Chapter 76. stack

This chapter describes the commands under the stack command.

76.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 76.1. Positional Arguments

ValueSummary

<stack>

Name or id of stack to abandon

Table 76.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--output-file <output-file>

File to output abandon results

Table 76.3. Output Formatters

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 76.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.5. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 76.6. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

76.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 76.7. Positional Arguments

ValueSummary

<stack-name>

Name of the stack to adopt

Table 76.8. Optional 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 76.9. Output Formatters

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 76.10. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.11. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 76.12. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

76.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 76.13. Positional Arguments

ValueSummary

<stack>

Stack(s) to cancel (name or id)

Table 76.14. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait

Wait for cancel to complete

--no-rollback

Cancel without rollback

Table 76.15. Output Formatters

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 76.16. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 76.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.18. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

76.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 76.19. Positional Arguments

ValueSummary

<stack>

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

Table 76.20. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait

Wait for check to complete

Table 76.21. Output Formatters

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 76.22. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 76.23. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.24. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

76.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 76.25. Positional Arguments

ValueSummary

<stack-name>

Name of the stack to create

Table 76.26. Optional 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 76.27. Output Formatters

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 76.28. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.29. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 76.30. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

76.6. stack delete

Delete stack(s).

Usage:

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

Table 76.31. Positional Arguments

ValueSummary

<stack>

Stack(s) to delete (name or id)

Table 76.32. Optional 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

76.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 76.33. Positional Arguments

ValueSummary

<NAME or ID>

Name or id of stack to query

Table 76.34. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 76.35. Output Formatters

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 76.36. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.37. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 76.38. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

76.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 76.39. Positional Arguments

ValueSummary

<stack>

Name or id of stack to show events for

Table 76.40. Optional 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 76.41. Output Formatters

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 76.42. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 76.43. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.44. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

76.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 76.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 76.46. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 76.47. Output Formatters

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 76.48. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.49. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 76.50. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

76.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 76.51. Positional Arguments

ValueSummary

<stack>

Name or id of stack to export

Table 76.52. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--output-file <output-file>

File to output export data

Table 76.53. Output Formatters

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 76.54. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.55. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 76.56. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

76.11. stack failures list

Show information about failed stack resources.

Usage:

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

Table 76.57. Positional Arguments

ValueSummary

<stack>

Stack to display (name or id)

Table 76.58. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

Show full deployment logs in output

76.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 76.59. Positional Arguments

ValueSummary

<NAME or ID>

Name or id of stack to query

Table 76.60. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 76.61. Output Formatters

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 76.62. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.63. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 76.64. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

76.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 76.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 76.66. Optional 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

76.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 76.67. Positional Arguments

ValueSummary

<stack>

Stack to display (name or id)

Table 76.68. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--nested-depth <nested-depth>

Depth of nested stacks from which to display hooks

Table 76.69. Output Formatters

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 76.70. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 76.71. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.72. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

76.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 76.73. Optional 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 76.74. Output Formatters

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 76.75. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 76.76. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.77. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

76.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 76.78. Positional Arguments

ValueSummary

<stack>

Name or id of stack to query

Table 76.79. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 76.80. Output Formatters

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 76.81. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 76.82. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.83. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

76.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 76.84. Positional Arguments

ValueSummary

<stack>

Name or id of stack to query

<output>

Name of an output to display

Table 76.85. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all

Display all stack outputs

Table 76.86. Output Formatters

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 76.87. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.88. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 76.89. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

76.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 76.90. Positional Arguments

ValueSummary

<stack>

Name or id of stack to query

Table 76.91. Optional 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 76.92. Output Formatters

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 76.93. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 76.94. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.95. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

76.19. stack resource mark unhealthy

Set resource’s health.

Usage:

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

Table 76.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 76.97. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--reset

Set the resource as healthy

76.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 76.98. Positional Arguments

ValueSummary

<stack>

Stack to display (name or id)

<resource>

Name of the resource to show the metadata for

Table 76.99. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 76.100. Output Formatters

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 76.101. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.102. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 76.103. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

76.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 76.104. Positional Arguments

ValueSummary

<stack>

Name or id of stack to query

<resource>

Name of resource

Table 76.105. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--with-attr <attribute>

Attribute to show, can be specified multiple times

Table 76.106. Output Formatters

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 76.107. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.108. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 76.109. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

76.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 76.110. Positional Arguments

ValueSummary

<stack>

Name or id of stack the resource belongs to

<resource>

Name of the resoure to signal

Table 76.111. Optional 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

76.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 76.112. Positional Arguments

ValueSummary

<stack>

Stack(s) to resume (name or id)

Table 76.113. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait

Wait for resume to complete

Table 76.114. Output Formatters

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 76.115. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 76.116. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.117. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

76.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 76.118. Positional Arguments

ValueSummary

<stack>

Stack to display (name or id)

Table 76.119. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--no-resolve-outputs

Do not resolve outputs of the stack.

Table 76.120. Output Formatters

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 76.121. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.122. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 76.123. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

76.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 76.124. Positional Arguments

ValueSummary

<stack>

Name or id of stack

Table 76.125. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Name of snapshot

Table 76.126. Output Formatters

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 76.127. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.128. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 76.129. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

76.26. stack snapshot delete

Delete stack snapshot.

Usage:

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

Table 76.130. Positional Arguments

ValueSummary

<stack>

Name or id of stack

<snapshot>

Id of stack snapshot

Table 76.131. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

-y, --yes

Skip yes/no prompt (assume yes)

76.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 76.132. Positional Arguments

ValueSummary

<stack>

Name or id of stack containing the snapshots

Table 76.133. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 76.134. Output Formatters

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 76.135. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 76.136. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.137. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

76.28. stack snapshot restore

Restore stack snapshot

Usage:

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

Table 76.138. Positional Arguments

ValueSummary

<stack>

Name or id of stack containing the snapshot

<snapshot>

Id of the snapshot to restore

Table 76.139. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

76.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 76.140. Positional Arguments

ValueSummary

<stack>

Name or id of stack containing the snapshot

<snapshot>

Id of the snapshot to show

Table 76.141. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 76.142. Output Formatters

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 76.143. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.144. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 76.145. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

76.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 76.146. Positional Arguments

ValueSummary

<stack>

Stack(s) to suspend (name or id)

Table 76.147. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait

Wait for suspend to complete

Table 76.148. Output Formatters

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 76.149. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 76.150. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.151. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

76.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 76.152. Positional Arguments

ValueSummary

<stack>

Name or id of stack to query

Table 76.153. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 76.154. Output Formatters

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 76.155. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.156. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 76.157. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

76.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 76.158. Positional Arguments

ValueSummary

<stack>

Name or id of stack to update

Table 76.159. Optional 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 76.160. Output Formatters

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 76.161. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.162. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 76.163. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.