Commands › Exchange Online
Set-FrontendTransportService
Modify the configuration of the Front End Transport service on Exchange 2013 or later servers that have the Client Access server role installed.
Quick start script
# Set-FrontendTransportService — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org
# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-FrontendTransportService
$before | Format-List
# 3. Make the change (dry run first)
Set-FrontendTransportService -Identity <FrontendTransportServerIdParameter> -WhatIf
Set-FrontendTransportService -Identity <FrontendTransportServerIdParameter>
# 4. Verify and diff
$after = Get-FrontendTransportService
Compare-Object ($before | Out-String) ($after | Out-String)Syntax
Set-FrontendTransportService [-Identity] <FrontendTransportServerIdParameter>
[-AgentLogEnabled <Boolean>]
[-AgentLogMaxAge <EnhancedTimeSpan>]
[-AgentLogMaxDirectorySize <Unlimited>]
[-AgentLogMaxFileSize <Unlimited>]
[-AgentLogPath <LocalLongFullPath>]
[-AntispamAgentsEnabled <Boolean>]
[-Confirm]
[-ConnectivityLogEnabled <Boolean>]
[-ConnectivityLogMaxAge <EnhancedTimeSpan>]
[-ConnectivityLogMaxDirectorySize <Unlimited>]
[-ConnectivityLogMaxFileSize <Unlimited>]
[-ConnectivityLogPath <LocalLongFullPath>]
[-DnsLogEnabled <Boolean>]
[-DnsLogMaxAge <EnhancedTimeSpan>]
[-DnsLogMaxDirectorySize <Unlimited>]
[-DnsLogMaxFileSize <Unlimited>]
[-DnsLogPath <LocalLongFullPath>]
[-DomainController <Fqdn>]
[-ExternalDNSAdapterEnabled <Boolean>]
[-ExternalDNSAdapterGuid <Guid>]
[-ExternalDNSProtocolOption <ProtocolOption>]
[-ExternalDNSServers <MultiValuedProperty>]
[-ExternalIPAddress <IPAddress>]
[-InternalDNSAdapterEnabled <Boolean>]
[-InternalDNSAdapterGuid <Guid>]
[-InternalDNSProtocolOption <ProtocolOption>]
[-InternalDNSServers <MultiValuedProperty>]
[-IntraOrgConnectorProtocolLoggingLevel <ProtocolLoggingLevel>]
[-MaxConnectionRatePerMinute <Int32>]
[-ReceiveProtocolLogMaxAge <EnhancedTimeSpan>]
[-ReceiveProtocolLogMaxDirectorySize <Unlimited>]
[-ReceiveProtocolLogMaxFileSize <Unlimited>]
[-ReceiveProtocolLogPath <LocalLongFullPath>]
[-RoutingTableLogMaxAge <EnhancedTimeSpan>]
[-RoutingTableLogMaxDirectorySize <Unlimited>]
[-RoutingTableLogPath <LocalLongFullPath>]
[-SendProtocolLogMaxAge <EnhancedTimeSpan>]
[-SendProtocolLogMaxDirectorySize <Unlimited>]
[-SendProtocolLogMaxFileSize <Unlimited>]
[-SendProtocolLogPath <LocalLongFullPath>]
[-TransientFailureRetryCount <Int32>]
[-TransientFailureRetryInterval <EnhancedTimeSpan>]
[-WhatIf]
[<CommonParameters>]Parameters (44)
| Parameter | Type | Required | What it controls |
|---|---|---|---|
| -Identity | FrontendTransportServerIdParameter | yes | The Identity parameter specifies the server that you want to modify. |
| -AgentLogEnabled | Boolean | The AgentLogEnabled parameter specifies whether the agent log is enabled. The default value is $true. | |
| -AgentLogMaxAge | 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 7.00:00:00 or 7 days. | |
| -AgentLogMaxDirectorySize | 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... | |
| -AgentLogMaxFileSize | 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. | |
| -AgentLogPath | LocalLongFullPath | The AgentLogPath parameter specifies the default agent log directory location. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\FrontEnd\\AgentLog. Setting the value of this parameter to $null... | |
| -AntispamAgentsEnabled | Boolean | The AntispamAgentsEnabled parameter specifies whether anti-spam agents are installed on the server specified with the Identity parameter. The default value is $false for the Front End Transport service. | |
| -Confirm | SwitchParameter | The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding. | |
| -ConnectivityLogEnabled | Boolean | The ConnectivityLogEnabled parameter specifies whether the connectivity log is enabled. The default value is $true. | |
| -ConnectivityLogMaxAge | 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. | |
| -ConnectivityLogMaxDirectorySize | 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... | |
| -ConnectivityLogMaxFileSize | 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. | |
| -ConnectivityLogPath | LocalLongFullPath | The ConnectivityLogPath parameter specifies the default connectivity log directory location. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\FrontEnd\\Connectivity. Setting the value of this... | |
| -DnsLogEnabled | Boolean | The DnsLogEnabled parameter specifies whether the DNS log is enabled. The default value is $false. | |
| -DnsLogMaxAge | EnhancedTimeSpan | The DnsLogMaxAge parameter specifies the maximum age for the DNS log file. Log files older than the specified value are deleted. The default value is 7.00:00:00 or 7 days. | |
| -DnsLogMaxDirectorySize | Unlimited | The DnsLogMaxDirectorySize parameter specifies the maximum size of all DNS logs in the DNS log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default... | |
| -DnsLogMaxFileSize | Unlimited | The DnsLogMaxFileSize parameter specifies the maximum size of each DNS log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. | |
| -DnsLogPath | LocalLongFullPath | The DnsLogPath parameter specifies the DNS log directory location. The default value is blank ($null), which indicates no location is configured. If you enable DNS logging, you need to specify a local file path for... | |
| -DomainController | Fqdn | The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name... | |
| -ExternalDNSAdapterEnabled | 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 $true, DNS lookups of... | |
| -ExternalDNSAdapterGuid | 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... | |
| -ExternalDNSProtocolOption | ProtocolOption | The ExternalDNSProtocolOption parameter specifies which protocol to use when querying external DNS servers. The valid options for this parameter are Any, UseTcpOnly, and UseUdpOnly. The default value is Any. | |
| -ExternalDNSServers | 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 | IPAddress | The ExternalIPAddress parameter specifies the IP address used in the Received message header field for every message that travels through the Front End Transport service. The IP address in the Received header field... | |
| -InternalDNSAdapterEnabled | Boolean | The InternalDNSAdapterEnabled parameter specifies one or more DNS servers that Exchange uses for internal DNS lookups. When the InternalDNSAdapterEnabled parameter is set to $true, DNS lookups of destinations inside... | |
| -InternalDNSAdapterGuid | 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... | |
| -InternalDNSProtocolOption | ProtocolOption | The InternalDNSProtocolOption parameter specifies which protocol to use when you query internal DNS servers. Valid options for this parameter are Any, UseTcpOnly, or UseUdpOnly. | |
| -InternalDNSServers | 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... | |
| -IntraOrgConnectorProtocolLoggingLevel | ProtocolLoggingLevel | The IntraOrgConnectorProtocolLoggingLevel parameter enables or disables SMTP protocol logging on the implicit and invisible intra-organization Send connector In the Front End Transport service. Valid values are: | |
| -MaxConnectionRatePerMinute | 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,... | |
| -ReceiveProtocolLogMaxAge | EnhancedTimeSpan | The ReceiveProtocolLogMaxAge parameter specifies the maximum age of a protocol log file that's shared by all Receive connectors in the Transport service on the server. Log files that are older than the specified... | |
| -ReceiveProtocolLogMaxDirectorySize | Unlimited | The ReceiveProtocolLogMaxDirectorySize parameter specifies the maximum size of the protocol log directory that's shared by all Receive connectors in the Front End Transport service on the server. When the maximum... | |
| -ReceiveProtocolLogMaxFileSize | Unlimited | The ReceiveProtocolLogMaxFileSize parameter specifies the maximum size of a protocol log file that's shared by all Receive connectors in the Front End Transport service on the server. When a log file reaches its... | |
| -ReceiveProtocolLogPath | LocalLongFullPath | The ReceiveProtocolLogPath parameter specifies the location of the protocol log directory for all Receive connectors in the Front End Transport service on the server. The default location is... | |
| -RoutingTableLogMaxAge | EnhancedTimeSpan | The RoutingTableLogMaxAge parameter specifies the maximum routing table log age. Log files older than the specified value are deleted. The default value is 7 days. | |
| -RoutingTableLogMaxDirectorySize | Unlimited | The RoutingTableLogMaxDirectorySize parameter specifies the maximum size of the routing table log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The default... | |
| -RoutingTableLogPath | LocalLongFullPath | The RoutingTableLogPath parameter specifies the directory location where routing table log files should be stored. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\FrontEnd\\Routing. Setting this... | |
| -SendProtocolLogMaxAge | EnhancedTimeSpan | The SendProtocolLogMaxAge parameter specifies the maximum age of a protocol log file that's shared by all Send connectors in the Front End Transport service that have this server configured as a source server. Log... | |
| -SendProtocolLogMaxDirectorySize | Unlimited | The SendProtocolLogMaxDirectorySize parameter specifies the maximum size of the protocol log directory that's shared by all Send connectors in the Front End Transport service that have this server configured as a... | |
| -SendProtocolLogMaxFileSize | Unlimited | The SendProtocolLogMaxFileSize parameter specifies the maximum size of a protocol log file that's shared by all the Send connectors in the Front End Transport service that have this server configured as a source... | |
| -SendProtocolLogPath | LocalLongFullPath | The SendProtocolLogPath parameter specifies the location of the protocol log directory for all Send connectors in the Front End Transport service that have this server configured as a source server. The default... | |
| -TransientFailureRetryCount | 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... | |
| -TransientFailureRetryInterval | EnhancedTimeSpan | The TransientFailureRetryInterval parameter controls the connection interval between each connection attempt specified by the TransientFailureRetryCount parameter. For the Front End Transport service, the default... | |
| -WhatIf | SwitchParameter | The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch. |
Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.