Chapter 88. workflow

88.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 88.1. Positional arguments
Value	Summary
definition	Workflow definition file.

Table 88.2. Command 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 88.3. Output formatter options
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 88.4. CSV formatter options
Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 88.5. JSON formatter options
Value	Summary
--noindent	Whether to disable indenting the json

Table 88.6. Table formatter options
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.

88.2. workflow definition show

Show workflow definition.

Usage:

openstack workflow definition show [-h] [--namespace [NAMESPACE]]
                                          identifier

Table 88.7. Positional arguments
Value	Summary
identifier	Workflow id or name.

Table 88.8. Command arguments
Value	Summary
-h, --help	Show this help message and exit
--namespace [NAMESPACE]	Namespace to get the workflow from.

88.3. workflow delete

Delete workflow.

Usage:

openstack workflow delete [-h] [--namespace [NAMESPACE]]
                                 workflow [workflow ...]

Table 88.9. Positional arguments
Value	Summary
workflow	Name or id of workflow(s).

Table 88.10. Command arguments
Value	Summary
-h, --help	Show this help message and exit
--namespace [NAMESPACE]	Namespace to delete the workflow from.

88.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 88.11. Command 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 88.12. Output formatter options
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 88.13. CSV formatter options
Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 88.14. JSON formatter options
Value	Summary
--noindent	Whether to disable indenting the json

Table 88.15. Table formatter options
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.

88.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 88.16. Positional arguments
Value	Summary
file	Environment configuration file in json or yaml

Table 88.17. Command arguments
Value	Summary
-h, --help	Show this help message and exit

Table 88.18. Output formatter options
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 88.19. JSON formatter options
Value	Summary
--noindent	Whether to disable indenting the json

Table 88.20. Shell formatter options
Value	Summary
--prefix PREFIX	Add a prefix to all variable names

Table 88.21. Table formatter options
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.

88.6. workflow env delete

Delete environment.

Usage:

openstack workflow env delete [-h] environment [environment ...]

Table 88.22. Positional arguments
Value	Summary
environment	Name of environment(s).

Table 88.23. Command arguments
Value	Summary
-h, --help	Show this help message and exit

88.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 88.24. Command 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 88.25. Output formatter options
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 88.26. CSV formatter options
Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 88.27. JSON formatter options
Value	Summary
--noindent	Whether to disable indenting the json

Table 88.28. Table formatter options
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.

88.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 88.29. Positional arguments
Value	Summary
environment	Environment name

Table 88.30. Command arguments
Value	Summary
-h, --help	Show this help message and exit
--export	Export the environment suitable for import

Table 88.31. Output formatter options
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 88.32. JSON formatter options
Value	Summary
--noindent	Whether to disable indenting the json

Table 88.33. Shell formatter options
Value	Summary
--prefix PREFIX	Add a prefix to all variable names

Table 88.34. Table formatter options
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.

88.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 88.35. Positional arguments
Value	Summary
file	Environment configuration file in json or yaml

Table 88.36. Command arguments
Value	Summary
-h, --help	Show this help message and exit

Table 88.37. Output formatter options
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 88.38. JSON formatter options
Value	Summary
--noindent	Whether to disable indenting the json

Table 88.39. Shell formatter options
Value	Summary
--prefix PREFIX	Add a prefix to all variable names

Table 88.40. Table formatter options
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.

88.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 88.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 88.42. Command 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 88.43. Output formatter options
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 88.44. JSON formatter options
Value	Summary
--noindent	Whether to disable indenting the json

Table 88.45. Shell formatter options
Value	Summary
--prefix PREFIX	Add a prefix to all variable names

Table 88.46. Table formatter options
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.

88.11. workflow execution delete

Delete execution.

Usage:

openstack workflow execution delete [-h] [--force]
                                           execution [execution ...]

Table 88.47. Positional arguments
Value	Summary
execution	Id of execution identifier(s).

Table 88.48. Command 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.

88.12. workflow execution input show

Show execution input data.

Usage:

openstack workflow execution input show [-h] id

Table 88.49. Positional arguments
Value	Summary
id	Execution id

