Start a stub by using the command line
You can start a stub by using the HCL OneTest™ API command line.
IntegrationTesterCmd Options start-stub
IntegrationTesterCmd --serverUrl "https://Host name or IP address:5443/RTCP/"
--domain <Domain name> --environment <Environment name>
--name <Stub name> start-stub
IntegrationTesterCmd --serverUrl "https://Host name or IP address:5443/RTCP/"
--domain <Domain name> --environment <Environment name>
--component <Component name> --operation <Operation name>
--name <Stub name> --version <Stub version number>
--username <User name> --async start-stub
Managed stubs
IntegrationTesterCmd Options switch-on-stub
For more information about managed stubs, see Server-based stubs.
List of available options for starting a stub lists the options that
you can use with the IntegrationTesterCmd
command for starting a stub and List of available options for starting a managed stub lists the options available for
starting a managed stub.
Options | Description |
---|---|
--serverUrl/-u | URL of the HCL Quality Server. |
--domain/-d | Domain name |
--environment/-e | Environment name |
--component/-c | Component the stub exists within (optional). |
--operation/-o | The operation the stub exists within on the server (optional). |
--name/-n | The name of the target stub to start. |
--version/-v | Version of the target stub to start (optional). Note: If you are using HCL OneTest™ API 8.5.0.1 or
later, and the HCL Quality Server command
line or Apache Ant tasks are used to start a stub, and if no stub version information is provided,
it is the latest version of a stub that is run. If you are using 8.5.0 or earlier, and the HCL Quality Server command
line or Apache Ant tasks are used to start a stub, and if no stub version information is provided,
it is the earliest version of a stub that is run. |
--attributes/-t | Comma-separated list of agent attributes that identify the agent to run on (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. |
--disablePerformanceOptimisations | Specify "true" value to disable performance optimization when you start the stub (optional). |
--workerThreadCount | The amount of worker threads that are used to service requests to the stub (optional). |
--dedicatedEngine |
Use this option to run the stub by using a dedicated engine that is not used to run
other stubs even if they are published from the same project. You can specify the JVM options by
using the Syntax example:
Note:
|
|
Use the
force option to start the stub by attempting to ignore
any warnings or errors that might occur.
You can specify if a specific problem identifier must either be ignored or considered
when the stub is started. The problem identifier parameters are:
Examples:
|
--secretsAuthorization |
Offline user token for authorizing the client to access HCL OneTest™ Server (Optional). For example, the command to start a stub using the --secretsAuthorization
parameter
follows:
For more information, see Accessing HCL OneTest Server from IntegrationTesterCmd, ANT CLI, Maven CLI, or in a REST API call. |
Options | Description |
---|---|
--serverUrl/-u | URL of the HCL Quality Server. |
--domain/-d | Domain name |
--environment/-e | Environment name |
--name/-n | The name of the target stub to start. |
--id/-i | The ID of the target (Optional). |
--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. |
- HCL OneTest™ API Agent failing
- HCL Quality Server failing
- a network outage
Error codes
For details of any error codes, see Exit codes for Command-line client and Ant client.