Stop a scenario by using the command line

You can stop a scenario by using the HCL OneTest™ API command line, optionally waiting for the scenario to stop before exiting. This option is useful in situations where Ant is not available.
The syntax to use is as follows:
IntegrationTesterCmd Options stop-scenario

An example syntax for synchronous mode:

IntegrationTesterCmd --serverUrl "https://Host name or IP address:5443/RTCP/" 
--domain <Domain name> --environment <Environment name> 
--name <Scenario name> stop-scenario

An example syntax for asynchronous mode:

IntegrationTesterCmd --serverUrl "https://Host name or IP address:5443/RTCP/" 
--domain <Domain name> --environment <Environment name> 
--name <Scenario name> --owner <Owner user name> 
--username "<Username>" --async stop-scenario

The following table lists the options that can be used with the IntegrationTesterCmd command for stopping a scenario.

Table 1. List of available options
Option Description
--serverUrl/-u URL of the HCL Quality Server.
--domain/-d Domain name
--environment/-e Environment name
--name/-n The name of the target scenario to stop.
--owner/o Filters the scenarios by owner (optional).
--async/-a Run asynchronously; defaults to synchronous (flag).
--username/-l Specify the user name to authenticate with the server if the environment is locked and the domain security is disabled.
--securityToken

Specify the security token generated for the user to authenticate with HCL Quality Server when the domain security is enabled. In the locked environment mode, the operation can be performed by the user who locked the environment. For more information, see Domain level security and Managing environments.

Scenario selection

For a description of how to select a scenario, see Scenario selection.

Error codes

For details of any error codes, see Exit codes for Command-line client and Ant client.

Feedback