Disable-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 Disable-UMIPGateway cmdlet disables a Unified Messaging (UM) IP gateway.
Syntax
Disable-UMIPGateway -Identity <UMIPGatewayIdParameter> [-DomainController <Fqdn>] [-Immediate <$true | $false>]
Detailed Description
The status variable for a UM IP gateway can be used to enable or disable call answering that is destined for the IP gateway. The Disable-UMIPGateway cmdlet disables a UM IP gateway in Active Directory by modifying its status variable.
To run the Disable-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 |
|---|---|---|---|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.UMIPGatewayIdParameter |
This parameter specifies the identifier for the UM IP gateway that is being disabled. This is the directory object ID for the UM IP gateway. |
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. |
Immediate |
Optional |
System.Boolean |
This parameter specifies whether the Unified Messaging server will drop calls that are associated with this UM IP gateway immediately or wait for the current calls to finish processing. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
Example
The first example disables a UM IP gateway named MyUMIPGateway and stops it from accepting incoming calls from the IP gateway.
The second example disables a UM IP gateway named MyUMIPGateway and disconnects all current calls immediately.
Disable-UMIPGateway -Identity MyUMIPGateway
Disable-UMIPGateway -Identity MyUMIPGateway -Immediate $true