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

Returns information about your call detail recording (CDR) settings. CDR enables you to keep track of peer-to-peer, voice over Internet Protocol (VoIP), and conferencing phone calls, including information about who called whom, when they called, and how long they talked.

Syntax


Get-CsCdrConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>]


Get-CsCdrConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>]

Parameters

Parameter	Required	Type	Description
Identity	Optional	XdsIdentity	Indicates the unique identifier for the collection of CDR configuration settings you want to return. To refer to the global settings, use this syntax: -Identity global. To refer to a collection configured at the site scope, use syntax similar to this: -Identity site:Redmond. Note that you cannot use wildcards when specifying an Identity. If you need to use wildcards then include the -Filter parameter instead. If this parameter is not specified then Get-CsCdrConfiguration will return a collection of all the CDR configuration settings currently in use in the organization.
Filter	Optional	String	Enables you to use wildcard characters in order to return a collection of CDR configuration settings. To return a collection of all the settings configured at the site scope, use this syntax: -Filter site:. To return a collection of all the settings that have the string value "Western" somewhere in their Identity use this syntax: -Filter Western*.
LocalStore	Optional	SwitchParameter

Parameter

Required

Type

Description

Identity

Optional

XdsIdentity

Indicates the unique identifier for the collection of CDR configuration settings you want to return. To refer to the global settings, use this syntax: -Identity global. To refer to a collection configured at the site scope, use syntax similar to this: -Identity site:Redmond. Note that you cannot use wildcards when specifying an Identity. If you need to use wildcards then include the -Filter parameter instead.

If this parameter is not specified then Get-CsCdrConfiguration will return a collection of all the CDR configuration settings currently in use in the organization.

Filter

Optional

String

Enables you to use wildcard characters in order to return a collection of CDR configuration settings. To return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. To return a collection of all the settings that have the string value "Western" somewhere in their Identity use this syntax: -Filter *Western*.

LocalStore

Optional

SwitchParameter

Detailed Description

Call Detail Recording provides a way for you to track usage of Microsoft Communications Server 2010 capabilities such as Voice over IP phone calls; instant messaging; file transfers; audio/video conferencing; and application sharing sessions. CDR (which is available only if you have deployed the Monitoring service) keeps usage information: it logs information such as the parties involved in the call; the length of the call; the size of the files transferred; etc. What CDR does not do is record the actual communication itself; for example, Call Detail Recording will log information about a Voice over IP phone call, but will not make a recording of the call itself.

As an administrator, you can determine whether or not CDR is used in your organization; assuming that the Monitoring service has been deployed, you can easily enable or disable CDR. In addition, you can make this decision globally (in which case CDR will either be enabled or disabled throughout the organization) or on a site-by-site basis; for example, you could use CDR in the Redmond site but not use CDR in the Paris site.

The Get-CsCdrConfiguration cmdlet provides a way for you return detailed information about how Call Detail Recording is used in your organization.

Return Types

Get-CsCdrConfiguration returns instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.CallDetailRecording.CdrSettings object.

Examples

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

	Copy Code
Get-CsCdrConfiguration

This example uses Get-CsCdrConfiguration to return a collection of all the CDR settings configured for use in your organization.

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

	Copy Code
Get-CsCdrConfiguration -Identity site:Redmond

Example 2 uses the -Identity parameter to ensure that Get-CsCdrConfiguration returns only the CDR settings with Identity site:Redmond.

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

	Copy Code
Get-CsCdrConfiguration -Filter site:*

In example 3 the -Filter parameter is employed to return all the CDR settings that have been configured at the site scope. The filter value "site:*" returns all the CDR settings that have an Identity that begins with the string value "site:". By definition, those are settings that have been configured at the site scope.

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

	Copy Code
Get-CsCdrConfiguration \| Where-Object {$_.KeepCallDetailForDays -lt 30}

The preceding example returns only a collection of all the CDR settings where the KeepCallDetailForDays property is less than 30 days. To do this, the command first uses Get-CsCdrConfiguration to return a collection of all the CDR settings configured in the organization. That collection is then "piped" to the Where-Object cmdlet, which applies a filter that limits the returned data to those settings that have a KeepCallDetailForDays value of 30 days or less.