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
Parameter Description
$token Species a valid HTTP bearer token with necessary credentials.
$schemaclassid Species 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 specic elds. The supported elds
are dened in the schema. For details, see the reservation service schema
denitions in the vRealize Automation API Reference in the vRealize Automation
documentation center.
Output
The command output contains property names and values based on the command input parameters.
Each eld contains an array of data rows. Each data row represents one of the elds dened in the schema.
Property Description
Id Species the unique identier of this resource.
label Species the eld label.
dataType Species the dataType eld value:
n
type: Species the eld value type:
n
Self refers to the object that was returned or requested.
n
First, Previous, Next, and Last refer to corresponding pages of a pageable
list.
n
Species the application or service that determines the other names.
n
componentTypeid:
Species the type ID of the component.
n
component:
Species the unique identier of the component.
n
classId:
Species the schema class of the eld
This property is valid for complex and ref eld types only.
n
label:
Species the label of the eld data type.
displayAdvice Contains display advice for the eld. This property is valid for a user interface element
only.
permissibleValues Optional eld. If this eld is a permissible value list eld, dene the meta info for the
permissible value by using the following options:
n
type:
Species if the permissible value list is dynamic or static.
n
customAllowed:
Species if a custom value is allowed during user input in this eld.
n
dependencies:
Species the list of elds that the current eld depends on.
Chapter 3 REST API Use Cases
VMware, Inc. 129