7.2
Table Of Contents
- Programming Guide
- Contents
- vRealize Automation Programming Guide
- 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
- Request a Machine
- Approve a Machine Request
- List Provisioned Resources
- Manage Provisioned Deployments
- 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
- Get a List of Available IP Ranges for an IPAM Provider
- Import and Export Content
- Syntax for Listing Supported Content Types
- Syntax for Listing Available Content
- Syntax for Filtering Content by Content Type
- Syntax for Creating a Package for Export
- Syntax for Listing Packages in the Content Service
- Syntax for Exporting a Package
- Syntax for Validating a Content Bundle Before Importing
- Syntax for Importing a Package
- Understanding Blueprint Schema
- Manage XaaS Content with Import and Export
- Create a Tenant
- Related Tools and Documentation
- Filtering and Formatting REST API Information
- Index
Property Description
Links Species an array of link objects, each of which contains the following parts:
n
rel
Species the name of the link.
n
Self refers to the object which was returned or requested.
n
First, Previous, Next, and Last refer to corresponding pages of pageable lists.
n
Species the application or service that determines the other names.
n
href
Species the URL that produces the result.
Content Species an array of data rows, each of which represents one of the tenant objects returned in a
pageable list. Each tenant object contains the following information:
n
@type. Contains the ReservationPolicy string.
n
id. Species the unique reservation policy ID.
n
name. Species the reservation policy name.
n
description. Species the reservation policy description.
reservationPolicyTypeI
d
Species the type of reservation policy. Supported vRealize Automation reservation policy
types are Reservation.Policy.ComputeResource and Reservation.Policy.Storage.
Metadata Species the paging-related data:
n
Size. Species the maximum number of rows per page.
n
totalElements. Species the number of rows returned.
n
totalPages. Species the total number of pages of data available.
n
Number. Species the current page number.
n
Oset. Species the number of rows skipped.
Example: curl Command
List all available reservation policies.
curl --insecure -H "Accept:application/json"
-H "Authorization: Bearer $token"
https://$host/reservation-service/api/reservations/policies
Example: JSON Output
The following example output lists two reservation policies, named reservationPolicyTest and
reservationPolicyTest2. Use the id value for each reservation policy to update or delete them. See “Syntax
for Updating a Reservation Policy,” on page 272and “Syntax for Deleting a Reservation Policy Syntax,” on
page 274.
{
"links": [],
"content": [{
"@type": "ReservationPolicy",
"id": "8adafb54-4c85-4478-86f0-b6ae80ab5ca4",
"name": "reservationPolicyTest",
"description": "reservationPolicyDescTest",
"reservationPolicyTypeId": "Infrastructure.Reservation.Policy.ComputeResource"
},
{
"@type": "reservationPolicy",
"id": "fdd9854b-012e-41d7-ad17-fc73d4395714",
"name": "reservationPolicyTest2",
"description": "reservationPolicyDescTest2",
"reservationPolicyTypeId": "Infrastructure.Reservation.Policy.Storage"
}],
Chapter 3 REST API Use Cases
VMware, Inc. 267