Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 3. action

This chapter describes the commands under the action command.

3.1. action definition create
Copy link

Usage:

openstack action definition 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]
                                        [--public]
                                        definition
Copy to Clipboard Toggle word wrap

Create new action.

Expand
Table 3.1. Positional Arguments
ValueSummary

definition

Action definition file

Expand
Table 3.2. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--public

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

Expand
Table 3.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

Expand
Table 3.4. 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.

Expand
Table 3.5. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 3.6. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-mistralclient plugin.

3.2. action definition definition show
Copy link

Usage:

openstack action definition definition show [-h] name
Copy to Clipboard Toggle word wrap

Show action definition.

Expand
Table 3.7. Positional Arguments
ValueSummary

name

Action name

Expand
Table 3.8. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-mistralclient plugin.

3.3. action definition delete
Copy link

Usage:

openstack action definition delete [-h] action [action ...]
Copy to Clipboard Toggle word wrap

Delete action.

Expand
Table 3.9. Positional Arguments
ValueSummary

action

Name or id of action(s).

Expand
Table 3.10. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-mistralclient plugin.

3.4. action definition list
Copy link

Usage:

openstack action definition 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]
Copy to Clipboard Toggle word wrap

List all actions.

Expand
Table 3.11. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--filter FILTERS

Filters. can be repeated.

Expand
Table 3.12. 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

Expand
Table 3.13. 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.

Expand
Table 3.14. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 3.15. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-mistralclient plugin.

3.5. action definition show
Copy link

Usage:

openstack action definition show [-h]

                                      [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      action
Copy to Clipboard Toggle word wrap

Show specific action.

Expand
Table 3.16. Positional Arguments
ValueSummary

action

Action (name or id)

Expand
Table 3.17. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 3.18. 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

Expand
Table 3.19. 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.

Expand
Table 3.20. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 3.21. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-mistralclient plugin.

3.6. action definition update
Copy link

Usage:

openstack action definition 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] [--public]
                                        definition
Copy to Clipboard Toggle word wrap

Update action.

Expand
Table 3.22. Positional Arguments
ValueSummary

definition

Action definition file

Expand
Table 3.23. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--id ID

Action id.

--public

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

Expand
Table 3.24. 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

Expand
Table 3.25. 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.

Expand
Table 3.26. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 3.27. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-mistralclient plugin.

3.7. action execution delete
Copy link

Usage:

openstack action execution delete [-h]

                                       action_execution
                                       [action_execution ...]
Copy to Clipboard Toggle word wrap

Delete action execution.

Expand
Table 3.28. Positional Arguments
ValueSummary

action_execution

Id of action execution identifier(s).

Expand
Table 3.29. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-mistralclient plugin.

3.8. action execution input show
Copy link

Usage:

openstack action execution input show [-h] id
Copy to Clipboard Toggle word wrap

Show Action execution input data.

Expand
Table 3.30. Positional Arguments
ValueSummary

id

Action execution id.

Expand
Table 3.31. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-mistralclient plugin.

3.9. action execution list
Copy link

Usage:

openstack action 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]
                                     [--limit [LIMIT]]
                                     [task_execution_id]
Copy to Clipboard Toggle word wrap

List all Action executions.

Expand
Table 3.32. Positional Arguments
ValueSummary

task_execution_id

Task execution id.

Expand
Table 3.33. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--limit [LIMIT]

Maximum number of action-executions to return in a single result. limit is set to 100 by default. Use

--limit -1 to fetch the full result set.

 
Expand
Table 3.34. 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

Expand
Table 3.35. 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.

Expand
Table 3.36. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 3.37. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-mistralclient plugin.

3.10. action execution output show
Copy link

Usage:

openstack action execution output show [-h] id
Copy to Clipboard Toggle word wrap

Show Action execution output data.

Expand
Table 3.38. Positional Arguments
ValueSummary

id

Action execution id.

Expand
Table 3.39. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-mistralclient plugin.

3.11. action execution run
Copy link

Usage:

openstack action execution run [-h] [-f {json,shell,table,value,yaml}]

                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--noindent] [--prefix PREFIX] [-s]
                                    [--run-sync] [-t TARGET]
                                    name [input]
Copy to Clipboard Toggle word wrap

Create new Action execution or just run specific action.

Expand
Table 3.40. Positional Arguments
ValueSummary

name

Action name to execute.

input

Action input.

Expand
Table 3.41. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

-s, --save-result

Save the result into db.

--run-sync

Run the action synchronously.

-t TARGET, --target TARGET

Action will be executed on <target> executor.

Expand
Table 3.42. 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

Expand
Table 3.43. 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.

Expand
Table 3.44. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 3.45. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-mistralclient plugin.

3.12. action execution show
Copy link

Usage:

openstack action execution show [-h] [-f {json,shell,table,value,yaml}]

                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     action_execution
Copy to Clipboard Toggle word wrap

Show specific Action execution.

Expand
Table 3.46. Positional Arguments
ValueSummary

action_execution

Action execution id.

Expand
Table 3.47. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 3.48. 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

Expand
Table 3.49. 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.

Expand
Table 3.50. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 3.51. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-mistralclient plugin.

3.13. action execution update
Copy link

Usage:

openstack action execution update [-h]

                                       [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       [--state {IDLE,RUNNING,SUCCESS,ERROR,CANCELLED}]
                                       [--output OUTPUT]
                                       id
Copy to Clipboard Toggle word wrap

Update specific Action execution.

Expand
Table 3.52. Positional Arguments
ValueSummary

id

Action execution id.

Expand
Table 3.53. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--state {IDLE,RUNNING,SUCCESS,ERROR,CANCELLED}

Action execution state

--output OUTPUT

Action execution output

Expand
Table 3.54. 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

Expand
Table 3.55. 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.

Expand
Table 3.56. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 3.57. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-mistralclient plugin.

Back to top
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. Explore our recent updates.

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.

Theme

© 2025 Red Hat