Update CLI reference for python-cinderclient 1.2.1
Change-Id: I19481ee28d477ee2f5b8676a15bb2b2f30a0200f
This commit is contained in:
Christian Berendt
parent
7404f7bede
commit
40fded4f76
@ -15,7 +15,7 @@
|
||||
interface (CLI) for the OpenStack Block Storage API and its extensions.
|
||||
|
||||
This chapter documents <command>cinder</command> version
|
||||
<literal>1.2.0</literal>.
|
||||
<literal>1.2.1</literal>.
|
||||
</para>
|
||||
|
||||
<para>For help on a specific <command>cinder</command>
|
||||
@ -1278,7 +1278,7 @@ Attempts force-delete of volume, regardless of state.
|
||||
<screen><computeroutput>usage: cinder list [--all-tenants [<0|1>]] [--display-name <display-name>]
|
||||
[--status <status>]
|
||||
[--metadata [<key=value> [<key=value> ...]]]
|
||||
[--tenant [<tenant>]]</computeroutput></screen>
|
||||
[--tenant [<tenant>]] [--limit <limit>]</computeroutput></screen>
|
||||
<para>
|
||||
Lists all volumes.
|
||||
</para> <variablelist wordsize="10">
|
||||
@ -1324,6 +1324,15 @@ Lists all volumes.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--limit <limit></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Maximum number of volumes to return. OPTIONAL:
|
||||
Default=None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_list-extensions">
|
||||
@ -2627,7 +2636,7 @@ Lists all availability zones.
|
||||
<section xml:id="cinderclient_subcommand_backup-create_v2">
|
||||
<title>cinder backup-create (v2)</title>
|
||||
<screen><computeroutput>usage: cinder --os-volume-api-version 2 backup-create [--container <container>] [--name <name>]
|
||||
[--description <description>]
|
||||
[--description <description>] [--incremental]
|
||||
<volume></computeroutput></screen>
|
||||
<para>
|
||||
Creates a volume backup.
|
||||
@ -2668,6 +2677,14 @@ Creates a volume backup.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--incremental</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Incremental backup. Default=False.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_backup-delete_v2">
|
||||
@ -2931,6 +2948,41 @@ Creates a consistency group.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_consisgroup-create-from-src_v2">
|
||||
<title>cinder consisgroup-create-from-src (v2)</title>
|
||||
<screen><computeroutput>usage: cinder --os-volume-api-version 2 consisgroup-create-from-src [--cgsnapshot <cgsnapshot>]
|
||||
[--name <name>]
|
||||
[--description <description>]</computeroutput></screen>
|
||||
<para>
|
||||
Creates a consistency group from a cgsnapshot.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>--cgsnapshot <cgsnapshot></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name or ID of a cgsnapshot. Default=None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--name <name></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of a consistency group. Default=None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--description <description></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Description of a consistency group. Default=None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_consisgroup-delete_v2">
|
||||
@ -2998,6 +3050,63 @@ Shows details of a consistency group.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_consisgroup-update_v2">
|
||||
<title>cinder consisgroup-update (v2)</title>
|
||||
<screen><computeroutput>usage: cinder --os-volume-api-version 2 consisgroup-update [--name <name>] [--description <description>]
|
||||
[--add-volumes <uuid1,uuid2,......>]
|
||||
[--remove-volumes <uuid3,uuid4,......>]
|
||||
<consistencygroup></computeroutput></screen>
|
||||
<para>
|
||||
Updates a consistencygroup.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><consistencygroup></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name or ID of a consistency group.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>--name <name></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
New name for consistency group. Default=None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--description <description></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
New description for consistency group. Default=None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--add-volumes <uuid1,uuid2,......></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
UUID of one or more volumes to be added to the
|
||||
consistency group, separated by commas. Default=None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--remove-volumes <uuid3,uuid4,......></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
UUID of one or more volumes to be removed from the
|
||||
consistency group, separated by commas. Default=None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_create_v2">
|
||||
@ -3350,7 +3459,7 @@ Lists all volumes.
|
||||
<term><command>--name <name></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Filters results by a name. OPTIONAL: Default=None.
|
||||
Filters results by a name. Default=None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -3358,7 +3467,7 @@ Lists all volumes.
|
||||
<term><command>--status <status></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Filters results by a status. OPTIONAL: Default=None.
|
||||
Filters results by a status. Default=None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -3367,7 +3476,7 @@ Lists all volumes.
|
||||
<listitem>
|
||||
<para>
|
||||
Filters results by a metadata key and value pair.
|
||||
OPTIONAL: Default=None.
|
||||
Default=None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -3377,7 +3486,7 @@ Lists all volumes.
|
||||
<para>
|
||||
Begin returning volumes that appear later in the
|
||||
volume list than that represented by this volume id.
|
||||
OPTIONAL: Default=None.
|
||||
Default=None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -3385,8 +3494,7 @@ Lists all volumes.
|
||||
<term><command>--limit <limit></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Maximum number of volumes to return. OPTIONAL:
|
||||
Default=None.
|
||||
Maximum number of volumes to return. Default=None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -3397,7 +3505,7 @@ Lists all volumes.
|
||||
Comma-separated list of sort keys and directions in
|
||||
the form of <key>[:<asc|desc>]. Valid keys: id,
|
||||
status, size, availability_zone, name, bootable,
|
||||
created_at. OPTIONAL: Default=None.
|
||||
created_at. Default=None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -3588,7 +3696,7 @@ Updates volume metadata.
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_migrate_v2">
|
||||
<title>cinder migrate (v2)</title>
|
||||
<screen><computeroutput>usage: cinder --os-volume-api-version 2 migrate [--force-host-copy <True|False>] <volume> <host></computeroutput></screen>
|
||||
<screen><computeroutput>usage: cinder --os-volume-api-version 2 migrate [--force-host-copy [<True|False>]] <volume> <host></computeroutput></screen>
|
||||
<para>
|
||||
Migrates volume to a new host.
|
||||
</para> <variablelist wordsize="10">
|
||||
@ -3613,7 +3721,7 @@ Migrates volume to a new host.
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>--force-host-copy <True|False></command></term>
|
||||
<term><command>--force-host-copy [<True|False>]</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Enables or disables generic host-based force-
|
||||
@ -3677,7 +3785,7 @@ Creates a qos specs.
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_qos-delete_v2">
|
||||
<title>cinder qos-delete (v2)</title>
|
||||
<screen><computeroutput>usage: cinder --os-volume-api-version 2 qos-delete [--force <True|False>] <qos_specs></computeroutput></screen>
|
||||
<screen><computeroutput>usage: cinder --os-volume-api-version 2 qos-delete [--force [<True|False>]] <qos_specs></computeroutput></screen>
|
||||
<para>
|
||||
Deletes a specified qos specs.
|
||||
</para> <variablelist wordsize="10">
|
||||
@ -3694,10 +3802,10 @@ Deletes a specified qos specs.
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>--force <True|False></command></term>
|
||||
<term><command>--force [<True|False>]</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Enables or disables deletion of in-use QoS
|
||||
Enables or disables deletion of in-use QoS
|
||||
specifications. Default=False.
|
||||
</para>
|
||||
</listitem>
|
||||
@ -4352,7 +4460,7 @@ Shows volume details.
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_snapshot-create_v2">
|
||||
<title>cinder snapshot-create (v2)</title>
|
||||
<screen><computeroutput>usage: cinder --os-volume-api-version 2 snapshot-create [--force <True|False>] [--name <name>]
|
||||
<screen><computeroutput>usage: cinder --os-volume-api-version 2 snapshot-create [--force [<True|False>]] [--name <name>]
|
||||
[--description <description>]
|
||||
[--metadata [<key=value> [<key=value> ...]]]
|
||||
<volume></computeroutput></screen>
|
||||
@ -4372,10 +4480,10 @@ Creates a snapshot.
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>--force <True|False></command></term>
|
||||
<term><command>--force [<True|False>]</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Allows or disallows snapshot of a volume when the
|
||||
Allows or disallows snapshot of a volume when the
|
||||
volume is attached to an instance. If set to True,
|
||||
ignores the current status of the volume when
|
||||
attempting to snapshot it rather than forcing it to be
|
||||
@ -4977,7 +5085,7 @@ Stop managing a volume.
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_upload-to-image_v2">
|
||||
<title>cinder upload-to-image (v2)</title>
|
||||
<screen><computeroutput>usage: cinder --os-volume-api-version 2 upload-to-image [--force <True|False>]
|
||||
<screen><computeroutput>usage: cinder --os-volume-api-version 2 upload-to-image [--force [<True|False>]]
|
||||
[--container-format <container-format>]
|
||||
[--disk-format <disk-format>]
|
||||
<volume> <image-name></computeroutput></screen>
|
||||
@ -5005,10 +5113,10 @@ Uploads volume to Image Service as an image.
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>--force <True|False></command></term>
|
||||
<term><command>--force [<True|False>]</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Enables or disables upload of a volume that is
|
||||
Enables or disables upload of a volume that is
|
||||
attached to an instance. Default=False.
|
||||
</para>
|
||||
</listitem>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user