Set-TransportAgent (RTM)
Microsoft Exchange Server 2007 will reach end of support on April 11, 2017. To stay supported, you will need to upgrade. For more information, see Resources to help you upgrade your Office 2007 servers and clients.
Applies to: Exchange Server 2007
Use the Set-TransportAgent cmdlet to modify 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
Set-TransportAgent -Identity <String> [-DomainController <Fqdn>] [-Priority <Nullable>]
Detailed Description
The Set-TransportAgent cmdlet is used to modify a transport agent on an Edge Transport server or a Hub Transport server.
To run the Set-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 Set-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 Server 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
System.String |
Use this parameter to specify the display name of the transport agent to be modified. The length of the name cannot exceed 64 characters. |
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. |
Priority |
Optional |
System.Nullable |
Use this parameter to specify the priority of the transport agent. The priority of the transport agent controls the order in which the transport agents process e-mail messages. The priority must be a value between 0 and the maximum number of transport agents. The default behavior is to append a new transport agent to the end of the priority list. Transport agents with a priority closest to 0 process e-mail messages first. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
Exceptions
| Exceptions | Description |
|---|---|
|
Example
The following example shows how the priority of a fictitious antivirus agent would be modified.
Set-TransportAgent -Identity "Antivirus for Exchange" -Priority 3