Commands › Exchange Online
Set-UMService
Modify the properties of the Microsoft Exchange Unified Messaging service on Exchange 2013 or Exchange 2016 Mailbox servers.
Quick start script
# Set-UMService — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org
# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-UMService
$before | Format-List
# 3. Make the change (dry run first)
Set-UMService -Identity <UMServerIdParameter> -WhatIf
Set-UMService -Identity <UMServerIdParameter>
# 4. Verify and diff
$after = Get-UMService
Compare-Object ($before | Out-String) ($after | Out-String)Syntax
Set-UMService [-Identity] <UMServerIdParameter>
[-Confirm]
[-DialPlans <MultiValuedProperty>]
[-DomainController <Fqdn>]
[-GrammarGenerationSchedule <ScheduleInterval[]>]
[-IPAddressFamily <IPAddressFamily>]
[-IPAddressFamilyConfigurable <Boolean>]
[-IrmLogEnabled <Boolean>]
[-IrmLogMaxAge <EnhancedTimeSpan>]
[-IrmLogMaxDirectorySize <Unlimited>]
[-IrmLogMaxFileSize <ByteQuantifiedSize>]
[-IrmLogPath <LocalLongFullPath>]
[-MaxCallsAllowed <Int32>]
[-SIPAccessService <ProtocolConnectionSettings>]
[-Status <ServerStatus>]
[-UMStartupMode <UMStartupMode>]
[-WhatIf]
[<CommonParameters>]Parameters (17)
| Parameter | Type | Required | What it controls |
|---|---|---|---|
| -Identity | UMServerIdParameter | yes | The Identity parameter specifies the Mailbox server that hosts the Unified Messaging service configuration you want to modify. You can use any value that uniquely identifies the server. For example: |
| -Confirm | SwitchParameter | The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding. | |
| -DialPlans | MultiValuedProperty | The DialPlans parameter specifies all dial plans that the Unified Messaging service handles incoming calls for. | |
| -DomainController | Fqdn | The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name... | |
| -GrammarGenerationSchedule | ScheduleInterval[] | 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... | |
| -IPAddressFamily | IPAddressFamily | The IPAddressFamily parameter specifies the Internet Protocol (IP) version to use. Valid values are: | |
| -IPAddressFamilyConfigurable | Boolean | The IPAddressFamilyConfigurable parameter specifies whether you're able to set the IPAddressFamily parameter to IPv6Only or Any. The default is $true. | |
| -IrmLogEnabled | Boolean | The IrmLogEnabled parameter specifies whether to enable logging of Information Rights Management (IRM) transactions. IRM logging is enabled by default. Valid values are: | |
| -IrmLogMaxAge | EnhancedTimeSpan | 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. | |
| -IrmLogMaxDirectorySize | Unlimited | 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... | |
| -IrmLogMaxFileSize | ByteQuantifiedSize | 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. | |
| -IrmLogPath | LocalLongFullPath | The IrmLogPath parameter specifies the default IRM log directory location. The default location is %ExchangeInstallPath%IRMLogs. | |
| -MaxCallsAllowed | Int32 | The MaxCallsAllowed parameter specifies the maximum number of concurrent voice calls that the Unified Messaging service allows. The default value is 100. | |
| -SIPAccessService | ProtocolConnectionSettings | The SIPAccessService parameter specifies the FQDN and TCP port of the nearest Lync Server Front End pool or Skype for Business Server Front End pool location for inbound and outbound calls from remote Lync or Skype... | |
| -Status | ServerStatus | This parameter is deprecated and no longer used. | |
| -UMStartupMode | UMStartupMode | The UMStartupMode parameter specifies the startup mode for the Unified Messaging service. Valid values are: | |
| -WhatIf | SwitchParameter | The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch. |
Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.