Applies to: Exchange Server 2013
Topic Last Modified: 2013-01-11
Use the Set-TransportAgent cmdlet to modify a transport agent.
Syntax
Set-TransportAgent -Identity
<TransportAgentObjectId> [-Confirm [<SwitchParameter>]]
[-DomainController <Fqdn>] [-Priority <Int32>]
[-TransportService <Hub | Edge | FrontEnd | MailboxSubmission |
MailboxDelivery>] [-WhatIf [<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example modifies the priority of a fictitious agent named Test App in the Front End Transport service on a Client Access server.
 Copy Code |
|
|---|---|
Set-TransportAgent "Test App" -Priority 3 -TransportService -FrontEnd |
|
Detailed Description
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 |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Exchange.Management.AgentTasks.TransportAgentObjectId |
The Identity parameter specifies the display name of the transport agent to be modified. The length of the name can't exceed 64 characters. |
|
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. |
|
Priority |
Optional |
System.Int32 |
The Priority parameter specifies the priority of the transport agent. The priority of the transport agent controls the order in which the transport agents process email 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 email messages first. |
|
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.