ccb80d725d
Updated a typo (keystone-mange -> keystone-manage) Updated a few capitalization errors in titles Change-Id: I38ec2a6c53b9e3a1e1bf330b54c26f293a764d94 author: diane fleming
100 lines
4.9 KiB
XML
100 lines
4.9 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<section 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="heat_client_commands">
|
|
<title>heat commands</title>
|
|
<para>The heat client is the command-line interface for the
|
|
OpenStack Orchestration API.</para>
|
|
<para>For help on a specific heat command, enter:</para>
|
|
<screen><prompt>$</prompt> <userinput><command>heat</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
|
|
<example>
|
|
<title>Usage</title>
|
|
<screen><computeroutput>heat [-d] [-v] [-k] [--cert-file CERT_FILE] [--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] [-t]
|
|
<subcommand> ...</computeroutput></screen>
|
|
</example>
|
|
<example>
|
|
<title>Positional arguments</title>
|
|
<screen><computeroutput><subcommand>
|
|
action-resume Resume the stack.
|
|
action-suspend Suspend the stack.
|
|
create DEPRECATED! Use stack-create instead
|
|
delete DEPRECATED! Use stack-delete instead
|
|
describe DEPRECATED! Use stack-show instead
|
|
event DEPRECATED! Use event-show instead
|
|
event-list List events for a stack
|
|
event-show Describe the event
|
|
gettemplate DEPRECATED! Use template-show instead
|
|
list DEPRECATED! Use stack-list instead
|
|
resource DEPRECATED! Use resource-show instead
|
|
resource-list Show list of resources belonging to a stack
|
|
resource-metadata List resource metadata
|
|
resource-show Describe the resource
|
|
stack-create Create the stack
|
|
stack-delete Delete the stack
|
|
stack-list List the user's stacks
|
|
stack-show Describe the stack
|
|
stack-update Update the stack
|
|
template-show Get the template for the specified stack
|
|
template-validate Validate a template with parameters
|
|
update DEPRECATED! Use stack-update instead
|
|
validate DEPRECATED! Use template-validate instead
|
|
help Display help about this program or one of its
|
|
subcommands.</computeroutput></screen>
|
|
</example>
|
|
|
|
<example>
|
|
<title>Optional arguments</title>
|
|
<screen><computeroutput> -d, --debug Defaults to env[HEATCLIENT_DEBUG]
|
|
-v, --verbose Print more verbose output
|
|
-k, --insecure 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.
|
|
--cert-file CERT_FILE
|
|
Path of certificate file to use in SSL connection.
|
|
This file can optionally be prepended with the private
|
|
key.
|
|
--key-file KEY_FILE Path of client key to use in SSL connection. This
|
|
option is not necessary if your key is prepended to
|
|
your cert file.
|
|
--ca-file CA_FILE 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.
|
|
--timeout TIMEOUT Number of seconds to wait for a response
|
|
--os-username OS_USERNAME
|
|
Defaults to env[OS_USERNAME]
|
|
--os-password OS_PASSWORD
|
|
Defaults to env[OS_PASSWORD]
|
|
--os-tenant-id OS_TENANT_ID
|
|
Defaults to env[OS_TENANT_ID]
|
|
--os-tenant-name OS_TENANT_NAME
|
|
Defaults to env[OS_TENANT_NAME]
|
|
--os-auth-url OS_AUTH_URL
|
|
Defaults to env[OS_AUTH_URL]
|
|
--os-region-name OS_REGION_NAME
|
|
Defaults to env[OS_REGION_NAME]
|
|
--os-auth-token OS_AUTH_TOKEN
|
|
Defaults to env[OS_AUTH_TOKEN]
|
|
--os-no-client-auth Do not contact heat for a token. Defaults to
|
|
env[OS_NO_CLIENT_AUTH]
|
|
--heat-url HEAT_URL Defaults to env[HEAT_URL]
|
|
--heat-api-version HEAT_API_VERSION
|
|
Defaults to env[HEAT_API_VERSION] or 1
|
|
--os-service-type OS_SERVICE_TYPE
|
|
Defaults to env[OS_SERVICE_TYPE]
|
|
--os-endpoint-type OS_ENDPOINT_TYPE
|
|
Defaults to env[OS_ENDPOINT_TYPE]
|
|
-t, --token-only Only send a token for auth, do not send username and
|
|
password as well.</computeroutput></screen>
|
|
</example>
|
|
</section>
|