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

Enables you to specify a new database location for one or more Archiving Servers.


Set-CsArchivingServer [-Identity <XdsGlobalRelativeIdentity>] [-ArchivingDatabase <String>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]


Parameter Required Type Description



Xds Identity

Service location of the Archiving Server instance to be modified. For example: ArchivingServer:atl-cs-001.litwareinc.com. You can retrieve the service location for all your archiving servers by running this command:

Get-CsService –ArchivingServer | Select-Object Identity.




Service location where the new archiving database is located. For example: ArchivingDatabase:atl-sql-001.litwareinc.com. Make sure you use the service location and not the SQL Server path when specifying the database location.



Switch Parameter

Suppresses the display of any non-fatal error message that might arise when running the command.



Switch Parameter

Describes what would happen if you executed the command without actually executing the command.



Switch Parameter

Prompts you for confirmation before executing the command.

Detailed Description

Archiving Server provides a way for you to save complete transcripts of all the instant messaging sessions that take place in your organization. (Alternatively, you might choose to save transcripts only for specific users.) In some organizations, it can be useful to have copies of these instant messaging sessions. In other organizations, where records must be kept of all electronic communications, it can be mandatory to have copies of these instant messaging sessions.

Archiving Server records the transcript of each instant message session (as well as information about when the session took place, and who participated in the session) in a SQL Server database. The location of this database must be specified when you install Archiving Server, and, in most cases, you will not need to change the location of that database. However, if a hardware failure or other problem should arise, you can point Archiving Server to a new database location by using the Set-CsArchivingServer cmdlet.

Return Types

Set-CsArchivingServer does not return any objects or values. Instead, the cmdlet modifies instances of the Microsoft.Rtc.Management.Xds.DisplayArchivingServer object.


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

Copy Code
Set-CsArchivingServer -Identity "ArchivingServer:atl-cs-001.litwareinc.com" -ArchivingDatabase "ArchivingDatabase:atl-sql-001.litwareinc.com"

The preceding command changes the location of the archiving database for the archiving server ArchivingServer:atl-cs-001.litwareinc.com. In this example, the new database is located on the service ArchivingDatabase:atl-sql-001.litwareinc.com.