diff --git a/doc/cli-reference/generated/ch_cli_cinder_commands.xml b/doc/cli-reference/generated/ch_cli_cinder_commands.xml index c9c20118eb..e62b22d75d 100644 --- a/doc/cli-reference/generated/ch_cli_cinder_commands.xml +++ b/doc/cli-reference/generated/ch_cli_cinder_commands.xml @@ -9,13 +9,13 @@ - Block Storage command-line client + Block Storage service command-line client The cinder 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 cinder version - 1.4.0. + 1.5.0. For help on a specific cinder @@ -28,8 +28,8 @@ 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 @@ + + backup-reset-state + + + Explicitly updates the backup state. + + + backup-restore @@ -326,6 +334,14 @@ + + image-metadata-show + + + Shows volume image metadata. + + + list @@ -526,6 +542,38 @@ + + replication-disable + + + Disables volume replication on a given volume. + + + + + replication-enable + + + Enables volume replication on a given volume. + + + + + replication-failover + + + Failover a volume to a secondary target + + + + + replication-list-targets + + + List replication targets available for a volume. + + + replication-promote @@ -778,11 +826,20 @@ + + type-show + + + Show volume type details. + + + type-update - Updates volume type name and/or description. + Updates volume type name ,description and/or + is_public. @@ -881,14 +938,6 @@ - - --endpoint-type <endpoint-type> - - - DEPRECATED! Use --os-endpoint-type. - - - --os-endpoint-type <os-endpoint-type> @@ -899,6 +948,14 @@ + + --endpoint-type <endpoint-type> + + + DEPRECATED! Use --os-endpoint-type. + + + --os-volume-api-version <volume-api-ver> @@ -913,7 +970,7 @@ Use this API endpoint instead of the Service Catalog. - Defaults to env[CINDERCLIENT_BYPASS_URL] + Defaults to env[CINDERCLIENT_BYPASS_URL]. @@ -931,7 +988,7 @@ Authentication strategy (Env: OS_AUTH_STRATEGY, default keystone). For now, any other value will - disable the authentication + disable the authentication. @@ -980,7 +1037,7 @@ --os-user-id <auth-user-id> - Authentication user ID (Env: OS_USER_ID) + Authentication user ID (Env: OS_USER_ID). @@ -1050,7 +1107,7 @@ --os-token <token> - Defaults to env[OS_TOKEN] + Defaults to env[OS_TOKEN]. @@ -1058,7 +1115,7 @@ --os-url <url> - Defaults to env[OS_URL] + Defaults to env[OS_URL]. @@ -1255,7 +1312,9 @@ Import backup metadata record.
cinder backup-list usage: cinder backup-list [--all-tenants [<all_tenants>]] [--name <name>] - [--status <status>] [--volume-id <volume-id>] + [--status <status>] [--volume-id <volume-id>] + [--marker <marker>] [--limit <limit>] + [--sort <key>[:<direction>]] Lists all backups. @@ -1292,6 +1351,65 @@ Lists all backups. + + --marker <marker> + + + Begin returning backups that appear later in the + backup list than that represented by this id. + Default=None. + + + + + --limit <limit> + + + Maximum number of backups to return. Default=None. + + + + + --sort <key>[:<direction>] + + + 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. + + + + +
+
+ cinder backup-reset-state + usage: cinder backup-reset-state [--state <state>] <backup> [<backup> ...] + +Explicitly updates the backup state. + + Positional arguments + + <backup> + + + Name or ID of the backup to modify. + + + + + + Optional arguments + + --state <state> + + + The state to assign to the backup. Valid values are + "available", "error", "creating", "deleting", and + "error_deleting". Default=available. + + +
@@ -1680,7 +1798,7 @@ Creates a volume. <size> - Size of volume, in GBs. (Required unless snapshot-id + Size of volume, in GiBs. (Required unless snapshot-id /source-volid is specified). @@ -2012,7 +2130,7 @@ Attempts to extend size of an existing volume. <new_size> - New size of volume, in GBs. + New size of volume, in GiBs. @@ -2109,6 +2227,23 @@ Sets or deletes volume image metadata. + +
+
+ cinder image-metadata-show + usage: cinder image-metadata-show <volume> + +Shows volume image metadata. + + Positional arguments + + <volume> + + + ID of volume. + + +
@@ -2399,7 +2534,8 @@ Migrates volume to a new host. <host> - Destination host. + Destination host. Takes the form: host@backend- + name#pool @@ -2929,6 +3065,82 @@ Renames a volume. + +
+
+ cinder replication-disable + usage: cinder replication-disable <volume> + +Disables volume replication on a given volume. + + Positional arguments + + <volume> + + + ID of volume to disable replication. + + + + +
+
+ cinder replication-enable + usage: cinder replication-enable <volume> + +Enables volume replication on a given volume. + + Positional arguments + + <volume> + + + ID of volume to enable replication. + + + + +
+
+ cinder replication-failover + usage: cinder replication-failover <volume> <secondary> + +Failover a volume to a secondary target + + Positional arguments + + <volume> + + + ID of volume to failover. + + + + + <secondary> + + + A unqiue identifier that represents a failover target. + + + + +
+
+ cinder replication-list-targets + usage: cinder replication-list-targets <volume> + +List replication targets available for a volume. + + Positional arguments + + <volume> + + + ID of volume to list available replication targets. + + +
@@ -3274,7 +3486,9 @@ Removes one or more snapshots.
cinder snapshot-list usage: cinder snapshot-list [--all-tenants [<0|1>]] [--name <name>] - [--status <status>] [--volume-id <volume-id>] + [--status <status>] [--volume-id <volume-id>] + [--marker <marker>] [--limit <limit>] + [--sort <key>[:<direction>]] Lists all snapshots. @@ -3311,6 +3525,35 @@ Lists all snapshots. + + --marker <marker> + + + Begin returning snapshots that appear later in the + snapshot list than that represented by this id. + Default=None. + + + + + --limit <limit> + + + Maximum number of snapshots to return. Default=None. + + + + + --sort <key>[:<direction>] + + + 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. + + +
@@ -3757,11 +4000,30 @@ Sets or unsets extra_spec for a volume type. Lists available 'volume types'. (Admin only will see private types)
+
+ cinder type-show + usage: cinder type-show <volume_type> + +Show volume type details. + + Positional arguments + + <volume_type> + + + Name or ID of the volume type. + + + + +
cinder type-update - usage: cinder type-update [--name <name>] [--description <description>] <id> + usage: cinder type-update [--name <name>] [--description <description>] + [--is-public <is-public>] + <id> -Updates volume type name and/or description. +Updates volume type name ,description and/or is_public. Positional arguments @@ -3791,6 +4053,14 @@ Updates volume type name and/or description. + + --is-public <is-public> + + + Make type accessible to the public or not. + + +
@@ -4019,7 +4289,9 @@ Import backup metadata record.
cinder backup-list (v2) usage: cinder --os-volume-api-version 2 backup-list [--all-tenants [<all_tenants>]] [--name <name>] - [--status <status>] [--volume-id <volume-id>] + [--status <status>] [--volume-id <volume-id>] + [--marker <marker>] [--limit <limit>] + [--sort <key>[:<direction>]] Lists all backups. @@ -4056,6 +4328,65 @@ Lists all backups. + + --marker <marker> + + + Begin returning backups that appear later in the + backup list than that represented by this id. + Default=None. + + + + + --limit <limit> + + + Maximum number of backups to return. Default=None. + + + + + --sort <key>[:<direction>] + + + 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. + + + + +
+
+ cinder backup-reset-state (v2) + usage: cinder --os-volume-api-version 2 backup-reset-state [--state <state>] <backup> [<backup> ...] + +Explicitly updates the backup state. + + Positional arguments + + <backup> + + + Name or ID of the backup to modify. + + + + + + Optional arguments + + --state <state> + + + The state to assign to the backup. Valid values are + "available", "error", "creating", "deleting", and + "error_deleting". Default=available. + + +
@@ -4444,7 +4775,7 @@ Creates a volume. <size> - Size of volume, in GBs. (Required unless snapshot-id + Size of volume, in GiBs. (Required unless snapshot-id /source-volid is specified). @@ -4776,7 +5107,7 @@ Attempts to extend size of an existing volume. <new_size> - New size of volume, in GBs. + New size of volume, in GiBs. @@ -4873,6 +5204,23 @@ Sets or deletes volume image metadata. + +
+
+ cinder image-metadata-show (v2) + usage: cinder --os-volume-api-version 2 image-metadata-show <volume> + +Shows volume image metadata. + + Positional arguments + + <volume> + + + ID of volume. + + +
@@ -5163,7 +5511,8 @@ Migrates volume to a new host. <host> - Destination host. + Destination host. Takes the form: host@backend- + name#pool @@ -5693,6 +6042,82 @@ Renames a volume. + +
+
+ cinder replication-disable (v2) + usage: cinder --os-volume-api-version 2 replication-disable <volume> + +Disables volume replication on a given volume. + + Positional arguments + + <volume> + + + ID of volume to disable replication. + + + + +
+
+ cinder replication-enable (v2) + usage: cinder --os-volume-api-version 2 replication-enable <volume> + +Enables volume replication on a given volume. + + Positional arguments + + <volume> + + + ID of volume to enable replication. + + + + +
+
+ cinder replication-failover (v2) + usage: cinder --os-volume-api-version 2 replication-failover <volume> <secondary> + +Failover a volume to a secondary target + + Positional arguments + + <volume> + + + ID of volume to failover. + + + + + <secondary> + + + A unqiue identifier that represents a failover target. + + + + +
+
+ cinder replication-list-targets (v2) + usage: cinder --os-volume-api-version 2 replication-list-targets <volume> + +List replication targets available for a volume. + + Positional arguments + + <volume> + + + ID of volume to list available replication targets. + + +
@@ -6038,7 +6463,9 @@ Removes one or more snapshots.
cinder snapshot-list (v2) usage: cinder --os-volume-api-version 2 snapshot-list [--all-tenants [<0|1>]] [--name <name>] - [--status <status>] [--volume-id <volume-id>] + [--status <status>] [--volume-id <volume-id>] + [--marker <marker>] [--limit <limit>] + [--sort <key>[:<direction>]] Lists all snapshots. @@ -6075,6 +6502,35 @@ Lists all snapshots. + + --marker <marker> + + + Begin returning snapshots that appear later in the + snapshot list than that represented by this id. + Default=None. + + + + + --limit <limit> + + + Maximum number of snapshots to return. Default=None. + + + + + --sort <key>[:<direction>] + + + 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. + + +
@@ -6521,11 +6977,30 @@ Sets or unsets extra_spec for a volume type. Lists available 'volume types'. (Admin only will see private types)
+
+ cinder type-show (v2) + usage: cinder --os-volume-api-version 2 type-show <volume_type> + +Show volume type details. + + Positional arguments + + <volume_type> + + + Name or ID of the volume type. + + + + +
cinder type-update (v2) - usage: cinder --os-volume-api-version 2 type-update [--name <name>] [--description <description>] <id> + usage: cinder --os-volume-api-version 2 type-update [--name <name>] [--description <description>] + [--is-public <is-public>] + <id> -Updates volume type name and/or description. +Updates volume type name ,description and/or is_public. Positional arguments @@ -6555,6 +7030,14 @@ Updates volume type name and/or description. + + --is-public <is-public> + + + Make type accessible to the public or not. + + +