Update CLI reference for python-heatclient 0.8.0
Change-Id: I5aa0062c74b8d189284e908dc6477be464181839
This commit is contained in:
parent
c0ca3c53c3
commit
b9c3a70e76
@ -15,7 +15,7 @@
|
|||||||
interface (CLI) for the Orchestration API and its extensions.
|
interface (CLI) for the Orchestration API and its extensions.
|
||||||
|
|
||||||
This chapter documents <command>heat</command> version
|
This chapter documents <command>heat</command> version
|
||||||
<literal>0.7.0</literal>.
|
<literal>0.8.0</literal>.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>For help on a specific <command>heat</command>
|
<para>For help on a specific <command>heat</command>
|
||||||
@ -1455,10 +1455,23 @@ Send a signal to a resource.
|
|||||||
</section>
|
</section>
|
||||||
<section xml:id="heatclient_subcommand_resource-type-list">
|
<section xml:id="heatclient_subcommand_resource-type-list">
|
||||||
<title>heat resource-type-list</title>
|
<title>heat resource-type-list</title>
|
||||||
<screen><computeroutput>usage: heat resource-type-list</computeroutput></screen>
|
<screen><computeroutput>usage: heat resource-type-list [-f <KEY1=VALUE1;KEY2=VALUE2...>]</computeroutput></screen>
|
||||||
<para>
|
<para>
|
||||||
List the available resource types.
|
List the available resource types.
|
||||||
</para>
|
</para> <variablelist wordsize="10">
|
||||||
|
<title>Optional arguments</title>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command>-f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...></command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Filter parameters to apply on returned resource types.
|
||||||
|
This can be specified multiple times, or once with
|
||||||
|
parameters separated by a semicolon. It can be any of
|
||||||
|
name, version and support_status
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
</section>
|
</section>
|
||||||
<section xml:id="heatclient_subcommand_resource-type-show">
|
<section xml:id="heatclient_subcommand_resource-type-show">
|
||||||
<title>heat resource-type-show</title>
|
<title>heat resource-type-show</title>
|
||||||
@ -1868,7 +1881,7 @@ Delete the stack(s).
|
|||||||
[-t <TAG1,TAG2...>] [--tags-any <TAG1,TAG2...>]
|
[-t <TAG1,TAG2...>] [--tags-any <TAG1,TAG2...>]
|
||||||
[--not-tags <TAG1,TAG2...>]
|
[--not-tags <TAG1,TAG2...>]
|
||||||
[--not-tags-any <TAG1,TAG2...>] [-l <LIMIT>] [-m <ID>]
|
[--not-tags-any <TAG1,TAG2...>] [-l <LIMIT>] [-m <ID>]
|
||||||
[-g] [-o]</computeroutput></screen>
|
[-k <KEY1,KEY2...>] [-d [asc|desc]] [-g] [-o]</computeroutput></screen>
|
||||||
<para>
|
<para>
|
||||||
List the user's stacks.
|
List the user's stacks.
|
||||||
</para> <variablelist wordsize="10">
|
</para> <variablelist wordsize="10">
|
||||||
@ -1960,6 +1973,27 @@ List the user's stacks.
|
|||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command>-k <KEY1,KEY2...>, --sort-keys <KEY1,KEY2...></command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
List of keys for sorting the returned stacks. This can
|
||||||
|
be specified multiple times or once with keys
|
||||||
|
separated by semicolons. Valid sorting keys include
|
||||||
|
"stack_name", "stack_status", "creation_time" and
|
||||||
|
"updated_time".
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command>-d [asc|desc], --sort-dir [asc|desc]</command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Sorting direction (either "asc" or "desc") for the
|
||||||
|
sorting keys.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><command>-g, --global-tenant</command></term>
|
<term><command>-g, --global-tenant</command></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
@ -2159,7 +2193,7 @@ Make a snapshot of a stack.
|
|||||||
<title>heat stack-update</title>
|
<title>heat stack-update</title>
|
||||||
<screen><computeroutput>usage: heat stack-update [-f <FILE>] [-e <FILE or URL>]
|
<screen><computeroutput>usage: heat stack-update [-f <FILE>] [-e <FILE or URL>]
|
||||||
[--pre-update <RESOURCE>] [-u <URL>] [-o <URL>]
|
[--pre-update <RESOURCE>] [-u <URL>] [-o <URL>]
|
||||||
[-t <TIMEOUT>] [-r] [--rollback <VALUE>]
|
[-t <TIMEOUT>] [-r] [--rollback <VALUE>] [-y]
|
||||||
[-P <KEY1=VALUE1;KEY2=VALUE2...>] [-Pf <KEY=FILE>]
|
[-P <KEY1=VALUE1;KEY2=VALUE2...>] [-Pf <KEY=FILE>]
|
||||||
[-x] [-c <PARAMETER>] [--tags <TAG1,TAG2>]
|
[-x] [-c <PARAMETER>] [--tags <TAG1,TAG2>]
|
||||||
<NAME or ID></computeroutput></screen>
|
<NAME or ID></computeroutput></screen>
|
||||||
@ -2255,6 +2289,15 @@ Update the stack.
|
|||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command>-y, --dry-run</command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Do not actually perform the stack update, but show
|
||||||
|
what would be changed
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><command>-P <KEY1=VALUE1;KEY2=VALUE2...>, --parameters <KEY1=VALUE1;KEY2=VALUE2...></command></term>
|
<term><command>-P <KEY1=VALUE1;KEY2=VALUE2...>, --parameters <KEY1=VALUE1;KEY2=VALUE2...></command></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
@ -2279,10 +2322,14 @@ Update the stack.
|
|||||||
<term><command>-x, --existing</command></term>
|
<term><command>-x, --existing</command></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Re-use the set of parameters of the current stack.
|
Re-use the template, parameters and environment of the
|
||||||
Parameters specified in --parameters will patch over
|
current stack. If the template argument is omitted
|
||||||
the existing values in the current stack. Parameters
|
then the existing template is used. If no
|
||||||
omitted will keep the existing values.
|
--environment-file is specified then the existing
|
||||||
|
environment is used. Parameters specified in
|
||||||
|
--parameters will patch over the existing values in
|
||||||
|
the current stack. Parameters omitted will keep the
|
||||||
|
existing values.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
@ -2344,7 +2391,7 @@ Get the template for the specified stack.
|
|||||||
<section xml:id="heatclient_subcommand_template-validate">
|
<section xml:id="heatclient_subcommand_template-validate">
|
||||||
<title>heat template-validate</title>
|
<title>heat template-validate</title>
|
||||||
<screen><computeroutput>usage: heat template-validate [-u <URL>] [-f <FILE>] [-e <FILE or URL>]
|
<screen><computeroutput>usage: heat template-validate [-u <URL>] [-f <FILE>] [-e <FILE or URL>]
|
||||||
[-o <URL>]</computeroutput></screen>
|
[-o <URL>] [-n]</computeroutput></screen>
|
||||||
<para>
|
<para>
|
||||||
Validate a template with parameters.
|
Validate a template with parameters.
|
||||||
</para> <variablelist wordsize="10">
|
</para> <variablelist wordsize="10">
|
||||||
@ -2382,6 +2429,14 @@ Validate a template with parameters.
|
|||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command>-n, --show-nested</command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Resolve parameters from nested templates as well.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
</variablelist>
|
</variablelist>
|
||||||
</section>
|
</section>
|
||||||
<section xml:id="heatclient_subcommand_template-version-list">
|
<section xml:id="heatclient_subcommand_template-version-list">
|
||||||
|
Loading…
Reference in New Issue
Block a user