Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2012-12-11

Use the Get-TransportRuleAction cmdlet to retrieve a list of all available transport rule actions that can be used with the Transport Rules agent on a Hub Transport or an Edge Transport server.

Syntax

Get-TransportRuleAction [-Name <String>]

Detailed Description

The Get-TransportRuleAction cmdlet displays a list of available actions that an e-mail administrator can use in transport rules that are part of the Transport Rules agent in Microsoft Exchange Server 2010.

The transport rule actions available for use on a Hub Transport server and an Edge Transport server are slightly different. For a list of transport rule actions included with the Get-TransportRuleAction cmdlet, and to determine which actions are available on each of the server roles, see Transport Rule Actions.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Transport rules" entry in the Messaging Policy and Compliance Permissions topic.

Parameters

Parameter Required Type Description

Name

Optional

System.String

The Name parameter specifies the action to display. For a list of values that can be used with this parameter on the server role that you are administering, see Transport Rule Actions.

Input Types

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

Return Types

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

Examples

EXAMPLE 1

This example returns all available transport rule actions for transport rules used with the Transport Rules agent.

Copy Code
Get-TransportRuleAction

EXAMPLE 2

This example retrieves a single transport rule action. The command is piped to the Format-List command to display all properties of the transport rule action.

Copy Code
Get-TransportRuleAction -Name DeleteMessage | Format-List

For more information about pipelining, see Pipelining. For more information about how to work with the output of a command, see Working with Command Output.