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

Modifies an existing collection of Call Detail Recording (CDR) settings. CDR enables you to keep track of peer-to-peer, VoIP, and conferencing phone calls, including information about who called who, when they called, and how long they talked.

Syntax


Set-CsCdrConfiguration [-Identity <XdsIdentity>] [-Confirm [<SwitchParameter>]] [-EnableCDR <$true \| $false>] [-EnablePurging <$true \| $false>] [-Force <SwitchParameter>] [-KeepCallDetailForDays <UInt32>] [-KeepErrorReportForDays <UInt32>] [-PurgeHourOfDay <UInt32>] [-WhatIf [<SwitchParameter>]]

Set-CsCdrConfiguration [-Identity <XdsIdentity>] [-Confirm [<SwitchParameter>]] [-EnableCDR <$true | $false>] [-EnablePurging <$true | $false>] [-Force <SwitchParameter>] [-KeepCallDetailForDays <UInt32>] [-KeepErrorReportForDays <UInt32>] [-PurgeHourOfDay <UInt32>] [-WhatIf [<SwitchParameter>]]


Set-CsCdrConfiguration [-Confirm [<SwitchParameter>]] [-EnableCDR <$true \| $false>] [-EnablePurging <$true \| $false>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-KeepCallDetailForDays <UInt32>] [-KeepErrorReportForDays <UInt32>] [-PurgeHourOfDay <UInt32>] [-WhatIf [<SwitchParameter>]]

Set-CsCdrConfiguration [-Confirm [<SwitchParameter>]] [-EnableCDR <$true | $false>] [-EnablePurging <$true | $false>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-KeepCallDetailForDays <UInt32>] [-KeepErrorReportForDays <UInt32>] [-PurgeHourOfDay <UInt32>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter	Required	Type	Description
Identity	Optional	XdsIdentity	Represents the unique identifier to be assigned to the collection of CDR configuration settings. 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 wildcard characters when specifying an Identity. If this parameter is omitted then Set-CsCdrConfiguration will modify the global settings.
Instance	Optional	CdrSettings object	Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.
EnableCDR	Optional	Boolean	Indicates whether or not Call Detail Recording is enabled. The default value is True.
EnablePurging	Optional	Boolean	Indicates whether or not Call Detail records will periodically be deleted from the CDR database. If True (the default value) records will be deleted after the time period specified by the KeepCallDetailForDays property. If False, CDR records will be maintained indefinitely.
KeepCallDetailForDays	Optional	Integer	Indicates the number of days that Call Detail records will be kept in the CDR database; any records older than the specified number of days will automatically be deleted. (Note that purging will take place only if the EnablePurging property has been set to true.) You can set this property to any integer value between 1 and 2562 (approximately 7 years). The default value is 60.
KeepErrorReportForDays	Optional	Integer	Indicates the number of days that Call Detail error reports are kept; any reports older than the specified number of days will automatically be deleted. You can set this property to any integer value between 1 and 2562 (approximately 7 years). The default value is 10.
PurgeHourOfDay	Optional	Integer	Indicates the time of day when expired records are deleted from the CDR database. The time of day is specified using a 24-hour clock, with 0 representing midnight (12:00 AM) and 23 representing 11:00 PM. Note that you can only specify the hour of the day; although you can schedule purging to take place at 4:00 AM you cannot schedule it to take place at, say, 4:30AM or 4:15 AM. The default value is 2 (2:00 AM). Database purging takes place only if the EnablePurging property is set to True.
Force	Optional	Switch Parameter	Suppresses the display of any non-fatal error message that might arise when running the command.
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.

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 Call Detail Recording. 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 Call Detail Recording in the Redmond site but not use Call Detail Recording in the Paris site.

Administrators can also manage the CDR database, doing such things as specifying the number of days CDR records are maintained before they are purged from the database. Changes such as these can be made using the Set-CsCdrConfiguration cmdlet.

Return Types

Set-CsCdrConfiguration does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.CallDetailRecording.CDRSettings object.

Examples

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

	Copy Code
Set-CsCdrConfiguration -Identity site:Redmond -PurgeHourOfDay 23

The preceding example sets the time of day for purging old records; in this case the time is set to 23 (11:00 PM on a 24-hour clock). The -Identity parameter is used to ensure that these changes are only made to the CDR settings that have the Identity site:Redmond.

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

	Copy Code
Get-CsCdrConfiguration \| Set-CsCdrConfiguration -PurgeHourOfDay 23

Example 2 is a variation of the command shown in Example 1; in this case, the PurgeHourOfDay property is modified for each collection of CDR configuration settings currently in use in the organization. To do this, the command first calls Get-CsCdrConfiguration (without any parameters) in order to return a collection of all the CDR settings currently in use. This collection is then piped to Set-CsCdrConfiguration, which takes each item in the collection and changes the value of the PurgeHourOfDay property to 11:00 PM (23).

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

	Copy Code
Get-CsCdrConfiguration -Filter "site:*"\| Set-CsCdrConfiguration -PurgeHourOfDay 23

Another variation of the command demonstrated in Example 1 is shown in Example 3. In this example, the PurgeHourOfDay property is changed for all the CDR settings that have been configured at the site scope. (This means that the global settings will not be changed.) To perform this task, the command calls Get-CsCdrConfiguration. This call includes the -Filter parameter; the filter value "site:*" ensures that only CDR settings that have an Identity that begins with the string value "site:" will be returned. This filtered collection is piped to Set-CsCdrConfiguration, which proceeds to modify the PurgeHourOfDay property for each item in that collection.