6.2
Table Of Contents
- Programming Guide
- Contents
- vRealize Automation Programming Guide
- Updated Information
- 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
- Requesting a Machine By Type
- Request a Machine
- Syntax for Listing Shared and Private Catalog Items
- Syntax for Finding a Catalog Item by Name
- Syntax for Locating the Blueprint Values Required to Construct a Machine Request
- Syntax for Constructing a JSON File For a Machine Request
- Syntax for Requesting a Machine
- Syntax for Viewing All of Your Requests
- Syntax for Finding a Resource by its Request ID
- Syntax for Viewing the Details of a Machine Request
- Request a vCloud Air Machine
- Request an Amazon Machine
- Request a Machine
- Approve a Machine Request
- List Provisioned Resources
- Reprovision a Machine Resource
- 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
- Create a Tenant
- Filtering and Formatting REST API Information
- Related Tools and Documentation
Get Resources Schema for an Amazon EC2 Reservation Syntax
You can display resource schema, such as storage and network information, for an Amazon EC2
reservation by using the data and schema service.
Overview
This example illustrates how to get a permissible value list for the securityGroups field. You can use the
generated output as input for creating or updating an Amazon EC2 reservation.
Table 3‑13. 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
specificKeyPairs Entity Reference KeyPair Yes computeResource
and keyPairs
computeResource Entity Reference ComputeResource Yes NA
VPC Complex Type Infrastructure.Reservation.Cl
oud.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 field information.
For related information, see Syntax for Displaying a Schema Definition for an Amazon Reservation.
Input
Use the supported input parameters to control the command output.
Parameter Description
URL https://$host/reservation-service/api/data-
service/schema/$schemaclassid/default/$fieldid/values
Method Post
$host Specifies the host name and fully qualified domain name or IP address of
the vRealize Automation identity server.
$token Specifies a valid HTTP bearer token with necessary credentials.
Programming Guide
VMware, Inc. 233