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
Property Description
quote Contains a quote made by the provider defining the estimated cost(s) associated with the
request and/or any resources provisioned as a result of the request.
requestCompletion Contains additional request completion information.
requestData Contains a map of the provider-specific field-value pairs collected for this request.
retriesRemaning Specifies the number of attempts remaining to move this request from its current state to the
next state in the request workflow.
Some state transitions require calls to external services. These calls may fail due to transient
errors such as momentary network errors. In these cases, the catalog will retry the call a
number of times before failing.
This property defines the number of retries remaining for the current state transition. When it
reaches 0, the catalog will stop retrying and mark the request as failed. This property is reset to
the default number of retries for every new operation that is triggered.
requestedItemName Specifies the item name.
requestedItemDescription Specifies the item description.
Example: curl Command
The following example command checks the status of an Amazon machine request where 25211c6c-
f09d-4e2b-9be4-7b09c47c9f6c is the value of the request ID.
curl --insecure -H "Content-Type: application/json"
-H "Authorization: Bearer $token"
https://$host/catalog-service/api/consumer/requests/25211c6c-f09d-4e2b-9be4-7b09c47c9f6c
Example: JSON Output
The following JSON output is returned based on the command input.
{
"@type" : "CatalogItemRequest",
"id" : "25211c6c-f09d-4e2b-9be4-7b09c47c9f6c",
"iconId" : "cafe_default_icon_genericCatalogItem",
"version" : 5,
"requestNumber" : 14,
"state" : "SUCCESSFUL",
"description" : "CLI EC2 description",
"reasons" : "CLI EC2 reason",
"requestedFor" : "Auto.admin@abx.local",
"requestedBy" : "Auto.admin@abx.local",
"organization" : {
"tenantRef" : "sqa",
"tenantLabel" : "SQA",
"subtenantRef" : "b475039a-94dd-4bf3-97f6-8596f8cf8818",
"subtenantLabel" : "Business Group"
},
"requestorEntitlementId" : "04f4588f-548a-4bc6-baf8-c22241918322",
"preApprovalId" : null,
"postApprovalId" : null,
"dateCreated" : "2014-09-11T22:29:02.190Z",
Programming Guide
VMware, Inc. 89