Red Hat Training

A Red Hat training course is available for Red Hat OpenStack Platform

Chapter 10. Orchestration Service Command-line Client

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

10.1. heat Usage

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] [--profile HMAC_KEY]
            <subcommand> ...

Subcommands

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.

config-create


        Create a software configuration.

config-delete


        Delete the software configuration(s).

config-list


        List software configs.

config-show


        View details of a software configuration.

deployment-create


        Create a software deployment.

deployment-delete


        Delete the software deployment(s).

deployment-list


        List software deployments.

deployment-metadata-show


      Get deployment configuration metadata for the
      specified server.

deployment-output-show


      Show a specific deployment output.

deployment-show


        Show the details of a software deployment.

event


        DEPRECATED!

event-list


        List events for a stack.

event-show


        Describe the event.

hook-clear


        Clear hooks on a given stack.

hook-poll


        List resources with pending hook for a stack.

output-list


        Show available outputs.

output-show


        Show a specific stack output.

resource-list


        Show list of resources belonging to a stack.

resource-mark-unhealthy


      Set resource's health.

resource-metadata


        List resource metadata.

resource-show


        Describe the resource.

resource-signal


        Send a signal to a resource.

resource-template


        DEPRECATED!

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.

service-list


        List the Heat engines.

snapshot-delete


        Delete a snapshot of a stack.

snapshot-list


        List the snapshots of a stack.

snapshot-show


        Show a snapshot of a stack.

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


        Restore a snapshot of a stack.

stack-show


        Describe the stack.

stack-snapshot


        Make a snapshot of a stack.

stack-update


        Update the stack.

template-function-list


      List the available functions.

template-show


        Get the template for the specified stack.

template-validate


        Validate a template with parameters.

template-version-list


      List the available template versions.

bash-completion


        Prints all of the commands and options to stdout.

help


        Display help about this program or one of its
      subcommands.