Cloudbreak CLI Reference
Also available as:
PDF

cluster list

Lists all clusters which are currently associated with the Cloudbreak instance.

Required options

None

Options

--output [$VALUE] Supported formats: json, yaml, table (default: “json”) [$CB_OUT_FORMAT]

--server [$VALUE] Cloudbreak server address [$CB_SERVER_ADDRESS]

--username [$VALUE] Cloudbreak user name (e-mail address) [$CB_USER_NAME]

--password [$VALUE] Cloudbreak password [$CB_PASSWORD]

--workspace [$VALUE] Name of the workspace holding the resource

--profile [$VALUE] Selects a config profile to use [$CB_PROFILE]

--auth-type [$VALUE] Authentication method to use. Values: oauth2, basic [$CB_AUTH_TYPE]

Examples

Lists available clusters:

cb cluster list
[
  {
    "Name": "test1234",
    "Description": "",
    "CloudPlatform": "AZURE",
    "StackStatus": "UPDATE_IN_PROGRESS",
    "ClusterStatus": "REQUESTED"
  }
]

Lists available clusters, with output in a table format:

cb cluster list --output table
+----------+-------------+---------------+--------------------+---------------+
|   NAME   | DESCRIPTION | CLOUDPLATFORM |    STACKSTATUS     | CLUSTERSTATUS |
+----------+-------------+---------------+--------------------+---------------+
| test1234 |             | AZURE         | UPDATE_IN_PROGRESS | REQUESTED     |
+----------+-------------+---------------+--------------------+---------------+