Command-line parameters

You can find the information about parameters that you can use while running tests from the command-line interface (CLI).

HCL DevOps Test Performance (Test Performance) supports the usage of CLI to run tests. Based on the operating system where you installed Test Performance, you can go to the following directory to use CLI:

Operating system The default path to the directory
Windows® C:\Program Files\HCL\DevOpsTest\cmdline
Linux™ /opt/HCL/DevOpsTest/cmdline
Mac /Application/HCL/DevOpsTest/cmdline

After navigating to the directory, you can run the test by using CLI. The CLI supports various parameters. Based on your requirements, you can use those parameters while running tests. You can enter cmdline -help in CLI to view all the supported parameters.

The workspace is locked after you run the tests from CLI. To check the progress of the test or schedule during the run, you can invoke another workspace and open the project through that workspace.

The CLI does not provide a way to specify the secure storage password for encrypted datasets. You must provide the password in Test Performance and ensure that it is stored and persisted in the test before you run the test that is associated with an encrypted dataset from CLI. See Activating secure storage of dataset passwords.

You must provide the values for certain parameters to run tests from CLI. The minimum parameters that you need to provide are -workspace, -project, and -suite or -schedule, or -configfile. The remaining parameters are optional. For example, if you provide a complete path of a configuration file for the -configfile parameter that contains the values of the parameters for a test or schedule run, then you need not provide values for the -workspace, -project, and -suite or -schedule parameters.

Note: If Test Performance is not installed in default location, then you must provide the value for -eclipsehome and -plugins parameters along with other mandatory parameters.

You can refer to the following tables to know the required and optional parameters and its description:

Table 1. Required parameters for CLI
Parameters Description
-workspace Enter the complete path of the Eclipse workspace.
For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace"
-project Enter the path including the file name of the project relative to the workspace.
For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123"
OR
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "/myproj/proj123"
-suite Enter the path including the file name of the performance test relative to the project.
For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "/myproj/proj123" -suite "test1.testsuite"
OR
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "/myproj/proj123" -suite "Tests/test1.testsuite"
Note: You must not use both the -suite and -schedule parameters simultaneously in a single command.

You can specify multiple tests separated by a colon character (:) to run multiple tests simultaneously.

For example, 
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "/myproj/proj123" 
-suite "test1.testsuite:test2.testsuite:test3.testsuite"

You can run any or all tests and compound tests that are in a folder by using the wildcard character * enclosed in quotes in different combinations in the command line.

cmdline -workspace <workspace_full_path> -project <project_relative_path> -suite "*".

For example, you can run the following commands:

  • cmdline -workspace “workspace” -project myProject -suite "*"to run all the tests in myProject.
  • cmdline -workspace “workspace” -project myProject -suite "test*" to run all the tests in myProject that have the file names starting with 'test'.
  • cmdline -workspace “workspace” -project myProject -suite "Compound Tests/*" to run all the tests in the Compound Tests folder under myProject.
  • cmdline -workspace “workspace” -project myProject -suite "Web*.testsuite:!Web2" to run all the tests in myProject that have the file names starting with 'Web', but not 'Web2'
  • cmdline -workspace “workspace” -project myProject -suite "Web*.testsuite:/myProject2/Test1*.testsuite" to run all the tests in myProject that have the file names starting with 'Web' and all the tests in myProject2 that have the file names starting with 'Test1'
-schedule Enter the path including the file name of the schedule relative to the project.
For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "/myproj/proj123" -schedule "sch1"
OR
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "/myproj/proj123" -schedule "Schedules/sch1"
Note: You must not use both the -schedule and -suite parameters simultaneously in a single command.

You can specify multiple schedules separated by a colon character (:) to run schedules simultaneously.

For example, 
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "/myproj/proj123" 
-schedule "sch1:sch2:sch3"

You can run the following command to run the schedule: cmdline -workspace <workspace_full_path> -project <project_relative_path> -schedules "sch1*"

For example, cmdline -workspace "workspace" -project "PT1" -schedules "sch1*"
-configfile Enter the complete path to a configuration file that contains the parameters for a test or schedule run.

