Chapter 74. stack

This chapter describes the commands under the stack command.

74.1. stack abandon

Abandon stack and output results.

Usage:

openstack stack abandon [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--output-file <output-file>]
                               <stack>

Table 74.1. Positional arguments

ValueSummary

<stack>

Name or id of stack to abandon

Table 74.2. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--output-file <output-file>

File to output abandon results

Table 74.3. Output formatter options

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to json

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.4. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.5. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 74.6. Table formatter options

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.

74.2. stack adopt

Adopt a stack.

Usage:

openstack stack adopt [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [-e <environment>]
                             [--timeout <timeout>] [--enable-rollback]
                             [--parameter <key=value>] [--wait] --adopt-file
                             <adopt-file>
                             <stack-name>

Table 74.7. Positional arguments

ValueSummary

<stack-name>

Name of the stack to adopt

Table 74.8. Command arguments

ValueSummary

-h, --help

Show this help message and exit

-e <environment>, --environment <environment>

Path to the environment. can be specified multiple times

--timeout <timeout>

Stack creation timeout in minutes

--enable-rollback

Enable rollback on create/update failure

--parameter <key=value>

Parameter values used to create the stack. can be specified multiple times

--wait

Wait until stack adopt completes

--adopt-file <adopt-file>

Path to adopt stack data file

Table 74.9. Output formatter options

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

Table 74.10. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.11. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 74.12. Table formatter options

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.

74.3. stack cancel

Cancel current task for a stack. Supported tasks for cancellation: * update * create

Usage:

openstack stack cancel [-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] [--wait]
                              [--no-rollback]
                              <stack> [<stack> ...]

Table 74.13. Positional arguments

ValueSummary

<stack>

Stack(s) to cancel (name or id)

Table 74.14. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--wait

Wait for cancel to complete

--no-rollback

Cancel without rollback

Table 74.15. Output formatter options

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

Table 74.16. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 74.17. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.18. Table formatter options

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.

74.4. stack check

Check a stack.

Usage:

openstack stack check [-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] [--wait]
                             <stack> [<stack> ...]

Table 74.19. Positional arguments

ValueSummary

<stack>

Stack(s) to check update (name or id)

Table 74.20. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--wait

Wait for check to complete

Table 74.21. Output formatter options

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

Table 74.22. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 74.23. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.24. Table formatter options

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.

74.5. stack create

Create a stack.

Usage:

openstack stack create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [-e <environment>]
                              [--timeout <timeout>] [--pre-create <resource>]
                              [--enable-rollback] [--parameter <key=value>]
                              [--parameter-file <key=file>] [--wait]
                              [--tags <tag1,tag2...>] [--dry-run] -t
                              <template>
                              <stack-name>

Table 74.25. Positional arguments

ValueSummary

<stack-name>

Name of the stack to create

Table 74.26. Command arguments

ValueSummary

-h, --help

Show this help message and exit

-e <environment>, --environment <environment>

Path to the environment. can be specified multiple times

--timeout <timeout>

Stack creating timeout in minutes

--pre-create <resource>

Name of a resource to set a pre-create hook to. Resources in nested stacks can be set using slash as a separator: ``nested_stack/another/my_resource``. You can use wildcards to match multiple stacks or resources: ``nested_stack/an*/*_resource``. This can be specified multiple times

--enable-rollback

Enable rollback on create/update failure

--parameter <key=value>

Parameter values used to create the stack. this can be specified multiple times

--parameter-file <key=file>

Parameter values from file used to create the stack. This can be specified multiple times. Parameter values would be the content of the file

--wait

Wait until stack goes to create_complete or CREATE_FAILED

--tags <tag1,tag2…​>

A list of tags to associate with the stack

--dry-run

Do not actually perform the stack create, but show what would be created

-t <template>, --template <template>

Path to the template

Table 74.27. Output formatter options

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

Table 74.28. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.29. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 74.30. Table formatter options

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.

74.6. stack delete

Delete stack(s).

Usage:

openstack stack delete [-h] [-y] [--wait] <stack> [<stack> ...]

Table 74.31. Positional arguments

ValueSummary

<stack>

Stack(s) to delete (name or id)

Table 74.32. Command arguments

ValueSummary

-h, --help

Show this help message and exit

-y, --yes

Skip yes/no prompt (assume yes)

--wait

Wait for stack delete to complete

74.7. stack environment show

Show a stack’s environment.

Usage:

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

Table 74.33. Positional arguments

ValueSummary

<NAME or ID>

Name or id of stack to query

Table 74.34. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 74.35. Output formatter options

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to yaml

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.36. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.37. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 74.38. Table formatter options

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.

74.8. stack event list

List events.

Usage:

openstack stack event list [-h] [-f {csv,json,log,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN]
                                  [--resource <resource>]
                                  [--filter <key=value>] [--limit <limit>]
                                  [--marker <id>] [--nested-depth <depth>]
                                  [--sort <key>[:<direction>]] [--follow]
                                  <stack>

Table 74.39. Positional arguments

ValueSummary

<stack>

Name or id of stack to show events for

Table 74.40. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--resource <resource>

Name of resource to show events for. note: this cannot be specified with --nested-depth

--filter <key=value>

Filter parameters to apply on returned events

--limit <limit>

Limit the number of events returned

--marker <id>

Only return events that appear after the given id

--nested-depth <depth>

Depth of nested stacks from which to display events. Note: this cannot be specified with --resource

--sort <key>[:<direction>]

Sort output by selected keys and directions (asc or desc) (default: asc). Specify multiple times to sort on multiple keys. Sort key can be: "event_time" (default), "resource_name", "links", "logical_resource_id", "resource_status", "resource_status_reason", "physical_resource_id", or "id". You can leave the key empty and specify ":desc" for sorting by reverse time.

--follow

Print events until process is halted

Table 74.41. Output formatter options

ValueSummary

-f {csv,json,log,table,value,yaml}, --format {csv,json,log,table,value,yaml}

The output format, defaults to log

-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 74.42. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 74.43. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.44. Table formatter options

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.

74.9. stack event show

Show event details.

Usage:

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

Table 74.45. Positional arguments

ValueSummary

<stack>

Name or id of stack to show events for

<resource>

Name of the resource event belongs to

<event>

Id of event to display details for

Table 74.46. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 74.47. Output formatter options

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

Table 74.48. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.49. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 74.50. Table formatter options

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.

74.10. stack export

Export stack data json.

Usage:

openstack stack export [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--output-file <output-file>]
                              <stack>

Table 74.51. Positional arguments

ValueSummary

<stack>

Name or id of stack to export

Table 74.52. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--output-file <output-file>

File to output export data

Table 74.53. Output formatter options

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to json

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.54. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.55. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 74.56. Table formatter options

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.

74.11. stack failures list

Show information about failed stack resources.

Usage:

openstack stack failures list [-h] [--long] <stack>

Table 74.57. Positional arguments

ValueSummary

<stack>

Stack to display (name or id)

Table 74.58. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--long

Show full deployment logs in output

74.12. stack file list

Show a stack’s files map.

Usage:

openstack stack file list [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty]
                                 <NAME or ID>

Table 74.59. Positional arguments

ValueSummary

<NAME or ID>

Name or id of stack to query

Table 74.60. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 74.61. Output formatter options

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to yaml

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.62. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.63. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 74.64. Table formatter options

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.

74.13. stack hook clear

Clear resource hooks on a given stack.

Usage:

openstack stack hook clear [-h] [--pre-create] [--pre-update]
                                  [--pre-delete]
                                  <stack> <resource> [<resource> ...]

Table 74.65. Positional arguments

ValueSummary

<stack>

Stack to display (name or id)

<resource>

Resource names with hooks to clear. resources in nested stacks can be set using slash as a separator: ``nested_stack/another/my_resource``. You can use wildcards to match multiple stacks or resources: ``nested_stack/an*/*_resource``

Table 74.66. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--pre-create

Clear the pre-create hooks

--pre-update

Clear the pre-update hooks

--pre-delete

Clear the pre-delete hooks

74.14. stack hook poll

List resources with pending hook for a stack.

Usage:

openstack stack hook poll [-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]
                                 [--nested-depth <nested-depth>]
                                 <stack>

Table 74.67. Positional arguments

ValueSummary

<stack>

Stack to display (name or id)

Table 74.68. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--nested-depth <nested-depth>

Depth of nested stacks from which to display hooks

Table 74.69. Output formatter options

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

Table 74.70. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 74.71. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.72. Table formatter options

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.

74.15. stack list

List stacks.

Usage:

openstack stack 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]
                            [--deleted] [--nested] [--hidden]
                            [--property <key=value>] [--tags <tag1,tag2...>]
                            [--tag-mode <mode>] [--limit <limit>]
                            [--marker <id>] [--sort <key>[:<direction>]]
                            [--all-projects] [--short] [--long]

