7.3
Table Of Contents
- Programming Guide
- Contents
- vRealize Automation Programming Guide
- Updated Information
- Overview of the vRealize Automation REST API
- REST API Authentication
- Creating a Tenant
- Prerequisites for Creating a Tenant
- Create a Tenant With Parameters Inline
- Create a Tenant With a JSON File
- Identity Service Examples for Creating 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
- Approving a Machine Request
- Listing Provisioned Resources
- Managing Provisioned Deployments
- Working with Reservations
- Prerequisites for 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
- Service Examples for Working with Reservations
- Syntax for Displaying a List of Reservations
- Syntax for Displaying a Schema Definition for a vSphere Reservation
- Syntax for Displaying a Schema Definition for an Amazon Reservation
- Syntax for Displaying a Schema Definition for a vCloud Air Reservation
- Syntax for Getting the Business Group ID for a Reservation
- Syntax for Getting a Compute Resource for a Reservation
- Syntax for Getting Resources Schema for a vSphere Reservation
- Syntax for Getting Resources Schema for an Amazon Reservation
- Syntax for Getting Resources Schema for a vCloud Air Reservation
- Syntax for Creating a vSphere Reservation
- Syntax for Creating an Amazon Reservation
- Syntax for Creating a vCloud Air Reservation
- Syntax for Verifying a Reservation and Getting Reservation Details
- Syntax for Displaying a List of Supported Reservation Types
- Syntax for Updating a Reservation
- Syntax for Deleting a Reservation
- Working with Reservation Policies
- Working with Key Pairs
- Working with Network Profiles
- Getting a List of Available IP Ranges
- Importing and Exporting Content
- Understanding Blueprint Schema
- Prerequisites for Importing and Exporting Content
- List Supported Content Types Example
- List Available Content Example
- Filter Content by Content Type Example
- Create a Package for Export Example
- List Packages in the Content Service Example
- Export a Package Example
- Validate a Content Bundle Before Importing example
- Import a Package Example
- Export XaaS Content Example
- Import XaaS Content Example
- Related Tools and Documentation
- Filtering and Formatting REST API Information
Parameter Description
$vRA Specifies the appliance name and fully qualified domain name, or IP
address of the vRealize Automation server.
$token Specifies a valid HTTP bearer token with necessary credentials.
Output
The command output contains property names and values based on the command input parameters.
Property Description
Links Specifies an array of link objects, each of which contains the following parts:
n
rel
Specifies 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
Specifies the application or service that determines the other names.
n
href
Specifies the URL that produces the result.
Content Specifies 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. Specifies the unique reservation policy ID.
n
name. Specifies the reservation policy name.
n
description. Specifies the reservation policy description.
reservationPolicyTypeId Specifies the type of reservation policy. Supported vRealize Automation reservation policy types are
Reservation.Policy.ComputeResource and Reservation.Policy.Storage.
Metadata Specifies the paging-related data:
n
Size. Specifies the maximum number of rows per page.
n
totalElements. Specifies the number of rows returned.
n
totalPages. Specifies the total number of pages of data available.
n
Number. Specifies the current page number.
n
Offset. Specifies the number of rows skipped.
Create a Reservation Policy Example
POST /api/reservations/policies creates a reservation policy.
curl Command
The following example command uses the reservation service to create a new reservation policy.
curl -X POST --insecure -H "Accept:application/json"
-H "Authorization: Bearer $token"
https://$vRA/reservation-service/api/reservations/policies -d “
{
Programming Guide
VMware, Inc. 284