For more information about creating a command line config file from Test Performance, see the Related information section.

Note: If you provide a complete path of a configuration file for the -configfile parameter, then you need not provide values for the -workspace, -project, and -suite parameters.

The contents of a default configuration file are as follows:

eclipsehome=C:/Program Files/HCL/DevOpsTest
plugins=C:\Program Files\HCL\HCLIMShared\plugins
workspace=C:/Users/HCL/devopstest/workspace
project=proj1
suite=Tests/test1.testsuite
exportlogmillis=false
overwrite=false
Note: If you are creating a config file manually, the file must be in the UTF-8 format. You must not use double quotation marks () in the file even for values that contain spaces.
Table 2. Optional parameters for CLI
Parameters Description
-compare Use this parameter along with -exportstatshtml to export the result in compare mode.

The value can be paths to the runs and are relative to the workspace. You must separate the paths by a comma.
-duration

Use this parameter to change the duration of the stages in the rate schedule.

For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-rate "Rate Runner Group 1=1/s, 3/m" -duration "Stage1=10s; Stage2=5m"

The stage number specified must exist in the rate schedule.

You can specify multiple stages separated by semicolon (;). The time units that you can specify for the duration are as follows:
  • ms (millisecond)
  • s (second)
  • m (minute)
  • h (hour)
  • d (day)
Note: The -duration parameter creates a new copy of the rate schedule that contains the specified number of duration.
-eclipsehome Use this parameter to provide the complete path to the directory that contains eclipse.exe, if Test Performance is not installed in the default location.
The default location of eclipse.exe is as follows:
Operating system The default path to the directory
Windows® C:\Program Files\HCL\DevOpsTest
Linux™ /opt/HCL/DevOpsTest
Mac /Application/HCL/DevOpsTest
For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "/myproj/proj123" -suite "test1.testsuite" 
-eclipsehome D:\Testtool\HCL\DevOpsTest
-execsummary Use this parameter to export all of the reports for the test run in a printable format, also known as an executive summary, to the local computer.

You must specify the path to store the executive summary.

For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-execsummary "C:/Users/Tets/summary"
-execsummaryreport Use this parameter to export a specific report as an executive summary for the test run to the local computer.

You must specify the ID of the report to export. You must use this parameter along with the -execsummary parameter.

For example, you can specify http to export the executive summary of an HTTP performance report.
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-execsummary "C:/Users/Tets/summary" -execsummaryreport "http"
-exportlog Use this parameter to specify the file directory path to store the exported HTTP test log.
For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-exportlog "C:/Users/logs/logexport.txt"

In the -exportlog parameter, you can provide multiple values when running multiple tests. You must use colon (:) to separate the entries of the parameter value.

For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite:test2.testsuite" 
-exportlog "C:/Users/logs/logexport.txt:C:/Users/logs/logexport2.txt"

If there are multiple values for the -suite parameter and a single value for the -exportlog parameter, then the -exportlog parameter generates the appropriate number of test logs by appending 0, 1, 2, and so on.

For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite:test2.testsuite:test3.testsuite" 
-exportlog "C:/Users/logs/logexport.txt"

The preceding command generates the following test logs:

  • logexport_0.txt
  • logexport_1.txt
  • logexport.txt

The last test log generated has the same name as that of value of -exportlog parameter.

Note: If there are multiple values for the -suite and -exportlog parameters, then the number of -suite values must match with the number of -exportlog values. Otherwise, the following error message is displayed:

Error, number of -suite and -exportlog entries do not match.
-exportlogmillis Use this parameter if you want to view the timestamp of the test logs in milliseconds.

The default value for the -exportlogmillis is set to false. Therefore, the timestamp in the test logs does not contain milliseconds.
-exportstatreportlist Use this parameter to specify the IDs of reports that you want to export in place of the default report.

You can provide multiple report IDs separated by a comma. You can navigate to the Preferences of Test Performance (Window > Preferences > Test > Performance Test Reports > Export Reports), and then you can select Show Report IDs checkbox to view the report IDs.

