Export (0) Print
Expand All
Expand Minimize

Get-CsPersistentChatConfiguration

Lync Server 2013
 

Topic Last Modified: 2013-03-07

Returns information about the Persistent Chat configuration settings currently in use in your organization. Persistent Chat configuration settings are used to manage the Persistent Chat service. For example, these settings allow you to specify the maximum number of users who can participate in a chat room. This cmdlet was introduced in Lync Server 2013.

Get-CsPersistentChatConfiguration [-Identity <XdsIdentity>] <COMMON PARAMETERS>
Get-CsPersistentChatConfiguration [-Filter <String>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-LocalStore <SwitchParameter>]

The command shown in Example 1 returns information for all the Persistent Chat configuration settings in use in the organization.

Get-CsPersistentChatConfiguration

In Example 2, information is returned for a specified set of Persistent Chat configuration settings: the settings applied to the Redmond site.

Get-CsPersistentChatConfiguration -Identity "site:Redmond"

Example 3 returns information for all the Persistent Chat configuration settings applied to the site scope. This is done by including the Filter parameter and the filter value "service:*".

Get-CsPersistentChatConfiguration -Filter "service:*"

In Example 4, information is returned for all the Persistent Chat configuration settings where the default chat history is set to a value greater than 30. To carry out this task the command first uses the Get-CsPersistentChatConfiguration cmdlet to return a collection of all the Persistent Chat configuration settings. This collection is then piped to the Where-Object cmdlet, which picks out only those settings where the DefaultChatHistory property is greater than (-gt) 30.

Get-CsPersistentChatConfiguration | Where-Object {$_.DefaultChatHistory -gt 30}

Example 5 shows how you can return information for all the Persistent Chat configuration settings where the room management URL has not been defined. To do this, the command first uses the Get-CsPersistentChatConfiguration cmdlet to return a collection of all the Persistent Chat configuration settings. In turn, this collection is piped to the Where-Object cmdlet, which selects any settings where the RoomManagementUrl property is equal to a null value ($Null).

Get-CsPersistentChatConfiguration | Where-Object {$_.RoomManagementUrl -eq $Null}

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.

The Persistent Chat service is managed, in part, by Persistent Chat configuration settings, which dictate such things as the number of previously-posted chat messages immediately available when you log on to a chat room (the chat history) or the maximum size of a file that can be uploaded to (or downloaded from) the service. These settings can be configured at the global or the site scope, or at the service scope (that is, you can have a custom collection of settings assigned to an individual Persistent Chat pool).

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

Lync Server Control Panel: To view Persistent Chat configuration information in the Lync Server Control Panel, click Persistent Chat and then click Persistent Chat Configuration.

 

Parameter Required Type Description

Filter

Optional

System.String

Enables you to use wildcards when specifying the collection (or collections) of Persistent Chat configuration settings to be returned. For example, this syntax returns all the settings configured at the service scope:

-Filter "service:*"

The Filter and Identity parameters cannot be used in the same command.

Identity

Optional

Microsoft.Rtc.Management.Xds.XdsIdentity

Unique identifier for the Persistent Chat configuration settings to be returned. To return the global collection, use this syntax:

-Identity "global"

To return a collection of settings configured at the site scope, use syntax similar to this:

-Identity "site:Redmond"

To return a collection configured at the service scope, use syntax like this:

-Identity "service:PersistentChatServer:atl-gc-001.litwareinc.com"

Note that you cannot use wildcards with the Identity parameter.

If neither the Identity parameter nor the Filter parameter are included in a command then the Get-CsPersistentChatConfiguration cmdlet will return information about all the Persistent Chat configuration settings in use in your organization.

LocalStore

Optional

System.Management.Automation.SwitchParameter

Retrieves the Persistent Chat configuration data from the local replica of the Central Management store rather than from the Central Management store itself.

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

The Get-CsPersistentChatConfiguration cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatConfiguration object.

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