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‑14. Extension Fields Supported in vCloud Reservations
Field ID Data Type Type Class
Permissible
Value Depends on Field
reservationNetworks Complex Type Infrastructure.Reservation.N
etwork
Yes computeResource
allocationModel Integer NA No NA
reservationMemory Complex Type Infrastructure.Reservation.M
emory
No NA
computeResource Entity Reference ComputeResource Yes NA
machineQuota Integer NA No NA
reservationStorages Complex Type Infrastructure.Reservation.St
orage
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 a vCloud 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.
$schemaclassid Specifies the schema class ID.
This example illustrates how to use the reservationStorages field of a vCloud
reservation type as an example. The schema class ID of a vCloud reservation is
Infrastructure.Reservation.Cloud.vCloud. For this example, the input value
for $schemaclassid is Infrastructure.Reservation.Cloud.vCloud.
$fieldId Specifies the field ID of the resource.
For example, the field ID for the reservation storage is reservationStorages. For
this example, the input value for $fieldId is reservationStorages.
HTTP body Contains information about dependencies.
Because the dependency of the permissible value field reservationStorages is
computeResource, you must include a dependency definition in the HTTP body.
text Empty
Programming Guide
VMware, Inc. 238