Get-CsUserClusterInfo -Identity <UserIdParameter> [-Force <SwitchParameter>] [-Tenant <Nullable>]

Parameters

When a user is enabled for Microsoft Communications 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:

Get-CsUser "Ken Myer" | Select-Object RegistrarPool

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 in the primary Registrar pool is unavailable); the names of the individual computers that make up these pool; and the User Services pool the user has been assigned to. That type of detailed information can be returned by running the Get-CsUserClusterInfo cmdlet.

Note. Don’t be confused by the cmdlet name: Get-CsUserClusterInfo does return Registrar- and User Services-related information. "Cluster" is nothing more than a term that was once used to refer to Communications Server pools.

Get-CsUserClusterInfo returns instances of the Microsoft.Rtc.Management.Xds.GetOcsUserClusterInfoCmdlet+UserInformation object.

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

	Copy Code
Get-CsUserClusterInfo "sip:kenmyer@litwareinc.com"

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

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

	Copy Code
Get-CsUser | Get-CsUserClusterInfo

In Example 2, user pool information is returned for all the users who have been enabled for Communications 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 Communications Server-enabled users. This collection is then piped the Get-CsUserClusterInfo, which proceeds to display pool information for each user in the collection.

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

	Copy Code
Get-CsUser | Where-Object {"$_.RegistrarPool -ne $Null} | Get-CsUserClusterInfo

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 Communications Server. However, it is possible to have users who have been enabled for Communications 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. In this case, Get-CsUser is again used to return a collection of all the Communications 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 (-ne) a null value. (In other words, users who have been assigned a registrar pool.) That filtered collection is then piped the Get-CsUserClusterInfo, which displays pool information for each user in the filtered collection.

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

	Copy Code
Get-CsUser | Get-CsUserClusterInfo | Where-Object {"$_.PrimaryClusterFqdn -eq "redmond-cs-001.litwareinc.com"}

In the preceding command, pool information is displayed for all the users homed on the 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 Microsoft Communications Server. That collection is piped to Get-CsUserClusterInfo, 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 PrimaryClusterFqdn property is equal to (-eq) redmond-cs-001.litwareinc.com.

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

	Copy Code
Get-CsUser | Get-CsUserClusterInfo | Where-Object {"$_.BackupClusterFqdn -eq $Null}

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 Communications Server. That information is then piped to Get-CsUserClusterInfo, 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 BackupClusterFqdn property is equal to (-eq) a null value ($Null).

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

	Copy Code
Get-CsUserClusterInfo "Ken Myer" | Select-Object -Expand PrimaryClusterMachinesInPreferredOrder

In Example 6, the information is reported about the individual computers that make up Ken Myer’s Registrar pool. To retrieve this information, Get-CsUserClusterInfo 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 then uses the –Expand parameter to "expand" information stored in the PrimaryClusterMachinesInPreferredOrder property. Expanding a property simply means that all the values stored in that property are displayed onscreen in easy-to-read fashion.