Set-CsCdrConfiguration
Topic Last Modified: 2012-03-26
Modifies an existing collection of call detail recording (CDR) settings. CDR enables you to track usage of such things as peer-to-peer instant messaging sessions, Voice over Internet Protocol (VoIP) phone calls, and conferencing calls. This usage data includes information about who called whom, 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 [-Confirm [<SwitchParameter>]] [-EnableCDR <$true | $false>] [-EnablePurging <$true | $false>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-KeepCallDetailForDays <UInt32>] [-KeepErrorReportForDays <UInt32>] [-PurgeHourOfDay <UInt32>] [-WhatIf [<SwitchParameter>]]
Detailed Description
Call detail recording (CDR) provides a way for you to track usage of Microsoft Lync Server 2010 capabilities such as Voice over Internet Protocol (VoIP) phone calls; instant messaging (IM); file transfers; audio/video (A/V) 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; and whether or not any files were transferred. However, CDR does not make a recording of the call itself.
CDR also keeps track of call error information: detailed diagnostic data for both peer-to-peer sessions and for conferencing calls.
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.
Administrators can also manage the CDR database; for example, you can specify the number of days CDR records are maintained before they are purged from that database. Changes such as these can be made by using the Set-CsCdrConfiguration cmdlet.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsCdrConfiguration cmdlet locally: RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsCdrConfiguration"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
Xds Identity |
Unique identifier 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 CDR is enabled. The default value is True. |
EnablePurging |
Optional |
Boolean |
Indicates whether or not CDR 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 properties KeepCallDetailForDays (for CDR records) and KeepErrorReportForDays (for CDR errors). If False, CDR records will be maintained indefinitely. |
KeepCallDetailForDays |
Optional |
Integer |
Indicates the number of days that CDR 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 only place if the EnablePurging property has been set to true.) You can set this property to any integer value between 1 and 2562 days (approximately 7 years). The default value is 60. |
KeepErrorReportForDays |
Optional |
Integer |
Indicates the number of days that CDR error reports are kept; any reports older than the specified number of days will automatically be deleted. CDR error reports are diagnostic reports uploaded by client applications such as Microsoft Lync 2010. You can set this property to any integer value between 1 and 2562 days (approximately 7 years). The default value is 60. |
PurgeHourOfDay |
Optional |
Integer |
Indicates the local 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 A.M.) and 23 representing 11:00 P.M. Note that you can only specify the hour of the day; that means that you can schedule purging to take place at 4:00 A.M., but you cannot schedule it to take place at 4:30 A.M. or 4:15 A.M.. The default value is 2 (2:00 A.M.). It is recommended that purging take place during non-working hours. 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 occur when running the command. |
WhatIf |
Optional |
Switch Parameter |
Describes what would happen if you executed the command without actually executing the command. |
Confirm |
Optional |
Switch Parameter |
Prompts you for confirmation before executing the command. |
Input Types
Microsoft.Rtc.Management.WritableConfig.Settings.CallDetailRecording.CdrSettings. Set-CsCdrConfiguration accepts pipelined input of call detail recording configuration objects.
Return Types
Set-CsCdrConfiguration does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CallDetailRecording.CDRSettings object.
Example
-------------------------- Example 1 --------------------------
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 P.M. 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 --------------------------
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 --------------------------
Get-CsCdrConfiguration -Filter "site:*"| Set-CsCdrConfiguration -PurgeHourOfDay 23
Another variation of the command used 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. To perform this task, the command first calls Get-CsCdrConfiguration along with 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. The filtered collection is then piped to Set-CsCdrConfiguration, which changes the PurgeHourOfDay property for each item in that collection.