Table 88.50. Command arguments
Value	Summary
-h, --help	Show this help message and exit

88.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 88.51. Command 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 88.52. Output formatter options
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 88.53. CSV formatter options
Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 88.54. JSON formatter options
Value	Summary
--noindent	Whether to disable indenting the json

Table 88.55. Table formatter options
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.

88.14. workflow execution output show

Show execution output data.

Usage:

openstack workflow execution output show [-h] id

Table 88.56. Positional arguments
Value	Summary
id	Execution id

Table 88.57. Command arguments
Value	Summary
-h, --help	Show this help message and exit

88.15. workflow execution published show

Show workflow global published variables.

Usage:

openstack workflow execution published show [-h] id

Table 88.58. Positional arguments
Value	Summary
id	Workflow id

Table 88.59. Command arguments
Value	Summary
-h, --help	Show this help message and exit

88.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 88.60. Positional arguments
Value	Summary
id	Execution id

Table 88.61. Command 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

88.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 88.62. Positional arguments
Value	Summary
execution	Execution identifier

Table 88.63. Command arguments
Value	Summary
-h, --help	Show this help message and exit

Table 88.64. Output formatter options
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 88.65. JSON formatter options
Value	Summary
--noindent	Whether to disable indenting the json

Table 88.66. Shell formatter options
Value	Summary
--prefix PREFIX	Add a prefix to all variable names

Table 88.67. Table formatter options
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.

88.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 88.68. Positional arguments
Value	Summary
id	Execution identifier

Table 88.69. Command 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 88.70. Output formatter options
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 88.71. JSON formatter options
Value	Summary
--noindent	Whether to disable indenting the json

Table 88.72. Shell formatter options
Value	Summary
--prefix PREFIX	Add a prefix to all variable names

Table 88.73. Table formatter options
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.

88.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 88.74. Command 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 88.75. Output formatter options
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 88.76. CSV formatter options
Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 88.77. JSON formatter options
Value	Summary
--noindent	Whether to disable indenting the json

Table 88.78. Table formatter options
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.

88.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 88.79. Positional arguments
Value	Summary
workflow	Workflow id or name.

Table 88.80. Command arguments
Value	Summary
-h, --help	Show this help message and exit
--namespace [NAMESPACE]	Namespace to get the workflow from.

Table 88.81. Output formatter options
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 88.82. JSON formatter options
Value	Summary
--noindent	Whether to disable indenting the json

Table 88.83. Shell formatter options
Value	Summary
--prefix PREFIX	Add a prefix to all variable names

Table 88.84. Table formatter options
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.

88.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 88.85. Positional arguments
Value	Summary
definition	Workflow definition

Table 88.86. Command 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 88.87. Output formatter options
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 88.88. CSV formatter options
Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 88.89. JSON formatter options
Value	Summary
--noindent	Whether to disable indenting the json

Table 88.90. Table formatter options
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.

88.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 88.91. Positional arguments
Value	Summary
definition	Workflow definition file

Table 88.92. Command arguments
Value	Summary
-h, --help	Show this help message and exit

Table 88.93. Output formatter options
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 88.94. JSON formatter options
Value	Summary
--noindent	Whether to disable indenting the json

Table 88.95. Shell formatter options
Value	Summary
--prefix PREFIX	Add a prefix to all variable names

Table 88.96. Table formatter options
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.

88.1. workflow create

88.2. workflow definition show

88.3. workflow delete

88.4. workflow engine service list

88.5. workflow env create

88.6. workflow env delete

88.7. workflow env list

88.8. workflow env show

88.9. workflow env update

88.10. workflow execution create

88.11. workflow execution delete

88.12. workflow execution input show

88.13. workflow execution list

88.14. workflow execution output show

88.15. workflow execution published show

88.16. workflow execution report show

88.17. workflow execution show

88.18. workflow execution update

88.19. workflow list

88.20. workflow show

88.21. workflow update

88.22. workflow validate

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

Making open source more inclusive

About Red Hat

Red Hat legal and privacy links

Red Hat legal and privacy links