Remove-CsCallParkOrbit
Topic Last Modified: 2012-03-26
Removes a specific call park orbit range.
Syntax
Remove-CsCallParkOrbit -Identity <XdsGlobalRelativeIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The Remove-CsCallParkOrbit cmdlet deletes the call park orbit range with the name passed to the Identity parameter (this parameter is required). Each call park orbit within an organization must have a unique range of numbers. Removing a call park orbit frees up the range that was in that call park orbit. The freed numbers can then be used in a newly defined call park orbit.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Remove-CsCallParkOrbit cmdlet locally: RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Remove-CsCallParkOrbit"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
String |
The name of the call park orbit range. This name was assigned by the administrator when the call park orbit range was defined. |
Force |
Optional |
SwitchParameter |
Suppresses any confirmation prompts that would otherwise be displayed before making changes. |
WhatIf |
Optional |
SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Confirm |
Optional |
SwitchParameter |
Prompts you for confirmation before executing the command. |
Input Types
Microsoft.Rtc.Management.Voice.Helpers.DisplayCallParkOrbit object. Accepts pipelined input of call park orbit objects.
Return Types
This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayCallParkOrbit.
Example
-------------------------- Example 1 --------------------------
Remove-CsCallParkOrbit -Identity "Redmond CPO 1"
In this example, Remove-CsCallParkOrbit is used to delete the call park orbit range with the name Redmond CPO 1.
-------------------------- Example 2 --------------------------
Get-CsCallParkOrbit | Remove-CsCallParkOrbit
The command in this example removes all call park orbit ranges that have been defined for an organization. The command first calls the Get-CsCallParkOrbit cmdlet with no parameters to retrieve all the defined call park orbit ranges. It then pipes that collection of call park orbit ranges to the Remove-CsCallParkOrbit cmdlet, which removes each call park orbit.
-------------------------- Example 3 --------------------------
Get-CsCallParkOrbit -Filter *Redmond* | Remove-CsCallParkOrbit
This command removes all call park orbit ranges that have an identity that includes the string "Redmond", such as "Redmond 501", "CP Redmond 1", and "ARedmond". The command first calls Get-CsCallParkOrbit with the Filter parameter to retrieve all call park orbit ranges that have an Identity with the string Redmond in it. This collection is piped to Remove-CsCallParkOrbit, which removes everything in the collection.