Update CLI reference for python-heatclient 0.3.0
Change-Id: I9d0649694e36aa697aee61747b29e6eb2927873f
This commit is contained in:
Christian Berendt
parent
9467e94d4c
commit
3717096c8e
@ -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.2.12</literal>.
|
<literal>0.3.0</literal>.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>For help on a specific <command>heat</command>
|
<para>For help on a specific <command>heat</command>
|
||||||
@ -77,6 +77,30 @@
|
|||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command>config-create</command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Create a software configuration.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command>config-delete</command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Delete software configurations.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command>config-show</command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
View details of a software configuration.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><command>create</command></term>
|
<term><command>create</command></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
@ -93,6 +117,31 @@
|
|||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command>deployment-delete</command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Delete software deployments.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command>deployment-metadata-show</command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Get deployment configuration metadata for the
|
||||||
|
specified server.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command>deployment-show</command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Show the details of a software deployment.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><command>describe</command></term>
|
<term><command>describe</command></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
@ -229,6 +278,38 @@
|
|||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command>service-list</command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
List the Heat engines.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command>snapshot-delete</command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Delete a snapshot of a stack.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command>snapshot-list</command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
List the snapshots of a stack.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command>snapshot-show</command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Show a snapshot of a stack.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><command>stack-abandon</command></term>
|
<term><command>stack-abandon</command></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
@ -285,6 +366,14 @@
|
|||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command>stack-restore</command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Restore a snapshot of a stack.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><command>stack-show</command></term>
|
<term><command>stack-show</command></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
@ -293,6 +382,14 @@
|
|||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command>stack-snapshot</command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Make a snapshot of a stack.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><command>stack-update</command></term>
|
<term><command>stack-update</command></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
@ -678,6 +775,150 @@ Suspend the stack.
|
|||||||
Retrieve build information.
|
Retrieve build information.
|
||||||
</para>
|
</para>
|
||||||
</section>
|
</section>
|
||||||
|
<section xml:id="heatclient_subcommand_config-create">
|
||||||
|
<title>heat config-create</title>
|
||||||
|
<screen><computeroutput>usage: heat config-create [-f <FILE or URL>] [-c <FILE or URL>]
|
||||||
|
[-g <GROUP_NAME>]
|
||||||
|
<CONFIG_NAME></computeroutput></screen>
|
||||||
|
<para>
|
||||||
|
Create a software configuration.
|
||||||
|
</para> <variablelist wordsize="10">
|
||||||
|
<title>Positional arguments</title>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command><CONFIG_NAME></command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Name of the configuration to create.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
<variablelist wordsize="10">
|
||||||
|
<title>Optional arguments</title>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command>-f <FILE or URL>, --definition-file <FILE or URL></command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Path to JSON/YAML containing map defining <inputs>,
|
||||||
|
<outputs>, and <options>.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command>-c <FILE or URL>, --config-file <FILE or URL></command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Path to configuration script/data.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command>-g <GROUP_NAME>, --group <GROUP_NAME></command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Group name of configuration tool expected by the
|
||||||
|
config.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
</section>
|
||||||
|
<section xml:id="heatclient_subcommand_config-delete">
|
||||||
|
<title>heat config-delete</title>
|
||||||
|
<screen><computeroutput>usage: heat config-delete <ID> [<ID> ...]</computeroutput></screen>
|
||||||
|
<para>
|
||||||
|
Delete software configurations.
|
||||||
|
</para> <variablelist wordsize="10">
|
||||||
|
<title>Positional arguments</title>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command><ID></command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
IDs of the configurations to delete.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
</section>
|
||||||
|
<section xml:id="heatclient_subcommand_config-show">
|
||||||
|
<title>heat config-show</title>
|
||||||
|
<screen><computeroutput>usage: heat config-show [-c] <ID></computeroutput></screen>
|
||||||
|
<para>
|
||||||
|
View details of a software configuration.
|
||||||
|
</para> <variablelist wordsize="10">
|
||||||
|
<title>Positional arguments</title>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command><ID></command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
ID of the config.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
<variablelist wordsize="10">
|
||||||
|
<title>Optional arguments</title>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command>-c, --config-only</command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Only display the value of the <config> property.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
</section>
|
||||||
|
<section xml:id="heatclient_subcommand_deployment-delete">
|
||||||
|
<title>heat deployment-delete</title>
|
||||||
|
<screen><computeroutput>usage: heat deployment-delete <ID> [<ID> ...]</computeroutput></screen>
|
||||||
|
<para>
|
||||||
|
Delete software deployments.
|
||||||
|
</para> <variablelist wordsize="10">
|
||||||
|
<title>Positional arguments</title>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command><ID></command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
IDs of the deployments to delete.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
</section>
|
||||||
|
<section xml:id="heatclient_subcommand_deployment-metadata-show">
|
||||||
|
<title>heat deployment-metadata-show</title>
|
||||||
|
<screen><computeroutput>usage: heat deployment-metadata-show <ID></computeroutput></screen>
|
||||||
|
<para>
|
||||||
|
Get deployment configuration metadata for the specified server.
|
||||||
|
</para> <variablelist wordsize="10">
|
||||||
|
<title>Positional arguments</title>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command><ID></command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
ID of the server to fetch deployments for.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
</section>
|
||||||
|
<section xml:id="heatclient_subcommand_deployment-show">
|
||||||
|
<title>heat deployment-show</title>
|
||||||
|
<screen><computeroutput>usage: heat deployment-show <ID></computeroutput></screen>
|
||||||
|
<para>
|
||||||
|
Show the details of a software deployment.
|
||||||
|
</para> <variablelist wordsize="10">
|
||||||
|
<title>Positional arguments</title>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command><ID></command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
ID of the deployment.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
</section>
|
||||||
<section xml:id="heatclient_subcommand_event-list">
|
<section xml:id="heatclient_subcommand_event-list">
|
||||||
<title>heat event-list</title>
|
<title>heat event-list</title>
|
||||||
<screen><computeroutput>usage: heat event-list [-r <RESOURCE>] [-f <KEY1=VALUE1;KEY2=VALUE2...>]
|
<screen><computeroutput>usage: heat event-list [-r <RESOURCE>] [-f <KEY1=VALUE1;KEY2=VALUE2...>]
|
||||||
@ -787,7 +1028,7 @@ Show available outputs.
|
|||||||
</section>
|
</section>
|
||||||
<section xml:id="heatclient_subcommand_output-show">
|
<section xml:id="heatclient_subcommand_output-show">
|
||||||
<title>heat output-show</title>
|
<title>heat output-show</title>
|
||||||
<screen><computeroutput>usage: heat output-show <NAME or ID> <OUTPUT NAME></computeroutput></screen>
|
<screen><computeroutput>usage: heat output-show [-a] [-F <FORMAT>] <NAME or ID> [<OUTPUT NAME>]</computeroutput></screen>
|
||||||
<para>
|
<para>
|
||||||
Show a specific stack output.
|
Show a specific stack output.
|
||||||
</para> <variablelist wordsize="10">
|
</para> <variablelist wordsize="10">
|
||||||
@ -808,6 +1049,25 @@ Show a specific stack output.
|
|||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
<variablelist wordsize="10">
|
||||||
|
<title>Optional arguments</title>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command>-a, --all</command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Display all stack outputs.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command>-F <FORMAT>, --format <FORMAT></command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
The output value format, one of: json, raw
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
</variablelist>
|
</variablelist>
|
||||||
</section>
|
</section>
|
||||||
<section xml:id="heatclient_subcommand_resource-list">
|
<section xml:id="heatclient_subcommand_resource-list">
|
||||||
@ -1012,6 +1272,80 @@ Generate a template based on a resource type.
|
|||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
</section>
|
||||||
|
<section xml:id="heatclient_subcommand_service-list">
|
||||||
|
<title>heat service-list</title>
|
||||||
|
<screen><computeroutput>usage: heat service-list</computeroutput></screen>
|
||||||
|
<para>
|
||||||
|
List the Heat engines.
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
<section xml:id="heatclient_subcommand_snapshot-delete">
|
||||||
|
<title>heat snapshot-delete</title>
|
||||||
|
<screen><computeroutput>usage: heat snapshot-delete <NAME or ID> <SNAPSHOT></computeroutput></screen>
|
||||||
|
<para>
|
||||||
|
Delete a snapshot of a stack.
|
||||||
|
</para> <variablelist wordsize="10">
|
||||||
|
<title>Positional arguments</title>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command><NAME or ID></command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Name or ID of the stack containing the snapshot.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command><SNAPSHOT></command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
The ID of the snapshot to delete.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
</section>
|
||||||
|
<section xml:id="heatclient_subcommand_snapshot-list">
|
||||||
|
<title>heat snapshot-list</title>
|
||||||
|
<screen><computeroutput>usage: heat snapshot-list <NAME or ID></computeroutput></screen>
|
||||||
|
<para>
|
||||||
|
List the snapshots of a stack.
|
||||||
|
</para> <variablelist wordsize="10">
|
||||||
|
<title>Positional arguments</title>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command><NAME or ID></command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Name or ID of the stack containing the snapshots.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
</section>
|
||||||
|
<section xml:id="heatclient_subcommand_snapshot-show">
|
||||||
|
<title>heat snapshot-show</title>
|
||||||
|
<screen><computeroutput>usage: heat snapshot-show <NAME or ID> <SNAPSHOT></computeroutput></screen>
|
||||||
|
<para>
|
||||||
|
Show a snapshot of a stack.
|
||||||
|
</para> <variablelist wordsize="10">
|
||||||
|
<title>Positional arguments</title>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command><NAME or ID></command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Name or ID of the stack containing the snapshot.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command><SNAPSHOT></command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
The ID of the snapshot to show.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
</variablelist>
|
</variablelist>
|
||||||
</section>
|
</section>
|
||||||
<section xml:id="heatclient_subcommand_stack-abandon">
|
<section xml:id="heatclient_subcommand_stack-abandon">
|
||||||
@ -1400,6 +1734,31 @@ Preview the stack.
|
|||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
</section>
|
||||||
|
<section xml:id="heatclient_subcommand_stack-restore">
|
||||||
|
<title>heat stack-restore</title>
|
||||||
|
<screen><computeroutput>usage: heat stack-restore <NAME or ID> <SNAPSHOT></computeroutput></screen>
|
||||||
|
<para>
|
||||||
|
Restore a snapshot of a stack.
|
||||||
|
</para> <variablelist wordsize="10">
|
||||||
|
<title>Positional arguments</title>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command><NAME or ID></command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Name or ID of the stack containing the snapshot.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command><SNAPSHOT></command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
The ID of the snapshot to restore.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
</variablelist>
|
</variablelist>
|
||||||
</section>
|
</section>
|
||||||
<section xml:id="heatclient_subcommand_stack-show">
|
<section xml:id="heatclient_subcommand_stack-show">
|
||||||
@ -1417,6 +1776,34 @@ Describe the stack.
|
|||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
</section>
|
||||||
|
<section xml:id="heatclient_subcommand_stack-snapshot">
|
||||||
|
<title>heat stack-snapshot</title>
|
||||||
|
<screen><computeroutput>usage: heat stack-snapshot [-n <NAME>] <NAME or ID></computeroutput></screen>
|
||||||
|
<para>
|
||||||
|
Make a snapshot of a stack.
|
||||||
|
</para> <variablelist wordsize="10">
|
||||||
|
<title>Positional arguments</title>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command><NAME or ID></command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Name or ID of stack to snapshot.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
<variablelist wordsize="10">
|
||||||
|
<title>Optional arguments</title>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command>-n <NAME>, --name <NAME></command></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
If specified, the name given to the snapshot.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
</variablelist>
|
</variablelist>
|
||||||
</section>
|
</section>
|
||||||
<section xml:id="heatclient_subcommand_stack-update">
|
<section xml:id="heatclient_subcommand_stack-update">
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user