[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Gets the call park orbit settings for the organization.

Syntax

Get-CsCallParkOrbit [-Identity <XdsGlobalRelativeIdentity>] [-LocalStore <SwitchParameter>]
Get-CsCallParkOrbit [-Filter <String>] [-LocalStore <SwitchParameter>]

Parameters

Parameter Required Type Description

Identity

Optional

String

The unique name of the call park orbit. This name was assigned by the administrator when the call park orbit was defined.

Filter

Optional

String

This parameter accepts a wildcard string and returns all call park orbits with identities matching that string. For example, a Filter value of Redmond* will return all call park orbits with names beginning with the string Redmond, such as Redmond 1, Redmond 2, and RedmondCPO.

LocalStore

Optional

Guid

Retrieves the call park orbit information from the local replica of the Central Management database, rather than the Central Management database itself.

Detailed Description

This cmdlet retrieves the settings for the call park orbits defined for an organization. Call park orbits are composed of settings that specify a range of numbers at which a user can park a call, and the servers associated with those number ranges. You can retrieve a single call park orbit (specified by the Identity parameter) or you can call Get-CsCallParkOrbit with no parameters to retrieve all the call park orbits defined for an organization.

Return Types

This cmdlet returns an object of the data type Microsoft.Rtc.Management.Voice.Helpers.DisplayCallParkOrbits.

Examples

-------------------------- Example 1 --------------------------

Copy Code
Get-CsCallParkOrbit

In this example, Get-CsCallParkOrbit is called without specifying any additional parameters. When called like this, Get-CsCallParkOrbit returns a collection of all the call park orbits configured for use in your organization.

-------------------------- Example 2 --------------------------

Copy Code
Get-CsCallParkOrbit -Identity "Redmond CPO 1"

In Example 2, Get-CsCallParkOrbit is used to return information about the call park orbit with the name "Redmond CPO 1".

-------------------------- Example 3 --------------------------

Copy Code
Get-CsCallParkOrbit -Filter *Redmond*

The command in this example returns all call park orbits with the string "Redmond" in their Identity. For example, this command will return call park orbits with identities such as "Redmond 501", "CP Redmond 1", and "ARedmond". The command uses the Filter parameter with the wildcard character (*) to designate what to search for. (This search is not case-sensitive.)

-------------------------- Example 4 --------------------------

Copy Code
Get-CsCallParkOrbit | Where-Object {$_.CallParkServiceId -eq "ApplicationServer:pool0.litwareinc.com"}

This command returns all call park orbits assigned to the call park service with the ID ApplicationServer:pool0.litwareinc.com. The Get-CsCallParkOrbit cmdlet retrieves a collection of all call park orbits, and then pipes that collection to the Where-Object cmdlet. This call to Where-Object finds all call park orbits in that collection with a value of ApplicationServer:pool0.litwareinc.com in their CallParkServiceId parameters.

-------------------------- Example 5 --------------------------

Copy Code
Get-CsCallParkOrbit | Where-Object {$_.NumberRangeStart.StartsWith("*")}

The command in this example returns all call park orbits where the range of numbers starts with an * prefix. After Get-CsCallParkOrbit retrieves a collection of all the call park orbits, the collection is then piped to Where-Object. Where-Object narrows the collection to only those call park orbits that have a call park location starting with a *. It does this by checking the StartsWith property of the NumberRangeStart object for the string "*".

-------------------------- Example 6 --------------------------

Copy Code
Get-CsCallParkOrbit | Where-Object {[Char]::IsDigit($_.NumberRangeStart[0])}

The command in this example returns all call park orbits where no prefix has been assigned to the numbers in the range. (A prefix is the value * or # placed at the beginning of the number.) All call park orbits returned by this command will have ranges that consist only of numbers with no other characters included. Get-CsCallParkOrbit retrieves a collection of all the call park orbits, and then that collection is piped to Where-Object. Looking at the criteria in the call to Where-Object, we see this: $_.NumberRangeStart[0]). This returns the first character in the number at the start of the range. (Note that we need to check only the start of the range--if the start doesn’t have a prefix, neither will the end.) This character is passed to the IsDigit function to determine whether it is a numeric character. If it is, the call park orbit information for the corresponding collection item will be returned.