Start a stub by using the command line

You can start a stub by using the IBM® Rational® Integration Tester command line. This option is useful in situations where Ant is not available.

Note: The command-line tasks provide an option to wait for all of the stubs in a scenario to start before returning. This is the default option but you can disable it by specifying the “async” option. When in synchronous mode, the commands also alert users whether a scenario was started successfully.

The syntax to use is as follows:

GHTesterCmd Options start-stub

Here is an example syntax of synchronous mode (where there is only one stub in the environment, and it only has one version):

GHTesterCmd --serverUrl "http://Host name or IP address:7819/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:

GHTesterCmd --serverUrl "http://Host name or IP address:7819/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

The following table lists the options that you can use with the GHTesterCmd command for starting a stub.

Table 1. List of available options
Options	Description
--serverUrl/-u	URL of Rational Test Control Panel.
--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 IBM Rational Integration Tester 8.5.0.1 or later, and the Rational Test 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 Rational Integration Tester 8.5.0 or earlier, and the Rational Test 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.
--attributes/-t	Comma-separated list of agent attributes identifying the agent to run on (optional).
--async/-a	Run asynchronously; defaults to synchronous (flag).
--username/-l	Specify the user name to authenticate with Rational Test Control Panel if the environment is locked and the domain security is disabled.
--securityToken	Specify the security token generated for the user to authenticate with Rational Test 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 more information, see Domain level security and Managing environments.
--disablePerformanceOptimisations	Specify "true" value to disable performance optimization when starting the stub (optional).
--workerThreadCount	The amount of worker threads used to service requests to the stub (optional).
--dedicatedEngine	Use this option to run the stub using a dedicated engine that will not be used to run other stubs even if they are published from the same project. You can specify the JVM options using the `dedicatedEngineJvmOptions` parameter and specify the values such as the maximum memory, initial memory and the garbage collection policy for the engine. Syntax example: `GHTesterCmd --serverUrl http://localhost:7819/RTCP --domain default --environment local --name ReqRepStub --version "1.0" --dedicatedEngine --dedicatedEngineJvmOptions "-Xmx2g -Xms256m -Dmy.option=\"my\ value\"" start-stub` Note: Use spaces to separate the JVM parameters. The quotes and the space in the value must be escaped with a backslash as specified in the example.
--force --forceIf --forceUnless	Use the `force` option to start the stub by attempting to ignore any warnings or errors that might occur. `force`: To ignore all the problems that occur when you start the stub. `forceIf`: Specify a space-separated list of problem identifiers to ignore when starting a stub. `forceUnless`: Specify a space-separated list of problem identifiers to not ignore when starting a stub. If the parameter list is empty, the force setting is not considered and none of the errors are ignored. You can specify if a specific problem identifier must either be ignored or considered when the stub is started. The problem identifier parameters are: `agent-criteria-unsatisfied`: Indicates that there were not enough agents available to run the stub or the specified agents were not found. `reused-agent`: Indicates that the selected agent is already running a stub. This does not provide any benefit over running a single stub. `engine-criteria-unsatisfied`: Indicates that none of the agents could satisfy the engine requirements to start the stub on. This might occur if none of the agents support dedicated stub deployments. Examples: The command to ignore all the problems: `GHTesterCmd -u http://localhost:7819/RTCP -d MQ -e test --name stubReqRep --component SC --operation ReqRep --version "1.0" --force start-stub` To ignore a specific set of problems: `GHTesterCmd -u http://localhost:7819/RTCP -d MQ -e test --name stubReqRep --component SC --operation ReqRep --version "1.0" --forceIf "reused-agent agent-criteria-unsatisfied" start-stub`

Error codes

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

Feedback