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
Contents
vRealize Automation Programming Guide 5
Updated Information 6
1
Overview of the vRealize Automation REST API 7
2
REST API Authentication 9
Using HTTP Bearer Tokens 9
Configure the Duration of an HTTP Bearer Token 9
Request an HTTP Bearer Token 10
Validate an HTTP Bearer Token 13
Delete an HTTP Bearer Token 13
3
REST API Use Cases 15
Create a Tenant 15
Syntax for Displaying Your Current Tenants 18
Syntax for Requesting a New Tenant 20
Syntax for Listing All Tenant Identity Stores 23
Syntax for Linking an Identity Store to the Tenant 26
Syntax for Searching LDAP or Active Directory for a User 30
Syntax for Assigning a User to a Role 32
Syntax for Displaying all Roles Assigned to a User 32
Requesting a Machine By Type 35
Request a Machine 35
Request a vCloud Air Machine 59
Request an Amazon Machine 75
Approve a Machine Request 91
Syntax for Listing Work Items 92
Syntax for Getting Work Item Details 98
Syntax for Constructing a JSON File to Approve a Machine Request 103
Syntax for Approving a Submitted Machine Request 106
List Provisioned Resources 108
Syntax for Displaying Your Provisioned Resources 109
Syntax for Displaying Provisioned Resources by Resource Type 111
Syntax for Displaying All Available Resource Types 114
Syntax for Displaying Provisioned Resources by Business Groups You Manage 116
Syntax for Viewing Machine Details 123
VMware, Inc.
3