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
The following table describes the Amazon EC2 reservation types eld IDs that appear in the output schema
denitions.
Table 3‑11. Extension Fields Supported in Amazon Reservations
Field ID Data Type Type Class
Permissible
Value Depends on Field
securityGroups Entity Reference AmazonSecurityGroup Yes computeResource
locations Entity Reference AvailabilityZone Yes computeResource
loadBalancers Entity Reference ElasticLoadBalancer Yes computeResource and
locations
specicKeyPairs Entity Reference KeyPair Yes computeResource
and keyPairs
computeResource Entity Reference ComputeResource Yes NA
VPC Complex Type Infrastructure.Reservation
.Cloud.Amazon.VPC
Yes computeResource
machineQuota Integer NA No NA
keyPairs String ResourcePools Yes computeResource
Note The information in the table is subject to change. Call the data and schema service to retrieve the
latest eld information.
Input
Use the supported input parameters to control the command output.
Parameter Description
URL hps://$host/reservation-service/api/data-service/schema/$schemaclassid/default
Method Get
$host Species the host name and fully qualied domain name or IP address of the
vRealize Automation identity server.
$token Species a valid HTTP bearer token with necessary credentials.
$schemaclassid Species the schema class of the reservation type.
The schema class ID for an Amazon reservation is
Infrastructure.Reservation.Cloud.Amazon.
Each supported reservation type contains specic elds. The supported elds
are dened in the schema. For details, see the reservation service schema
denitions in the vRealize Automation API Reference in vRealize Automation
documentation.
Output
The command output contains property names and values based on the command input parameters.
Each eld contains an array of data rows. Each data row represents one of the elds dened in the schema.
Property Description
Id Species the unique identier of this resource.
label Species the eld label.
Programming Guide
148 VMware, Inc.