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

usage: heat [--version] [-d] [-v] [--api-timeout API_TIMEOUT] [--os-no-client-auth] [--heat-url HEAT_URL] [--heat-api-version HEAT_API_VERSION] [--include-password] [-k] [--os-cert OS_CERT] [--cert-file OS_CERT] [--os-key OS_KEY] [--key-file OS_KEY] [--os-cacert <ca-certificate-file>] [--ca-file OS_CACERT] [--os-username OS_USERNAME] [--os-user-id OS_USER_ID] [--os-user-domain-id OS_USER_DOMAIN_ID] [--os-user-domain-name OS_USER_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID] [--os-project-name OS_PROJECT_NAME] [--os-project-domain-id OS_PROJECT_DOMAIN_ID] [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] [--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-service-type OS_SERVICE_TYPE] [--os-endpoint-type OS_ENDPOINT_TYPE] <subcommand> ... action-check Check that stack resources are in expected states. 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 DEPRECATED! Use resource-type-template instead. resource-type-list List the available resource types. resource-type-show Show the resource type. resource-type-template Generate a template based on a resource type. stack-abandon Abandon the stack. stack-adopt Adopt a stack. stack-cancel-update Cancel currently running update of the 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. --api-timeout API_TIMEOUT Number of seconds to wait for an API response, defaults to system socket timeout --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. --include-password Send os-username and os-password to heat. -k, --insecure Explicitly allow heatclient 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-cert OS_CERT Path of certificate file to use in SSL connection. This file can optionally be prepended with the private key. --cert-file OS_CERT DEPRECATED! Use --os-cert. --os-key OS_KEY Path of client key to use in SSL connection. This option is not necessary if your key is prepended to your cert file. --key-file OS_KEY DEPRECATED! Use --os-key. --os-cacert <ca-certificate-file> Path of CA TLS certificate(s) used to verify the remote server's certificate. Without this option glance looks for the default system CA certificates. --ca-file OS_CACERT DEPRECATED! Use --os-cacert. --os-username OS_USERNAME Defaults to env[OS_USERNAME]. --os-user-id OS_USER_ID Defaults to env[OS_USER_ID]. --os-user-domain-id OS_USER_DOMAIN_ID Defaults to env[OS_USER_DOMAIN_ID]. --os-user-domain-name OS_USER_DOMAIN_NAME Defaults to env[OS_USER_DOMAIN_NAME]. --os-project-id OS_PROJECT_ID Another way to specify tenant ID. This option is mutually exclusive with --os-tenant-id. Defaults to env[OS_PROJECT_ID]. --os-project-name OS_PROJECT_NAME Another way to specify tenant name. This option is mutually exclusive with --os-tenant-name. Defaults to env[OS_PROJECT_NAME]. --os-project-domain-id OS_PROJECT_DOMAIN_ID Defaults to env[OS_PROJECT_DOMAIN_ID]. --os-project-domain-name OS_PROJECT_DOMAIN_NAME Defaults to env[OS_PROJECT_DOMAIN_NAME]. --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-service-type OS_SERVICE_TYPE Defaults to env[OS_SERVICE_TYPE]. --os-endpoint-type OS_ENDPOINT_TYPE Defaults to env[OS_ENDPOINT_TYPE].

usage: heat action-check <NAME or ID> Check that stack resources are in expected states. <NAME or ID> Name or ID of stack to check.

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>] [-f <KEY1=VALUE1;KEY2=VALUE2...>] [-l <LIMIT>] [-m <ID>] <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. -f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...> Filter parameters to apply on returned events. This can be specified multiple times, or once with parameters separated by a semicolon. -l <LIMIT>, --limit <LIMIT> Limit the number of events returned. -m <ID>, --marker <ID> Only return events that appear after the given event ID.

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 [-n <DEPTH>] <NAME or ID> Show list of resources belonging to a stack. <NAME or ID> Name or ID of stack to show the resources for. -n <DEPTH>, --nested-depth <DEPTH> Depth of nested stacks from which to display resources.

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_TYPE> DEPRECATED! Use resource-type-template instead. <RESOURCE_TYPE> Resource type 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 resource-type-template [-F <FORMAT>] <RESOURCE_TYPE> Generate a template based on a resource type. <RESOURCE_TYPE> Resource type to generate a template for. -F <FORMAT>, --format <FORMAT> The template output format, one of: yaml, json.

usage: heat stack-abandon [-O <FILE>] <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 or a file on success. <NAME or ID> Name or ID of stack to abandon. -O <FILE>, --output-file <FILE> file to output abandon result. If the option is specified, the result will be output into <FILE>.

usage: heat stack-adopt [-e <FILE or 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. -e <FILE or URL>, --environment-file <FILE or URL> Path to the environment, it can be specified multiple times. -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-cancel-update <NAME or ID> Cancel currently running update of the stack. <NAME or ID> Name or ID of stack to cancel update for.

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, it can be specified multiple times. -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] [-n] [-f <KEY1=VALUE1;KEY2=VALUE2...>] [-l <LIMIT>] [-m <ID>] [-g] [-o] List the user's stacks. -s, --show-deleted Include soft-deleted stacks in the stack listing. -n, --show-nested Include nested 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. -o, --show-owner Display stack owner information. This is automatically enabled when using --global-tenant.

usage: heat stack-preview [-f <FILE>] [-e <FILE or URL>] [-u <URL>] [-o <URL>] [-t <TIMEOUT>] [-r] [-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, it can be specified multiple times. -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 creation timeout in minutes. This is only used duringvalidation in preview. -r, --enable-rollback Enable rollback on failure. This option is not used duringpreview and exists only for symmetry with stack- create. -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] [--rollback <VALUE>] [-P <KEY1=VALUE1;KEY2=VALUE2...>] [-x] [-c <PARAMETER>] <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, it can be specified multiple times. -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 DEPRECATED! Use --rollback argument instead. Enable rollback on stack update failure. NOTE: default behavior is now to use the rollback value of existing stack. --rollback <VALUE> Set rollback on update failure. Values ('1', 't', 'true', 'on', 'y', 'yes') set rollback to enabled. Values ('0', 'f', 'false', 'off', 'n', 'no') set rollback to disabled. Default is to use the value of existing stack to be updated. -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. -x, --existing Re-use the set of parameters of the current stack. Parameters specified in --parameters will patch over the existing values in the current stack. Parameters omitted will keep the existing values. -c <PARAMETER>, --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.

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, it can be specified multiple times. -o <URL>, --template-object <URL> URL to retrieve template object (e.g. from swift).