Menu Close

Chapter 62. stack

This chapter describes the commands under the stack command.

62.1. stack abandon

Abandon stack and output results.

Usage:

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

Table 62.1. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

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

--fit-width

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

Table 62.2. Positional Arguments

ValueSummary

<stack>

Name or id of stack to abandon

Table 62.3. Output Formatters

ValueSummary

output formatter options-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 62.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.5. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--output-file <output-file>

File to output abandon results

Table 62.6. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

62.2. stack adopt

Adopt a stack.

Usage:

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

Table 62.7. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

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

--fit-width

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

Table 62.8. Positional Arguments

ValueSummary

<stack-name>

Name of the stack to adopt

Table 62.9. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 62.10. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.11. Optional Arguments

ValueSummary

--timeout <timeout>

Stack creation timeout in minutes

--wait

Wait until stack adopt completes

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

Path to the environment. can be specified multiple times

--adopt-file <adopt-file>

Path to adopt stack data file

--parameter <key=value>

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

-h, --help

Show this help message and exit

--enable-rollback

Enable rollback on create/update failure

Table 62.12. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

62.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] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--sort-column SORT_COLUMN] [--wait]
                              [--no-rollback]
                              <stack> [<stack> ...]

Table 62.13. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

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

--fit-width

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

Table 62.14. Positional Arguments

ValueSummary

<stack>

Stack(s) to cancel (name or id)

Table 62.15. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 62.16. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 62.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.18. Optional Arguments

ValueSummary

--no-rollback

Cancel without rollback

-h, --help

Show this help message and exit

--wait

Wait for cancel to complete

62.4. stack check

Check a stack.

Usage:

openstack stack check [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--sort-column SORT_COLUMN] [--wait]
                             <stack> [<stack> ...]

Table 62.19. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

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

--fit-width

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

Table 62.20. Positional Arguments

ValueSummary

<stack>

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

Table 62.21. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 62.22. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 62.23. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.24. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait

Wait for check to complete

62.5. stack create

Create a stack.

Usage:

openstack stack create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX] [-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 62.25. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

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

--fit-width

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

Table 62.26. Positional Arguments

ValueSummary

<stack-name>

Name of the stack to create

Table 62.27. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 62.28. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.29. Optional Arguments

ValueSummary

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

--timeout <timeout>

Stack creating timeout in minutes

--wait

Wait until stack goes to create_complete or CREATE_FAILED

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

Path to the template

--dry-run

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

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

Path to the environment. can be specified multiple times

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

--parameter <key=value>

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

-h, --help

Show this help message and exit

--tags <tag1,tag2…​>

A list of tags to associate with the stack

--enable-rollback

Enable rollback on create/update failure

Table 62.30. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

62.6. stack delete

Delete stack(s).

Usage:

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

Table 62.31. Positional Arguments

ValueSummary

<stack>

Stack(s) to delete (name or id)

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

62.7. stack environment show

Show a stack’s environment.

Usage:

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

Table 62.33. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

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

--fit-width

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

Table 62.34. Positional Arguments

ValueSummary

<NAME or ID>

Name or id of stack to query

Table 62.35. Output Formatters

ValueSummary

output formatter options-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 62.36. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.37. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 62.38. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

62.8. stack event list

List events.

Usage:

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

Table 62.39. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

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

--fit-width

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

Table 62.40. Positional Arguments

ValueSummary

<stack>

Name or id of stack to show events for

Table 62.41. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 62.42. Output Formatters

ValueSummary

output formatter options-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 62.43. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.44. Optional Arguments

ValueSummary

--filter <key=value>

Filter parameters to apply on returned events

--nested-depth <depth>

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

--follow

Print events until process is halted

--resource <resource>

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

--limit <limit>

Limit the number of events returned

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

-h, --help

Show this help message and exit

--marker <id>

Only return events that appear after the given id

62.9. stack event show

Show event details.

Usage:

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

Table 62.45. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

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

--fit-width

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

Table 62.46. Positional Arguments

ValueSummary

<resource>

Name of the resource event belongs to

<stack>

Name or id of stack to show events for

<event>

Id of event to display details for

Table 62.47. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 62.48. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.49. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 62.50. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

62.10. stack export

Export stack data json.

Usage:

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

Table 62.51. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

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

--fit-width

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

Table 62.52. Positional Arguments

ValueSummary

<stack>

Name or id of stack to export

Table 62.53. Output Formatters

ValueSummary

output formatter options-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 62.54. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.55. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--output-file <output-file>

File to output export data

Table 62.56. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

62.11. stack failures list

Show information about failed stack resources.

Usage:

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

Table 62.57. Positional Arguments

ValueSummary

<stack>

Stack to display (name or id)

Table 62.58. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

Show full deployment logs in output

62.12. stack file list

Show a stack’s files map.

Usage:

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

Table 62.59. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

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

--fit-width

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

Table 62.60. Positional Arguments

ValueSummary

<NAME or ID>

Name or id of stack to query

Table 62.61. Output Formatters

ValueSummary

output formatter options-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 62.62. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.63. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 62.64. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

62.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 62.65. Positional Arguments

ValueSummary

<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

<stack>

Stack to display (name or id)

Table 62.66. Optional Arguments

ValueSummary

--pre-update

Clear the pre-update hooks

-h, --help

Show this help message and exit

--pre-create

Clear the pre-create hooks

--pre-delete

Clear the pre-delete hooks

62.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] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--sort-column SORT_COLUMN]
                                 [--nested-depth <nested-depth>]
                                 <stack>

