Language:
Format:

Language:
Format:

Chapter 3. action

This chapter describes the commands under the action command.

3.1. action definition create

Create new action.

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

Table 3.1. Table Formatter

Value	Summary
--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 3.2. Positional Arguments

Value	Summary
definition	Action definition file

Table 3.3. CSV Formatter

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

Table 3.4. Output Formatters

Value	Summary
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 3.5. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 3.6. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit
--public	With this flag action will be marked as "public".

3.2. action definition definition show

Show action definition.

Usage:

openstack action definition definition show [-h] name

Table 3.7. Positional Arguments

Value	Summary
name	Action name

Table 3.8. Optional Arguments

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

3.3. action definition delete

Delete action.

Usage:

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

Table 3.9. Positional Arguments

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

Table 3.10. Optional Arguments

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

3.4. action definition list

List all actions.

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]

Table 3.11. Table Formatter

Value	Summary
--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 3.12. CSV Formatter

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

Table 3.13. Output Formatters

Value	Summary
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 3.14. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 3.15. Optional Arguments

Value	Summary
--filter FILTERS	Filters. can be repeated.
-h, --help	Show this help message and exit

3.5. action definition show

Show specific action.

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

Table 3.16. Table Formatter

Value	Summary
--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 3.17. Positional Arguments

Value	Summary
action	Action (name or id)

Table 3.18. Output Formatters

Value	Summary
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 3.19. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 3.20. Optional Arguments

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

Table 3.21. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

3.6. action definition update

Update action.

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

Table 3.22. Table Formatter

Value	Summary
--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 3.23. Positional Arguments

Value	Summary
definition	Action definition file

Table 3.24. CSV Formatter

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

Table 3.25. Output Formatters

Value	Summary
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 3.26. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 3.27. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit
--id ID	Action id.
--public	With this flag action will be marked as "public".

3.7. action execution delete

Delete action execution.

Usage:

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

Table 3.28. Positional Arguments

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

Table 3.29. Optional Arguments

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

3.8. action execution input show

Show Action execution input data.

Usage:

openstack action execution input show [-h] id

Table 3.30. Positional Arguments

Value	Summary
id	Action execution id.

Table 3.31. Optional Arguments

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

3.9. action execution list

List all Action executions.

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]

Table 3.32. Table Formatter

Value	Summary
--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 3.33. Positional Arguments

Value	Summary
task_execution_id	Task execution id.

Table 3.34. CSV Formatter

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

Table 3.35. Output Formatters

Value	Summary
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 3.36. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 3.37. Optional Arguments

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

3.10. action execution output show

Show Action execution output data.

Usage:

openstack action execution output show [-h] id

Table 3.38. Positional Arguments

Value	Summary
id	Action execution id.

Table 3.39. Optional Arguments

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

3.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] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX] [-s]
                                      [--run-sync] [-t TARGET]
                                      name [input]

Table 3.40. Table Formatter

Value	Summary
--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 3.41. Positional Arguments

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

Table 3.42. Output Formatters

Value	Summary
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 3.43. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 3.44. Optional Arguments

Value	Summary
-s, --save-result	Save the result into db.
-t TARGET, --target TARGET	Action will be executed on <target> executor.
-h, --help	Show this help message and exit
--run-sync	Run the action synchronously.

Table 3.45. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

3.12. action execution show

Show specific Action execution.

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

Table 3.46. Table Formatter

Value	Summary
--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 3.47. Positional Arguments

Value	Summary
action_execution	Action execution id.

Table 3.48. Output Formatters

Value	Summary
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 3.49. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 3.50. Optional Arguments

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

Table 3.51. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

3.13. action execution update

Update specific Action execution.

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

Table 3.52. Table Formatter

Value	Summary
--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 3.53. Positional Arguments

Value	Summary
id	Action execution id.

Table 3.54. Output Formatters

Value	Summary
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 3.55. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 3.56. Optional Arguments

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

Table 3.57. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

Select Your Language

Chapter 3. action

3.1. action definition create

3.2. action definition definition show

3.3. action definition delete

3.4. action definition list

3.5. action definition show

3.6. action definition update

3.7. action execution delete

3.8. action execution input show

3.9. action execution list

3.10. action execution output show

3.11. action execution run

3.12. action execution show

3.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 3. action

3.1. action definition create

3.2. action definition definition show

3.3. action definition delete

3.4. action definition list

3.5. action definition show

3.6. action definition update

3.7. action execution delete

3.8. action execution input show

3.9. action execution list

3.10. action execution output show

3.11. action execution run

3.12. action execution show

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