Set-UMServer — usage, script and reference

Quick start script

# Set-UMServer — 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-UMServer
$before | Format-List

# 3. Make the change (dry run first)
Set-UMServer -Identity <UMServerIdParameter> -WhatIf
Set-UMServer -Identity <UMServerIdParameter>

# 4. Verify and diff
$after = Get-UMServer
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax

Set-UMServer [-Identity] <UMServerIdParameter>
 [-Confirm]
 [-DialPlans <MultiValuedProperty>]
 [-DomainController <Fqdn>]
 [-ExternalServiceFqdn <UMSmartHost>]
 [-GrammarGenerationSchedule <ScheduleInterval[]>]
 [-IrmLogEnabled <Boolean>]
 [-IrmLogMaxAge <EnhancedTimeSpan>]
 [-IrmLogMaxDirectorySize <Unlimited>]
 [-IrmLogMaxFileSize <ByteQuantifiedSize>]
 [-IrmLogPath <LocalLongFullPath>]
 [-MaxCallsAllowed <Int32>]
 [-SIPAccessService <ProtocolConnectionSettings>]
 [-SipTcpListeningPort <Int32>]
 [-SipTlsListeningPort <Int32>]
 [-Status <ServerStatus>]
 [-UMStartupMode <UMStartupMode>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (18)

Parameter	Type	Required	What it controls
-Identity	UMServerIdParameter	yes	The Identity parameter specifies the Unified Messaging server that 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 the dial plans that the server handles UM calls for. You can specify multiple values separated by commas.
-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...
-ExternalServiceFqdn	UMSmartHost		The ExternalServiceFqdn parameter is the FQDN or host name of a load balancer servicing Unified Messaging servers. This parameter is useful when you're migrating Unified Messaging servers from within your...
-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...
-IrmLogEnabled	Boolean		The IrmLogEnabled parameter specifies whether to enable logging of Information Rights Management (IRM) transactions. IRM logging is enabled by default. Values include:
-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. To specify a value, enter the value as a time...
-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. When you enter a value, qualify...
-IrmLogPath	LocalLongFullPath		The IrmLogPath parameter specifies the default IRM log directory location. The default value is %ExchangeInstallPath%IRMLogs.
-MaxCallsAllowed	Int32		The MaxCallsAllowed parameter specifies the maximum number of concurrent voice calls that the Unified Messaging server allows.
-SIPAccessService	ProtocolConnectionSettings		The SIPAccessService parameter specifies the FQDN and TCP port of the nearest Lync Server Edge pool or Skype for Business Server Edge pool location for inbound and outbound calls from remote Lync or Skype for...
-SipTcpListeningPort	Int32		The SipTcpListeningPort parameter specifies the TCP port used by the Unified Messaging server to receive incoming calls. This TCP port is used by Unified Messaging servers added to a UM dial plan that isn't...
-SipTlsListeningPort	Int32		The SipTlsListeningPort parameter specifies the Transport Layer Security (TLS) port used by the Unified Messaging server to receive incoming calls. This TLS port is used by Unified Messaging servers that are added to...
-Status	ServerStatus		The Status parameter specifies the Unified Messaging server status. The available options are Enabled, Disabled, and NoNewCalls.
-UMStartupMode	UMStartupMode		The UMStartupMode parameter specifies the startup mode for the Microsoft Exchange Unified Messaging service on an Exchange server. 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.