CLI - Script Mode

In Avi Vantage 16.3, a set of CLI enhancements are introduced with the following in mind:

  • Easy automation using the CLI
  • Search for specific keywords in the configuration using the CLI
  • Quick cut-and-paste to make modifications or resolve some issues with the CLI

A new CLI mode, script, is introduced in 16.3. In the script mode, the input and output of the CLI command is expected to be in a YAML format. This is a direct conversion of what is presented in the API input and output as JSON into YAML. YAML was chosen for presentation as it offers an easier interaction without having to worry about the syntax such as comma, quotes, curly braces, etc. It is easier to work with YAML primarily for cut-and-paste and incremental changes to an existing object. Multi-line configuration of object uses a bash heredoc style. You can find more information on this under https://en.wikipedia.org/wiki/Here_document.

terminal mode script
show pool p1
name: p1
server_count: 3
servers:
- hostname: 1.1.1.1
ip:
addr: 1.1.1.1
type: V4
- hostname: 2.2.2.2
ip:
addr: 2.2.2.2
type: V4
tenant_ref: https://localhost/api/tenant/admin
uuid: pool-b0cb56dc-cc24-4b87-9d19-7bf790d2e582

Configuration using the Script mode

configure pool p1 << END
name: p1
server_count: 3
servers:
- hostname: 1.1.1.1
ip:
addr: 1.1.1.1
type: V4
- hostname: 2.2.2.2
ip:
addr: 2.2.2.2
type: V4
- hostname: 3.3.3.3
ip:
addr: 3.3.3.3
type: V4
tenant_ref: https://localhost/api/tenant/admin
uuid: pool-b0cb56dc-cc24-4b87-9d19-7bf790d2e582
END
Updating an existing object
name: p1
server_count: 3
servers:
- hostname: 1.1.1.1
ip:
addr: 1.1.1.1
type: V4
- hostname: 2.2.2.2
ip:
addr: 2.2.2.2
type: V4
- hostname: 3.3.3.3
ip:
addr: 3.3.3.3
type: V4
tenant_ref: https://localhost/api/tenant/admin
uuid: pool-b0cb56dc-cc24-4b87-9d19-7bf790d2e582

Updated: 2017-09-22 01:37:55 +0000