[Index]
Model ref.: device/exchangehybrid/TransportServer
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{ "$schema": "http://json-schema.org/draft-03/schema", "type": "object", "properties": { "TransportMaintenanceLogMaxAge": { "__type_requested": "System.String", "required": true, "name": "TransportMaintenanceLogMaxAge", "title": "TransportMaintenanceLogMaxAge", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "FlowControlLogEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "FlowControlLogEnabled", "title": "FlowControlLogEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "This parameter is reserved for internal Microsoft use." }, "ExternalDNSProtocolOption": { "__type_requested": "System.String", "required": true, "name": "ExternalDNSProtocolOption", "title": "ExternalDNSProtocolOption", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "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." }, "IntraOrgConnectorProtocolLoggingLevel": { "__type_requested": "System.String", "required": true, "name": "IntraOrgConnectorProtocolLoggingLevel", "title": "IntraOrgConnectorProtocolLoggingLevel", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "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.\nValid 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." }, "WlmLogMaxFileSize": { "__type_requested": "System.String", "required": true, "name": "WlmLogMaxFileSize", "title": "WlmLogMaxFileSize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "ResourceLogPath": { "__type_requested": "LocalLongFullPath", "required": true, "description": "This parameter is reserved for internal Microsoft use.", "title": "ResourceLogPath", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "ResourceLogPath" }, "TransportSyncImapEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "TransportSyncImapEnabled", "title": "TransportSyncImapEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "This parameter is reserved for internal Microsoft use." }, "MessageTrackingLogMaxAge": { "__type_requested": "System.String", "required": true, "name": "MessageTrackingLogMaxAge", "title": "MessageTrackingLogMaxAge", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The MessageTrackingLogMaxAge parameter specifies the message tracking log maximum file age. Log files older than the specified value are deleted. The default value is 30 days.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor 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 MessageTrackingLogMaxAge parameter to 00:00:00 prevents the automatic removal of message tracking log files because of their age." }, "TransientFailureRetryCount": { "__type_requested": "System.Int32", "required": true, "name": "TransientFailureRetryCount", "title": "TransientFailureRetryCount", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "description": "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, and the next connection attempt is controlled by the OutboundConnectionFailureRetryInterval parameter." }, "ActiveUserStatisticsLogMaxFileSize": { "__type_requested": "System.String", "required": true, "name": "ActiveUserStatisticsLogMaxFileSize", "title": "ActiveUserStatisticsLogMaxFileSize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The ActiveUserStatisticsLogMaxFileSize parameter specifies the maximum file size for the per user activity statistics log files. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes.\nThe value of the ActiveUserStatisticsLogMaxFileSize parameter must be less than or equal to the value of the ActiveUserStatisticsLogMaxDirectorySize 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 server statistics log files." }, "PSShowComputerName": { "__type_requested": "System.Boolean", "required": false, "name": "PSShowComputerName", "title": "PSShowComputerName", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "JournalLogMaxFileSize": { "__type_requested": "System.String", "required": true, "name": "JournalLogMaxFileSize", "title": "JournalLogMaxFileSize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "RootDropDirectoryPath": { "__type_requested": "System.String", "required": true, "name": "RootDropDirectoryPath", "title": "RootDropDirectoryPath", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The RootDropDirectoryPath parameter specifies the top-level location of the Drop directory used by all Foreign connectors defined in the Transport service on a Mailbox server. The value of the RootDropDirectoryPath parameter may be a local path, or a Universal Naming Convention (UNC) path to a remote server. By default, the RootDropDirectoryPath parameter is blank. This indicates the value of RootDropDirectoryPath is the Exchange installation folder. The RootDropDirectoryPath parameter is used with the DropDirectory parameter in the Set-ForeignConnector cmdlet to specify the location for outgoing messages going to the address spaces defined on the Foreign connector." }, "TransportSyncMaxDownloadSizePerItem": { "__type_requested": "System.String", "required": true, "name": "TransportSyncMaxDownloadSizePerItem", "title": "TransportSyncMaxDownloadSizePerItem", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "MaxOutboundConnections": { "__type_requested": "System.String", "required": true, "name": "MaxOutboundConnections", "title": "MaxOutboundConnections", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The MaxOutboundConnections parameter specifies the maximum number of outbound connections that can be open at a time. The default value is 1000. The valid input range for this parameter is from 1 through 2147483647. If you enter a value of unlimited, no limit is imposed on the number of outbound connections. The value of the MaxOutboundConnections parameter must be greater than or equal to the value of the MaxPerDomainOutboundConnections parameter." }, "IntraOrgConnectorSmtpMaxMessagesPerConnection": { "__type_requested": "System.Int32", "required": true, "name": "IntraOrgConnectorSmtpMaxMessagesPerConnection", "title": "IntraOrgConnectorSmtpMaxMessagesPerConnection", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "description": "The IntraOrgConnectorSmtpMaxMessagesPerConnection parameter specifies the maximum number of messages per connection limit on the implicit and invisible intra-organization Send connectors that are used to transmit messages between Exchange servers in the Exchange organization." }, "InternalTransportCertificateThumbprint": { "__type_requested": "System.String", "required": true, "name": "InternalTransportCertificateThumbprint", "title": "InternalTransportCertificateThumbprint", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "MessageTrackingLogMaxFileSize": { "__type_requested": "System.String", "required": true, "name": "MessageTrackingLogMaxFileSize", "title": "MessageTrackingLogMaxFileSize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The MessageTrackingLogMaxFileSize parameter specifies the maximum size of the message tracking log files. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes.\nThe value of the MessageTrackingLogMaxFileSize parameter must be less than or equal to the value of the MessageTrackingLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 4294967296 bytes (4 GB). If you enter a value of unlimited, no size limit is imposed on the message tracking log files." }, "JournalLogMaxDirectorySize": { "__type_requested": "System.String", "required": true, "name": "JournalLogMaxDirectorySize", "title": "JournalLogMaxDirectorySize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "InternalDNSServers": { "__type_requested": "MultiValuedProperty", "required": true, "name": "InternalDNSServers", "title": "InternalDNSServers", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "description": "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. The default value is any empty list ({}).\nTo enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: \"<value1>\",\"<value2>\"....\nTo add or remove one or more values without affecting any existing entries, use the following syntax: @{Add=\"<value1>\",\"<value2>\"...; Remove=\"<value1>\",\"<value2>\"...}.\nIf 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." }, "OriginatingServer": { "__type_requested": "System.String", "required": true, "name": "OriginatingServer", "title": "OriginatingServer", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "TransportSyncLogMaxDirectorySize": { "__type_requested": "System.String", "required": true, "name": "TransportSyncLogMaxDirectorySize", "title": "TransportSyncLogMaxDirectorySize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "ProcessingSchedulerLogMaxDirectorySize": { "__type_requested": "System.String", "required": true, "name": "ProcessingSchedulerLogMaxDirectorySize", "title": "ProcessingSchedulerLogMaxDirectorySize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "TransportMaintenanceLogEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "TransportMaintenanceLogEnabled", "title": "TransportMaintenanceLogEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "This parameter is reserved for internal Microsoft use." }, "SendProtocolLogMaxAge": { "__type_requested": "System.String", "required": true, "name": "SendProtocolLogMaxAge", "title": "SendProtocolLogMaxAge", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "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.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor 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." }, "ActiveUserStatisticsLogMaxAge": { "__type_requested": "System.String", "required": true, "name": "ActiveUserStatisticsLogMaxAge", "title": "ActiveUserStatisticsLogMaxAge", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The ActiveUserStatisticsLogMaxAge parameter specifies the maximum duration that the per user activity statistics log files are kept. Log files older than the specified value are deleted. The default value is 30 days.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, to specify 10 days for this parameter, use 10.00:00:00. The valid input range for this parameter is from 00:00:00 through 24855.03:14:07. Setting the value of this parameter to 00:00:00 prevents the automatic removal of server statistics log files." }, "WhenCreated": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenCreated", "title": "WhenCreated", "format": "date-time", "required": true, "readonly": false, "type": "string" }, "DelayNotificationTimeout": { "__type_requested": "System.String", "required": true, "name": "DelayNotificationTimeout", "title": "DelayNotificationTimeout", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The DelayNotificationTimeout parameter specifies how long the server waits before it generates a delayed delivery status notification (DSN) message. The default value is 4 hours.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, to specify 3.5 hours for this parameter, use 03:30:00. The valid input range for this parameter is from 00:00:01 through 30.00:00:00. The value of the DelayNotificationTimeout parameter should always be greater than the value of the TransientFailureRetryCount parameter multiplied by the value of the TransientFailureRetryInterval parameter." }, "ExchangeVersion": { "__type_requested": "System.String", "required": true, "name": "ExchangeVersion", "title": "ExchangeVersion", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "WindowsLiveHotmailTransportSyncEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "WindowsLiveHotmailTransportSyncEnabled", "title": "WindowsLiveHotmailTransportSyncEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "This parameter is reserved for internal Microsoft use." }, "TransportMaintenanceLogPath": { "__type_requested": "LocalLongFullPath", "required": true, "description": "This parameter is reserved for internal Microsoft use.", "title": "TransportMaintenanceLogPath", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "TransportMaintenanceLogPath" }, "ConnectivityLogEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "ConnectivityLogEnabled", "title": "ConnectivityLogEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The ConnectivityLogEnabled parameter specifies whether the connectivity log is enabled. The default value is $true." }, "ConnectivityLogPath": { "__type_requested": "System.String", "required": true, "name": "ConnectivityLogPath", "title": "ConnectivityLogPath", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The ConnectivityLogPath parameter specifies the default connectivity log directory location. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\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." }, "TransportSyncLogLoggingLevel": { "__type_requested": "System.String", "required": true, "name": "TransportSyncLogLoggingLevel", "title": "TransportSyncLogLoggingLevel", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "AntispamUpdatesEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "AntispamUpdatesEnabled", "title": "AntispamUpdatesEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean" }, "IrmLogMaxDirectorySize": { "__type_requested": "System.String", "required": true, "name": "IrmLogMaxDirectorySize", "title": "IrmLogMaxDirectorySize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This IrmLogMaxDirectorySize parameter specifies the maximum size of all IRM 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 250 MB.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes.\nThe value of the IrmLogMaxFileSize parameter must be less than or equal to the value of the IrmLogMaxDirectorySize 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 IRM log directory." }, "ConnectivityLogMaxAge": { "__type_requested": "System.String", "required": true, "name": "ConnectivityLogMaxAge", "title": "ConnectivityLogMaxAge", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "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.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor 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." }, "InternalDNSAdapterEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "InternalDNSAdapterEnabled", "title": "InternalDNSAdapterEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "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." }, "MessageTrackingLogEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "MessageTrackingLogEnabled", "title": "MessageTrackingLogEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The MessageTrackingLogEnabled parameter specifies whether message tracking is enabled. The default value is $true." }, "AgentLogPath": { "__type_requested": "System.String", "required": true, "name": "AgentLogPath", "title": "AgentLogPath", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The AgentLogPath parameter specifies the default agent log directory location. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\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." }, "MessageTrackingLogSubjectLoggingEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "MessageTrackingLogSubjectLoggingEnabled", "title": "MessageTrackingLogSubjectLoggingEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The MessageTrackingLogSubjectLoggingEnabled parameter specifies whether the message subject should be included in the message tracking log. The default value is $true." }, "RunspaceId": { "__type_requested": "System.Guid", "required": false, "name": "RunspaceId", "title": "RunspaceId", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Guid": { "__type_requested": "System.Guid", "required": true, "name": "Guid", "title": "Guid", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "HttpProtocolLogLoggingLevel": { "__type_requested": "System.String", "required": true, "name": "HttpProtocolLogLoggingLevel", "title": "HttpProtocolLogLoggingLevel", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "OrganizationId": { "__type_requested": "System.String", "required": true, "name": "OrganizationId", "title": "OrganizationId", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "FlowControlLogMaxFileSize": { "__type_requested": "System.String", "required": true, "name": "FlowControlLogMaxFileSize", "title": "FlowControlLogMaxFileSize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "ProcessingSchedulerLogMaxAge": { "__type_requested": "System.String", "required": true, "name": "ProcessingSchedulerLogMaxAge", "title": "ProcessingSchedulerLogMaxAge", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "TransportSyncLogMaxAge": { "__type_requested": "System.String", "required": true, "name": "TransportSyncLogMaxAge", "title": "TransportSyncLogMaxAge", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "ProcessingSchedulerLogEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "ProcessingSchedulerLogEnabled", "title": "ProcessingSchedulerLogEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "This parameter is reserved for internal Microsoft use." }, "DnsLogPath": { "__type_requested": "LocalLongFullPath", "required": true, "description": "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 (\").", "title": "DnsLogPath", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "DnsLogPath" }, "PickupDirectoryPath": { "__type_requested": "System.String", "required": true, "name": "PickupDirectoryPath", "title": "PickupDirectoryPath", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The PickupDirectoryPath parameter specifies the location of the Pickup directory. The Pickup directory is used by administrators and third-party applications to create and submit messages. The default location is %ExchangeInstallPath%TransportRoles\\Pickup. If the value of the PickupDirectoryPath parameter is set to $null, the Pickup directory is disabled." }, "TransportSyncFacebookEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "TransportSyncFacebookEnabled", "title": "TransportSyncFacebookEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "This parameter is reserved for internal Microsoft use." }, "PoisonThreshold": { "__type_requested": "System.Int32", "required": true, "name": "PoisonThreshold", "title": "PoisonThreshold", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "description": "The PoisonThreshold parameter specifies the number of times a message can be rejected before it's classified as a poison message. The default value is 2. We recommend that you don't modify the default value unless Customer Service and Support advises you to do this. The valid input range for this parameter is from 1 through 10." }, "WlmLogMaxDirectorySize": { "__type_requested": "System.String", "required": true, "name": "WlmLogMaxDirectorySize", "title": "WlmLogMaxDirectorySize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "InternalDNSAdapterGuid": { "__type_requested": "System.Guid", "required": true, "name": "InternalDNSAdapterGuid", "title": "InternalDNSAdapterGuid", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "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.\nIf 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." }, "JournalLogMaxAge": { "__type_requested": "System.String", "required": true, "name": "JournalLogMaxAge", "title": "JournalLogMaxAge", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "FlowControlLogMaxDirectorySize": { "__type_requested": "System.String", "required": true, "name": "FlowControlLogMaxDirectorySize", "title": "FlowControlLogMaxDirectorySize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "MaxNumberOfTransportSyncAttempts": { "__type_requested": "System.Int32", "required": true, "name": "MaxNumberOfTransportSyncAttempts", "title": "MaxNumberOfTransportSyncAttempts", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "description": "This parameter is reserved for internal Microsoft use." }, "AntispamAgentsEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "AntispamAgentsEnabled", "title": "AntispamAgentsEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "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 Transport service on Mailbox servers and $true on Edge servers.\nYou set this parameter by using a script. You shouldn't modify this parameter manually." }, "DistinguishedName": { "__type_requested": "System.String", "required": true, "name": "DistinguishedName", "title": "DistinguishedName", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "PipelineTracingPath": { "__type_requested": "System.String", "required": true, "name": "PipelineTracingPath", "title": "PipelineTracingPath", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The PipelineTracingPath parameter specifies the location of the pipeline tracing logs. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\PipelineTracing. The path must be local to the Exchange computer. Setting the value of this parameter to $null disables pipeline tracing. However, setting this parameter to $null when the value of the PipelineTracingEnabled attribute is $true generates event log errors. The preferred method to disable pipeline tracing is to use the PipelineTracingEnabled parameter. Pipeline tracing captures the complete contents of e-mail messages to the path specified by the PipelineTracingPath parameter. Make sure that you restrict access to this directory. The permissions required on the directory specified by the PipelineTracingPath parameter are as follows:\nAdministrators: Full Control\nNetwork Service: Full Control\nSystem: Full Control" }, "ReceiveProtocolLogMaxAge": { "__type_requested": "System.String", "required": true, "name": "ReceiveProtocolLogMaxAge", "title": "ReceiveProtocolLogMaxAge", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "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.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor 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." }, "ExternalDNSAdapterEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "ExternalDNSAdapterEnabled", "title": "ExternalDNSAdapterEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "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." }, "IrmLogMaxFileSize": { "__type_requested": "System.String", "required": true, "name": "IrmLogMaxFileSize", "title": "IrmLogMaxFileSize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This IrmLogMaxFileSize parameter specifies the maximum size of each IRM log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes.\nThe value of the IrmLogMaxFileSize parameter must be less than or equal to the value of the IrmLogMaxDirectorySize 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 IRM log files." }, "MaxConcurrentMailboxDeliveries": { "__type_requested": "System.Int32", "required": true, "name": "MaxConcurrentMailboxDeliveries", "title": "MaxConcurrentMailboxDeliveries", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "description": "The MaxConcurrentMailboxDeliveries parameter specifies the maximum number of delivery threads that the transport service can have open at the same time to deliver messages to mailboxes. The default value is 20. The valid input range for this parameter is from 1 through 256. We recommend that you don't modify the default value unless Microsoft Customer Service and Support advises you to do this." }, "RecipientValidationCacheEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "RecipientValidationCacheEnabled", "title": "RecipientValidationCacheEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The RecipientValidationCacheEnabled parameter specifies whether the recipient addresses used by transport agents, such as the Recipient Filtering agent, are cached. The default value is $true on Edge servers and $false for the Transport service on Mailbox servers." }, "TransportSyncLogMaxFileSize": { "__type_requested": "System.String", "required": true, "name": "TransportSyncLogMaxFileSize", "title": "TransportSyncLogMaxFileSize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "ProcessingSchedulerLogPath": { "__type_requested": "LocalLongFullPath", "required": true, "description": "This parameter is reserved for internal Microsoft use.", "title": "ProcessingSchedulerLogPath", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "ProcessingSchedulerLogPath" }, "ServerStatisticsLogPath": { "__type_requested": "System.String", "required": true, "name": "ServerStatisticsLogPath", "title": "ServerStatisticsLogPath", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The ServerStatisticsLogPath parameter specifies the location of server statistics log storage. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\ServerStats. Setting the value of this parameter to $null disables server statistics logging." }, "UseDowngradedExchangeServerAuth": { "__type_requested": "System.Boolean", "required": true, "name": "UseDowngradedExchangeServerAuth", "title": "UseDowngradedExchangeServerAuth", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The UseDowngradedExchangeServerAuth parameter specifies whether the Generic Security Services application programming interface (GSSAPI) authentication method is used on connections where Transport Layer Security (TLS) is disabled.\nNormally, TLS is required for connections between the Transport services on Mailbox servers in your organization. On TLS secured connections, Kerberos authentication is used by default. However, there may be scenarios where you need to disable TLS between specific Transport services in your organization. When you do that, you need to set this parameter to $true to provide an alternative authentication method. The default value is $false. You shouldn't set this value to $true unless it's absolutely required.\nIf you set this parameter to $true, you also need to create a specific Receive connector to service the non-TLS connections. This Receive connector must have remote IP address ranges specified to ensure that it's only used for non-TLS connections. You also must set the SuppressXAnonymousTls attribute of the Receive connector to $true." }, "AgentLogMaxDirectorySize": { "__type_requested": "System.String", "required": true, "name": "AgentLogMaxDirectorySize", "title": "AgentLogMaxDirectorySize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "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.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes.\nThe 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." }, "DnsLogEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "DnsLogEnabled", "title": "DnsLogEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The DnsLogEnabled parameter specifies whether the DNS log is enabled. The default value is $false." }, "InternalDNSProtocolOption": { "__type_requested": "System.String", "required": true, "name": "InternalDNSProtocolOption", "title": "InternalDNSProtocolOption", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The InternalDNSProtocolOption parameter specifies which protocol to use when you query internal DNS servers. Valid options for this parameter are Any, UseTcpOnly, or UseUdpOnly.\nThe default value is Any." }, "ObjectCategory": { "__type_requested": "System.String", "required": true, "name": "ObjectCategory", "title": "ObjectCategory", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "IsValid": { "__type_requested": "System.Boolean", "required": true, "name": "IsValid", "title": "IsValid", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean" }, "HttpProtocolLogFilePath": { "__type_requested": "LocalLongFullPath", "required": true, "description": "This parameter is reserved for internal Microsoft use.", "title": "HttpProtocolLogFilePath", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "HttpProtocolLogFilePath" }, "QueueMaxIdleTime": { "__type_requested": "System.String", "required": true, "name": "QueueMaxIdleTime", "title": "QueueMaxIdleTime", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The QueueMaxIdleTime parameter specifies the period of time an empty delivery queue can exist before the queue is removed. The default value is 3 minutes.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, to specify 5 minutes for this parameter, use 00:05:00. The valid input range for this parameter is from 00:00:05 through 01:00:00. We recommend that you don't modify the default value unless Customer Service and Support advises you to do this." }, "RoutingTableLogPath": { "__type_requested": "System.String", "required": true, "name": "RoutingTableLogPath", "title": "RoutingTableLogPath", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The RoutingTableLogPath parameter specifies the directory location where routing table log files should be stored. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Routing. Setting the value of the RoutingTableLogPath parameter to $null disables routing table logging." }, "WhenChanged": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenChanged", "title": "WhenChanged", "format": "date-time", "required": true, "readonly": false, "type": "string" }, "ObjectState": { "__type_requested": "System.String", "required": true, "name": "ObjectState", "title": "ObjectState", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "TransientFailureRetryInterval": { "__type_requested": "System.String", "required": true, "name": "TransientFailureRetryInterval", "title": "TransientFailureRetryInterval", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The TransientFailureRetryInterval parameter controls the connection interval between each connection attempt specified by the TransientFailureRetryCount parameter. For the Transport service on a Mailbox server, the default value of the TransientFailureRetryInterval parameter is 5 minutes. On an Edge server, the default value is 10 minutes.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor 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." }, "PickupDirectoryMaxMessagesPerMinute": { "__type_requested": "System.Int32", "required": true, "name": "PickupDirectoryMaxMessagesPerMinute", "title": "PickupDirectoryMaxMessagesPerMinute", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "description": "The PickupDirectoryMaxMessagesPerMinute parameter specifies the maximum number of messages processed per minute by the Pickup directory and by the Replay directory. Each directory can independently process message files at the rate specified by the PickupDirectoryMaxMessagesPerMinute parameter. The default value is 100. The valid input range for this parameter is from 1 through 20000." }, "ServerStatisticsLogMaxFileSize": { "__type_requested": "System.String", "required": true, "name": "ServerStatisticsLogMaxFileSize", "title": "ServerStatisticsLogMaxFileSize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The ServerStatisticsLogMaxFileSize parameter specifies the maximum file size for the server statistics log files. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes.\nThe value of the ServerStatisticsLogMaxFileSize parameter must be less than or equal to the value of the ServerStatisticsLogMaxDirectorySize 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 server statistics log files." }, "TransportSyncHubHealthLogMaxDirectorySize": { "__type_requested": "System.String", "required": true, "name": "TransportSyncHubHealthLogMaxDirectorySize", "title": "TransportSyncHubHealthLogMaxDirectorySize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "AgentLogMaxFileSize": { "__type_requested": "System.String", "required": true, "name": "AgentLogMaxFileSize", "title": "AgentLogMaxFileSize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "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.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes.\nThe 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." }, "RoutingTableLogMaxAge": { "__type_requested": "System.String", "required": true, "name": "RoutingTableLogMaxAge", "title": "RoutingTableLogMaxAge", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "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.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, to specify 5 days for this parameter, use 5.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 RoutingTableLogMaxAge parameter to 00:00:00 prevents the automatic removal of routing table log files because of their age." }, "MaxConnectionRatePerMinute": { "__type_requested": "System.Int32", "required": true, "name": "MaxConnectionRatePerMinute", "title": "MaxConnectionRatePerMinute", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "description": "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." }, "ProcessingSchedulerLogMaxFileSize": { "__type_requested": "System.String", "required": true, "name": "ProcessingSchedulerLogMaxFileSize", "title": "ProcessingSchedulerLogMaxFileSize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "HttpProtocolLogMaxDirectorySize": { "__type_requested": "System.String", "required": true, "name": "HttpProtocolLogMaxDirectorySize", "title": "HttpProtocolLogMaxDirectorySize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "ReceiveProtocolLogMaxFileSize": { "__type_requested": "System.String", "required": true, "name": "ReceiveProtocolLogMaxFileSize", "title": "ReceiveProtocolLogMaxFileSize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "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.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes.\nThe 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." }, "TransportSyncAccountsPoisonItemThreshold": { "__type_requested": "System.Int32", "required": true, "name": "TransportSyncAccountsPoisonItemThreshold", "title": "TransportSyncAccountsPoisonItemThreshold", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "description": "This parameter is reserved for internal Microsoft use." }, "ResourceLogMaxDirectorySize": { "__type_requested": "System.String", "required": true, "name": "ResourceLogMaxDirectorySize", "title": "ResourceLogMaxDirectorySize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "ContentConversionTracingEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "ContentConversionTracingEnabled", "title": "ContentConversionTracingEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The ContentConversionTracingEnabled parameter specifies whether content conversion tracing is enabled. Content conversion tracing captures content conversion failures that occur in the Transport service on a Mailbox server or on the Edge server. The default value is $false. Content conversion tracing captures a maximum of 128 MB of content conversion failures. When the 128 MB limit is reached, no more content conversion failures are captured. Content conversion tracing captures the complete contents of e-mail messages to the path specified by the PipelineTracingPath parameter. Make sure that you restrict access to this directory. The permissions required on the directory specified by the PipelineTracingPath parameter are as follows:\nAdministrators: Full Control\nNetwork Service: Full Control\nSystem: Full Control" }, "TransportMaintenanceLogMaxFileSize": { "__type_requested": "System.String", "required": true, "name": "TransportMaintenanceLogMaxFileSize", "title": "TransportMaintenanceLogMaxFileSize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "TransportSyncExchangeEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "TransportSyncExchangeEnabled", "title": "TransportSyncExchangeEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "This parameter is reserved for internal Microsoft use." }, "QueueLogMaxDirectorySize": { "__type_requested": "System.String", "required": true, "name": "QueueLogMaxDirectorySize", "title": "QueueLogMaxDirectorySize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The QueueLogMaxDirectorySize parameter specifies the maximum size of the queue log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The default value is 200 MB.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes.\nThe value of the QueueLogMaxFileSize parameter must be less than or equal to the value of the QueueLogMaxDirectorySize 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 queue log directory." }, "OutboundConnectionFailureRetryInterval": { "__type_requested": "System.String", "required": true, "name": "OutboundConnectionFailureRetryInterval", "title": "OutboundConnectionFailureRetryInterval", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The OutboundConnectionFailureRetryInterval parameter specifies the retry interval for subsequent connection attempts to a remote server where previous connection attempts have failed. The previously failed connection attempts are controlled by the TransientFailureRetryCount and TransientFailureRetryInterval parameters. For the Transport service on a Mailbox server, the default value of the OutboundConnectionFailureRetryInterval parameter is 10 minutes. On an Edge server, the default value is 30 minutes.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, to specify 15 minutes for this parameter, use 00:15:00. The valid input range for this parameter is from 00:00:01 through 20.00:00:00." }, "HttpProtocolLogMaxAge": { "__type_requested": "System.String", "required": true, "name": "HttpProtocolLogMaxAge", "title": "HttpProtocolLogMaxAge", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "ConnectivityLogMaxFileSize": { "__type_requested": "System.String", "required": true, "name": "ConnectivityLogMaxFileSize", "title": "ConnectivityLogMaxFileSize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "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.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes.\nThe 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." }, "TransportSyncHubHealthLogFilePath": { "__type_requested": "LocalLongFullPath", "required": true, "description": "This parameter is reserved for internal Microsoft use.", "title": "TransportSyncHubHealthLogFilePath", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "TransportSyncHubHealthLogFilePath" }, "ReplayDirectoryPath": { "__type_requested": "System.String", "required": true, "name": "ReplayDirectoryPath", "title": "ReplayDirectoryPath", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The ReplayDirectoryPath parameter specifies the path of the Replay directory. The Replay directory is used to resubmit exported messages and to receive messages from foreign gateway servers. The default location is %ExchangeInstallPath%TransportRoles\\Replay. If the value of the ReplayDirectoryPath parameter is set to $null, the Replay directory is disabled." }, "PickupDirectoryMaxHeaderSize": { "__type_requested": "System.String", "required": true, "name": "PickupDirectoryMaxHeaderSize", "title": "PickupDirectoryMaxHeaderSize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The PickupDirectoryMaxHeaderSize parameter specifies the maximum message header size that can be submitted to the Pickup directory. The default value is 64 KB.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes.\nThe valid input range for this parameter is from 32768 through 2147483647 bytes." }, "DnsLogMaxFileSize": { "__type_requested": "System.String", "required": true, "name": "DnsLogMaxFileSize", "title": "DnsLogMaxFileSize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "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.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes.\nThe 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." }, "PSComputerName": { "__type_requested": "System.String", "required": false, "name": "PSComputerName", "title": "PSComputerName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "PipelineTracingEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "PipelineTracingEnabled", "title": "PipelineTracingEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The PipelineTracingEnabled parameter specifies whether to enable pipeline tracing. Pipeline tracing captures message snapshot files that record the changes made to the message by each transport agent configured in the transport service on the server. Pipeline tracing creates verbose log files that accumulate quickly. Pipeline tracing should only be enabled for a short time to provide in-depth diagnostic information that enables you to troubleshoot problems. In addition to troubleshooting, you can use pipeline tracing to validate changes that you make to the configuration of the transport service where you enable pipeline tracing. The default value is $false." }, "FlowControlLogPath": { "__type_requested": "LocalLongFullPath", "required": true, "description": "This parameter is reserved for internal Microsoft use.", "title": "FlowControlLogPath", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "FlowControlLogPath" }, "FlowControlLogMaxAge": { "__type_requested": "System.String", "required": true, "name": "FlowControlLogMaxAge", "title": "FlowControlLogMaxAge", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "AgentLogEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "AgentLogEnabled", "title": "AgentLogEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The AgentLogEnabled parameter specifies whether the agent log is enabled. The default value is $true." }, "Identity": { "__type_requested": "System.String", "required": true, "name": "Identity", "title": "Identity", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The Identity parameter specifies the server you want to view. When you use this parameter on a Mailbox server, the parameter returns the transport configuration of the Transport service on specified server. You can't use this parameter on an Edge Transport server." }, "IrmLogMaxAge": { "__type_requested": "System.String", "required": true, "name": "IrmLogMaxAge", "title": "IrmLogMaxAge", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The IrmLogMaxAge parameter specifies the maximum age for the IRM log file. Log files that are older than the specified value are deleted. The default value is 30 days.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nThe valid input range for this parameter is 00:00:00 to 24855.03:14:07. Setting the value of the IrmLogMaxAge parameter to 00:00:00 prevents the automatic removal of connectivity log files because of their age." }, "ReceiveProtocolLogPath": { "__type_requested": "System.String", "required": true, "name": "ReceiveProtocolLogPath", "title": "ReceiveProtocolLogPath", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "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\\Hub\\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." }, "DnsLogMaxDirectorySize": { "__type_requested": "System.String", "required": true, "name": "DnsLogMaxDirectorySize", "title": "DnsLogMaxDirectorySize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "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.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes.\nThe 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." }, "PickupDirectoryMaxRecipientsPerMessage": { "__type_requested": "System.Int32", "required": true, "name": "PickupDirectoryMaxRecipientsPerMessage", "title": "PickupDirectoryMaxRecipientsPerMessage", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "description": "The PickupDirectoryMaxRecipientsPerMessage parameter specifies the maximum number of recipients that can be included on an e-mail message. The default value is 100. The valid input range for this parameter is from 1 through 10000." }, "MessageRetryInterval": { "__type_requested": "System.String", "required": true, "name": "MessageRetryInterval", "title": "MessageRetryInterval", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The MessageRetryInterval parameter specifies the retry interval for individual messages after a connection failure with a remote server. The default value is 1 minute.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, to specify 2 minutes for this parameter, use 00:02:00. The valid input range for this parameter is from 00:00:01 through 1.00:00:00. We recommend that you don't modify the default value unless Customer Service and Support advises you to do this." }, "HttpProtocolLogEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "HttpProtocolLogEnabled", "title": "HttpProtocolLogEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "This parameter is reserved for internal Microsoft use." }, "MaxPerDomainOutboundConnections": { "__type_requested": "System.String", "required": true, "name": "MaxPerDomainOutboundConnections", "title": "MaxPerDomainOutboundConnections", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The MaxPerDomainOutboundConnections parameter specifies the maximum number of concurrent connections to any single domain. The default value is 20. The valid input range for this parameter is from 1 through 2147483647. If you enter a value of unlimited, no limit is imposed on the number of outbound connections per domain. The value of the MaxPerDomainOutboundConnections parameter must be less than or equal to the value of the MaxOutboundConnections parameter." }, "JournalLogPath": { "__type_requested": "System.String", "required": true, "name": "JournalLogPath", "title": "JournalLogPath", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "SendProtocolLogMaxFileSize": { "__type_requested": "System.String", "required": true, "name": "SendProtocolLogMaxFileSize", "title": "SendProtocolLogMaxFileSize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "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.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes.\nThe 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." }, "ServerStatisticsLogMaxDirectorySize": { "__type_requested": "System.String", "required": true, "name": "ServerStatisticsLogMaxDirectorySize", "title": "ServerStatisticsLogMaxDirectorySize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The ServerStatisticsLogMaxDirectorySize parameter specifies the cap on the size of the server statistics 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:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes.\nThe value of the ServerStatisticsLogMaxFileSize parameter must be less than or equal to the value of the ServerStatisticsLogMaxDirectorySize 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 server statistics log directory." }, "TransportSyncAccountsPoisonAccountThreshold": { "__type_requested": "System.Int32", "required": true, "name": "TransportSyncAccountsPoisonAccountThreshold", "title": "TransportSyncAccountsPoisonAccountThreshold", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "description": "This parameter is reserved for internal Microsoft use." }, "TransportSyncLogFilePath": { "__type_requested": "LocalLongFullPath", "required": true, "description": "This parameter is reserved for internal Microsoft use.", "title": "TransportSyncLogFilePath", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "TransportSyncLogFilePath" }, "AgentLogMaxAge": { "__type_requested": "System.String", "required": true, "name": "AgentLogMaxAge", "title": "AgentLogMaxAge", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "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.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nSetting the value of the AgentLogMaxAge parameter to 00:00:00 prevents the automatic removal of agent log files because of their age." }, "ConnectivityLogMaxDirectorySize": { "__type_requested": "System.String", "required": true, "name": "ConnectivityLogMaxDirectorySize", "title": "ConnectivityLogMaxDirectorySize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "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.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes.\nThe 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." }, "QueueLogPath": { "__type_requested": "System.String", "required": true, "name": "QueueLogPath", "title": "QueueLogPath", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The QueueLogPath parameter specifies the path of the queue log directory. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\QueueViewer. Setting the value of this parameter to $null disables queue logging." }, "MaxConcurrentMailboxSubmissions": { "__type_requested": "System.Int32", "required": true, "name": "MaxConcurrentMailboxSubmissions", "title": "MaxConcurrentMailboxSubmissions", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "description": "The MaxConcurrentMailboxSubmissions parameter specifies the maximum number of submission threads that the transport service can have open at the same time to send messages from mailboxes. The default value is 20. The valid input range for this parameter is from 1 through 256." }, "ExternalDNSAdapterGuid": { "__type_requested": "System.Guid", "required": true, "name": "ExternalDNSAdapterGuid", "title": "ExternalDNSAdapterGuid", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "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.\nIf 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." }, "TransportSyncLinkedInEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "TransportSyncLinkedInEnabled", "title": "TransportSyncLinkedInEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "This parameter is reserved for internal Microsoft use." }, "TransportSyncEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "TransportSyncEnabled", "title": "TransportSyncEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "This parameter is reserved for internal Microsoft use." }, "ActiveUserStatisticsLogPath": { "__type_requested": "System.String", "required": true, "name": "ActiveUserStatisticsLogPath", "title": "ActiveUserStatisticsLogPath", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The ActiveUserStatisticsLogPath parameter specifies the location of per user activity statistics log storage. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\ActiveUsersStats. Setting the value of this parameter to $null disables server statistics logging." }, "WhenChangedUTC": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenChangedUTC", "title": "WhenChangedUTC", "format": "date-time", "required": true, "readonly": false, "type": "string" }, "MessageExpirationTimeout": { "__type_requested": "System.String", "required": true, "name": "MessageExpirationTimeout", "title": "MessageExpirationTimeout", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The MessageExpirationTimeout parameter specifies the maximum time that a particular message can remain in a queue. If a message remains in the queue for longer than this period of time, the message is returned to the sender as a permanent failure. The default value is 2 days.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, to specify 3 days for this parameter, use 3.00:00:00. The valid input range for this parameter is from 00:00:05 through 90.00:00:00." }, "ExternalIPAddress": { "__type_requested": "IPAddress", "required": true, "description": "The ExternalIPAddress parameter specifies the IP address used in the Received message header field for every message that travels through the Edge server or the Transport service on a Mailbox 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.", "title": "ExternalIPAddress", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "ExternalIPAddress" }, "ReceiveProtocolLogMaxDirectorySize": { "__type_requested": "System.String", "required": true, "name": "ReceiveProtocolLogMaxDirectorySize", "title": "ReceiveProtocolLogMaxDirectorySize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "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.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes.\nThe 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." }, "DeltaSyncClientCertificateThumbprint": { "__type_requested": "System.String", "required": true, "name": "DeltaSyncClientCertificateThumbprint", "title": "DeltaSyncClientCertificateThumbprint", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "WlmLogMaxAge": { "__type_requested": "System.String", "required": true, "name": "WlmLogMaxAge", "title": "WlmLogMaxAge", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "ResourceLogMaxAge": { "__type_requested": "System.String", "required": true, "name": "ResourceLogMaxAge", "title": "ResourceLogMaxAge", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "ResourceLogMaxFileSize": { "__type_requested": "System.String", "required": true, "name": "ResourceLogMaxFileSize", "title": "ResourceLogMaxFileSize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "WhenCreatedUTC": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenCreatedUTC", "title": "WhenCreatedUTC", "format": "date-time", "required": true, "readonly": false, "type": "string" }, "PipelineTracingSenderAddress": { "__type_requested": "SmtpAddress", "required": true, "description": "The PipelineTracingSenderAddress parameter specifies the sender e-mail address that invokes pipeline tracing. Only messages from this address generate pipeline tracing output. The address can be either inside or outside the Exchange organization. Depending on your requirements, you may have to set this parameter to different sender addresses and send new messages to start the transport agents or routes that you want to test. The default value of this parameter is $null.", "title": "PipelineTracingSenderAddress", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "PipelineTracingSenderAddress" }, "TransportSyncRemoteConnectionTimeout": { "__type_requested": "System.String", "required": true, "name": "TransportSyncRemoteConnectionTimeout", "title": "TransportSyncRemoteConnectionTimeout", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "HttpProtocolLogMaxFileSize": { "__type_requested": "System.String", "required": true, "name": "HttpProtocolLogMaxFileSize", "title": "HttpProtocolLogMaxFileSize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "ServerStatisticsLogMaxAge": { "__type_requested": "System.String", "required": true, "name": "ServerStatisticsLogMaxAge", "title": "ServerStatisticsLogMaxAge", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The ServerStatisticsLogMaxAge parameter specifies the maximum duration that the server statistics log files are kept. Log files older than the specified value are deleted. The default value is 30 days.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, to specify 60 days for this parameter, use 60.00:00:00. The valid input range for this parameter is from 00:00:00 through 24855.03:14:07. Setting the value of this parameter to 00:00:00 prevents the automatic removal of server statistics log files." }, "ResourceLogEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "ResourceLogEnabled", "title": "ResourceLogEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "This parameter is reserved for internal Microsoft use." }, "QueueLogMaxAge": { "__type_requested": "System.String", "required": true, "name": "QueueLogMaxAge", "title": "QueueLogMaxAge", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The QueueLogMaxAge parameter specifies the maximum age of the queue log files. Log files that are older than the specified value are deleted. The default value is 7 days.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, to specify 10 days for this parameter, use 10.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 QueueLogMaxAge parameter to 00:00:00 prevents the automatic removal of queue log files because of their age." }, "TransportMaintenanceLogMaxDirectorySize": { "__type_requested": "System.String", "required": true, "name": "TransportMaintenanceLogMaxDirectorySize", "title": "TransportMaintenanceLogMaxDirectorySize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "MaxActiveTransportSyncJobsPerProcessor": { "__type_requested": "System.Int32", "required": true, "name": "MaxActiveTransportSyncJobsPerProcessor", "title": "MaxActiveTransportSyncJobsPerProcessor", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "description": "This parameter is reserved for internal Microsoft use." }, "RoutingTableLogMaxDirectorySize": { "__type_requested": "System.String", "required": true, "name": "RoutingTableLogMaxDirectorySize", "title": "RoutingTableLogMaxDirectorySize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "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 value is 50 MB.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes.\nThe valid input range for this parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the routing table log directory." }, "IrmLogPath": { "__type_requested": "System.String", "required": true, "name": "IrmLogPath", "title": "IrmLogPath", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The IrmLogPath parameter specifies the default IRM log directory location. The default location is %ExchangeInstallPath%Logging\\IRMLogs. If you set the value of the IrmLogPath parameter to $null, you effectively disable IRM logging. However, if you set the value of the IrmLogPath parameter to $null when the value of the IrmLogEnabled attribute is $true, Exchange will log errors in the Application event log. The preferred way for disabling IRM logging is to set the IrmLogEnabled to $false." }, "TransportSyncAccountsPoisonDetectionEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "TransportSyncAccountsPoisonDetectionEnabled", "title": "TransportSyncAccountsPoisonDetectionEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "This parameter is reserved for internal Microsoft use." }, "ObjectClass": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": true, "name": "ObjectClass", "title": "ObjectClass", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array" }, "PoisonMessageDetectionEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "PoisonMessageDetectionEnabled", "title": "PoisonMessageDetectionEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The PoisonMessageDetectionEnabled parameter specifies whether poison messages should be detected. The default value is $true. Poison messages are messages determined to be potentially harmful to the Exchange system after a server failure. Poison messages are put in the poison message queue. We recommend that you don't modify the default value unless Customer Service and Support advises you to do this." }, "MessageTrackingLogPath": { "__type_requested": "System.String", "required": true, "name": "MessageTrackingLogPath", "title": "MessageTrackingLogPath", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The MessageTrackingLogPath parameter specifies the location of the message tracking logs. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\MessageTracking. Setting the value of this parameter to $null disables message tracking. However, setting this parameter to $null when the value of the MessageTrackingLogEnabled attribute is $true generates event log errors. The preferred method to disable message tracking is to use the MessageTrackingLogEnabled parameter." }, "ExternalDNSServers": { "__type_requested": "MultiValuedProperty", "required": true, "name": "ExternalDNSServers", "title": "ExternalDNSServers", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "description": "The ExternalDNSServers parameter specifies the list of external DNS servers that the server queries when resolving a remote domain. DNS servers are specified by IP address. The default value is an empty list ({}).\nTo enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: \"<value1>\",\"<value2>\"....\nTo add or remove one or more values without affecting any existing entries, use the following syntax: @{Add=\"<value1>\",\"<value2>\"...; Remove=\"<value1>\",\"<value2>\"...}.\nIf the value of the ExternalDNSAdapterEnabled parameter is set to $true, the ExternalDNSServers parameter and its list of DNS servers isn't used." }, "Name": { "__type_requested": "System.String", "required": true, "name": "Name", "title": "Name", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "MessageTrackingLogMaxDirectorySize": { "__type_requested": "System.String", "required": true, "name": "MessageTrackingLogMaxDirectorySize", "title": "MessageTrackingLogMaxDirectorySize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The MessageTrackingLogMaxDirectorySize parameter specifies the maximum size of the message tracking log directory. When the maximum directory size is reached, the server deletes the oldest log files first.\nThe maximum size of the message tracking log directory is calculated as the total size of all log files that have the same name prefix. Other files that don't follow the name prefix convention aren't counted in the total directory size calculation. Renaming old log files or copying other files into the message tracking log directory could cause the directory to exceed its specified maximum size.\nFor Mailbox servers, the maximum size of the message tracking log directory isn't the specified maximum size because the message tracking log files generated by the Transport service and the Mailbox Transport service have different name prefixes. Message tracking log files for the Transport service or for Edge servers begin with the name prefix MSGTRK. Message tracking log files for the Mailbox Transport service begin with the name prefix MSGTRKM. For Mailbox servers, the maximum size of the message tracking log directory is two times the specified value.\nThe default value is 1000 MB.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes.\nThe value of the MessageTrackingLogMaxFileSize parameter must be less than or equal to the value of the MessageTrackingLogMaxDirectorySize 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 message tracking log directory." }, "SendProtocolLogMaxDirectorySize": { "__type_requested": "System.String", "required": true, "name": "SendProtocolLogMaxDirectorySize", "title": "SendProtocolLogMaxDirectorySize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "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.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes.\nThe 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." }, "TransportSyncHubHealthLogMaxFileSize": { "__type_requested": "System.String", "required": true, "name": "TransportSyncHubHealthLogMaxFileSize", "title": "TransportSyncHubHealthLogMaxFileSize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "IrmLogEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "IrmLogEnabled", "title": "IrmLogEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The IrmLogEnabled parameter enables logging of Information Rights Management (IRM) transactions. IRM logging is enabled by default. Values include:\n$true Enable IRM logging\n$false Disable IRM logging" }, "DnsLogMaxAge": { "__type_requested": "System.String", "required": true, "name": "DnsLogMaxAge", "title": "DnsLogMaxAge", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "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.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nSetting the value of the DnsLogMaxAge parameter to 00:00:00 prevents the automatic removal of DNS log files because of their age." }, "HttpTransportSyncProxyServer": { "__type_requested": "System.String", "required": true, "name": "HttpTransportSyncProxyServer", "title": "HttpTransportSyncProxyServer", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "TransportSyncMaxDownloadSizePerConnection": { "__type_requested": "System.String", "required": true, "name": "TransportSyncMaxDownloadSizePerConnection", "title": "TransportSyncMaxDownloadSizePerConnection", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "WlmLogPath": { "__type_requested": "System.String", "required": true, "name": "WlmLogPath", "title": "WlmLogPath", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "TransportSyncHubHealthLogMaxAge": { "__type_requested": "System.String", "required": true, "name": "TransportSyncHubHealthLogMaxAge", "title": "TransportSyncHubHealthLogMaxAge", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "TransportSyncMaxDownloadItemsPerConnection": { "__type_requested": "System.Int32", "required": true, "name": "TransportSyncMaxDownloadItemsPerConnection", "title": "TransportSyncMaxDownloadItemsPerConnection", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "description": "This parameter is reserved for internal Microsoft use." }, "SendProtocolLogPath": { "__type_requested": "System.String", "required": true, "name": "SendProtocolLogPath", "title": "SendProtocolLogPath", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The SendProtocolLogPath parameter specifies the location of protocol log storage for the Send connectors. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\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." }, "QueueLogMaxFileSize": { "__type_requested": "System.String", "required": true, "name": "QueueLogMaxFileSize", "title": "QueueLogMaxFileSize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The QueueLogMaxFileSize parameter specifies the maximum size of the queue log files. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes.\nThe value of the QueueLogMaxFileSize parameter must be less than or equal to the value of the QueueLogMaxDirectorySize 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 queue log files." }, "TransportSyncPopEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "TransportSyncPopEnabled", "title": "TransportSyncPopEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "This parameter is reserved for internal Microsoft use." }, "JournalLogEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "JournalLogEnabled", "title": "JournalLogEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "This parameter is reserved for internal Microsoft use." }, "TransportSyncAccountsSuccessivePoisonItemThreshold": { "__type_requested": "System.Int32", "required": true, "name": "TransportSyncAccountsSuccessivePoisonItemThreshold", "title": "TransportSyncAccountsSuccessivePoisonItemThreshold", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "description": "This parameter is reserved for internal Microsoft use." }, "TransportSyncHubHealthLogEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "TransportSyncHubHealthLogEnabled", "title": "TransportSyncHubHealthLogEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "This parameter is reserved for internal Microsoft use." }, "ActiveUserStatisticsLogMaxDirectorySize": { "__type_requested": "System.String", "required": true, "name": "ActiveUserStatisticsLogMaxDirectorySize", "title": "ActiveUserStatisticsLogMaxDirectorySize", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The ActiveUserStatisticsLogMaxDirectorySize parameter specifies the cap on the size of the per user activity statistics log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The minimum value is 1 megabyte (MB). The default value is 250 MB.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes.\nThe value of the ActiveUserStatisticsLogMaxFileSize parameter must be less than or equal to the value of the ActiveUserStatisticsLogMaxDirectorySize 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 server statistics log directory." }, "TransportSyncLogEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "TransportSyncLogEnabled", "title": "TransportSyncLogEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "This parameter is reserved for internal Microsoft use." }, "Id": { "__type_requested": "System.String", "required": true, "name": "Id", "title": "Id", "__type_mapping_type": "String", "readonly": false, "type": "string" } }, "schema_version": "15312" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/exchangehybrid/TransportServer/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/exchangehybrid/TransportServer/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangehybrid/TransportServer/[pkid1]", "/api/v0/device/exchangehybrid/TransportServer/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchangehybrid/TransportServer/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/exchangehybrid/TransportServer |
|
{"hrefs": ["/api/device/exchangehybrid/TransportServer/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchangehybrid/TransportServer |
|
{"hrefs": ["/api/device/exchangehybrid/TransportServer/[pkid1]", "/api/device/exchangehybrid/TransportServer/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchangehybrid/TransportServer; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchangehybrid/TransportServer/export/ |
|
{ "hrefs":["/api/device/exchangehybrid/TransportServer/[pkid1]", "/api/device/exchangehybrid/TransportServer/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip Content-Language:en Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of device/exchangehybrid/TransportServer and the JSON format can be used to import instances of device/exchangehybrid/TransportServer.
GET http://[host-proxy]/api/device/exchangehybrid/TransportServer/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/exchangehybrid/TransportServer | POST | /api/device/exchangehybrid/TransportServer/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/device/exchangehybrid/TransportServer/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/exchangehybrid/TransportServer/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/exchangehybrid/TransportServer/ |
|
The device/exchangehybrid/TransportServer schema and all instances as JSON. |
(The list will return 0 to 3 device/exchangehybrid/TransportServer instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "Name", "maximum_limit": 2000, "skip": 0, "current": "/api/device/exchangehybrid/TransportServer/?skip=0&limit=3&order_by=Name&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "15312", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/exchangehybrid/TransportServer/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Bulk Modify" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/exchangehybrid/TransportServer", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/exchangehybrid/TransportServer/export/?hierarchy=[hierarchy]", "method": "POST", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/device/exchangehybrid/TransportServer/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/exchangehybrid/TransportServer/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/exchangehybrid/TransportServer/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/exchangehybrid/TransportServer/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/exchangehybrid/TransportServer/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/exchangehybrid/TransportServer/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/exchangehybrid/TransportServer", "model_specific_actions": [ "get", "list", "update", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move" ], "summary_attrs": [ { "name": "Name", "title": "Name" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/exchangehybrid/TransportServer. | GET | /api/device/exchangehybrid/TransportServer/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchangehybrid/TransportServer as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/exchangehybrid/TransportServer/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/exchangehybrid/TransportServer/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchangehybrid/TransportServer/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchangehybrid/TransportServer | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a selected [export_format] of the schema and a single instance with [pkid] of device/exchangehybrid/TransportServer; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchangehybrid/TransportServer/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip Content-Language:en Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of device/exchangehybrid/TransportServer and the JSON format can be used to import instances of device/exchangehybrid/TransportServer.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/exchangehybrid/TransportServer/[pkid] | hierarchy=[hierarchy] | The device/exchangehybrid/TransportServer instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/exchangehybrid/TransportServer/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchangehybrid/TransportServer. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/exchangehybrid/TransportServer/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |