Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Remove-CsPersistentChatRoom

Lync Server 2013
 

Topic Last Modified: 2013-03-07

Removes one or more Persistent Chat chat rooms. A chat room is a discussion forum that typically revolves around a specific topic. This cmdlet was introduced in Lync Server 2013.

Remove-CsPersistentChatRoom -Identity <String> <COMMON PARAMETERS>
Remove-CsPersistentChatRoom -Instance <ChatRoom> <COMMON PARAMETERS>
COMMON PARAMETERS: [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

The command shown in Example 1 removes the Persistent Chat chat room RedmondChatRoom.

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

In Example 2, all the Persistent Chat chat rooms in use in the organization are removed. To do this, the command first calls the Get-CsPersistentChatRoom cmdlet without any parameters in order to return a collection of all the available chat rooms. This collection is then piped to the Remove-CsPersistentChatRoom cmdlet, which deletes each room in the collection.

Get-CsPersistentChatRoom  | Remove-CsPersistentChatRoom

Example 3 removes all the "closed" chat rooms. (A closed chat room means that any user can locate the chat room by doing a directory search, but only members can participate in chat room activities.) To accomplish this task, the command first uses the Get-CsPersistentChatRoom cmdlet and the Privacy parameter to return a collection of all the closed chat rooms. This collection is then piped to the Remove-CsPersistentChatConfiguration cmdlet, which deletes each room in the collection.

Get-CsPersistentChatRoom -Privacy "Closed"  | Remove-CsPersistentChatRoom

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 discussions take the form of messages posted in individual chat rooms; chat rooms are discussion forums based on specific topics. By design, messages posted in a chat room remain there forever; at any time, users can return to the room and review all the messages that have been previously posted.

The Remove-CsPersistentChatRoom cmdlet provides a way for administrators to remove one or more of the Persistent Chat chat rooms that have been configured for use in the organization.

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 "Remove-CsPersistentChatRoom"}

Lync Server Control Panel: To delete an existing Persistent Chat chat room using the Lync Server Control Panel, click Persistent Chat, click Room, and then select the room to be deleted. To delete the room, click Edit, and then click Delete.

 

Parameter Required Type Description

Identity

Required

System.String

Unique Identifier for the Persistent Chat chat room being removed. 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"

Instance

Required

Microsoft.Rtc.Management.Chat.Cmdlets.ChatRoom

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

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 occur when running the command.

WhatIf

Optional

System.Management.Automation.SwitchParameter

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

The Remove-CsPersistentChatRooms cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.ChatRoomObject object.

None. Instead, the Remove-CsPersistentChatRoom cmdlet deletes existing instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.ChatRoomObject object.

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.