6.2
Table Of Contents
- Programming Guide
- Contents
- vRealize Automation Programming Guide
- Updated Information
- Overview of the vRealize Automation REST API
- REST API Authentication
- REST API Use Cases
- Create 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 By Type
- Request a Machine
- Syntax for Listing Shared and Private Catalog Items
- Syntax for Finding a Catalog Item by Name
- Syntax for Locating the Blueprint Values Required to Construct a Machine Request
- Syntax for Constructing a JSON File For a Machine Request
- Syntax for Requesting a Machine
- Syntax for Viewing All of Your Requests
- Syntax for Finding a Resource by its Request ID
- Syntax for Viewing the Details of a Machine Request
- Request a vCloud Air Machine
- Request an Amazon Machine
- Request a Machine
- Approve a Machine Request
- List Provisioned Resources
- Reprovision a Machine Resource
- 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
- Create a Reservation
- Working with Reservation Policies
- Working with Key Pairs
- Working with Network Profiles
- Create a Tenant
- Filtering and Formatting REST API Information
- Related Tools and Documentation
Process Overview
Use the following sequence to find a vCloud Air blueprint for use in creating a vCloud Air machine
request.
1 From the list of your entitled catalog items, find the catalog item that corresponds to the vCloud Air
blueprint to use for the request. You can search on the catalog item ID Infrastructure.vCloudAir
to locate a published vCloud Air blueprint.
2 In the catalog item output that contains a catalog item ID Infrastructure.vACloudAir entry, locate
the following entries that are required by the vCloud Air machine request:
n
Catalog item ID, for example c2cacf7c-b3c8-47fb-a938-2c09910b6713
n
Tenant reference, for example sqa.
n
Blueprint identifier (binding ID), for example 46548940-eb20-4368-9e73-c1685cda8c64.
n
Business group (subtenant ID), for example name1.
If the business group value is null, you do need to enter a business group value in the vCloud Air
machine request.
If the request information about a catalog item for which one is not entitled, or the blueprint catalog item is
not published, then the request is rejected.
Input
Use the supported input parameters to control the command output.
Property Description
&page Specifies a page number. Specifies the default value is 1.
?limit Specifies the number of entries displayed on a page. Specifies the default value is 10.
$orderby Specifies how the results are sorted and paginated.
$skip Specifies how many results to skip before computing pagination.
$filter Specifies a Boolean expression to define whether a particular entry be included in the
response. Each API supports a different set of filterable fields.
Output
The command output contains property names and values based on the command input parameters.
Property Description
version Displays the object version number.
id Specifies the unique identifier of this resource.
outputResourceTypeRef Specifies the type of the resource that results from requesting the catalog item.
name Specifies the user friendly name of the catalog item. Specifies the property type is string.
description Specifies a short description of the catalog item. Specifies the property type is string.
status Specifies the life cycle stage of the catalog item.
Programming Guide
VMware, Inc. 61