Topic Last Modified: 2010-10-01

Returns information about how (or if) instant messaging (IM) sessions are archived in your organization.


Get-CsArchivingConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>]
Get-CsArchivingConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>]


Parameter Required Type Description



Xds Identity

Indicates the unique identifier for the collection of archiving settings you want to return. 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 wildcards when specifying an Identity. If you need to use wildcards, then include the Filter parameter instead.

If this parameter is not specified, then Get-CsArchivingConfiguration returns a collection of all the archiving configuration settings in use in the organization.




Enables you to use wildcard characters in order to return a collection (or collections) of archiving configuration settings. To return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. To return a collection of all the settings that have the string value "Canada" somewhere in their Identity (the only property you can filter on) use this syntax: -Filter "*Canada*".



Switch Parameter

Retrieves the archiving configuration data from the local replica of the Central Management store rather than from the Central Management store itself.

Detailed Description

Many organizations find it useful to keep a transcript of all the IM sessions carried out by their users (or a selected subset of users). 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 instant message 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.

In order to archive IM sessions, you must set up at least one Archiving Server. After the Archiving Server is set up, you must perform two additional steps. First, you need to enable archiving at the appropriate scope (for details, see the Set-CsArchivingConfiguration topic). This might be the global scope; however, you can also configure custom archiving settings for different sites.

Second, you must use archiving policies to indicate which users will have their IM sessions archived. What happens if you enable archiving but do not assign any users a policy that specifies that their IM sessions should be archived? Literally, nothing happens: IM sessions will not be archived unless a policy is in force that requires IM sessions to be archived.

With the Get-CsArchivingConfiguration cmdlet, you can determine how IM session archiving has been configured in your organization.

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

Input Types

None. Get-CsArchivingConfiguration does not accept pipelined input.

Return Types

Get-CsArchivingConfiguration returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings object.


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

Copy Code

The command shown in Example 1 returns a collection of all the archiving configuration settings in use in your organization.

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

Copy Code
Get-CsArchivingConfiguration -Identity site:Redmond

In the preceding example, the Identity parameter is used to limit the returned collection of archiving configuration settings to those settings that have the Identity site:Redmond.

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

Copy Code
Get-CsArchivingConfiguration -Filter site:*

In Example 3, the Filter parameter is used to limit the returned collection of archiving configuration settings to settings that have been configured at the site scope. The parameter value "site:*" limits the returned items to those that have an Identity that starts with the string value "site:".

-------------------------- Example 4 --------------------------

Copy Code
Get-CsArchivingConfiguration | Where-Object {$_.EnableArchiving -ne "None"}

This example uses Get-CsArchivingConfiguration to return a collection of all the archiving configuration settings that have been enabled for use in your organization. To do that, the command first calls Get-CsArchivingConfiguration without any parameters in order to return a collection of all your archiving configuration settings. That collection is then piped to the Where-Object cmdlet, which applies a filter that limits the returned data to those collections where the EnableArchiving property is not equal to "None". If EnableArchiving is set to "None", archiving has been disabled. If this property is set to any other value (either "IMOnly" or "ImAndWebConf") that means that archiving has been enabled.

See Also