Regenerate cli commands with new auto-commands
Change-Id: I410067be5b489f5547f9fced3f7db841088fb8eb
This commit is contained in:
Andreas Jaeger
parent
5ba82d1e45
commit
4113bb218e
@ -8,9 +8,10 @@
|
||||
|
||||
<?dbhtml stop-chunking?>
|
||||
|
||||
<title>ceilometer commands</title>
|
||||
<para>The ceilometer client is the command-line interface (CLI) for the
|
||||
Telemetry API and its extensions.</para>
|
||||
<title>Telemetry command-line client</title>
|
||||
<para>The <command>ceilometer</command> client is the command-line interface
|
||||
(CLI) for the Telemetry API and its extensions.
|
||||
</para>
|
||||
<para>For help on a specific <command>ceilometer</command>
|
||||
command, enter:
|
||||
</para>
|
||||
@ -507,8 +508,9 @@ Create a new alarm based on state of other alarms.
|
||||
<term><command>--insufficient-data-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
URL to invoke when state transitions to unkown. May be
|
||||
used multiple times. Defaults to None.
|
||||
URL to invoke when state transitions to
|
||||
insufficient_data. May be used multiple times.
|
||||
Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -639,8 +641,9 @@ Update an existing alarm based on state of other alarms.
|
||||
<term><command>--insufficient-data-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
URL to invoke when state transitions to unkown. May be
|
||||
used multiple times. Defaults to None.
|
||||
URL to invoke when state transitions to
|
||||
insufficient_data. May be used multiple times.
|
||||
Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -811,8 +814,7 @@ Set the state of an alarm.
|
||||
[--alarm-action <Webhook URL>]
|
||||
[--ok-action <Webhook URL>]
|
||||
[--insufficient-data-action <Webhook URL>]
|
||||
--meter-name <METRIC>
|
||||
[--period <PERIOD>]
|
||||
-m <METRIC> [--period <PERIOD>]
|
||||
[--evaluation-periods <COUNT>]
|
||||
[--statistic <STATISTIC>]
|
||||
[--comparison-operator <OPERATOR>]
|
||||
@ -897,13 +899,14 @@ Create a new alarm based on computed statistics.
|
||||
<term><command>--insufficient-data-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
URL to invoke when state transitions to unkown. May be
|
||||
used multiple times. Defaults to None.
|
||||
URL to invoke when state transitions to
|
||||
insufficient_data. May be used multiple times.
|
||||
Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--meter-name <METRIC></command></term>
|
||||
<term><command>-m <METRIC>, --meter-name <METRIC></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Metric to evaluate against Required.
|
||||
@ -984,8 +987,7 @@ Create a new alarm based on computed statistics.
|
||||
[--alarm-action <Webhook URL>]
|
||||
[--ok-action <Webhook URL>]
|
||||
[--insufficient-data-action <Webhook URL>]
|
||||
[--meter-name <METRIC>]
|
||||
[--period <PERIOD>]
|
||||
[-m <METRIC>] [--period <PERIOD>]
|
||||
[--evaluation-periods <COUNT>]
|
||||
[--statistic <STATISTIC>]
|
||||
[--comparison-operator <OPERATOR>]
|
||||
@ -1078,13 +1080,14 @@ Update an existing alarm based on computed statistics.
|
||||
<term><command>--insufficient-data-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
URL to invoke when state transitions to unkown. May be
|
||||
used multiple times. Defaults to None.
|
||||
URL to invoke when state transitions to
|
||||
insufficient_data. May be used multiple times.
|
||||
Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--meter-name <METRIC></command></term>
|
||||
<term><command>-m <METRIC>, --meter-name <METRIC></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Metric to evaluate against
|
||||
@ -1165,8 +1168,7 @@ Update an existing alarm based on computed statistics.
|
||||
[--ok-action <Webhook URL>]
|
||||
[--insufficient-data-action <Webhook URL>]
|
||||
[--period <PERIOD>]
|
||||
[--evaluation-periods <COUNT>]
|
||||
[--meter-name <METRIC>]
|
||||
[--evaluation-periods <COUNT>] [-m <METRIC>]
|
||||
[--statistic <STATISTIC>]
|
||||
[--comparison-operator <OPERATOR>]
|
||||
[--threshold <THRESHOLD>]
|
||||
@ -1258,8 +1260,9 @@ Update an existing alarm.
|
||||
<term><command>--insufficient-data-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
URL to invoke when state transitions to unkown. May be
|
||||
used multiple times. Defaults to None.
|
||||
URL to invoke when state transitions to
|
||||
insufficient_data. May be used multiple times.
|
||||
Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -1280,7 +1283,7 @@ Update an existing alarm.
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--meter-name <METRIC></command></term>
|
||||
<term><command>-m <METRIC>, --meter-name <METRIC></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Metric to evaluate against
|
||||
@ -1565,7 +1568,7 @@ List the samples for a meter.
|
||||
</section>
|
||||
<section xml:id="ceilometerclient_subcommand_statistics">
|
||||
<title>ceilometer statistics command</title>
|
||||
<screen><computeroutput>usage: ceilometer statistics [-q <QUERY>] -m <NAME> [-p <PERIOD>]
|
||||
<screen><computeroutput>usage: ceilometer statistics [-q <QUERY>] -m <NAME> [-p <PERIOD>] [-g <FIELD>]
|
||||
</computeroutput></screen>
|
||||
<para>
|
||||
List the statistics for a meter.
|
||||
@ -1597,6 +1600,14 @@ List the statistics for a meter.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-g <FIELD>, --groupby <FIELD></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Field for group aggregation.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="ceilometerclient_subcommand_trait-description-list">
|
||||
|
||||
@ -8,9 +8,10 @@
|
||||
|
||||
<?dbhtml stop-chunking?>
|
||||
|
||||
<title>cinder commands</title>
|
||||
<para>The cinder client is the command-line interface (CLI) for the
|
||||
OpenStack Block Storage API and its extensions.</para>
|
||||
<title>Block Storage command-line client</title>
|
||||
<para>The <command>cinder</command> client is the command-line interface
|
||||
(CLI) for the OpenStack Block Storage API and its extensions.
|
||||
</para>
|
||||
<para>For help on a specific <command>cinder</command>
|
||||
command, enter:
|
||||
</para>
|
||||
@ -120,6 +121,15 @@
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>encryption-type-delete</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Delete the encryption type for a volume type (Admin
|
||||
Only).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>encryption-type-list</command></term>
|
||||
<listitem>
|
||||
@ -921,10 +931,9 @@ Add a new volume.
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--metadata [<key=value> [<key=value></command></term>
|
||||
<term><command>--metadata [<key=value> [<key=value> ...]]</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
...]]
|
||||
Metadata key=value pairs (Optional, Default=None)
|
||||
</para>
|
||||
</listitem>
|
||||
@ -1010,8 +1019,26 @@ Create a new encryption type for a volume type (Admin Only).
|
||||
<listitem>
|
||||
<para>
|
||||
Notional service where encryption is performed (e.g.,
|
||||
front-end=Nova). Values: 'front-end', 'back-end'
|
||||
(Optional, Default=None)
|
||||
front-end=Nova) Values: 'front-end', 'back-end'
|
||||
(Default='front-end')
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_encryption-type-delete">
|
||||
<title>cinder encryption-type-delete command</title>
|
||||
<screen><computeroutput>usage: cinder encryption-type-delete <volume_type>
|
||||
</computeroutput></screen>
|
||||
<para>
|
||||
Delete the encryption type for a volume type (Admin Only).
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><volume_type></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name or ID of the volume type
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -1135,10 +1162,9 @@ List all the volumes.
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--metadata [<key=value> [<key=value></command></term>
|
||||
<term><command>--metadata [<key=value> [<key=value> ...]]</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
...]]
|
||||
Filter results by metadata
|
||||
</para>
|
||||
</listitem>
|
||||
|
||||
@ -8,9 +8,10 @@
|
||||
|
||||
<?dbhtml stop-chunking?>
|
||||
|
||||
<title>glance commands</title>
|
||||
<para>The glance client is the command-line interface (CLI) for the
|
||||
OpenStack Image Service API and its extensions.</para>
|
||||
<title>Image Service command-line client</title>
|
||||
<para>The <command>glance</command> client is the command-line interface
|
||||
(CLI) for the OpenStack Image Service API and its extensions.
|
||||
</para>
|
||||
<para>For help on a specific <command>glance</command>
|
||||
command, enter:
|
||||
</para>
|
||||
@ -845,7 +846,8 @@ List images you can access.
|
||||
</section>
|
||||
<section xml:id="glanceclient_subcommand_image-show">
|
||||
<title>glance image-show command</title>
|
||||
<screen><computeroutput>usage: glance image-show [--human-readable] <IMAGE>
|
||||
<screen><computeroutput>usage: glance image-show [--human-readable] [--max-column-width <integer>]
|
||||
<IMAGE>
|
||||
</computeroutput></screen>
|
||||
<para>
|
||||
Describe a specific image.
|
||||
@ -870,6 +872,14 @@ Describe a specific image.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--max-column-width <integer></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The max column width of the printed table.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="glanceclient_subcommand_image-update">
|
||||
|
||||
@ -8,9 +8,10 @@
|
||||
|
||||
<?dbhtml stop-chunking?>
|
||||
|
||||
<title>heat commands</title>
|
||||
<para>The heat client is the command-line interface (CLI) for the
|
||||
Orchestration API and its extensions.</para>
|
||||
<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>
|
||||
@ -46,6 +47,14 @@
|
||||
</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>
|
||||
@ -166,6 +175,14 @@
|
||||
</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>
|
||||
@ -476,6 +493,13 @@ Suspend the stack.
|
||||
</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>
|
||||
@ -661,11 +685,29 @@ Show the resource type.
|
||||
</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>] [-u <URL>] [-o <URL>]
|
||||
<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>
|
||||
@ -693,7 +735,7 @@ Create the stack.
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-e <FILE>, --environment-file <FILE></command></term>
|
||||
<term><command>-e <FILE or URL>, --environment-file <FILE or URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Path to the environment.
|
||||
@ -764,11 +806,42 @@ Delete the stack(s).
|
||||
</section>
|
||||
<section xml:id="heatclient_subcommand_stack-list">
|
||||
<title>heat stack-list command</title>
|
||||
<screen><computeroutput>usage: heat stack-list
|
||||
<screen><computeroutput>usage: heat stack-list [-f <KEY1=VALUE1;KEY2=VALUE2...>] [-l <LIMIT>]
|
||||
[-m <ID>]
|
||||
</computeroutput></screen>
|
||||
<para>
|
||||
List the user's stacks.
|
||||
</para> </section>
|
||||
</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>
|
||||
@ -789,7 +862,7 @@ Describe the stack.
|
||||
</section>
|
||||
<section xml:id="heatclient_subcommand_stack-update">
|
||||
<title>heat stack-update command</title>
|
||||
<screen><computeroutput>usage: heat stack-update [-f <FILE>] [-e <FILE>] [-u <URL>] [-o <URL>]
|
||||
<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>
|
||||
@ -817,7 +890,7 @@ Update the stack.
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-e <FILE>, --environment-file <FILE></command></term>
|
||||
<term><command>-e <FILE or URL>, --environment-file <FILE or URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Path to the environment.
|
||||
@ -872,8 +945,8 @@ Get the template for the specified stack.
|
||||
</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>] [-o <URL>]
|
||||
[-P <KEY1=VALUE1;KEY2=VALUE2...>]
|
||||
<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.
|
||||
@ -896,7 +969,7 @@ Validate a template with parameters.
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-e <FILE>, --environment-file <FILE></command></term>
|
||||
<term><command>-e <FILE or URL>, --environment-file <FILE or URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Path to the environment.
|
||||
|
||||
@ -8,9 +8,10 @@
|
||||
|
||||
<?dbhtml stop-chunking?>
|
||||
|
||||
<title>keystone commands</title>
|
||||
<para>The keystone client is the command-line interface (CLI) for the
|
||||
OpenStack Identity API and its extensions.</para>
|
||||
<title>Identity Service command-line client</title>
|
||||
<para>The <command>keystone</command> client is the command-line interface
|
||||
(CLI) for the OpenStack Identity API and its extensions.
|
||||
</para>
|
||||
<para>For help on a specific <command>keystone</command>
|
||||
command, enter:
|
||||
</para>
|
||||
@ -572,13 +573,7 @@ List service catalog, possibly filtered by service.
|
||||
<screen><computeroutput>usage: keystone discover
|
||||
</computeroutput></screen>
|
||||
<para>
|
||||
Discover Keystone servers, supported API versions and extensions. Usage:: $
|
||||
keystone discover Keystone found at http://localhost:35357 - supports version
|
||||
v1.0 (<emphasis>DEPRECATED</emphasis>) here http://localhost:35357/v1.0 - supports version v1.1
|
||||
(CURRENT) here http://localhost:35357/v1.1 - supports version v2.0 (CURRENT)
|
||||
here http://localhost:35357/v2.0 - and RAX-KSKEY: Rackspace API Key
|
||||
Authentication Admin Extension - and RAX-KSGRP: Rackspace Keystone Group
|
||||
Extensions
|
||||
Discover Keystone servers, supported API versions and extensions.
|
||||
</para> </section>
|
||||
<section xml:id="keystoneclient_subcommand_ec2-credentials-create">
|
||||
<title>keystone ec2-credentials-create command</title>
|
||||
|
||||
@ -8,9 +8,10 @@
|
||||
|
||||
<?dbhtml stop-chunking?>
|
||||
|
||||
<title>neutron commands</title>
|
||||
<para>The neutron client is the command-line interface (CLI) for the
|
||||
OpenStack Networking API and its extensions.</para>
|
||||
<title>Networking command-line client</title>
|
||||
<para>The <command>neutron</command> client is the command-line interface
|
||||
(CLI) for the OpenStack Networking API and its extensions.
|
||||
</para>
|
||||
<para>For help on a specific <command>neutron</command>
|
||||
command, enter:
|
||||
</para>
|
||||
@ -18,7 +19,7 @@
|
||||
|
||||
<section xml:id="neutronclient_command_usage">
|
||||
<title>neutron usage</title>
|
||||
<screen><computeroutput> [--os-auth-strategy <auth-strategy>] [--os-auth-url <auth-url>]
|
||||
<screen><computeroutput> [--os-auth-url <auth-url>]
|
||||
[--os-tenant-name <auth-tenant-name>]
|
||||
[--os-tenant-id <auth-tenant-id>]
|
||||
[--os-username <auth-username>] [--os-password <auth-password>]
|
||||
@ -39,10 +40,11 @@
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-v, --verbose</command></term>
|
||||
<term><command>-v, --verbose, --debug</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Increase verbosity of output. Can be repeated.
|
||||
Increase verbosity of output and show tracebacks on
|
||||
errors. Can be repeated.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -62,14 +64,6 @@
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--debug</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Show tracebacks on errors
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-auth-strategy <auth-strategy></command></term>
|
||||
<listitem>
|
||||
@ -8039,7 +8033,7 @@ Create a router for a given tenant.
|
||||
<term><command>distributed</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Create a distributed router (Nicira plugin only)
|
||||
Create a distributed router (VMware NSX plugin only)
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
@ -8,9 +8,10 @@
|
||||
|
||||
<?dbhtml stop-chunking?>
|
||||
|
||||
<title>nova commands</title>
|
||||
<para>The nova client is the command-line interface (CLI) for the
|
||||
OpenStack Compute API and its extensions.</para>
|
||||
<title>Compute command-line client</title>
|
||||
<para>The <command>nova</command> client is the command-line interface
|
||||
(CLI) for the OpenStack Compute API and its extensions.
|
||||
</para>
|
||||
<para>For help on a specific <command>nova</command>
|
||||
command, enter:
|
||||
</para>
|
||||
@ -1311,54 +1312,6 @@
|
||||
</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>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>baremetal-interface-add</command></term>
|
||||
<listitem>
|
||||
@ -1416,6 +1369,103 @@
|
||||
</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>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>
|
||||
<term><command>host-evacuate</command></term>
|
||||
<listitem>
|
||||
@ -1441,55 +1491,6 @@
|
||||
</para>
|
||||
</listitem>
|
||||
</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>
|
||||
</section>
|
||||
<section xml:id="novaclient_command_optional">
|
||||
|
||||
@ -8,9 +8,10 @@
|
||||
|
||||
<?dbhtml stop-chunking?>
|
||||
|
||||
<title>swift commands</title>
|
||||
<para>The swift client is the command-line interface (CLI) for the
|
||||
OpenStack Object Storage API and its extensions.</para>
|
||||
<title>Object Storage command-line client</title>
|
||||
<para>The <command>swift</command> client is the command-line interface
|
||||
(CLI) for the OpenStack Object Storage API and its extensions.
|
||||
</para>
|
||||
<para>For help on a specific <command>swift</command>
|
||||
command, enter:
|
||||
</para>
|
||||
@ -85,6 +86,14 @@
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>capabilities</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
List cluster capabilities
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="swiftclient_command_examples">
|
||||
@ -203,7 +212,7 @@
|
||||
<term><command>--os-username=<auth-user-name></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Openstack username. Defaults to <code>env[OS_USERNAME]</code>.
|
||||
OpenStack username. Defaults to <code>env[OS_USERNAME]</code>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -211,7 +220,7 @@
|
||||
<term><command>--os-password=<auth-password></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Openstack password. Defaults to <code>env[OS_PASSWORD]</code>.
|
||||
OpenStack password. Defaults to <code>env[OS_PASSWORD]</code>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -227,7 +236,7 @@
|
||||
<term><command>--os-tenant-name=<auth-tenant-name></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Openstack tenant name. Defaults to
|
||||
OpenStack tenant name. Defaults to
|
||||
<code>env[OS_TENANT_NAME]</code>.
|
||||
</para>
|
||||
</listitem>
|
||||
@ -236,7 +245,7 @@
|
||||
<term><command>--os-auth-url=<auth-url></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Openstack auth URL. Defaults to <code>env[OS_AUTH_URL]</code>.
|
||||
OpenStack auth URL. Defaults to <code>env[OS_AUTH_URL]</code>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -244,7 +253,7 @@
|
||||
<term><command>--os-auth-token=<auth-token></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Openstack token. Defaults to <code>env[OS_AUTH_TOKEN]</code>. Used
|
||||
OpenStack token. Defaults to <code>env[OS_AUTH_TOKEN]</code>. Used
|
||||
with --os-storage-url to bypass the usual
|
||||
username/password authentication.
|
||||
</para>
|
||||
@ -254,7 +263,7 @@
|
||||
<term><command>--os-storage-url=<storage-url></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Openstack storage URL. Defaults to
|
||||
OpenStack storage URL. Defaults to
|
||||
<code>env[OS_STORAGE_URL]</code>. Overrides the storage url
|
||||
returned during auth. Will bypass authentication when
|
||||
used with --os-auth-token.
|
||||
@ -265,7 +274,7 @@
|
||||
<term><command>--os-region-name=<region-name></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Openstack region name. Defaults to <code>env[OS_REGION_NAME]</code>
|
||||
OpenStack region name. Defaults to <code>env[OS_REGION_NAME]</code>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -273,7 +282,7 @@
|
||||
<term><command>--os-service-type=<service-type></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Openstack Service type. Defaults to
|
||||
OpenStack Service type. Defaults to
|
||||
<code>env[OS_SERVICE_TYPE]</code>
|
||||
</para>
|
||||
</listitem>
|
||||
@ -282,7 +291,7 @@
|
||||
<term><command>--os-endpoint-type=<endpoint-type></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Openstack Endpoint type. Defaults to
|
||||
OpenStack Endpoint type. Defaults to
|
||||
<code>env[OS_ENDPOINT_TYPE]</code>
|
||||
</para>
|
||||
</listitem>
|
||||
@ -300,10 +309,9 @@
|
||||
<term><command>--insecure</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Allow swiftclient to access insecure keystone server.
|
||||
The keystone's certificate will not be verified.
|
||||
Defaults to <code>env[SWIFTCLIENT_INSECURE]</code> (set to 'true'
|
||||
to enable).
|
||||
Allow swiftclient to access servers without having to
|
||||
verify the SSL certificate. Defaults to
|
||||
<code>env[SWIFTCLIENT_INSECURE]</code> (set to 'true' to enable).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -311,8 +319,9 @@
|
||||
<term><command>--no-ssl-compression</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Disable SSL compression when using https. This may
|
||||
increase performance.
|
||||
This option is deprecated and not used anymore. SSL
|
||||
compression should be disabled by default by the
|
||||
system SSL library
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -365,7 +374,8 @@
|
||||
<term><command>--object-threads <threads></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Number of threads to use for deleting objects
|
||||
Number of threads to use for deleting objects.
|
||||
Default is 10
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -373,7 +383,8 @@
|
||||
<term><command>--container-threads <threads></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Number of threads to use for deleting containers
|
||||
Number of threads to use for deleting containers.
|
||||
Default is 10
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -396,7 +407,7 @@
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command><object></command></term>
|
||||
<term><command>[object]</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of object to download. Specify multiple times
|
||||
@ -448,7 +459,8 @@
|
||||
<term><command>--object-threads <threads></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Number of threads to use for downloading objects
|
||||
Number of threads to use for downloading objects.
|
||||
Default is 10
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -456,7 +468,8 @@
|
||||
<term><command>--container-threads <threads></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Number of threads to use for deleting containers
|
||||
Number of threads to use for downloading containers.
|
||||
Default is 10
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -519,7 +532,7 @@
|
||||
<term><command>--totals</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Used with -l or --ls, only report totals
|
||||
Used with -l or --lh, only report totals
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -552,7 +565,7 @@ If the container is not found, it will be created automatically.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><container></command></term>
|
||||
<term><command>[container]</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of container to post to
|
||||
@ -634,7 +647,7 @@ If the container is not found, it will be created automatically.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><container></command></term>
|
||||
<term><command>[container]</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of container to stat from
|
||||
@ -642,7 +655,7 @@ If the container is not found, it will be created automatically.
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command><object></command></term>
|
||||
<term><command>[object]</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of object to stat. Specify multiple times
|
||||
|
||||
Loading…
Reference in New Issue
Block a user