Chapter 91. workflow

This chapter describes the commands under the workflow command.

91.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]
                                 [--sort-ascending | --sort-descending]
                                 [--marker [MARKER]] [--limit [LIMIT]]
                                 [--sort_keys [SORT_KEYS]]
                                 [--sort_dirs [SORT_DIRS]] [--filter FILTERS]
                                 [--namespace [NAMESPACE]] [--public]
                                 definition

Table 91.1. Positional arguments

ValueSummary

definition

Workflow definition file.

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

--namespace [NAMESPACE]

Namespace to create the workflow within.

--public

With this flag workflow will be marked as "public".

Table 91.3. Output formatter options

ValueSummary

-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 to show multiple columns

--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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Table 91.4. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 91.5. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.6. Table formatter options

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.

91.2. workflow definition show

Show workflow definition.

Usage:

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

Table 91.7. Positional arguments

ValueSummary

identifier

Workflow id or name.

Table 91.8. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--namespace [NAMESPACE]

Namespace to get the workflow from.

91.3. workflow delete

Delete workflow.

Usage:

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

Table 91.9. Positional arguments

ValueSummary

workflow

Name or id of workflow(s).

Table 91.10. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--namespace [NAMESPACE]

Namespace to delete the workflow from.

91.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]
                                              [--sort-ascending | --sort-descending]
                                              [--marker [MARKER]]
                                              [--limit [LIMIT]]
                                              [--sort_keys [SORT_KEYS]]
                                              [--sort_dirs [SORT_DIRS]]
                                              [--filter FILTERS]

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

Table 91.12. Output formatter options

ValueSummary

-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 to show multiple columns

--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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Table 91.13. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 91.14. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.15. Table formatter options

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.

91.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 91.16. Positional arguments

ValueSummary

file

Environment configuration file in json or yaml

Table 91.17. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 91.18. Output formatter options

ValueSummary

-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 to show multiple columns

Table 91.19. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.20. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 91.21. Table formatter options

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.

91.6. workflow env delete

Delete environment.

Usage:

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

Table 91.22. Positional arguments

ValueSummary

environment

Name of environment(s).

Table 91.23. Command arguments

ValueSummary

-h, --help

Show this help message and exit

91.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]
                                   [--sort-ascending | --sort-descending]
                                   [--marker [MARKER]] [--limit [LIMIT]]
                                   [--sort_keys [SORT_KEYS]]
                                   [--sort_dirs [SORT_DIRS]]
                                   [--filter FILTERS]

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

Table 91.25. Output formatter options

ValueSummary

-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 to show multiple columns

--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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Table 91.26. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 91.27. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.28. Table formatter options

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.

91.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 91.29. Positional arguments

ValueSummary

environment

Environment name

Table 91.30. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--export

Export the environment suitable for import

Table 91.31. Output formatter options

ValueSummary

-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 to show multiple columns

Table 91.32. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.33. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 91.34. Table formatter options

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.

91.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 91.35. Positional arguments

ValueSummary

file

Environment configuration file in json or yaml

Table 91.36. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 91.37. Output formatter options

ValueSummary

-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 to show multiple columns

Table 91.38. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.39. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 91.40. Table formatter options

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.

91.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 91.41. Positional arguments

ValueSummary

workflow_identifier

Workflow id or name

workflow_input

Workflow input

params

Workflow additional parameters

Table 91.42. Command arguments

ValueSummary

-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 91.43. Output formatter options

ValueSummary

-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 to show multiple columns

Table 91.44. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.45. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 91.46. Table formatter options

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.

91.11. workflow execution delete

Delete execution.

Usage:

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

Table 91.47. Positional arguments

ValueSummary

execution

Id of execution identifier(s).

Table 91.48. Command arguments

ValueSummary

-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.

91.12. workflow execution input show

Show execution input data.

Usage:

openstack workflow execution input show [-h] id

Table 91.49. Positional arguments

ValueSummary

id

Execution id

Table 91.50. Command arguments

