Merge "Update cli commands to latest *released* version"

This commit is contained in:
Jenkins 2014-03-06 07:35:54 +00:00 committed by Gerrit Code Review
commit a3e1eaab79
9 changed files with 420 additions and 194 deletions

View File

@ -10,7 +10,8 @@
<title>Telemetry command-line client</title> <title>Telemetry command-line client</title>
<para>The <command>ceilometer</command> client is the command-line interface <para>The <command>ceilometer</command> client is the command-line interface
(CLI) for the Telemetry API and its extensions. (CLI) for the Telemetry API and its extensions. This chapter documents
<command>ceilometer</command> version 1.0.9.
</para> </para>
<para>For help on a specific <command>ceilometer</command> <para>For help on a specific <command>ceilometer</command>
command, enter: command, enter:

View File

@ -10,7 +10,8 @@
<title>Block Storage command-line client</title> <title>Block Storage command-line client</title>
<para>The <command>cinder</command> client is the command-line interface <para>The <command>cinder</command> client is the command-line interface
(CLI) for the OpenStack Block Storage API and its extensions. (CLI) for the OpenStack Block Storage API and its extensions. This chapter documents
<command>cinder</command> version 1.0.8.
</para> </para>
<para>For help on a specific <command>cinder</command> <para>For help on a specific <command>cinder</command>
command, enter: command, enter:
@ -1019,8 +1020,8 @@ Create a new encryption type for a volume type (Admin Only).
<listitem> <listitem>
<para> <para>
Notional service where encryption is performed (e.g., Notional service where encryption is performed (e.g.,
front-end=Nova) Values: 'front-end', 'back-end' front-end=Nova). Values: 'front-end', 'back-end'
(Default='front-end') (Optional, Default=None)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>

View File

@ -10,7 +10,8 @@
<title>Image Service command-line client</title> <title>Image Service command-line client</title>
<para>The <command>glance</command> client is the command-line interface <para>The <command>glance</command> client is the command-line interface
(CLI) for the OpenStack Image Service API and its extensions. (CLI) for the OpenStack Image Service API and its extensions. This chapter documents
<command>glance</command> version 0.12.0.
</para> </para>
<para>For help on a specific <command>glance</command> <para>For help on a specific <command>glance</command>
command, enter: command, enter:
@ -846,8 +847,7 @@ List images you can access.
</section> </section>
<section xml:id="glanceclient_subcommand_image-show"> <section xml:id="glanceclient_subcommand_image-show">
<title>glance image-show command</title> <title>glance image-show command</title>
<screen><computeroutput>usage: glance image-show [--human-readable] [--max-column-width &lt;integer&gt;] <screen><computeroutput>usage: glance image-show [--human-readable] &lt;IMAGE&gt;
&lt;IMAGE&gt;
</computeroutput></screen> </computeroutput></screen>
<para> <para>
Describe a specific image. Describe a specific image.
@ -872,14 +872,6 @@ Describe a specific image.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><command>--max-column-width &lt;integer&gt;</command></term>
<listitem>
<para>
The max column width of the printed table.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</section> </section>
<section xml:id="glanceclient_subcommand_image-update"> <section xml:id="glanceclient_subcommand_image-update">

View File

