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
The password is masked for security purposes and does not appear in spring-shell.log.
vcac-cli>login --url https://vcac148-084-173.eng.vmware.com
--user administrator@vsphere.local < /tmp/password.txt
Suppress Log Files
The API Explorer updates the spring-shell history file spring-shell.log and the message file vcac-
cli.log in the vcac-cli_install/bin folder by default. You can suppress output to both of these files.
Prerequisites
n
Install the API Explorer, if necessary.
n
Your PATH environment variable must contain the location of the vcac-cli (UNIX) or vcac_cli.bat
(Windows) script.
Procedure
u
Run the following command.
$ vcac-cli --profiles nologging
Creating an API Explorer Command Using Supplied curl Examples
The command line syntax provided in the supplied use cases is for curl. You can use the supplied curl
command line syntax to create equivalent API Explorer command line syntax.
This document contains sample curl command statements to illustrate how to use various
vRealize Automation REST API service calls. The API Explorer is one of several command line interfaces
that are also available for using the vRealize Automation REST API services. While command line syntax
varies, the API Explorer uses the same input and output parameters as described in Chapter 3 REST API
Use Cases.
The following example illustrates a sample curl command and its equivalent API Explorer command. In
this example, the command is used to display machine details for a provisioned machine, where
resourceID is the ID of the provisioned machine .
Note Sample curl Command
curl --insecure -H "Content-Type: application/json"
-H "Authorization: Bearer $token”
https://$host/catalog-service/api/consumer/resources/resourceID
Note Equivalent API Explorer Command
rest get --service catalog-service --u /consumer/resources/resourceID
Programming Guide
VMware, Inc. 405