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
Requesting a Machine By Type
You can use the REST API catalog service to request a machine by type.
Your vRealize Automation API calls vary slightly based on your intended machine type.
For information about requesting a machine by using the vRealize Automation application user interface,
see the IaaS Configuration documentation.
Request a Machine
You can use a sequence of Rest API catalog service commands to request a machine. This procedure
provides sample command line syntax to request a machine. Supporting information regarding available
input and output parameters, command-line entry samples, and sample JSON output samples is
available in the following reference topics.
This procedure provides sample command line syntax for approving a machine request. Supporting
information regarding available input and output parameters, command-line entry samples, and sample
JSON output samples is available.
Prerequisites
n
Log in to vRealize Automation as a consumer and current business group user.
n
Verify that the host name and fully qualified domain name of the vRealize Automation instance are
available.
n
If you are not using the API Explorer, verify that you have a valid HTTP bearer token that matches
your login credentials. See Chapter 2 REST API Authentication.
Procedure
1 List all shared catalog items in the catalog.
curl --insecure -H "Content-Type: application/json"
-H "Authorization: Bearer $token”
https://$host/catalog-service/api/consumer/entitledCatalogItems
2 Locate the details of a specific catalog item by name.
curl --insecure -H "Content-Type: application/json" -H "Authorization: Bearer $token”
https://$host/catalog-service/api/consumer/entitledCatalogItems
3 Locate the blueprint values to complete a machine request by listing the entitled catalog items, and
then locating the catalog item that corresponds to the machine blueprint.
4 Create a JSON file that contains the blueprint values to construct a machine request.
a Open a text editor and create a file, for example, request.json.
b Save the file with any valid file name and file extension, for example, request.json.
Programming Guide
VMware, Inc. 35