Table 74.73. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--deleted

Include soft-deleted stacks in the stack listing

--nested

Include nested stacks in the stack listing

--hidden

Include hidden stacks in the stack listing

--property <key=value>

Filter properties to apply on returned stacks (repeat to filter on multiple properties)

--tags <tag1,tag2…​>

List of tags to filter by. can be combined with --tag- mode to specify how to filter tags

--tag-mode <mode>

Method of filtering tags. must be one of "any", "not", or "not-any". If not specified, multiple tags will be combined with the boolean AND expression

--limit <limit>

The number of stacks returned

--marker <id>

Only return stacks that appear after the given id

--sort <key>[:<direction>]

Sort output by selected keys and directions (asc or desc) (default: asc). Specify multiple times to sort on multiple properties

--all-projects

Include all projects (admin only)

--short

List fewer fields in output

--long

List additional fields in output, this is implied by --all-projects

Table 74.74. Output formatter options

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

Table 74.75. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 74.76. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.77. Table formatter options

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.

74.16. stack output list

List stack outputs.

Usage:

openstack stack output 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]
                                   <stack>

Table 74.78. Positional arguments

ValueSummary

<stack>

Name or id of stack to query

Table 74.79. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 74.80. Output formatter options

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

Table 74.81. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 74.82. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.83. Table formatter options

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.

