Chapter 10. Orchestration command-line client

The heat client is the command-line interface (CLI) for the Orchestration API and its extensions. This chapter documents heat version 0.2.9.

For help on a specific heat command, enter:

$ heat help COMMAND

heat usage

usage: heat [--version] [-d] [-v] [-k] [--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> ...

Subcommands

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.

heat optional arguments

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

heat action-resume command

usage: heat action-resume <NAME or ID>

Resume the stack.

Positional arguments

<NAME or ID>: Name or ID of stack to resume.

heat action-suspend command

usage: heat action-suspend <NAME or ID>

Suspend the stack.

Positional arguments

<NAME or ID>: Name or ID of stack to suspend.

heat build-info command

usage: heat build-info

Retrieve build information.

heat event-list command

usage: heat event-list [-r <RESOURCE>] <NAME or ID>

List events for a stack.

Positional arguments

<NAME or ID>: Name or ID of stack to show the events for.

Optional arguments

-r <RESOURCE>, --resource <RESOURCE>: Name of the resource to filter events by.

heat event-show command

usage: heat event-show <NAME or ID> <RESOURCE> <EVENT>

Describe the event.

Positional arguments

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

heat output-list command

usage: heat output-list <NAME or ID>

Show available outputs.

Positional arguments

<NAME or ID>: Name or ID of stack to query.

heat output-show command

usage: heat output-show <NAME or ID> <OUTPUT NAME>

Show a specific stack output.

Positional arguments

<NAME or ID>: Name or ID of stack to query.
<OUTPUT NAME>: Name of an output to display.

heat resource-list command

usage: heat resource-list <NAME or ID>

Show list of resources belonging to a stack.

Positional arguments

<NAME or ID>: Name or ID of stack to show the resources for.

heat resource-metadata command

usage: heat resource-metadata <NAME or ID> <RESOURCE>

List resource metadata.

Positional arguments

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

heat resource-show command

usage: heat resource-show <NAME or ID> <RESOURCE>

Describe the resource.

Positional arguments

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

heat resource-signal command

usage: heat resource-signal [-D <DATA>] [-f <FILE>] <NAME or ID> <RESOURCE>

Send a signal to a resource.

Positional arguments

<NAME or ID>: Name or ID of stack the resource belongs to.
<RESOURCE>: Name of the resource to signal.

Optional arguments

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

heat resource-template command

usage: heat resource-template [-F <FORMAT>] <RESOURCE>

Generate a template based on a resource.

Positional arguments

<RESOURCE>: Name of the resource to generate a template for.

Optional arguments

-F <FORMAT>, --format <FORMAT>: The template output format, one of: yaml, json.

heat resource-type-list command

usage: heat resource-type-list

List the available resource types.

heat resource-type-show command

usage: heat resource-type-show <RESOURCE_TYPE>

Show the resource type.

Positional arguments

<RESOURCE_TYPE>: Resource type to get the details for.

heat stack-abandon command

usage: heat stack-abandon <NAME or ID>

Abandon the stack.

Positional arguments

<NAME or ID>: Name or ID of stack to abandon.

heat stack-adopt command

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.

Positional arguments

<STACK_NAME>: Name of the stack to adopt.

Optional arguments

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

heat stack-create command

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.

Positional arguments

<STACK_NAME>: Name of the stack to create.

Optional arguments

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

heat stack-delete command

usage: heat stack-delete <NAME or ID> [<NAME or ID> ...]

Delete the stack(s).

Positional arguments

<NAME or ID>: Name or ID of stack(s) to delete.

heat stack-list command

usage: heat stack-list [-f <KEY1=VALUE1;KEY2=VALUE2...>] [-l <LIMIT>]
                       [-m <ID>]

List the user's stacks.

Optional arguments

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

heat stack-preview command

usage: heat stack-preview [-f <FILE>] [-e <FILE or URL>] [-u <URL>] [-o <URL>]
                          [-c <TIMEOUT>] [-r]
                          [-P <KEY1=VALUE1;KEY2=VALUE2...>]
                          <STACK_NAME>

Preview the stack.

Positional arguments

<STACK_NAME>: Name of the stack to preview.

Optional arguments

-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 timeout in minutes. Default: 60
-r, --enable-rollback: Enable rollback on failure
-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.

heat stack-show command

usage: heat stack-show <NAME or ID>

Describe the stack.

Positional arguments

<NAME or ID>: Name or ID of stack to describe.

heat stack-update command

usage: heat stack-update [-f <FILE>] [-e <FILE or URL>] [-u <URL>] [-o <URL>]
                         [-t <TIMEOUT>] [-P <KEY1=VALUE1;KEY2=VALUE2...>]
                         <NAME or ID>

Update the stack.

Positional arguments

<NAME or ID>: Name or ID of stack to update.

Optional arguments

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

heat template-show command

usage: heat template-show <NAME or ID>

Get the template for the specified stack.

Positional arguments

<NAME or ID>: Name or ID of stack to get the template for.

heat template-validate command

usage: heat template-validate [-u <URL>] [-f <FILE>] [-e <FILE or URL>]
                              [-o <URL>] [-P <KEY1=VALUE1;KEY2=VALUE2...>]

Validate a template with parameters.

Optional arguments

-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).
-P <KEY1=VALUE1;KEY2=VALUE2...>, --parameters <KEY1=VALUE1;KEY2=VALUE2...>: Parameter values to validate. This can be specified multiple times, or once with parameters separated by a semicolon.

Questions? Discuss on ask.openstack.org
Found an error? Report a bug against this page

Legal notices