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

Returns information about the Call Park application. Call parking is a service that allows a user to park an incoming phone call. Parking a call transfers it to a number in a specified range, or orbit, and then immediately places the call on hold. Anyone (not just the person who originally answered the call) can resume the conversation from any telephone in the system by entering the correct number.

Syntax

Get-CsCpsConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>]
Get-CsCpsConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>]

Parameters

Parameter Required Type Description

Identity

Optional

XdsIdentity

The unique identifier of the Call Park application configuration you want to retrieve. This identifier will be either Global or site:<sitename>, where <sitename> is the name of the site to which the configuration applies.

Filter

Optional

String

Allows you to perform a wildcard search to retrieve only those configurations with identity values matching the wildcard string.

LocalStore

Optional

SwitchParameter

Retrieves the Call Park service information from the local replica of the Central Management database, rather than the Central Management database itself.

Detailed Description

This cmdlet is used to retrieve one or more Call Park application configurations. A Call Park application configuration specifies what happens to a call once it’s parked. For example, if a parked call isn’t answered after a period of time it can be automatically forwarded to someone else, such as an administrator, or to a Response Group. Calls can be configured to ring after a certain period of time to ensure the call isn’t forgotten. In addition, the Call Park application can be configured to play music on hold to the caller while the call is parked.

Return Types

Retrieves one or more objects of type Microsoft.Rtc.Management.WritableConfig.Settings.CallParkServiceSettings.CallParkServiceSettings.

Examples

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

Copy Code
Get-CsCpsConfiguration

Example 1 retrieves a collection of all the Call Park application configurations that have been defined for use in your organization.

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

Copy Code
Get-CsCpsConfiguration -Identity site:Redmond1

This command retrieves the Call Park application configurations with the Identity site:Redmond1.

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

Copy Code
Get-CsCpsConfiguration -Filter site:*

In Example 3, the Filter parameter is used to return all the Call Park application configurations that have been configured at the site scope. The wildcard site:* tells Get-CsCpsConfiguration to return only those settings collections where the identity begins with the string value site:.

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

Copy Code
Get-CsCpsConfiguration -Filter *:re*

As in the previous example, in this example we use the Filter parameter to retrieve a subset of all the defined Call Park application configurations. In this case, we filter on the string *:re*, which will return Call Park configurations for all sites that have names beginning with the letters re, such as Redmond1, Redmond2, and RemoteComputer.

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

Copy Code
Get-CsCpsConfiguration | Where-Object {$_.EnableMusicOnHold -eq $False}

The command shown above returns all the Call Park application settings that do not play music when a caller is placed on hold. To do this, the command first uses Get-CsCpsConfiguration to retrieve all the Call Park application settings configured for use in the organization. That collection is then piped to the Where-Object cmdlet, which, in turn, applies a filter that limits the returned data to those items where the EnableMusicOnHold property is equal to (-eq) False.