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
Table 8‑5. Fields Common To All Reservation Types (Continued)
Parameter Description
Parameter
Type
subTenantId Specifies the subtenant ID that contains the reservation. GUID
enabled Specifies whether the reservation is enabled. Boolean
priority Specifies the priority of the reservation during VM provisioning. Integer
reservationPolicyId Specifies the reservation policy ID to bind to this reservation. GUID
alertPolicy Specifies the alert policy of the reservation. The detail schema of this field refers to the
alert policy.
JSON
extensionData Contains type-specific fields. The detail schema of this field is retrieved by the data and
schema service.
JSON
The following table describes the vCloud Air reservation types field IDs that appear in the output schema
definitions.
Table 8‑6. Extension Fields Supported in vCloud Reservations
Field ID Data Type Type Class
Permissible
Value Depends on Field
reservationNetworks Complex Type Infrastructure.Reservation.N
etwork
Yes computeResource
allocationModel Integer NA No NA
reservationMemory Complex Type Infrastructure.Reservation.M
emory
No NA
computeResource Entity Reference ComputeResource Yes NA
machineQuota Integer NA No NA
reservationStorages Complex Type Infrastructure.Reservation.St
orage
Yes computeResource
Note The information in the table is subject to change. Call the data and schema service to retrieve the
latest field information.
Input
Use the supported input parameters to control the command output.
Parameter Description
URL https://$vRA/reservation-service/api/data-service/schema/$schemaclassid/default
Method Get
$vRA Specifies the appliance name and fully qualified domain name, or IP address of the
vRealize Automation server.
Programming Guide
VMware, Inc. 222