74.17. stack output show

Show stack output.

Usage:

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

Table 74.84. Positional arguments

ValueSummary

<stack>

Name or id of stack to query

<output>

Name of an output to display

Table 74.85. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--all

Display all stack outputs

Table 74.86. Output formatter options

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

Table 74.87. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.88. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 74.89. Table formatter options

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.

74.18. stack resource list

List stack resources.

Usage:

openstack stack resource list [-h] [-f {csv,dot,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN] [--long]
                                     [-n <nested-depth>]
                                     [--filter <key=value>]
                                     <stack>

Table 74.90. Positional arguments

ValueSummary

<stack>

Name or id of stack to query

Table 74.91. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--long

Enable detailed information presented for each resource in resource list

-n <nested-depth>, --nested-depth <nested-depth>

Depth of nested stacks from which to display resources

--filter <key=value>

Filter parameters to apply on returned resources based on their name, status, type, action, id and physical_resource_id

Table 74.92. Output formatter options

ValueSummary

-f {csv,dot,json,table,value,yaml}, --format {csv,dot,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 74.93. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 74.94. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.95. Table formatter options

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.

74.19. stack resource mark unhealthy

Set resource’s health.

Usage:

openstack stack resource mark unhealthy [-h] [--reset]
                                               <stack> <resource> [reason]

Table 74.96. Positional arguments

ValueSummary

<stack>

Name or id of stack the resource belongs to

<resource>

Name of the resource

reason

Reason for state change

Table 74.97. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--reset

Set the resource as healthy

74.20. stack resource metadata

Show resource metadata

Usage:

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

Table 74.98. Positional arguments

ValueSummary

<stack>

Stack to display (name or id)

<resource>

Name of the resource to show the metadata for

Table 74.99. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 74.100. Output formatter options

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to json

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.101. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.102. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 74.103. Table formatter options

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.

74.21. stack resource show

Display stack resource.

Usage:

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

Table 74.104. Positional arguments

ValueSummary

<stack>

Name or id of stack to query

<resource>

Name of resource

Table 74.105. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--with-attr <attribute>

Attribute to show, can be specified multiple times

Table 74.106. Output formatter options

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

Table 74.107. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.108. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 74.109. Table formatter options

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.

74.22. stack resource signal

Signal a resource with optional data.

Usage:

openstack stack resource signal [-h] [--data <data>]
                                       [--data-file <data-file>]
                                       <stack> <resource>

Table 74.110. Positional arguments

ValueSummary

<stack>

Name or id of stack the resource belongs to

<resource>

Name of the resoure to signal

Table 74.111. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--data <data>

Json data to send to the signal handler

--data-file <data-file>

File containing json data to send to the signal handler

74.23. stack resume

Resume a stack.

Usage:

openstack stack resume [-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] [--wait]
                              <stack> [<stack> ...]

Table 74.112. Positional arguments

ValueSummary

<stack>

Stack(s) to resume (name or id)

Table 74.113. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--wait

Wait for resume to complete

Table 74.114. Output formatter options

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

Table 74.115. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 74.116. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.117. Table formatter options

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.

74.24. stack show

Show stack details.

Usage:

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

Table 74.118. Positional arguments

ValueSummary

<stack>

Stack to display (name or id)

Table 74.119. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--no-resolve-outputs

Do not resolve outputs of the stack.

Table 74.120. Output formatter options

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

Table 74.121. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.122. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 74.123. Table formatter options

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.

74.25. stack snapshot create

Create stack snapshot.

Usage:

openstack stack snapshot create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty] [--name <name>]
                                       <stack>

Table 74.124. Positional arguments

ValueSummary

<stack>

Name or id of stack

Table 74.125. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Name of snapshot

Table 74.126. Output formatter options

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

Table 74.127. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.128. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 74.129. Table formatter options

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.

74.26. stack snapshot delete

Delete stack snapshot.

Usage:

openstack stack snapshot delete [-h] [-y] <stack> <snapshot>

Table 74.130. Positional arguments

ValueSummary

<stack>

Name or id of stack

<snapshot>

Id of stack snapshot

Table 74.131. Command arguments

ValueSummary

-h, --help

Show this help message and exit

-y, --yes

Skip yes/no prompt (assume yes)

74.27. stack snapshot list

List stack snapshots.

Usage:

openstack stack snapshot 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]
                                     <stack>

