Chapter 77. stack
Chapter 77. stack This chapter describes the commands under the stack command. 77.1. stack abandon Abandon stack and output results. Usage: Table 77.1. Positional arguments Value Summary <stack> Name or id of stack to abandon Table 77.2. Command arguments Value Summary -h, --help Show this help message and exit --output-file <output-file> File to output abandon results Table 77.3. Output formatter options Value Summary -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 to show multiple columns Table 77.4. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 77.5. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 77.6. Table formatter options Value Summary --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. 77.2. stack adopt Adopt a stack. Usage: Table 77.7. Positional arguments Value Summary <stack-name> Name of the stack to adopt Table 77.8. Command arguments Value Summary -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 77.9. Output formatter options Value Summary -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 to show multiple columns Table 77.10. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 77.11. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 77.12. Table formatter options Value Summary --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. 77.3. stack cancel Cancel current task for a stack. Supported tasks for cancellation: * update * create Usage: Table 77.13. Positional arguments Value Summary <stack> Stack(s) to cancel (name or id) Table 77.14. Command arguments Value Summary -h, --help Show this help message and exit --wait Wait for cancel to complete --no-rollback Cancel without rollback Table 77.15. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 77.16. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 77.17. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 77.18. Table formatter options Value Summary --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. 77.4. stack check Check a stack. Usage: Table 77.19. Positional arguments Value Summary <stack> Stack(s) to check update (name or id) Table 77.20. Command arguments Value Summary -h, --help Show this help message and exit --wait Wait for check to complete Table 77.21. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 77.22. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 77.23. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 77.24. Table formatter options Value Summary --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. 77.5. stack create Create a stack. Usage: Table 77.25. Positional arguments Value Summary <stack-name> Name of the stack to create Table 77.26. Command arguments Value Summary -h, --help Show this help message and exit -e <environment>, --environment <environment> Path to the environment. can be specified multiple times -s <files-container>, --files-container <files-container> Swift files container name. local files other than root template would be ignored. If other files are not found in swift, heat engine would raise an error. --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 --poll SECONDS Poll interval in seconds for use with --wait, defaults to 5. --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 77.27. Output formatter options Value Summary -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 to show multiple columns Table 77.28. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 77.29. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 77.30. Table formatter options Value Summary --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. 77.6. stack delete Delete stack(s). Usage: Table 77.31. Positional arguments Value Summary <stack> Stack(s) to delete (name or id) Table 77.32. Command arguments Value Summary -h, --help Show this help message and exit -y, --yes Skip yes/no prompt (assume yes) --wait Wait for stack delete to complete 77.7. stack environment show Show a stack's environment. Usage: Table 77.33. Positional arguments Value Summary <NAME or ID> Name or id of stack to query Table 77.34. Command arguments Value Summary -h, --help Show this help message and exit Table 77.35. Output formatter options Value Summary -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 to show multiple columns Table 77.36. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 77.37. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 77.38. Table formatter options Value Summary --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. 77.8. stack event list List events. Usage: Table 77.39. Positional arguments Value Summary <stack> Name or id of stack to show events for Table 77.40. Command arguments Value Summary -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 77.41. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 77.42. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 77.43. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 77.44. Table formatter options Value Summary --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. 77.9. stack event show Show event details. Usage: Table 77.45. Positional arguments Value Summary <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 77.46. Command arguments Value Summary -h, --help Show this help message and exit Table 77.47. Output formatter options Value Summary -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 to show multiple columns Table 77.48. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 77.49. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 77.50. Table formatter options Value Summary --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. 77.10. stack export Export stack data json. Usage: Table 77.51. Positional arguments Value Summary <stack> Name or id of stack to export Table 77.52. Command arguments Value Summary -h, --help Show this help message and exit --output-file <output-file> File to output export data Table 77.53. Output formatter options Value Summary -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 to show multiple columns Table 77.54. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 77.55. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 77.56. Table formatter options Value Summary --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. 77.11. stack failures list Show information about failed stack resources. Usage: Table 77.57. Positional arguments Value Summary <stack> Stack to display (name or id) Table 77.58. Command arguments Value Summary -h, --help Show this help message and exit --long Show full deployment logs in output 77.12. stack file list Show a stack's files map. Usage: Table 77.59. Positional arguments Value Summary <NAME or ID> Name or id of stack to query Table 77.60. Command arguments Value Summary -h, --help Show this help message and exit Table 77.61. Output formatter options Value Summary -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 to show multiple columns Table 77.62. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 77.63. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 77.64. Table formatter options Value Summary --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. 77.13. stack hook clear Clear resource hooks on a given stack. Usage: Table 77.65. Positional arguments Value Summary <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 77.66. Command arguments Value Summary -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 77.14. stack hook poll List resources with pending hook for a stack. Usage: Table 77.67. Positional arguments Value Summary <stack> Stack to display (name or id) Table 77.68. Command arguments Value Summary -h, --help Show this help message and exit --nested-depth <nested-depth> Depth of nested stacks from which to display hooks Table 77.69. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 77.70. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 77.71. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 77.72. Table formatter options Value Summary --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. 77.15. stack list List stacks. Usage: Table 77.73. Command arguments Value Summary -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 77.74. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 77.75. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 77.76. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 77.77. Table formatter options Value Summary --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. 77.16. stack output list List stack outputs. Usage: Table 77.78. Positional arguments Value Summary <stack> Name or id of stack to query Table 77.79. Command arguments Value Summary -h, --help Show this help message and exit Table 77.80. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 77.81. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 77.82. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 77.83. Table formatter options Value Summary --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. 77.17. stack output show Show stack output. Usage: Table 77.84. Positional arguments Value Summary <stack> Name or id of stack to query <output> Name of an output to display Table 77.85. Command arguments Value Summary -h, --help Show this help message and exit --all Display all stack outputs Table 77.86. Output formatter options Value Summary -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 to show multiple columns Table 77.87. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 77.88. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 77.89. Table formatter options Value Summary --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. 77.18. stack resource list List stack resources. Usage: Table 77.90. Positional arguments Value Summary <stack> Name or id of stack to query Table 77.91. Command arguments Value Summary -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 77.92. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 77.93. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 77.94. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 77.95. Table formatter options Value Summary --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. 77.19. stack resource mark unhealthy Set resource's health. Usage: Table 77.96. Positional arguments Value Summary <stack> Name or id of stack the resource belongs to <resource> Name of the resource reason Reason for state change Table 77.97. Command arguments Value Summary -h, --help Show this help message and exit --reset Set the resource as healthy 77.20. stack resource metadata Show resource metadata Usage: Table 77.98. Positional arguments Value Summary <stack> Stack to display (name or id) <resource> Name of the resource to show the metadata for Table 77.99. Command arguments Value Summary -h, --help Show this help message and exit Table 77.100. Output formatter options Value Summary -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 to show multiple columns Table 77.101. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 77.102. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 77.103. Table formatter options Value Summary --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. 77.21. stack resource show Display stack resource. Usage: Table 77.104. Positional arguments Value Summary <stack> Name or id of stack to query <resource> Name of resource Table 77.105. Command arguments Value Summary -h, --help Show this help message and exit --with-attr <attribute> Attribute to show, can be specified multiple times Table 77.106. Output formatter options Value Summary -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 to show multiple columns Table 77.107. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 77.108. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 77.109. Table formatter options Value Summary --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. 77.22. stack resource signal Signal a resource with optional data. Usage: Table 77.110. Positional arguments Value Summary <stack> Name or id of stack the resource belongs to <resource> Name of the resoure to signal Table 77.111. Command arguments Value Summary -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 77.23. stack resume Resume a stack. Usage: Table 77.112. Positional arguments Value Summary <stack> Stack(s) to resume (name or id) Table 77.113. Command arguments Value Summary -h, --help Show this help message and exit --wait Wait for resume to complete Table 77.114. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 77.115. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 77.116. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 77.117. Table formatter options Value Summary --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. 77.24. stack show Show stack details. Usage: Table 77.118. Positional arguments Value Summary <stack> Stack to display (name or id) Table 77.119. Command arguments Value Summary -h, --help Show this help message and exit --no-resolve-outputs Do not resolve outputs of the stack. Table 77.120. Output formatter options Value Summary -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 to show multiple columns Table 77.121. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 77.122. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 77.123. Table formatter options Value Summary --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. 77.25. stack snapshot create Create stack snapshot. Usage: Table 77.124. Positional arguments Value Summary <stack> Name or id of stack Table 77.125. Command arguments Value Summary -h, --help Show this help message and exit --name <name> Name of snapshot Table 77.126. Output formatter options Value Summary -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 to show multiple columns Table 77.127. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 77.128. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 77.129. Table formatter options Value Summary --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. 77.26. stack snapshot delete Delete stack snapshot. Usage: Table 77.130. Positional arguments Value Summary <stack> Name or id of stack <snapshot> Id of stack snapshot Table 77.131. Command arguments Value Summary -h, --help Show this help message and exit -y, --yes Skip yes/no prompt (assume yes) 77.27. stack snapshot list List stack snapshots. Usage: Table 77.132. Positional arguments Value Summary <stack> Name or id of stack containing the snapshots Table 77.133. Command arguments Value Summary -h, --help Show this help message and exit Table 77.134. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 77.135. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 77.136. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 77.137. Table formatter options Value Summary --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. 77.28. stack snapshot restore Restore stack snapshot Usage: Table 77.138. Positional arguments Value Summary <stack> Name or id of stack containing the snapshot <snapshot> Id of the snapshot to restore Table 77.139. Command arguments Value Summary -h, --help Show this help message and exit 77.29. stack snapshot show Show stack snapshot. Usage: Table 77.140. Positional arguments Value Summary <stack> Name or id of stack containing the snapshot <snapshot> Id of the snapshot to show Table 77.141. Command arguments Value Summary -h, --help Show this help message and exit Table 77.142. Output formatter options Value Summary -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 to show multiple columns Table 77.143. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 77.144. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 77.145. Table formatter options Value Summary --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. 77.30. stack suspend Suspend a stack. Usage: Table 77.146. Positional arguments Value Summary <stack> Stack(s) to suspend (name or id) Table 77.147. Command arguments Value Summary -h, --help Show this help message and exit --wait Wait for suspend to complete Table 77.148. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 77.149. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 77.150. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 77.151. Table formatter options Value Summary --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. 77.31. stack template show Display stack template. Usage: Table 77.152. Positional arguments Value Summary <stack> Name or id of stack to query Table 77.153. Command arguments Value Summary -h, --help Show this help message and exit Table 77.154. Output formatter options Value Summary -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 to show multiple columns Table 77.155. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 77.156. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 77.157. Table formatter options Value Summary --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. 77.32. stack update Update a stack. Usage: Table 77.158. Positional arguments Value Summary <stack> Name or id of stack to update Table 77.159. Command arguments Value Summary -h, --help Show this help message and exit -t <template>, --template <template> Path to the template -s <files-container>, --files-container <files-container> Swift files container name. local files other than root template would be ignored. If other files are not found in swift, heat engine would raise an error. -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 77.160. Output formatter options Value Summary -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 to show multiple columns Table 77.161. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 77.162. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 77.163. Table formatter options Value Summary --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.
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> 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> 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] [--sort-ascending | --sort-descending] [--wait] [--no-rollback] <stack> [<stack> ...] 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] [--sort-ascending | --sort-descending] [--wait] <stack> [<stack> ...] openstack stack create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [-e <environment>] [-s <files-container>] [--timeout <timeout>] [--pre-create <resource>] [--enable-rollback] [--parameter <key=value>] [--parameter-file <key=file>] [--wait] [--poll SECONDS] [--tags <tag1,tag2...>] [--dry-run] -t <template> <stack-name> openstack stack delete [-h] [-y] [--wait] <stack> [<stack> ...] 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> 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] [--sort-ascending | --sort-descending] [--resource <resource>] [--filter <key=value>] [--limit <limit>] [--marker <id>] [--nested-depth <depth>] [--sort <key>[:<direction>]] [--follow] <stack> 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> 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> openstack stack failures list [-h] [--long] <stack> 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> openstack stack hook clear [-h] [--pre-create] [--pre-update] [--pre-delete] <stack> <resource> [<resource> ...] 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] [--sort-ascending | --sort-descending] [--nested-depth <nested-depth>] <stack> 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] [--sort-ascending | --sort-descending] [--deleted] [--nested] [--hidden] [--property <key=value>] [--tags <tag1,tag2...>] [--tag-mode <mode>] [--limit <limit>] [--marker <id>] [--sort <key>[:<direction>]] [--all-projects] [--short] [--long] 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] [--sort-ascending | --sort-descending] <stack> 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>] 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] [--sort-ascending | --sort-descending] [--long] [-n <nested-depth>] [--filter <key=value>] <stack> openstack stack resource mark unhealthy [-h] [--reset] <stack> <resource> [reason] 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> 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> openstack stack resource signal [-h] [--data <data>] [--data-file <data-file>] <stack> <resource> 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] [--sort-ascending | --sort-descending] [--wait] <stack> [<stack> ...] 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> 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> openstack stack snapshot delete [-h] [-y] <stack> <snapshot> 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] [--sort-ascending | --sort-descending] <stack> openstack stack snapshot restore [-h] <stack> <snapshot> 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> 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] [--sort-ascending | --sort-descending] [--wait] <stack> [<stack> ...] openstack stack template show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <stack> openstack stack update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [-t <template>] [-s <files-container>] [-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>