Run LyncPerfTool


Topic Last Modified: 2013-02-24

Before running the Lync Server 2013 Stress and Performance Tool (LyncPerfTool.exe), you must create users, contacts, and scenarios. For details about using the tools to perform these actions, see Create Users and Contacts and Configure User Profile. Running these tools will also generate a file that will run LyncPerfTool.exe as part of a batch file with the required parameters included.

Running the Lync Server 2013 Stress and Performance Tool

The UserProfileGenerator.exe tool creates a batch file that enables you to run LyncPerfTool.exe by registering the LyncPerfTool performance counters and loading the XML configuration file. The batch file runs one instance of LyncPerfTool.exe per configuration file. To run the batch file, do the following:

  1. Copy the folder that contains the configuration folders and files to the directory that contains LyncStressTool.exe on each client computer. (For example, if you generated the configuration files in the folder named 1.28_13.16.16, copy that folder to the folder that contains LyncPerfTool.exe on each client.)

  2. Navigate to the appropriately numbered client folder and run the RunClient batch script. You can simply double-click the batch file in Windows Explorer and it will run all of the configuration files for that client number. You can also run the script from the appropriate client folder by using the following syntax:

        RunClient0.bat "C:\Program Files\Microsoft Lync Server 2013\LyncStressAndPerfTool\LyncStress" 

To run LyncPerfTool.exe directly, open a command prompt, and then type the following command at the command line (when doing this for the first time, be sure to register the performance counters regsvr32 /i /n /s LyncPerfToolPerf.dll, as show in the note later in this topic):LyncPerfTool.exe /file:<configXML>

    LyncPerfTool.exe /file:IM_client0.xml

To have the tool display the values in the configuration file, include the /displayfile parameter on the preceding command, like this:

    LyncPerfTool.exe /file:IM_client0.xml /displayfile

To end the process, press Ctrl+C.


Before running LyncPerfTool directly, you must register the performance counters. Enter the following command to register performance counters:

    regsvr32 /i /n /s LyncPerfToolPerf.dll


Every instance of LyncPerfTool.exe that you start will immediately start signing in users, usually at a rate of one user per second. The peak user sign-in rate for the pool is about 12 per second. This means that you should not start more than 12 LyncPerfTool instances at the same time, while the users are still signing in. 1000 users will take about 20 minutes to fully sign in, at one per second.