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
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 (UNIX) In a shell, entervcac-cli or sh bin/vcac-cli.
2 (Windows) In a Command Prompt window, enter vcac-cli.bat.
The vcac-cli banner appears.
3 (Optional) Enter the help command for a list of supported commands.
vcac-cli>help
* ! - Allows execution of operating system (OS) commands.
* */ - End of block comment
* /* - Start of block comment
* // - Inline comment markers (start of line only)
* ; - Inline comment markers (start of line only)
* date - Displays the local date and time
* exit - Exits the shell
* help - list all commands usage
* login - Open a secure session to a VCAC server
* output - Set the command output parameters
* quit - Exits the shell
* rest delete - Invoke a DELETE http request
* rest get - Invoke a GET http request
* rest post - Invoke a POST http request
* rest put - Invoke a PUT http request
* script - Parses the specified resource file and executes its commands
* services - Displays a list of available services
* system properties - Shows the shell's properties
vcac-cli>
4 (Optional) Enter help command_name for verbose help on the command.
vcac-cli>help rest get
Keyword: rest get
Description: Invoke a GET http request
Keyword: s
Keyword: sessionid
Help: Session identifier
Mandatory: false
Default if specified: '__NULL__'
Default if unspecified: '__NULL__'
Keyword: ** default **
Keyword: service
Help: Name of the Service hosting the URI. e.g. catalog-service
Mandatory: true
Default if specified: '__NULL__'
Programming Guide
VMware, Inc. 401