1HEAT(1)                        python-heatclient                       HEAT(1)
2
3
4

NAME

6       heat - Command line access to the heat project.
7

SYNOPSIS

9          heat [options] <command> [command-options]
10
11          heat help
12
13          heat help <command>
14

DESCRIPTION

16       heat is a command line client for controlling OpenStack Heat.
17
18       Before  the heat command is issued, ensure the environment contains the
19       necessary variables so that the CLI can pass user  credentials  to  the
20       server.   See  Getting  Credentials for a CLI  section of OpenStack CLI
21       Guide for more info.
22

OPTIONS

24       To get a list of available commands and options run:
25
26          heat help
27
28       To get usage and options of a command run:
29
30          heat help <command>
31

EXAMPLES

33       Get information about stack-create command:
34
35          heat help stack-create
36
37       List available stacks:
38
39          heat stack-list
40
41       List available resources in a stack:
42
43          heat resource-list <stack name>
44
45       Create a stack:
46
47          heat stack-create mystack -f some-template.yaml -P "KeyName=mine"
48
49       View stack information:
50
51          heat stack-show mystack
52
53       List stack outputs:
54
55          heat output-list <stack name>
56
57       Show the value of a single output:
58
59          heat output-show <stack name> <output key>
60
61       List events:
62
63          heat event-list mystack
64
65       Delete a stack:
66
67          heat stack-delete mystack
68
69       Abandon a stack:
70
71          heat stack-abandon mystack
72
73       Adopt a stack
74
75          heat stack-adopt -a <adopt_file> mystack
76
77       List heat-engines running status
78
79          heat service-list
80
81       Note: stack-adopt and stack-abandon commands are not available  by  de‐
82       fault.  Please ask your OpenStack operator to enable this feature.
83

BUGS

85       Heat  client  is  hosted  in  Launchpad so you can view current bugs at
86       https://storyboard.openstack.org/#!/project/openstack/python-heatclient.
87

AUTHOR

89       Heat Developers
90

92       OpenStack Contributors
93
94
95
96
972.3.0                            Jul 23, 2021                          HEAT(1)
Impressum