The heat client is the command-line interface (CLI) for the Orchestration API and its extensions. This chapter documents heat version 0.2.10. For help on a specific heat command, enter: $ heat help COMMAND

usage: heat [--version] [-d] [-v] [-k] [--os-cacert <ca-certificate>] [--cert-file CERT_FILE] [--key-file KEY_FILE] [--ca-file CA_FILE] [--api-timeout API_TIMEOUT] [--os-username OS_USERNAME] [--os-password OS_PASSWORD] [--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME] [--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME] [--os-auth-token OS_AUTH_TOKEN] [--os-no-client-auth] [--heat-url HEAT_URL] [--heat-api-version HEAT_API_VERSION] [--os-service-type OS_SERVICE_TYPE] [--os-endpoint-type OS_ENDPOINT_TYPE] [--include-password] <subcommand> ... action-resume Resume the stack. action-suspend Suspend the stack. build-info Retrieve build information. create DEPRECATED! Use stack-create instead. delete DEPRECATED! Use stack-delete instead. describe DEPRECATED! Use stack-show instead. event DEPRECATED! Use event-show instead. event-list List events for a stack. event-show Describe the event. gettemplate DEPRECATED! Use template-show instead. list DEPRECATED! Use stack-list instead. output-list Show available outputs. output-show Show a specific stack output. resource DEPRECATED! Use resource-show instead. resource-list Show list of resources belonging to a stack. resource-metadata List resource metadata. resource-show Describe the resource. resource-signal Send a signal to a resource. resource-template Generate a template based on a resource. resource-type-list List the available resource types. resource-type-show Show the resource type. stack-abandon Abandon the stack. stack-adopt Adopt a stack. stack-create Create the stack. stack-delete Delete the stack(s). stack-list List the user's stacks. stack-preview Preview the stack. stack-show Describe the stack. stack-update Update the stack. template-show Get the template for the specified stack. template-validate Validate a template with parameters. update DEPRECATED! Use stack-update instead. validate DEPRECATED! Use template-validate instead. bash-completion Prints all of the commands and options to stdout. help Display help about this program or one of its subcommands.

--version Shows the client version and exits. -d, --debug Defaults to env[HEATCLIENT_DEBUG]. -v, --verbose Print more verbose output. -k, --insecure Explicitly allow the client to perform "insecure" SSL (https) requests. The server's certificate will not be verified against any certificate authorities. This option should be used with caution. --os-cacert <ca-certificate> Specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to env[OS_CACERT] --cert-file CERT_FILE Path of certificate file to use in SSL connection. This file can optionally be prepended with the private key. --key-file KEY_FILE Path of client key to use in SSL connection.This option is not necessary if your key is prepended to your cert file. --ca-file CA_FILE Path of CA SSL certificate(s) used to verify the remote server's certificate. Without this option the client looks for the default system CA certificates. --api-timeout API_TIMEOUT Number of seconds to wait for an API response, defaults to system socket timeout --os-username OS_USERNAME Defaults to env[OS_USERNAME]. --os-password OS_PASSWORD Defaults to env[OS_PASSWORD]. --os-tenant-id OS_TENANT_ID Defaults to env[OS_TENANT_ID]. --os-tenant-name OS_TENANT_NAME Defaults to env[OS_TENANT_NAME]. --os-auth-url OS_AUTH_URL Defaults to env[OS_AUTH_URL]. --os-region-name OS_REGION_NAME Defaults to env[OS_REGION_NAME]. --os-auth-token OS_AUTH_TOKEN Defaults to env[OS_AUTH_TOKEN]. --os-no-client-auth Do not contact keystone for a token. Defaults to env[OS_NO_CLIENT_AUTH]. --heat-url HEAT_URL Defaults to env[HEAT_URL]. --heat-api-version HEAT_API_VERSION Defaults to env[HEAT_API_VERSION] or 1. --os-service-type OS_SERVICE_TYPE Defaults to env[OS_SERVICE_TYPE]. --os-endpoint-type OS_ENDPOINT_TYPE Defaults to env[OS_ENDPOINT_TYPE]. --include-password Send os-username and os-password to heat.