@ -10,7 +10,8 @@
<title>Orchestration command-line client</title> <title>Orchestration command-line client</title>
<para>The <command>heat</command> client is the command-line interface <para>The <command>heat</command> client is the command-line interface
(CLI) for the Orchestration API and its extensions. (CLI) for the Orchestration API and its extensions. This chapter documents
<command>heat</command> version 0.2.8.
</para> </para>
<para>For help on a specific <command>heat</command> <para>For help on a specific <command>heat</command>
command, enter: command, enter:
@ -119,6 +120,22 @@
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><command>output-list</command></term>
<listitem>
<para>
Show available outputs.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>output-show</command></term>
<listitem>
<para>
Show a specific stack output.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><command>resource</command></term> <term><command>resource</command></term>
<listitem> <listitem>
@ -151,6 +168,14 @@
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><command>resource-signal</command></term>
<listitem>
<para>
Send a signal to a resource.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><command>resource-template</command></term> <term><command>resource-template</command></term>
<listitem> <listitem>
@ -183,6 +208,14 @@
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><command>stack-adopt</command></term>
<listitem>
<para>
Adopt a stack.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><command>stack-create</command></term> <term><command>stack-create</command></term>
<listitem> <listitem>
@ -281,7 +314,7 @@
<term><command>--version</command></term> <term><command>--version</command></term>
<listitem> <listitem>
<para> <para>
Shows the client version and exits Shows the client version and exits.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -289,7 +322,7 @@
<term><command>-d, --debug</command></term> <term><command>-d, --debug</command></term>
<listitem> <listitem>
<para> <para>
Defaults to <code>env[HEATCLIENT_DEBUG]</code> Defaults to <code>env[HEATCLIENT_DEBUG]</code>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -297,7 +330,7 @@
<term><command>-v, --verbose</command></term> <term><command>-v, --verbose</command></term>
<listitem> <listitem>
<para> <para>
Print more verbose output Print more verbose output.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -305,7 +338,7 @@
<term><command>-k, --insecure</command></term> <term><command>-k, --insecure</command></term>
<listitem> <listitem>
<para> <para>
Explicitly allow the client to perform"insecure" SSL Explicitly allow the client to perform "insecure" SSL
(https) requests. The server's certificate will not be (https) requests. The server's certificate will not be
verified against any certificate authorities. This verified against any certificate authorities. This
option should be used with caution. option should be used with caution.
@ -317,7 +350,7 @@
<listitem> <listitem>
<para> <para>
Path of certificate file to use in SSL connection. Path of certificate file to use in SSL connection.
This file can optionally be prependedwith the private This file can optionally be prepended with the private
key. key.
</para> </para>
</listitem> </listitem>
@ -346,7 +379,7 @@
<term><command>--timeout TIMEOUT</command></term> <term><command>--timeout TIMEOUT</command></term>
<listitem> <listitem>
<para> <para>
Number of seconds to wait for a response Number of seconds to wait for a response.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -354,7 +387,7 @@
<term><command>--os-username OS_USERNAME</command></term> <term><command>--os-username OS_USERNAME</command></term>
<listitem> <listitem>
<para> <para>
Defaults to <code>env[OS_USERNAME]</code> Defaults to <code>env[OS_USERNAME]</code>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -362,7 +395,7 @@
<term><command>--os-password OS_PASSWORD</command></term> <term><command>--os-password OS_PASSWORD</command></term>
<listitem> <listitem>
<para> <para>
Defaults to <code>env[OS_PASSWORD]</code> Defaults to <code>env[OS_PASSWORD]</code>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -370,7 +403,7 @@
<term><command>--os-tenant-id OS_TENANT_ID</command></term> <term><command>--os-tenant-id OS_TENANT_ID</command></term>
<listitem> <listitem>
<para> <para>
Defaults to <code>env[OS_TENANT_ID]</code> Defaults to <code>env[OS_TENANT_ID]</code>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -378,7 +411,7 @@
<term><command>--os-tenant-name OS_TENANT_NAME</command></term> <term><command>--os-tenant-name OS_TENANT_NAME</command></term>
<listitem> <listitem>
<para> <para>
Defaults to <code>env[OS_TENANT_NAME]</code> Defaults to <code>env[OS_TENANT_NAME]</code>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -386,7 +419,7 @@
<term><command>--os-auth-url OS_AUTH_URL</command></term> <term><command>--os-auth-url OS_AUTH_URL</command></term>
<listitem> <listitem>
<para> <para>
Defaults to <code>env[OS_AUTH_URL]</code> Defaults to <code>env[OS_AUTH_URL]</code>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -394,7 +427,7 @@
<term><command>--os-region-name OS_REGION_NAME</command></term> <term><command>--os-region-name OS_REGION_NAME</command></term>
<listitem> <listitem>
<para> <para>
Defaults to <code>env[OS_REGION_NAME]</code> Defaults to <code>env[OS_REGION_NAME]</code>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -402,7 +435,7 @@
<term><command>--os-auth-token OS_AUTH_TOKEN</command></term> <term><command>--os-auth-token OS_AUTH_TOKEN</command></term>
<listitem> <listitem>
<para> <para>
Defaults to <code>env[OS_AUTH_TOKEN]</code> Defaults to <code>env[OS_AUTH_TOKEN]</code>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -411,7 +444,7 @@
<listitem> <listitem>
<para> <para>
Do not contact keystone for a token. Defaults to Do not contact keystone for a token. Defaults to
<code>env[OS_NO_CLIENT_AUTH]</code> <code>env[OS_NO_CLIENT_AUTH]</code>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -419,7 +452,7 @@
<term><command>--heat-url HEAT_URL</command></term> <term><command>--heat-url HEAT_URL</command></term>
<listitem> <listitem>
<para> <para>
Defaults to <code>env[HEAT_URL]</code> Defaults to <code>env[HEAT_URL]</code>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -427,7 +460,7 @@
<term><command>--heat-api-version HEAT_API_VERSION</command></term> <term><command>--heat-api-version HEAT_API_VERSION</command></term>
<listitem> <listitem>
<para> <para>
Defaults to <code>env[HEAT_API_VERSION]</code> or 1 Defaults to <code>env[HEAT_API_VERSION]</code> or 1.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -435,7 +468,7 @@
<term><command>--os-service-type OS_SERVICE_TYPE</command></term> <term><command>--os-service-type OS_SERVICE_TYPE</command></term>
<listitem> <listitem>
<para> <para>
Defaults to <code>env[OS_SERVICE_TYPE]</code> Defaults to <code>env[OS_SERVICE_TYPE]</code>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -443,7 +476,7 @@
<term><command>--os-endpoint-type OS_ENDPOINT_TYPE</command></term> <term><command>--os-endpoint-type OS_ENDPOINT_TYPE</command></term>
<listitem> <listitem>
<para> <para>
Defaults to <code>env[OS_ENDPOINT_TYPE]</code> Defaults to <code>env[OS_ENDPOINT_TYPE]</code>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -451,7 +484,7 @@
<term><command>--include-password</command></term> <term><command>--include-password</command></term>
<listitem> <listitem>
<para> <para>
Send os-username and os-password to heat Send os-username and os-password to heat.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -523,7 +556,7 @@ List events for a stack.
<term><command>-r &lt;RESOURCE&gt;, --resource &lt;RESOURCE&gt;</command></term> <term><command>-r &lt;RESOURCE&gt;, --resource &lt;RESOURCE&gt;</command></term>
<listitem> <listitem>
<para> <para>
Name of the resource to filter events by Name of the resource to filter events by.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -557,7 +590,51 @@ Describe the event.
<term><command>&lt;EVENT&gt;</command></term> <term><command>&lt;EVENT&gt;</command></term>
<listitem> <listitem>
<para> <para>
ID of event to display details for ID of event to display details for.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="heatclient_subcommand_output-list">
<title>heat output-list command</title>
<screen><computeroutput>usage: heat output-list &lt;NAME or ID&gt;
</computeroutput></screen>
<para>
Show available outputs.
</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 query.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="heatclient_subcommand_output-show">
<title>heat output-show command</title>
<screen><computeroutput>usage: heat output-show &lt;NAME or ID&gt; &lt;OUTPUT NAME&gt;
</computeroutput></screen>
<para>
Show a specific stack output.
</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 query.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;OUTPUT NAME&gt;</command></term>
<listitem>
<para>
Name of an output to display.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -631,6 +708,52 @@ Describe the resource.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist>
</section>
<section xml:id="heatclient_subcommand_resource-signal">
<title>heat resource-signal command</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>
<para>
Send a signal to a resource.
</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 the resource belongs to.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;RESOURCE&gt;</command></term>
<listitem>
<para>
Name of the resource to signal.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-D &lt;DATA&gt;, --data &lt;DATA&gt;</command></term>
<listitem>
<para>
JSON Data to send to the signal handler.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-f &lt;FILE&gt;, --data-file &lt;FILE&gt;</command></term>
<listitem>
<para>
File containing JSON data to send to the signal
handler.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</section> </section>
<section xml:id="heatclient_subcommand_resource-template"> <section xml:id="heatclient_subcommand_resource-template">
@ -656,7 +779,7 @@ Generate a template based on a resource.
<term><command>-F &lt;FORMAT&gt;, --format &lt;FORMAT&gt;</command></term> <term><command>-F &lt;FORMAT&gt;, --format &lt;FORMAT&gt;</command></term>
<listitem> <listitem>
<para> <para>
The template output format, one of: yaml, json The template output format, one of: yaml, json.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -681,7 +804,7 @@ Show the resource type.
<term><command>&lt;RESOURCE_TYPE&gt;</command></term> <term><command>&lt;RESOURCE_TYPE&gt;</command></term>
<listitem> <listitem>
<para> <para>
Resource Type to get the details for. Resource type to get the details for.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -703,6 +826,96 @@ Abandon the stack.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist>
</section>
<section xml:id="heatclient_subcommand_stack-adopt">
<title>heat stack-adopt command</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;]
[-c &lt;TIMEOUT&gt;] [-a &lt;FILE or URL&gt;] [-r]
[-P &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;]
&lt;STACK_NAME&gt;
</computeroutput></screen>
<para>
Adopt a stack.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;STACK_NAME&gt;</command></term>
<listitem>
<para>
Name of the stack to adopt.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<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>
<term><command>-e &lt;FILE or URL&gt;, --environment-file &lt;FILE or URL&gt;</command></term>
<listitem>
<para>
Path to the environment.
</para>
</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>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-c &lt;TIMEOUT&gt;, --create-timeout &lt;TIMEOUT&gt;</command></term>
<listitem>
<para>
Stack creation timeout in minutes. Default: 60.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-a &lt;FILE or URL&gt;, --adopt-file &lt;FILE or URL&gt;</command></term>
<listitem>
<para>
Path to adopt stack data file.
</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 &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;, --parameters &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;</command></term>
<listitem>
<para>
Parameter values used to create the stack. This can be
specified multiple times, or once with parameters
separated by a semicolon.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</section> </section>
<section xml:id="heatclient_subcommand_stack-create"> <section xml:id="heatclient_subcommand_stack-create">
@ -754,7 +967,7 @@ Create the stack.
<term><command>-o &lt;URL&gt;, --template-object &lt;URL&gt;</command></term> <term><command>-o &lt;URL&gt;, --template-object &lt;URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
URL to retrieve template object (e.g from swift) URL to retrieve template object (e.g. from swift).
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -762,7 +975,7 @@ Create the stack.
<term><command>-c &lt;TIMEOUT&gt;, --create-timeout &lt;TIMEOUT&gt;</command></term> <term><command>-c &lt;TIMEOUT&gt;, --create-timeout &lt;TIMEOUT&gt;</command></term>
<listitem> <listitem>
<para> <para>
Stack creation timeout in minutes. Default: 60 Stack creation timeout in minutes. Default: 60.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -770,7 +983,7 @@ Create 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 Enable rollback on create/update failure.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -780,7 +993,7 @@ Create the stack.
<para> <para>
Parameter values used to create the stack. This can be Parameter values used to create the stack. This can be
specified multiple times, or once with parameters specified multiple times, or once with parameters
separated by semicolon. separated by a semicolon.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -819,7 +1032,7 @@ List the user's stacks.
<para> <para>
Filter parameters to apply on returned stacks. This Filter parameters to apply on returned stacks. This
can be specified multiple times, or once with can be specified multiple times, or once with
parameters separated by semicolon. parameters separated by a semicolon.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -827,7 +1040,7 @@ List the user's stacks.
<term><command>-l &lt;LIMIT&gt;, --limit &lt;LIMIT&gt;</command></term> <term><command>-l &lt;LIMIT&gt;, --limit &lt;LIMIT&gt;</command></term>
<listitem> <listitem>
<para> <para>
Limit the number of stacks returned Limit the number of stacks returned.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -836,7 +1049,7 @@ List the user's stacks.
<listitem> <listitem>
<para> <para>
Only return stacks that appear after the given stack Only return stacks that appear after the given stack
ID ID.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -909,7 +1122,7 @@ Update the stack.
<term><command>-o &lt;URL&gt;, --template-object &lt;URL&gt;</command></term> <term><command>-o &lt;URL&gt;, --template-object &lt;URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
URL to retrieve template object (e.g from swift) URL to retrieve template object (e.g. from swift).
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -919,7 +1132,7 @@ Update the stack.
<para> <para>
Parameter values used to create the stack. This can be Parameter values used to create the stack. This can be
specified multiple times, or once with parameters specified multiple times, or once with parameters
separated by semicolon. separated by a semicolon.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -980,7 +1193,7 @@ Validate a template with parameters.
<term><command>-o &lt;URL&gt;, --template-object &lt;URL&gt;</command></term> <term><command>-o &lt;URL&gt;, --template-object &lt;URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
URL to retrieve template object (e.g from swift) URL to retrieve template object (e.g. from swift).
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -989,7 +1202,7 @@ Validate a template with parameters.
<listitem> <listitem>
<para> <para>
Parameter values to validate. This can be specified Parameter values to validate. This can be specified
multiple times, or once with parameters separated by multiple times, or once with parameters separated by a
semicolon. semicolon.
</para> </para>
</listitem> </listitem>

