Removes the specified collection of Call Detail Recording settings. Call Detail Recording is used to track information about peer-to-peer, VoIP, and conferencing phone calls made in your organization.
Syntax
Remove-CsCdrConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
XdsIdentity |
Unique identifier of the Call Detail Configuration settings to be removed. To "remove" the global settings use this syntax: -Identity global. (As noted previously, you cannot actually remove the global settings; all you can do is reset the properties to their default values.) To remove settings from the site scope use syntax similar to this: -Identity site:Redmond. Note that you cannot use wildcards when specifying an Identity. |
|
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.
Site-specific settings you create using New-CsCdrConfiguration can be removed by using the Remove-CsCdrConfiguration cmdlet. When you remove site-specific settings then Call Detail Recording for the affected site will automatically be governed by the global CDR configuration settings.
You can also run Remove-CsCdrConfiguration against those global settings. In that case, the global settings will not be removed; that’s because the global settings cannot be removed. However, all the global properties will be reset to their default values. For example, suppose, at some point, you set the value of the global KeepCallDetailForDays property to 90. If you run Remove-CsCdrConfiguration the global settings, that property will be reset to its default value of 60.
Return Types
Deletes instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.CallDetailRecording.CdrSettings object.
Examples
-------------------------- Example 1 --------------------------
 Copy Code |
|
|---|---|
Remove-CsCdrConfiguration -Identity site:Redmond |
|
The preceding command uses Remove-CsCdrConfiguration to remove the Call Detail Recording settings assigned to the Redmond site. Using the -Identity parameter ensures that only the settings assigned to the specified site will be removed.
-------------------------- Example 2 --------------------------
| Copy Code |
|
|---|---|
Get-CsCdrConfiguration -Filter site:* | Remove-CsCdrConfiguration |
|
The command shown in Example 2 removes all the Call Detail Recording settings that have been assigned at the site scope. To do this, the command first uses Get-CsCdrConfiguration and the -Filter parameter to retrieve the appropriate CDR settings; the wildcard string "site:*" ensures that only those settings that have an Identity that begins with the string value "site:" are returned. The filtered collection is then passed to Remove-CsCdrConfiguration, which deletes all the items in the collection.
-------------------------- Example 3 --------------------------
| Copy Code |
|
|---|---|
Get-CsCdrConfiguration | Where-Object {$_.KeepCallDetailForDays -lt 30} | Remove-CsCdrConfiguration
|
|
In Example 3, any Call Detail Recording settings where the KeepCallDetailForDays property is less than 30 days are deleted. To carry out this task, the command calls Get-CsCdrConfiguration without any parameters in order to return a collection of all the CDR settings currently in use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those settings where the KeepCallDetailForDays property is less than (-lt) 30 days. In turn, the filtered collection is piped to Remove-CsCdrConfiguration, which deletes each item in that collection.