How to Use mastercontroller Command Options (Cheat Sheet)

Mastercontroller

The mastercontroller is the primary tool for managing the entire load test. It calculates load distribution, begins and ends the test, and also deploys the test suite to all agentcontroller instances. At the end, the mastercontroller saves test results on the file system. It can be run using interactive mode, auto mode, or non-interactive mode (scripted commands).

Usage

• mastercontroller [<other options>] runs in interactive mode. Any command can be chosen to be executed next.
• mastercontroller --help displays all available options and a brief guide on their usage.
• mastercontroller -auto [<other options>] runs a load test in auto mode by automatically executing all commands.

Example

This will run a load test in auto mode, in combination with embedded mode:

Windows

cd <XLT>\bin
./mastercontroller.cmd -auto -embedded -comment "Test Run" 

Linux

cd <XLT>/bin
./mastercontroller.sh -auto -embedded -comment "Test Run" 

List of Command Options

• -auto is used for running a load test in auto mode. This option automatically executes several steps, including uploading the test suite, starting the test, and downloading test results. It can also be used with the -report option to automatically create a report upon test completion.

• -c <commandList> or --commands <commandList> executes commands in a comma-separated list in the specified order and then quits. Supported commands include abort, upload, report, start, and download.

• -comment <string> sets a comment for your test run.

• -D <property=value> is used for overriding or configuring a property in the mastercontroller.properties file.

• -embedded utilizes a single embedded agent controller, running the test in embedded mode.

• -faf Usage is deprecated. It is recommended to use -auto instead.

• -noDownload is for use with auto mode only. Test results are not downloaded. This option is ignored in sequential/non-interactive mode.

• -o <dir> stores downloaded test results in the specified directory.

• --only-download <dataTypeList> restricts download to only the given result data types in a comma-separated list. Applicable only for downloads in non-interactive mode.

• -pf <file> can be used to utilize a separate properties file, which overrides values in the mastercontroller.properties file.

• -report generates a report after downloading test results. It is not effective in commands mode. It can be used with auto mode using the -auto option to automatically generate a report once tests are downloaded.

• sequential is used for running test cases sequentially (one after another).

• testPropertiesFile <filename> can be used for specifying the properties file for the test run.

• timezone <timezoneID> overrides the user’s default timezone while generating a test report.