You must use the -exportstatreportlist parameter along with the -exportstats or -exportstatshtml parameter.

For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-exportstats "C:/Users/stats" -exportstatreportlist "http"
-exportstats Use this parameter to provide the complete path to a directory that you can use to store the exported report in a comma-separated values (CSV) format.
For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-exportstats "C:/Users/stats"
-exportstatspattern Use the -exportstatspattern parameter along with the -exportstats parameter to specify a pattern that defines the name of a CSV or JSON file. You can use the following token to customize the file name:

"{TEST_NAME}{AGENT_NAME}{SPLIT_INDEX}_{TIMESTAMP}_{REPORT_ID}_{EXPORT_TYPE}"

For example,
cmdline -workspace "C:/Users/HCL//devopstest/workspace" 
-project "proj123" -suite "test1.testsuite -exportstatshtml" C:/Users  -exportstatsformat "simple.json,full.csv" -exportstats 
C:/Users -exportlog "C:/Users/logexport.txt" -exportstatreportlist "http,httpVP" 
-exportstatspattern "RPT_{REPORT_NAME}_{EXPORT_TYPE}_{REPORT_ID}"
Note: The -exportstatspattern parameter is only supported for the command which is run from the command line of Test Performance.
-exportstatsformat Use this parameter to specify a format for the result that you want to export along with the -exportstats parameter.
You must use at least one of the following arguments with the -exportstatsformat parameter:
  • simple.csv
  • full.csv
  • simple.json
  • full.json
  • csv
  • json
For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-exportstats "C:/Users/stats" -exportstatsformat "simple.json"

You can add multiple arguments separated by a comma.

For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-exportstats "C:/Users/stats" -exportstatsformat "simple.json,full.csv"

When you want to export both simple and full type of test results in a json or csv format, you can specify json or csv as the arguments in the command. When the test run completes, the test result exports to simple.json and full.json files.

For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-exportstats "C:/Users/stats" -exportstatsformat "json"

You can select the Command Line checkbox from the product Preferences (Window > Preferences > Test > Performance Test Reports > Export Reports) when you want to automatically export test results to one of the selected formats after the test run completes.

Remember: When you run the test from CLI, and if you use the -exportstats parameter, then CLI preferences take precedence over the Preferences set in the product. Therefore, the default format of the exported test result is CSV.

For example, when you select the Command Line option and Report format to json in the product Preferences, and run the test from CLI by using the -exportstats parameter, then the result is exported to a csv file after the test run is complete.
-exportstatshtml Use this parameter to provide the complete path to a directory that you can use to export web analytic results.
For example,
cmdline -workspace "C:/Users/HCL/hclonetest/workspace" -project "proj123" -suite "test1.testsuite" 
-exportstatshtml "C:/Users/reports"

The results are exported to the specified directory. You can analyze the results on a web browser without using Test Performance.
-history Use this parameter when you want to view a record of all events that occurred during a test or schedule run.
You can use any of the following options:
  • jaeger: To send test logs to the Jaeger UI during the test or schedule run.
    Note: You must set the JAEGER_AGENT_HOST property as an environment variable by using the command line before you use the jaeger option to send test logs to the Jaeger UI.

  • testlog: To send test logs as traditional test logs in Test Performance during the test or schedule run.

  • null: To send no test logs either to the Jaeger UI or Test Performance during the test or schedule run.

For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-history "jaeger"

You can add multiple arguments separated by a comma to send test logs during the test or schedule run to Test Performance and the Jaeger UI.

For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-history "jaeger,testlog"

For more information about how to view test logs in the Jaeger UI and Test Performance, see the Related information section.
ignoreunhealthytranscations Use this parameter if you do not want to record the elapsed time for the unhealthy transactions during the test run.

The default value for the ignoreunhealthytranscations parameter is set to false. Therefore, the elapsed time is recorded for unhealthy transactions.

