Chapter 79. task


This chapter describes the commands under the task command.

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

Table 79.1. Positional arguments
ValueSummary

workflow_execution

Workflow execution id associated with list of tasks.

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

--oldest

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

Table 79.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 79.4. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 79.5. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

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

79.2. task execution published show

Show task published variables.

Usage:

openstack task execution published show [-h] id

Table 79.7. Positional arguments
ValueSummary

id

Task id

Table 79.8. Command arguments
ValueSummary

-h, --help

Show this help message and exit

79.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 79.9. Positional arguments
ValueSummary

id

Task identifier

Table 79.10. Command 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 79.11. 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 79.12. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 79.13. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

79.4. task execution result show

Show task output data.

Usage:

openstack task execution result show [-h] id

Table 79.15. Positional arguments
ValueSummary

id

Task id

Table 79.16. Command arguments
ValueSummary

-h, --help

Show this help message and exit

79.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 79.17. Positional arguments
ValueSummary

task

Task identifier

Table 79.18. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Table 79.19. 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 79.20. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 79.21. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

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.