requestDeploy

The requestDeploy task requests a deployment for a specified deployment definition. There must be an active engine supporting the build definition for a successful request to occur.

The following table contains requestDeploy task attributes. Other required deployment properties, such as the remote system, load method, are fetched from the deployment definition.

Attribute Description Required

buildDefinitionId

For requestDeploy task, the deployment definition id, such as test.deploy, to request a deployment for.

Yes

repositoryAddress

Address of the team repository to use. The value of this attribute is typically ${repositoryAddress} because that property is built-in when using the Jazz Build Engine.

Yes

packageLabel

The build label of the package result which is to be deployed.

Yes

userId

User ID for authentication to the repository. Requires password or passwordFile to be set.

Yes

certificateFile

The path to the file that contains the user's login certificate for authentication. Requires password or passwordFile to be set. You can specify certificateFile or repositoriesFile, but not both.

No

deletePropertiesFile

Path to a properties file. This properties file specifies properties that should be omitted when the build is run. The properties are assumed to exist in the build definition. The path can be a relative path from the base directory of the build file or a full path.

No

deployAction

The deployment action to execute on the request. If unspecified, this request loads and deploys. Other values are load, deploy, and rollback.

No

failOnError

If true (the default), the task fails if it encounters an error. If false, some errors are ignored and the task is completed.

No

overridePropertiesFile

Path to a properties file. This properties file can add new properties or override existing properties in the build definition. The path can be a relative path from the base directory of the build file or a full path.

No

packageResultUuid

The UUID for the package result which is to be deployed. If unspecified, the deployment task uses the packageLabel attribute to look up the corresponding packageResultUUID for the package definition linked to this deployment definition (i.e. the buildDefinitionId Ant attribute).

No

integratedWindows

Whether to use Integrated Windows Authentication

No

kerberos

Whether to use Windows user credentials using Kerberos/SPNeGO.

No

password

Password for the user ID for authentication to the repository. Either password or passwordFile can be provided, but not both.

No

passwordFile

The password file to use for authentication to the connection. You can create a suitable password file by invoking the Jazz Build Engine with the -createPasswordFile argument. You can only specify one password file. Either password or passwordFile can be provided, but not both.

No

repositoriesFile

The repositories registry file containing a listing of repositories and their login credentials. You can specify repositoriesFile or certificateFile, but not both. If you specify repositoriesFile, do not specify either password or passwordFile. The repositories file is created and updated through the use of scm login and logout commands.

No

requestUUIDProperty

Stores the UUID of the retrieved build request. It is set only if a request is found.

No

resultUUIDProperty

Property to store the UUID of the build result.

No

reuseLoginOption

The first time an Ant task logs in to a repository, a connection is not terminated at the end of this task. All subsequent tasks reuse this connection as long as they connect to same repository with same user ID. When a task logs in to a different repository or with a different user ID, the previous connection is terminated and a new connection is created and reused.

No

verbose

Specifies more message output. The default is false.

No

Example

<requestDeploy repositoryAddress="https://example.com:9443/ccm" buildDefinitionId="DeployDef1" userId="RELENG" passwordFile="/u/RELENG/private/rtcPasswordFile.txt" packageLabel="20130901-1430221111" resultUUIDProperty="rtc.buildResultUUID" />

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki