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
"outputResourceTypeRef" : {
"id" : "Infrastructure.Cloud",
"label" : "Cloud Machine"
}
} ],
"metadata" : {
"size" : 10,
"totalElements" : 1,
"totalPages" : 1,
"number" : 1,
"offset" : 0
}
}
Syntax for Constructing a JSON File for an Amazon Machine Request
You can use the vRealize Automation REST API catalog service to request a machine by using a
published Amazon blueprint, the resource values specified in the blueprint, and a JSON input file
containing request data such as your user name and business group ID.
Prerequisites
n
Obtain the information that you need to add to your JSON file. See Syntax for Finding the Published
Amazon Blueprint for a Machine Request.
n
Use an XML editor to create your JSON file.
Example: JSON Input File
Use the following JSON input file sample when constructing a file.
Populate all the highlighted value equivalents from the following example JSON file when you create a
JSON input file.
{
"@type": "CatalogItemRequest",
"catalogItemRef": {
"id": "6cca9fd9-83b7-4f5d-8884-fb8a005fc656"
},
"organization": {
"tenantRef": "abx",
"subtenantRef": "b475039a-94dd-4bf3-97f6-8596f8cf8818"
},
"requestedFor": "Auto.admin@abx.local",
"state": "SUBMITTED",
"requestData": {
"entries": [{
"key": "provider-blueprintId",
"value": {
"type": "string",
"value": "1701645d-7e43-479f-930c-fbef58d13d50"
}
},
{
Programming Guide
VMware, Inc. 80