Commands › Exchange Online
Set-UMCallRouterSettings
Modify the configuration of the Microsoft Exchange Unified Messaging Call Router service. This service exists on Exchange servers that have the Client Access server role installed, and is used by telephony clients to connect to Exchange.
Quick start script
# Set-UMCallRouterSettings — 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-UMCallRouterSettings
$before | Format-List
# 3. Make the change (dry run first)
Set-UMCallRouterSettings -WhatIf
Set-UMCallRouterSettings
# 4. Verify and diff
$after = Get-UMCallRouterSettings
Compare-Object ($before | Out-String) ($after | Out-String)Syntax
Set-UMCallRouterSettings [[-Server] <ServerIdParameter>]
[-Confirm]
[-DialPlans <MultiValuedProperty>]
[-DomainController <Fqdn>]
[-IPAddressFamily <IPAddressFamily>]
[-IPAddressFamilyConfigurable <Boolean>]
[-MaxCallsAllowed <Int32>]
[-SipTcpListeningPort <Int32>]
[-SipTlsListeningPort <Int32>]
[-UMStartupMode <UMStartupMode>]
[-WhatIf]
[<CommonParameters>]Parameters (11)
| Parameter | Type | Required | What it controls |
|---|---|---|---|
| -Server | ServerIdParameter | The Server parameter specifies the Exchange server where you want to run this command. 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 the dial plan used by the Microsoft Exchange Unified Messaging Call Router service. The Exchange server only needs to be associated with a UM dial plan if Lync Server 2010, Lync... | |
| -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... | |
| -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. | |
| -MaxCallsAllowed | Int32 | This parameter is deprecated and no longer used. | |
| -SipTcpListeningPort | Int32 | The SipTcpListeningPort parameter specifies the TCP port that's used by the Microsoft Exchange Unified Messaging Call Router service to receive incoming calls. This TCP port is used when a UM dial plan isn't... | |
| -SipTlsListeningPort | Int32 | The SipTlsListeningPort parameter specifies the Transport Layer Security (TLS) port that's used by the Microsoft Exchange Unified Messaging Call Router service to receive incoming calls. This TLS port is used when a... | |
| -UMStartupMode | UMStartupMode | The UMStartupMode parameter specifies whether the Microsoft Exchange Unified Messaging Call Router service starts up in TCP, TLS, or Dual mode. If the Exchange server isn't associated with any UM dial plans or is... | |
| -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.