Language:
Format:

Language:
Format:

Chapter 4. action

This chapter describes the commands under the action command.

4.1. action definition create

Create new action.

Usage:

openstack action definition create [-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] [--public]
                                          definition

Table 4.1. Positional arguments

Value	Summary
definition	Action definition file

Table 4.2. Command arguments

Value	Summary
-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.
--public	With this flag action will be marked as "public".

Table 4.3. Output formatter options

Value	Summary
-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 4.4. CSV formatter options

Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 4.5. JSON formatter options

Value	Summary
--noindent	Whether to disable indenting the json

Table 4.6. Table formatter options

Value	Summary
--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.

4.2. action definition definition show

Show action definition.

Usage:

openstack action definition definition show [-h] name

Table 4.7. Positional arguments

Value	Summary
name	Action name

Table 4.8. Command arguments

Value	Summary
-h, --help	Show this help message and exit

4.3. action definition delete

Delete action.

Usage:

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

Table 4.9. Positional arguments

Value	Summary
action	Name or id of action(s).

Table 4.10. Command arguments

Value	Summary
-h, --help	Show this help message and exit

4.4. action definition list

List all actions.

Usage:

openstack action definition 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]

Table 4.11. Command arguments

Value	Summary
-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.

Table 4.12. Output formatter options

Value	Summary
-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 4.13. CSV formatter options

Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 4.14. JSON formatter options

Value	Summary
--noindent	Whether to disable indenting the json

Table 4.15. Table formatter options

Value	Summary
--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.

4.5. action definition show

Show specific action.

Usage:

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

Table 4.16. Positional arguments

Value	Summary
action	Action (name or id)

Table 4.17. Command arguments

Value	Summary
-h, --help	Show this help message and exit

Table 4.18. Output formatter options

Value	Summary
-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 4.19. JSON formatter options

Value	Summary
--noindent	Whether to disable indenting the json

Table 4.20. Shell formatter options

Value	Summary
--prefix PREFIX	Add a prefix to all variable names

Table 4.21. Table formatter options

Value	Summary
--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.

4.6. action definition update

Update action.

Usage:

openstack action definition update [-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] [--id ID]
                                          [--public]
                                          definition

Table 4.22. Positional arguments

Value	Summary
definition	Action definition file

Table 4.23. Command arguments

Value	Summary
-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.
--id ID	Action id.
--public	With this flag action will be marked as "public".

Table 4.24. Output formatter options

Value	Summary
-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 4.25. CSV formatter options

Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 4.26. JSON formatter options

Value	Summary
--noindent	Whether to disable indenting the json

Table 4.27. Table formatter options

Value	Summary
--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.

4.7. action execution delete

Delete action execution.

Usage:

openstack action execution delete [-h]
                                         action_execution
                                         [action_execution ...]

Table 4.28. Positional arguments

Value	Summary
action_execution	Id of action execution identifier(s).

Table 4.29. Command arguments

Value	Summary
-h, --help	Show this help message and exit

4.8. action execution input show

Show Action execution input data.

Usage:

openstack action execution input show [-h] id

Table 4.30. Positional arguments

Value	Summary
id	Action execution id.

Table 4.31. Command arguments

Value	Summary
-h, --help	Show this help message and exit

4.9. action execution list

List all Action executions.

Usage:

openstack action 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]
                                       [task_execution_id]

Table 4.32. Positional arguments

Value	Summary
task_execution_id	Task execution id.

Table 4.33. Command arguments

Value	Summary
-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 4.34. Output formatter options

Value	Summary
-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 4.35. CSV formatter options

Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 4.36. JSON formatter options

Value	Summary
--noindent	Whether to disable indenting the json

Table 4.37. Table formatter options

Value	Summary
--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.

4.10. action execution output show

Show Action execution output data.

Usage:

openstack action execution output show [-h] id

Table 4.38. Positional arguments

Value	Summary
id	Action execution id.

Table 4.39. Command arguments

Value	Summary
-h, --help	Show this help message and exit

4.11. action execution run

Create new Action execution or just run specific action.

Usage:

openstack action execution run [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [-s] [--run-sync]
                                      [-t TARGET]
                                      name [input]

Table 4.40. Positional arguments

Value	Summary
name	Action name to execute.
input	Action input.

Table 4.41. Command arguments

Value	Summary
-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.

Table 4.42. Output formatter options

Value	Summary
-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 4.43. JSON formatter options

Value	Summary
--noindent	Whether to disable indenting the json

Table 4.44. Shell formatter options

Value	Summary
--prefix PREFIX	Add a prefix to all variable names

Table 4.45. Table formatter options

Value	Summary
--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.

4.12. action execution show

Show specific Action execution.

Usage:

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

Table 4.46. Positional arguments

Value	Summary
action_execution	Action execution id.

Table 4.47. Command arguments

Value	Summary
-h, --help	Show this help message and exit

Table 4.48. Output formatter options

Value	Summary
-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 4.49. JSON formatter options

Value	Summary
--noindent	Whether to disable indenting the json

Table 4.50. Shell formatter options

Value	Summary
--prefix PREFIX	Add a prefix to all variable names

Table 4.51. Table formatter options

Value	Summary
--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.

4.13. action execution update

Update specific Action execution.

Usage:

openstack action execution update [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         [--state {PAUSED,RUNNING,SUCCESS,ERROR,CANCELLED}]
                                         [--output OUTPUT]
                                         id

Table 4.52. Positional arguments

Value	Summary
id	Action execution id.

Table 4.53. Command arguments

Value	Summary
-h, --help	Show this help message and exit
--state {PAUSED,RUNNING,SUCCESS,ERROR,CANCELLED}	Action execution state
--output OUTPUT	Action execution output

Table 4.54. Output formatter options

Value	Summary
-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 4.55. JSON formatter options

Value	Summary
--noindent	Whether to disable indenting the json

Table 4.56. Shell formatter options

Value	Summary
--prefix PREFIX	Add a prefix to all variable names

Table 4.57. Table formatter options

Value	Summary
--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.

Select Your Language

Chapter 4. action

4.1. action definition create

4.2. action definition definition show

4.3. action definition delete

4.4. action definition list

4.5. action definition show

4.6. action definition update

4.7. action execution delete

4.8. action execution input show

4.9. action execution list

4.10. action execution output show

4.11. action execution run

4.12. action execution show

4.13. action execution update

Quick Links

Help

Site Info

Related Sites

About

Red Hat legal and privacy links

Red Hat legal and privacy links

Language and Page Formatting Options

Chapter 4. action

4.1. action definition create

4.2. action definition definition show

4.3. action definition delete

4.4. action definition list

4.5. action definition show

4.6. action definition update

4.7. action execution delete

4.8. action execution input show

4.9. action execution list

4.10. action execution output show

4.11. action execution run

4.12. action execution show

4.13. action execution update

Quick Links

Help

Site Info

Related Sites

Systems Status

About

Red Hat legal and privacy links

Red Hat legal and privacy links