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
Table 3‑14. Extension Fields Supported in vSphere Reservations (Continued)
Field ID Data Type Type Class
Permissible
Value Depends on Field
resourcePool Entity Reference ResourcePools Yes computeResource
reservationVCNSRouted
Gateways
Complex Type reservationVCNSRoutedG
ateway
Yes computeResource
Note The information in the table is subject to change. Call the data and schema service to retrieve the
latest eld information.
For related information, see “Syntax for Displaying a Schema Denition for a vSphere Reservation,” on
page 127.
Input
Use the supported input parameters to control the command output.
Input Description
URL hps://$host/reservation-service/api/data-
service/schema/$schemaclassid/default/$eldid/values
Method Post
$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 ID.
This example illustrates how to use the resourcePool eld of a vSphere reservation
type as an example. The schema class ID of a vSphere reservation is
Infrastructure.Reservation.Virtual.vSphere. For this example, the input
value for $schemaclassid is Infrastructure.Reservation.Virtual.vSphere.
$eldId Species the eld ID of the resource.
For example, the eld ID for the resource pool is resourcePool. For this example, the
input value for $eldId is resourcePool.
HTTP body Contains information about dependencies.
Because the dependency of this permissible value eld is computeResource, you
must provide a dependency denition in the HTTP body.
Output
The command output contains property names and values based on the command input parameters.
Property Description
values An array of data rows, each of which represents one of the resource pool objects
returned in a pageable list. Each resource pool object contains an underlyingValue and
label entry.
underlyingValue JSON string representing one permissible value for a eld:
n
type -- data type of entityRef, complexRef, or primary
n
component ID -- componentID
n
classId -- schema class ID of current data type
n
id -- unique resource pool ID
n
label -- resource pool label
label
Species the resource pool label. This value matches the underlyingValue value.
Chapter 3 REST API Use Cases
VMware, Inc. 195