7.3
Table Of Contents
- Programming Guide
- Contents
- vRealize Automation Programming Guide
- Updated Information
- Overview of the vRealize Automation REST API
- REST API Authentication
- Creating a Tenant
- Prerequisites for Creating a Tenant
- Create a Tenant With Parameters Inline
- Create a Tenant With a JSON File
- Identity Service Examples for Creating a Tenant
- Syntax for Displaying Your Current Tenants
- Syntax for Requesting a New Tenant
- Syntax for Listing All Tenant Identity Stores
- Syntax for Linking an Identity Store to the Tenant
- Syntax for Searching LDAP or Active Directory for a User
- Syntax for Assigning a User to a Role
- Syntax for Displaying all Roles Assigned to a User
- Requesting a Machine
- Approving a Machine Request
- Listing Provisioned Resources
- Managing Provisioned Deployments
- Working with Reservations
- Prerequisites for Working With Reservations
- Create a Reservation
- Display a List of Supported Reservation Types
- Displaying a Schema Definition for a Reservation
- Get the Business Group ID for a Reservation
- Get a Compute Resource for the Reservation
- Getting a Resources Schema by Reservation Type
- Creating a Reservation By Type
- Verify a Reservation and Get Reservation Details
- Display a List of Reservations
- Update a Reservation
- Delete a Reservation
- Service Examples for Working with Reservations
- Syntax for Displaying a List of Reservations
- Syntax for Displaying a Schema Definition for a vSphere Reservation
- Syntax for Displaying a Schema Definition for an Amazon Reservation
- Syntax for Displaying a Schema Definition for a vCloud Air Reservation
- Syntax for Getting the Business Group ID for a Reservation
- Syntax for Getting a Compute Resource for a Reservation
- Syntax for Getting Resources Schema for a vSphere Reservation
- Syntax for Getting Resources Schema for an Amazon Reservation
- Syntax for Getting Resources Schema for a vCloud Air Reservation
- Syntax for Creating a vSphere Reservation
- Syntax for Creating an Amazon Reservation
- Syntax for Creating a vCloud Air Reservation
- Syntax for Verifying a Reservation and Getting Reservation Details
- Syntax for Displaying a List of Supported Reservation Types
- Syntax for Updating a Reservation
- Syntax for Deleting a Reservation
- Working with Reservation Policies
- Working with Key Pairs
- Working with Network Profiles
- Getting a List of Available IP Ranges
- Importing and Exporting Content
- Understanding Blueprint Schema
- Prerequisites for Importing and Exporting Content
- List Supported Content Types Example
- List Available Content Example
- Filter Content by Content Type Example
- Create a Package for Export Example
- List Packages in the Content Service Example
- Export a Package Example
- Validate a Content Bundle Before Importing example
- Import a Package Example
- Export XaaS Content Example
- Import XaaS Content Example
- Related Tools and Documentation
- Filtering and Formatting REST API Information
In addition to general information about the provisioned deployment such as its name, description, and
ID, the response contains additional HATEOAS links that enable you to obtain additional details and
information.
Table 6‑1. HATEOAS Link Functions as Defined by rel Field
Link Description
GET: Catalog Item URI to get the catalog item details (as described in sections 3.2.1 and
3.2.2) from which this catalog item was provisioned.
GET: Request URI to get the request details that provisioned this item.
GET:Template
{com.vmware.csp.component.cafe.composition@reso
urce.action.deployment.$actionName
URI to get a template request for a specific action that you can perform on
this resource. Typically, on a deployment the action will be Delete.
POST:
{com.vmware.csp.component.cafe.composition@reso
urce.action.deployment.$actionName
URI to which to post the request to perform an action, based on the
corresponding template.
GET: Child Resources If the deployment contains child resources (nodes specified in the
composite blueprint), this is the URI to get a list of the resourceViews for
the children of this deployment.
Input
Use the supported input parameters to control the command output.
Parameter Description
URL https://$vRA/catalog-service/api/consumer/resources/$resourceId
$vRA Specifies the appliance name and fully qualified domain name, or IP address of the
vRealize Automation server.
$token Specifies a valid HTTP bearer token with necessary credentials.
$resourceID Specifies a resource ID. See Display Your Provisioned Resources Example to view all of your
requests and search for a request ID.
managedOnly If true, the returned requests are from the user's managed subtenants.
page Specifies a page number.
limit Specifies the number of entries to display on a page.
$orderby Specifies how to order multiple comma-separated properties sorted in ascending or descending
order.
$top Specifies the number of returned entries from the top of the response (total number per page in
relation to skip).
$skip Specifies the number of entries to skip.
filter Contains a Boolean expression to determine if a particular entry is included in the response.
Output
The command output contains property names and values based on the command input parameters.
Programming Guide
VMware, Inc. 105