Chapter 73. workflow


This chapter describes the commands under the workflow command.

73.1. workflow create

Create new workflow.

Usage:

openstack workflow create [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--sort-column SORT_COLUMN]
                                 [--namespace [NAMESPACE]] [--public]
                                 definition

Table 73.1. Table Formatter
ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 73.2. Positional Arguments
ValueSummary

definition

Workflow definition file.

Table 73.3. CSV Formatter
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 73.4. Output Formatters
ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 73.5. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 73.6. Optional Arguments
ValueSummary

--namespace [NAMESPACE]

Namespace to create the workflow within.

-h, --help

Show this help message and exit

--public

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

73.2. workflow definition show

Show workflow definition.

Usage:

openstack workflow definition show [-h] identifier

Table 73.7. Positional Arguments
ValueSummary

identifier

Workflow id or name.

Table 73.8. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

73.3. workflow delete

Delete workflow.

Usage:

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

Table 73.9. Positional Arguments
ValueSummary

workflow

Name or id of workflow(s).

Table 73.10. Optional Arguments
ValueSummary

--namespace [NAMESPACE]

Parent task execution id associated with workflow execution list.

-h, --help

Show this help message and exit

73.4. workflow engine service list

List all services.

Usage:

openstack workflow engine service list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--sort-column SORT_COLUMN]

Table 73.11. Table Formatter
ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 73.12. CSV Formatter
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 73.13. Output Formatters
ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 73.14. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 73.15. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

73.5. workflow env create

Create new environment.

Usage:

openstack workflow env create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     file

Table 73.16. Table Formatter
ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 73.17. Positional Arguments
ValueSummary

file

Environment configuration file in json or yaml

Table 73.18. Output Formatters
ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 73.19. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 73.20. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Table 73.21. Shell Formatter
ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

73.6. workflow env delete

Delete environment.

Usage:

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

Table 73.22. Positional Arguments
ValueSummary

environment

Name of environment(s).

Table 73.23. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

73.7. workflow env list

List all environments.

Usage:

openstack workflow env list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--sort-column SORT_COLUMN]

Table 73.24. Table Formatter
ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 73.25. CSV Formatter
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 73.26. Output Formatters
ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 73.27. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 73.28. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

73.8. workflow env show

Show specific environment.

Usage:

openstack workflow env show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--prefix PREFIX]
                                   environment

Table 73.29. Table Formatter
ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 73.30. Positional Arguments
ValueSummary

environment

Environment name

Table 73.31. Output Formatters
ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 73.32. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 73.33. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Table 73.34. Shell Formatter
ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

73.9. workflow env update

Update environment.

Usage:

