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
n
Service Examples for Working with Reservations
Prerequisites for Working With Reservations
Satisfy the following conditions before performing any tasks for this use case.
n
Log in to vRealize Automation as a fabric group administrator.
n
Verify that the appliance name and fully qualified domain name of the vRealize Automation instance
are available.
n
Verify that you have a valid HTTP bearer token that matches your login credentials. See Chapter 2
REST API Authentication.
Create a Reservation
You use the reservation service REST API to create a vSphere, Amazon, or vCloud Air reservation.
Some of the steps required to create a reservation include commands that vary by reservation type.
When performing the step, select the command for your vSphere, Amazon, or vCloud Air reservation.
Procedure
1 Display a List of Supported Reservation Types
Use the reservation service to display a list of supported reservation types, such as vSphere,
Amazon EC2, or vCloud Air.
2 Displaying a Schema Definition for a Reservation
After you know the supported reservations types, you can display a schema definition for the
vSphere, Amazon EC2, or vCloud Air reservation.
3 Get the Business Group ID for a Reservation
You can use reservation service to get the business group ID for a vRealize Automation reservation.
The business group is also referred to as the subtenant in the API.
4 Get a Compute Resource for the Reservation
You can use the REST API reservation service to obtain compute resources for vRealize Automation
reservations.
5 Getting a Resources Schema by Reservation Type
You can use the vRealize Automation REST API to get a resources schema for any supported
reservation type, including a vSphere, Amazon EC2, or vCloud reservation.
6 Creating a Reservation By Type
You can use the vRealize Automation REST API to create any supported reservation type, including
a vSphere, Amazon EC2, or vCloud reservation.
7 Verify a Reservation and Get Reservation Details
After you create a reservation, you can use the reservation service along with reservation ID to verify
that the reservation exists. You can also use the ID to get information about the reservation in
preparation for updating or deleting it.
Programming Guide
VMware, Inc. 123