Este contenido no está disponible en el idioma seleccionado.

Chapter 3. action


This chapter describes the commands under the action command.

3.1. action definition create

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

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

Usage:

openstack action definition definition show [-h] name

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

Usage:

openstack action definition delete [-h] action [action ...]

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

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]

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

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

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

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

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

Usage:

openstack action execution delete [-h]

                                       action_execution
                                       [action_execution ...]

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

Usage:

openstack action execution input show [-h] id

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

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]

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

Usage:

openstack action execution output show [-h] id

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

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]

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

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

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

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

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.

Red Hat logoGithubredditYoutubeTwitter

Aprender

Pruebe, compre y venda

Comunidades

Acerca de la documentación de Red Hat

Ayudamos a los usuarios de Red Hat a innovar y alcanzar sus objetivos con nuestros productos y servicios con contenido en el que pueden confiar. Explore nuestras recientes actualizaciones.

Hacer que el código abierto sea más inclusivo

Red Hat se compromete a reemplazar el lenguaje problemático en nuestro código, documentación y propiedades web. Para más detalles, consulte el Blog de Red Hat.

Acerca de Red Hat

Ofrecemos soluciones reforzadas que facilitan a las empresas trabajar en plataformas y entornos, desde el centro de datos central hasta el perímetro de la red.

Theme

© 2026 Red Hat
Volver arriba