Table 62.67. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

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

--fit-width

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

Table 62.68. Positional Arguments

ValueSummary

<stack>

Stack to display (name or id)

Table 62.69. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 62.70. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 62.71. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.72. Optional Arguments

ValueSummary

--nested-depth <nested-depth>

Depth of nested stacks from which to display hooks

-h, --help

Show this help message and exit

62.15. stack list

List stacks.

Usage:

openstack stack list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--noindent]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--sort-column SORT_COLUMN] [--deleted] [--nested]
                            [--hidden] [--property <key=value>]
                            [--tags <tag1,tag2...>] [--tag-mode <mode>]
                            [--limit <limit>] [--marker <id>]
                            [--sort <key>[:<direction>]] [--all-projects]
                            [--short] [--long]

Table 62.73. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

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

--fit-width

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

Table 62.74. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 62.75. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 62.76. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.77. Optional Arguments

ValueSummary

--all-projects

Include all projects (admin only)

--hidden

Include hidden stacks in the stack listing

--property <key=value>

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

--short

List fewer fields in output

--limit <limit>

The number of stacks returned

--long

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

--nested

Include nested stacks in the stack listing

--deleted

Include soft-deleted stacks in the stack listing

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

-h, --help

Show this help message and exit

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

62.16. stack output list

List stack outputs.

Usage:

openstack stack output list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--sort-column SORT_COLUMN]
                                   <stack>

Table 62.78. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

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

--fit-width

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

Table 62.79. Positional Arguments

ValueSummary

<stack>

Name or id of stack to query

Table 62.80. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 62.81. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 62.82. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.83. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

62.17. stack output show

Show stack output.

Usage:

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

Table 62.84. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

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

--fit-width

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

Table 62.85. Positional Arguments

ValueSummary

<stack>

Name or id of stack to query

<output>

Name of an output to display

Table 62.86. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 62.87. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.88. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all

Display all stack outputs

Table 62.89. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

62.18. stack resource list

List stack resources.

Usage:

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

Table 62.90. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

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

--fit-width

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

Table 62.91. Positional Arguments

ValueSummary

<stack>

Name or id of stack to query

Table 62.92. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 62.93. Output Formatters

ValueSummary

output formatter options-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 62.94. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.95. Optional Arguments

ValueSummary

--filter <key=value>

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

-h, --help

Show this help message and exit

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

Depth of nested stacks from which to display resources

--long

Enable detailed information presented for each resource in resource list

62.19. stack resource mark unhealthy

Set resource’s health.

Usage:

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

Table 62.96. Positional Arguments

ValueSummary

reason

Reason for state change

<resource>

Name of the resource

<stack>

Name or id of stack the resource belongs to

Table 62.97. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--reset

Set the resource as healthy

62.20. stack resource metadata

Show resource metadata

Usage:

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

Table 62.98. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

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

--fit-width

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

Table 62.99. Positional Arguments

ValueSummary

<resource>

Name of the resource to show the metadata for

<stack>

Stack to display (name or id)

Table 62.100. Output Formatters

ValueSummary

output formatter options-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 62.101. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.102. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 62.103. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

62.21. stack resource show

Display stack resource.

Usage:

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

Table 62.104. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

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

--fit-width

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

Table 62.105. Positional Arguments

ValueSummary

<resource>

Name of resource

<stack>

Name or id of stack to query

