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
Default if unspecified: '__NULL__'
Keyword: u
Keyword: uri
Help: URI of resource. e.g. consumer/catalogItems
Mandatory: true
Default if specified: '__NULL__'
Default if unspecified: '__NULL__'
Keyword: h
Keyword: headers
Help: Show request and response headers
Mandatory: false
Default if specified: 'true'
Default if unspecified: 'false'
* rest get - Invoke a GET http request
Use the Command Line Mode
The command line mode lets you incorporate vcac-cli commands in other scripts and programs.
You can invoke any supported vcac-cli command and option, including help.
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
1 Enter the command string on the vcac-cli command line.
$ vcac-cli command_string
The output is displayed on the stderr stream.
2 (Optional) You can redirect the output to a file in Linux or Windows.
$ vcac-cli system properties 2> output.txt
Example: Run vcac-cli commands in the command line
$ vcac-cli system properties
app.home = /Users/myusername/vcac/cli/shell/target/appassembler
app.name = vcac-cli
app.pid = 12444
app.repo = /Users/myusername/vcac/cli/shell/target/appassembler/repo
. . .
Programming Guide
VMware, Inc. 402