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
Table 3‑7. Extension Fields Supported in vSphere Reservations
Field ID Data Type Type Class
Permissible
Value Depends on Field
reservationNetworks Complex Type reservationNetwork Yes computeResource
reservationVCNSTransportZ
one
Entity Reference NetworkScopes Yes computeResource
reservationVCNSSecurityGr
oups
Entity Reference SecurityGroups Yes computeResource
reservationMemory Complex Type reservationMemory Yes computeResource
computeResource Entity Reference ComputeResource Yes NA
machineQuota Integer N/A No NA
reservationStorages Complex Type reservationStorage Yes computeResource
resourcePool Entity Reference ResourcePools Yes computeResource
reservationVCNSRoutedGat
eways
Complex Type reservationVCNSRoutedGat
eway
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://$host/reservation-service/api/data-service/schema/$schemaclassid/default
Method Get
$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.
$schemaclassid Specifies the schema class of the reservation type.
The schema class ID for a vSphere reservation is
Infrastructure.Reservation.Virtual.vSphere.
Each supported reservation type contains specific fields. The supported fields are
defined in the schema. For details, see the reservation service schema definitions in
the REST API Reference in the vRealize Automation documentation center.
Output
The command output contains property names and values based on the command input parameters.
Each field contains an array of data rows. Each data row represents one of the fields defined in the
schema.
Programming Guide
VMware, Inc. 160