Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2
Topic Last Modified: 2011-05-05
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 2010 organization.
Syntax
Get-TransportAgent [-Identity
<TransportAgentObjectId>] [-DomainController
<Fqdn>]
|
Detailed Description
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 agents" entry in the Transport Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory. The DomainController parameter isn't supported on the Edge Transport server role. The Edge Transport server role reads only from the Active Directory Lightweight Directory Services (AD LDS) instance. |
|
Identity |
Optional |
Microsoft.Exchange.Management.AgentTasks.TransportAgentObjectId |
The Identity parameter specifies the display name of the transport agent to be displayed. The length of the name can't exceed 64 characters. |
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 displays a summary list of all transport agents installed on an Edge Transport server or a Hub Transport server.
 Copy Code |
|
|---|---|
Get-TransportAgent |
|
EXAMPLE 2
This example displays detailed information about a specific transport agent. The output of the Get-TransportAgent command is piped to the Format-List command to display the detailed configuration of the specified transport rule.
| Copy Code |
|
|---|---|
Get-TransportAgent -Identity "Edge Rule Agent" | Format-List |
|