vRealize Automation 8.x

Version: 1.0Minimum Jenkins requirement: 2.235.1ID: vrealize-automation-8
Installs: 1
Last released:
Pontus Rydin


This plugin lets you create, manage and destroy virtual machines, networks, load balancers and other resources managed by vRealize Automation 8.x.

The plugin is currently focused on pipelines rather than freestyle project. If you see a need for support for freestyle, please open an issue and we will put that on the roadmap for future development.

Getting started

Install the plugin, either by selecting it from the plugin library in Jenkins (coming soon) or by uploading the HPI file.

In your application repository, create a Jenkinsfile with contents similar to this:

node {
    // Submit a deployment request and wait for it complete
    def deployment = vraDeployFromCatalog(
            catalogItemName: '<catalog item name>',
            count: 1,
            deploymentName: 'Jenkins-#',
            projectName: '<project name>',
            reason: 'I have my reasons!',
            timeout: 300,
            version: '2',
            inputs: '{ username: \'testuser\' }')
    assert deployment != null

    // Wait for the machine to receive a valid IP address. 
    def addr = vraWaitForAddress(
            deploymentId: deployment[0].id,
            resourceName: '<name of a machine within the blueprint>')
    echo "Deployed: $deployment[0].id, addresses: ${addr}"

That's it! Create a pipeline project in Jenkins that's linked to your repository, and you can start using it.

You have now deployed a machine and received an IP address for it. You may use it for SSH steps etc.

Global settings

This plugin allows you to configure the address of the vRealize Automation environment, the API key, as well as whether Jenkins should accept vRealize Automation Servers with self-signed certificates. This is useful when you're only interacting with a single instance of vRealize Automation and allows you to omit address and credentials from the actual pipelines. The credentials are configured as a reference to a standard Jenkins string credential.

Global Settings

Available pipeline steps




We strongly encourage contributions to this project and would love to include your code and ideas! For details, please refer to CONTRIBUTING.md

ArchivesGet past versions
This plugin has no labels