VAST CLI Command Syntax

The VAST CLI commands follow this naming and syntax convention:

<command> <subcommand> --<argument1> <value1> --<argument2> <value2> ... --<argumentn> <valuen>

The <command> part of the command name is a type of object, such as a cluster, a user, or a virtual IP address. The <subcommand> part of the command name is an action to perform, such as list to display objects of the specified type, or create to create a new object of the specified type.

For example, the command vip with the subcommand list displays virtual IPs. The optional argument cnode-name can filter the list by a specific CNode. So, to display all virtual IPs of the CNode named cnode-1, the command vip, is entered with the subcommand list, and the optional argument cnode-name is specified with the value cnode-1:

vip list --cnode-name cnode-1

+-----------+--------------+---------+------------+
| VIP-Pool  | Virtual-IP   | CNode   | Cluster    |
+-----------+--------------+---------+------------+
| vippool-2 | 172.21.11.11 | cnode-1 | my-cluster |
| vippool-2 | 172.21.11.12 | cnode-1 | my-cluster |
| vippool-2 | 172.21.11.14 | cnode-1 | my-cluster |
| vippool-2 | 172.21.11.16 | cnode-1 | my-cluster |
| vippool-2 | 172.21.11.6  | cnode-1 | my-cluster |
+-----------+--------------+---------+------------+

This guide refers to commands in the format <command> <subcommand>.