Commands › Exchange Online
Set-UMIPGateway
Modify the configuration settings for a single Unified Messaging (UM) IP gateway or to return a list of configuration settings that can be modified on a specified UM IP gateway.
Quick start script
# Set-UMIPGateway — 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-UMIPGateway
$before | Format-List
# 3. Make the change (dry run first)
Set-UMIPGateway -Identity <UMIPGatewayIdParameter> -WhatIf
Set-UMIPGateway -Identity <UMIPGatewayIdParameter>
# 4. Verify and diff
$after = Get-UMIPGateway
Compare-Object ($before | Out-String) ($after | Out-String)Syntax
Set-UMIPGateway [-Identity] <UMIPGatewayIdParameter>
[-Address <UMSmartHost>]
[-Confirm]
[-DelayedSourcePartyInfoEnabled <Boolean>]
[-DomainController <Fqdn>]
[-ForceUpgrade]
[-IPAddressFamily <IPAddressFamily>]
[-MessageWaitingIndicatorAllowed <Boolean>]
[-Name <String>]
[-OutcallsAllowed <Boolean>]
[-Port <Int32>]
[-Simulator <Boolean>]
[-Status <GatewayStatus>]
[-WhatIf]
[<CommonParameters>]Parameters (14)
| Parameter | Type | Required | What it controls |
|---|---|---|---|
| -Identity | UMIPGatewayIdParameter | yes | The Identity parameter specifies the identifier for the UM IP gateway being modified. This parameter is the directory object ID for the UM IP gateway. |
| -Address | UMSmartHost | The Address parameter specifies the IP address or the fully qualified domain name (FQDN) configured on the UM IP gateway or SIP-enabled IP PBX. An FQDN is required if the UM dial plan associated with the UM IP... | |
| -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. | |
| -DelayedSourcePartyInfoEnabled | Boolean | The DelayedSourcePartyInfoEnabled parameter specifies whether Unified Messaging should delay the process of accepting an inbound call from the Voice over IP (VoIP) gateway if the corresponding SIP INVITE of the call... | |
| -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... | |
| -ForceUpgrade | SwitchParameter | The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. | |
| -IPAddressFamily | IPAddressFamily | The IPAddressFamily parameter specifies the Internet Protocol (IP) version to use. Valid values are: | |
| -MessageWaitingIndicatorAllowed | Boolean | The MessageWaitingIndicatorAllowed parameter specifies whether to enable the UM IP gateway to allow SIP NOTIFY messages to be sent to users associated with a UM dial plan and the UM IP gateway. The default value is $true. | |
| -Name | String | The Name parameter specifies the display name for the UM IP gateway. This display name is limited to 64 characters. | |
| -OutcallsAllowed | Boolean | The OutcallsAllowed parameter specifies whether to allow this UM IP gateway to be used for outgoing calls. This doesn't govern call transfers. | |
| -Port | Int32 | The Port parameter specifies the IP port on which the IP gateway or IP PBX is listening. By default, it's port 5060. The range for this parameter is from 0 through 65535. | |
| -Simulator | Boolean | The Simulator parameter specifies the simulator used for the UM IP gateway being viewed. A simulator allows a client to connect to the Mailbox server. | |
| -Status | GatewayStatus | The Status parameter specifies whether to enable or disable the UM IP gateway. 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.