Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 87. workbook

This chapter describes the commands under the workbook command.

87.1. workbook create
Copy link

Create new workbook.

Usage:

openstack workbook create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--public]
                                 [--namespace [NAMESPACE]]
                                 definition
Copy to Clipboard Toggle word wrap

Expand
Table 87.1. Positional arguments
ValueSummary

definition

Workbook definition file

Expand
Table 87.2. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--public

With this flag workbook will be marked as "public".

--namespace [NAMESPACE]

Namespace to create the workbook within.

Expand
Table 87.3. Output formatter options
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Expand
Table 87.4. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 87.5. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Expand
Table 87.6. Table formatter options
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

87.2. workbook definition show
Copy link

Show workbook definition.

Usage:

openstack workbook definition show [-h] name
Copy to Clipboard Toggle word wrap

Expand
Table 87.7. Positional arguments
ValueSummary

name

Workbook name

Expand
Table 87.8. Command arguments
ValueSummary

-h, --help

Show this help message and exit

87.3. workbook delete
Copy link

Delete workbook.

Usage:

openstack workbook delete [-h] [--namespace [NAMESPACE]]
                                 workbook [workbook ...]
Copy to Clipboard Toggle word wrap

Expand
Table 87.9. Positional arguments
ValueSummary

workbook

Name of workbook(s).

Expand
Table 87.10. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--namespace [NAMESPACE]

Namespace to delete the workbook(s) from.

87.4. workbook list
Copy link

List all workbooks.

Usage:

openstack workbook list [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--noindent] [--max-width <integer>]
                               [--fit-width] [--print-empty]
                               [--sort-column SORT_COLUMN] [--marker [MARKER]]
                               [--limit [LIMIT]] [--sort_keys [SORT_KEYS]]
                               [--sort_dirs [SORT_DIRS]] [--filter FILTERS]
Copy to Clipboard Toggle word wrap

Expand
Table 87.11. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--marker [MARKER]

The last execution uuid of the previous page, displays list of executions after "marker".

--limit [LIMIT]

Maximum number of entries to return in a single result.

--sort_keys [SORT_KEYS]

Comma-separated list of sort keys to sort results by. Default: created_at. Example: mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

Comma-separated list of sort directions. default: asc. Example: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

Filters. can be repeated.

Expand
Table 87.12. Output formatter options
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 87.13. CSV formatter options
ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Expand
Table 87.14. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 87.15. Table formatter options
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

87.5. workbook show
Copy link

Show specific workbook.

Usage:

openstack workbook show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--namespace [NAMESPACE]]
                               workbook
Copy to Clipboard Toggle word wrap

Expand
Table 87.16. Positional arguments
ValueSummary

workbook

Workbook name

Expand
Table 87.17. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--namespace [NAMESPACE]

Namespace to get the workbook from.

Expand
Table 87.18. Output formatter options
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Expand
Table 87.19. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 87.20. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Expand
Table 87.21. Table formatter options
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

87.6. workbook update
Copy link

Update workbook.

Usage:

openstack workbook update [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--namespace [NAMESPACE]]
                                 [--public]
                                 definition
Copy to Clipboard Toggle word wrap

Expand
Table 87.22. Positional arguments
ValueSummary

definition

Workbook definition file

Expand
Table 87.23. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--namespace [NAMESPACE]

Namespace to update the workbook in.

--public

With this flag workbook will be marked as "public".

Expand
Table 87.24. Output formatter options
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Expand
Table 87.25. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 87.26. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Expand
Table 87.27. Table formatter options
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

87.7. workbook validate
Copy link

Validate workbook.

Usage:

openstack workbook validate [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   definition
Copy to Clipboard Toggle word wrap

Expand
Table 87.28. Positional arguments
ValueSummary

definition

Workbook definition file

Expand
Table 87.29. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 87.30. Output formatter options
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Expand
Table 87.31. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 87.32. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Expand
Table 87.33. Table formatter options
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat