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
Table 3‑5. JSON Template Values (Continued)
Property Description
requestNumber Contains Get information that is generated by the system.
requestData Specifies other custom request data.
JSON Input File Template
Use the following JSON template to create a JSON text file that contains the information required to
reprovision a machine.
This example reprov_action.json file contains a resource action request for the reprovision action
(resourceActionRef and id) to be performed on the specified machine (resourceRef and id). The
organization content include the names and labels of the tenant and business group.
{
"@type": "ResourceActionRequest",
"resourceRef": {
"id": "b3adbe4f-274d-4a0c-8757-7843b8cb2ba4"
},
"resourceActionRef": {
"id": "a1caee9b-d67f-41e8-a7b3-131616a0f6ac"
},
"organization": {
"tenantRef": "MYCOMPANY",
"tenantLabel": "QETenant",
"subtenantRef": "eab762cb-6e75-4379-83ef-171a71c9f00e",
"subtenantLabel": "MyTestAgentBusinessGroup"
},
"state": "SUBMITTED",
"requestNumber": 0,
"requestData": {
"entries": []
}
}
Example: curl Command
The following example command calls the JSON text file and reprovisions a machine.
curl --insecure -H "Content-Type: application/json"
-H "Authorization: Bearer $token"
https://$host/catalog-service/api/consumer/requests --d @C:\reprov_action.json.txt
Working with Reservations
You can work with the REST API reservation service to perform a variety of functions, such as creating
and updating reservations.
Programming Guide
VMware, Inc. 130