Topic Last Modified: 2013-02-22

Enables you to configure a new Persistent Chat add-in. A Persistent Chat add-in is a customized web page that can be embedded within a Persistent Chat client. This cmdlet was introduced in Lync Server 2013.


New-CsPersistentChatAddin -Name <String> -Url <String> [-PersistentChatPoolFqdn <String>]


Example 1

The command shown in Example 1 creates a new Persistent Chat add-in (with the name ITPersistentChatAddin) for the pool The URL parameter and the parameter value specify the location of the add-in's webpage.

Copy Code
New-CsPersistentChatAddin -Name "ITPersistentChatAddin" -PersistentChatPoolFqdn "" -Url ""

Detailed 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.

Add-ins serve as extensions to a Persistent Chat chat room. Add-ins are external applications (that is, items not built into Persistent Chat itself) that are associated with a particular chat room. For example, a help desk chat room might include a URL that links to a Web page or to a Silverlight application that shows the status of the day's help requests. Lync Server Management Shell does not provide the ability to create these add-ins. Instead, the CsPersistentChatAddin cmdlets are used to associate (or disassociate) an add-in from a chat room.

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 prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "New-CsPersistentChatAddin"}

Lync Server Control Panel: To create a new Persistent Chat add-in using the Lync Server Control Panel, click Persistent Chat, click Add-in, and then click New.


Parameter Required Type Description




Friendly name to be given to the Persistent Chat add-in. Names must be unique per Persistent Chat Server pool.




URL of the webpage to be displayed by the Persistent Chat add-in.




Fully qualified domain name of the Persistent Chat Server pool.

Input Types

None. The New-CsPersistentChatAddin cmdlet does not accept pipelined input.

Return Types

The New-CsPersistentChatAddin cmdlet creates new instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.AddinObject object.

See Also