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‑6. HATEOAS Link Functions as Defined by rel Field
Link Description
GET: Parent Resource
URI to get the resourceView for the parent item. See “Syntax for
Geing Deployment Details,” on page 89.
GET:Template
{com.vmware.csp.component.cafe.composition@res
ource.action.deployment.$actionName
URI to get a template request for a specic action that you can
perform on this resource.
POST:
{com.vmware.csp.component.cafe.composition@res
ource.action.deployment.$actionName
URI to which to post the request to perform an action, based on the
corresponding template.
Input
Use the supported input parameters to control the command output.
Parameter Description
URL hps://$host/catalog-service/api/consumer/resources/$resourceId
$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.
$resourceID Species a resource ID. See “Syntax for Geing Deployment Details,” on page 89 to
view all of your requests and search for a request ID.
managedOnly If true, the returned requests are from the user's managed subtenants.
page Species a page number.
limit Species the number of entries to display on a page.
$orderby Species how to order multiple comma-separated properties sorted in ascending or
descending order.
$top Species the number of returned entries from the top of the response (total number per
page in relation to skip).
$skip Species the number of entries to skip.
lter Contains a Boolean expression to determine if a particular entry is included in the
response.
Output
The command output contains property names and values based on the command input parameters.
Table 3‑7. Output Parameters
Property Description
resourceId The unique identier of the resource.
iconId Species an icon for this request based on the requested object type.
name The user friendly name of the resource.
description An extended user friendly description of the resource.
status The status of the resource. For example, On, O, etc.
catalogItemId The identier of the catalog item associated with this provisioned resource.
catalogItemLabel The label of the catalog item associated with this provisioned resource.
requestId The unique identier of the request that created this provisioned resource.
Chapter 3 REST API Use Cases
VMware, Inc. 93