summaryrefslogtreecommitdiff
path: root/doc/source/man/heat.rst
blob: 826499dd11baa32e18b183e82104968447bc9e90 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
====
heat
====

.. program:: heat

SYNOPSIS
========

  `heat` [options] <command> [command-options]

  `heat help`

  `heat help` <command>


DESCRIPTION
===========

`heat` is a command line client for controlling OpenStack Heat.

Before the `heat` command is issued, ensure the environment contains
the necessary variables so that the CLI can pass user credentials to
the server.
See `Getting Credentials for a CLI`  section of `OpenStack CLI Guide`
for more info.


OPTIONS
=======

To get a list of available commands and options run::

    heat help

To get usage and options of a command run::

    heat help <command>


EXAMPLES
========

Get information about stack-create command::

    heat help stack-create

List available stacks::

    heat stack-list

List available resources in a stack::

    heat resource-list <stack name>

Create a stack::

    heat stack-create mystack -f some-template.yaml -P "KeyName=mine"

View stack information::

    heat stack-show mystack

List events::

    heat event-list mystack

Delete a stack::

    heat stack-delete mystack


BUGS
====

Heat client is hosted in Launchpad so you can view current bugs at https://bugs.launchpad.net/python-heatclient/.