openstack workflow env update [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     file

Table 73.35. Table Formatter
ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 73.36. Positional Arguments
ValueSummary

file

Environment configuration file in json or yaml

Table 73.37. Output Formatters
ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 73.38. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 73.39. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Table 73.40. Shell Formatter
ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

73.10. workflow execution create

Create new execution.

Usage:

openstack workflow execution create [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           [--namespace [NAMESPACE]]
                                           [-d DESCRIPTION]
                                           [-s [SOURCE_EXECUTION_ID]]
                                           [workflow_identifier]
                                           [workflow_input] [params]

Table 73.41. Table Formatter
ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 73.42. Positional Arguments
ValueSummary

workflow_input

Workflow input

params

Workflow additional parameters

workflow_identifier

Workflow id or name. workflow name will be deprecated since Mitaka.

Table 73.43. Output Formatters
ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 73.44. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 73.45. Optional Arguments
ValueSummary

--namespace [NAMESPACE]

Workflow namespace.

-h, --help

Show this help message and exit

-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 73.46. Shell Formatter
ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

73.11. workflow execution delete

Delete execution.

Usage:

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

Table 73.47. Positional Arguments
ValueSummary

execution

Id of execution identifier(s).

Table 73.48. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

73.12. workflow execution input show

Show execution input data.

Usage:

openstack workflow execution input show [-h] id

Table 73.49. Positional Arguments
ValueSummary

id

Execution id

Table 73.50. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

73.13. workflow execution list

List all executions.

Usage:

openstack workflow execution list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--sort-column SORT_COLUMN]
                                         [--task [TASK]] [--marker [MARKER]]
                                         [--limit [LIMIT]]
                                         [--sort_keys [SORT_KEYS]]
                                         [--sort_dirs [SORT_DIRS]]
                                         [--filter FILTERS]

Table 73.51. Table Formatter
ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 73.52. CSV Formatter
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 73.53. Output Formatters
ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 73.54. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 73.55. Optional Arguments
ValueSummary

--marker [MARKER]

The last execution uuid of the previous page, displays list of executions after "marker".

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

--limit [LIMIT]

Maximum number of executions to return in a single result. limit is set to 100 by default. Use --limit -1 to fetch the full result set.

--filter FILTERS

Filters. can be repeated.

-h, --help

Show this help message and exit

--task [TASK]

Parent task execution id associated with workflow execution list.

73.14. workflow execution output show

Show execution output data.

Usage:

openstack workflow execution output show [-h] id

Table 73.56. Positional Arguments
ValueSummary

id

Execution id

Table 73.57. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

73.15. workflow execution show

Show specific execution.

Usage:

openstack workflow execution show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         execution

Table 73.58. Table Formatter
ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 73.59. Positional Arguments
ValueSummary

execution

Execution identifier

Table 73.60. Output Formatters
ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 73.61. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 73.62. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Table 73.63. Shell Formatter
ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

73.16. workflow execution update

Update execution.

Usage:

openstack workflow execution update [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           [-s {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}]
                                           [-e ENV] [-d DESCRIPTION]
                                           id

Table 73.64. Table Formatter
ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 73.65. Positional Arguments
ValueSummary

id

Execution identifier

Table 73.66. Output Formatters
ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 73.67. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 73.68. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

-d DESCRIPTION, --description DESCRIPTION

Execution description

-e ENV, --env ENV

Environment variables

-s {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}, --state {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}

Execution state

Table 73.69. Shell Formatter
ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

73.17. workflow list

List all workflows.

Usage:

openstack workflow list [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--sort-column SORT_COLUMN] [--filter FILTERS]

Table 73.70. Table Formatter
ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 73.71. CSV Formatter
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 73.72. Output Formatters
ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 73.73. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 73.74. Optional Arguments
ValueSummary

--filter FILTERS

Filters. can be repeated.

-h, --help

Show this help message and exit

73.18. workflow show

Show specific workflow.

Usage:

openstack workflow show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX]
                               workflow

Table 73.75. Table Formatter
ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 73.76. Positional Arguments
ValueSummary

workflow

Workflow id or name.

Table 73.77. Output Formatters
ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 73.78. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 73.79. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Table 73.80. Shell Formatter
ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

73.19. workflow update

Update workflow.

Usage:

openstack workflow update [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--sort-column SORT_COLUMN] [--id ID]
                                 [--namespace [NAMESPACE]] [--public]
                                 definition

Table 73.81. Table Formatter
ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 73.82. Positional Arguments
ValueSummary

definition

Workflow definition

Table 73.83. CSV Formatter
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 73.84. Output Formatters
ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 73.85. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 73.86. Optional Arguments
ValueSummary

--namespace [NAMESPACE]

Parent task execution id associated with workflow execution list.

-h, --help

Show this help message and exit

--id ID

Workflow id.

--public

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

73.20. workflow validate

Validate workflow.

Usage:

openstack workflow validate [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--prefix PREFIX]
                                   definition

Table 73.87. Table Formatter
ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 73.88. Positional Arguments
ValueSummary

definition

Workflow definition file

Table 73.89. Output Formatters
ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 73.90. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 73.91. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Table 73.92. Shell Formatter
ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.