Chapter 64. task


This chapter describes the commands under the task command.

64.1. task execution list

List all tasks.

Usage:

openstack task 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]
                                     [--filter FILTERS] [--limit [LIMIT]]
                                     [workflow_execution]

Table 64.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 64.2. Positional Arguments
ValueSummary

workflow_execution

Workflow execution id associated with list of tasks.

Table 64.3. CSV Formatter
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 64.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 64.5. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 64.6. Optional Arguments
ValueSummary

--filter FILTERS

Filters. can be repeated.

-h, --help

Show this help message and exit

--limit [LIMIT]

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

64.2. task execution published show

Show task published variables.

Usage:

openstack task execution published show [-h] id

Table 64.7. Positional Arguments
ValueSummary

id

Task id

Table 64.8. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

64.3. task execution rerun

Rerun an existing task.

Usage:

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

Table 64.9. 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 64.10. Positional Arguments
ValueSummary

id

Task identifier

Table 64.11. 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 64.12. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 64.13. 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 64.14. Shell Formatter
ValueSummary

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

Add a prefix to all variable names

64.4. task execution result show

Show task output data.

Usage:

openstack task execution result show [-h] id

Table 64.15. Positional Arguments
ValueSummary

id

Task id

Table 64.16. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

64.5. task execution show

Show specific task.

Usage:

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

Table 64.17. 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 64.18. Positional Arguments
ValueSummary

task

Task identifier

Table 64.19. 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 64.20. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 64.21. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

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