Applies to: Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1
Topic Last Modified: 2007-07-27

Use the Install-TransportAgent cmdlet to register 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

Install-TransportAgent -Name <String> -AssemblyPath <String> -TransportAgentFactory <String> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

AssemblyPath

Required

System.String

This parameter specifies the location of the transport agent Microsoft .NET assembly. Universal Naming Convention (UNC) file paths cannot be used.

Name

Required

System.String

This parameter specifies the display name of the transport agent to be installed. The length of the name cannot exceed 64 characters.

TransportAgentFactory

Required

System.String

This parameter specifies the Microsoft .NET class type of the transport agent factory. The developer of the transport agent that is 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 parameter 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 parameter.

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.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, 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 parameter.

Detailed Description

The Install-TransportAgent cmdlet is used to register a transport agent for use on an Edge Transport server or a Hub Transport server.

Caution:
Transport agents have full access to all e-mail 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.

To run the Install-TransportAgent cmdlet, the account you use must be delegated the following:

  • Exchange Server Administrator role and local Administrators group for the target server

To run the Install-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 2007, see Permission Considerations.

Input Types

Return Types

Errors

Error Description

 

Exceptions

Exceptions Description

 

Example

The following example shows how a fictitious antivirus application would be installed on an Edge Transport server or a Hub Transport server.

Copy Code 
Install-TransportAgent -Name "Antivirus for Exchange" -TransportAgentFactory "vendor.exchange.avTransportAgentfactory" -AssemblyPath "c:\Program Files\Vendor\TransportAgent\AvTransportAgentFactory.dll"