stack¶

Basic actions¶

stack list¶

List stacks.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

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

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

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

This command is provided by the python-heatclient plugin.

stack create¶

Create a stack.

stack create
    [-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>

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

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

-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

stack-name¶: Name of the stack to create

This command is provided by the python-heatclient plugin.

stack update¶

Update a stack.

stack update
    [-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>

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

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

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

stack¶: Name or ID of stack to update

This command is provided by the python-heatclient plugin.

stack cancel¶

Cancel current task for a stack.

Supported tasks for cancellation:

update
create

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

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

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

--wait¶: Wait for cancel to complete

--no-rollback¶: Cancel without rollback

stack¶: Stack(s) to cancel (name or ID)

This command is provided by the python-heatclient plugin.

stack show¶

Show stack details.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

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

--no-resolve-outputs¶: Do not resolve outputs of the stack.

stack¶: Stack to display (name or ID)

This command is provided by the python-heatclient plugin.

stack delete¶

Delete stack(s).

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

-y, --yes¶: Skip yes/no prompt (assume yes)

--wait¶: Wait for stack delete to complete

stack¶: Stack(s) to delete (name or ID)

This command is provided by the python-heatclient plugin.

Outputs¶

stack output list¶

List stack outputs.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

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

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

stack¶: Name or ID of stack to query

This command is provided by the python-heatclient plugin.

stack output show¶

Show stack output.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

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

--all¶: Display all stack outputs

stack¶: Name or ID of stack to query

output¶: Name of an output to display

This command is provided by the python-heatclient plugin.

Resources¶

stack resource list¶

List stack resources.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

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

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

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

stack¶: Name or ID of stack to query

This command is provided by the python-heatclient plugin.

stack resource show¶

Display stack resource.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

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

--with-attr <attribute>¶: Attribute to show, can be specified multiple times

stack¶: Name or ID of stack to query

resource¶: Name of resource

This command is provided by the python-heatclient plugin.

stack resource metadata¶

Show resource metadata

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to json

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

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

stack¶: Stack to display (name or ID)

resource¶: Name of the resource to show the metadata for

This command is provided by the python-heatclient plugin.

stack resource mark unhealthy¶

Set resource’s health.

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

--reset¶: Set the resource as healthy

stack¶: Name or ID of stack the resource belongs to

resource¶: Name of the resource

reason¶: Reason for state change

This command is provided by the python-heatclient plugin.

stack resource signal¶

Signal a resource with optional data.

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

--data <data>¶: JSON Data to send to the signal handler

--data-file <data-file>¶: File containing JSON data to send to the signal handler

stack¶: Name or ID of stack the resource belongs to

resource¶: Name of the resoure to signal

This command is provided by the python-heatclient plugin.

Events¶

stack event list¶

List events.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to log

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

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

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

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

stack¶: Name or ID of stack to show events for

This command is provided by the python-heatclient plugin.

stack event show¶

Show event details.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

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

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

This command is provided by the python-heatclient plugin.

stack failures list¶

Show information about failed stack resources.

stack failures list [--long] <stack>

--long¶: Show full deployment logs in output

stack¶: Stack to display (name or ID)

This command is provided by the python-heatclient plugin.

Input data¶

stack template show¶

Display stack template.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to yaml

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

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

stack¶: Name or ID of stack to query

This command is provided by the python-heatclient plugin.

stack environment show¶

Show a stack’s environment.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to yaml

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

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

NAME or ID¶: Name or ID of stack to query

This command is provided by the python-heatclient plugin.

stack file list¶

Show a stack’s files map.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to yaml

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

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

NAME or ID¶: Name or ID of stack to query

This command is provided by the python-heatclient plugin.

User hooks¶

stack hook poll¶

List resources with pending hook for a stack.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

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

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

--nested-depth <nested-depth>¶: Depth of nested stacks from which to display hooks

stack¶: Stack to display (name or ID)

This command is provided by the python-heatclient plugin.

stack hook clear¶

Clear resource hooks on a given stack.

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

--pre-create¶: Clear the pre-create hooks

--pre-update¶: Clear the pre-update hooks

--pre-delete¶: Clear the pre-delete hooks

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

This command is provided by the python-heatclient plugin.

Other actions¶

stack check¶

Check a stack.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

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

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

--wait¶: Wait for check to complete

stack¶: Stack(s) to check update (name or ID)

This command is provided by the python-heatclient plugin.

stack suspend¶

Suspend a stack.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

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

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

--wait¶: Wait for suspend to complete

stack¶: Stack(s) to suspend (name or ID)

This command is provided by the python-heatclient plugin.

stack resume¶

Resume a stack.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

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

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

--wait¶: Wait for resume to complete

stack¶: Stack(s) to resume (name or ID)

This command is provided by the python-heatclient plugin.

stack export¶

Export stack data json.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to json

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

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

--output-file <output-file>¶: File to output export data

stack¶: Name or ID of stack to export

This command is provided by the python-heatclient plugin.

stack abandon¶

Abandon stack and output results.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to json

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

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

--output-file <output-file>¶: File to output abandon results

stack¶: Name or ID of stack to abandon

This command is provided by the python-heatclient plugin.

stack adopt¶

Adopt a stack.

stack adopt
    [-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>

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

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

-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

stack-name¶: Name of the stack to adopt

This command is provided by the python-heatclient plugin.

Snapshots¶

stack snapshot list¶

List stack snapshots.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

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

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

stack¶: Name or ID of stack containing the snapshots

This command is provided by the python-heatclient plugin.

stack snapshot create¶

Create stack snapshot.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

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

--name <name>¶: Name of snapshot

stack¶: Name or ID of stack

This command is provided by the python-heatclient plugin.

stack snapshot restore¶

Restore stack snapshot

stack snapshot restore <stack> <snapshot>

stack¶: Name or ID of stack containing the snapshot

snapshot¶: ID of the snapshot to restore

This command is provided by the python-heatclient plugin.

stack snapshot show¶

Show stack snapshot.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to yaml

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

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

stack¶: Name or ID of stack containing the snapshot

snapshot¶: ID of the snapshot to show

This command is provided by the python-heatclient plugin.

stack snapshot delete¶

Delete stack snapshot.

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

-y, --yes¶: Skip yes/no prompt (assume yes)

stack¶: Name or ID of stack

snapshot¶: ID of stack snapshot

This command is provided by the python-heatclient plugin.

stack

stack¶

Basic actions¶

stack list¶

stack create¶

stack update¶

stack cancel¶

stack show¶

stack delete¶

Outputs¶

stack output list¶

stack output show¶

Resources¶

stack resource list¶

stack resource show¶

stack resource metadata¶

stack resource mark unhealthy¶

stack resource signal¶

Events¶

stack event list¶

stack event show¶

stack failures list¶

Input data¶

stack template show¶

stack environment show¶

stack file list¶

User hooks¶

stack hook poll¶

stack hook clear¶

Other actions¶

stack check¶

stack suspend¶

stack resume¶

stack export¶

stack abandon¶

stack adopt¶

Snapshots¶

stack snapshot list¶

stack snapshot create¶

stack snapshot restore¶

stack snapshot show¶

stack snapshot delete¶

python-heatclient 2.2.2.dev2

Page Contents