Note: The value provided in the ignoreunhealthytranscations parameter always take precedence over the Discard time measurements for unhealthy transactions option set in the product preferences (Window > Preferences > Test > Test Execution).
-import Use this parameter to import the project from your local computer to a workspace and then run the test from the command-line interface.

When you want to run tests that are in a source control system such as Git, you can clone the project resources from the remote repository to your computer. You must use the -import parameter along with the -workspace parameter and use an empty workspace to import test assets.

You can use the -import parameter when you do not want to use your existing workspace or the workspace that you cloned from a remote repository.

For example,
cmdline -workspace "C:/Users/IBM/devopstest/workspace_new" -project "proj123" 
-suite "test1.testsuite" -import "D:/Performance/Project1
-importzip Use this parameter to import the project as test assets with dependencies into your workspace.

You can run test assets from the imported zip file, but you must specify the -importzip parameter along with the -schedule or -suite parameters.

For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -importzip "C:\User\Desktop\test1.zip" 
-suite "test1.testsuite"
-labels Use this parameter to add labels to test results when you run test assets from CLI.
For example, 
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-publish “https://localhost:5443/#project.name=test&teamspace.name=ts1” -labels "label1,label2"

You can also use the -labels parameter along with the -publish parameter to add labels to a test result when you want to publish test results to Test Hub.

You can add multiple labels to a test result separated by a comma. When you run test assets, then the labels that you added are displayed on the Performance Report in Test Performance.

The Results page of Test Hub displays the label that you added, in the specific test asset in the following conditions:

  • When you set Publish result after execution as Always or Prompt in the Preferences of Test Performance (WindowsPreferencesTestDevOps Test Hub).

  • When you use the labels parameter along with the publish parameter.

Note: If the value of the -labels parameter contains double quotation marks (""), for example, "100" users, then CLI does not accept values for the parameter.

To work around this problem, you must create a command-line config file, and then run the test by using the -configfile parameter. You can also use the CommandLine.exe file to run the command and add labels in a language that might not support Unicode characters on the Windows® operating system.

You can locate the CommandLine.exe file in the following location:

<installation_directory>\\HCLIMShared\plugins\com.ibm.rational.test.lt.cmdlineexecute<time_stamp>
- overridermlabels Use this parameter to perform any of the following actions:

  • Enable the Resource Monitoring from Service option for a performance schedule if the Resource Monitoring from Service option is not enabled from the schedule editor in Test Performance.

  • Ignore Resource Monitoring sources that were set in the performance schedule and to change for a label matching mode.

  • Replace an existing set of Resource Monitoring labels that were set in the performance schedule and run the schedule with a new set of Resource Monitoring labels.

You must have added the Resource Monitoring labels to the Resource Monitoring sources on the Resource Monitoring page in your Test Hub project. You can then use those labels to collect data from the source while running the schedule from CLI.

For example, if you have added a label in Test Hub for a Resource Monitoring source as rm1, then you can run the following command to collect data from the source:
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "/myproj/proj123" 
-schedule "sch1" -overridermlabels "rm1"

You can add multiple labels to a schedule separated by a comma to collect data from multiple sources during the schedule run.

For example:
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "/myproj/proj123" 
-schedule "sch1" -overridermlabels "rm1,rm2"

If your label for resource monitoring contains a comma (,) then you must replace the single comma with the double comma in the -overridermlabels parameter.

For example, if you have added a label to a Resource Monitoring source as rm1,test, then you must run the following command to collect data from source as follows:
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "/myproj/proj123" 
-schedule "sch1" -overridermlabels "rm1,,test"
-overwrite Use this parameter to determine whether a result file with the same name is overwritten or not.

The default value is false. If the value is set to true, the file is overwritten and retains the same file name.

You must use double quotation marks () for values true or false.

For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-overwrite "true"
-plugins Use this parameter to provide the complete path to the directory that contains the plugins directory, if Test Performance is not installed in the default location.
The default location of the plugins directory is as follows:
Operating system The default path to the directory
Windows® C:\Program Files\HCL\HCLIMShared\plugins
Linux™ /opt/HCL/HCLIMShared/plugins
Mac /Application/HCL/HCLIMShared/plugins
For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "/myproj/proj123" -suite "test1.testsuite" 
-eclipsehome "D:\Testtool\HCL\DevOpsTest" -plugins "D:\Testtool\HCL\HCLIMShared\plugins"
-publish

