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‑8. Fields Common To All Reservation Types (Continued)
Parameter Description Parameter Type
subTenantId Species the subtenant ID that
contains the reservation.
GUID
enabled Species whether the reservation is
enabled.
Boolean
priority Species the priority of the
reservation during VM provisioning.
Integer
reservationPolicyId Species the reservation policy ID to
bind to this reservation.
GUID
alertPolicy Species the alert policy of the
reservation. The detail schema of this
eld refers to the alert policy.
JSON
extensionData Contains type-specic elds. The
detail schema of this eld is retrieved
by the data and schema service.
JSON
The following table describes the vSphere reservation types eld IDs that appear in the output schema
denitions.
Table 3‑9. Extension Fields Supported in vSphere Reservations
Field ID Data Type Type Class
Permissible
Value Depends on Field
reservationNetworks Complex Type reservationNetwork Yes computeResource
reservationVCNSTranspo
rtZone
Entity Reference NetworkScopes Yes computeResource
reservationVCNSSecurity
Groups
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
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.
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.
Programming Guide
128 VMware, Inc.