Chapter 78. task

This chapter describes the commands under the task command.

78.1. task execution list

List all tasks.

Usage:

openstack task 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]
                                     [workflow_execution]

Table 78.1. Positional Arguments

ValueSummary

workflow_execution

Workflow execution id associated with list of tasks.

Table 78.2. Optional 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

Table 78.3. Output Formatters

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

--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 78.4. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 78.5. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 78.6. Table Formatter

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.

78.2. task execution published show

Show task published variables.

Usage:

openstack task execution published show [-h] id

Table 78.7. Positional Arguments

ValueSummary

id

Task id

Table 78.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

78.3. task execution rerun

Rerun an existing task.

Usage:

openstack task execution rerun [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--resume] [-e ENV]
                                      id

Table 78.9. Positional Arguments

ValueSummary

id

Task identifier

Table 78.10. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--resume

Rerun only failed or unstarted action executions for with-items task

-e ENV, --env ENV

Environment variables

Table 78.11. Output Formatters

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

Table 78.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 78.13. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 78.14. Table Formatter

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.

78.4. task execution result show

Show task output data.

Usage:

openstack task execution result show [-h] id

Table 78.15. Positional Arguments

ValueSummary

id

Task id

Table 78.16. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

78.5. task execution show

Show specific task.

Usage:

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

Table 78.17. Positional Arguments

ValueSummary

task

Task identifier

Table 78.18. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 78.19. Output Formatters

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

Table 78.20. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 78.21. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 78.22. Table Formatter

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.