Applies to: Exchange Server 2007
Topic Last Modified: 2007-07-12
The Set-UMIPGateway cmdlet is used to modify the configuration settings for a single Unified Messaging (UM) IP gateway or return a list of configuration settings that can be modified on a given UM IP gateway.
Syntax
Set-UMIPGateway -Identity <UMIPGatewayIdParameter>
[-Address <UMSmartHost>] [-DomainController <Fqdn>]
[-Name <String>] [-OutcallsAllowed <$true | $false>]
[-Port <Int32>] [-Simulator <$true | $false>] [-Status
<Enabled | Disabled | NoNewCalls>]
|
Set-UMIPGateway [-Address <UMSmartHost>]
[-DomainController <Fqdn>] [-Instance <UMIPGateway>]
[-Name <String>] [-OutcallsAllowed <$true | $false>]
[-Port <Int32>] [-Simulator <$true | $false>] [-Status
<Enabled | Disabled | NoNewCalls>]
|
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.UMIPGatewayIdParameter |
This parameter specifies the identifier for the UM IP gateway that is being modified. This parameter is the directory object ID for the UM IP gateway. |
|
Address |
Optional |
Microsoft.Exchange.Data.UMSmartHost |
This parameter specifies the IP address that is configured on the IP gateway or Session Initiation Protocol (SIP)-enabled IP/Private Branch eXchange (PBX). |
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet. |
|
Instance |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.UMIPGateway |
This parameter specifies the input parameter that represents a new IP gateway. |
|
Name |
Optional |
System.String |
This parameter specifies the display name that will be used for the UM IP gateway. This display name is limited to 64 characters. |
|
OutcallsAllowed |
Optional |
System.Boolean |
This parameter specifies whether to allow this IP Gateway object to be used for outgoing calls. This does not govern call transfers. |
|
Port |
Optional |
System.Int32 |
This parameter specifies the IP port on which the IP gateway or IP PBX is listening. By default, it is port 5060. The range for this parameter is 0 to 65535. |
|
Simulator |
Optional |
System.Boolean |
This parameter specifies the simulator that will be used for the UM IP gateway that is being viewed. A simulator allows a client to connect to the Unified Messaging server. This connection is typically used in the Exchange Test Phone application. |
|
Status |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.GatewayStatus |
This parameter specifies whether to enable or disable the UM IP gateway. |
Detailed Description
The Set-UMIPGateway cmdlet modifies configuration settings for a given UM IP gateway, for example, the IP address to the IP gateway. These modifications include allowing outgoing calls and controlling communications with a SIP-enabled IP PBX or IP gateway.
 Important: |
|---|
| It is possible that modifications to the UM IP gateway settings may disrupt communication between Unified Messaging servers and the SIP-enabled or IP PBX IP gateway. Modifications to a UM IP Gateway object should be performed only by an administrator who fully understands the implications of making configuration changes to the UM IP gateway. |
To run the Set-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 Microsoft Exchange Server 2007, see Permission Considerations.
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
|
Example
The first code example modifies the IP address of a UM IP gateway named MyUMIPGateway.
The second code example prevents the UM IP gateway from accepting incoming calls and prevents outgoing calls.
The third example enables the UM IP Gateway to function as an IP/VoIP simulator.
 Copy Code |
|
|---|---|
Set-UMIPGateway -Identity MyUMIPGateway -Address 10.10.10.1 Set-UMIPGateway -Identity MyUMIPGateway -Address 10.10.10.1 -Status 2 -OutcallsAllowed $false Set-UMIPGateway -Identity MyUMIPGateway -Simulator $true |
|