Updating a managed stub by using the command line
You can update the values of the attributes of a managed stub by using the HCL DevOps Test Integrations and APIs (Test Integrations and APIs) command line.
The syntax to start a stub by using the command line is as follows:
IntegrationTesterCmd [Options] start-stub
Here is an example syntax of synchronous mode (where there is only one stub in the environment, and it has only one version):
IntegrationTesterCmd --serverUrl "https://Hostname or IP address:5443/RTCP/" --domain <Domain name> --environment <Environment name> --name <Stub name> start-stub
Here is an example syntax of asynchronous mode, where component and operation are used to precisely identify a stub, a specific version is specified, and the user has locked the environment:
IntegrationTesterCmd --serverUrl "https://Hostname 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
Starting from version 10.0.0 or later, you can use the following command to start a managed stub instance:
IntegrationTesterCmd [Options] switch-on-stub
For more information about managed stubs, see Server-based stubs.
List of supported options for starting a stub lists the options
that you can use with the IntegrationTesterCmd
command for starting a stub
and List of supported options for starting a managed stub lists
the options that you can use for starting a managed stub.
Options | Action for the command option | Usage criteria | Default value | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
--serverUrl/-u | Enter the URL of HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel). For example, if you installed Test Virtualization Control Panel on your local host, then the command option can be: --serverUrl https://localhost:5443/RTCP or -u https://localhost:5443/RTCP |
Mandatory | NA | ||||||||||||||||
--domain/-d | Enter the name of the domain in which the stub was created in
Test Integrations and APIs. For example, if you created the stub in the domain called default, then the command option can be: --domain default or -d default |
Mandatory | NA | ||||||||||||||||
--environment/-e | Enter the name of the environment in which the stub was created
in Test Integrations and APIs. For example, if you created the stub in the environment called local, then the command option can be: --environment local or -e local |
Mandatory | NA | ||||||||||||||||
--component/-c | Enter the name of the service component in which the stub was
created in Test Integrations and APIs. For example, if you created the stub in the service component called MyServiceComp, then the command option can be: --component MyServiceComp or -c MyServiceComp |
Optional | NA | ||||||||||||||||
--operation/-o | Enter the name of the operation in which the stub was created in
Test Integrations and APIs. For example, if you created the stub in the operation called StubOperation, then the command option can be: --operation StubOperation or -o StubOperation |
Optional | NA | ||||||||||||||||
--name/-n | Enter the name of the stub that you want to start on Test Virtualization Control Panel. For example, if you created the stub with the name as Stub_1, then the command option can be: --name Stub_1 or -o Stub_1 |
Mandatory | NA | ||||||||||||||||
--version/-v | Enter the version of the stub that you want to start on Test Virtualization Control Panel. For example, if you published different stub versions from 1.0 to 1.5 and you want to start the stub with version 1.3, then the co--version 1.3mmand option can be: or -v 1.3 Note: If you are using Test Integrations and APIs 8.5.0.1
or later, and the Test Virtualization Control Panel 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 Test Virtualization Control Panel
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. |
Optional | The latest version of the stub is started if no version is entered. For example, the stub with version 1.5 is started if no version is specified when you published different stub versions from 1.0 to 1.5. |
||||||||||||||||
--attributes/-t | Enter the agent attributes in a comma-separated list. Test Virtualization Control Panel identifies an agent with the specified attributes on which the stub must be run.
Use this option when you want to run the stub on an agent. For example, if you configured an agent with a particular attribute such as Windows 10, and you want this agent to be selected for running the stub, then the command option can be: --attributes Windows10 or -t Windows10 |
Optional | NA | ||||||||||||||||
--async/-a | Use this flag if you are running a stub that is in a scenario
and you do not want to wait until all the stubs in the scenario are started. When
this flag is used the stub that you want to start runs without waiting for the other
stubs to start. If this flag is not used, the stub runs synchronously. Note: The
command-line tasks provide an option to wait for all of the stubs in a scenario to
start before starting a stub. This is the default option but you can disable it by
specifying the async option. When you start a stub in the
synchronous mode, you are alerted when a scenario was started
successfully. |
Conditional | The stub runs synchronously. | ||||||||||||||||
--username/-l | Enter your user name to authenticate with the Test Virtualization Control Panel in the following conditions:
For example, if you have set up Tester1 as a user on Test Virtualization Control Panel, then the command option can be: --username Tester1 or -l Tester1 |
Conditional | NA | ||||||||||||||||
--securityToken |
Specify the security token generated for you to authenticate with Test Virtualization Control Panel when the domain security is enabled. In the locked environment mode, the operation can be performed by the user who locked the environment. For example, if the security token that is generated for you is X1akJHlq932i, then the command option can be: --securityToken X1akJHlq932i |
Conditional | NA | ||||||||||||||||
--disablePerformanceOptimisations | Include this flag when you want to disable performance optimization. | Optional | Performance optimization is enabled. | ||||||||||||||||
--workerThreadCount | Enter the number of worker threads that must be used to service
requests to the stub. If no number is specified with this option, the number of
worker threads defined in the stub is considered during the run. For example, if the stub has 10 worker threads defined, and you want to use 12 worker threads for its run, then the command option can be: --workerThreadCount 12 |
Optional | The number of worker threads defined in the stub. | ||||||||||||||||
--dedicatedEngine |
Use this flag when you want to run the stub that uses a dedicated engine. The dedicated engine is not used to run other stubs even if they are published from the same project. If you do not use this flag in the command the stub is not run on any dedicated engine. If you want to run the stub on a dedicated engine, you can also specify the JVM options by using the dedicatedEngineJvmOptions parameter. You can then specify the values for the attributes such as the maximum memory, the initial memory, and the garbage collection policy that must be applied for the dedicated engine. For example, if you want to specify the attributes for the JVM to have 2GB RAM and 256GB disk space, the command can be: IntegrationTesterCmd --serverUrl https://localhost:5443/RTCP --domain default --environment local --name ReqRepStub --version "1.0" --dedicatedEngine --dedicatedEngineJvmOptions "-Xmx2g -Xms256m -Dmy.option=\"my\ value\"" start-stub Note:
|
Optional | The stub is not run on any dedicated engine. | ||||||||||||||||
|
Use the force flag or option to start the
stub by ignoring any warnings or errors that might occur. You can use any of the
following variants:
You can use the following identifiers that must be either ignored or
considered when the stub is started:
Examples:
|
Conditional | NA | ||||||||||||||||
--secretsAuthorization |
Enter the offline user token for authorizing the client to access HCL DevOps Test Hub (Test Hub) when the stub needs to access contents such as secrets. For example, the command to start a stub using the --secretsAuthorization parameter follows: IntegrationTesterCmd -u ${SERVER_URL} -d ${DOMAIN_NAME} -e ${ENV_NAME} -n ${STUB_NAME} --secretsAuthorization ${OFFLINE_USER_TOKEN} start-stub For more information, see the related links. |
Conditional | NA |
Options | Action for the command option | Usage criteria | Default value |
---|---|---|---|
--serverUrl/-u | Enter the URL of Test Virtualization Control Panel. For example, if you installed Test Virtualization Control Panel on your local host, then the command option can be: --serverUrl https://localhost:5443/RTCP or -u https://localhost:5443/RTCP |
Mandatory | NA |
--domain/-d | Enter the name of the domain in which the stub was created in
Test Integrations and APIs. For example, if you created the stub in the domain called default, then the command option can be: --domain default or -d default |
Mandatory | NA |
--environment/-e | Enter the name of the environment in which the stub was created
in Test Integrations and APIs. For example, if you created the stub in the environment called local, then the command option can be: --environment local or -e local |
Mandatory | NA |
--name/-n | Enter the name of the managed stub that you want to start on
Test Virtualization Control Panel. For example, if you created the managed stub with the name as Stub_1, then the command option can be: --name Stub_1 or -n Stub_1 |
Optional | NA |
--id/-i |
Enter the ID of the target stub that you want to start. For example, the command to start a stub using the
--secretsAuthorization parameter
follows:
For more information, see the related links. |
Optional | NA |
--securityToken |
Specify the security token generated for you to authenticate with Test Virtualization Control Panel when the domain security is enabled. In the locked environment mode, the operation can be performed by the user who locked the environment. For example, if the security token that is generated for you is X1akJHlq932i, then the command option can be: --securityToken X1akJHlq932i |
Conditional | NA |
- HCL DevOps Test Integrations and APIs Agent (Test Integrations and APIs Agent) fails.
- Test Virtualization Control Panel fails.
- A network outage.
Error codes
For details of any error codes, see Exit codes for Command-line client and Ant client.