View File

@ -10,7 +10,8 @@
<title>Identity Service command-line client</title> <title>Identity Service command-line client</title>
<para>The <command>keystone</command> client is the command-line interface <para>The <command>keystone</command> client is the command-line interface
(CLI) for the OpenStack Identity API and its extensions. (CLI) for the OpenStack Identity API and its extensions. This chapter documents
<command>keystone</command> version 0.6.0.
</para> </para>
<para>For help on a specific <command>keystone</command> <para>For help on a specific <command>keystone</command>
command, enter: command, enter:

View File

@ -10,7 +10,8 @@
<title>Networking command-line client</title> <title>Networking command-line client</title>
<para>The <command>neutron</command> client is the command-line interface <para>The <command>neutron</command> client is the command-line interface
(CLI) for the OpenStack Networking API and its extensions. (CLI) for the OpenStack Networking API and its extensions. This chapter documents
<command>neutron</command> version 2.3.4.
</para> </para>
<para>For help on a specific <command>neutron</command> <para>For help on a specific <command>neutron</command>
command, enter: command, enter:
@ -1063,7 +1064,7 @@
<term><command>quota-list</command></term> <term><command>quota-list</command></term>
<listitem> <listitem>
<para> <para>
List defined quotas of all tenants. List quotas of all tenants who have non-default quota values.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -7222,7 +7223,7 @@ Update network's information.
[--tenant-id TENANT_ID] [--name NAME] [--tenant-id TENANT_ID] [--name NAME]
[--admin-state-down] [--mac-address MAC_ADDRESS] [--admin-state-down] [--mac-address MAC_ADDRESS]
[--device-id DEVICE_ID] [--device-id DEVICE_ID]
[--fixed-ip ip_address=IP_ADDR] [--fixed-ip subnet_id=SUBNET,ip_address=IP_ADDR]
[--security-group SECURITY_GROUP | --no-security-groups] [--security-group SECURITY_GROUP | --no-security-groups]
[--extra-dhcp-opt EXTRA_DHCP_OPTS] [--extra-dhcp-opt EXTRA_DHCP_OPTS]
NETWORK NETWORK
@ -7302,8 +7303,8 @@ Create a port for a given tenant.
<term><command>--fixed-ip</command></term> <term><command>--fixed-ip</command></term>
<listitem> <listitem>
<para> <para>
ip_address=IP_ADDR subnet_id=SUBNET,ip_address=IP_ADDR
Desired IP for this port: Desired IP and/or subnet for this port:
subnet_id=&lt;name_or_id&gt;,ip_address=&lt;ip&gt;, (This option subnet_id=&lt;name_or_id&gt;,ip_address=&lt;ip&gt;, (This option
can be repeated.) can be repeated.)
</para> </para>
@ -7849,7 +7850,7 @@ Delete defined quotas of a given tenant.
[--request-format {json,xml}] [--request-format {json,xml}]
</computeroutput></screen> </computeroutput></screen>
<para> <para>
List defined quotas of all tenants. List quotas of all tenants who have non-default quota values.
</para> <variablelist wordsize="10"> </para> <variablelist wordsize="10">
<title>Optional arguments</title> <title>Optional arguments</title>
<varlistentry> <varlistentry>

