Set-CsPersistentChatState

Modifies the state of a Persistent Chat service pool. Persistent Chat pools can be in one of two states: Normal, in which the pool uses its primary databases; or FailedOver, in which the pool uses the backup databases defined in the topology. This cmdlet was introduced in Lync Server 2013.

Syntax

Set-CsPersistentChatState
   [[-Identity] <XdsIdentity>]
   [-Confirm]
   [-Force]
   [-PoolState <PoolState>]
   [-WhatIf]
   [<CommonParameters>]
Set-CsPersistentChatState
   [-Confirm]
   [-Force]
   [-Instance <PSObject>]
   [-PoolState <PoolState>]
   [-WhatIf]
   [<CommonParameters>]

Description

The Get-CsPersistentChatState cmdlet returns the state of one or more Persistent Chat pools. Persistent Chat pools can be in either the Normal state (in which the pool uses its primary databases) or in a FailedOver state, in which the pool uses its backup databases. You can use the Set-CsPersistentChatState cmdlet to change the state of a Persistent Chat pool; when you change the state of the pool, Skype for Business Server will automatically change the state of each individual server in the pool. To change the state of an individual chat server, use the Set-CsPersistentChatActiveServer cmdlet.

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

Examples

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

Set-CsPersistentChatState -Identity "PersistentChatServer:atl-gc-001.litwareinc.com" -PoolState "FailedOver"

The command shown in Example 1 sets the pool state for the Persistent Chat server atl-gc-001.litwareinc.com to FailedOver.

Optional Parameters

-Confirm

Prompts you for confirmation before executing the command.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015
-Identity

Service Identity of the Persistent Chat pool where the new service state will be applied. For example:

-Identity PersistentChatServer:atl-persistentchat-001.litwareinc.com

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

Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.

Type:PSObject
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015
-PoolState

Current state of the Persistent Chat pool. Valid values are:

  • Normal
  • FailedOver

The default value is Normal.

Type:PoolState
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015

Inputs

The Set-CsPersistentChatState cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatstate object.

Outputs

None. Instead, the Set-CsPersistentChatState cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatState object.