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
requestedItemName Specifies the item name.
requestedItemDescription Specifies the item description.
Example: curl Command
The following example command submits a request that includes the specifications in an
ec2machine_specific.json input file.
curl --insecure -H "Content-Type: application/json"
-H "Authorization: Bearer $token"
https://$host/catalog-service/api/consumer/requests --data @ec2machine_specific.json
Example: JSON Output
The following JSON output is returned based on the command input.
The highlighted URL in the following sample indicates the location and ID of the vRealize Automation
request.
Request Headers
{
Accept = application/json
Content-Type = application/json
Content-Length = 1347
Accept-Charset = big5, big5-hkscs, ...
}
Response Headers
{
Date = Tue, 11 Oct 2014 22:28:35 GMT
ETag = "0"
Location = https://abx148-084-124.eng.mycompany.com/catalog-
service/api/consumer/requests/25211c6c-f09d-4e2b-
9be4-7b09c47c9f6c
Content-Type = application/json;charset=UTF-8
Content-Length = 0
Vary = Accept-Encoding,User-Agent
Keep-Alive = timeout=15, max=100
Connection = Keep-Alive
}
null
Syntax for Viewing the Details of an Amazon Machine Request
You can use the REST API catalog service to check the status of your Amazon EC2 Machine request.
Input
Use the supported input parameters to control the command output.
Programming Guide
VMware, Inc. 87