[Index]
Model ref.: device/exchange/MailboxTransportService
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": {
"MailboxSubmissionAgentLogMaxFileSize": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "MailboxSubmissionAgentLogMaxFileSize",
"title": "MailboxSubmissionAgentLogMaxFileSize",
"required": true,
"type": "string",
"description": "The MailboxSubmissionAgentLogMaxFileSize parameter specifies the maximum size of each agent log file for the Mailbox Transport Submission service. 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 MailboxSubmissionAgentLogMaxFileSize parameter must be less than or equal to the value of the MailboxSubmissionAgentLogMaxDirectorySize parameter. If you enter a value of unlimited, no size limit is imposed on the agent log files."
},
"MailboxSubmissionAgentLogMaxAge": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "MailboxSubmissionAgentLogMaxAge",
"title": "MailboxSubmissionAgentLogMaxAge",
"required": true,
"type": "string",
"description": "The MailboxSubmissionAgentLogMaxAge parameter specifies the maximum age for the agent log file of the Mailbox Transport Submission service. 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 MailboxSubmissionAgentLogMaxAge parameter to 00:00:00 prevents the automatic removal of agent log files because of their age."
},
"NetworkAddress": {
"__type_requested": "Deserialized.Microsoft.Exchange.Data.NetworkAddressCollection",
"__type_mapping_type": "Unknown",
"name": "NetworkAddress",
"title": "NetworkAddress",
"required": true,
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"PipelineTracingSenderAddress": {
"__type_requested": "SmtpAddress",
"__type_mapping_type": "Unknown",
"name": "PipelineTracingSenderAddress",
"title": "PipelineTracingSenderAddress",
"description": "The PipelineTracingSenderAddress parameter specifies the sender email 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.",
"required": true,
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"ExchangeLegacyDN": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "ExchangeLegacyDN",
"title": "ExchangeLegacyDN",
"required": true,
"type": "string"
},
"ContentConversionTracingEnabled": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "ContentConversionTracingEnabled",
"title": "ContentConversionTracingEnabled",
"required": true,
"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 or in the Mailbox Transport service on the Mailbox 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 email 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"
},
"PipelineTracingEnabled": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "PipelineTracingEnabled",
"title": "PipelineTracingEnabled",
"required": true,
"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."
},
"MailboxDeliveryThrottlingLogMaxAge": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "MailboxDeliveryThrottlingLogMaxAge",
"title": "MailboxDeliveryThrottlingLogMaxAge",
"required": true,
"type": "string",
"description": "The MailboxDeliveryThrottlingLogMaxAge parameter specifies the maximum age for the mailbox delivery throttling 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 MailboxDeliveryThrottlingLogMaxAge parameter to 00:00:00 prevents the automatic removal of mailbox delivery throttling log files because of their age."
},
"MailboxDeliveryThrottlingLogMaxDirectorySize": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "MailboxDeliveryThrottlingLogMaxDirectorySize",
"title": "MailboxDeliveryThrottlingLogMaxDirectorySize",
"required": true,
"type": "string",
"description": "The MailboxDeliveryThrottlingLogMaxDirectorySize parameter specifies the maximum size of all mailbox delivery throttling logs in the mailbox delivery throttling log directory. When a directory reaches its maximum file size, 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 MailboxDeliveryThrottlingLogMaxFileSize parameter must be less than or equal to the value of the MailboxDeliveryThrottlingLogMaxDirectorySize parameter. If you enter a value of unlimited, no size limit is imposed on the mailbox delivery throttling log directory."
},
"WhenCreated": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenCreated",
"title": "WhenCreated",
"format": "date-time",
"required": true,
"readonly": false,
"type": "string"
},
"ReceiveProtocolLogMaxFileSize": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "ReceiveProtocolLogMaxFileSize",
"title": "ReceiveProtocolLogMaxFileSize",
"required": true,
"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."
},
"MailboxSubmissionAgentLogEnabled": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "MailboxSubmissionAgentLogEnabled",
"title": "MailboxSubmissionAgentLogEnabled",
"required": true,
"type": "boolean",
"description": "The MailboxSubmissionAgentLogEnabled parameter specifies whether the agent log is enabled for the Mailbox Transport Submission service. The default value is $true."
},
"IsMailboxServer": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "IsMailboxServer",
"title": "IsMailboxServer",
"required": true,
"type": "boolean"
},
"MailboxDeliveryThrottlingLogEnabled": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "MailboxDeliveryThrottlingLogEnabled",
"title": "MailboxDeliveryThrottlingLogEnabled",
"required": true,
"type": "boolean",
"description": "The MailboxDeliveryThrottlingLogEnabled parameter specifies whether the mailbox delivery throttling log is enabled. The default value is $true."
},
"WhenCreatedUTC": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenCreatedUTC",
"title": "WhenCreatedUTC",
"format": "date-time",
"required": true,
"readonly": false,
"type": "string"
},
"ConnectivityLogMaxFileSize": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "ConnectivityLogMaxFileSize",
"title": "ConnectivityLogMaxFileSize",
"required": true,
"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."
},
"PSShowComputerName": {
"__type_requested": "System.Boolean",
"readonly": true,
"__type_mapping_type": "Boolean",
"name": "PSShowComputerName",
"title": "PSShowComputerName",
"required": false,
"type": "boolean"
},
"MailboxDeliveryAgentLogPath": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "MailboxDeliveryAgentLogPath",
"title": "MailboxDeliveryAgentLogPath",
"required": true,
"type": "string",
"description": "The MailboxDeliveryAgentLogPath parameter specifies the default agent log directory location for the Mailbox Transport Delivery service. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Mailbox\\AgentLog\\Delivery. Setting the value of this parameter to $null disables agent logging. However, setting this parameter to $null when the value of the MailboxDeliveryAgentLogEnabled attribute is $true generates event log errors."
},
"ObjectClass": {
"__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,",
"__type_mapping_type": "String[]",
"name": "ObjectClass",
"title": "ObjectClass",
"items": {
"type": "string"
},
"required": true,
"readonly": false,
"type": "array"
},
"PSComputerName": {
"__type_requested": "System.String",
"readonly": true,
"__type_mapping_type": "String",
"name": "PSComputerName",
"title": "PSComputerName",
"required": false,
"type": "string"
},
"MailboxDeliveryAgentLogMaxDirectorySize": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "MailboxDeliveryAgentLogMaxDirectorySize",
"title": "MailboxDeliveryAgentLogMaxDirectorySize",
"required": true,
"type": "string",
"description": "The MailboxDeliveryAgentLogMaxDirectorySize parameter specifies the maximum size of all Mailbox Transport Delivery service 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 MailboxDeliveryAgentLogMaxFileSize parameter must be less than or equal to the value of the MailboxDeliveryAgentLogMaxDirectorySize parameter. If you enter a value of unlimited, no size limit is imposed on the agent log directory."
},
"OrganizationId": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "OrganizationId",
"title": "OrganizationId",
"required": true,
"type": "string"
},
"IsProvisionedServer": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "IsProvisionedServer",
"title": "IsProvisionedServer",
"required": true,
"type": "boolean"
},
"MailboxDeliveryAgentLogMaxAge": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "MailboxDeliveryAgentLogMaxAge",
"title": "MailboxDeliveryAgentLogMaxAge",
"required": true,
"type": "string",
"description": "The MailboxDeliveryAgentLogMaxAge parameter specifies the maximum age for the agent log file of the Mailbox Transport Delivery service. 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 MailboxDeliveryAgentLogMaxAge parameter to 00:00:00 prevents the automatic removal of agent log files because of their age."
},
"Identity": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "Identity",
"title": "Identity",
"required": true,
"type": "string",
"description": "The Identity parameter specifies the server that you want to view."
},
"DistinguishedName": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "DistinguishedName",
"title": "DistinguishedName",
"required": true,
"type": "string"
},
"PipelineTracingPath": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "PipelineTracingPath",
"title": "PipelineTracingPath",
"required": true,
"type": "string",
"description": "The PipelineTracingPath parameter specifies the location of the pipeline tracing logs. The default location is %ExchangeInstallPath%TransportRoles\\Mailbox\\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 email 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"
},
"OriginatingServer": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "OriginatingServer",
"title": "OriginatingServer",
"required": true,
"type": "string"
},
"ReceiveProtocolLogMaxAge": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "ReceiveProtocolLogMaxAge",
"title": "ReceiveProtocolLogMaxAge",
"required": true,
"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."
},
"Name": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "Name",
"title": "Name",
"required": true,
"type": "string"
},
"SendProtocolLogMaxDirectorySize": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "SendProtocolLogMaxDirectorySize",
"title": "SendProtocolLogMaxDirectorySize",
"required": true,
"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."
},
"SendProtocolLogMaxFileSize": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "SendProtocolLogMaxFileSize",
"title": "SendProtocolLogMaxFileSize",
"required": true,
"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. When you enter a value, qualify the value with one of the following:\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."
},
"MailboxSubmissionAgentLogMaxDirectorySize": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "MailboxSubmissionAgentLogMaxDirectorySize",
"title": "MailboxSubmissionAgentLogMaxDirectorySize",
"required": true,
"type": "string",
"description": "The MailboxSubmissionAgentLogMaxDirectorySize parameter specifies the maximum size of all Mailbox Transport Submission service 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 MailboxSubmissionAgentLogMaxFileSize parameter must be less than or equal to the value of the MailboxSubmissionAgentLogMaxDirectorySize parameter. If you enter a value of unlimited, no size limit is imposed on the agent log directory."
},
"ConnectivityLogMaxDirectorySize": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "ConnectivityLogMaxDirectorySize",
"title": "ConnectivityLogMaxDirectorySize",
"required": true,
"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."
},
"MaxConcurrentMailboxDeliveries": {
"__type_requested": "System.Int32",
"readonly": false,
"__type_mapping_type": "Integer",
"name": "MaxConcurrentMailboxDeliveries",
"title": "MaxConcurrentMailboxDeliveries",
"required": true,
"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."
},
"MailboxSubmissionAgentLogPath": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "MailboxSubmissionAgentLogPath",
"title": "MailboxSubmissionAgentLogPath",
"required": true,
"type": "string",
"description": "The MailboxSubmissionAgentLogPath parameter specifies the default agent log directory location for the Mailbox Transport Submission service. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Mailbox\\AgentLog\\Submission. Setting the value of this parameter to $null disables agent logging. However, setting this parameter to $null when the value of the MailboxSubmissionAgentLogEnabled attribute is $true generates event log errors."
},
"ServerRole": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "ServerRole",
"title": "ServerRole",
"required": true,
"type": "string"
},
"AdminDisplayVersion": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "AdminDisplayVersion",
"title": "AdminDisplayVersion",
"required": true,
"type": "string"
},
"ExchangeVersion": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "ExchangeVersion",
"title": "ExchangeVersion",
"required": true,
"type": "string"
},
"MailboxDeliveryAgentLogEnabled": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "MailboxDeliveryAgentLogEnabled",
"title": "MailboxDeliveryAgentLogEnabled",
"required": true,
"type": "boolean",
"description": "The MailboxDeliveryAgentLogEnabled parameter specifies whether the agent log for the Mailbox Transport Delivery service is enabled. The default value is $true."
},
"ReceiveProtocolLogPath": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "ReceiveProtocolLogPath",
"title": "ReceiveProtocolLogPath",
"required": true,
"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\\Mailbox\\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."
},
"MailboxDeliveryThrottlingLogPath": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "MailboxDeliveryThrottlingLogPath",
"title": "MailboxDeliveryThrottlingLogPath",
"required": true,
"type": "string",
"description": "The MailboxDeliveryThrottlingLogPath parameter specifies the default mailbox delivery throttling log directory location. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Throttling\\Delivery. Setting the value of this parameter to $null disables mailbox delivery throttling logging. However, setting this parameter to $null when the value of the MailboxDeliveryThrottlingLogEnabled attribute is $true generates event log errors."
},
"ConnectivityLogEnabled": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "ConnectivityLogEnabled",
"title": "ConnectivityLogEnabled",
"required": true,
"type": "boolean",
"description": "The ConnectivityLogEnabled parameter specifies whether the connectivity log is enabled. The default value is $true."
},
"ConnectivityLogPath": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "ConnectivityLogPath",
"title": "ConnectivityLogPath",
"required": true,
"type": "string",
"description": "The ConnectivityLogPath parameter specifies the default connectivity log directory location. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Mailbox\\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."
},
"MaxConcurrentMailboxSubmissions": {
"__type_requested": "System.Int32",
"readonly": false,
"__type_mapping_type": "Integer",
"name": "MaxConcurrentMailboxSubmissions",
"title": "MaxConcurrentMailboxSubmissions",
"required": true,
"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."
},
"ConnectivityLogMaxAge": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "ConnectivityLogMaxAge",
"title": "ConnectivityLogMaxAge",
"required": true,
"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."
},
"IsValid": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "IsValid",
"title": "IsValid",
"required": true,
"type": "boolean"
},
"SendProtocolLogPath": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "SendProtocolLogPath",
"title": "SendProtocolLogPath",
"required": true,
"type": "string",
"description": "The SendProtocolLogPath parameter specifies the location of protocol log storage for the Send connectors. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Mailbox\\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."
},
"MailboxDeliveryThrottlingLogMaxFileSize": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "MailboxDeliveryThrottlingLogMaxFileSize",
"title": "MailboxDeliveryThrottlingLogMaxFileSize",
"required": true,
"type": "string",
"description": "The MailboxDeliveryThrottlingLogMaxFileSize parameter specifies the maximum size of each mailbox delivery throttling 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 MailboxDeliveryThrottlingLogMaxFileSize parameter must be less than or equal to the value of the MailboxDeliveryThrottlingLogMaxDirectorySize parameter. If you enter a value of unlimited, no size limit is imposed on the mailbox delivery throttling log files."
},
"MailboxDeliveryConnectorProtocolLoggingLevel": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "MailboxDeliveryConnectorProtocolLoggingLevel",
"title": "MailboxDeliveryConnectorProtocolLoggingLevel",
"required": true,
"type": "string",
"description": "The MailboxDeliveryConnectorProtocolLoggingLevel parameter sets the protocol logging level for messages transferred from the Transport service to the Mailbox Transport Delivery service on Mailbox servers using SMTP. Valid values for this parameter are None and Verbose. The default value is None."
},
"WhenChanged": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenChanged",
"title": "WhenChanged",
"format": "date-time",
"required": true,
"readonly": false,
"type": "string"
},
"WhenChangedUTC": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenChangedUTC",
"title": "WhenChangedUTC",
"format": "date-time",
"required": true,
"readonly": false,
"type": "string"
},
"Edition": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "Edition",
"title": "Edition",
"required": true,
"type": "string"
},
"VersionNumber": {
"__type_requested": "System.Int32",
"readonly": false,
"__type_mapping_type": "Integer",
"name": "VersionNumber",
"title": "VersionNumber",
"required": true,
"type": "integer"
},
"ObjectState": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "ObjectState",
"title": "ObjectState",
"required": true,
"type": "string"
},
"SendProtocolLogMaxAge": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "SendProtocolLogMaxAge",
"title": "SendProtocolLogMaxAge",
"required": true,
"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."
},
"MailboxDeliveryAgentLogMaxFileSize": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "MailboxDeliveryAgentLogMaxFileSize",
"title": "MailboxDeliveryAgentLogMaxFileSize",
"required": true,
"type": "string",
"description": "The MailboxDeliveryAgentLogMaxFileSize parameter specifies the maximum size of each agent log file for the Mailbox Transport Delivery service. 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 MailboxDeliveryAgentLogMaxFileSize parameter must be less than or equal to the value of the MailboxDeliveryAgentLogMaxDirectorySize parameter. If you enter a value of unlimited, no size limit is imposed on the agent log files."
},
"ReceiveProtocolLogMaxDirectorySize": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "ReceiveProtocolLogMaxDirectorySize",
"title": "ReceiveProtocolLogMaxDirectorySize",
"required": true,
"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."
},
"RunspaceId": {
"__type_requested": "System.Guid",
"readonly": true,
"__type_mapping_type": "String",
"name": "RunspaceId",
"title": "RunspaceId",
"required": false,
"type": "string"
},
"Guid": {
"__type_requested": "System.Guid",
"readonly": false,
"__type_mapping_type": "String",
"name": "Guid",
"title": "Guid",
"required": true,
"type": "string"
},
"ObjectCategory": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "ObjectCategory",
"title": "ObjectCategory",
"required": true,
"type": "string"
}
},
"schema_version": "15312"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/exchange/MailboxTransportService/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/exchange/MailboxTransportService/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchange/MailboxTransportService/[pkid1]", "/api/v0/device/exchange/MailboxTransportService/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchange/MailboxTransportService/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/exchange/MailboxTransportService |
|
{"hrefs": ["/api/device/exchange/MailboxTransportService/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchange/MailboxTransportService |
|
{"hrefs": ["/api/device/exchange/MailboxTransportService/[pkid1]", "/api/device/exchange/MailboxTransportService/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchange/MailboxTransportService; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchange/MailboxTransportService/export/ |
|
{ "hrefs":["/api/device/exchange/MailboxTransportService/[pkid1]", "/api/device/exchange/MailboxTransportService/[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/exchange/MailboxTransportService and the JSON format can be used to import instances of device/exchange/MailboxTransportService.
GET http://[host-proxy]/api/device/exchange/MailboxTransportService/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/exchange/MailboxTransportService | POST | /api/device/exchange/MailboxTransportService/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/exchange/MailboxTransportService/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/exchange/MailboxTransportService/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/exchange/MailboxTransportService/ |
|
The device/exchange/MailboxTransportService schema and all instances as JSON. |
(The list will return 0 to 3 device/exchange/MailboxTransportService instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "Name",
"direction": "asc",
"current": "/api/device/exchange/MailboxTransportService/?skip=0&limit=3&order_by=Name&direction=asc&traversal=down"
},
"operations": [
"move"
],
"meta": {
"model_type": "device/exchange/MailboxTransportService",
"summary_attrs": [
{
"name": "Name",
"title": "Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"get",
"list",
"update",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"schema_version": "15312",
"actions": [
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/device/exchange/MailboxTransportService/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/exchange/MailboxTransportService",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/device/exchange/MailboxTransportService/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/device/exchange/MailboxTransportService/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/device/exchange/MailboxTransportService/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/device/exchange/MailboxTransportService/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/device/exchange/MailboxTransportService/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/exchange/MailboxTransportService/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/exchange/MailboxTransportService/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/exchange/MailboxTransportService. | GET | /api/device/exchange/MailboxTransportService/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchange/MailboxTransportService as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/exchange/MailboxTransportService/purge/ |
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/exchange/MailboxTransportService/[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/exchange/MailboxTransportService/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchange/MailboxTransportService/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchange/MailboxTransportService | 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/exchange/MailboxTransportService; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchange/MailboxTransportService/[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/exchange/MailboxTransportService and the JSON format can be used to import instances of device/exchange/MailboxTransportService.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/exchange/MailboxTransportService/[pkid] | hierarchy=[hierarchy] | The device/exchange/MailboxTransportService instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/exchange/MailboxTransportService/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchange/MailboxTransportService. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/exchange/MailboxTransportService/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |