Remove-UMIPGateway
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
The Remove-UMIPGateway cmdlet deletes a Unified Messaging (UM) IP gateway.
Syntax
Remove-UMIPGateway -Identity <UMIPGatewayIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The Remove-UMIPGateway cmdlet deletes a specified UM IP gateway. After the UM IP gateway is deleted, Unified Messaging servers will no longer accept new call requests from the IP gateway. The Remove-UMIPGateway cmdlet should be run only by an administrator who fully understands the implications of disabling communication with a Session Initiation Protocol (SIP)–enabled IP PBX or IP gateway.
To run the Remove-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 deleted. This parameter specifies 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 that you 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 the Active Directory directory service. |
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, you 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
This example deletes a UM IP gateway named MyUMIPGateway.
Remove-UMIPGateway -Identity MyUMIPGateway