openstack/openstack-manuals
Code Issues Proposed changes

Update for heat 0.2.11

Browse Source 
Regenerated cli chapter for python-heatclient 0.2.11.

Change-Id: If833497605a9f2b38b1f323109bdb513459494e6
This commit is contained in:
Andreas Jaeger 2014-09-19 08:02:03 +02:00
parent 8955d0c843
commit 879f458ec6
1 changed files with 417 additions and 160 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

577
doc/cli-reference/generated/ch_cli_heat_commands.xml
View File

@ -10,10 +10,14 @@
<?dbhtml stop-chunking?> <?dbhtml stop-chunking?>
<title>Orchestration command-line client</title> <title>Orchestration command-line client</title>
<para>The <command>heat</command> client is the command-line interface
(CLI) for the Orchestration API and its extensions. This chapter documents <para>The <command>heat</command> client is the command-line
<command>heat</command> version 0.2.10. interface (CLI) for the Orchestration API and its extensions.
This chapter documents <command>heat</command> version
<literal>0.2.11</literal>.
</para> </para>
<para>For help on a specific <command>heat</command> <para>For help on a specific <command>heat</command>
command, enter: command, enter:
</para> </para>
@ -21,16 +25,23 @@
<section xml:id="heatclient_command_usage"> <section xml:id="heatclient_command_usage">
<title>heat usage</title> <title>heat usage</title>
<screen><computeroutput>usage: heat [--version] [-d] [-v] [-k] [--os-cacert &lt;ca-certificate&gt;] <screen><computeroutput>usage: heat [--version] [-d] [-v] [--api-timeout API_TIMEOUT]
[--cert-file CERT_FILE] [--key-file KEY_FILE] [--ca-file CA_FILE] [--os-no-client-auth] [--heat-url HEAT_URL]
[--api-timeout API_TIMEOUT] [--os-username OS_USERNAME] [--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 &lt;ca-certificate-file&gt;]
[--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-password OS_PASSWORD] [--os-tenant-id OS_TENANT_ID]
[--os-tenant-name OS_TENANT_NAME] [--os-auth-url OS_AUTH_URL] [--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-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-service-type OS_SERVICE_TYPE]
[--os-endpoint-type OS_ENDPOINT_TYPE] [--include-password] [--os-endpoint-type OS_ENDPOINT_TYPE]
&lt;subcommand&gt; ...</computeroutput></screen> &lt;subcommand&gt; ...</computeroutput></screen>
<variablelist wordsize="10"> <variablelist wordsize="10">
<title>Subcommands</title> <title>Subcommands</title>
@ -182,7 +193,7 @@
<term><command>resource-template</command></term> <term><command>resource-template</command></term>
<listitem> <listitem>
<para> <para>
Generate a template based on a resource. <emphasis>DEPRECATED!</emphasis> Use resource-type-template instead.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -202,6 +213,14 @@
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><command>resource-type-template</command></term>
<listitem>
<para>
Generate a template based on a resource type.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><command>stack-abandon</command></term> <term><command>stack-abandon</command></term>
<listitem> <listitem>
@ -218,6 +237,14 @@
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><command>stack-cancel-update</command></term>
<listitem>
<para>
Cancel currently running update of the stack.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><command>stack-create</command></term> <term><command>stack-create</command></term>
<listitem> <listitem>
@ -344,56 +371,6 @@
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><command>-k, --insecure</command></term>
<listitem>
<para>
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.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-cacert &lt;ca-certificate&gt;</command></term>
<listitem>
<para>
Specify a CA bundle file to use in verifying a TLS
(https) server certificate. Defaults to <code>env[OS_CACERT]</code>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--cert-file CERT_FILE</command></term>
<listitem>
<para>
Path of certificate file to use in SSL connection.
This file can optionally be prepended with the private
key.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--key-file KEY_FILE</command></term>
<listitem>
<para>
Path of client key to use in SSL connection.This
option is not necessary if your key is prepended to
your cert file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--ca-file CA_FILE</command></term>
<listitem>
<para>
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.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><command>--api-timeout API_TIMEOUT</command></term> <term><command>--api-timeout API_TIMEOUT</command></term>
<listitem> <listitem>
@ -403,6 +380,104 @@
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><command>--os-no-client-auth</command></term>
<listitem>
<para>
Do not contact keystone for a token. Defaults to
<code>env[OS_NO_CLIENT_AUTH]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--heat-url HEAT_URL</command></term>
<listitem>
<para>
Defaults to <code>env[HEAT_URL]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--heat-api-version HEAT_API_VERSION</command></term>
<listitem>
<para>
Defaults to <code>env[HEAT_API_VERSION]</code> or 1.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--include-password</command></term>
<listitem>
<para>
Send os-username and os-password to heat.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-k, --insecure</command></term>
<listitem>
<para>
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.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-cert OS_CERT</command></term>
<listitem>
<para>
Path of certificate file to use in SSL connection.
This file can optionally be prepended with the private
key.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--cert-file OS_CERT</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use --os-cert.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-key OS_KEY</command></term>
<listitem>
<para>
Path of client key to use in SSL connection. This
option is not necessary if your key is prepended to
your cert file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--key-file OS_KEY</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use --os-key.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-cacert &lt;ca-certificate-file&gt;</command></term>
<listitem>
<para>
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.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--ca-file OS_CACERT</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use --os-cacert.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><command>--os-username OS_USERNAME</command></term> <term><command>--os-username OS_USERNAME</command></term>
<listitem> <listitem>
@ -411,6 +486,66 @@
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><command>--os-user-id OS_USER_ID</command></term>
<listitem>
<para>
Defaults to <code>env[OS_USER_ID]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-user-domain-id OS_USER_DOMAIN_ID</command></term>
<listitem>
<para>
Defaults to <code>env[OS_USER_DOMAIN_ID]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-user-domain-name OS_USER_DOMAIN_NAME</command></term>
<listitem>
<para>
Defaults to <code>env[OS_USER_DOMAIN_NAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-project-id OS_PROJECT_ID</command></term>
<listitem>
<para>
Another way to specify tenant ID. This option is
mutually exclusive with --os-tenant-id. Defaults to
<code>env[OS_PROJECT_ID]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-project-name OS_PROJECT_NAME</command></term>
<listitem>
<para>
Another way to specify tenant name. This option is
mutually exclusive with --os-tenant-name. Defaults to
<code>env[OS_PROJECT_NAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-project-domain-id OS_PROJECT_DOMAIN_ID</command></term>
<listitem>
<para>
Defaults to <code>env[OS_PROJECT_DOMAIN_ID]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-project-domain-name OS_PROJECT_DOMAIN_NAME</command></term>
<listitem>
<para>
Defaults to <code>env[OS_PROJECT_DOMAIN_NAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><command>--os-password OS_PASSWORD</command></term> <term><command>--os-password OS_PASSWORD</command></term>
<listitem> <listitem>
@ -459,31 +594,6 @@
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><command>--os-no-client-auth</command></term>
<listitem>
<para>
Do not contact keystone for a token. Defaults to
<code>env[OS_NO_CLIENT_AUTH]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--heat-url HEAT_URL</command></term>
<listitem>
<para>
Defaults to <code>env[HEAT_URL]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--heat-api-version HEAT_API_VERSION</command></term>
<listitem>
<para>
Defaults to <code>env[HEAT_API_VERSION]</code> or 1.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><command>--os-service-type OS_SERVICE_TYPE</command></term> <term><command>--os-service-type OS_SERVICE_TYPE</command></term>
<listitem> <listitem>
@ -500,18 +610,10 @@
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><command>--include-password</command></term>
<listitem>
<para>
Send os-username and os-password to heat.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</section> </section>
<section xml:id="heatclient_subcommand_action-resume"> <section xml:id="heatclient_subcommand_action-resume">
<title>heat action-resume command</title> <title>heat action-resume</title>
<screen><computeroutput>usage: heat action-resume &lt;NAME or ID&gt;</computeroutput></screen> <screen><computeroutput>usage: heat action-resume &lt;NAME or ID&gt;</computeroutput></screen>
<para> <para>
Resume the stack. Resume the stack.
@ -528,7 +630,7 @@ Resume the stack.
</variablelist> </variablelist>
</section> </section>
<section xml:id="heatclient_subcommand_action-suspend"> <section xml:id="heatclient_subcommand_action-suspend">
<title>heat action-suspend command</title> <title>heat action-suspend</title>
<screen><computeroutput>usage: heat action-suspend &lt;NAME or ID&gt;</computeroutput></screen> <screen><computeroutput>usage: heat action-suspend &lt;NAME or ID&gt;</computeroutput></screen>
<para> <para>
Suspend the stack. Suspend the stack.
@ -545,15 +647,17 @@ Suspend the stack.
</variablelist> </variablelist>
</section> </section>
<section xml:id="heatclient_subcommand_build-info"> <section xml:id="heatclient_subcommand_build-info">
<title>heat build-info command</title> <title>heat build-info</title>
<screen><computeroutput>usage: heat build-info</computeroutput></screen> <screen><computeroutput>usage: heat build-info</computeroutput></screen>
<para> <para>
Retrieve build information. Retrieve build information.
</para> </para>
</section> </section>
<section xml:id="heatclient_subcommand_event-list"> <section xml:id="heatclient_subcommand_event-list">
<title>heat event-list command</title> <title>heat event-list</title>
<screen><computeroutput>usage: heat event-list [-r &lt;RESOURCE&gt;] &lt;NAME or ID&gt;</computeroutput></screen> <screen><computeroutput>usage: heat event-list [-r &lt;RESOURCE&gt;] [-f &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;]
[-l &lt;LIMIT&gt;] [-m &lt;ID&gt;]
&lt;NAME or ID&gt;</computeroutput></screen>
<para> <para>
List events for a stack. List events for a stack.
</para> <variablelist wordsize="10"> </para> <variablelist wordsize="10">
@ -577,10 +681,37 @@ List events for a stack.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><command>-f &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;, --filters &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;</command></term>
<listitem>
<para>
Filter parameters to apply on returned events. This
can be specified multiple times, or once with
parameters separated by a semicolon.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-l &lt;LIMIT&gt;, --limit &lt;LIMIT&gt;</command></term>
<listitem>
<para>
Limit the number of events returned.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-m &lt;ID&gt;, --marker &lt;ID&gt;</command></term>
<listitem>
<para>
Only return events that appear after the given event
ID.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</section> </section>
<section xml:id="heatclient_subcommand_event-show"> <section xml:id="heatclient_subcommand_event-show">
<title>heat event-show command</title> <title>heat event-show</title>
<screen><computeroutput>usage: heat event-show &lt;NAME or ID&gt; &lt;RESOURCE&gt; &lt;EVENT&gt;</computeroutput></screen> <screen><computeroutput>usage: heat event-show &lt;NAME or ID&gt; &lt;RESOURCE&gt; &lt;EVENT&gt;</computeroutput></screen>
<para> <para>
Describe the event. Describe the event.
@ -613,7 +744,7 @@ Describe the event.
</variablelist> </variablelist>
</section> </section>
<section xml:id="heatclient_subcommand_output-list"> <section xml:id="heatclient_subcommand_output-list">
<title>heat output-list command</title> <title>heat output-list</title>
<screen><computeroutput>usage: heat output-list &lt;NAME or ID&gt;</computeroutput></screen> <screen><computeroutput>usage: heat output-list &lt;NAME or ID&gt;</computeroutput></screen>
<para> <para>
Show available outputs. Show available outputs.
@ -630,7 +761,7 @@ Show available outputs.
</variablelist> </variablelist>
</section> </section>
<section xml:id="heatclient_subcommand_output-show"> <section xml:id="heatclient_subcommand_output-show">
<title>heat output-show command</title> <title>heat output-show</title>
<screen><computeroutput>usage: heat output-show &lt;NAME or ID&gt; &lt;OUTPUT NAME&gt;</computeroutput></screen> <screen><computeroutput>usage: heat output-show &lt;NAME or ID&gt; &lt;OUTPUT NAME&gt;</computeroutput></screen>
<para> <para>
Show a specific stack output. Show a specific stack output.
@ -655,8 +786,8 @@ Show a specific stack output.
</variablelist> </variablelist>
</section> </section>
<section xml:id="heatclient_subcommand_resource-list"> <section xml:id="heatclient_subcommand_resource-list">
<title>heat resource-list command</title> <title>heat resource-list</title>
<screen><computeroutput>usage: heat resource-list &lt;NAME or ID&gt;</computeroutput></screen> <screen><computeroutput>usage: heat resource-list [-n &lt;DEPTH&gt;] &lt;NAME or ID&gt;</computeroutput></screen>
<para> <para>
Show list of resources belonging to a stack. Show list of resources belonging to a stack.
</para> <variablelist wordsize="10"> </para> <variablelist wordsize="10">
@ -669,10 +800,22 @@ Show list of resources belonging to a stack.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-n &lt;DEPTH&gt;, --nested-depth &lt;DEPTH&gt;</command></term>
<listitem>
<para>
Depth of nested stacks from which to display
resources.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</section> </section>
<section xml:id="heatclient_subcommand_resource-metadata"> <section xml:id="heatclient_subcommand_resource-metadata">
<title>heat resource-metadata command</title> <title>heat resource-metadata</title>
<screen><computeroutput>usage: heat resource-metadata &lt;NAME or ID&gt; &lt;RESOURCE&gt;</computeroutput></screen> <screen><computeroutput>usage: heat resource-metadata &lt;NAME or ID&gt; &lt;RESOURCE&gt;</computeroutput></screen>
<para> <para>
List resource metadata. List resource metadata.
@ -697,7 +840,7 @@ List resource metadata.
</variablelist> </variablelist>
</section> </section>
<section xml:id="heatclient_subcommand_resource-show"> <section xml:id="heatclient_subcommand_resource-show">
<title>heat resource-show command</title> <title>heat resource-show</title>
<screen><computeroutput>usage: heat resource-show &lt;NAME or ID&gt; &lt;RESOURCE&gt;</computeroutput></screen> <screen><computeroutput>usage: heat resource-show &lt;NAME or ID&gt; &lt;RESOURCE&gt;</computeroutput></screen>
<para> <para>
Describe the resource. Describe the resource.
@ -722,7 +865,7 @@ Describe the resource.
</variablelist> </variablelist>
</section> </section>
<section xml:id="heatclient_subcommand_resource-signal"> <section xml:id="heatclient_subcommand_resource-signal">
<title>heat resource-signal command</title> <title>heat resource-signal</title>
<screen><computeroutput>usage: heat resource-signal [-D &lt;DATA&gt;] [-f &lt;FILE&gt;] &lt;NAME or ID&gt; &lt;RESOURCE&gt;</computeroutput></screen> <screen><computeroutput>usage: heat resource-signal [-D &lt;DATA&gt;] [-f &lt;FILE&gt;] &lt;NAME or ID&gt; &lt;RESOURCE&gt;</computeroutput></screen>
<para> <para>
Send a signal to a resource. Send a signal to a resource.
@ -767,17 +910,17 @@ Send a signal to a resource.
</variablelist> </variablelist>
</section> </section>
<section xml:id="heatclient_subcommand_resource-template"> <section xml:id="heatclient_subcommand_resource-template">
<title>heat resource-template command</title> <title>heat resource-template</title>
<screen><computeroutput>usage: heat resource-template [-F &lt;FORMAT&gt;] &lt;RESOURCE&gt;</computeroutput></screen> <screen><computeroutput>usage: heat resource-template [-F &lt;FORMAT&gt;] &lt;RESOURCE_TYPE&gt;</computeroutput></screen>
<para> <para>
Generate a template based on a resource. <emphasis>DEPRECATED!</emphasis> Use resource-type-template instead.
</para> <variablelist wordsize="10"> </para> <variablelist wordsize="10">
<title>Positional arguments</title> <title>Positional arguments</title>
<varlistentry> <varlistentry>
<term><command>&lt;RESOURCE&gt;</command></term> <term><command>&lt;RESOURCE_TYPE&gt;</command></term>
<listitem> <listitem>
<para> <para>
Name of the resource to generate a template for. Resource type to generate a template for.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -795,14 +938,14 @@ Generate a template based on a resource.
</variablelist> </variablelist>
</section> </section>
<section xml:id="heatclient_subcommand_resource-type-list"> <section xml:id="heatclient_subcommand_resource-type-list">
<title>heat resource-type-list command</title> <title>heat resource-type-list</title>
<screen><computeroutput>usage: heat resource-type-list</computeroutput></screen> <screen><computeroutput>usage: heat resource-type-list</computeroutput></screen>
<para> <para>
List the available resource types. List the available resource types.
</para> </para>
</section> </section>
<section xml:id="heatclient_subcommand_resource-type-show"> <section xml:id="heatclient_subcommand_resource-type-show">
<title>heat resource-type-show command</title> <title>heat resource-type-show</title>
<screen><computeroutput>usage: heat resource-type-show &lt;RESOURCE_TYPE&gt;</computeroutput></screen> <screen><computeroutput>usage: heat resource-type-show &lt;RESOURCE_TYPE&gt;</computeroutput></screen>
<para> <para>
Show the resource type. Show the resource type.
@ -816,15 +959,43 @@ Show the resource type.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist>
</section>
<section xml:id="heatclient_subcommand_resource-type-template">
<title>heat resource-type-template</title>
<screen><computeroutput>usage: heat resource-type-template [-F &lt;FORMAT&gt;] &lt;RESOURCE_TYPE&gt;</computeroutput></screen>
<para>
Generate a template based on a resource type.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;RESOURCE_TYPE&gt;</command></term>
<listitem>
<para>
Resource type to generate a template for.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-F &lt;FORMAT&gt;, --format &lt;FORMAT&gt;</command></term>
<listitem>
<para>
The template output format, one of: yaml, json.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</section> </section>
<section xml:id="heatclient_subcommand_stack-abandon"> <section xml:id="heatclient_subcommand_stack-abandon">
<title>heat stack-abandon command</title> <title>heat stack-abandon</title>
<screen><computeroutput>usage: heat stack-abandon &lt;NAME or ID&gt;</computeroutput></screen> <screen><computeroutput>usage: heat stack-abandon [-O &lt;FILE&gt;] &lt;NAME or ID&gt;</computeroutput></screen>
<para> <para>
Abandon the stack. This will delete the record of the stack from Heat, but 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 will not delete any of the underlying resources. Prints an adoptable JSON
representation of the stack to stdout on success. representation of the stack to stdout or a file on success.
</para> <variablelist wordsize="10"> </para> <variablelist wordsize="10">
<title>Positional arguments</title> <title>Positional arguments</title>
<varlistentry> <varlistentry>
@ -835,12 +1006,24 @@ representation of the stack to stdout on success.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-O &lt;FILE&gt;, --output-file &lt;FILE&gt;</command></term>
<listitem>
<para>
file to output abandon result. If the option is
specified, the result will be output into &lt;FILE&gt;.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</section> </section>
<section xml:id="heatclient_subcommand_stack-adopt"> <section xml:id="heatclient_subcommand_stack-adopt">
<title>heat stack-adopt command</title> <title>heat stack-adopt</title>
<screen><computeroutput>usage: heat stack-adopt [-f &lt;FILE&gt;] [-e &lt;FILE or URL&gt;] [-u &lt;URL&gt;] [-o &lt;URL&gt;] <screen><computeroutput>usage: heat stack-adopt [-e &lt;FILE or URL&gt;] [-c &lt;TIMEOUT&gt;] [-t &lt;TIMEOUT&gt;]
[-c &lt;TIMEOUT&gt;] [-t &lt;TIMEOUT&gt;] [-a &lt;FILE or URL&gt;] [-r] [-a &lt;FILE or URL&gt;] [-r]
[-P &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;] [-P &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;]
&lt;STACK_NAME&gt;</computeroutput></screen> &lt;STACK_NAME&gt;</computeroutput></screen>
<para> <para>
@ -858,35 +1041,12 @@ Adopt a stack.
</variablelist> </variablelist>
<variablelist wordsize="10"> <variablelist wordsize="10">
<title>Optional arguments</title> <title>Optional arguments</title>
<varlistentry>
<term><command>-f &lt;FILE&gt;, --template-file &lt;FILE&gt;</command></term>
<listitem>
<para>
Path to the template.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><command>-e &lt;FILE or URL&gt;, --environment-file &lt;FILE or URL&gt;</command></term> <term><command>-e &lt;FILE or URL&gt;, --environment-file &lt;FILE or URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
Path to the environment. Path to the environment, it can be specified multiple
</para> times.
</listitem>
</varlistentry>
<varlistentry>
<term><command>-u &lt;URL&gt;, --template-url &lt;URL&gt;</command></term>
<listitem>
<para>
URL of template.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-o &lt;URL&gt;, --template-object &lt;URL&gt;</command></term>
<listitem>
<para>
URL to retrieve template object (e.g. from swift).
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -933,10 +1093,27 @@ Adopt a stack.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist>
</section>
<section xml:id="heatclient_subcommand_stack-cancel-update">
<title>heat stack-cancel-update</title>
<screen><computeroutput>usage: heat stack-cancel-update &lt;NAME or ID&gt;</computeroutput></screen>
<para>
Cancel currently running update of the stack.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;NAME or ID&gt;</command></term>
<listitem>
<para>
Name or ID of stack to cancel update for.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</section> </section>
<section xml:id="heatclient_subcommand_stack-create"> <section xml:id="heatclient_subcommand_stack-create">
<title>heat stack-create command</title> <title>heat stack-create</title>
<screen><computeroutput>usage: heat stack-create [-f &lt;FILE&gt;] [-e &lt;FILE or URL&gt;] [-u &lt;URL&gt;] [-o &lt;URL&gt;] <screen><computeroutput>usage: heat stack-create [-f &lt;FILE&gt;] [-e &lt;FILE or URL&gt;] [-u &lt;URL&gt;] [-o &lt;URL&gt;]
[-c &lt;TIMEOUT&gt;] [-t &lt;TIMEOUT&gt;] [-r] [-c &lt;TIMEOUT&gt;] [-t &lt;TIMEOUT&gt;] [-r]
[-P &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;] [-P &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;]
@ -968,7 +1145,8 @@ Create the stack.
<term><command>-e &lt;FILE or URL&gt;, --environment-file &lt;FILE or URL&gt;</command></term> <term><command>-e &lt;FILE or URL&gt;, --environment-file &lt;FILE or URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
Path to the environment. Path to the environment, it can be specified multiple
times.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -1026,7 +1204,7 @@ Create the stack.
</variablelist> </variablelist>
</section> </section>
<section xml:id="heatclient_subcommand_stack-delete"> <section xml:id="heatclient_subcommand_stack-delete">
<title>heat stack-delete command</title> <title>heat stack-delete</title>
<screen><computeroutput>usage: heat stack-delete &lt;NAME or ID&gt; [&lt;NAME or ID&gt; ...]</computeroutput></screen> <screen><computeroutput>usage: heat stack-delete &lt;NAME or ID&gt; [&lt;NAME or ID&gt; ...]</computeroutput></screen>
<para> <para>
Delete the stack(s). Delete the stack(s).
@ -1043,9 +1221,9 @@ Delete the stack(s).
</variablelist> </variablelist>
</section> </section>
<section xml:id="heatclient_subcommand_stack-list"> <section xml:id="heatclient_subcommand_stack-list">
<title>heat stack-list command</title> <title>heat stack-list</title>
<screen><computeroutput>usage: heat stack-list [-s] [-f &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;] [-l &lt;LIMIT&gt;] <screen><computeroutput>usage: heat stack-list [-s] [-n] [-f &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;]
[-m &lt;ID&gt;] [-g]</computeroutput></screen> [-l &lt;LIMIT&gt;] [-m &lt;ID&gt;] [-g] [-o]</computeroutput></screen>
<para> <para>
List the user's stacks. List the user's stacks.
</para> <variablelist wordsize="10"> </para> <variablelist wordsize="10">
@ -1058,6 +1236,14 @@ List the user's stacks.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><command>-n, --show-nested</command></term>
<listitem>
<para>
Include nested stacks in the stack listing.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><command>-f &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;, --filters &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;</command></term> <term><command>-f &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;, --filters &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;</command></term>
<listitem> <listitem>
@ -1095,11 +1281,21 @@ List the user's stacks.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><command>-o, --show-owner</command></term>
<listitem>
<para>
Display stack owner information. This is automatically
enabled when using --global-tenant.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</section> </section>
<section xml:id="heatclient_subcommand_stack-preview"> <section xml:id="heatclient_subcommand_stack-preview">
<title>heat stack-preview command</title> <title>heat stack-preview</title>
<screen><computeroutput>usage: heat stack-preview [-f &lt;FILE&gt;] [-e &lt;FILE or URL&gt;] [-u &lt;URL&gt;] [-o &lt;URL&gt;] <screen><computeroutput>usage: heat stack-preview [-f &lt;FILE&gt;] [-e &lt;FILE or URL&gt;] [-u &lt;URL&gt;] [-o &lt;URL&gt;]
[-t &lt;TIMEOUT&gt;] [-r]
[-P &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;] [-P &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;]
&lt;STACK_NAME&gt;</computeroutput></screen> &lt;STACK_NAME&gt;</computeroutput></screen>
<para> <para>
@ -1129,7 +1325,8 @@ Preview the stack.
<term><command>-e &lt;FILE or URL&gt;, --environment-file &lt;FILE or URL&gt;</command></term> <term><command>-e &lt;FILE or URL&gt;, --environment-file &lt;FILE or URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
Path to the environment. Path to the environment, it can be specified multiple
times.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -1149,6 +1346,25 @@ Preview the stack.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><command>-t &lt;TIMEOUT&gt;, --timeout &lt;TIMEOUT&gt;</command></term>
<listitem>
<para>
Stack creation timeout in minutes. This is only used
duringvalidation in preview.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-r, --enable-rollback</command></term>
<listitem>
<para>
Enable rollback on failure. This option is not used
duringpreview and exists only for symmetry with stack-
create.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><command>-P &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;, --parameters &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;</command></term> <term><command>-P &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;, --parameters &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;</command></term>
<listitem> <listitem>
@ -1162,7 +1378,7 @@ Preview the stack.
</variablelist> </variablelist>
</section> </section>
<section xml:id="heatclient_subcommand_stack-show"> <section xml:id="heatclient_subcommand_stack-show">
<title>heat stack-show command</title> <title>heat stack-show</title>
<screen><computeroutput>usage: heat stack-show &lt;NAME or ID&gt;</computeroutput></screen> <screen><computeroutput>usage: heat stack-show &lt;NAME or ID&gt;</computeroutput></screen>
<para> <para>
Describe the stack. Describe the stack.
@ -1179,9 +1395,11 @@ Describe the stack.
</variablelist> </variablelist>
</section> </section>
<section xml:id="heatclient_subcommand_stack-update"> <section xml:id="heatclient_subcommand_stack-update">
<title>heat stack-update command</title> <title>heat stack-update</title>
<screen><computeroutput>usage: heat stack-update [-f &lt;FILE&gt;] [-e &lt;FILE or URL&gt;] [-u &lt;URL&gt;] [-o &lt;URL&gt;] <screen><computeroutput>usage: heat stack-update [-f &lt;FILE&gt;] [-e &lt;FILE or URL&gt;] [-u &lt;URL&gt;] [-o &lt;URL&gt;]
[-t &lt;TIMEOUT&gt;] [-r] [-P &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;] [-t &lt;TIMEOUT&gt;] [-r] [--rollback &lt;VALUE&gt;]
[-P &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;] [-x]
[-c &lt;PARAMETER&gt;]
&lt;NAME or ID&gt;</computeroutput></screen> &lt;NAME or ID&gt;</computeroutput></screen>
<para> <para>
Update the stack. Update the stack.
@ -1210,7 +1428,8 @@ Update the stack.
<term><command>-e &lt;FILE or URL&gt;, --environment-file &lt;FILE or URL&gt;</command></term> <term><command>-e &lt;FILE or URL&gt;, --environment-file &lt;FILE or URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
Path to the environment. Path to the environment, it can be specified multiple
times.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -1242,7 +1461,22 @@ Update the stack.
<term><command>-r, --enable-rollback</command></term> <term><command>-r, --enable-rollback</command></term>
<listitem> <listitem>
<para> <para>
Enable rollback on create/update failure. <emphasis>DEPRECATED!</emphasis> Use --rollback argument instead. Enable
rollback on stack update failure. NOTE: default
behavior is now to use the rollback value of existing
stack.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--rollback &lt;VALUE&gt;</command></term>
<listitem>
<para>
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.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -1256,10 +1490,32 @@ Update the stack.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><command>-x, --existing</command></term>
<listitem>
<para>
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.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-c &lt;PARAMETER&gt;, --clear-parameter &lt;PARAMETER&gt;</command></term>
<listitem>
<para>
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.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</section> </section>
<section xml:id="heatclient_subcommand_template-show"> <section xml:id="heatclient_subcommand_template-show">
<title>heat template-show command</title> <title>heat template-show</title>
<screen><computeroutput>usage: heat template-show &lt;NAME or ID&gt;</computeroutput></screen> <screen><computeroutput>usage: heat template-show &lt;NAME or ID&gt;</computeroutput></screen>
<para> <para>
Get the template for the specified stack. Get the template for the specified stack.
@ -1276,7 +1532,7 @@ Get the template for the specified stack.
</variablelist> </variablelist>
</section> </section>
<section xml:id="heatclient_subcommand_template-validate"> <section xml:id="heatclient_subcommand_template-validate">
<title>heat template-validate command</title> <title>heat template-validate</title>
<screen><computeroutput>usage: heat template-validate [-u &lt;URL&gt;] [-f &lt;FILE&gt;] [-e &lt;FILE or URL&gt;] <screen><computeroutput>usage: heat template-validate [-u &lt;URL&gt;] [-f &lt;FILE&gt;] [-e &lt;FILE or URL&gt;]
[-o &lt;URL&gt;]</computeroutput></screen> [-o &lt;URL&gt;]</computeroutput></screen>
<para> <para>
@ -1303,7 +1559,8 @@ Validate a template with parameters.
<term><command>-e &lt;FILE or URL&gt;, --environment-file &lt;FILE or URL&gt;</command></term> <term><command>-e &lt;FILE or URL&gt;, --environment-file &lt;FILE or URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
Path to the environment. Path to the environment, it can be specified multiple
times.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>