Cloudbreak CLI Reference
Also available as:
PDF

recipe describe

Describes an existing recipe.

Required options

--name [$VALUE] Recipe name

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

Describes a recipe called “test”:

cb recipe describe --name test
{
  "Name": "test",
  "Description": "",
  "ExecutionType": "POST"
}

Describes a recipe called “test”, with output presented in a table format:

cb describe-recipe --name test --output table
+------+-------------+----------------+------+
| NAME | DESCRIPTION | EXECUTION TYPE |  ID  |  
+------+-------------+----------------+------+
| test |             | POST           | 1810 |
+------+-------------+----------------+------+