Remove-CsPersistentChatRoom
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.
Syntax
Identity
Remove-CsPersistentChatRoom
[-Identity] <String>
[-Confirm]
[-Force]
[-WhatIf]
[<CommonParameters>]
Instance
Remove-CsPersistentChatRoom
[-Instance] <ChatRoom>
[-Confirm]
[-Force]
[-WhatIf]
[<CommonParameters>]
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.
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.
Skype for Business Server Control Panel: To delete an existing Persistent Chat chat room using the Skype for Business 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.
Examples
Example 1
Remove-CsPersistentChatRoom -Identity "atl-gc-001.litwareinc.com\RedmondChatRoom"
The command shown in Example 1 removes the Persistent Chat chat room RedmondChatRoom.
Example 2
Get-CsPersistentChatRoom | Remove-CsPersistentChatRoom
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.
Example 3
Get-CsPersistentChatRoom -Privacy "Closed" | 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.
Parameters
-Confirm
Applicable: Lync Server 2013, Skype for Business Server 2015
Prompts you for confirmation before executing the command.
Parameter properties
Type: | SwitchParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Aliases: | cf |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-Force
Applicable: Lync Server 2013, Skype for Business Server 2015
Suppresses the display of any non-fatal error message that might occur when running the command.
Parameter properties
Type: | SwitchParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-Identity
Applicable: Lync Server 2013, Skype for Business Server 2015
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"
Parameter properties
Type: | String |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
Identity
Position: | 1 |
Mandatory: | True |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-Instance
Applicable: Lync Server 2013, Skype for Business Server 2015
Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.
Parameter properties
Type: | ChatRoom |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
Instance
Position: | 1 |
Mandatory: | True |
Value from pipeline: | True |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-WhatIf
Applicable: Lync Server 2013, Skype for Business Server 2015
Describes what would happen if you executed the command without actually executing the command.
Parameter properties
Type: | SwitchParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Aliases: | wi |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Microsoft.Rtc.Management.PersistentChat.Cmdlets.ChatRoomObject
The Remove-CsPersistentChatRooms
cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.ChatRoomObject object.
Outputs
None
This cmdlet does not return a value or object.