See Also
Topic Last Modified: 2013-03-07
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>]
<COMMON PARAMETERS>
|
Set-CsPersistentChatState [-Instance <PSObject>]
<COMMON PARAMETERS>
|
COMMON PARAMETERS: [-Confirm [<SwitchParameter>]]
[-Force <SwitchParameter>] [-PoolState <FailedOver |
Normal>] [-WhatIf [<SwitchParameter>]]
|
Examples
Example 1
The command shown in Example 1 sets the pool state for the Persistent Chat server atl-gc-001.litwareinc.com to FailedOver.
 Copy Code |
|
|---|---|
Set-CsPersistentChatState -Identity "PersistentChatServer:atl-gc-001.litwareinc.com" -PoolState "FailedOver" |
|
Detailed 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, Lync Server 2013 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.
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 command-line interface prompt:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsPersistentChatState"}
Lync Server Control Panel: The functions carried out by the Set-CsPersistentChatState cmdlet are not available in the Lync Server Control Panel.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
Prompts you for confirmation before executing the command. |
|
Force |
Optional |
System.Management.Automation.SwitchParameter |
Suppresses the display of any non-fatal error message that might arise when running the command. |
|
Identity |
Optional |
Microsoft.Rtc.Management.Xds.XdsIdentity |
Service Identity of the Persistent Chat pool where the new service state will be applied. For example: -Identity PersistentChatServer:atl-persistentchat-001.litwareinc.com |
|
Instance |
Optional |
System.Management.Automation.PSObject |
Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. |
|
PoolState |
Optional |
Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PoolState |
Current state of the Persistent Chat pool. Valid values are: * Normal * FailedOver The default value is Normal. |
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Input Types
The Set-CsPersistentChatState cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatstate object.
Return Types
None. Instead, the Set-CsPersistentChatState cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatState object.
