> User Documentation Home

User Handbook
Tutorials
Resources

The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

vRealize Automation 8.x Plugin

View this plugin on the Plugins site

vraDeleteDeployment: vRA - Delete Deployment

Requests the deletion of a deployment and waits for it to complete.
  • deploymentId (optional)
    • Type: String
  • deploymentName (optional)
    • Type: String
  • domain (optional)
    • Type: String
  • password (optional)
    • Type: String
  • timeout (optional)
    • Type: long
  • token (optional)
    • Type: String
  • trustSelfSignedCert (optional)
    • Type: boolean
  • username (optional)
    • Type: String
  • vraURL (optional)
    • Type: String

vraDeployFromCatalog: vRA - Deploy from catalog

Creates a new deployment from a vRealize Automation catalog item
  • catalogItemName (optional)
    • Type: String
  • config (optional)
    • Type: String
  • configFormat (optional)
    • Type: String
  • count (optional)
    • Type: int
  • deploymentName (optional)
    • Type: String
  • domain (optional)
    • Type: String
  • inputMap (optional)
    • Type: java.util.Map<java.lang.String, java.lang.Object>
  • inputs (optional)
    • Type: String
  • password (optional)
    • Type: String
  • projectName (optional)
    • Type: String
  • reason (optional)
    • Type: String
  • timeout (optional)
    • Type: int
  • token (optional)
    • Type: String
  • trustSelfSignedCert (optional)
    • Type: boolean
  • username (optional)
    • Type: String
  • version (optional)
    • Type: String
  • vraURL (optional)
    • Type: String

vraGetDeployment: vRA - Get Deployment

Returns the details of a resource action.
  • deploymentId (optional)
    • Type: String
  • deploymentName (optional)
    • Type: String
  • domain (optional)
    • Type: String
  • expandResources (optional)
    • Type: boolean
  • password (optional)
    • Type: String
  • token (optional)
    • Type: String
  • trustSelfSignedCert (optional)
    • Type: boolean
  • username (optional)
    • Type: String
  • vraURL (optional)
    • Type: String

vraGetResourceActionDetails: vRA - Get Resource Action Details

Returns details of a specific resource action.
  • actionId (optional)
    • Type: String
  • deploymentId (optional)
    • Type: String
  • deploymentName (optional)
    • Type: String
  • domain (optional)
    • Type: String
  • password (optional)
    • Type: String
  • resourceName (optional)
    • Type: String
  • token (optional)
    • Type: String
  • trustSelfSignedCert (optional)
    • Type: boolean
  • username (optional)
    • Type: String
  • vraURL (optional)
    • Type: String

vraGetResourceActions: vRA - Get Resource Actions

Returns the actions available for a resource.
  • deploymentId (optional)
    • Type: String
  • deploymentName (optional)
    • Type: String
  • domain (optional)
    • Type: String
  • password (optional)
    • Type: String
  • resourceName (optional)
    • Type: String
  • token (optional)
    • Type: String
  • trustSelfSignedCert (optional)
    • Type: boolean
  • username (optional)
    • Type: String
  • vraURL (optional)
    • Type: String

vraRunAction: vRA - Run Action

Runs a day two action against a deployment or a resource within a deployment.
  • actionId (optional)
    • Type: String
  • deploymentId (optional)
    • Type: String
  • deploymentName (optional)
    • Type: String
  • domain (optional)
    • Type: String
  • inputMap (optional)
    • Type: java.util.Map<java.lang.String, java.lang.Object>
  • inputs (optional)
    • Type: String
  • password (optional)
    • Type: String
  • reason (optional)
    • Type: String
  • resourceName (optional)
    • Type: String
  • timeout (optional)
    • Type: long
  • token (optional)
    • Type: String
  • trustSelfSignedCert (optional)
    • Type: boolean
  • username (optional)
    • Type: String
  • vraURL (optional)
    • Type: String

vraWaitForAddress: vRA - Wait for Address

Waits until a machine within a deployment has obtained an IP address and returns it.
  • deploymentId (optional)
    • Type: String
  • deploymentName (optional)
    • Type: String
  • domain (optional)
    • Type: String
  • password (optional)
    • Type: String
  • resourceName (optional)
    • Type: String
  • timeout (optional)
    • Type: long
  • token (optional)
    • Type: String
  • trustSelfSignedCert (optional)
    • Type: boolean
  • username (optional)
    • Type: String
  • vraURL (optional)
    • Type: String

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.