Chapter 89. workbook
This chapter describes the commands under the workbook
command.
89.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
Table 89.1. Positional Arguments
Value | Summary |
---|---|
definition | Workbook definition file |
Table 89.2. Optional Arguments
Value | Summary |
---|---|
-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. |
Table 89.3. Output Formatters
Value | Summary |
---|---|
-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 |
Table 89.4. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 89.5. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 89.6. Table Formatter
Value | Summary |
---|---|
--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. |
89.2. workbook definition show
Show workbook definition.
Usage:
openstack workbook definition show [-h] name
Table 89.7. Positional Arguments
Value | Summary |
---|---|
name | Workbook name |
Table 89.8. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
89.3. workbook delete
Delete workbook.
Usage:
openstack workbook delete [-h] [--namespace [NAMESPACE]] workbook [workbook ...]
Table 89.9. Positional Arguments
Value | Summary |
---|---|
workbook | Name of workbook(s). |
Table 89.10. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--namespace [NAMESPACE] | Namespace to delete the workbook(s) from. |
89.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]
Table 89.11. Optional Arguments
Value | Summary |
---|---|
-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. |
Table 89.12. Output Formatters
Value | Summary |
---|---|
-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 |
Table 89.13. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 89.14. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 89.15. Table Formatter
Value | Summary |
---|---|
--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. |
89.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
Table 89.16. Positional Arguments
Value | Summary |
---|---|
workbook | Workbook name |
Table 89.17. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--namespace [NAMESPACE] | Namespace to get the workbook from. |
Table 89.18. Output Formatters
Value | Summary |
---|---|
-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 |
Table 89.19. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 89.20. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 89.21. Table Formatter
Value | Summary |
---|---|
--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. |
89.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
Table 89.22. Positional Arguments
Value | Summary |
---|---|
definition | Workbook definition file |
Table 89.23. Optional Arguments
Value | Summary |
---|---|
-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". |
Table 89.24. Output Formatters
Value | Summary |
---|---|
-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 |
Table 89.25. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 89.26. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 89.27. Table Formatter
Value | Summary |
---|---|
--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. |
89.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
Table 89.28. Positional Arguments
Value | Summary |
---|---|
definition | Workbook definition file |
Table 89.29. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 89.30. Output Formatters
Value | Summary |
---|---|
-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 |
Table 89.31. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 89.32. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 89.33. Table Formatter
Value | Summary |
---|---|
--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. |