[Index]

Model: device/exchangehybrid/FrontendTransportService

Model Details

Title Description Details
ResourceLogMaxAge * This parameter is reserved for internal Microsoft use.
  • Field Name: ResourceLogMaxAge
  • Type: String
ReceiveProtocolLogMaxFileSize * 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: B (bytes) KB (kilobytes) MB (megabytes) GB (gigabytes) TB (terabytes) 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 unlimited, no size limit is imposed on the Receive connector protocol log files.
  • Field Name: ReceiveProtocolLogMaxFileSize
  • Type: String
ExternalDNSProtocolOption * 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.
  • Field Name: ExternalDNSProtocolOption
  • Type: String
IntraOrgConnectorProtocolLoggingLevel * 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 None or Verbose. The value Verbose enables protocol logging for the connector. The value None disables protocol logging for the connector. The default value is None. When the IntraOrgConnectorProtocolLoggingLevel parameter is set to Verbose, the information is written to the Send connector protocol log specified by the SendProtocolLog parameters.
  • Field Name: IntraOrgConnectorProtocolLoggingLevel
  • Type: String
ExchangeLegacyDN *
  • Field Name: ExchangeLegacyDN
  • Type: String
OriginatingServer *
  • Field Name: OriginatingServer
  • Type: String
SendProtocolLogMaxFileSize * 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: B (bytes) KB (kilobytes) MB (megabytes) GB (gigabytes) TB (terabytes) 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 unlimited, no size limit is imposed on the Send connector protocol log files.
  • Field Name: SendProtocolLogMaxFileSize
  • Type: String
ResourceLogPath * This parameter is reserved for internal Microsoft use.
  • Field Name: ResourceLogPath
  • Type: String
ExternalIPAddress * 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 on a Client Access server. The IP address in the Received header field is used for hop count and routing loop detection. The IP address specified by the ExternalIPAddress parameter overrides the external network adapter's actual IP address. Typically, you would want to set the value of the ExternalIPAddress parameter to match the value of your domain's public MX record. The default value of the ExternalIPAddress parameter is blank. This means the actual IP address of the external network adapter is used in the Received header field.
  • Field Name: ExternalIPAddress
  • Type: String
TransientFailureRetryCount * 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.
  • Field Name: TransientFailureRetryCount
  • Type: Integer
IsFrontendTransportServer *
  • Field Name: IsFrontendTransportServer
  • Type: Boolean
ExternalDNSServers 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 ({}). If the value of the ExternalDNSAdapterEnabled parameter is set to $true, the ExternalDNSServers parameter and its list of DNS servers isn't used.
  • Field Name: ExternalDNSServers.[n]
  • Type: Array
ConnectivityLogMaxFileSize * 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: B (bytes) KB (kilobytes) MB (megabytes) GB (gigabytes) TB (terabytes) 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 unlimited, no size limit is imposed on the connectivity log files.
  • Field Name: ConnectivityLogMaxFileSize
  • Type: String
WhenChanged *
  • Field Name: WhenChanged
  • Type: String
  • Format: date-time
PSShowComputerName
  • Field Name: PSShowComputerName
  • Type: Boolean
ResourceLogMaxDirectorySize * This parameter is reserved for internal Microsoft use.
  • Field Name: ResourceLogMaxDirectorySize
  • Type: String
