Applies to: Exchange Server 2013
Topic Last Modified: 2012-09-13
Use the Install-TransportAgent cmdlet to register a transport agent in the Transport service on a Mailbox server, in the Front End Transport service on a Client Access server, or on an Edge Transport server.
Syntax
Install-TransportAgent -AssemblyPath <String> -Name
<String> -TransportAgentFactory <String> [-Confirm
[<SwitchParameter>]] [-DomainController <Fqdn>]
[-TransportService <Hub | Edge | FrontEnd | MailboxSubmission |
MailboxDelivery>] [-WhatIf [<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example shows how a fictitious application named Test App is installed in the Transport service on a Mailbox server.
 Copy Code |
|
|---|---|
Install-TransportAgent -Name "Test App" -TransportAgentFactory "vendor.exchange.avTransportAgentfactory" -AssemblyPath "c:\Program Files\Vendor\TransportAgent\AvTransportAgentFactory.dll" -TransportService Hub |
|
Detailed Description
 Caution: |
|---|
| Transport agents have full access to all email messages that they encounter. Exchange puts no restrictions on a transport agent's behavior. Transport agents that are unstable or contain security flaws may affect the stability and security of Exchange. Therefore, you must only install transport agents that you fully trust and that have been fully tested in a test environment. |
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.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
AssemblyPath |
Required |
System.String |
The AssemblyPath parameter specifies the location of the transport agent Microsoft .NET assembly. Universal Naming Convention (UNC) file paths can't be used. |
|
Name |
Required |
System.String |
The Name parameter specifies the display name of the transport agent to be installed. The length of the name can't exceed 64 characters. |
|
TransportAgentFactory |
Required |
System.String |
The TransportAgentFactory parameter specifies the Microsoft .NET class type of the transport agent factory. The developer of the transport agent being installed provides the transport agent factory and related information. For more information, see the documentation provided by the developer of the transport agent. |
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch. |
|
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:
|
|
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. |
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.