The easiest way to use and learn the vRealize Automation API Explorer is with the interactive mode.

About this task

Every command you type in interactive mode is appended to the spring-shell.log file in your current folder. This file retains a history of commands you have issued. It also serves as an example of what a CLI Script File looks like. While using this mode, you can navigate your command history by pressing the up-arrow and down-arrow keys on your keyboard.

The vcac-cli supports tab auto-completion and context-sensitive help on both Windows and UNIX. For example, if you enter rest g and then press the Tab key, the command expands to rest get. If you press the Tab key again, vcac-cli displays all options for the command. See the following examples.

vcac-cli>rest
Rest delete	rest get	rest post	rest put

vcac-cli>rest get --
Rest get --service	rest get --u	rest get --uri

vcac-cli>rest get --f
rest get --f	rest get --format

vcac-cli>rest get --format
rest get --format
optional – format: format (JSON, table raw, …); default: ‘JSON’

vcac-cli>rest get --format
JSON	compactTable	raw	solidBorderTable	table

Prerequisites

  • Install the API Explorer, if necessary.

  • 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__'
       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