Welcome to VMware vRealize® Automation™ documentation for the on-premises versions of vRealize Automation. 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.

Introducing the New VMware Aria Family Name

Starting with the VMware Aria Automation April 2023 and upcoming VMware Aria Automation 8.12 release, the documentation suite is hosted on a new VMware Aria Automation product documentation landing page that includes documentation for:

  • VMware Aria Automation Assembler (formerly Cloud Assembly)
  • VMware Aria Automation Service Broker (formerly Service Broker)
  • VMware Aria Automation Pipelines (formerly Code Stream)
  • VMware Aria Automation Orchestrator (formerly vRealize Orchestrator)
  • VMware Aria Automation Config (formerly SaltStack Config)
  • VMware Aria Automation for Secure Hosts (formerly SecOps)

This new landing page also includes the VMware Aria Automation Release Notes.

Switching between on-premises product documentation versions

You can find all vRealize Automation on-premises product documentation here. Feel free to access the guides on the left, use the search option at the top, or go directly to topics in the tables below.

To access the documentation for your on-premises product version, use the version selector in the upper right corner of each topic. For example, to switch from version 8.11 documentation to 8.10 documentation, click 8.11 in the Selected product version selector drop-down menu at the top of a topic and click 8.10.

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 content.

Integrated vRealize Automation content Other vRealize Automation publications More resources
VMware product interoperability matrix vRealize Automation 8.x Support Matrix Cloud Management hands-on labs
vRealize Automation SaltStack Config documentation Installing vRealize Automation with Easy Installer vRealize Automation blogs and videos
vRealize Orchestrator documentation Administering vRealize Automation vRealize Automation product page
VMware vRealize Automation for Service Now 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 documentation 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.

VMware vRealize Automation 8.7 (and related products) and earlier

Browse the following archived vRealize Automation 8.x documentation in the list below.

VMware vRealize Automation 7.6 and earlier

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

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

PDF documentation