Share via

  • Article

Remove-CsArchivingConfiguration

 

Topic Last Modified: 2012-03-27

Removes the specified collection of archiving settings. Archiving settings are used to enable or disable the automatic saving of instant messaging (IM) sessions, and to optionally block any instant message that cannot be archived.

Syntax

Remove-CsArchivingConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Detailed Description

Many organizations find it useful to keep a transcript of all the IM sessions and conferences their users participate in. For other organizations, it’s mandatory to keep such transcripts; for example, many organizations in the financial world are required by law to keep copies of all their electronic communications.

Microsoft Lync Server 2010 gives you flexibility when it comes to archiving IM and web conferencing sessions. If you have deployed Archiving Server, you can use the various CsArchivingConfiguration cmdlets to enable and disable IM session archiving and to manage your archiving database. You can also suspend IM should archiving fail; this helps to ensure that you keep a record of all your electronic communications.

When you install Lync Server 2010, a collection of global archiving settings will be created for you; by default, these settings will apply to your entire organization. Alternatively, you can use the New-CsArchivingConfiguration cmdlet to create custom configuration settings on a site-by-site basis. Any site-specific settings created using New-CsArchivingConfiguration can later be removed by using the Remove-CsArchivingConfiguration cmdlet. When you remove the settings for a site, the affected site will then be governed by the global settings.

Note that you can also run Remove-CsArchivingConfiguration against the global archiving settings. In that case, however, the settings will not be removed; that’s because you cannot delete the global settings. Instead, all the global properties will be reset to their default values. For example, suppose you have enabled IM session archiving at the global scope; sometime later, you run the command Remove-CsArchivingConfiguration -Identity global. Running that command will reset the property values for the global settings; that means that EnableArchiving will revert to its default value of None. In turn, that will disable archiving at the global scope.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Remove-CsArchivingConfiguration 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 "Remove-CsArchivingConfiguration"}

Parameters

Parameter Required Type Description

Identity

Required

Xds Identity

Unique identifier for the collection of archiving configuration settings to be removed. To remove the global collection, use the following syntax: -Identity global. (Note that you cannot actually remove the global settings; instead, you can only reset the properties to their default values.) To remove a site collection, use syntax similar to this: -Identity site:Redmond. You cannot use wildcards when specifying a policy Identity.

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.Archiving.ArchivingSettings object. Remove-CsArchivingConfiguration accepts pipelined input of archiving configuration objects.

Return Types

Set-CsArchivingConfiguration does not return a value or object. Instead, the cmdlet removes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings object.

Example

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

Remove-CsArchivingConfiguration -Identity site:Redmond

The preceding example uses Remove-CsArchivingConfiguration to delete the archiving configuration settings with the identity site:Redmond.

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

Get-CsArchivingConfiguration -Filter "site:*" | Remove-CsArchivingConfiguration

The command shown in Example 2 removes all of the archiving configuration settings that have been configured at the site scope. To do this, the command first uses Get-CsArchivingConfiguration and the Filter parameter to return a collection of all of the settings configured at the site scope. This is done by using the filter value "site:*", which limits the returned data to settings that have an Identity that begins with the characters "site:". The filtered collection is then piped to Remove-CsArchivingConfiguration, which deletes each item in that collection.

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

Get-CsArchivingConfiguration | Where-Object {$_.EnableArchiving -eq "None"} | Remove-CsArchivingConfiguration

Example 3 deletes all the archiving configuration settings where the EnableArchiving property has been set to "None". To carry out this task, Get-CsArchivingConfiguration is called without any parameters in order to return a collection of all the archiving settings configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those settings where the EnableArchiving property is equal to "None". The filtered collection is then piped to Remove-CsArchivingConfiguration, which deletes each item in the collection.