Cloudbreak CLI Reference
Also available as:

cluster describe

Describes an existing cluster.

Required options

--name [$VALUE] Cluster name


--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]


Returns a JSON file describing an existing cluster called “test1234”:

cb cluster describe --name test1234

The command returns JSON output which due to space limitation was not captured in the example.