Export (0) Print
Expand All
Expand Minimize

Set-CsPersistentChatCategory

Lync Server 2013
 

Topic Last Modified: 2013-03-07

Modifies an existing Persistent Chat category. A Persistent Chat category represents a collection of Persistent Chat chat rooms. Each chat room must be associated with a category. This cmdlet was introduced in Lync Server 2013.

Set-CsPersistentChatCategory -Instance <Category> <COMMON PARAMETERS>
Set-CsPersistentChatCategory -Identity <String> <COMMON PARAMETERS>
COMMON PARAMETERS: [-AllowedMembers <PSListModifier>] [-AsObject <SwitchParameter>] [-ChatHistory <$true | $false>] [-Confirm [<SwitchParameter>]] [-Creators <PSListModifier>] [-DeniedMembers <PSListModifier>] [-Description <String>] [-FileUpload <$true | $false>] [-Invitations <$true | $false>] [-Name <String>] [-WhatIf [<SwitchParameter>]]

In Example 1, file uploads are disabled for the Persistent Chat category atl-cs-001.litwareinc.com\helpdesk.

Set-CsPersistentChatCategory -Identity "atl-cs-001.litwareinc.com\helpdesk" -FileUpload $False

Example 2 disables file uploads for all the Persistent Chat categories currently in use in the organization. To carry out this task, the command first calls the Get-CsPersistentChatCategory cmdlet without any parameters in order to return a collection of all the Persistent Chat categories. The categories in this collection are then piped to the Set-CsPersistentChatCategory cmdlet to disable file uploads for each category.

Get-CsPersistentChatCategory | Set-CsPersistentChatCategory-FileUpload $False

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.

Persistent Chat categories provide a way for administrators to organize, and manage, Persistent Chat chat rooms. Categories provide a way for administrators to group related chat rooms; for example, all chat rooms used by the finance department can be grouped in the same category. Likewise, categories provide a way for administrators to manage permissions to these rooms, dictating which users are allowed access to the rooms, which users are denied access to the rooms, and which users are allowed to create new chat rooms within the category.

Note that all chat rooms must belong to a category; you cannot create a chat room without assigning that room to a category. That means that you must create at least one category before you can add any chat rooms to your Persistent Chat implementation.

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-CsPersistentChatCategory"}

Lync Server Control Panel: To modify an existing Persistent Chat category using the Lync Server Control Panel, click Persistent Chat, click Category, then double-click the category to be modified.

 

Parameter Required Type Description

Identity

Required

System.String

Unique identifier for the chat room category. The Identity consists of the Persistent Chat pool were the category is located followed by the category Name; for example:

-Identity "atl-gc-001.litwareinc.com\ITChat"

Instance

Required

Microsoft.Rtc.Management.Chat.Cmdlets.Category

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

AllowedMembers

Optional

System.Management.Automation.PSListModifier

Lists the users who are allowed to access chat rooms within the category. To add a new user to the Members list, use syntax similar to this:

-Members @{Add="sip:kenmyer@litwareinc.com"}

Multiple users can be added by separating the user SIP addresses with commas:

-Members @{Add="sip:kenmyer@litwareinc.com", "sip:pilar@litwareinc.com"}

To remove a user from the Members list use the Remove method:

-Members @{Remove="sip:kenmyer@litwareinc.com"}

To remove all the users from the Members list, set the value of the Members property to null:

-AllowedMembers $Null

In addition to working with individual users you can also work with entire OUs. For example, this command enables all the users in the IT OU to access chat rooms:

-Members @{Add="OU=IT,DC=litwareinc,DC=com"}

To add all the users in a distribution list, use the Active Directory distinguished name of that distribution list:

-Members @{Add="CN=ChatSupportGroup,OU=IT,DC=litwareinc,DC=com"}

AsObject

Optional

System.Management.Automation.SwitchParameter

When specified, Active Directory display names are used when adding users to or removing users from the AllowedMembers, DeniedMembers, and Creators lists. When not specified, SIP addresses are used when managing these lists.

ChatHistory

Optional

System.Boolean

When set the False ($False), the chat history feature will be disabled for the new category. Typically, chat history is only disabled for chat rooms that are used for announcements that are posted once and then never need to be referred to again.

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command.

Creators

Optional

System.Management.Automation.PSListModifier

Lists the users who are allowed to create chat rooms within the category. To add a new user to the Creators list, use syntax similar to this:

-Creators @{Add="sip:kenmyer@litwareinc.com"}

Multiple users can be added by separating the user SIP addresses with commas:

-Creators @{Add="sip:kenmyer@litwareinc.com", "sip:pilar@litwareinc.com"}

To remove a user from the Creators list use the Remove method:

-Creators @{Remove="sip:kenmyer@litwareinc.com"}

To remove all the users from the Creators list, set the value of the Creators property to null:

-Creators $Null

In addition to working with individual users you can also work with entire OUs. For example, this command enables all the users in the IT OU to create chat rooms:

-Creators @{Add="OU=IT,DC=litwareinc,DC=com"}

To add all the users in a distribution list, use the Active Directory distinguished name of that distribution list:

-Creators @{Add="CN=ChatSupportGroup.OU=IT,DC=litwareinc,DC=com"}

DeniedMembers

Optional

System.Management.Automation.PSListModifier

Lists the users who are not allowed to access chat rooms within the category. To add a new user to the DeniedMembers list, use syntax similar to this:

-DeniedMembers @{Add="sip:kenmyer@litwareinc.com"}

Multiple users can be added by separating the user SIP addresses with commas:

-DeniedMembers @{Add="sip:kenmyer@litwareinc.com", "sip:pilar@litwareinc.com"}

To remove a user from the DeniedMembers list use the Remove method:

-DeniedMembers @{Remove="sip:kenmyer@litwareinc.com"}

To remove all the users from the DeniedMembers list, set the value of the DeniedMembers property to null:

-DeniedMembers $Null

In addition to working with individual users you can also work with entire OUs. For example, this command denies chat room access to all the users in the IT OUs:

-DeniedMembers @{Add="OU=IT,DC=litwareinc,DC=com"}

To deny access to all the users in a distribution list, use the Active Directory distinguished name of that distribution list:

-DeniedMembers @{Add="CN=ChatSupportGroup.OU=IT,DC=litwareinc,DC=com"}

Description

Optional

System.String

Additional text accompanying the Persistent Chat category. For example, the Description might explain the purpose of the category and what type of rooms you can expect to find within the category.

FileUpload

Optional

System.Boolean

When set to True ($True), allows file uploads to the chat rooms in the category.

Invitations

Optional

System.Boolean

When set to False ($False), Invitations will be enabled for the category. Among other things, this means that users on the AllowedMembers list will automatically receive an invitation to join a new chat room at the time that new room is created.

Name

Optional

System.String

Name given to the Persistent Chat category. Names must be unique per Persistent Chat pool.

WhatIf

Optional

System.Management.Automation.SwitchParameter

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

The Set-CsPersistentChatCategory cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.CategoryObject object.

None. Instead, the Set-CsPersistentChatCategory cmdlet modifies existing instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.CategoryObject object.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft