Chapter 90. workflow
This chapter describes the commands under the workflow
command.
90.1. workflow create
Create new workflow.
Usage:
openstack workflow create [-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] [--namespace [NAMESPACE]] [--public] definition
Table 90.1. Positional Arguments
Value | Summary |
---|---|
definition | Workflow definition file. |
Table 90.2. 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. |
--namespace [NAMESPACE] | Namespace to create the workflow within. |
--public | With this flag workflow will be marked as "public". |
Table 90.3. 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 90.4. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 90.5. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 90.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. |
90.2. workflow definition show
Show workflow definition.
Usage:
openstack workflow definition show [-h] [--namespace [NAMESPACE]] identifier
Table 90.7. Positional Arguments
Value | Summary |
---|---|
identifier | Workflow id or name. |
Table 90.8. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--namespace [NAMESPACE] | Namespace to get the workflow from. |
90.3. workflow delete
Delete workflow.
Usage:
openstack workflow delete [-h] [--namespace [NAMESPACE]] workflow [workflow ...]
Table 90.9. Positional Arguments
Value | Summary |
---|---|
workflow | Name or id of workflow(s). |
Table 90.10. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--namespace [NAMESPACE] | Namespace to delete the workflow from. |
90.4. workflow engine service list
List all services.
Usage:
openstack workflow engine service 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 90.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 90.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 90.13. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 90.14. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 90.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. |
90.5. workflow env create
Create new environment.
Usage:
openstack workflow env create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] file
Table 90.16. Positional Arguments
Value | Summary |
---|---|
file | Environment configuration file in json or yaml |
Table 90.17. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 90.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 90.19. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 90.20. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 90.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. |
90.6. workflow env delete
Delete environment.
Usage:
openstack workflow env delete [-h] environment [environment ...]
Table 90.22. Positional Arguments
Value | Summary |
---|---|
environment | Name of environment(s). |
Table 90.23. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
90.7. workflow env list
List all environments.
Usage:
openstack workflow env 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 90.24. 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 90.25. 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 90.26. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 90.27. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 90.28. 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. |
90.8. workflow env show
Show specific environment.
Usage:
openstack workflow env show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--export] environment
Table 90.29. Positional Arguments
Value | Summary |
---|---|
environment | Environment name |
Table 90.30. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--export | Export the environment suitable for import |
Table 90.31. 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 90.32. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 90.33. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 90.34. 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. |
90.9. workflow env update
Update environment.
Usage:
openstack workflow env update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] file
Table 90.35. Positional Arguments
Value | Summary |
---|---|
file | Environment configuration file in json or yaml |
Table 90.36. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 90.37. 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 90.38. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 90.39. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 90.40. 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. |
90.10. workflow execution create
Create new execution.
Usage:
openstack workflow execution create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--namespace [NAMESPACE]] [-d DESCRIPTION] [-s [SOURCE_EXECUTION_ID]] [workflow_identifier] [workflow_input] [params]
Table 90.41. Positional Arguments
Value | Summary |
---|---|
workflow_identifier | Workflow id or name. workflow name will be deprecated since Mitaka. |
workflow_input | Workflow input |
params | Workflow additional parameters |
Table 90.42. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--namespace [NAMESPACE] | Workflow namespace. |
-d DESCRIPTION, --description DESCRIPTION | Execution description |
-s [SOURCE_EXECUTION_ID] | Workflow execution id which will allow operators to create a new workflow execution based on the previously successful executed workflow. Example: mistral execution-create -s 123e4567-e89b-12d3-a456-426655440000 |
Table 90.43. 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 90.44. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 90.45. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 90.46. 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. |
90.11. workflow execution delete
Delete execution.
Usage:
openstack workflow execution delete [-h] [--force] execution [execution ...]
Table 90.47. Positional Arguments
Value | Summary |
---|---|
execution | Id of execution identifier(s). |
Table 90.48. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--force | Force the deletion of an execution. might cause a cascade of errors if used for running executions. |
90.12. workflow execution input show
Show execution input data.
Usage:
openstack workflow execution input show [-h] id
Table 90.49. Positional Arguments
Value | Summary |
---|---|
id | Execution id |
Table 90.50. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
90.13. workflow execution list
List all executions.
Usage:
openstack workflow execution 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] [--oldest] [--task [TASK]]
Table 90.51. 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. |
--oldest | Display the executions starting from the oldest entries instead of the newest |
--task [TASK] | Parent task execution id associated with workflow execution list. |
Table 90.52. 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 90.53. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 90.54. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 90.55. 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. |
90.14. workflow execution output show
Show execution output data.
Usage:
openstack workflow execution output show [-h] id
Table 90.56. Positional Arguments
Value | Summary |
---|---|
id | Execution id |
Table 90.57. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
90.15. workflow execution published show
Show workflow global published variables.
Usage:
openstack workflow execution published show [-h] id
Table 90.58. Positional Arguments
Value | Summary |
---|---|
id | Workflow id |
Table 90.59. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
90.16. workflow execution report show
Print execution report.
Usage:
openstack workflow execution report show [-h] [--errors-only] [--no-errors-only] [--max-depth [MAX_DEPTH]] id
Table 90.60. Positional Arguments
Value | Summary |
---|---|
id | Execution id |
Table 90.61. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--errors-only | Only error paths will be included. |
--no-errors-only | Not only error paths will be included. |
--max-depth [MAX_DEPTH] | Maximum depth of the workflow execution tree. if 0, only the root workflow execution and its tasks will be included |
90.17. workflow execution show
Show specific execution.
Usage:
openstack workflow execution show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] execution
Table 90.62. Positional Arguments
Value | Summary |
---|---|
execution | Execution identifier |
Table 90.63. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 90.64. 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 90.65. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 90.66. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 90.67. 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. |
90.18. workflow execution update
Update execution.
Usage:
openstack workflow execution update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [-s {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}] [-e ENV] [-d DESCRIPTION] id
Table 90.68. Positional Arguments
Value | Summary |
---|---|
id | Execution identifier |
Table 90.69. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
-s {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}, --state {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED} | Execution state |
-e ENV, --env ENV | Environment variables |
-d DESCRIPTION, --description DESCRIPTION | Execution description |
Table 90.70. 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 90.71. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 90.72. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 90.73. 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. |
90.19. workflow list
List all workflows.
Usage:
openstack workflow 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 90.74. 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 90.75. 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 90.76. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 90.77. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 90.78. 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. |
90.20. workflow show
Show specific workflow.
Usage:
openstack workflow show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--namespace [NAMESPACE]] workflow
Table 90.79. Positional Arguments
Value | Summary |
---|---|
workflow | Workflow id or name. |
Table 90.80. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--namespace [NAMESPACE] | Namespace to get the workflow from. |
Table 90.81. 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 90.82. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 90.83. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 90.84. 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. |
90.21. workflow update
Update workflow.
Usage:
openstack workflow update [-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] [--id ID] [--namespace [NAMESPACE]] [--public] definition
Table 90.85. Positional Arguments
Value | Summary |
---|---|
definition | Workflow definition |
Table 90.86. 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. |
--id ID | Workflow id. |
--namespace [NAMESPACE] | Namespace of the workflow. |
--public | With this flag workflow will be marked as "public". |
Table 90.87. 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 90.88. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 90.89. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 90.90. 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. |
90.22. workflow validate
Validate workflow.
Usage:
openstack workflow validate [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] definition
Table 90.91. Positional Arguments
Value | Summary |
---|---|
definition | Workflow definition file |
Table 90.92. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 90.93. 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 90.94. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 90.95. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 90.96. 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. |