Set-CsCallParkOrbit
Topic Last Modified: 2012-03-26
Sets the properties for an existing call park orbit range within an organization.
Syntax
Set-CsCallParkOrbit [-Identity <XdsGlobalRelativeIdentity>] [-NumberRangeStart <String>] [-NumberRangeEnd <String>] [-CallParkService <String>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Set-CsCallParkOrbit [-NumberRangeStart <String>] [-NumberRangeEnd <String>] [-CallParkService <String>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Instance <PSObject>] [-WhatIf [<SwitchParameter>]]
Detailed Description
Parking a call assigns a received phone call to a number within a specific range for later retrieval. A call park orbit is the set of numbers defined for this purpose. The Set-CsCallParkOrbit cmdlet enables you to change the number ranges and the ID of the Call Park service. The new range of numbers must be unique among all call park orbits defined within the organization.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-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 "Set-CsCallParkOrbit"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
String |
The unique identifier of the call park orbit range to be modified. If the Identity includes spaces, this value must be included within double quotes. |
Instance |
Optional |
DisplayCallParkOrbit |
Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. This object must be of type DisplayCallParkOrbit, which can be retrieved by calling the Get-CsCallParkOrbit cmdlet. |
CallParkService |
Required |
String |
The fully qualified domain name (FQDN) or service ID of the Application service that hosts the Call Park application. All calls parked to numbers within the range specified by the NumberRangeStart and NumberRangeEnd parameters will be routed to this server or pool. |
NumberRangeStart |
Required |
String |
The first number in the range for this call park orbit. The value must be less than or equal to the NumberRangeEnd. The value must also be the same length as the value of the NumberRangeEnd. Valid values: Must match the regular expression string ([\*|#]?[1-9]\d{0,7})|([1-9]\d{0,8}). This means that the value must be a string beginning with either the character * or # or a number 1 through 9 (the first character cannot be a zero). If the first character is * or # the following character must be a number 1 through 9 (it cannot be a zero). Subsequent characters can be any number 0 through 9 up to seven additional characters. (For example, "#6000", "*92000", and "*95551212".) The number following the * or # must be greater than 100. If the first character is not * or #, the first character must be a number 1 through 9 (it cannot be zero), followed by up to eight characters, each a number 0 through 9. (For example, 915551212;41212;300.) |
NumberRangeEnd |
Required |
String |
The last number in the range for this call park orbit. The value must be greater than or equal to the NumberRangeStart. The value must also be the same length as the value of the NumberRangeStart. For example, if NumberRangeStart is set to 100, NumberRangeEnd cannot be set to 1001. In addition, if the NumberRangeStart begins with a * or #, then NumberRangeEnd must begin with the same character. Valid values: Must match the regular expression string ([\*|#]?[1-9]\d{0,7})|([1-9]\d{0,8}). This means that the value must be a string beginning with either the character * or # or a number 1 through 9 (the first character cannot be a zero). If the first character is * or # the following character must be a number 1 through 9 (it cannot be a zero). Subsequent characters can be any number 0 through 9 up to seven additional characters. (For example, "#6000", "*92000", and "*95551212".) If the first character is not * or #, the first character must be a number 1 through 9 (it cannot be zero), followed by up to eight characters, each a number 0 through 9. (For example, 915551212;41212;300.) |
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 modifies an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayCallParkOrbit.
Example
-------------------------- Example 1 --------------------------
Set-CsCallParkOrbit -Identity "Redmond CPO 1" -NumberRangeStart 500 -NumberRangeEnd 699
This example changes the range of numbers for the call park orbit named "Redmond CPO 1" to 500 through 699. All values within this range must be unique among all call park orbit ranges within the organization.
-------------------------- Example 2 --------------------------
Set-CsCallParkOrbit -Identity "Redmond CPO 2" -NumberRangeStart "*7000" -NumberRangeEnd "*7100"
This example changes the range of numbers for the call park orbit named "Redmond CPO 2" to *7000 through *7100. All values within this range must be unique among all call park orbit ranges within the organization. Note that, unlike the preceding example, double quote marks were included around the values assigned to NumberRangeStart and NumberRangeEnd. If these values begin with a * or # (the only non-numeric values allowed) you must enclose the value in double quotes.