airshipctl/docs/source/cli/airshipctl_cluster_list.md
Sirisha Gopigiri d13d15f453 Cluster- updating cmd files for documentation
The description and examples are updated for the airshipctl
commands, which will be inturn used for generating documentation.
Please ignore the .md file changes in this PS. They are added for zuul
gates to pass. Here is the PS with generated documention
files https://review.opendev.org/c/airship/airshipctl/+/789250

Relates-To: #280
Change-Id: I7c088528842ff859f502d4484ff9a3847ebb1177
2021-05-07 19:23:55 +05:30

891 B

airshipctl cluster list

Airshipctl command to get and list defined clusters

Synopsis

Retrieve and list the defined clusters in the table form or display just the name as specified.

airshipctl cluster list [flags]

Examples


Retrieve list of clusters
# airshipctl cluster list --airshipconf /tmp/airconfig
# airshipctl cluster list -o table
# airshipctl cluster list -o name

Options

  -h, --help            help for list
  -o, --output string   output formats. Supported options are 'table' and 'name' (default "name")

Options inherited from parent commands

      --airshipconf string   Path to file for airshipctl configuration. (default "$HOME/.airship/config")
      --debug                enable verbose output

SEE ALSO