Update CLI reference for python-cinderclient 1.5.0
Add 7 subcommands for v1 and v2 each
<section xml:id="cinderclient_subcommand_backup-reset-state">
<section xml:id="cinderclient_subcommand_image-metadata-show">
<section xml:id="cinderclient_subcommand_replication-disable">
<section xml:id="cinderclient_subcommand_replication-enable">
<section xml:id="cinderclient_subcommand_replication-failover">
<section xml:id="cinderclient_subcommand_replication-list-targets">
<section xml:id="cinderclient_subcommand_type-show">
<section xml:id="cinderclient_subcommand_backup-reset-state_v2">
<section xml:id="cinderclient_subcommand_image-metadata-show_v2">
<section xml:id="cinderclient_subcommand_replication-disable_v2">
<section xml:id="cinderclient_subcommand_replication-enable_v2">
<section xml:id="cinderclient_subcommand_replication-failover_v2">
<section xml:id="cinderclient_subcommand_replication-list-targets_v2">
<section xml:id="cinderclient_subcommand_type-show_v2">
Fix comma location patch is posted already
https://review.openstack.org/#/c/252108/
Change-Id: I68b441cd42fcbcbf52e07a3ee61951908f1d2fab
This commit is contained in:
Atsushi SAKAI
parent
214060d7ce
commit
d5e9e4e866
@ -9,13 +9,13 @@
|
||||
|
||||
<?dbhtml stop-chunking?>
|
||||
|
||||
<title>Block Storage command-line client</title>
|
||||
<title>Block Storage service 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.
|
||||
interface (CLI) for the Block Storage service API and its extensions.
|
||||
|
||||
This chapter documents <command>cinder</command> version
|
||||
<literal>1.4.0</literal>.
|
||||
<literal>1.5.0</literal>.
|
||||
</para>
|
||||
|
||||
<para>For help on a specific <command>cinder</command>
|
||||
@ -28,8 +28,8 @@
|
||||
<screen><computeroutput>usage: cinder [--version] [-d] [--os-auth-system <auth-system>]
|
||||
[--service-type <service-type>] [--service-name <service-name>]
|
||||
[--volume-service-name <volume-service-name>]
|
||||
[--endpoint-type <endpoint-type>]
|
||||
[--os-endpoint-type <os-endpoint-type>]
|
||||
[--endpoint-type <endpoint-type>]
|
||||
[--os-volume-api-version <volume-api-ver>]
|
||||
[--bypass-url <bypass-url>] [--retries <retries>]
|
||||
[--os-auth-strategy <auth-strategy>]
|
||||
@ -105,6 +105,14 @@
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>backup-reset-state</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Explicitly updates the backup state.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>backup-restore</command></term>
|
||||
<listitem>
|
||||
@ -326,6 +334,14 @@
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>image-metadata-show</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Shows volume image metadata.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>list</command></term>
|
||||
<listitem>
|
||||
@ -526,6 +542,38 @@
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>replication-disable</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Disables volume replication on a given volume.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>replication-enable</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Enables volume replication on a given volume.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>replication-failover</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Failover a volume to a secondary target
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>replication-list-targets</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
List replication targets available for a volume.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>replication-promote</command></term>
|
||||
<listitem>
|
||||
@ -778,11 +826,20 @@
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>type-show</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Show volume type details.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>type-update</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Updates volume type name and/or description.
|
||||
Updates volume type name ,description and/or
|
||||
is_public.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -881,14 +938,6 @@
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--endpoint-type <endpoint-type></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<emphasis>DEPRECATED!</emphasis> Use --os-endpoint-type.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-endpoint-type <os-endpoint-type></command></term>
|
||||
<listitem>
|
||||
@ -899,6 +948,14 @@
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--endpoint-type <endpoint-type></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<emphasis>DEPRECATED!</emphasis> Use --os-endpoint-type.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-volume-api-version <volume-api-ver></command></term>
|
||||
<listitem>
|
||||
@ -913,7 +970,7 @@
|
||||
<listitem>
|
||||
<para>
|
||||
Use this API endpoint instead of the Service Catalog.
|
||||
Defaults to <code>env[CINDERCLIENT_BYPASS_URL]</code>
|
||||
Defaults to <code>env[CINDERCLIENT_BYPASS_URL]</code>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -931,7 +988,7 @@
|
||||
<para>
|
||||
Authentication strategy (Env: OS_AUTH_STRATEGY,
|
||||
default keystone). For now, any other value will
|
||||
disable the authentication
|
||||
disable the authentication.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -980,7 +1037,7 @@
|
||||
<term><command>--os-user-id <auth-user-id></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Authentication user ID (Env: OS_USER_ID)
|
||||
Authentication user ID (Env: OS_USER_ID).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -1050,7 +1107,7 @@
|
||||
<term><command>--os-token <token></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Defaults to <code>env[OS_TOKEN]</code>
|
||||
Defaults to <code>env[OS_TOKEN]</code>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -1058,7 +1115,7 @@
|
||||
<term><command>--os-url <url></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Defaults to <code>env[OS_URL]</code>
|
||||
Defaults to <code>env[OS_URL]</code>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -1255,7 +1312,9 @@ Import backup metadata record.
|
||||
<section xml:id="cinderclient_subcommand_backup-list">
|
||||
<title>cinder backup-list</title>
|
||||
<screen><computeroutput>usage: cinder backup-list [--all-tenants [<all_tenants>]] [--name <name>]
|
||||
[--status <status>] [--volume-id <volume-id>]</computeroutput></screen>
|
||||
[--status <status>] [--volume-id <volume-id>]
|
||||
[--marker <marker>] [--limit <limit>]
|
||||
[--sort <key>[:<direction>]]</computeroutput></screen>
|
||||
<para>
|
||||
Lists all backups.
|
||||
</para> <variablelist wordsize="10">
|
||||
@ -1292,6 +1351,65 @@ Lists all backups.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--marker <marker></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Begin returning backups that appear later in the
|
||||
backup list than that represented by this id.
|
||||
Default=None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--limit <limit></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Maximum number of backups to return. Default=None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--sort <key>[:<direction>]</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
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. Default=None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_backup-reset-state">
|
||||
<title>cinder backup-reset-state</title>
|
||||
<screen><computeroutput>usage: cinder backup-reset-state [--state <state>] <backup> [<backup> ...]</computeroutput></screen>
|
||||
<para>
|
||||
Explicitly updates the backup state.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><backup></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name or ID of the backup to modify.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>--state <state></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The state to assign to the backup. Valid values are
|
||||
"available", "error", "creating", "deleting", and
|
||||
"error_deleting". Default=available.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_backup-restore">
|
||||
@ -1680,7 +1798,7 @@ Creates a volume.
|
||||
<term><command><size></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Size of volume, in GBs. (Required unless snapshot-id
|
||||
Size of volume, in GiBs. (Required unless snapshot-id
|
||||
/source-volid is specified).
|
||||
</para>
|
||||
</listitem>
|
||||
@ -2012,7 +2130,7 @@ Attempts to extend size of an existing volume.
|
||||
<term><command><new_size></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
New size of volume, in GBs.
|
||||
New size of volume, in GiBs.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -2109,6 +2227,23 @@ Sets or deletes volume image metadata.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_image-metadata-show">
|
||||
<title>cinder image-metadata-show</title>
|
||||
<screen><computeroutput>usage: cinder image-metadata-show <volume></computeroutput></screen>
|
||||
<para>
|
||||
Shows volume image metadata.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><volume></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
ID of volume.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_list">
|
||||
@ -2399,7 +2534,8 @@ Migrates volume to a new host.
|
||||
<term><command><host></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Destination host.
|
||||
Destination host. Takes the form: host@backend-
|
||||
name#pool
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -2929,6 +3065,82 @@ Renames a volume.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_replication-disable">
|
||||
<title>cinder replication-disable</title>
|
||||
<screen><computeroutput>usage: cinder replication-disable <volume></computeroutput></screen>
|
||||
<para>
|
||||
Disables volume replication on a given volume.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><volume></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
ID of volume to disable replication.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_replication-enable">
|
||||
<title>cinder replication-enable</title>
|
||||
<screen><computeroutput>usage: cinder replication-enable <volume></computeroutput></screen>
|
||||
<para>
|
||||
Enables volume replication on a given volume.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><volume></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
ID of volume to enable replication.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_replication-failover">
|
||||
<title>cinder replication-failover</title>
|
||||
<screen><computeroutput>usage: cinder replication-failover <volume> <secondary></computeroutput></screen>
|
||||
<para>
|
||||
Failover a volume to a secondary target
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><volume></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
ID of volume to failover.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command><secondary></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
A unqiue identifier that represents a failover target.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_replication-list-targets">
|
||||
<title>cinder replication-list-targets</title>
|
||||
<screen><computeroutput>usage: cinder replication-list-targets <volume></computeroutput></screen>
|
||||
<para>
|
||||
List replication targets available for a volume.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><volume></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
ID of volume to list available replication targets.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_replication-promote">
|
||||
@ -3274,7 +3486,9 @@ Removes one or more snapshots.
|
||||
<section xml:id="cinderclient_subcommand_snapshot-list">
|
||||
<title>cinder snapshot-list</title>
|
||||
<screen><computeroutput>usage: cinder snapshot-list [--all-tenants [<0|1>]] [--name <name>]
|
||||
[--status <status>] [--volume-id <volume-id>]</computeroutput></screen>
|
||||
[--status <status>] [--volume-id <volume-id>]
|
||||
[--marker <marker>] [--limit <limit>]
|
||||
[--sort <key>[:<direction>]]</computeroutput></screen>
|
||||
<para>
|
||||
Lists all snapshots.
|
||||
</para> <variablelist wordsize="10">
|
||||
@ -3311,6 +3525,35 @@ Lists all snapshots.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--marker <marker></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Begin returning snapshots that appear later in the
|
||||
snapshot list than that represented by this id.
|
||||
Default=None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--limit <limit></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Maximum number of snapshots to return. Default=None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--sort <key>[:<direction>]</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
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. Default=None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_snapshot-metadata">
|
||||
@ -3757,11 +4000,30 @@ Sets or unsets extra_spec for a volume type.
|
||||
Lists available 'volume types'. (Admin only will see private types)
|
||||
</para>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_type-show">
|
||||
<title>cinder type-show</title>
|
||||
<screen><computeroutput>usage: cinder type-show <volume_type></computeroutput></screen>
|
||||
<para>
|
||||
Show volume type details.
|
||||
</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>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_type-update">
|
||||
<title>cinder type-update</title>
|
||||
<screen><computeroutput>usage: cinder type-update [--name <name>] [--description <description>] <id></computeroutput></screen>
|
||||
<screen><computeroutput>usage: cinder type-update [--name <name>] [--description <description>]
|
||||
[--is-public <is-public>]
|
||||
<id></computeroutput></screen>
|
||||
<para>
|
||||
Updates volume type name and/or description.
|
||||
Updates volume type name ,description and/or is_public.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
@ -3791,6 +4053,14 @@ Updates volume type name and/or description.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--is-public <is-public></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Make type accessible to the public or not.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_unmanage">
|
||||
@ -4019,7 +4289,9 @@ Import backup metadata record.
|
||||
<section xml:id="cinderclient_subcommand_backup-list_v2">
|
||||
<title>cinder backup-list (v2)</title>
|
||||
<screen><computeroutput>usage: cinder --os-volume-api-version 2 backup-list [--all-tenants [<all_tenants>]] [--name <name>]
|
||||
[--status <status>] [--volume-id <volume-id>]</computeroutput></screen>
|
||||
[--status <status>] [--volume-id <volume-id>]
|
||||
[--marker <marker>] [--limit <limit>]
|
||||
[--sort <key>[:<direction>]]</computeroutput></screen>
|
||||
<para>
|
||||
Lists all backups.
|
||||
</para> <variablelist wordsize="10">
|
||||
@ -4056,6 +4328,65 @@ Lists all backups.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--marker <marker></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Begin returning backups that appear later in the
|
||||
backup list than that represented by this id.
|
||||
Default=None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--limit <limit></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Maximum number of backups to return. Default=None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--sort <key>[:<direction>]</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
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. Default=None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_backup-reset-state_v2">
|
||||
<title>cinder backup-reset-state (v2)</title>
|
||||
<screen><computeroutput>usage: cinder --os-volume-api-version 2 backup-reset-state [--state <state>] <backup> [<backup> ...]</computeroutput></screen>
|
||||
<para>
|
||||
Explicitly updates the backup state.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><backup></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name or ID of the backup to modify.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>--state <state></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The state to assign to the backup. Valid values are
|
||||
"available", "error", "creating", "deleting", and
|
||||
"error_deleting". Default=available.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_backup-restore_v2">
|
||||
@ -4444,7 +4775,7 @@ Creates a volume.
|
||||
<term><command><size></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Size of volume, in GBs. (Required unless snapshot-id
|
||||
Size of volume, in GiBs. (Required unless snapshot-id
|
||||
/source-volid is specified).
|
||||
</para>
|
||||
</listitem>
|
||||
@ -4776,7 +5107,7 @@ Attempts to extend size of an existing volume.
|
||||
<term><command><new_size></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
New size of volume, in GBs.
|
||||
New size of volume, in GiBs.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -4873,6 +5204,23 @@ Sets or deletes volume image metadata.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_image-metadata-show_v2">
|
||||
<title>cinder image-metadata-show (v2)</title>
|
||||
<screen><computeroutput>usage: cinder --os-volume-api-version 2 image-metadata-show <volume></computeroutput></screen>
|
||||
<para>
|
||||
Shows volume image metadata.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><volume></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
ID of volume.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_list_v2">
|
||||
@ -5163,7 +5511,8 @@ Migrates volume to a new host.
|
||||
<term><command><host></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Destination host.
|
||||
Destination host. Takes the form: host@backend-
|
||||
name#pool
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -5693,6 +6042,82 @@ Renames a volume.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_replication-disable_v2">
|
||||
<title>cinder replication-disable (v2)</title>
|
||||
<screen><computeroutput>usage: cinder --os-volume-api-version 2 replication-disable <volume></computeroutput></screen>
|
||||
<para>
|
||||
Disables volume replication on a given volume.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><volume></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
ID of volume to disable replication.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_replication-enable_v2">
|
||||
<title>cinder replication-enable (v2)</title>
|
||||
<screen><computeroutput>usage: cinder --os-volume-api-version 2 replication-enable <volume></computeroutput></screen>
|
||||
<para>
|
||||
Enables volume replication on a given volume.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><volume></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
ID of volume to enable replication.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_replication-failover_v2">
|
||||
<title>cinder replication-failover (v2)</title>
|
||||
<screen><computeroutput>usage: cinder --os-volume-api-version 2 replication-failover <volume> <secondary></computeroutput></screen>
|
||||
<para>
|
||||
Failover a volume to a secondary target
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><volume></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
ID of volume to failover.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command><secondary></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
A unqiue identifier that represents a failover target.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_replication-list-targets_v2">
|
||||
<title>cinder replication-list-targets (v2)</title>
|
||||
<screen><computeroutput>usage: cinder --os-volume-api-version 2 replication-list-targets <volume></computeroutput></screen>
|
||||
<para>
|
||||
List replication targets available for a volume.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><volume></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
ID of volume to list available replication targets.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_replication-promote_v2">
|
||||
@ -6038,7 +6463,9 @@ Removes one or more snapshots.
|
||||
<section xml:id="cinderclient_subcommand_snapshot-list_v2">
|
||||
<title>cinder snapshot-list (v2)</title>
|
||||
<screen><computeroutput>usage: cinder --os-volume-api-version 2 snapshot-list [--all-tenants [<0|1>]] [--name <name>]
|
||||
[--status <status>] [--volume-id <volume-id>]</computeroutput></screen>
|
||||
[--status <status>] [--volume-id <volume-id>]
|
||||
[--marker <marker>] [--limit <limit>]
|
||||
[--sort <key>[:<direction>]]</computeroutput></screen>
|
||||
<para>
|
||||
Lists all snapshots.
|
||||
</para> <variablelist wordsize="10">
|
||||
@ -6075,6 +6502,35 @@ Lists all snapshots.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--marker <marker></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Begin returning snapshots that appear later in the
|
||||
snapshot list than that represented by this id.
|
||||
Default=None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--limit <limit></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Maximum number of snapshots to return. Default=None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--sort <key>[:<direction>]</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
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. Default=None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_snapshot-metadata_v2">
|
||||
@ -6521,11 +6977,30 @@ Sets or unsets extra_spec for a volume type.
|
||||
Lists available 'volume types'. (Admin only will see private types)
|
||||
</para>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_type-show_v2">
|
||||
<title>cinder type-show (v2)</title>
|
||||
<screen><computeroutput>usage: cinder --os-volume-api-version 2 type-show <volume_type></computeroutput></screen>
|
||||
<para>
|
||||
Show volume type details.
|
||||
</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>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_type-update_v2">
|
||||
<title>cinder type-update (v2)</title>
|
||||
<screen><computeroutput>usage: cinder --os-volume-api-version 2 type-update [--name <name>] [--description <description>] <id></computeroutput></screen>
|
||||
<screen><computeroutput>usage: cinder --os-volume-api-version 2 type-update [--name <name>] [--description <description>]
|
||||
[--is-public <is-public>]
|
||||
<id></computeroutput></screen>
|
||||
<para>
|
||||
Updates volume type name and/or description.
|
||||
Updates volume type name ,description and/or is_public.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
@ -6555,6 +7030,14 @@ Updates volume type name and/or description.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--is-public <is-public></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Make type accessible to the public or not.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="cinderclient_subcommand_unmanage_v2">
|
||||
|
||||
Loading…
Reference in New Issue
Block a user