Disable-UMIPGateway
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
The Disable-UMIPGateway cmdlet disables a Unified Messaging (UM) IP gateway.
Syntax
Disable-UMIPGateway -Identity <UMIPGatewayIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Immediate <$true | $false>] [-WhatIf [<SwitchParameter>]]
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 the Active Directory directory service by modifying its status variable.
To run the Disable-UMIPGateway cmdlet, the account you use must be delegated the 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.
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. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
This parameter causes the command to pause processing and requires the administrator to acknowledge what the command will do before processing continues. The default value is $true. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
This parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. |
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. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
This parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, the administrator can view what changes would occur without having to apply any of those changes. The default value is $true. |
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