Tip: Before executing NeoLoad Controller, you can configure its properties via the environment. The Controller properties can be edited by setting the corresponding environment variable. However, modifying the environment variable overrides the properties set in the controller_user.properties
file and in the controller.properties
file. Below is an example of how to add an environment variable corresponding to a given Controller property key:
Controller property key |
Environment variable |
[Recorder] controller.recorder.pause=1000 |
NL_PROPERTY_RECORDER_CONTROLLER_RECORDERPAUSE=1000 The standard format is: "NL_PROPERTY_CATEGORY_MYPROPERTY=value" |
<install-dir>
\bin\NeoLoadCmd.exe
<install-dir>
/bin/NeoLoadCmd
Argument |
Action |
|
Labels the base test when generating a comparison report. The default value is This argument requires the |
|
Names the This argument requires the |
|
Launches a Virtual User iteration before starting test to update cache information. |
|
Checks out a project. For example |
|
Specifies the SVN third-party collaboration server URL. This argument requires the
For example
This command is necessary when using an SVN third-party server to check out a project. It is not possible to clone a Git repository. In command line, the NeoLoad project has to be cloned with a Git client. |
|
Specifies the collaboration server login information.
For example
This command is necessary when using a third party server to check out a project. |
|
Generates test comparison reports (comma separated list of report files). NeoLoad configures the report format from the file extension ( |
|
Labels the current test when generating a comparison report. The default value is This argument requires the |
|
When this argument is set, the report will be generated based on the last report contents settings defined for this project. Otherwise, the report will be generated with default settings. |
|
Runs the scenario in debug mode. |
|
Describes the test. |
|
In GUI mode, exits NeoLoad when the test is completed. When a shared license is used, it is automatically released. |
|
Sets the exit code to " |
|
Exports in the defined file the raw results of all the Transactions of a test |
|
Displays the list of argument used. |
|
Deactivates the NeoLoad standard license key for this computer. |
|
Starts the test with the specified scenario from the project specified by For more information, see the YAML syntax documentation. Warning: If having the same name, the scenario included in the YAML or JSON file replaces the scenario existing in the NeoLoad project. Also, if the scenario available in the YAML or JSON file does not exist in the NeoLoad project, it is then added in the project.
Warning: When a YAML or JSON file is declared with the -project argument but when no infrastructure is declared via the This argument requires the For more information, see NeoLoad as-code. |
|
Specifies the license to lease.
For example
Specifies the license to lease including Web VUs and SAP VUs.
For example:
|
|
Allows specifying the license server to use (NTS or NeoLoad Web) to lease a license. |
|
Checks the YAML or JSON file describing the infrastructure to use.
|
|
Specifies the maximum number of VUH that can be estimated to launch the test. If the number of VUH estimated is lower or equal to the parameter value, the test can be launched. Otherwise, if the number of VUH estimated is greater than the parameter value, the test will not start. Information: To prevent the usage of VUH, add the argument with value 0, example:
|
|
Enables hosts to monitor during the test (comma-separated list of monitored machine names). Using this argument, only the listed machines are enabled. |
|
Connects to NeoLoad Cloud Platform using the specified login and password. The password hash command line utility must be used to hash the password before using this command. This command is necessary when using NeoLoad Cloud Platform to launch a load test with a Cloud Load Generator or Virtual User session.
The format must be as follows: -NCPLogin "<login>:<hashed password>" or <token> For example: For more information, see How do I use the Password Scrambler tool? |
|
Enables test data transfer to NeoLoad Web.
This argument can only work if the connection with NeoLoad Web has been activated and a token has been declared. These 2 operations can be performed:
|
|
Specifies the URL of the NeoLoad API in order to connect with NeoLoad Web when it is deployed on-premise. This argument requires the |
|
Allows connecting NeoLoad Web by using a proxy. The argument must be used as follows:
This argument requires the This argument can also be used to connect a Controller Agent or Load Generator Agent to NeoLoad Web by using a proxy. For more information, see Platform set-up for Runtime. |
|
Allows authenticating to NeoLoad Web with an access token. This overrides any configuration made in the Preferences screen. |
|
Specifies the Workspace ( |
|
Specifies the NeoLoad Web Test ( |
|
Allows overriding the Zone of the resource (Controller or Load Generator Agent). Example: |
|
Launches NeoLoad in non-GUI mode.
This argument can be used in 2 different ways:
|
|
Connects to Neotys Team Server (NTS) at the specified host name and port. For example This command is necessary when using NTS to lease a license and/or to check out a project. |
|
Connects to Neotys Team Server using the specified login and password. The password hash command line utility must be used to hash the password before using this command.
For example For more information, see How do I use the Password Scrambler tool?
This command is necessary when using NTS to lease a license and/or to check out a project. |
|
Specifies the Neotys Team Server (NTS) configuration parameter path.
This command is necessary when using NTS to lease a license and/or to check out a project. |
Short form: |
In the context of jobs automation and Cloud testing, replaces Load Generators planned in the scenario with other Load Generators. If you want to override LGs for a specified population, use If you want to override LGs for any population, use Load Generators can be replaced for a single or several populations in a same scenario. This argument can be repeated as needed. The TXT file must contain the list of the Load Generators separated by a line drop. Examples of .TXT file content: To override populations x and y: To override all populations: |
|
When working with a shared project (on NTS or SVN), the results are published after the scenario is run. It is not possible to publish a test result for a project shared with Git. |
|
Uses a given project file ( For example: Other example without declaring the “.nlp” file:
For more information, see YAML syntax documentation. |
|
Generates a test report at the end of the test. NeoLoad configures the report format from the file extension ( For example This argument requires the |
|
Maps an "acceptable" SLA alert to "pass" or "fail". Defaults to "pass". For example This argument requires the |
|
Creates a jUnit test results file based on SLA results. The generated XML report is jUnit compatible. For example This argument requires the |
|
Warning: This command is deprecated. The command to use is Creates a jUnit test results file based on SLA results. For example This argument requires the |
|
It is the name of the test results published to Neotys Team Server and found in the NeoLoad GUI. It may include a date/time stamp, such as Can be used together with the
For example: |
|
Overrides constant-type variable defined in project. If no variable is defined, a constant-type variable is created. For example:
This command overrides constant-type variable named "env" defined in project with the
Information: It's possible to override constant-type variables with Environment Variables, for example: |
Discontinued argument |
Valid argument to use |
|
|
|
|
|
|
|
|
Command |
Explanation |
|
|
|
|
|
Lease a license from Neotys Team Server (NTS) and check out a project from NTS.
Note: The |
|
Lease a license from Neotys Team Server (NTS) and check out a project from a third-party SVN server.
|
The system exit codes below reflect the status of the test: