Parameters

When a user is enabled for Microsoft Lync Server 2010, he or she must be homed on a Registrar pool. This pool is responsible for authenticating the user and for keeping track of his or her current status and location. If you need to know the Registrar pool that a user has been assigned to you can retrieve that information by using a command similar to this:

In many cases, simply knowing a user’s Registrar pool might be all the information you need. In other cases, however, you might also want to know such things as the backup Registrar pool the user has been assigned to (that is, the pool to be used if the primary Registrar pool is unavailable); the names of the individual computers that make up these pools; and the User Services pool the user has been assigned to. That type of detailed information can be returned by running the Get-CsUserPoolInfo cmdlet.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsUserPoolInfo cmdlet locally: RTCUniversalReadOnlyAdmins. 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 "Get-CsUserPoolInfo"}

String or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. Set-CsUser accepts a pipelined string value representing the SamAccountName of a user account that has been enabled for Lync Server 2010. The cmdlet also accepts pipelined instances of the Active Directory user object.

Get-CsUserPoolInfo returns instances of the Microsoft.Rtc.Management.Xds.GetOCsUserPoolInfoCmdlet+UserInformation object.

-------------------------- Example 1 ------------------------

The preceding command returns user pool information for a single user: the user with the SIP address sip:kenmyer@litwareinc.com.

-------------------------- Example 2 ------------------------

In Example 2, user pool information is returned for all the users who have been enabled for Lync Server 2010. To carry out this task, the command first calls Get-CsUser without any parameters in order to return a collection of all the Lync Server-enabled users. This collection is then piped the Get-CsUserPoolInfo, which displays pool information for each user in the collection.

-------------------------- Example 3 ------------------------

The command shown in Example 3 is a variation of the command used in Example 2. In Example 2, pool information is returned for all the users who have been enabled for Lync Server. However, it is possible to have users who have been enabled for Lync Server but have not been assigned a Registrar pool. The command shown in Example 2 displays an error message for each user who meets those criteria; those error messages are suppressed in Example 3.

To suppress the error message, Example 3 again uses Get-CsUser to return a collection of all the Lync Server-enabled users. This time, however, the collection is piped to the Where-Object cmdlet, which picks out only users where the RegistrarPool property is not equal to a null value. (In other words, users who have been assigned a Registrar pool.) That filtered collection is then piped to Get-CsUserPoolInfo, which displays pool information for each user in the filtered collection.

-------------------------- Example 4 ------------------------

In the preceding command, pool information is displayed for all the users who have been assigned the primary pool redmond-cs-001.litwareinc.com. To do this, Get-CsUser is called in order to return a collection of all the users who have been enabled for Lync Server. That collection is piped to Get-CsUserPoolInfo, which retrieves pool information for each user in the collection. In turn, that pool information is piped to the Where-Object cmdlet, which selects only those users where the PrimaryPoolFqdn property is equal to redmond-cs-001.litwareinc.com.

-------------------------- Example 5 ------------------------

The command shown in Example 5 returns pool information for all the users who have not been assigned a backup Registrar pool. To carry out this task, the command first calls Get-CsUser to return a collection of all the users who have been enabled for Lync Server. That information is then piped to Get-CsUserPoolInfo, which retrieves pool information for each user in the collection. Finally, that pool information is piped to Where-Object, which displays data only for those users where the BackupPoolFqdn property is equal to a null value.

-------------------------- Example 6 ------------------------

In Example 6, information is reported about the individual computers that make up Ken Myer’s Registrar pool. To retrieve this information, Get-CsUserPoolInfo is first called in order to return the relevant data for Ken Myer’s user account. This data is then piped to the Select-Object cmdlet. Select-Object uses the Expand parameter to "expand" information stored in the PrimaryPoolMachinesInPreferredOrder property. Expanding a property means that all of the values stored in that property are displayed onscreen in easy-to-read format.