Set-CsArchivingServer
Enables you to specify a new database location for one or more Archiving Servers. This cmdlet was introduced in Lync Server 2010.
Syntax
Default (Default)
Set-CsArchivingServer
[[-Identity] <XdsGlobalRelativeIdentity>]
[-ArchivingDatabase <String>]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Archiving Servers provide a way for you to save complete transcripts of the instant messaging (IM) sessions that take place in your organization. In some organizations, it can be useful to have copies of these IM sessions. In other organizations, where records must be kept of all electronic communications, it can be mandatory to have copies of these IM sessions.
Archiving Server records the transcript of each IM 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; in most cases, you will not need to change the location of that database.
However, if a hardware failure or other problem should occur, you can point Archiving Server to a new database by using the Set-CsArchivingServer cmdlet.
Examples
Example 1
Set-CsArchivingServer -Identity "ArchivingServer:atl-cs-001.litwareinc.com" -ArchivingDatabase "ArchivingDatabase:atl-sql-001.litwareinc.com"
The command shown in Example 1 changes the location of the Archiving database for the ArchivingServer:atl-cs-001.litwareinc.com Archiving Server . In this example, the new database is located at ArchivingDatabase:atl-sql-001.litwareinc.com.
Parameters
-ArchivingDatabase
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Service location where the new Archiving database is located.
For example: -ArchivingDatabase ArchivingDatabase:atl-sql-001.litwareinc.com.
Make sure you use the service location and not the SQL Server path when specifying the database location.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Prompts you for confirmation before executing the command.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Suppresses the display of any non-fatal error message that might occur when running the command.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Service location of the Archiving Server instance to be modified.
For example: -Identity 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
Note that you can leave off the prefix "ArchivingServer:" when specifying an Archiving server.
For example: -Identity "atl-cs-001.litwareinc.com".
Parameter properties
| Type: | XdsGlobalRelativeIdentity |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Describes what would happen if you executed the command without actually executing the command.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
The Set-CsArchivingServer cmdlet does not accept pipelined input.
Outputs
None
The Set-CsArchivingServer cmdlet does not return any objects or values.
Instead, the cmdlet modifies instances of the Microsoft.Rtc.Management.Xds.DisplayArchivingServer object.