Get-TransportAgent
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
Use the Get-TransportAgent cmdlet to view the configuration of a transport agent on a computer that has the Edge Transport server role or the Hub Transport server role installed in a Microsoft Exchange Server 2007 organization.
Syntax
Get-TransportAgent [-Identity <String>] [-DomainController <Fqdn>]
Detailed Description
The Get-TransportAgent cmdlet is used to view the configuration of a transport agent on an Edge Transport server or a Hub Transport server.
To run the Get-TransportAgent cmdlet, the account you use must be delegated the following:
- Exchange View-Only Administrator role
To run the Get-TransportAgent 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 |
|---|---|---|---|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
To specify the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the command. The DomainController parameter is not supported on computers that run the Edge Transport server role. The Edge Transport server role reads from and writes to only to the local ADAM instance. |
Identity |
Optional |
System.String |
This parameter specifies the display name of the transport agent to be displayed. The length of the name cannot exceed 64 characters. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
Exceptions
| Exceptions | Description |
|---|---|
Example
The first example shows how to display a summary list of all transport agents that are installed on an Edge Transport server or a Hub Transport server.
The second example shows how to display information about a specific transport agent in list format. The Get-TransportAgent command is piped to the Format-List command to display the detailed configuration of the specified transport rule.
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-TransportAgent
Get-TransportAgent -Identity "Edge Rule Agent" | Format-List