Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Uninstall-TransportAgent

 

Applies to: Exchange Server 2013

Topic Last Modified: 2013-01-11

Use the Uninstall-TransportAgent cmdlet to unregister a transport agent from the Transport service on a Mailbox server, the Front End Transport service on a Client Access server, or from an Edge Transport server.

Uninstall-TransportAgent -Identity <TransportAgentObjectId> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-TransportService <Hub | Edge | FrontEnd | MailboxSubmission | MailboxDelivery>] [-WhatIf [<SwitchParameter>]]

This example uninstalls a fictitious application named Test App from the Transport service on a Mailbox server.

Uninstall-TransportAgent "Test App" -TransportService Hub

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

Identity

Required

Microsoft.Exchange.Management.AgentTasks.TransportAgentObjectId

The Identity parameter specifies the display name of the transport agent to be uninstalled. The length of the name can't exceed 64 characters.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch can be used to suppress the confirmation prompt that appears by default when this cmdlet is run. To suppress the confirmation prompt, use the syntax -Confirm:$False. You must include a colon ( : ) in the syntax.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

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.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

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.

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.