Use this parameter to publish test results to Test Hub.

Remember: Before you use the publish parameter, you must provide the offline user token of Test Hub by using any of the following methods:

  • Set the value of the HCL_DEVOPS_OFFLINE_TOKEN environment variable to the offline user token of Test Hub by using the command-line interface.

  • Provide the offline user token of Test Hub in the preferences of Test Performance (Window > Preferences > Test > DevOps Test Hub)

You can use the following arguments along with the -publish parameter:

  • no: Use this argument if you do not want to publish test results after the run.

    This argument is useful if the product preferences are set to publish the results, but you do not want to publish them.

  • You can use any of the following arguments to specify the project name:

    • serverURL #project.name=projectName&teamspace.name=name_of_the _teamspace

    • serverURL #project.name=projectName&teamspace.alias=name_of_the _teamspace_alias

    For example,
    cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-publish “https://localhost:5443/#project.name=testproj”
    Where:

    • https://localhost:5443 is the URL of Test Hub.

    • testproj is the name of the project in Test Hub.

    For example,
    cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-publish “https://localhost:5443/#project.name=test&teamspace.name=ts1”
    Notes:

    • If you have a project with the same name in different team spaces, then you must append either the &teamspace.name=name_of_the _teamspace or &teamspace.alias=name_of_the_teamspace_alias options.

    • If the name of the project or team space contains a special character, then you must replace it with %<Hexvalue_of_special_character>.

      For example, if the name of the team space is Initial Team Space, then you must provide it as Intial%20Team%20Space.

      Where %20 is the Hex value of Space character.

    • The values provided in the publish parameter always take precedence over the Results options set in the product preferences (Window > Preferences > Test > DevOps Test Hub > Results).

The Reports information section on the Log file displays the names of the report along with its corresponding URLs in the following conditions:
  • When you configured the URL of Test Hub in Preferences of Test Performance (Window > Preferences > Test > DevOps Test Hub).
  • When you set Publish result after execution as Always or Prompt in the Preferences of Test Performance (Window > Preferences > Test > DevOps Test Hub > Results).
  • When you used publish parameter or publish parameter along with publishreports parameter.
Remember: If you provide Test Hub and the project details in the product Preferences (Window > Preferences > Test > DevOps Test Hub) and if you use the -publish parameter, the server details in CLI take precedence over the product preferences.
-publish_for Use this parameter to publish the test results based on the completion status of the tests:
  • ALL - This is the default option. Use this argument to publish test results for any text execution verdict.
  • PASS - Use this argument to publish test results for the tests that have passed.
  • FAIL - Use this argument to publish test results for the tests that have failed.
  • ERROR - Use this argument to publish test results for the tests that included errors.
  • INCONCLUSIVE - Use this argument to publish test results for the inconclusive tests.

You must use the -publish_for parameter along with the -publish parameter. You can add multiple arguments for the -publish_for parameter separated by a comma.

For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-publish “https://localhost:5443/#project.name=test&teamspace.name=ts1” -publish_for "PASS,ERROR"
-publishreports Use this parameter to publish specific test results to Test Hub.

The arguments that you can use with the -publishreports parameter are as follows:

  • STATS
  • TESTLOG

You must use the -publishreports parameter along with the -publish parameter.

For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-publish “https://localhost:5443/#project.name=testproj” -publishreports "STATS"

You can prefix the -publishreports arguments with ! to publish all the reports except the specified one.

For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-publish “https://localhost:5443/#project.name=testproj” -publishreports "!TESTLOG"
Note: When you run service tests, you cannot publish the functional report directly from the CLI to Test Hub.

