New-UMIPGateway (RTM)
Microsoft Exchange Server 2007 will reach end of support on April 11, 2017. To stay supported, you will need to upgrade. For more information, see Resources to help you upgrade your Office 2007 servers and clients.
Applies to: Exchange Server 2007
The New-UMIPGateway cmdlet creates a new 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 PBX.
Syntax
New-UMIPGateway -Name <String> -Address <UMSmartHost> [-DomainController <Fqdn>] [-TemplateInstance <PSObject>] [-UMDialPlan <UMDialPlanIdParameter>]
Detailed Description
The New-UMIPGateway cmdlet creates a new UM IP gateway. A UM IP gateway has organization-wide scope and references a single physical IP gateway. The new UM IP gateway that is created is used to establish a connection to an IP gateway or a SIP-enabled IP PBX.
To run the New-UMIPGateway cmdlet, the account you use must be delegated the following:
- Exchange Organization Administrator role
For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Address |
Required |
Microsoft.Exchange.Data.UMSmartHost |
This parameter specifies the IP address that is configured on the IP gateway or SIP-enabled IP PBX. |
Name |
Required |
System.String |
This parameter specifies the display name for the UM IP gateway. The name for the new UM IP gateway can contain up to 64 characters. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
To specify the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet. |
TemplateInstance |
Optional |
System.Management.Automation.PSObject |
When an existing object is supplied to this parameter, the cmdlet will use the configuration of that object to create an identical copy of the object on a local or target server. |
UMDialPlan |
Optional |
Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter |
This parameter specifies the UM dial plan to be associated with the UM IP gateway. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
Example
The first code example creates a new UM IP gateway named MyUMIPGateway that will enable a Unified Messaging server to start accepting calls from an IP gateway that has an IP address of 10.10.10.1.
The second code example creates a new UM IP gateway named MyUMIPGateway that will enable a Unified Messaging server to start accepting calls from an IP gateway that has an FQDN of MyUMIPGateway.contoso.com.
New-UMIPGateway -Name MyUMIPGateway -Address 10.10.10.1
New-UMIPGateway -Name MyUMIPGateway -Address "MyUMIPGateway.contoso.com"