usage: heat action-resume <NAME or ID> Resume the stack. <NAME or ID> Name or ID of stack to resume.

usage: heat action-suspend <NAME or ID> Suspend the stack. <NAME or ID> Name or ID of stack to suspend.

usage: heat build-info Retrieve build information.

usage: heat event-list [-r <RESOURCE>] <NAME or ID> List events for a stack. <NAME or ID> Name or ID of stack to show the events for. -r <RESOURCE>, --resource <RESOURCE> Name of the resource to filter events by.

usage: heat event-show <NAME or ID> <RESOURCE> <EVENT> Describe the event. <NAME or ID> Name or ID of stack to show the events for. <RESOURCE> Name of the resource the event belongs to. <EVENT> ID of event to display details for.

usage: heat output-list <NAME or ID> Show available outputs. <NAME or ID> Name or ID of stack to query.

usage: heat output-show <NAME or ID> <OUTPUT NAME> Show a specific stack output. <NAME or ID> Name or ID of stack to query. <OUTPUT NAME> Name of an output to display.

usage: heat resource-list <NAME or ID> Show list of resources belonging to a stack. <NAME or ID> Name or ID of stack to show the resources for.

usage: heat resource-metadata <NAME or ID> <RESOURCE> List resource metadata. <NAME or ID> Name or ID of stack to show the resource metadata for. <RESOURCE> Name of the resource to show the metadata for.

usage: heat resource-show <NAME or ID> <RESOURCE> Describe the resource. <NAME or ID> Name or ID of stack to show the resource for. <RESOURCE> Name of the resource to show the details for.

usage: heat resource-signal [-D <DATA>] [-f <FILE>] <NAME or ID> <RESOURCE> Send a signal to a resource. <NAME or ID> Name or ID of stack the resource belongs to. <RESOURCE> Name of the resource to signal. -D <DATA>, --data <DATA> JSON Data to send to the signal handler. -f <FILE>, --data-file <FILE> File containing JSON data to send to the signal handler.

usage: heat resource-template [-F <FORMAT>] <RESOURCE> Generate a template based on a resource. <RESOURCE> Name of the resource to generate a template for. -F <FORMAT>, --format <FORMAT> The template output format, one of: yaml, json.

usage: heat resource-type-list List the available resource types.

usage: heat resource-type-show <RESOURCE_TYPE> Show the resource type. <RESOURCE_TYPE> Resource type to get the details for.

usage: heat stack-abandon <NAME or ID> Abandon the stack. This will delete the record of the stack from Heat, but will not delete any of the underlying resources. Prints an adoptable JSON representation of the stack to stdout on success. <NAME or ID> Name or ID of stack to abandon.

usage: heat stack-adopt [-f <FILE>] [-e <FILE or URL>] [-u <URL>] [-o <URL>] [-c <TIMEOUT>] [-t <TIMEOUT>] [-a <FILE or URL>] [-r] [-P <KEY1=VALUE1;KEY2=VALUE2...>] <STACK_NAME> Adopt a stack. <STACK_NAME> Name of the stack to adopt. -f <FILE>, --template-file <FILE> Path to the template. -e <FILE or URL>, --environment-file <FILE or URL> Path to the environment. -u <URL>, --template-url <URL> URL of template. -o <URL>, --template-object <URL> URL to retrieve template object (e.g. from swift). -c <TIMEOUT>, --create-timeout <TIMEOUT> Stack creation timeout in minutes. DEPRECATED use --timeout instead. -t <TIMEOUT>, --timeout <TIMEOUT> Stack creation timeout in minutes. -a <FILE or URL>, --adopt-file <FILE or URL> Path to adopt stack data file. -r, --enable-rollback Enable rollback on create/update failure. -P <KEY1=VALUE1;KEY2=VALUE2...>, --parameters <KEY1=VALUE1;KEY2=VALUE2...> Parameter values used to create the stack. This can be specified multiple times, or once with parameters separated by a semicolon.

