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
Parameter Description
$schemaclassid Specifies the schema class ID.
For a vSphere reservation, specify
Infrastructure.Reservation.Virtual.vSphere as the
$schemaclassid value.
For an Amazon EC2 reservation, specify
Infrastructure.Reservation.Cloud.Amazon as the the
$schemaclassid value.
For a vCloud reservation, specify
Infrastructure.Reservation.Cloud.vCloud as the the
$schemaclassid value.
$fieldId From the schema definition, specifies the schemaclassid of the compute
resource field, which is is computeResource.
Enter computeResource for the $fieldId value.
HTTP body Because the dependencies entry for this permissible value field is an
empty string, provide an empty JSON string "{}" in the HTTP body.
Output
The command output contains property names and values based on the command input parameters.
The values section contains an array of data rows, each of which represents one of the compute
resource objects, returned in a pageable list. Each compute resource object contains the following
information.
Property Description
underlyingValue Contains a JSON string representing one permissible value of field.
n
type
Specifies one of the following permissible value data types.
n
entityRef - Indicates that the object references a vRealize Automation entity.
n
complexRef - Indicates that the object is a user-defined complex structure, for example struct
in C or Pojo in Java.
n
primary - Indicates the entity type such as string, integer, and so on.
n
componentId
Specifies the component ID.
n
classId
Specifies the schema class ID of the current data type.
n
Id
Specifies the unique compute resource identifier.
label Contains the compute resource label. This value matches the underlyingValue.label.
Programming Guide
VMware, Inc. 224