[Index]

Model: device/exchange/UMService

Model Details: device/exchange/UMService

Title Description Details
UMCertificateThumbprint *
  • Field Name: UMCertificateThumbprint
  • Type: String
WhenCreatedUTC *
  • Field Name: WhenCreatedUTC
  • Type: String
  • Format: date-time
IPAddressFamilyConfigurable * The IPAddressFamilyConfigurable parameter specifies whether you're able to set the IPAddressFamily parameter to IPv6Only or Any. The default is $true.
  • Field Name: IPAddressFamilyConfigurable
  • Type: Boolean
OrganizationId *
  • Field Name: OrganizationId
  • Type: String
Languages *
  • Field Name: Languages
  • Type: String
UMStartupMode * The UMStartupMode parameter specifies whether the Microsoft Exchange Unified Messaging service on an Exchange 2013 Mailbox server or Exchange 2007 or Exchange 2010 Unified Messaging server will start up in TCP, TLS, or Dual mode. If the Mailbox or Unified Messaging server is being added to UM dial plans that have different security settings, you should choose Dual mode. In Dual mode, the Mailbox or Unified Messaging server can listen on ports 5060 and 5061 at the same time. If the startup mode is changed, the Microsoft Exchange Unified Messaging service must be restarted.
  • Field Name: UMStartupMode
  • Type: String
WhenCreated *
  • Field Name: WhenCreated
  • Type: String
  • Format: date-time
PSShowComputerName
  • Field Name: PSShowComputerName
  • Type: Boolean
IrmLogPath * The IrmLogPath parameter specifies the default IRM log directory location. The default value is C:\Program Files\Microsoft\Exchange Server\V15. 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 parameter to $false.
  • Field Name: IrmLogPath
  • Type: String
Status * The Status parameter will be removed in future versions of the product.
  • Field Name: Status
  • Type: String
IPAddressFamily * The IPAddressFamily parameter specifies whether the UM IP gateway will use Internet Protocol version 4 (IPv4), IPv6, or both to communicate. If set to IPv4Only, the UM IP gateway only uses IPv4 to communicate. If set to IPv6Only, the UM IP gateway only uses IPv6. If set to Any, IPv6 is used first, and then if necessary, it falls back to IPv4. The default is IPv4Only.
  • Field Name: IPAddressFamily
  • Type: String
GrammarGenerationSchedule * The GrammarGenerationSchedule parameter specifies the scheduled times to start speech grammar generation. This parameter allows only one start time per day. The default scheduled time for grammar generation is 02:00-02:30 local time each day.
  • Field Name: GrammarGenerationSchedule
  • Type: String
ObjectClass
  • Field Name: ObjectClass.[n]
  • Type: Array
PSComputerName
  • Field Name: PSComputerName
  • Type: String
SipTcpListeningPort * This parameter is reserved for internal Microsoft use.
  • Field Name: SipTcpListeningPort
  • Type: Integer
ExternalHostFqdn * This parameter is reserved for internal Microsoft use.
  • Field Name: ExternalHostFqdn
  • Type: String
ExternalServiceFqdn * This parameter is reserved for internal Microsoft use.
  • Field Name: ExternalServiceFqdn
  • Type: String
Identity * The Identity parameter specifies the identifier for the UM server being disabled. This is the directory object ID for the UM server.
  • Field Name: Identity
  • Type: String
IrmLogMaxAge * 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. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds. The valid input range for this parameter is from 00:00:00 through 24855.03:14:07. Setting the value of the IrmLogMaxAge parameter to 00:00:00 prevents the automatic removal of IRM log files because of their age.
  • Field Name: IrmLogMaxAge
  • Type: String
DistinguishedName *
  • Field Name: DistinguishedName
  • Type: String
OriginatingServer *
  • Field Name: OriginatingServer
  • Type: String
Name *
  • Field Name: Name
  • Type: String