You must publish the functional report by using Test Performance. For more information about generating and publishing the functional report, see the Related information section.
-quiet Use this parameter when you do not want to display the values and acceptance status of the parameters on the command-line interface.
For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-quiet
-rate Use this parameter to specify a rate that you want to achieve for a workload in the Rate Runner group.
For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-rate "Rate Runner Group 1=1/s, 3/m"

Where, Rate Runner Group1 is the name of the rate runner group that has two stages. The desired rate for the first stage is one iteration per second and the rate for the second stage is three iterations per minute.

Notes:
  • The name of the Rate Runner group must match with the name in the rate schedule.
  • The -rate parameter creates a new copy of the rate schedule that contains the specified number of rate.
You can specify multiple Rate Runner groups separated by the semicolon (;). The time units that you can specify for the rate are as follows:
  • s (second)
  • m (minute)
  • h (hour)
  • d (day)
-results Use this parameter to specify the name of the results file.

The default name of the result file is the test or schedule name with a timestamp appended. You must specify a folder name that is relative to the project to store the test results.

For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-results "Results/testresults1"
-stdout Use this parameter to display the information about the test or schedule on CLI.

After you run the test or schedule from CLI, the following outputs are displayed to give you the overall information of the test or schedule:

  • --VERDICT: The verdict of the test or schedule.
  • --REMOTE_RESULT: The URL of the result published to Test Hub.
  • --REMOTE_RESULT_UI: The URL of the result published to Test Hub and can be opened in a browser to analyze the result.
  • --LOCAL_RESULT: The path of the result saved locally.
For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-publish “https://localhost:5443/#project.name=testproj” -stdout
-swapdatasets Use this parameter to replace the dataset values during a test or schedule run.

If the test or schedule is associated with the dataset, you can replace the dataset at run time while initiating the run from CLI.

You must ensure that both original and new datasets are in the same workspace and have the same column names. You must also include the path to the dataset when you use the -swapdatasets parameter. You must provide the values for the -swapdatasets parameter in the following format:

/project_name/ds_path/original_ds.csv:/project_name/ds_path/new_ds.csv

For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-swapdatsets "/proj1023/Datasets/ds1.csv:/proj1023/Datasets/new_ds1.csv"

You can swap multiple datasets that are saved in a different project by adding multiple paths to the dataset separated by a semicolon (;).

-timerange Use this parameter along with -exportstats and -exportstatshtml to export test results within one or more time ranges.

The value of the -timerange parameter is the time range that you specify in the schedule.

For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-exportstats "C:/Users/stats" -timerange "10 Users"

You must separate time ranges with a comma and use double quotation marks () when there is space in a time range.
-usercomments

Use this parameter to add text that you want to display in the user comments row of the report.

For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-exportstats "C:/Users/stats" -usercomments="test run with dataset"
Note: If the value of the -usercomments parameter contains double quotation marks (""), for example, test run with "dataset", then CLI does not accept values for the parameter.

To work around this problem, you must create a command-line configuration file by using Test Performance, and then run the test by using the -configfile parameter. You can also use the CommandLine.exe file to run the command and to add comments in a language that might not support Unicode characters on the Windows® operating system.

You can locate the CommandLine.exe file in the following location:

<installation_directory>\\HCLIMShared\plugins\com.ibm.rational.test.lt.cmdlineexecute<time_stamp>
-users Use this parameter to override the default number of virtual users in the test or schedule run.

For a schedule, the default is the number of users specified in the schedule editor and for a test, the default is one user.

The -users parameter creates a new copy of the schedule that contains the specified number of users.

For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-users 50
-varfile Use this parameter to specify the complete path to the XML file that contains the variable initialization.
-vmargs Use this parameter to specify the Java maximum heap size for the Java process that controls the command line playback.

You must use the -vmargs parameter with the -Xmx argument.

For example, when you use -vmargs -Xmx4096m, specifies the maximum heap size as 4Gb.

This method is similar to specifying -Xmx4096m in the eclipse.ini file for Test Performance when playing back the test from the user interface.

For example,
cmdline -workspace "C:/Users/HCL/devopstest/workspace" -project "proj123" -suite "test1.testsuite" 
-vmargs "-Xmx4096m"