DnsLogPath * 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 the DNS log files by using this parameter. If the path contains spaces, enclose the entire path value in quotation marks (").
  • Field Name: DnsLogPath
  • Type: String
AttributionLogMaxDirectorySize * This parameter is reserved for internal Microsoft use.
  • Field Name: AttributionLogMaxDirectorySize
  • Type: String
ObjectClass
  • Field Name: ObjectClass.[n]
  • Type: Array
DnsLogMaxFileSize * 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. When you enter a value, qualify the value with one of the following units: B (bytes) KB (kilobytes) MB (megabytes) GB (gigabytes) TB (terabytes) Unqualified values are treated as bytes. The value of the DnsLogMaxFileSize parameter must be less than or equal to the value of the DnsLogMaxDirectorySize parameter. If you enter a value of unlimited, no size limit is imposed on the DNS log files.
  • Field Name: DnsLogMaxFileSize
  • Type: String
PSComputerName
  • Field Name: PSComputerName
  • Type: String
InternalDNSAdapterGuid * 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 00000000-0000-0000-0000-000000000000, and internal DNS lookups are performed by using the DNS settings of any available network adapter. You may enter the GUID of a specific network adapter to use for internal DNS lookups. The default value of the InternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000. If the value of the InternalDNSAdapterEnabled parameter is set to $false, the value of the InternalDNSAdapterGuid parameter is ignored, and the list of DNS servers from the InternalDNSServers parameter is used.
  • Field Name: InternalDNSAdapterGuid
  • Type: String
OrganizationId *
  • Field Name: OrganizationId
  • Type: String
AttributionLogEnabled * This parameter is reserved for internal Microsoft use.
  • Field Name: AttributionLogEnabled
  • Type: Boolean
IsProvisionedServer *
  • Field Name: IsProvisionedServer
  • Type: Boolean
InternalDNSServers 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 ({}). If the InternalDNSAdapterGuid parameter is set, and the value of the InternalDNSAdapterEnabled parameter is set to $true, the InternalDNSServers parameter and its list of DNS servers isn't used.
  • Field Name: InternalDNSServers.[n]
  • Type: Array
AntispamAgentsEnabled * 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 on Client Access servers. You set this parameter by using a script. You shouldn't modify this parameter manually.
  • Field Name: AntispamAgentsEnabled
  • Type: Boolean
Identity * The Identity parameter specifies the server that you want to view.
  • Field Name: Identity
  • Type: String
DistinguishedName *
  • Field Name: DistinguishedName
  • Type: String
DnsLogMaxDirectorySize * 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 value is 100 MB. When you enter a value, qualify the value with one of the following units: B (bytes) KB (kilobytes) MB (megabytes) GB (gigabytes) TB (terabytes) Unqualified values are treated as bytes. The value of the DnsLogMaxFileSize parameter must be less than or equal to the value of the DnsLogMaxDirectorySize parameter. If you enter a value of unlimited, no size limit is imposed on the DNS log directory.
  • Field Name: DnsLogMaxDirectorySize
  • Type: String
ReceiveProtocolLogMaxAge * 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.
  • Field Name: ReceiveProtocolLogMaxAge
  • Type: String
Name *
  • Field Name: Name
  • Type: String
SendProtocolLogMaxDirectorySize * 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: B (bytes) KB (kilobytes) MB (megabytes) GB (gigabytes) TB (terabytes) 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 unlimited, no size limit is imposed on the Send connector protocol log directory.
  • Field Name: SendProtocolLogMaxDirectorySize
  • Type: String
ExternalDNSAdapterEnabled * 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 destinations outside the Exchange organization are performed by using the DNS settings of the external network adapter specified by the value of the ExternalDNSAdapterGuid parameter. If you want to specify a custom list of DNS servers used for external Exchange DNS lookups only, you must specify the DNS servers by using the ExternalDNSServers parameter, and you must also set the value of the ExternalDNSAdapterEnabled parameter to $false. The default value of the ExternalDNSAdapterEnabled parameter is $true.
  • Field Name: ExternalDNSAdapterEnabled
  • Type: Boolean
NetworkAddress *
  • Field Name: NetworkAddress
  • Type: String
WhenCreatedUTC *
  • Field Name: WhenCreatedUTC
  • Type: String
  • Format: date-time
DnsLogEnabled * The DnsLogEnabled parameter specifies whether the DNS log is enabled. The default value is $false.
  • Field Name: DnsLogEnabled
  • Type: Boolean
AttributionLogPath * This parameter is reserved for internal Microsoft use.
  • Field Name: AttributionLogPath
  • Type: String
ConnectivityLogMaxDirectorySize * 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: B (bytes) KB (kilobytes) MB (megabytes) GB (gigabytes) TB (terabytes) 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 unlimited, no size limit is imposed on the connectivity log directory.
  • Field Name: ConnectivityLogMaxDirectorySize
  • Type: String
ConnectivityLogMaxAge * 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.
  • Field Name: ConnectivityLogMaxAge
  • Type: String
WhenCreated *
  • Field Name: WhenCreated
  • Type: String
  • Format: date-time
ServerRole *
  • Field Name: ServerRole
  • Type: String
DnsLogMaxAge * 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. 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 DnsLogMaxAge parameter to 00:00:00 prevents the automatic removal of DNS log files because of their age.
  • Field Name: DnsLogMaxAge
  • Type: String
ReceiveProtocolLogMaxDirectorySize * 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: B (bytes) KB (kilobytes) MB (megabytes) GB (gigabytes) TB (terabytes) 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 unlimited, no size limit is imposed on the Receive connector protocol log directory.
  • Field Name: ReceiveProtocolLogMaxDirectorySize
  • Type: String
AdminDisplayVersion *
  • Field Name: AdminDisplayVersion
  • Type: String
ExchangeVersion *
  • Field Name: ExchangeVersion
  • Type: String
ResourceLogEnabled * This parameter is reserved for internal Microsoft use.
  • Field Name: ResourceLogEnabled
  • Type: Boolean
AgentLogMaxAge * 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. 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.
  • Field Name: AgentLogMaxAge
  • Type: String
AgentLogMaxDirectorySize * 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: B (bytes) KB (kilobytes) MB (megabytes) GB (gigabytes) TB (terabytes) 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 unlimited, no size limit is imposed on the agent log directory.
  • Field Name: AgentLogMaxDirectorySize
  • Type: String
ReceiveProtocolLogPath * 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 %ExchangeInstallPath%TransportRoles\Logs\FrontEnd\ProtocolLog\SmtpReceive. Setting the value of this parameter to $null disables protocol logging for all Receive connectors on the server. However, setting this parameter to $null when the value of the ProtocolLoggingLevel attribute for any Receive connector on the server is Verbose generates event log errors. The preferred method of disabling protocol logging is to use the Set-ReceiveConnector cmdlet to set the ProtocolLoggingLevel to None on each Receive connector.
  • Field Name: ReceiveProtocolLogPath
  • Type: String
InternalDNSAdapterEnabled * 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 the Exchange organization are performed by using the DNS settings of the internal network adapter specified by the value of the InternalDNSAdapterGuid parameter. If you want to specify a custom list of DNS servers used for internal Exchange DNS lookups only, you must specify the DNS servers by using the InternalDNSServers parameter, and you must also set the value of the InternalDNSAdapterEnabled parameter to $false. The default value of the InternalDNSAdapterEnabled parameter is $true.
  • Field Name: InternalDNSAdapterEnabled
  • Type: Boolean
ConnectivityLogEnabled * The ConnectivityLogEnabled parameter specifies whether the connectivity log is enabled. The default value is $true.
  • Field Name: ConnectivityLogEnabled
  • Type: Boolean
ConnectivityLogPath * The ConnectivityLogPath parameter specifies the default connectivity log directory location. The default location is %ExchangeInstallPath%TransportRoles\Logs\FrontEnd\Connectivity. Setting the value of this parameter to $null disables connectivity logging. However, setting this parameter to $null when the value of the ConnectivityLogEnabled attribute is $true generates event log errors.
  • Field Name: ConnectivityLogPath
  • Type: String
InternalDNSProtocolOption * The InternalDNSProtocolOption parameter specifies which protocol to use when you query internal DNS servers. Valid options for this parameter are Any, UseTcpOnly, or UseUdpOnly. The default value is Any.
  • Field Name: InternalDNSProtocolOption
  • Type: String
ExternalDNSAdapterGuid * 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 00000000-0000-0000-0000-000000000000, and external DNS lookups are performed by using the DNS settings of any available network adapter. You may enter the GUID of a specific network adapter to use for external DNS lookups. The default value of the ExternalDNSAdapterGuid parameter is 00000000-0000-0000-0000-000000000000. If the value of the ExternalDNSAdapterEnabled parameter is set to $false, the value of the ExternalDNSAdapterGuid parameter is ignored, and the list of DNS servers from the ExternalDNSServers parameter is used.
  • Field Name: ExternalDNSAdapterGuid
  • Type: String
ObjectCategory *
  • Field Name: ObjectCategory
  • Type: String
AttributionLogMaxAge * This parameter is reserved for internal Microsoft use.
  • Field Name: AttributionLogMaxAge
  • Type: String
IsValid *
  • Field Name: IsValid
  • Type: Boolean
SendProtocolLogPath * The SendProtocolLogPath parameter specifies the location of protocol log storage for the Send connectors. The default location is %ExchangeInstallPath%TransportRoles\Logs\FrontEnd\ProtocolLog\SmtpSend. Setting the value of this parameter to $null disables protocol logging for all Send connectors on the server. However, setting this parameter to $null when the value of the ProtocolLoggingLevel or IntraOrgConnectorProtocolLoggingLevel attribute for any Send connector on the server is Verbose generates event log errors. The preferred method of disabling protocol logging is to use the Set-SendConnector cmdlet to set the ProtocolLoggingLevel parameter to None on each Send connector and to set the IntraOrgConnectorProtocolLoggingLevel parameter to None.
  • Field Name: SendProtocolLogPath
  • Type: String
AttributionLogMaxFileSize * This parameter is reserved for internal Microsoft use.
  • Field Name: AttributionLogMaxFileSize
  • Type: String
AgentLogEnabled * The AgentLogEnabled parameter specifies whether the agent log is enabled. The default value is $true.
  • Field Name: AgentLogEnabled
  • Type: Boolean
WhenChangedUTC *
  • Field Name: WhenChangedUTC
  • Type: String
  • Format: date-time
Edition *
  • Field Name: Edition
  • Type: String
VersionNumber *
  • Field Name: VersionNumber
  • Type: Integer
ObjectState *
  • Field Name: ObjectState
  • Type: String
TransientFailureRetryInterval * 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.
  • Field Name: TransientFailureRetryInterval
  • Type: String
MaxReceiveTlsRatePerMinute * This parameter is reserved for internal Microsoft use.
  • Field Name: MaxReceiveTlsRatePerMinute
  • Type: Integer
AgentLogPath * 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 disables agent logging. However, setting this parameter to $null when the value of the AgentLogEnabled attribute is $true generates event log errors.
  • Field Name: AgentLogPath
  • Type: String
SendProtocolLogMaxAge * 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.
  • Field Name: SendProtocolLogMaxAge
  • Type: String
AgentLogMaxFileSize * 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: B (bytes) KB (kilobytes) MB (megabytes) GB (gigabytes) TB (terabytes) 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 unlimited, no size limit is imposed on the agent log files.
  • Field Name: AgentLogMaxFileSize
  • Type: String
RunspaceId
  • Field Name: RunspaceId
  • Type: String
Guid *
  • Field Name: Guid
  • Type: String
ResourceLogMaxFileSize * This parameter is reserved for internal Microsoft use.
  • Field Name: ResourceLogMaxFileSize
  • Type: String
Id *
  • Field Name: Id
  • Type: String
MaxConnectionRatePerMinute * 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.
  • Field Name: MaxConnectionRatePerMinute
  • Type: Integer
API reference for device/exchangehybrid/FrontendTransportService