Table 74.132. Positional arguments

ValueSummary

<stack>

Name or id of stack containing the snapshots

Table 74.133. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 74.134. Output formatter options

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

Table 74.135. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 74.136. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.137. Table formatter options

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.

74.28. stack snapshot restore

Restore stack snapshot

Usage:

openstack stack snapshot restore [-h] <stack> <snapshot>

Table 74.138. Positional arguments

ValueSummary

<stack>

Name or id of stack containing the snapshot

<snapshot>

Id of the snapshot to restore

Table 74.139. Command arguments

ValueSummary

-h, --help

Show this help message and exit

74.29. stack snapshot show

Show stack snapshot.

Usage:

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

Table 74.140. Positional arguments

ValueSummary

<stack>

Name or id of stack containing the snapshot

<snapshot>

Id of the snapshot to show

Table 74.141. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 74.142. Output formatter options

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to yaml

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.143. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.144. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 74.145. Table formatter options

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.

74.30. stack suspend

Suspend a stack.

Usage:

openstack stack suspend [-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] [--wait]
                               <stack> [<stack> ...]

Table 74.146. Positional arguments

ValueSummary

<stack>

Stack(s) to suspend (name or id)

Table 74.147. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--wait

Wait for suspend to complete

Table 74.148. Output formatter options

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

Table 74.149. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 74.150. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.151. Table formatter options

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.

74.31. stack template show

Display stack template.

Usage:

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

Table 74.152. Positional arguments

ValueSummary

<stack>

Name or id of stack to query

Table 74.153. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 74.154. Output formatter options

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to yaml

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.155. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.156. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 74.157. Table formatter options

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.

74.32. stack update

Update a stack.

Usage:

openstack stack update [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [-t <template>]
                              [-e <environment>] [--pre-update <resource>]
                              [--timeout <timeout>] [--rollback <value>]
                              [--dry-run] [--show-nested]
                              [--parameter <key=value>]
                              [--parameter-file <key=file>] [--existing]
                              [--clear-parameter <parameter>]
                              [--tags <tag1,tag2...>] [--wait] [--converge]
                              <stack>

Table 74.158. Positional arguments

ValueSummary

<stack>

Name or id of stack to update

Table 74.159. Command arguments

ValueSummary

-h, --help

Show this help message and exit

-t <template>, --template <template>

Path to the template

-e <environment>, --environment <environment>

Path to the environment. can be specified multiple times

--pre-update <resource>

Name of a resource to set a pre-update hook to. Resources in nested stacks can be set using slash as a separator: ``nested_stack/another/my_resource``. You can use wildcards to match multiple stacks or resources: ``nested_stack/an*/*_resource``. This can be specified multiple times

--timeout <timeout>

Stack update timeout in minutes

--rollback <value>

Set rollback on update failure. value "enabled" sets rollback to enabled. Value "disabled" sets rollback to disabled. Value "keep" uses the value of existing stack to be updated (default)

--dry-run

Do not actually perform the stack update, but show what would be changed

--show-nested

Show nested stacks when performing --dry-run

--parameter <key=value>

Parameter values used to create the stack. this can be specified multiple times

--parameter-file <key=file>

Parameter values from file used to create the stack. This can be specified multiple times. Parameter value would be the content of the file

--existing

Re-use the template, parameters and environment of the current stack. If the template argument is omitted then the existing template is used. If no --environment is specified then the existing environment is used. Parameters specified in --parameter will patch over the existing values in the current stack. Parameters omitted will keep the existing values

--clear-parameter <parameter>

Remove the parameters from the set of parameters of current stack for the stack-update. The default value in the template will be used. This can be specified multiple times

--tags <tag1,tag2…​>

An updated list of tags to associate with the stack

--wait

Wait until stack goes to update_complete or UPDATE_FAILED

--converge

Stack update with observe on reality.

Table 74.160. Output formatter options

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

Table 74.161. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.162. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 74.163. Table formatter options

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.