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
Syntax for Locating the Blueprint Values Required to Construct a Machine
Request
You can find the blueprint values you need to complete a machine request by listing your entitled catalog
items, and then locating the catalog item that corresponds to the machine blueprint.
Shared and Private Catalog Items
n
In the list of catalog items requested, locate the catalog item that corresponds to the machine
blueprint. Refer the sample catalog item output in the example.
n
The following attributes and their values are available in the catalog item output. The actual values
are required for the machine request.
Table 3‑1. Attribute Values
Attribute Sample Value Description
id 65fbca06-a28e-46f3-bced-
c6e5fb3a66f9
Catalog item ID
tenant Ref MYCOMPANY Tenant name
subtenantRef cccd7a7e-5283-416b-
beb0-45eb4e924dcb
Business group ID
bindingId e16edcf9-6a10-4bc7-98e2-
a33361aeb857
Machine blueprint ID
Excerpt from Sample Catalog Item Output
...
"@type" : "CatalogItem",
"id" : "65fbca06-a28e-46f3-bced-c6e5fb3a66f9",
"version" : 1,
"name" : "RHEL 6-vsphere",
"description" : "",
"status" : "PUBLISHED",
"organization" : {
"tenantRef" : "MYCOMPANY",
"tenantLabel" : "QETenant",
"subtenantRef" : "cccd7a7e-5283-416b-beb0-45eb4e924dcb",
"subtenantLabel" : "MyTestAgentBusinessGroup"
},
"providerBinding" : {
"bindingId" : "e16edcf9-6a10-4bc7-98e2-a33361aeb857",
"providerRef" : {
"id" : "c6fb1980-75b4-4adc-ac71-020d75f61978",
"label" : "iaas-service"
}
},
...
Programming Guide
VMware, Inc. 43