See Also
Topic Last Modified: 2014-02-21
Modifies an existing Persistent Chat policy. Persistent Chat policies determine whether or not users are allowed access to Persistent Chat chat rooms. This cmdlet was introduced in Lync Server 2013.
Syntax
Set-CsPersistentChatPolicy [-Identity
<XdsIdentity>] <COMMON PARAMETERS>
|
Set-CsPersistentChatPolicy [-Instance <PSObject>]
<COMMON PARAMETERS>
|
COMMON PARAMETERS: [-Confirm [<SwitchParameter>]]
[-Description <String>] [-EnablePersistentChat <$true |
$false>] [-Force <SwitchParameter>] [-Tenant <Guid>]
[-WhatIf [<SwitchParameter>]]
|
Examples
Example 1
In Example 1, Persistent Chat is enabled for the global Persistent Chat policy.
 Copy Code |
|
|---|---|
Set-CsPersistentChatPolicy -Identity "global" -EnablePersistentChat $True |
|
Example 2
In Example 2, Persistent Chat is enabled for all the Persistent Chat policies in the organization. To do this, the command first uses the Get-CsPersistentChatPolicy cmdlet without any parameters in order to return a collection of all the Persistent Chat policies. This collection is then piped to the Set-CsPersistentChatPolicy cmdlet, which sets the EnablePersistentChat parameter for each policy in the collection to True ($True).
| Copy Code |
|
|---|---|
Get-CsPersistentChatPolicy | Set-CsPersistentChatPolicy -EnablePersistentChat $True |
|
Detailed Description
The Persistent Chat service (which replaces the Group Chat service used in Microsoft Lync Server 2010) provides organizations with messaging and collaboration capabilities similar to those found in Internet discussion forums: users can exchange messages in real-time, yet can also revisit and restart those conversations at any time. Conversations can be based around specific topics, and these conversations can be made available to everyone or to only a selected set of users. Likewise, individual chat rooms can be configured so that anyone can post a message or configured so that only designated presenters can post messages.
By default, users are not granted access to the Persistent Chat service; that access can only be granted if the user is managed by a Persistent Chat policy that allows for the user of the service. When you install Lync 2013, all your users are managed by a global Persistent Chat policy in which the use of Persistent Chat is disabled. If you want to give all your users access to the service you can simply set the EnablePersistentChat property in this global policy to True. Alternatively, you can create additional policies at the site or at the per-user scope, and thus provide Persistent Chat access to some users while denying this access to other users.
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-CsPersistentChatPolicy"}
Lync Server Control Panel: To modify an existing Persistent Chat policy using the Lync Server Control Panel, click Persistent Chat, click Persistent Chat Policy, then double-click the policy to be modified.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
Prompts you for confirmation before executing the command. |
|
Description |
Optional |
System.String |
Enables administrators to provide explanatory text to accompany the policy. For example, the Description might include information about the users the policy should be assigned to. |
|
EnablePersistentChat |
Optional |
System.Boolean |
When set to True users affected by the policy will be allowed to use Persistent Chat. When set to False (the default value) users affected by the policy will not be allowed to use Persistent Chat. |
|
Force |
Optional |
System.Management.Automation.SwitchParameter |
Suppresses the display of any non-fatal error message that might occur when running the command. |
|
Identity |
Optional |
Microsoft.Rtc.Management.Xds.XdsIdentity |
Unique identity of the Persistent Chat policy to be modified. To modify the global policy, use this syntax: -Identity global To modify a site-scoped policy, use this syntax: -Identity site:Redmond To modify a per-user policy, use syntax similar to this: -Identity RedmondPolicy If you do not include the Identity parameter the Set-CsPersistentChatPolicy cmdlet will automatically modify the global policy. |
|
Instance |
Optional |
System.Management.Automation.PSObject |
Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. |
|
Tenant |
Optional |
System.Guid |
Globally unique identifier (GUID) of the Office 365 tenant account that owns the Persistent Chat policy being modified. For example: –Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" You can return the tenant ID for each of your tenants by running this command: Get-CsTenant | Select-Object DisplayName, TenantID If you are using a remote session of Windows PowerShell and are connected only to Lync Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. |
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Input Types
The Set-CsPersistentChatPolicy cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Policy.PersistentChat.PersistentChatPolicy object.
Return Types
None. Instead, the Set-CsPersistentChatPolicy cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Policy.PersistentChat.PersistentChatPolicy object.
