Applies to: Exchange Server 2013
Topic Last Modified: 2012-09-13
Use the Set-FrontEndTransportService cmdlet to set the transport configuration options for the Front End Transport service on Client Access servers.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Set-FrontendTransportService -Identity
<FrontendTransportServerIdParameter> [-AgentLogEnabled
<$true | $false>] [-AgentLogMaxAge <EnhancedTimeSpan>]
[-AgentLogMaxDirectorySize <Unlimited>] [-AgentLogMaxFileSize
<Unlimited>] [-AgentLogPath <LocalLongFullPath>]
[-AntispamAgentsEnabled <$true | $false>] [-Confirm
[<SwitchParameter>]] [-ConnectivityLogEnabled <$true |
$false>] [-ConnectivityLogMaxAge <EnhancedTimeSpan>]
[-ConnectivityLogMaxDirectorySize <Unlimited>]
[-ConnectivityLogMaxFileSize <Unlimited>]
[-ConnectivityLogPath <LocalLongFullPath>] [-DomainController
<Fqdn>] [-ExternalDNSAdapterEnabled <$true | $false>]
[-ExternalDNSAdapterGuid <Guid>] [-ExternalDNSProtocolOption
<Any | UseUdpOnly | UseTcpOnly>] [-ExternalDNSServers
<MultiValuedProperty>] [-ExternalIPAddress <IPAddress>]
[-InternalDNSAdapterEnabled <$true | $false>]
[-InternalDNSAdapterGuid <Guid>] [-InternalDNSProtocolOption
<Any | UseUdpOnly | UseTcpOnly>] [-InternalDNSServers
<MultiValuedProperty>]
[-IntraOrgConnectorProtocolLoggingLevel <None | Verbose>]
[-MaxConnectionRatePerMinute <Int32>]
[-ReceiveProtocolLogMaxAge <EnhancedTimeSpan>]
[-ReceiveProtocolLogMaxDirectorySize <Unlimited>]
[-ReceiveProtocolLogMaxFileSize <Unlimited>]
[-ReceiveProtocolLogPath <LocalLongFullPath>]
[-SendProtocolLogMaxAge <EnhancedTimeSpan>]
[-SendProtocolLogMaxDirectorySize <Unlimited>]
[-SendProtocolLogMaxFileSize <Unlimited>]
[-SendProtocolLogPath <LocalLongFullPath>]
[-TransientFailureRetryCount <Int32>]
[-TransientFailureRetryInterval <EnhancedTimeSpan>] [-WhatIf
[<SwitchParameter>]]
|
Examples
Example 1
This example sets the TransientFailureRetryCount parameter to 3 and sets the TransientFailureRetryInterval parameter to 30 seconds for the Front End Transport service on the Client Access server named CAS01.
Copy Code | |
---|---|
Set-FrontEndTransportService CAS01 -TransientFailureRetryCount 3 -TransientFailureRetryInterval 00:00:30 |
Example 2
This example sets the ReceiveProtocolLogPath parameter to C:\SMTP Protocol Logs\Receive.log for the Front End Transport service on the Client Access server named CAS01.
Copy Code | |
---|---|
Set-FrontEndTransportService CAS01 -ReceiveProtocolLogPath "C:\SMTP Protocol Logs\Receive.log" |
Detailed Description
The Front End Transport service runs on all Client Access servers and acts as a stateless proxy for all inbound and outbound external SMTP traffic for the Exchange organization. The Front End Transport service only communicates with the Transport service on a Mailbox server, and doesn't queue any messages locally.
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 "Front End Transport service" entries in the Mail Flow Permissions topic.
Parameters
Parameter | Required | Type | Description | ||
---|---|---|---|---|---|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.FrontendTransportServerIdParameter |
The Identity parameter specifies the server that you want to modify. |
||
AgentLogEnabled |
Optional |
System.Boolean |
The AgentLogEnabled parameter specifies whether the agent
log is enabled. The default value is |
||
AgentLogMaxAge |
Optional |
Microsoft.Exchange.Data.EnhancedTimeSpan |
The AgentLogMaxAge parameter specifies the maximum age
for the agent log file. Log files older than the specified value
are deleted. The default value is To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds. Setting the value of the AgentLogMaxAge parameter to 00:00:00 prevents the automatic removal of agent log files because of their age. |
||
AgentLogMaxDirectorySize |
Optional |
Microsoft.Exchange.Data.Unlimited |
The AgentLogMaxDirectorySize parameter specifies the maximum size of all agent logs in the agent log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 250 MB. When you enter a value, qualify the value with one of the following units:
Unqualified values are treated as bytes. The value of the AgentLogMaxFileSize parameter must be
less than or equal to the value of the
AgentLogMaxDirectorySize parameter. If you enter a value of
|
||
AgentLogMaxFileSize |
Optional |
Microsoft.Exchange.Data.Unlimited |
The AgentLogMaxFileSize parameter specifies the maximum size of each agent log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units:
Unqualified values are treated as bytes. The value of the AgentLogMaxFileSize parameter must be
less than or equal to the value of the
AgentLogMaxDirectorySize parameter. If you enter a value of
|
||
AgentLogPath |
Optional |
Microsoft.Exchange.Data.LocalLongFullPath |
The AgentLogPath parameter specifies the default agent
log directory location. The default location is
|
||
AntispamAgentsEnabled |
Optional |
System.Boolean |
The AntispamAgentsEnabled parameter specifies whether
anti-spam agents are installed on the server specified with the
Identity parameter. The default value is
|
||
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. |
||
ConnectivityLogEnabled |
Optional |
System.Boolean |
The ConnectivityLogEnabled parameter specifies whether
the connectivity log is enabled. The default value is
|
||
ConnectivityLogMaxAge |
Optional |
Microsoft.Exchange.Data.EnhancedTimeSpan |
The ConnectivityLogMaxAge parameter specifies the maximum age for the connectivity log file. Log files older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds. For example, to specify 25 days for this parameter, use 25.00:00:00. The valid input range for this parameter is from 00:00:00 through 24855.03:14:07. Setting the value of the ConnectivityLogMaxAge parameter to 00:00:00 prevents the automatic removal of connectivity log files because of their age. |
||
ConnectivityLogMaxDirectorySize |
Optional |
Microsoft.Exchange.Data.Unlimited |
The ConnectivityLogMaxDirectorySize parameter specifies the maximum size of all connectivity logs in the connectivity log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 1000 MB. When you enter a value, qualify the value with one of the following units:
Unqualified values are treated as bytes. The value of the ConnectivityLogMaxFileSize parameter
must be less than or equal to the value of the
ConnectivityLogMaxDirectorySize parameter. The valid input
range for either parameter is from 1 through
9223372036854775807 bytes. If you enter a value of
|
||
ConnectivityLogMaxFileSize |
Optional |
Microsoft.Exchange.Data.Unlimited |
The ConnectivityLogMaxFileSize parameter specifies the maximum size of each connectivity log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units:
Unqualified values are treated as bytes. The value of the ConnectivityLogMaxFileSize parameter
must be less than or equal to the value of the
ConnectivityLogMaxDirectorySize parameter. The valid input
range for either parameter is from 1 through
9223372036854775807 bytes. If you enter a value of
|
||
ConnectivityLogPath |
Optional |
Microsoft.Exchange.Data.LocalLongFullPath |
The ConnectivityLogPath parameter specifies the default
connectivity log directory location. The default location is
|
||
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. |
||
ExternalDNSAdapterEnabled |
Optional |
System.Boolean |
The ExternalDNSAdapterEnabled parameter specifies one or
more Domain Name System (DNS) servers that Exchange uses for
external DNS lookups. When the ExternalDNSAdapterEnabled
parameter is set to |
||
ExternalDNSAdapterGuid |
Optional |
System.Guid |
The ExternalDNSAdapterGuid parameter specifies the
network adapter that has the DNS settings used for DNS lookups of
destinations that exist outside the Exchange organization. The
concept of an external network adapter and an internal network
adapter is only applicable in a multi-homed Exchange server
environment. When no particular network adapter is specified as the
network adapter for external DNS lookups, the value of the
ExternalDNSAdapterGuid parameter is
|
||
ExternalDNSProtocolOption |
Optional |
Microsoft.Exchange.Data.ProtocolOption |
The ExternalDNSProtocolOption parameter specifies which
protocol to use when querying external DNS servers. The valid
options for this parameter are |
||
ExternalDNSServers |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The ExternalDNSServers parameter specifies the list of external DNS servers that the server queries when resolving a remote domain. You must separate IP addresses by using commas. The default value is an empty list ({}).
|
||
ExternalIPAddress |
Optional |
System.Net.IPAddress |
The ExternalIPAddress parameter specifies the IP address
used in the |
||
InternalDNSAdapterEnabled |
Optional |
System.Boolean |
The InternalDNSAdapterEnabled parameter specifies one or
more DNS servers that Exchange uses for internal DNS lookups. When
the InternalDNSAdapterEnabled parameter is set to
|
||
InternalDNSAdapterGuid |
Optional |
System.Guid |
The InternalDNSAdapterGuid parameter specifies the
network adapter that has the DNS settings used for DNS lookups of
servers that exist inside the Exchange organization. The concept of
an internal network adapter and an external network adapter is only
applicable in a multi-homed Exchange server environment. When no
particular network adapter is specified as the network adapter for
external DNS lookups, the value of the
InternalDNSAdapterGuid parameter is
|
||
InternalDNSProtocolOption |
Optional |
Microsoft.Exchange.Data.ProtocolOption |
The InternalDNSProtocolOption parameter specifies which
protocol to use when you query internal DNS servers. Valid options
for this parameter are The default value is |
||
InternalDNSServers |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The InternalDNSServers parameter specifies the list of DNS servers that should be used when resolving a domain name. DNS servers are specified by IP address and are separated by commas. The default value is any empty list ({}).
|
||
IntraOrgConnectorProtocolLoggingLevel |
Optional |
Microsoft.Exchange.Data.ProtocolLoggingLevel |
The IntraOrgConnectorProtocolLoggingLevel parameter enables or disables SMTP protocol logging on the implicit and invisible intra-organization Send connectors that are used to transmit messages between Exchange servers in the Exchange organization. Valid values for this parameter are |
||
MaxConnectionRatePerMinute |
Optional |
System.Int32 |
The MaxConnectionRatePerMinute parameter specifies the maximum rate that connections are allowed to be opened with the transport service. If many connections are attempted with the transport service at the same time, the MaxConnectionRatePerMinute parameter limits the rate that the connections are opened so that the server's resources aren't overwhelmed. The default value is 1200 connections per minute. The valid input range for this parameter is from 1 through 2147483647. |
||
ReceiveProtocolLogMaxAge |
Optional |
Microsoft.Exchange.Data.EnhancedTimeSpan |
The ReceiveProtocolLogMaxAge parameter specifies the maximum age of the Receive connector protocol log file. Log files that are older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds. For example, to specify 20 days for this parameter, use 20.00:00:00. The valid input range for this parameter is from 00:00:00 through 24855.03:14:07. Setting the value of the ReceiveProtocolLogMaxAge parameter to 00:00:00 prevents the automatic removal of Receive connector protocol log files because of their age. |
||
ReceiveProtocolLogMaxDirectorySize |
Optional |
Microsoft.Exchange.Data.Unlimited |
The ReceiveProtocolLogMaxDirectorySize parameter specifies the maximum size of the Receive connector protocol log directory shared by all the Receive connectors that exist on the server. When the maximum directory size is reached, the server deletes the oldest log files first. The default value is 250 MB. When you enter a value, qualify the value with one of the following units:
Unqualified values are treated as bytes. The value of the ReceiveProtocolLogMaxFileSize parameter
must be less than or equal to the value of the
ReceiveProtocolLogMaxDirectorySize parameter. The valid
input range for either parameter is from 1 through
9223372036854775807 bytes. If you enter a value of
|
||
ReceiveProtocolLogMaxFileSize |
Optional |
Microsoft.Exchange.Data.Unlimited |
The ReceiveProtocolLogMaxFileSize parameter specifies the maximum size of the Receive connector protocol log files shared by all the Receive connectors that exist on the server. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units:
Unqualified values are treated as bytes. The value of the ReceiveProtocolLogMaxFileSize parameter
must be less than or equal to the value of the
ReceiveProtocolLogMaxDirectorySize parameter. The valid
input range for either parameter is from 1 through
9223372036854775807 bytes. If you enter a value of
|
||
ReceiveProtocolLogPath |
Optional |
Microsoft.Exchange.Data.LocalLongFullPath |
The ReceiveProtocolLogPath parameter specifies the path
of the protocol log directory for all the Receive connectors that
exist on the server. The default location is
|
||
SendProtocolLogMaxAge |
Optional |
Microsoft.Exchange.Data.EnhancedTimeSpan |
The SendProtocolLogMaxAge parameter specifies the Send connector protocol log file maximum age. Log files older than the specified value are deleted. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds. For example, to specify 25 days for this parameter, use 25.00:00:00. The valid input range for this parameter is from 00:00:00 through 24855.03:14:07. Setting the value of the SendProtocolLogMaxAge parameter to 00:00:00 prevents the automatic removal of Send connector protocol log files because of their age. |
||
SendProtocolLogMaxDirectorySize |
Optional |
Microsoft.Exchange.Data.Unlimited |
The SendProtocolLogMaxDirectorySize parameter specifies the maximum size of the Send connector protocol log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The minimum value is 1 MB. The default value is 250 MB. When you enter a value, qualify the value with one of the following units:
Unqualified values are treated as bytes. The value of the SendProtocolLogMaxFileSize parameter
must be less than or equal to the value of the
SendProtocolLogMaxDirectorySize parameter. The valid input
range for either parameter is from 1 through 9223372036854775807
bytes. If you enter a value of |
||
SendProtocolLogMaxFileSize |
Optional |
Microsoft.Exchange.Data.Unlimited |
The SendProtocolLogMaxFileSize parameter specifies the maximum size of the Send connector protocol log files shared by all the Send connectors that exist on a server. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following units:
Unqualified values are treated as bytes. The value of the SendProtocolLogMaxFileSize parameter
must be less than or equal to the value of the
SendProtocolLogMaxDirectorySize parameter. The valid input
range for either parameter is from 1 through 9223372036854775807
bytes. If you enter a value of |
||
SendProtocolLogPath |
Optional |
Microsoft.Exchange.Data.LocalLongFullPath |
The SendProtocolLogPath parameter specifies the location
of protocol log storage for the Send connectors. The default
location is
|
||
TransientFailureRetryCount |
Optional |
System.Int32 |
The TransientFailureRetryCount parameter specifies the maximum number of immediate connection retries attempted when the server encounters a connection failure with a remote server. The default value is 6. The valid input range for this parameter is from 0 through 15. When the value of this parameter is set to 0, the server doesn't immediately attempt to retry an unsuccessful connection. |
||
TransientFailureRetryInterval |
Optional |
Microsoft.Exchange.Data.EnhancedTimeSpan |
The TransientFailureRetryInterval parameter controls the connection interval between each connection attempt specified by the TransientFailureRetryCount parameter. For the Front End Transport service on a Client Access server, the default value of the TransientFailureRetryInterval parameter is 5 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds. For example, to specify 8 minutes for this parameter, use 00:08:00. The valid input range for this parameter is from 00:00:01 through 12:00:00. |
||
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.