Chapter 72. workbook
This chapter describes the commands under the workbook
command.
72.1. workbook create
Create new workbook.
Usage:
openstack workbook create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] definition
Table 72.1. Table Formatter
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--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 |
Table 72.2. Positional Arguments
Value | Summary |
---|---|
definition | Workbook definition file |
Table 72.3. Output Formatters
Value | Summary |
---|---|
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 |
Table 72.4. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 72.5. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 72.6. Shell Formatter
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
72.2. workbook definition show
Show workbook definition.
Usage:
openstack workbook definition show [-h] name
Table 72.7. Positional Arguments
Value | Summary |
---|---|
name | Workbook name |
Table 72.8. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
72.3. workbook delete
Delete workbook.
Usage:
openstack workbook delete [-h] workbook [workbook ...]
Table 72.9. Positional Arguments
Value | Summary |
---|---|
workbook | Name of workbook(s). |
Table 72.10. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
72.4. workbook list
List all workbooks.
Usage:
openstack workbook list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN]
Table 72.11. Table Formatter
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--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 |
Table 72.12. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 72.13. Output Formatters
Value | Summary |
---|---|
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 |
Table 72.14. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 72.15. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
72.5. workbook show
Show specific workbook.
Usage:
openstack workbook show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] workbook
Table 72.16. Table Formatter
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--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 |
Table 72.17. Positional Arguments
Value | Summary |
---|---|
workbook | Workbook name |
Table 72.18. Output Formatters
Value | Summary |
---|---|
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 |
Table 72.19. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 72.20. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 72.21. Shell Formatter
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
72.6. workbook update
Update workbook.
Usage:
openstack workbook update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] definition
Table 72.22. Table Formatter
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--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 |
Table 72.23. Positional Arguments
Value | Summary |
---|---|
definition | Workbook definition file |
Table 72.24. Output Formatters
Value | Summary |
---|---|
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 |
Table 72.25. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 72.26. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 72.27. Shell Formatter
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
72.7. workbook validate
Validate workbook.
Usage:
openstack workbook validate [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] definition
Table 72.28. Table Formatter
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--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 |
Table 72.29. Positional Arguments
Value | Summary |
---|---|
definition | Workbook definition file |
Table 72.30. Output Formatters
Value | Summary |
---|---|
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 |
Table 72.31. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 72.32. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 72.33. Shell Formatter
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |