Set-CsPersistentChatActiveServer

Module:

SkypeForBusiness

Applies to:

Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Manages the list of active Persistent Chat servers. An active server is Persistent Chat server (in a specified Persistent Chat service pool) that is fully operational and can accept new client connections. Servers in the pool that have not been marked as active servers might be operational, but are currently unable to accept new client connections. This cmdlet was introduced in Lync Server 2013.

Syntax

Set-CsPersistentChatActiveServer
   [[-Identity] <XdsGlobalRelativeIdentity>]
   -ActiveServers <System.Management.Automation.PSListModifier`1[Microsoft.Rtc.Management.Deploy.Fqdn]>
   [-Confirm]
   [-Force]
   [-WhatIf]
   [<CommonParameters>]

Set-CsPersistentChatActiveServer
   [[-Identity] <XdsGlobalRelativeIdentity>]
   [-Swap]
   [-Confirm]
   [-Force]
   [-WhatIf]
   [<CommonParameters>]

Description

The Set-CsPersistentChatActiveServer cmdlet allows administrators to essentially enable or disable the Persistent Chat service on one or more servers in a Persistent Chat pool. Servers that appear on the active servers list are able to accept new client connections. Servers that do not appear on the list are not able to accept new client connections. (However, the server will continue to any client connections that were made before the server was removed from the list.) To enable the Persistent Chat service on a Persistent Chat server, add that server to the active server list. To disable the service, remove the server from the active server list.

To enable/disable the Persistent Chat service on all the servers in a pool, use the Set-CsPersistentChatState cmdlet.

Skype for Business Server Control Panel: The functions carried out by the Set-CsPersistentChatActiveServer cmdlet are not available in the Skype for Business Server Control Panel.

Examples

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

Set-CsPersistentChatActiveServer -Identity "PChatServerCollection" -ActiveServers @{Add="atl-gc-001.litwareinc.com"}

The command shown in Example 1 adds the server atl-gc-001.litwareinc.com to the collection of active Persistent Chat Servers.

First, determine the identity of your server collection by running the Get-CsService cmdlet, which will return the identity of your Persistent Chat collection :

Get-CsService -PersistentChatServer

The cmdlet will return something similar to

Identity : PersistentChatServer:client.vdomain.com

To add the server to the Then run the following cmdlet to add the server, using the :

Set-CsPersistentChatActiveServer -Identity "PChatServerCollection" -ActiveServers @{Add="atl-gc-001.litwareinc.com"}

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

Set-CsPersistentChatActiveServer -Identity "PChatServerCollection" -ActiveServers @{Remove="atl-gc-001.litwareinc.com"}

Example 2 removes the server atl-gc-001.litwareinc.com from the collection of active Persistent Chat servers.

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

Set-CsPersistentChatActiveServer -Identity "PChatServerCollection" -ActiveServers $Null

The command shown in Example 3 removes all the active Persistent Chat servers. Removing all the active servers is typically done in a failback or failover scenario.

Parameters

-ActiveServers

Collection of fully-qualified domain names representing the active Persistent Chat servers.

Type:	System.Management.Automation.PSListModifier`1[Microsoft.Rtc.Management.Deploy.Fqdn]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Lync Server 2013, Skype for Business Server 2015

-Confirm

Prompts you for confirmation before executing the command.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Lync Server 2013, Skype for Business Server 2015

-Force

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Lync Server 2013, Skype for Business Server 2015

-Identity

Unique Identity for the collection of active servers. Note that you can only have a single collection of Persistent Chat servers.

Type:	XdsGlobalRelativeIdentity
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Lync Server 2013, Skype for Business Server 2015

-Swap

When specified, swaps the active state for all the Persistent Chat servers in the specified pool: active servers will be marked as inactive, and inactive servers will be marked as active.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Lync Server 2013, Skype for Business Server 2015

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Lync Server 2013, Skype for Business Server 2015

Inputs

None. The Set-CsPersistentChatActiveServer cmdlet does not accept pipelined input.

Outputs

None.

Related Links

• Set-CsPersistentChatState