Set-CsPersistentChatRoom

Name of the Persistent Chat add-in, if any, associated with the chat room. A Persistent Chat add-in is a customized web page that can be embedded within a Persistent Chat client. Add-ins can be created by using the New-CsPersistentChatAddin cmdlet.

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

Category under which the room is located; for example:

-Category "IT"

Note that the specified category must already exist or the command will fail. Categories, which are a collection of chat rooms, can be created by using the New-CsPersistentChatCategory cmdlet.

Prompts you for confirmation before executing the command.

Enables administrators to provide additional information about the new chat room.

When set to True ($True), the new chat room will be disabled and unavailable for use when it is first created. If this parameter is not used then the new chat room will be enabled and available for immediate use.

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

Unique Identifier for the Persistent Chat chat room being modified. The Identity for a chat room consists of the Persistent Chat pool where the room has been configured plus the name of the room; for example:

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

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

Specifies whether or not invitations for the chat room will be inherited from the category. Among other things, this means that users on the Members list will automatically receive an invitation to join a new chat room at the time that new room is created. If set to False, invitations will not be used for the room. If set to Inherit, the room will use the Invitations setting specified for its Category.

List of users allowed to define the membership of the chat room as well as configure other settings for the room.

To add a new user to the Managers list, use syntax similar to this:

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

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

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

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

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

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

-Managers $Null

In addition to working with individual users you can also work with entire OUs. For example, this command adds all the users in the IT OU to the managers list:

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

To make all the users in a distribution list chat room managers, use the Active Directory distinguished name of that distribution list:

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

List of users who are allowed to access the chat room. If the Members property is null then the chat room inherits the membership list from its Persistent Chat 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:

-Members $Null

In addition to working with individual users you can also work with entire OUs. For example, this command adds all the users in the IT OU to the Members list:

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

To make all the users in a distribution list chat room members, use the Active Directory distinguished name of that distribution list:

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

Name of the Persistent Chat chat room. Names must be unique per Persistent Chat pool.

List of users who are allowed to post messages in an auditorium chat room.

To add a new user to the Presenters list, use syntax similar to this:

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

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

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

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

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

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

-Presenters $Null

In addition to working with individual users you can also work with entire OUs. For example, this command adds all the users in the IT OU to the Presenters list:

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

To make all the users in a distribution list chat room presenters, use the Active Directory distinguished name of that distribution list:

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

Privacy settings for the chat room. Allowed values are:

• Open (any user can locate the chat room by doing a directory search, and anyone can participate in chat room activities)
• Secret (only chat room members can locate the room by doing a directory search, and only members can participate in chat room activities)
• Closed (any user can locate the chat room by doing a directory search, but only members can participate in chat room activities)

Specifies whether the chat room is configured as a Normal chat room (where all members can post messages) or an Auditorium (where only presenters can post messages). For example:

-Type "Auditorium"

The default value is Normal.

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