ValueSummary

-h, --help

Show this help message and exit

91.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]
                                         [--sort-ascending | --sort-descending]
                                         [--marker [MARKER]] [--limit [LIMIT]]
                                         [--sort_keys [SORT_KEYS]]
                                         [--sort_dirs [SORT_DIRS]]
                                         [--filter FILTERS] [--oldest]
                                         [--task [TASK]] [--rootsonly]

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

--oldest

Display the executions starting from the oldest entries instead of the newest

--task [TASK]

Parent task execution id associated with workflow execution list.

--rootsonly

Return only root executions

Table 91.52. Output formatter options

ValueSummary

-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 to show multiple columns

--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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Table 91.53. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 91.54. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.55. Table formatter options

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.

91.14. workflow execution output show

Show execution output data.

Usage:

openstack workflow execution output show [-h] id

Table 91.56. Positional arguments

ValueSummary

id

Execution id

Table 91.57. Command arguments

ValueSummary

-h, --help

Show this help message and exit

91.15. workflow execution published show

Show workflow global published variables.

Usage:

openstack workflow execution published show [-h] id

Table 91.58. Positional arguments

ValueSummary

id

Workflow id

Table 91.59. Command arguments

ValueSummary

-h, --help

Show this help message and exit

91.16. workflow execution report show

Print execution report.

Usage:

openstack workflow execution report show [-h] [--errors-only]
                                                [--statistics-only]
                                                [--no-errors-only]
                                                [--max-depth [MAX_DEPTH]]
                                                id

Table 91.60. Positional arguments

ValueSummary

id

Execution id

Table 91.61. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--errors-only

Only error paths will be included.

--statistics-only

Only the statistics 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

91.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 91.62. Positional arguments

ValueSummary

execution

Execution identifier

Table 91.63. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 91.64. Output formatter options

ValueSummary

-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 to show multiple columns

Table 91.65. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.66. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 91.67. Table formatter options

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.

91.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 91.68. Positional arguments

ValueSummary

id

Execution identifier

Table 91.69. Command arguments

ValueSummary

-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 91.70. Output formatter options

ValueSummary

-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 to show multiple columns

Table 91.71. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.72. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 91.73. Table formatter options

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.

91.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]
                               [--sort-ascending | --sort-descending]
                               [--marker [MARKER]] [--limit [LIMIT]]
                               [--sort_keys [SORT_KEYS]]
                               [--sort_dirs [SORT_DIRS]] [--filter FILTERS]

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

Table 91.75. Output formatter options

ValueSummary

-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 to show multiple columns

--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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Table 91.76. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 91.77. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.78. Table formatter options

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.

91.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 91.79. Positional arguments

ValueSummary

workflow

Workflow id or name.

Table 91.80. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--namespace [NAMESPACE]

Namespace to get the workflow from.

Table 91.81. Output formatter options

ValueSummary

-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 to show multiple columns

Table 91.82. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.83. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 91.84. Table formatter options

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.

91.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]
                                 [--sort-ascending | --sort-descending]
                                 [--marker [MARKER]] [--limit [LIMIT]]
                                 [--sort_keys [SORT_KEYS]]
                                 [--sort_dirs [SORT_DIRS]] [--filter FILTERS]
                                 [--id ID] [--namespace [NAMESPACE]]
                                 [--public]
                                 definition

Table 91.85. Positional arguments

ValueSummary

definition

Workflow definition

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

--id ID

Workflow id.

--namespace [NAMESPACE]

Namespace of the workflow.

--public

With this flag workflow will be marked as "public".

Table 91.87. Output formatter options

ValueSummary

-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 to show multiple columns

--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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Table 91.88. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 91.89. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.90. Table formatter options

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.

91.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 91.91. Positional arguments

ValueSummary

definition

Workflow definition file

Table 91.92. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 91.93. Output formatter options

ValueSummary

-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 to show multiple columns

Table 91.94. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.95. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 91.96. Table formatter options

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.