Applies to: Exchange Server 2013

Topic Last Modified: 2012-09-13

Use the Set-UMIPGateway cmdlet to 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.

For information about the parameter sets in the Syntax section below, see Syntax.

Syntax


`Set-UMIPGateway -Identity <UMIPGatewayIdParameter> [-Address <UMSmartHost>] [-Confirm [<SwitchParameter>]] [-DelayedSourcePartyInfoEnabled <$true \| $false>] [-DomainController <Fqdn>] [-ForceUpgrade <SwitchParameter>] [-IPAddressFamily <IPv4Only \| IPv6Only \| Any>] [-MessageWaitingIndicatorAllowed <$true \| $false>] [-Name <String>] [-OutcallsAllowed <$true \| $false>] [-Port <Int32>] [-Simulator <$true \| $false>] [-Status <Enabled \| Disabled \| NoNewCalls>] [-WhatIf [<SwitchParameter>]]`

Set-UMIPGateway -Identity <UMIPGatewayIdParameter>
[-Address <UMSmartHost>] [-Confirm [<SwitchParameter>]]
[-DelayedSourcePartyInfoEnabled <$true | $false>]
[-DomainController <Fqdn>] [-ForceUpgrade
<SwitchParameter>] [-IPAddressFamily <IPv4Only | IPv6Only
| Any>] [-MessageWaitingIndicatorAllowed <$true | $false>]
[-Name <String>] [-OutcallsAllowed <$true | $false>]
[-Port <Int32>] [-Simulator <$true | $false>] [-Status
<Enabled | Disabled | NoNewCalls>] [-WhatIf
[<SwitchParameter>]]

Examples

EXAMPLE 1

This example modifies the IP address of the UM IP gateway MyUMIPGateway.

	Copy Code
Set-UMIPGateway -Identity MyUMIPGateway -Address 10.10.10.1

EXAMPLE 2

This example prevents the UM IP gateway from accepting incoming calls and prevents outgoing calls.

	Copy Code
Set-UMIPGateway -Identity MyUMIPGateway -Address 10.10.10.1 -Status Disabled -OutcallsAllowed $false

EXAMPLE 3

This example prevents the UM IP gateway MyUMIPGateway from accepting incoming calls and outgoing calls, sets an IPv6 address, and allows the UM IP gateway to use IPv4 and IPv6 addresses.

	Copy Code
Set-UMIPGateway -Identity MyUMIPGateway -Address fe80::39bd:88f7:6969:d223%11 -IPAddressFamily Any -Status Disabled -OutcallsAllowed $false

EXAMPLE 4

This example enables the UM IP gateway to function as an IP gateway simulator and can be used with the Test-UMConnectivity cmdlet.

	Copy Code
Set-UMIPGateway -Identity MyUMIPGateway -Simulator $true

Detailed Description

The Set-UMIPGateway cmdlet modifies configuration settings for a specific UM IP gateway, for example, the IP address to the IP gateway. These modifications include allowing outgoing calls and controlling communications with a Session Initiation Protocol (SIP)–enabled IP Private Branch eXchange (PBX) or IP gateway.

Important:
It's possible that modifications to the UM IP gateway settings may disrupt communication between Mailbox servers and the SIP-enabled IP PBX or IP gateway. Modifications to a UM IP gateway should be performed only by an administrator who fully understands the implications of making configuration changes to the UM IP gateway.

After this task is completed, the parameters and values specified are configured on the UM IP gateway.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "UM IP gateways" entry in the Unified Messaging Permissions topic.

Parameters

Parameter	Required	Type	Description
Identity	Required	Microsoft.Exchange.Configuration.Tasks.UMIPGatewayIdParameter	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	Optional	Microsoft.Exchange.Data.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 gateway is operating in SIP Secured or Secured mode. If an FQDN is used, verify that the Domain Name System (DNS) has been configured correctly.
Confirm	Optional	System.Management.Automation.SwitchParameter	The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.
DelayedSourcePartyInfoEnabled	Optional	System.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 contains no calling party and diversion information.
DomainController	Optional	Microsoft.Exchange.Data.Fqdn	The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.
ForceUpgrade	Optional	System.Management.Automation.SwitchParameter	The ForceUpgrade switch specifies whether you're prompted for confirmation before a UM IP gateway object is upgraded.
IPAddressFamily	Optional	Microsoft.Exchange.Data.Directory.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 will only use IPv4 to communicate. If set to `IPv6Only`, the UM IP gateway will only use IPv6. If set to `Any`, IPv6 will be used first, and then if necessary, it will fall back to IPv4. The default is `IPv4Only`.
MessageWaitingIndicatorAllowed	Optional	System.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	Optional	System.String	The Name parameter specifies the display name for the UM IP gateway. This display name is limited to 64 characters.
OutcallsAllowed	Optional	System.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	Optional	System.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	Optional	System.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	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.GatewayStatus	The Status parameter specifies whether to enable or disable the UM IP gateway.
WhatIf	Optional	System.Management.Automation.SwitchParameter	The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

Input Types

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

Return Types

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.