Applies to: Exchange Server 2013
Topic Last Modified: 2012-09-13
Use the New-UMIPGateway cmdlet to create a Unified Messaging (UM) IP gateway. A UM IP gateway is used to connect Unified Messaging servers to an IP gateway or a Session Initiation Protocol (SIP)–enabled IP Private Branch eXchange (PBX).
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
New-UMIPGateway -Address <UMSmartHost> -Name
<String> [-Confirm [<SwitchParameter>]]
[-DomainController <Fqdn>] [-GlobalCallRoutingScheme <None
| E164 | GatewayGuid | Reserved1 | Reserved2 | Reserved3>]
[-IPAddressFamily <IPv4Only | IPv6Only | Any>] [-Organization
<OrganizationIdParameter>] [-UMDialPlan
<UMDialPlanIdParameter>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example creates the UM IP gateway MyUMIPGateway that enables a Mailbox server to start accepting calls from an IP gateway with an IP address of 10.10.10.1.
 Copy Code |
|
|---|---|
New-UMIPGateway -Identity MyUMIPGateway -Address 10.10.10.1 |
|
EXAMPLE 2
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 3
This example creates the UM IP gateway MyUMIPGateway that enables a Mailbox server to start accepting calls from an IP gateway with an FQDN of MyUMIPGateway.contoso.com.
| Copy Code |
|
|---|---|
New-UMIPGateway -Identity MyUMIPGateway -Address "MyUMIPGateway.contoso.com" |
|
Detailed Description
The New-UMIPGateway cmdlet creates a UM IP gateway. A UM IP gateway has organization-wide scope and references a single physical IP gateway. The UM IP gateway that's created is used to establish a connection to an IP gateway or a SIP-enabled IP PBX. After this task is completed, a new UM IP gateway is created.
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 |
|---|---|---|---|
|
Address |
Required |
Microsoft.Exchange.Data.UMSmartHost |
The Address parameter specifies the IP address configured on the IP gateway or SIP-enabled IP PBX. |
|
Name |
Required |
System.String |
The Name parameter specifies the display name for the UM IP gateway. The name for the new UM IP gateway can contain up to 64 characters. |
|
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. |
|
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. |
|
GlobalCallRoutingScheme |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.UMGlobalCallRoutingScheme |
The GlobalCallRoutingScheme parameter specifies whether
the IP gateway can accept calls for UM-enabled users and auto
attendant numbers included in the global routing database. If the
value is set to |
|
IPAddressFamily |
Optional |
Microsoft.Exchange.Data.Directory.IPAddressFamily |
The IPAddressFamily parameter specifies whether the UM IP
gateway uses Internet Protocol version 4 (IPv4), IPv6, or both to
communicate. If set to |
|
Organization |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter |
The Organization parameter is reserved for internal Microsoft use. |
|
UMDialPlan |
Optional |
Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter |
The UMDialPlan parameter specifies the UM dial plan to be associated with 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.