usage: heat stack-create [-f <FILE>] [-e <FILE or URL>] [-u <URL>] [-o <URL>] [-c <TIMEOUT>] [-t <TIMEOUT>] [-r] [-P <KEY1=VALUE1;KEY2=VALUE2...>] <STACK_NAME> Create the stack. <STACK_NAME> Name of the stack to create. -f <FILE>, --template-file <FILE> Path to the template. -e <FILE or URL>, --environment-file <FILE or URL> Path to the environment. -u <URL>, --template-url <URL> URL of template. -o <URL>, --template-object <URL> URL to retrieve template object (e.g. from swift). -c <TIMEOUT>, --create-timeout <TIMEOUT> Stack creation timeout in minutes. DEPRECATED use --timeout instead. -t <TIMEOUT>, --timeout <TIMEOUT> Stack creation timeout in minutes. -r, --enable-rollback Enable rollback on create/update failure. -P <KEY1=VALUE1;KEY2=VALUE2...>, --parameters <KEY1=VALUE1;KEY2=VALUE2...> Parameter values used to create the stack. This can be specified multiple times, or once with parameters separated by a semicolon.

usage: heat stack-delete <NAME or ID> [<NAME or ID> ...] Delete the stack(s). <NAME or ID> Name or ID of stack(s) to delete.

usage: heat stack-list [-s] [-f <KEY1=VALUE1;KEY2=VALUE2...>] [-l <LIMIT>] [-m <ID>] [-g] List the user's stacks. -s, --show-deleted Include soft-deleted stacks in the stack listing. -f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...> Filter parameters to apply on returned stacks. This can be specified multiple times, or once with parameters separated by a semicolon. -l <LIMIT>, --limit <LIMIT> Limit the number of stacks returned. -m <ID>, --marker <ID> Only return stacks that appear after the given stack ID. -g, --global-tenant Display stacks from all tenants. Operation only authorized for users who match the policy in heat's policy.json.

usage: heat stack-preview [-f <FILE>] [-e <FILE or URL>] [-u <URL>] [-o <URL>] [-P <KEY1=VALUE1;KEY2=VALUE2...>] <STACK_NAME> Preview the stack. <STACK_NAME> Name of the stack to preview. -f <FILE>, --template-file <FILE> Path to the template. -e <FILE or URL>, --environment-file <FILE or URL> Path to the environment. -u <URL>, --template-url <URL> URL of template. -o <URL>, --template-object <URL> URL to retrieve template object (e.g. from swift) -P <KEY1=VALUE1;KEY2=VALUE2...>, --parameters <KEY1=VALUE1;KEY2=VALUE2...> Parameter values used to preview the stack. This can be specified multiple times, or once with parameters separated by semicolon.

usage: heat stack-show <NAME or ID> Describe the stack. <NAME or ID> Name or ID of stack to describe.

usage: heat stack-update [-f <FILE>] [-e <FILE or URL>] [-u <URL>] [-o <URL>] [-t <TIMEOUT>] [-r] [-P <KEY1=VALUE1;KEY2=VALUE2...>] <NAME or ID> Update the stack. <NAME or ID> Name or ID of stack to update. -f <FILE>, --template-file <FILE> Path to the template. -e <FILE or URL>, --environment-file <FILE or URL> Path to the environment. -u <URL>, --template-url <URL> URL of template. -o <URL>, --template-object <URL> URL to retrieve template object (e.g. from swift). -t <TIMEOUT>, --timeout <TIMEOUT> Stack update timeout in minutes. -r, --enable-rollback Enable rollback on create/update failure. -P <KEY1=VALUE1;KEY2=VALUE2...>, --parameters <KEY1=VALUE1;KEY2=VALUE2...> Parameter values used to create the stack. This can be specified multiple times, or once with parameters separated by a semicolon.

usage: heat template-show <NAME or ID> Get the template for the specified stack. <NAME or ID> Name or ID of stack to get the template for.

usage: heat template-validate [-u <URL>] [-f <FILE>] [-e <FILE or URL>] [-o <URL>] Validate a template with parameters. -u <URL>, --template-url <URL> URL of template. -f <FILE>, --template-file <FILE> Path to the template. -e <FILE or URL>, --environment-file <FILE or URL> Path to the environment. -o <URL>, --template-object <URL> URL to retrieve template object (e.g. from swift).