Orchestration Gateway Service API Specification

What Is the Orchestration Gateway Service?

The orchestration gateway service provides a gateway to VMware Realize Orchestrator (vRO) for services running on vRealize Automation. By using the gateway, consumers of the API can access a vRO instance, and initiate workflows or script actions without having to deal directly with the vRO APIs.

  Note: Currently orchestration gateway service users can access only one vRO
  configuration (i.e., instance) per tenant.  Access to multiple configurations is not suported.

The orchestration gateway service provides a standard way to request code execution by using:

• Well-defined and well-known model abstractions; for example, LiteralMap for input/output.
• Additional metadata needed to handle the request properly; for example, workflow/action definition ID, tenant ID, requester details, and so on.

When execution of a vRO workflow based on the request occurs, the orchestration gateway tracks code execution, collects the output from the vRO execution, and if needed, provides feedback to the requester.

Typical Use Cases

• The IP address management (IPAM) service or another internal vRA service calls the orchestration gateway service APIs to access a vRO workflow or execute a script.
• A solution user, system administrator, or tenant administrator accesses a GUI to configure, modify, or delete a vRO endpoint.

Key Concepts

Configuration

Configuration for a concrete vRO instance per tenant

Workflow

A vRO workflow.

ScriptAction

A vRO script action.

vRO Endpoint

An endpoint defined on a tenant for accessing vRO.

How the Orchestration Gateway Works

The orchestration gateway service provides APIs that allow an application to list existing categories and workflows associated with a category, and retrieve the workflow definition and workflow definition presentation for a workflow.

After the application has obtained a workflow definition and definition presentation, it can request execution of a workflow definition.

Similarly, an application can list vRO action definitions, retrieve a specified action definition, and then request vRO action definition execution. In addition, an application can configure a vRO endpoint.

After a workflow or action execution is requested, the orchestration gateway service can get execution details and status. It then broadcasts events indicating the changes in the status of tracked workflows, and if requested, notifify the requesterer of a vRO workflow by using a callback method.

Additional Information

For additional information, see the VRealize Automation Programming Guide.