IrmLogMaxFileSize * The 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. When you enter a value, qualify the value with one of the following units: B (bytes) KB (kilobytes) MB (megabytes) GB (gigabytes) TB (terabytes) Unqualified values are treated as bytes. The value of the 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.
  • Field Name: IrmLogMaxFileSize
  • Type: String
IrmLogEnabled * The IrmLogEnabled parameter specifies whether to enable logging of Information Rights Management (IRM) transactions. IRM logging is enabled by default. Values include: $true Enable IRM logging $false Disable IRM logging
  • Field Name: IrmLogEnabled
  • Type: Boolean
SIPAccessService * The SIPAccessService parameter specifies the FQDN and Transmission Control Protocol (TCP) port of the nearest Lync Server pool location for inbound and outbound calls from remote Lync users located outside of the network. When this parameter isn't set, the Mailbox server running the Microsoft Exchange Unified Messaging service may select a Lync pool for Real-Time Transport Protocol (RTP) media traffic that isn't the closest geographically to the remote user. This parameter is optional when you're configuring Unified Messaging with single Lync Server pool deployments. However, for Lync Server deployments that span multiple geographic regions, it's recommended that you specify this parameter. This parameter is set on a per-Mailbox server running the Microsoft Exchange Unified Messaging service basis and must point to the Lync Server pool that is located the closest geographically to the Mailbox server.
  • Field Name: SIPAccessService
  • Type: String
MaxCallsAllowed * The MaxCallsAllowed parameter specifies the maximum number of concurrent voice calls that an Exchange 2013 Mailbox server or Exchange 2013 Mailbox or Exchange 2007 or Exchange 2010 Unified Messaging server that's running the Microsoft Exchange Unified Messaging service allows.
  • Field Name: MaxCallsAllowed
  • Type: Integer
ExchangeVersion *
  • Field Name: ExchangeVersion
  • Type: String
DialPlans The DialPlans parameter specifies all dial plans for which an Exchange 2013 Client Access or Mailbox server or Exchange 2007 or Exchange 2010 Unified Messaging server handles incoming calls. Exchange 2013 Client Access and Mailbox servers can't be associated with a TelExt or E.164 UM dial plan but can be associated or added to SIP dial plans. If you're integrating Unified Messaging with Microsoft Office Communications Server 2007 R2, Lync Server 2010, or Lync Server 2013, you must associate or add all Client Access and Mailbox servers to SIP dial plans. This parameter can also be used to associate Exchange 2007 or Exchange 2010 Unified Messaging servers to a UM dial plan. To 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>".... To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="<value1>","<value2>"...; Remove="<value1>","<value2>"...}.
  • Field Name: DialPlans.[n]
  • Type: Array
ObjectCategory *
  • Field Name: ObjectCategory
  • Type: String
IsValid *
  • Field Name: IsValid
  • Type: Boolean
IrmLogMaxDirectorySize * The 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 megabytes (MB). When you enter a value, qualify the value with one of the following units: B (bytes) KB (kilobytes) MB (megabytes) GB (gigabytes) TB (terabytes) Unqualified values are treated as bytes. The value of the 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 connectivity log directory.
  • Field Name: IrmLogMaxDirectorySize
  • Type: String
UMPodRedirectTemplate * This parameter is reserved for internal Microsoft use.
  • Field Name: UMPodRedirectTemplate
  • Type: String
WhenChanged *
  • Field Name: WhenChanged
  • Type: String
  • Format: date-time
WhenChangedUTC *
  • Field Name: WhenChangedUTC
  • Type: String
  • Format: date-time
SipTlsListeningPort * This parameter is reserved for internal Microsoft use.
  • Field Name: SipTlsListeningPort
  • Type: Integer
ObjectState *
  • Field Name: ObjectState
  • Type: String
WorkloadManagementPolicy *
  • Field Name: WorkloadManagementPolicy
  • Type: String
UMForwardingAddressTemplate * This parameter is reserved for internal Microsoft use.
  • Field Name: UMForwardingAddressTemplate
  • Type: String
RunspaceId
  • Field Name: RunspaceId
  • Type: String
Guid *
  • Field Name: Guid
  • Type: String