Get-TransportRuleAction (RTM)
Microsoft Exchange Server 2007 will reach end of support on April 11, 2017. To stay supported, you will need to upgrade. For more information, see Resources to help you upgrade your Office 2007 servers and clients.
Applies to: Exchange Server 2007
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 computer that has the Hub Transport server role or the Edge Transport server role installed.
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 2007.
The transport rule actions that are 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.
To run the Get-TransportRuleAction cmdlet, the account you use must be delegated the following:
- Exchange View-Only Administrator role
To run the Get-TransportRuleAction cmdlet on a computer that has the Edge Transport server role installed, you must log on by using an account that is a member of the local Administrators group on that computer.
For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Name |
Optional |
System.String |
This parameter specifies the action to display. See Transport Rule Actions for a list of values that can be used with this parameter on the server role that you are administering. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
Exceptions
| Exceptions | Description |
|---|---|
|
Example
The following example shows how to use the Get-TransportRuleAction command to return all available transport rule actions for transport rules that are used with the Transport Rules agent.
A second example shows how to retrieve a single transport rule action. The command is piped to the Format-List command to display detailed transport rule action information.
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.
Get-TransportRuleAction
Get-TransportRuleAction -Name DeleteMessage | Format-List