4113bb218e
Change-Id: I410067be5b489f5547f9fced3f7db841088fb8eb
1000 lines
28 KiB
XML
1000 lines
28 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<chapter xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
|
|
xml:id="heatclient_commands">
|
|
|
|
<!-- This file is automatically generated, do not edit -->
|
|
|
|
<?dbhtml stop-chunking?>
|
|
|
|
<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.
|
|
</para>
|
|
<para>For help on a specific <command>heat</command>
|
|
command, enter:
|
|
</para>
|
|
<screen><prompt>$</prompt> <userinput><command>heat</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
|
|
|
|
<section xml:id="heatclient_command_usage">
|
|
<title>heat usage</title>
|
|
<screen><computeroutput> [--key-file KEY_FILE] [--ca-file CA_FILE] [--timeout TIMEOUT]
|
|
[--os-username OS_USERNAME] [--os-password OS_PASSWORD]
|
|
[--os-tenant-id OS_TENANT_ID] [--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-no-client-auth]
|
|
[--heat-url HEAT_URL] [--heat-api-version HEAT_API_VERSION]
|
|
[--os-service-type OS_SERVICE_TYPE]
|
|
[--os-endpoint-type OS_ENDPOINT_TYPE] [--include-password]
|
|
<subcommand> ...
|
|
</computeroutput></screen>
|
|
<variablelist wordsize="10">
|
|
<title>Subcommands</title>
|
|
<varlistentry>
|
|
<term><command>action-resume</command></term>
|
|
<listitem>
|
|
<para>
|
|
Resume the stack.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>action-suspend</command></term>
|
|
<listitem>
|
|
<para>
|
|
Suspend the stack.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>build-info</command></term>
|
|
<listitem>
|
|
<para>
|
|
Retrieve build information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>create</command></term>
|
|
<listitem>
|
|
<para>
|
|
<emphasis>DEPRECATED!</emphasis> Use stack-create instead.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
<emphasis>DEPRECATED!</emphasis> Use stack-delete instead.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>describe</command></term>
|
|
<listitem>
|
|
<para>
|
|
<emphasis>DEPRECATED!</emphasis> Use stack-show instead.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>event</command></term>
|
|
<listitem>
|
|
<para>
|
|
<emphasis>DEPRECATED!</emphasis> Use event-show instead.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>event-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List events for a stack.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>event-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Describe the event.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>gettemplate</command></term>
|
|
<listitem>
|
|
<para>
|
|
<emphasis>DEPRECATED!</emphasis> Use template-show instead.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>list</command></term>
|
|
<listitem>
|
|
<para>
|
|
<emphasis>DEPRECATED!</emphasis> Use stack-list instead.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>resource</command></term>
|
|
<listitem>
|
|
<para>
|
|
<emphasis>DEPRECATED!</emphasis> Use resource-show instead.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>resource-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show list of resources belonging to a stack.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>resource-metadata</command></term>
|
|
<listitem>
|
|
<para>
|
|
List resource metadata.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>resource-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Describe the resource.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>resource-template</command></term>
|
|
<listitem>
|
|
<para>
|
|
Generate a template based on a resource.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>resource-type-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List the available resource types.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>resource-type-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show the resource type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>stack-abandon</command></term>
|
|
<listitem>
|
|
<para>
|
|
Abandon the stack.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>stack-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create the stack.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>stack-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete the stack(s).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>stack-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List the user's stacks.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>stack-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Describe the stack.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>stack-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update the stack.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>template-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Get the template for the specified stack.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>template-validate</command></term>
|
|
<listitem>
|
|
<para>
|
|
Validate a template with parameters.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>update</command></term>
|
|
<listitem>
|
|
<para>
|
|
<emphasis>DEPRECATED!</emphasis> Use stack-update instead.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>validate</command></term>
|
|
<listitem>
|
|
<para>
|
|
<emphasis>DEPRECATED!</emphasis> Use template-validate instead.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>bash-completion</command></term>
|
|
<listitem>
|
|
<para>
|
|
Prints all of the commands and options to stdout.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>help</command></term>
|
|
<listitem>
|
|
<para>
|
|
Display help about this program or one of its
|
|
subcommands.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="heatclient_command_optional">
|
|
<title>heat optional arguments</title>
|
|
<variablelist wordsize="10">
|
|
<varlistentry>
|
|
<term><command>--version</command></term>
|
|
<listitem>
|
|
<para>
|
|
Shows the client version and exits
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-d, --debug</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[HEATCLIENT_DEBUG]</code>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-v, --verbose</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print more verbose output
|
|
</para>
|
|
</listitem>
|
|
</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>--cert-file CERT_FILE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Path of certificate file to use in SSL connection.
|
|
This file can optionally be prependedwith 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>
|
|
<term><command>--timeout TIMEOUT</command></term>
|
|
<listitem>
|
|
<para>
|
|
Number of seconds to wait for a response
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-username OS_USERNAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_USERNAME]</code>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-password OS_PASSWORD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_PASSWORD]</code>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-tenant-id OS_TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_TENANT_ID]</code>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-tenant-name OS_TENANT_NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_TENANT_NAME]</code>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-auth-url OS_AUTH_URL</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_AUTH_URL]</code>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-region-name OS_REGION_NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_REGION_NAME]</code>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-auth-token OS_AUTH_TOKEN</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_AUTH_TOKEN]</code>
|
|
</para>
|
|
</listitem>
|
|
</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>--os-service-type OS_SERVICE_TYPE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_SERVICE_TYPE]</code>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-endpoint-type OS_ENDPOINT_TYPE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_ENDPOINT_TYPE]</code>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--include-password</command></term>
|
|
<listitem>
|
|
<para>
|
|
Send os-username and os-password to heat
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="heatclient_subcommand_action-resume">
|
|
<title>heat action-resume command</title>
|
|
<screen><computeroutput>usage: heat action-resume <NAME or ID>
|
|
</computeroutput></screen>
|
|
<para>
|
|
Resume the 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 resume.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="heatclient_subcommand_action-suspend">
|
|
<title>heat action-suspend command</title>
|
|
<screen><computeroutput>usage: heat action-suspend <NAME or ID>
|
|
</computeroutput></screen>
|
|
<para>
|
|
Suspend the 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 suspend.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="heatclient_subcommand_build-info">
|
|
<title>heat build-info command</title>
|
|
<screen><computeroutput>usage: heat build-info
|
|
</computeroutput></screen>
|
|
<para>
|
|
Retrieve build information.
|
|
</para> </section>
|
|
<section xml:id="heatclient_subcommand_event-list">
|
|
<title>heat event-list command</title>
|
|
<screen><computeroutput>usage: heat event-list [-r <RESOURCE>] <NAME or ID>
|
|
</computeroutput></screen>
|
|
<para>
|
|
List events for 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 show the events for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-r <RESOURCE>, --resource <RESOURCE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the resource to filter events by
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="heatclient_subcommand_event-show">
|
|
<title>heat event-show command</title>
|
|
<screen><computeroutput>usage: heat event-show <NAME or ID> <RESOURCE> <EVENT>
|
|
</computeroutput></screen>
|
|
<para>
|
|
Describe the event.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAME or ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of stack to show the events for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><RESOURCE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the resource the event belongs to.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><EVENT></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of event to display details for
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="heatclient_subcommand_resource-list">
|
|
<title>heat resource-list command</title>
|
|
<screen><computeroutput>usage: heat resource-list <NAME or ID>
|
|
</computeroutput></screen>
|
|
<para>
|
|
Show list of resources belonging to 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 show the resources for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="heatclient_subcommand_resource-metadata">
|
|
<title>heat resource-metadata command</title>
|
|
<screen><computeroutput>usage: heat resource-metadata <NAME or ID> <RESOURCE>
|
|
</computeroutput></screen>
|
|
<para>
|
|
List resource metadata.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAME or ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of stack to show the resource metadata for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><RESOURCE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the resource to show the metadata for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="heatclient_subcommand_resource-show">
|
|
<title>heat resource-show command</title>
|
|
<screen><computeroutput>usage: heat resource-show <NAME or ID> <RESOURCE>
|
|
</computeroutput></screen>
|
|
<para>
|
|
Describe the resource.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAME or ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of stack to show the resource for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><RESOURCE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the resource to show the details for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="heatclient_subcommand_resource-template">
|
|
<title>heat resource-template command</title>
|
|
<screen><computeroutput>usage: heat resource-template [-F <FORMAT>] <RESOURCE>
|
|
</computeroutput></screen>
|
|
<para>
|
|
Generate a template based on a resource.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><RESOURCE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the resource to generate a template for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-F <FORMAT>, --format <FORMAT></command></term>
|
|
<listitem>
|
|
<para>
|
|
The template output format, one of: yaml, json
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="heatclient_subcommand_resource-type-list">
|
|
<title>heat resource-type-list command</title>
|
|
<screen><computeroutput>usage: heat resource-type-list
|
|
</computeroutput></screen>
|
|
<para>
|
|
List the available resource types.
|
|
</para> </section>
|
|
<section xml:id="heatclient_subcommand_resource-type-show">
|
|
<title>heat resource-type-show command</title>
|
|
<screen><computeroutput>usage: heat resource-type-show <RESOURCE_TYPE>
|
|
</computeroutput></screen>
|
|
<para>
|
|
Show the resource type.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><RESOURCE_TYPE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Resource Type to get the details for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="heatclient_subcommand_stack-abandon">
|
|
<title>heat stack-abandon command</title>
|
|
<screen><computeroutput>usage: heat stack-abandon <NAME or ID>
|
|
</computeroutput></screen>
|
|
<para>
|
|
Abandon the 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 abandon.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="heatclient_subcommand_stack-create">
|
|
<title>heat stack-create command</title>
|
|
<screen><computeroutput>usage: heat stack-create [-f <FILE>] [-e <FILE or URL>] [-u <URL>] [-o <URL>]
|
|
[-c <TIMEOUT>] [-r] [-P <KEY1=VALUE1;KEY2=VALUE2...>]
|
|
<STACK_NAME>
|
|
</computeroutput></screen>
|
|
<para>
|
|
Create the stack.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><STACK_NAME></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the stack to create.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-f <FILE>, --template-file <FILE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Path to the template.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-e <FILE or URL>, --environment-file <FILE or URL></command></term>
|
|
<listitem>
|
|
<para>
|
|
Path to the environment.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-u <URL>, --template-url <URL></command></term>
|
|
<listitem>
|
|
<para>
|
|
URL of template.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-o <URL>, --template-object <URL></command></term>
|
|
<listitem>
|
|
<para>
|
|
URL to retrieve template object (e.g from swift)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-c <TIMEOUT>, --create-timeout <TIMEOUT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Stack creation timeout in minutes. Default: 60
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-r, --enable-rollback</command></term>
|
|
<listitem>
|
|
<para>
|
|
Enable rollback on create/update failure
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P <KEY1=VALUE1;KEY2=VALUE2...>, --parameters <KEY1=VALUE1;KEY2=VALUE2...></command></term>
|
|
<listitem>
|
|
<para>
|
|
Parameter values used to create the stack. This can be
|
|
specified multiple times, or once with parameters
|
|
separated by semicolon.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="heatclient_subcommand_stack-delete">
|
|
<title>heat stack-delete command</title>
|
|
<screen><computeroutput>usage: heat stack-delete <NAME or ID> [<NAME or ID> ...]
|
|
</computeroutput></screen>
|
|
<para>
|
|
Delete the stack(s).
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAME or ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of stack(s) to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="heatclient_subcommand_stack-list">
|
|
<title>heat stack-list command</title>
|
|
<screen><computeroutput>usage: heat stack-list [-f <KEY1=VALUE1;KEY2=VALUE2...>] [-l <LIMIT>]
|
|
[-m <ID>]
|
|
</computeroutput></screen>
|
|
<para>
|
|
List the user's stacks.
|
|
</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 stacks. This
|
|
can be specified multiple times, or once with
|
|
parameters separated by semicolon.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-l <LIMIT>, --limit <LIMIT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Limit the number of stacks returned
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-m <ID>, --marker <ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
Only return stacks that appear after the given stack
|
|
ID
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="heatclient_subcommand_stack-show">
|
|
<title>heat stack-show command</title>
|
|
<screen><computeroutput>usage: heat stack-show <NAME or ID>
|
|
</computeroutput></screen>
|
|
<para>
|
|
Describe the 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 describe.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="heatclient_subcommand_stack-update">
|
|
<title>heat stack-update command</title>
|
|
<screen><computeroutput>usage: heat stack-update [-f <FILE>] [-e <FILE or URL>] [-u <URL>] [-o <URL>]
|
|
[-P <KEY1=VALUE1;KEY2=VALUE2...>]
|
|
<NAME or ID>
|
|
</computeroutput></screen>
|
|
<para>
|
|
Update the 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 update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-f <FILE>, --template-file <FILE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Path to the template.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-e <FILE or URL>, --environment-file <FILE or URL></command></term>
|
|
<listitem>
|
|
<para>
|
|
Path to the environment.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-u <URL>, --template-url <URL></command></term>
|
|
<listitem>
|
|
<para>
|
|
URL of template.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-o <URL>, --template-object <URL></command></term>
|
|
<listitem>
|
|
<para>
|
|
URL to retrieve template object (e.g from swift)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P <KEY1=VALUE1;KEY2=VALUE2...>, --parameters <KEY1=VALUE1;KEY2=VALUE2...></command></term>
|
|
<listitem>
|
|
<para>
|
|
Parameter values used to create the stack. This can be
|
|
specified multiple times, or once with parameters
|
|
separated by semicolon.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="heatclient_subcommand_template-show">
|
|
<title>heat template-show command</title>
|
|
<screen><computeroutput>usage: heat template-show <NAME or ID>
|
|
</computeroutput></screen>
|
|
<para>
|
|
Get the template for the specified 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 get the template for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="heatclient_subcommand_template-validate">
|
|
<title>heat template-validate command</title>
|
|
<screen><computeroutput>usage: heat template-validate [-u <URL>] [-f <FILE>] [-e <FILE or URL>]
|
|
[-o <URL>] [-P <KEY1=VALUE1;KEY2=VALUE2...>]
|
|
</computeroutput></screen>
|
|
<para>
|
|
Validate a template with parameters.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-u <URL>, --template-url <URL></command></term>
|
|
<listitem>
|
|
<para>
|
|
URL of template.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-f <FILE>, --template-file <FILE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Path to the template.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-e <FILE or URL>, --environment-file <FILE or URL></command></term>
|
|
<listitem>
|
|
<para>
|
|
Path to the environment.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-o <URL>, --template-object <URL></command></term>
|
|
<listitem>
|
|
<para>
|
|
URL to retrieve template object (e.g from swift)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-P <KEY1=VALUE1;KEY2=VALUE2...>, --parameters <KEY1=VALUE1;KEY2=VALUE2...></command></term>
|
|
<listitem>
|
|
<para>
|
|
Parameter values to validate. This can be specified
|
|
multiple times, or once with parameters separated by
|
|
semicolon.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
</chapter>
|