Topic Last Modified: 2010-10-27

Tests the ability of a user to log on to Microsoft Lync Server 2010. Test-CsRegistration is a "synthetic transaction": a simulation of common Lync Server 2010 activities used for health and performance monitoring.


Test-CsRegistration -TargetFqdn <String> [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-RegistrarPort <Nullable>] [-UserSipAddress <String>]
Test-CsRegistration [-TargetFqdn <String>] -UserCredential <PSCredential> -UserSipAddress <String> [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-RegistrarPort <Nullable>]


Parameter Required Type Description




Fully qualified domain name (FQDN) of the pool to be tested.




SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061.



PS credential object

User credential object for the account to be tested. The value passed to UserCredential must be an object reference obtained by using the Get-Credential cmdlet. For example, this code returns a credential object for the user litwareinc\kenmyer and stores that object in a variable named

$x: $x = Get-Credential "litwareinc\kenmyer"

You need to supply the user password when running this command. This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool.



SIP address

SIP address for user account to be tested; for example: -UserSipAddress "". The UserSipAddress parameter must reference the same user account as UserCredential. This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool.



Switch Parameter

Suppresses the display of any non-fatal error message that might occur when running the command.



Switch Parameter

Reports detailed activity to the screen as the cmdlet runs.

Detailed Description

Test-CsRegistration is an example of a Lync Server "synthetic transaction." Synthetic transactions are used in Lync Server to verify that users are able to successfully complete common tasks such as logging on to the system, exchanging instant messages, or making calls to a phone located on the public switched telephone network (PSTN). These tests can be conducted manually by an administrator, or they can be automatically run by an application such as Microsoft System Center Operations Manager (formerly Microsoft Operations Manager).

Synthetic transactions are typically conducted in two different ways. Many administrators will use the CsHealthMonitoringConfiguration cmdlets to set up test users for each of their Registrar pools. These test users are a pair of users who have been preconfigured for use with synthetic transactions. (Typically these are test accounts and not accounts that belong to actual users.) With test users configured for a pool, administrators can simply run a synthetic transaction against that pool without having to specify the identities of (and supply the credentials for) the user accounts involved in the test.

Alternatively, administrators can run a synthetic transaction using actual user accounts. For example, if two users are unable to exchange instant messages, an administrator could run a synthetic transaction using the two user accounts in question (as opposed to a pair of test accounts) and try to diagnose and resolve the problem. If you decide to conduct a synthetic transaction using actual user accounts you will need to supply the logon names and passwords for each user.

The Test-CsRegistration cmdlet enables you to verify that users in your organization can log on to Lync Server. In order to perform this check, Test-CsRegistration requires a single test account. If you have set up test users for the pool where the test is to be conducted, then you do not need to specify an account; instead, Test-CsRegistration will automatically use the first test account that was assigned to the pool. (For details, see the New-CsHealthMonitoringConfiguration Help topic.) Alternatively, you can conduct the test using an account that has not been assigned to the pool. This allows you run tests even if you have not configured test users. It also allows you to test the ability of a specific user to log on to Lync Server. (If you choose to use this approach, you will need to provide the user name and password for the account being tested.)

When you run Test-CsRegistration, the cmdlet attempts to sign the test user on to Lync Server and then, if successful, disconnects that test user from the system. All of this happens without any user interaction, and without affecting any actual users. For example, suppose the test account corresponds to a real user with a real Lync Server account. In that case, the test will be conducted without any disruption to the real Ken Myer. When the Ken Myer test account logs off from the system, Ken Myer the person will remain logged on.

Adding the Verbose parameter enables you to get a detailed account of all the actions taken by Test-CsRegistration in order to complete its test.

Who can run this cmdlet: 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 "Test-CsRegistration"}

Input Types

None. Test-CsRegistration does not accept pipelined input.

Return Types

Test-CsRegistration returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object.


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

Copy Code
Test-CsRegistration -TargetFqdn 

The preceding example tests the Registrar service for the pool This command will work only if test users have been defined for the pool If they have, then the command will determine whether or not the first test user is able to log on to Lync Server.

If test users have not been defined, then the command will fail because it will not know which user to log on as. If you have not defined test users for a pool, then you must include the UserSipAddress parameter and the credentials of the user that the command should use when trying to log on.

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

Copy Code
$cred1 = Get-Credential "litwareinc\pilar"

Test-CsRegistration -TargetFqdn -UserCredential $cred1 -UserSipAddress ""

The commands shown in Example 2 test the ability of a specific user (litwareinc\pilar) to log on to Lync Server. To do this, the first command in the example uses the Get-Credential cmdlet to create a Windows PowerShell credential object containing the name and password of the user Pilar Ackerman. (Because the logon name litwareinc\pilar has been included as a parameter, the Windows PowerShell Credential Request dialog box only requires the administrator to enter the password for the Pilar Ackerman account.) The resulting credential object is then stored in a variable named $cred1.

The second command then checks to see if this user can log on to the pool To carry out this task, Test-CsRegistration is called, along with three parameters: TargetFqdn (the FQDN of the Registrar pool); UserCredential (the Windows PowerShell object containing Pilar Ackerman’s user credentials); and UserSipAddress (the SIP address corresponding to the supplied user credentials).

See Also

Other Resources