Chapter 90. workbook


This chapter describes the commands under the workbook command.

90.1. workbook create

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 90.1. Positional Arguments
ValueSummary

definition

Workbook definition file

Expand
Table 90.2. Optional 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 90.3. Output Formatters
ValueSummary

output formatter options-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 90.4. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 90.5. Shell Formatter
ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Expand
Table 90.6. Table Formatter
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.

90.2. workbook definition show

Show workbook definition.

Usage:

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

Expand
Table 90.7. Positional Arguments
ValueSummary

name

Workbook name

Expand
Table 90.8. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

90.3. workbook delete

Delete workbook.

Usage:

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

Expand
Table 90.9. Positional Arguments
ValueSummary

workbook

Name of workbook(s).

Expand
Table 90.10. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--namespace [NAMESPACE]

Namespace to delete the workbook(s) from.

90.4. workbook list

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 90.11. Optional 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 90.12. Output Formatters
ValueSummary

output formatter options-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 90.13. CSV Formatter
ValueSummary

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

When to include quotes, defaults to nonnumeric

Expand
Table 90.14. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 90.15. Table Formatter
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.

90.5. workbook show

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 90.16. Positional Arguments
ValueSummary

workbook

Workbook name

Expand
Table 90.17. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--namespace [NAMESPACE]

Namespace to get the workbook from.

Expand
Table 90.18. Output Formatters
ValueSummary

output formatter options-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 90.19. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 90.20. Shell Formatter
ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Expand
Table 90.21. Table Formatter
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.

90.6. workbook update

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 90.22. Positional Arguments
ValueSummary

definition

Workbook definition file

Expand
Table 90.23. Optional 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 90.24. Output Formatters
ValueSummary

output formatter options-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 90.25. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 90.26. Shell Formatter
ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Expand
Table 90.27. Table Formatter
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.

90.7. workbook validate

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 90.28. Positional Arguments
ValueSummary

definition

Workbook definition file

Expand
Table 90.29. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 90.30. Output Formatters
ValueSummary

output formatter options-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 90.31. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 90.32. Shell Formatter
ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Expand
Table 90.33. Table Formatter
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.

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat