Red Hat Summit Red Hat SummitSupportKonsoleEntwicklerDemo startenKontakt

Dieser Inhalt ist in der von Ihnen ausgewählten Sprache nicht verfügbar.

Chapter 3. action

This chapter describes the commands under the action command.

3.1. action definition create
Link kopieren

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
Copy to Clipboard Toggle word wrap

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

Expand
Table 3.2. Positional Arguments
ValueSummary

definition

Action definition file

Expand
Table 3.3. CSV Formatter
ValueSummary

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

When to include quotes, defaults to nonnumeric

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

Expand
Table 3.5. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 3.6. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--public

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

3.2. action definition definition show
Link kopieren

Show action definition.

Usage:

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

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

3.3. action definition delete
Link kopieren

Delete action.

Usage:

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

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

3.4. action definition list
Link kopieren

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

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

Expand
Table 3.12. CSV Formatter
ValueSummary

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

When to include quotes, defaults to nonnumeric

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

Expand
Table 3.14. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 3.15. Optional Arguments
ValueSummary

--filter FILTERS

Filters. can be repeated.

-h, --help

Show this help message and exit

3.5. action definition show
Link kopieren

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
Copy to Clipboard Toggle word wrap

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

Expand
Table 3.17. Positional Arguments
ValueSummary

action

Action (name or id)

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

Expand
Table 3.19. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 3.20. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 3.21. Shell Formatter
ValueSummary

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

Add a prefix to all variable names

3.6. action definition update
Link kopieren

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
Copy to Clipboard Toggle word wrap

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

Expand
Table 3.23. Positional Arguments
ValueSummary

definition

Action definition file

Expand
Table 3.24. CSV Formatter
ValueSummary

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

When to include quotes, defaults to nonnumeric

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

Expand
Table 3.26. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 3.27. 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".

3.7. action execution delete
Link kopieren

Delete action execution.

Usage:

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

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

3.8. action execution input show
Link kopieren

Show Action execution input data.

Usage:

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

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

3.9. action execution list
Link kopieren

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

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

Expand
Table 3.33. Positional Arguments
ValueSummary

task_execution_id

Task execution id.

Expand
Table 3.34. CSV Formatter
ValueSummary

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

When to include quotes, defaults to nonnumeric

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

Expand
Table 3.36. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

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

3.10. action execution output show
Link kopieren

Show Action execution output data.

Usage:

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

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

3.11. action execution run
Link kopieren

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

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

Expand
Table 3.41. Positional Arguments
ValueSummary

input

Action input.

name

Action name to execute.

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

Expand
Table 3.43. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 3.44. Optional Arguments
ValueSummary

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

Expand
Table 3.45. Shell Formatter
ValueSummary

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

Add a prefix to all variable names

3.12. action execution show
Link kopieren

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
Copy to Clipboard Toggle word wrap

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

Expand
Table 3.47. Positional Arguments
ValueSummary

action_execution

Action execution id.

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

Expand
Table 3.49. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 3.50. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 3.51. Shell Formatter
ValueSummary

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

Add a prefix to all variable names

3.13. action execution update
Link kopieren

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
Copy to Clipboard Toggle word wrap

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

Expand
Table 3.53. Positional Arguments
ValueSummary

id

Action execution id.

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

Expand
Table 3.55. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 3.56. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--output OUTPUT

Action execution output

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

Action execution state

Expand
Table 3.57. Shell Formatter
ValueSummary

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

Add a prefix to all variable names

Nach oben
Red Hat logoGithubredditYoutubeTwitter

Lernen

Testen, kaufen und verkaufen

Communitys

Über Red Hat Dokumentation

Wir helfen Red Hat Benutzern, mit unseren Produkten und Diensten innovativ zu sein und ihre Ziele zu erreichen – mit Inhalten, denen sie vertrauen können. Entdecken Sie unsere neuesten Updates.

Mehr Inklusion in Open Source

Red Hat hat sich verpflichtet, problematische Sprache in unserem Code, unserer Dokumentation und unseren Web-Eigenschaften zu ersetzen. Weitere Einzelheiten finden Sie in Red Hat Blog.

Über Red Hat

Wir liefern gehärtete Lösungen, die es Unternehmen leichter machen, plattform- und umgebungsübergreifend zu arbeiten, vom zentralen Rechenzentrum bis zum Netzwerkrand.

Theme

© 2025 Red Hat