vRealize Automation Orchestration (o11n) Gateway Service API
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,
- 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.
Configuration for a concrete vRO instance per tenant
A vRO workflow.
A vRO script action.
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.
For additional information, see the VRealize Automation Programming Guide.
Related Sample Code
- vRealize Automation API Samples for PostmanvRealize Automation API Samples for Postman Overview The vRealize Automation REST API provides consumers and administrators access to all services in its service catalog that support the vRealize Auto ...vRealize Automation POSTMAN CollectionDownload
Updated 1 month
- vRealize Automation - Catalog ServicevRealize Automation - Catalog Service The catalog service REST API is designed to be used by the consumers of the service catalog; for example, an end user who wants to request a catalog item would be ...api_vra_catalog vRealize Automation api_vra_composition POSTMAN CollectionDownload
Updated 4 months
- vRealize Automation - NSX IntegrationvRealize Automation - NSX Integration NSX integration in vRealize Automation can help creating and configuring existing networks, on-demand NAT networks and on-demand routed networks, creating load ba ...vRealize Automation api_vra_network POSTMAN Collection
- vRealize Automation - Composition ServicevRealize Automation - Composition Service The composition service allows vRA services to register application components, which the composition service manages so that they can be used in composite bl ...vRealize Automation api_vra_composition POSTMAN Collection
- vRealize Automation - Identity ServicevRealize Automation - Identity Service Identity service manages tenants, business groups (formerly named subtenants), groups (both Single-Sign-On and Custom groups), users and identity stores. It also ...vRealize Automation api_vra_identity POSTMAN Collection
- VMware vRealize Automation PluginJenkins vRealize Automation Plugin The vRealize Automation Jenkins plugin enables Jenkins to provision vRealize Automation 7 Blueprints. Requirements Jenkins 1.58+ Java 8 to compile plugin or Java 7 ...vRealize Automation JavaDownload
Updated 8 months
- vRealize Automation - Component RegistryvRealize Automation - Component Registry Component Registry manages all services (including out-of-the-box services and services from third party solution providers) and serves as the central view for ...api_vra_component_registry vRealize Automation POSTMAN Collection
- vRealize Automation - Management Service APIvRealize Automation - Management Service API You can use the reclamation service to query the VMs in an installation for non-usage and, if they are not in use, mark them as eligible for reclamation. ...vRealize Automation api_vra_management POSTMAN Collection
- vRealize Automation - Content Management ServicevRealize Automation - Content Management Service You can use the content management service REST API to import and export content, such as blueprints, software components, and other artifacts, from vR ...vRealize Automation api_vra_content_management api_vra_composition POSTMAN Collection
- vRealize Automation - Event BrokervRealize Automation - Event Broker The event broker provides features for managing subscriptions, event topics, events, and messages. Available Use Case Get event topics Registers or updates an Even ...vRealize Automation api_vra_event_broker POSTMAN Collection
- Extend Disk vRealize Automation WorkflowThis VMware Orchestrator workflow package will extend the C drive of a virtual disk in vRealize Automation from a vCenter (vSphere) machine template blueprint. The workflow receives a payload of prope ...vRealize Orchestrator Plug-in SDK vRealize Automation vRO PackageDownload
Updated 1 year
- vRealize Automation - BrandingvRealize Automation - Branding The Branding service enables the user to customize the VRA UI header and footer. The configurable properties include logo image, company name, product name, background c ...api_vra_branding vRealize Automation POSTMAN Collection
- vRealize Automation - Properties ServicevRealize Automation - Properties Service The property service provides APIs to manage property definitions and property groups. Available Use Cases Manage property definitions Manage property groups ...api_vra_properties vRealize Automation POSTMAN Collection
- vRealize Automation - Approval ServicevRealize Automation - Approval Service The approval service provides features for managing and tracking the human approval tasks associated with a service process/artifact in a provider realm. It also ...api_vra_approval vRealize Automation POSTMAN Collection
- vRealize Automation - WorkItem ServicevRealize Automation - WorkItem Service The work item service provides a standard way for services to present work items to users. It manages the life-cycle of a work item and passes events back to the ...api_vra_approval api_vra_workitem vRealize Automation POSTMAN Collection
Updated 1 year
- vRA 7 and above prepare_vra_template.ps1Powershell script designed to deploy the needed agents on your windows template. This mimics the prepare_vra_template.sh file for linux and will deploy java, bootstrap and gugent agents from the vRA a ...vRealize Automation PowerShellDownload
Updated 1 year
- chef-client example of a bootstrap install on Ubuntu 16.04A basic example to install the chef-client via the install.sh from Chef Software. This should be noted that this only requires wget and bash, so this can work for CentOS, RHEL, debian, Ubuntu, and the ...vRealize Automation vRA BlueprintDownload
Updated 2 years