Table 62.106. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 62.107. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.108. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--with-attr <attribute>

Attribute to show, can be specified multiple times

Table 62.109. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

62.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 62.110. Positional Arguments

ValueSummary

<resource>

Name of the resoure to signal

<stack>

Name or id of stack the resource belongs to

Table 62.111. Optional Arguments

ValueSummary

--data <data>

Json data to send to the signal handler

-h, --help

Show this help message and exit

--data-file <data-file>

File containing json data to send to the signal handler

62.23. stack resume

Resume a stack.

Usage:

openstack stack resume [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--sort-column SORT_COLUMN] [--wait]
                              <stack> [<stack> ...]

Table 62.112. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

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

--fit-width

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

Table 62.113. Positional Arguments

ValueSummary

<stack>

Stack(s) to resume (name or id)

Table 62.114. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 62.115. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 62.116. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.117. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait

Wait for resume to complete

62.24. stack show

Show stack details.

Usage:

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

Table 62.118. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

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

--fit-width

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

Table 62.119. Positional Arguments

ValueSummary

<stack>

Stack to display (name or id)

Table 62.120. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 62.121. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.122. Optional Arguments

ValueSummary

--no-resolve-outputs

Do not resolve outputs of the stack.

-h, --help

Show this help message and exit

Table 62.123. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

62.25. stack snapshot create

Create stack snapshot.

Usage:

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

Table 62.124. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

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

--fit-width

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

Table 62.125. Positional Arguments

ValueSummary

<stack>

Name or id of stack

Table 62.126. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 62.127. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.128. Optional Arguments

ValueSummary

--name <name>

Name of snapshot

-h, --help

Show this help message and exit

Table 62.129. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

62.26. stack snapshot delete

Delete stack snapshot.

Usage:

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

Table 62.130. Positional Arguments

ValueSummary

<snapshot>

Id of stack snapshot

<stack>

Name or id of stack

Table 62.131. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

-y, --yes

Skip yes/no prompt (assume yes)

62.27. stack snapshot list

List stack snapshots.

Usage:

openstack stack snapshot list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--sort-column SORT_COLUMN]
                                     <stack>

Table 62.132. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

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

--fit-width

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

Table 62.133. Positional Arguments

ValueSummary

<stack>

Name or id of stack containing the snapshots

Table 62.134. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 62.135. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 62.136. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.137. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

62.28. stack snapshot restore

Restore stack snapshot

Usage:

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

Table 62.138. Positional Arguments

ValueSummary

<snapshot>

Id of the snapshot to restore

<stack>

Name or id of stack containing the snapshot

Table 62.139. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

62.29. stack snapshot show

Show stack snapshot.

Usage:

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

Table 62.140. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

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

--fit-width

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

Table 62.141. Positional Arguments

ValueSummary

<snapshot>

Id of the snapshot to show

<stack>

Name or id of stack containing the snapshot

Table 62.142. Output Formatters

ValueSummary

output formatter options-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 62.143. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.144. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 62.145. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

62.30. stack suspend

Suspend a stack.

Usage:

openstack stack suspend [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--sort-column SORT_COLUMN] [--wait]
                               <stack> [<stack> ...]

Table 62.146. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

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

--fit-width

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

Table 62.147. Positional Arguments

ValueSummary

<stack>

Stack(s) to suspend (name or id)

Table 62.148. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 62.149. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 62.150. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.151. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait

Wait for suspend to complete

62.31. stack template show

Display stack template.

Usage:

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

Table 62.152. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

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

--fit-width

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

Table 62.153. Positional Arguments

ValueSummary

<stack>

Name or id of stack to query

Table 62.154. Output Formatters

ValueSummary

output formatter options-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 62.155. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.156. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 62.157. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

62.32. stack update

Update a stack.

Usage:

openstack stack update [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX] [-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 62.158. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

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

--fit-width

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

Table 62.159. Positional Arguments

ValueSummary

<stack>

Name or id of stack to update

Table 62.160. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 62.161. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.162. Optional Arguments

ValueSummary

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

--timeout <timeout>

Stack update timeout in minutes

--wait

Wait until stack goes to update_complete or UPDATE_FAILED

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

Path to the template

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

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

Path to the environment. can be specified multiple times

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

--converge

Stack update with observe on reality.

--dry-run

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

-h, --help

Show this help message and exit

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

--show-nested

Show nested stacks when performing --dry-run

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

Table 62.163. Shell Formatter

ValueSummary

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

Add a prefix to all variable names