Unlocking an environment by using an Ant task
You can unlock an environment by using the IBM® Rational® Test Control Panel Ant tasks.
Here is an example syntax:
<taskdef name="unlockEnvironment" classname="com.ghc.ghTester.ant.UnLockEnvironment" classpathref="tasklib" />
<unlockEnvironment domain="<Domain name>" environment=<Environment name>"
username="<User name>" serverUrl="https://<Host name
or IP address>:5443/RTCP/" />The following example usage files for the Ant tasks are available in the
AntClient.zip package that can be downloaded from Rational
Test Control Panel. For more
information, see Rational
Integration Tester tool packages.
- create-update-delete-environment.xml
- lock-unlock-environment.xml
- publish-stubs.xml
- start-stop-scenario.xml
- start-stop-stub.xml
The following table lists the attributes that you can use with the unlockEnvironment Ant task for unlocking an environment.
| Attribute | Description | Required |
|---|---|---|
| serverUrl | URL of the Rational Test Control Panel | Yes |
| domain | Domain name | Yes |
| environment | Environment name | Yes |
| username | Specify the user name to authenticate with the Rational Test Control Panel to unlock the environment when the domain security is disabled. | No |
| 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. |
No, default is to send no token. |
| haltOnFailure | Set to true to fail the Ant script if the environment fails to unlock (flag). | No, default is false. |
| failureProperty | The name of a property that is set in the event of a failure. | No |
Error codes
For details of any error codes, see Exit codes for Command-line client and Ant client.