Export (0) Print
Expand All
Expand Minimize

Get-TransportAgent

 

Applies to: Exchange Server 2013

Topic Last Modified: 2014-04-11

This cmdlet is available only in on-premises Exchange Server 2013.

Use the Get-TransportAgent cmdlet to view the configuration of a transport agent.

Get-TransportAgent [-Identity <TransportAgentObjectId>] [-DomainController <Fqdn>] [-TransportService <Hub | Edge | FrontEnd | MailboxSubmission | MailboxDelivery>]

This example displays a summary list of all transport agents installed on all Exchange servers in your organization.

Get-TransportAgent

This example displays detailed information about the Transport Rule agent that's installed in the Transport service on a Mailbox server. The output of the Get-TransportAgent command is piped to the Format-List command to display the detailed configuration of the transport agent.

Get-TransportAgent "Transport Rule Agent" -TransportService Hub | Format-List

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 Mail flow permissions topic.

 

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 Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data.

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.

TransportService

Optional

Microsoft.Exchange.Data.TransportService

The TransportService parameter specifies the transport service that you want to view or modify. Valid values for this parameter are:

  • Hub for the Transport service on Mailbox servers.

  • MailboxSubmission for the Mailbox Transport Submission service on Mailbox servers.

  • MailboxDelivery for the Mailbox Transport Delivery service on Mailbox servers.

  • FrontEnd for the Front End Transport service on Client Access servers.

  • Edge on Edge Transport servers.

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.

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft