Remove-UMDialplan
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
The Remove-UMDialplan cmdlet deletes an existing Unified Messaging (UM) dial plan.
Syntax
Remove-UMDialPlan -Identity <UMDialPlanIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The Remove-UMDialplan cmdlet is used to delete an existing UM dial plan from the Active Directory directory service. The administrator must make sure that the UM dial plan is not being used by other UM objects such as UM mailbox policies or UM IP gateways. When you delete an existing UM dial plan, the cmdlet verifies that the specified UM dial plan is not referenced by a Unified Messaging server, UM IP gateway, or UM mailbox policies. The only benefit gained from deleting an obsolete UM dial plan is to reuse the name or perform general Active Directory housekeeping.
To run the Remove-UMDialplan 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.UMDialPlanIdParameter |
This parameter specifies the identifier for the UM dial plan that is being deleted. This is the directory object ID for the UM dial plan. |
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 Active Directory. |
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 an existing UM dial plan named MyUMDialPlan.
Remove-UMDialplan -Identity MyUMDialPlan