Export (0) Print
Expand All
Expand Minimize

Get-CsPersistentChatRoom

Lync Server 2013
 

Topic Last Modified: 2014-02-05

Returns information about the Persistent Chat chat rooms configured for use in your organization. A chat room is a discussion forum that typically revolves around a specific topic. This cmdlet was introduced in Lync Server 2013.

Get-CsPersistentChatRoom [-Addin <String>] [-Category <String>] [-ChatContentExceedsMB <Int32>] [-Disabled <$true | $false>] [-Filter <String>] [-Invitations <False | Inherit>] [-Manager <String>] [-Member <String>] [-PersistentChatPoolFqdn <String>] [-Privacy <Open | Closed | Secret>] [-ResultSize <Int32>] [-SearchDescription <SwitchParameter>] [-Type <Normal | Auditorium>] <COMMON PARAMETERS>
Get-CsPersistentChatRoom [-Identity <String>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-AsObject <SwitchParameter>]

The command shown in Example 1 returns information about the Persistent Chat chat rooms configured for use in the organization.

Get-CsPersistentChatRoom

Example 2 returns information for a single Persistent Chat chat room: the room with the Identity atl-cs-001.litwareinc.com\ITChatRoom.

Get-CsPersistentChatRoom -Identity "atl-cs-001.litwareinc.com\ITChatRoom"

In Example 3, information is returned for all the Persistent Chat chat rooms configured for the pool atl-cs-001.litwareinc.com.

Get-CsPersistentChatRoom -PersistentChatPoolFqdn "atl-cs-001.litwareinc.com"

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 Get-CsPersistentChatRoom cmdlet provides a way to return information about all the chat rooms configured for use in your 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 "Get-CsPersistentChatRoom"}

 

Parameter Required Type Description

Addin

Optional

System.String

Returns chat rooms associated with the specified chat room add-in.

Note that you can only specify one add-in per command.

AsObject

Optional

System.Management.Automation.SwitchParameter

When specified, Active Directory display names are used when showing users who are on the Managers or Presenters lists. When not specified, SIP addresses are used when showing these users.

Category

Optional

System.String

Returns information for all the Persistent Chat chat rooms in the specified category. For example:

-Category "ITChat"

You can only specify a single category when using the Category parameter. In addition, you cannot use the PersistentChatPoolFqdn, Filter, or Identity parameters in any command that uses the Category parameter.

ChatContentExceedsMB

Optional

System.Int32

Returns chat rooms whose cumulative chat content exceeds the specified value (in megabytes).

Disabled

Optional

System.Boolean

Enables you to search for active chat rooms (by using the parameter value $False) or disabled chat rooms (by using the parameter value $True).

Filter

Optional

System.String

Enables you to return information for Persistent Chat chat rooms based on the Name and/or the Description of the room. To return information for a chat room with a specific name, use syntax similar to this:

-Filter {Name –like "ITChat"}

That syntax returns information only for chat rooms that have the name ITChat.

Identity

Optional

System.String

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

You cannot use the Category, Filter, or PersistentChatPoolFqdn parameters in any command that uses the Identity parameter. If you call the Get-CsPersistentChatRoom cmdlet without any parameters the cmdlet will return information about all the chat rooms configured for use in your organization.

Invitations

Optional

Microsoft.Rtc.Management.Chat.Cmdlets.ChatRoomInvitations

Returns chat rooms that use invitations (by using the parameter value Inherit) or chat rooms that do not use inivtations (by using the parameter value False).

Manager

Optional

System.String

Returns chat rooms managed by the specified user. For example:

-Manager "sip:kenmyer@litwareinc.com"

Note that you can only specify a single manager per command.

Member

Optional

System.String

Returns chat rooms that the specified user is a member of. For example:

-Member "sip:kenmyer@litwareinc.com"

Note that you can only specify a single member per command.

PersistentChatPoolFqdn

Optional

System.String

Returns information about all the Persistent Chat chat rooms configured on the specified Persistent Chat pool. For example:

-PersistentChatPoolFqdn "atl-gc-001.litwareinc.com"

You cannot use the Category, Filter, or Identity parameters in any command that uses the PersistentChatPoolFqdn parameter.

Privacy

Optional

Microsoft.Rtc.Management.Chat.Cmdlets.ChatRoomPrivacy

Enables you to return chat rooms that meet the specified privacy setting. 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)

ResultSize

Optional

System.Int32

Enables you to limit the number of records returned by the cmdlet. For example, to return seven chat rooms (regardless of the number of rooms in your forest) include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which seven rooms will be returned.

The result size can be set to any whole number between 0 and 2147483647, inclusive. If set to 0 the command will run, but no data will be returned. If you set the ResultSize to 7 but you have only three rooms in your forest, the command will return those three rooms, and then complete without error.

SearchDescription

Optional

System.Management.Automation.SwitchParameter

Enables you to search for the specified text value in either the chat room Name or the chat room Description. To search both the Name and the Description, include the SearchDescription parameter along with the Filter parameter. For example:

-SearchDescription –Filter "IT chat room"

Type

Optional

Microsoft.Rtc.Management.Chat.Cmdlets.ChatRoomType

Returns chat rooms by room type. Allowed values are:

* Normal (chat rooms where all members can post messages)

* Auditorium (chat rooms where only presenters can post messages)

None. The Get-CsPersistentChatRoom cmdlet does not accept pipelined input.

The Get-CsPersistentChatRoom cmdlet returns instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.ChatRoomObject object.

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