Welcome to VMware vRealize® Automation™ documentation for the SaaS and the on-premises versions of the product. Learn how you can provide a secure portal where authorized administrators, developers, or business users can request new IT services. Manage your cloud and IT resources while ensuring compliance with business policies.

Switching between SaaS and on-prem documentation

About the version selector Example (click image to enlarge)

To access the documentation for your SaaS or on-premises product version, use the version selector on each topic.

For example, to switch to SaaS documentation, click SaaS in the Selected product version drop-down menu at the top of a topic.

The vRealize Automation interface displays the expanded version selector, showing all available product versions.

Getting started with vRealize Automation

Use the links in the navigation to the left to access documentation for the main vRealize Automation services. Use the links below to access related guides for your SaaS or on-prem versions.

Shared between SaaS and 8.x SaaS only 8.x only More resources
VMware product interoperability matrix vRealize Automation Cloud Transition Guide vRealize Automation 8.x Support Matrix Cloud Management hands-on labs
vRealize Automation SaltStack Config documentation Quick Cloud Automation Setup for VMware Cloud on AWS Installing vRealize Automation with Easy Installer vRealize Automation blogs and videos
vRealize Orchestrator documentation Understanding the VMware Cloud services cloud proxy Administering vRealize Automation vRealize Automation product page
VMware vRealize Automation for Service Now VMware Cloud Services vRealize Automation Transition Guide vRealize Automation community forum
Creating and deploying a provider-specific IPAM integration package vRealize Automation 8.x Extensibility Migration Guide Cloud Assembly tutorials
vRealize Automation Resource Schema NSX-V to NSX-T Migration Guide Code Stream tutorials
Load Balancing Guide
Reference Architecture Guide
vRealize Suite

The Suite documentation includes backup and recovery for vRealize Automation .

vRealize Automation APIs and CLI

vRealize Automation includes tools and APIs that are intended for administrators and programmers who want to configure and manage vRealize Automation outside of the UI. To use the tools and APIs, refer to the documentation.

Programming Guide vRealize Automation API Reference On-premises CLI

The Programming Guide provides common use cases including sample requests and responses.

The vRealize Automation API Reference includes OpenAPI files for all REST API service calls.

How you access the API reference depends on the vRealize Automation version you use.

  • For vRealize Automation Cloud, go to https://www.mgmt.cloud.vmware.com/automation-ui/api-docs/.
  • If vRealize Automation 8.0 or later is installed, go to https://$vRA/automation-ui/api-docs, where $vRA is the hostname of your vRealize Automation appliance.
  • If vRealize Automation 7.6 or earlier is installed, go to https://$vRA/component-registry/services/docs, where $vRA denotes an instance of vRealize Automation.

On-premises versions of vRealize Automation include the vracli tool to perform administration and troubleshooting tasks from the command line.

To use vracli, connect to the vRealize Automation appliance using SSH and log in as the root user. For information on vracli commands, type vracli -h.

vRealize Automation 7.6 and earlier

Browse vRealize Automation 7.x documentation in the table below.

Archived ZIP downloads More 7.x-related content
HTML documentation

PDF documentation