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

Creates a new set of Call Detail Recording (CDR) settings. These settings can be used to record information about the peer-to-peer, VoIP, and conferencing phone calls that take place in your organization, including information about who called who, when they called, and how long they talked.

Syntax


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

New-CsCdrConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-EnableCDR <$true | $false>] [-EnablePurging <$true | $false>] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-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 new collection of CDR configuration settings. Because you can only create new collections at the site scope the Identity will always be the prefix "site:" followed by the site name; for example "site:Redmond".
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.) KeepCallDetailForDays can be set 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.
InMemory	Optional	SwitchParameter	Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet’s matching Set- cmdlet.
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.

The New-CsCdrConfiguration cmdlet enables you to create new CDR setting collections at the site scope. (New settings cannot be created at the global scope.) In addition, each site can only host a single collection of CDR settings. That means that you cannot create a new collection for the Redmond site if the site already has a set of CDR configuration settings. If you try this, you command will fail.

Return Types

Creates instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.CallDetailRecording.CdrSettings object.

Examples

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

	Copy Code
New-CsCdrConfiguration -Identity site:Redmond -EnableCDR $False

The command in Example 1 uses the New-CsCdrConfiguration cmdlet to create a new set of Call Detail Recording settings with the Identity site:Redmond. In addition to the Identity site:Redmond, the new settings also have the EnableCDR property set to False. Because site settings take precedence over global settings, this means that Call Detail Recording will not be used in the Redmond site, regardless of whether or not CDR has been enabled at the global scope.

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

	Copy Code
$x = New-CsCdrConfiguration -Identity site:Redmond -InMemory $x.EnableCDR = $False Set-CsCdrConfiguration -Instance $x

Example 2 uses the -InMemory parameter to demonstrate how you can create a new collection of CDR configuration settings that initially exist only in memory. To do this, the sample first uses New-CsCdrConfiguration and the -InMemory parameter to create a virtual collection of settings with the Identity site:Redmond. This virtual collection is stored in the variable $x; if the collection was not stored in a variable then it would be created and then immediately disappear.

After the virtual collection has been created, the command shown in line 2 sets the value of the EnableCDR property to False ($False). In line 3, Set-CsCdrConfiguration is then used to transform the virtual collection $x into an actual collection of CDR configuration settings that is applied to the Redmond site. If the command did not call Set-CsCdrConfiguration then the virtual collection would disappear as soon as the Windows PowerShell session was terminated or the variable $x was deleted.