Get-TransportRulePredicate
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
Use the Get-TransportRulePredicate cmdlet to retrieve a list of all available rule predicates 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-TransportRulePredicate [-Name <String>]
Detailed Description
The Get-TransportRulePredicate cmdlet displays a list of available rule predicates that you can use in transport rules that are part of the Transport Rules agent in Microsoft Exchange Server 2007.
The predicates that are available for use on a Hub Transport server and an Edge Transport server are slightly different. For a list of transport rule predicates that are included with the Get-TransportRulePredicate cmdlet, and to determine which predicates are available on each server role, see Transport Rule Predicates.
To run the Get-TransportRulePredicate cmdlet, the account you use must be delegated the following:
- Exchange View-Only Administrator role
To run the Get-TransportRulePredicate 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 |
Use this parameter to specify the predicate to display. See Transport Rule Predicates 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 first example shows how to use the Get-TransportRulePredicate command to return all available predicates for transport rules that are used with the Transport Rules agent.
The second example shows how to retrieve a single predicate. The command is piped to the Format-List command to display detailed transport rule predicate 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-TransportRulePredicate
Get-TransportRulePredicate -Name SubjectMatches | Format-List