View File

@ -10,7 +10,8 @@
<title>Compute command-line client</title> <title>Compute command-line client</title>
<para>The <command>nova</command> client is the command-line interface <para>The <command>nova</command> client is the command-line interface
(CLI) for the OpenStack Compute API and its extensions. (CLI) for the OpenStack Compute API and its extensions. This chapter documents
<command>nova</command> version 2.16.0.
</para> </para>
<para>For help on a specific <command>nova</command> <para>For help on a specific <command>nova</command>
command, enter: command, enter:
@ -495,6 +496,14 @@
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><command>get-rdp-console</command></term>
<listitem>
<para>
Get a rdp console to a server.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><command>get-spice-console</command></term> <term><command>get-spice-console</command></term>
<listitem> <listitem>
@ -1312,6 +1321,54 @@
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><command>force-delete</command></term>
<listitem>
<para>
Force delete a server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>restore</command></term>
<listitem>
<para>
Restore a soft-deleted server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>net</command></term>
<listitem>
<para>
Show a network
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>net-create</command></term>
<listitem>
<para>
Create a network
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>net-delete</command></term>
<listitem>
<para>
Delete a network
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>net-list</command></term>
<listitem>
<para>
List networks
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><command>baremetal-interface-add</command></term> <term><command>baremetal-interface-add</command></term>
<listitem> <listitem>
@ -1369,103 +1426,6 @@
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><command>cell-capacities</command></term>
<listitem>
<para>
Get cell capacities for all cells or a given cell.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cell-show</command></term>
<listitem>
<para>
Show details of a given cell.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>force-delete</command></term>
<listitem>
<para>
Force delete a server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>restore</command></term>
<listitem>
<para>
Restore a soft-deleted server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>host-servers-migrate</command></term>
<listitem>
<para>
Migrate all instances of the specified host to other
available hosts.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>list-extensions</command></term>
<listitem>
<para>
List all the os-api extensions that are available.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>host-meta</command></term>
<listitem>
<para>
Set or Delete metadata on all instances of a host.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>net</command></term>
<listitem>
<para>
Show a network
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>net-create</command></term>
<listitem>
<para>
Create a network
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>net-delete</command></term>
<listitem>
<para>
Delete a network
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>net-list</command></term>
<listitem>
<para>
List networks
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>migration-list</command></term>
<listitem>
<para>
Print a list of migrations.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><command>host-evacuate</command></term> <term><command>host-evacuate</command></term>
<listitem> <listitem>
@ -1491,6 +1451,55 @@
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><command>migration-list</command></term>
<listitem>
<para>
Print a list of migrations.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>host-servers-migrate</command></term>
<listitem>
<para>
Migrate all instances of the specified host to other
available hosts.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cell-capacities</command></term>
<listitem>
<para>
Get cell capacities for all cells or a given cell.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cell-show</command></term>
<listitem>
<para>
Show details of a given cell.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>host-meta</command></term>
<listitem>
<para>
Set or Delete metadata on all instances of a host.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>list-extensions</command></term>
<listitem>
<para>
List all the os-api extensions that are available.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</section> </section>
<section xml:id="novaclient_command_optional"> <section xml:id="novaclient_command_optional">
@ -2411,7 +2420,7 @@ Boot a new server.
<term><command>--snapshot &lt;snapshot_id&gt;</command></term> <term><command>--snapshot &lt;snapshot_id&gt;</command></term>
<listitem> <listitem>
<para> <para>
Sapshot ID to boot from (will create a volume). Snapshot ID to boot from (will create a volume).
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -3550,6 +3559,32 @@ Get password for a server.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist>
</section>
<section xml:id="novaclient_subcommand_get-rdp-console">
<title>nova get-rdp-console command</title>
<screen><computeroutput>usage: nova get-rdp-console &lt;server&gt; &lt;console-type&gt;
</computeroutput></screen>
<para>
Get a rdp console to a server.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;server&gt;</command></term>
<listitem>
<para>
Name or ID of server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;console-type&gt;</command></term>
<listitem>
<para>
Type of rdp console ("rdp-html5").
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</section> </section>
<section xml:id="novaclient_subcommand_get-spice-console"> <section xml:id="novaclient_subcommand_get-spice-console">
@ -4907,9 +4942,7 @@ List the quotas for a quota class.
<section xml:id="novaclient_subcommand_quota-class-update"> <section xml:id="novaclient_subcommand_quota-class-update">
<title>nova quota-class-update command</title> <title>nova quota-class-update command</title>
<screen><computeroutput>usage: nova quota-class-update [--instances &lt;instances&gt;] [--cores &lt;cores&gt;] <screen><computeroutput>usage: nova quota-class-update [--instances &lt;instances&gt;] [--cores &lt;cores&gt;]
[--ram &lt;ram&gt;] [--volumes &lt;volumes&gt;] [--ram &lt;ram&gt;] [--floating-ips &lt;floating-ips&gt;]
[--gigabytes &lt;gigabytes&gt;]
[--floating-ips &lt;floating-ips&gt;]
[--metadata-items &lt;metadata-items&gt;] [--metadata-items &lt;metadata-items&gt;]
[--injected-files &lt;injected-files&gt;] [--injected-files &lt;injected-files&gt;]
[--injected-file-content-bytes &lt;injected-file-content-bytes&gt;] [--injected-file-content-bytes &lt;injected-file-content-bytes&gt;]
@ -4958,22 +4991,6 @@ Update the quotas for a quota class.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><command>--volumes &lt;volumes&gt;</command></term>
<listitem>
<para>
New value for the "volumes" quota.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--gigabytes &lt;gigabytes&gt;</command></term>
<listitem>
<para>
New value for the "gigabytes" quota.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><command>--floating-ips &lt;floating-ips&gt;</command></term> <term><command>--floating-ips &lt;floating-ips&gt;</command></term>
<listitem> <listitem>
@ -5113,8 +5130,7 @@ List the quotas for a tenant/user.
<section xml:id="novaclient_subcommand_quota-update"> <section xml:id="novaclient_subcommand_quota-update">
<title>nova quota-update command</title> <title>nova quota-update command</title>
<screen><computeroutput>usage: nova quota-update [--user &lt;user-id&gt;] [--instances &lt;instances&gt;] <screen><computeroutput>usage: nova quota-update [--user &lt;user-id&gt;] [--instances &lt;instances&gt;]
[--cores &lt;cores&gt;] [--ram &lt;ram&gt;] [--volumes &lt;volumes&gt;] [--cores &lt;cores&gt;] [--ram &lt;ram&gt;]
[--gigabytes &lt;gigabytes&gt;]
[--floating-ips &lt;floating-ips&gt;] [--floating-ips &lt;floating-ips&gt;]
[--fixed-ips &lt;fixed-ips&gt;] [--fixed-ips &lt;fixed-ips&gt;]
[--metadata-items &lt;metadata-items&gt;] [--metadata-items &lt;metadata-items&gt;]
@ -5174,22 +5190,6 @@ Update the quotas for a tenant/user.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><command>--volumes &lt;volumes&gt;</command></term>
<listitem>
<para>
New value for the "volumes" quota.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--gigabytes &lt;gigabytes&gt;</command></term>
<listitem>
<para>
New value for the "gigabytes" quota.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><command>--floating-ips &lt;floating-ips&gt;</command></term> <term><command>--floating-ips &lt;floating-ips&gt;</command></term>
<listitem> <listitem>

View File

@ -10,7 +10,8 @@
<title>Object Storage command-line client</title> <title>Object Storage command-line client</title>
<para>The <command>swift</command> client is the command-line interface <para>The <command>swift</command> client is the command-line interface
(CLI) for the OpenStack Object Storage API and its extensions. (CLI) for the OpenStack Object Storage API and its extensions. This chapter documents
<command>swift</command> version 2.0.3.
</para> </para>
<para>For help on a specific <command>swift</command> <para>For help on a specific <command>swift</command>
command, enter: command, enter:
@ -492,6 +493,14 @@
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><command>--skip-identical</command></term>
<listitem>
<para>
Skip downloading files that are identical on both sides
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</section> </section>
<section xml:id="swiftclient_subcommand_list"> <section xml:id="swiftclient_subcommand_list">
@ -712,6 +721,14 @@ If the container is not found, it will be created automatically.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><command>--skip-identical</command></term>
<listitem>
<para>
Skip uploading files that are identical on both sides
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><command>--segment-size &lt;size&gt;</command></term> <term><command>--segment-size &lt;size&gt;</command></term>
<listitem> <listitem>

0
doc/common/section_cli_cinder_manage_volumes.xml Executable file → Normal file
View File