From 013b55f69938a5484a88682a8eb7d6a69b482b41 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sat, 13 Sep 2014 21:20:59 +0200 Subject: [PATCH] Update for cinderclient 1.1.0 Also document v2 commands. Closes-Bug: #1286664 Closes-Bug: #1369149 Closes-Bug: #1291139 Change-Id: Id21c03c8772b3db4a851e4af015d507a5e293f29 --- .../generated/ch_cli_cinder_commands.xml | 3786 ++++++++++++++--- 1 file changed, 3079 insertions(+), 707 deletions(-) diff --git a/doc/cli-reference/generated/ch_cli_cinder_commands.xml b/doc/cli-reference/generated/ch_cli_cinder_commands.xml index b60e3699df..93e47d5664 100644 --- a/doc/cli-reference/generated/ch_cli_cinder_commands.xml +++ b/doc/cli-reference/generated/ch_cli_cinder_commands.xml @@ -10,10 +10,14 @@ Block Storage command-line client - The cinder client is the command-line interface - (CLI) for the OpenStack Block Storage API and its extensions. This chapter documents - cinder version 1.0.9. + + The cinder client is the command-line + interface (CLI) for the OpenStack Block Storage API and its extensions. + + This chapter documents cinder version + 1.1.0. + For help on a specific cinder command, enter: @@ -21,17 +25,25 @@
cinder usage - usage: cinder [--version] [--debug] [--os-username <auth-user-name>] - [--os-password <auth-password>] - [--os-tenant-name <auth-tenant-name>] - [--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>] - [--os-region-name <region-name>] - [--os-auth-system <auth-system>] [--service-type <service-type>] - [--service-name <service-name>] + usage: cinder [--version] [--debug] [--os-auth-system <auth-system>] + [--service-type <service-type>] [--service-name <service-name>] [--volume-service-name <volume-service-name>] [--endpoint-type <endpoint-type>] - [--os-volume-api-version <volume-api-ver>] - [--os-cacert <ca-certificate>] [--retries <retries>] + [--os-volume-api-version <volume-api-ver>] [--retries <retries>] + [--os-auth-strategy <auth-strategy>] + [--os-username <auth-user-name>] [--os-password <auth-password>] + [--os-tenant-name <auth-tenant-name>] + [--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>] + [--os-user-id <auth-user-id>] + [--os-user-domain-id <auth-user-domain-id>] + [--os-user-domain-name <auth-user-domain-name>] + [--os-project-id <auth-project-id>] + [--os-project-name <auth-project-name>] + [--os-project-domain-id <auth-project-domain-id>] + [--os-project-domain-name <auth-project-domain-name>] + [--os-cert <certificate>] [--os-key <key>] + [--os-region-name <region-name>] [--os-token <token>] + [--os-url <url>] [--os-cacert <ca-certificate>] <subcommand> ... Subcommands @@ -39,7 +51,7 @@ absolute-limits - Print a list of absolute limits for a user + Lists absolute limits for a user. @@ -47,7 +59,7 @@ availability-zone-list - List all the availability zones. + Lists all availability zones. @@ -55,7 +67,7 @@ backup-create - Creates a backup. + Creates a volume backup. @@ -63,7 +75,7 @@ backup-delete - Remove a backup. + Removes a backup. @@ -71,7 +83,7 @@ backup-list - List all the backups. + Lists all backups. @@ -79,7 +91,7 @@ backup-restore - Restore a backup. + Restores a backup. @@ -87,7 +99,7 @@ backup-show - Show details about a backup. + Show backup details. @@ -95,7 +107,7 @@ create - Add a new volume. + Creates a volume. @@ -103,7 +115,7 @@ credentials - Show user credentials returned from auth. + Shows user credentials returned from auth. @@ -111,7 +123,7 @@ delete - Remove volume(s). + Removes one or more volumes. @@ -119,8 +131,7 @@ encryption-type-create - Create a new encryption type for a volume type (Admin - Only). + Creates encryption type for a volume type. Admin only. @@ -128,8 +139,7 @@ encryption-type-delete - Delete the encryption type for a volume type (Admin - Only). + Deletes encryption type for a volume type. Admin only. @@ -137,8 +147,8 @@ encryption-type-list - List encryption type information for all volume types - (Admin Only). + Shows encryption type details for volume types. Admin + only. @@ -146,8 +156,8 @@ encryption-type-show - Show the encryption type information for a volume type - (Admin Only). + Shows encryption type details for volume type. Admin + only. @@ -155,8 +165,8 @@ endpoints - Discover endpoints that get returned from the - authenticate services. + Discovers endpoints registered by authentication + service. @@ -164,7 +174,7 @@ extend - Attempt to extend the size of an existing volume. + Attempts to extend size of an existing volume. @@ -172,8 +182,7 @@ extra-specs-list - Print a list of current 'volume types and extra specs' - (Admin Only). + Lists current volume types and extra specs. @@ -181,8 +190,7 @@ force-delete - Attempt forced removal of volume(s), regardless of the - state(s). + Attempts force-delete of volume, regardless of state. @@ -190,7 +198,7 @@ list - List all the volumes. + Lists all volumes. @@ -198,7 +206,7 @@ metadata - Set or Delete metadata on a volume. + Sets or deletes volume metadata. @@ -206,7 +214,7 @@ metadata-show - Show metadata of given volume. + Shows volume metadata. @@ -214,7 +222,7 @@ metadata-update-all - Update all metadata of a volume. + Updates volume metadata. @@ -222,7 +230,7 @@ migrate - Migrate the volume to the new host. + Migrates volume to a new host. @@ -230,7 +238,7 @@ qos-associate - Associate qos specs with specific volume type. + Associates qos specs with specified volume type. @@ -238,7 +246,7 @@ qos-create - Create a new qos specs. + Creates a qos specs. @@ -246,7 +254,7 @@ qos-delete - Delete a specific qos specs. + Deletes a specified qos specs. @@ -254,7 +262,7 @@ qos-disassociate - Disassociate qos specs from specific volume type. + Disassociates qos specs from specified volume type. @@ -262,7 +270,7 @@ qos-disassociate-all - Disassociate qos specs from all of its associations. + Disassociates qos specs from all associations. @@ -270,7 +278,7 @@ qos-get-association - Get all associations of specific qos specs. + Gets all associations for specified qos specs. @@ -278,7 +286,7 @@ qos-key - Set or unset specifications for a qos spec. + Sets or unsets specifications for a qos spec. @@ -286,7 +294,7 @@ qos-list - Get full list of qos specs. + Lists qos specs. @@ -294,7 +302,7 @@ qos-show - Get a specific qos specs. + Shows a specified qos specs. @@ -302,7 +310,7 @@ quota-class-show - List the quotas for a quota class. + Lists quotas for a quota class. @@ -310,7 +318,7 @@ quota-class-update - Update the quotas for a quota class. + Updates quotas for a quota class. @@ -318,7 +326,7 @@ quota-defaults - List the default quotas for a tenant. + Lists default quotas for a tenant. @@ -334,7 +342,7 @@ quota-show - List the quotas for a tenant. + Lists quotas for a tenant. @@ -342,7 +350,7 @@ quota-update - Update the quotas for a tenant. + Updates quotas for a tenant. @@ -350,7 +358,7 @@ quota-usage - List the quota usage for a tenant. + Lists quota usage for a tenant. @@ -358,7 +366,7 @@ rate-limits - Print a list of rate limits for a user + Lists rate limits for a user. @@ -366,7 +374,7 @@ readonly-mode-update - Update volume read-only access mode read_only. + Updates volume read-only access-mode flag. @@ -374,7 +382,7 @@ rename - Rename a volume. + Renames a volume. @@ -382,7 +390,7 @@ reset-state - Explicitly update the state of a volume. + Explicitly updates the volume state. @@ -390,7 +398,7 @@ service-disable - Disable the service. + Disables the service. @@ -398,7 +406,7 @@ service-enable - Enable the service. + Enables the service. @@ -406,8 +414,15 @@ service-list - List all the services. Filter by host & service - binary. + Lists all services. Filter by host and service binary. + + + + + set-bootable + + + Update bootable status of a volume. @@ -415,7 +430,7 @@ show - Show details about a volume. + Shows volume details. @@ -423,7 +438,7 @@ snapshot-create - Add a new snapshot. + Creates a snapshot. @@ -439,7 +454,7 @@ snapshot-list - List all the snapshots. + Lists all snapshots. @@ -447,7 +462,7 @@ snapshot-metadata - Set or Delete metadata of a snapshot. + Sets or deletes snapshot metadata. @@ -455,7 +470,7 @@ snapshot-metadata-show - Show metadata of given snapshot. + Shows snapshot metadata. @@ -463,7 +478,7 @@ snapshot-metadata-update-all - Update all metadata of a snapshot. + Updates snapshot metadata. @@ -471,7 +486,7 @@ snapshot-rename - Rename a snapshot. + Renames a snapshot. @@ -479,7 +494,7 @@ snapshot-reset-state - Explicitly update the state of a snapshot. + Explicitly updates the snapshot state. @@ -487,7 +502,7 @@ snapshot-show - Show details about a snapshot. + Shows snapshot details. @@ -511,7 +526,7 @@ transfer-delete - Undo a transfer. + Undoes a transfer. @@ -519,7 +534,7 @@ transfer-list - List all the transfers. + Lists all transfers. @@ -527,7 +542,7 @@ transfer-show - Show details about a transfer. + Show transfer details. @@ -535,7 +550,7 @@ type-create - Create a new volume type. + Creates a volume type. @@ -543,7 +558,7 @@ type-delete - Delete a specific volume type. + Deletes a specified volume type. @@ -551,7 +566,7 @@ type-key - Set or unset extra_spec for a volume type. + Sets or unsets extra_spec for a volume type. @@ -559,7 +574,7 @@ type-list - Print a list of available 'volume types'. + Lists available 'volume types'. @@ -567,7 +582,7 @@ upload-to-image - Upload volume to image service as image. + Uploads volume to Image Service as an image. @@ -575,7 +590,7 @@ bash-completion - Print arguments for bash_completion. + Prints arguments for bash_completion. @@ -583,7 +598,7 @@ help - Display help about this program or one of its + Shows help about this program or one of its subcommands. @@ -592,7 +607,7 @@ list-extensions - List all the os-api extensions that are available. + Lists all available os-api extensions. @@ -613,55 +628,7 @@ --debug - Print debugging output - - - - - --os-username <auth-user-name> - - - Defaults to env[OS_USERNAME]. - - - - - --os-password <auth-password> - - - Defaults to env[OS_PASSWORD]. - - - - - --os-tenant-name <auth-tenant-name> - - - Defaults to env[OS_TENANT_NAME]. - - - - - --os-tenant-id <auth-tenant-id> - - - Defaults to env[OS_TENANT_ID]. - - - - - --os-auth-url <auth-url> - - - Defaults to env[OS_AUTH_URL]. - - - - - --os-region-name <region-name> - - - Defaults to env[OS_REGION_NAME]. + Shows debugging output. @@ -677,7 +644,7 @@ --service-type <service-type> - Defaults to volume for most actions + Service type. For most actions, default is volume. @@ -685,7 +652,7 @@ --service-name <service-name> - Defaults to env[CINDER_SERVICE_NAME] + Service name. Default=env[CINDER_SERVICE_NAME]. @@ -693,7 +660,8 @@ --volume-service-name <volume-service-name> - Defaults to env[CINDER_VOLUME_SERVICE_NAME] + Volume service name. + Default=env[CINDER_VOLUME_SERVICE_NAME]. @@ -701,7 +669,8 @@ --endpoint-type <endpoint-type> - Defaults to env[CINDER_ENDPOINT_TYPE] or publicURL. + Endpoint type, which is publicURL or internalURL. + Default=nova env[CINDER_ENDPOINT_TYPE] or publicURL. @@ -709,7 +678,169 @@ --os-volume-api-version <volume-api-ver> - Accepts 1 or 2,defaults to env[OS_VOLUME_API_VERSION]. + Block Storage API version. Valid values are 1 or 2. + Default=env[OS_VOLUME_API_VERSION]. + + + + + --retries <retries> + + + Number of retries. + + + + + --os-auth-strategy <auth-strategy> + + + Authentication strategy (Env: OS_AUTH_STRATEGY, + default keystone). For now, any other value will + disable the authentication + + + + + --os-username <auth-user-name> + + + OpenStack user name. Default=env[OS_USERNAME]. + + + + + --os-password <auth-password> + + + Password for OpenStack user. Default=env[OS_PASSWORD]. + + + + + --os-tenant-name <auth-tenant-name> + + + Tenant name. Default=env[OS_TENANT_NAME]. + + + + + --os-tenant-id <auth-tenant-id> + + + ID for the tenant. Default=env[OS_TENANT_ID]. + + + + + --os-auth-url <auth-url> + + + URL for the authentication service. + Default=env[OS_AUTH_URL]. + + + + + --os-user-id <auth-user-id> + + + Authentication user ID (Env: OS_USER_ID) + + + + + --os-user-domain-id <auth-user-domain-id> + + + OpenStack user domain ID. Defaults to + env[OS_USER_DOMAIN_ID]. + + + + + --os-user-domain-name <auth-user-domain-name> + + + OpenStack user domain name. Defaults to + env[OS_USER_DOMAIN_NAME]. + + + + + --os-project-id <auth-project-id> + + + Another way to specify tenant ID. This option is + mutually exclusive with --os-tenant-id. Defaults to + env[OS_PROJECT_ID]. + + + + + --os-project-name <auth-project-name> + + + Another way to specify tenant name. This option is + mutually exclusive with --os-tenant-name. Defaults to + env[OS_PROJECT_NAME]. + + + + + --os-project-domain-id <auth-project-domain-id> + + + Defaults to env[OS_PROJECT_DOMAIN_ID]. + + + + + --os-project-domain-name <auth-project-domain-name> + + + Defaults to env[OS_PROJECT_DOMAIN_NAME]. + + + + + --os-cert <certificate> + + + Defaults to env[OS_CERT]. + + + + + --os-key <key> + + + Defaults to env[OS_KEY]. + + + + + --os-region-name <region-name> + + + Region name. Default=env[OS_REGION_NAME]. + + + + + --os-token <token> + + + Defaults to env[OS_TOKEN] + + + + + --os-url <url> + + + Defaults to env[OS_URL] @@ -722,45 +853,40 @@ - - --retries <retries> - - - Number of retries. - - -
+ +
+ Block Storage API v1 commands
- cinder absolute-limits command + cinder absolute-limits usage: cinder absolute-limits -Print a list of absolute limits for a user +Lists absolute limits for a user.
- cinder availability-zone-list command + cinder availability-zone-list usage: cinder availability-zone-list -List all the availability zones. +Lists all availability zones.
- cinder backup-create command + cinder backup-create usage: cinder backup-create [--container <container>] [--display-name <display-name>] [--display-description <display-description>] <volume> -Creates a backup. +Creates a volume backup. Positional arguments <volume> - Name or ID of the volume to backup. + Name or ID of volume to back up. @@ -771,7 +897,7 @@ Creates a backup. --container <container> - Optional Backup container name. (Default=None) + Backup container name. Default=None. @@ -779,7 +905,7 @@ Creates a backup. --display-name <display-name> - Optional backup name. (Default=None) + Backup name. Default=None. @@ -787,48 +913,48 @@ Creates a backup. --display-description <display-description> - Optional backup description. (Default=None) + Backup description. Default=None.
- cinder backup-delete command + cinder backup-delete usage: cinder backup-delete <backup> -Remove a backup. +Removes a backup. Positional arguments <backup> - Name or ID of the backup to delete. + Name or ID of backup to delete.
- cinder backup-list command + cinder backup-list usage: cinder backup-list -List all the backups. +Lists all backups.
- cinder backup-restore command + cinder backup-restore usage: cinder backup-restore [--volume-id <volume>] <backup> -Restore a backup. +Restores a backup. Positional arguments <backup> - ID of the backup to restore. + ID of backup to restore. @@ -836,34 +962,35 @@ Restore a backup. Optional arguments - --volume-id <volume> + --volume-id <volume> ID - Optional ID(or name) of the volume to restore to. + or name of backup volume to which to restore. + Default=None.
- cinder backup-show command + cinder backup-show usage: cinder backup-show <backup> -Show details about a backup. +Show backup details. Positional arguments <backup> - Name or ID of the backup. + Name or ID of backup.
- cinder create command + cinder create usage: cinder create [--snapshot-id <snapshot-id>] [--source-volid <source-volid>] [--image-id <image-id>] [--display-name <display-name>] @@ -873,14 +1000,14 @@ Show details about a backup. [--metadata [<key=value> [<key=value> ...]]] <size> -Add a new volume. +Creates a volume. Positional arguments <size> - Size of volume in GB + Volume size, in GBs. @@ -891,8 +1018,7 @@ Add a new volume. --snapshot-id <snapshot-id> - Create volume from snapshot id (Optional, - Default=None) + Creates volume from snapshot ID. Default=None. @@ -900,7 +1026,7 @@ Add a new volume. --source-volid <source-volid> - Create volume from volume id (Optional, Default=None) + Creates volume from volume ID. Default=None. @@ -908,7 +1034,7 @@ Add a new volume. --image-id <image-id> - Create volume from image id (Optional, Default=None) + Creates volume from image ID. Default=None. @@ -916,12 +1042,2362 @@ Add a new volume. --display-name <display-name> - Volume name (Optional, Default=None) + Volume name. Default=None. --display-description <display-description> + + + Volume description. Default=None. + + + + + --volume-type <volume-type> + + + Volume type. Default=None. + + + + + --availability-zone <availability-zone> + + + Availability zone for volume. Default=None. + + + + + --metadata [<key=value> [<key=value> ...]] + + + Metadata key and value pairs. Default=None. + + + + +
+
+ cinder credentials + usage: cinder credentials + +Shows user credentials returned from auth. + +
+
+ cinder delete + usage: cinder delete <volume> [<volume> ...] + +Removes one or more volumes. + + Positional arguments + + <volume> + + + Name or ID of volume to delete. Separate multiple volumes with a + space. + + + + +
+
+ cinder encryption-type-create + usage: cinder encryption-type-create [--cipher <cipher>] + [--key_size <key_size>] + [--control_location <control_location>] + <volume_type> <provider> + +Creates encryption type for a volume type. Admin only. + + Positional arguments + + <volume_type> + + + Name or ID of volume type. + + + + + <provider> + + + The class that provides encryption support. For + example, a volume driver class path. + + + + + + Optional arguments + + --cipher <cipher> + + + The encryption algorithm and mode. For example, aes- + xts-plain64. Default=None. + + + + + --key_size <key_size> + + + Size of encryption key, in bits. For example, 128 or + 256. Default=None. + + + + + --control_location <control_location> + + + Notional service where encryption is performed. Valid + values are "front-end" or "back-end." For example, + front-end=Nova. Default is "front-end." + + + + +
+
+ cinder encryption-type-delete + usage: cinder encryption-type-delete <volume_type> + +Deletes encryption type for a volume type. Admin only. + + Positional arguments + + <volume_type> + + + Name or ID of volume type. + + + + +
+
+ cinder encryption-type-list + usage: cinder encryption-type-list + +Shows encryption type details for volume types. Admin only. + +
+
+ cinder encryption-type-show + usage: cinder encryption-type-show <volume_type> + +Shows encryption type details for volume type. Admin only. + + Positional arguments + + <volume_type> + + + Name or ID of volume type. + + + + +
+
+ cinder endpoints + usage: cinder endpoints + +Discovers endpoints registered by authentication service. + +
+
+ cinder extend + usage: cinder extend <volume> <new-size> + +Attempts to extend size of an existing volume. + + Positional arguments + + <volume> + + + Name or ID of volume to extend. + + + + + <new-size> + + + Size of volume, in GBs. + + + + +
+
+ cinder extra-specs-list + usage: cinder extra-specs-list + +Lists current volume types and extra specs. + +
+
+ cinder force-delete + usage: cinder force-delete <volume> [<volume> ...] + +Attempts force-delete of volume, regardless of state. + + Positional arguments + + <volume> + + + Name or ID of volume to delete. Separate multiple volumes with a + space. + + + + +
+
+ cinder list + usage: cinder list [--all-tenants [<0|1>]] [--display-name <display-name>] + [--status <status>] + [--metadata [<key=value> [<key=value> ...]]] + +Lists all volumes. + + Optional arguments + + --all-tenants [<0|1>] + + + Shows details for all tenants. Admin only. + + + + + --display-name <display-name> + + + Filters list by a volume display name. Default=None. + + + + + --status <status> + + + Filters list by a status. Default=None. + + + + + --metadata [<key=value> [<key=value> ...]] + + + Filters list by metadata key and value pair. + Default=None. + + + + +
+
+ cinder list-extensions + usage: cinder list-extensions + +Lists all available os-api extensions. + +
+
+ cinder metadata + usage: cinder metadata <volume> <action> <key=value> [<key=value> ...] + +Sets or deletes volume metadata. + + Positional arguments + + <volume> + + + Name or ID of volume for which to update metadata. + + + + + <action> + + + The action. Valid values are 'set' or 'unset.' + + + + + <key=value> + + + The metadata key and pair to set or unset. For unset, specify + only the key. Default=[]. + + + + +
+
+ cinder metadata-show + usage: cinder metadata-show <volume> + +Shows volume metadata. + + Positional arguments + + <volume> + + + ID of volume. + + + + +
+
+ cinder metadata-update-all + usage: cinder metadata-update-all <volume> <key=value> [<key=value> ...] + +Updates volume metadata. + + Positional arguments + + <volume> + + + ID of volume for which to update metadata. + + + + + <key=value> + + + Metadata key and value pair or pairs to update. Default=[]. + + + + +
+
+ cinder migrate + usage: cinder migrate [--force-host-copy <True|False>] <volume> <host> + +Migrates volume to a new host. + + Positional arguments + + <volume> + + + ID of volume to migrate. + + + + + <host> + + + Destination host. + + + + + + Optional arguments + + --force-host-copy <True|False> + + + Enables or disables generic host-based force- + migration, which bypasses driver optimizations. + Default=False. + + + + +
+
+ cinder qos-associate + usage: cinder qos-associate <qos_specs> <volume_type_id> + +Associates qos specs with specified volume type. + + Positional arguments + + <qos_specs> + + + ID of QoS specifications. + + + + + <volume_type_id> + + + ID of volume type. + + + + +
+
+ cinder qos-create + usage: cinder qos-create <name> <key=value> [<key=value> ...] + +Creates a qos specs. + + Positional arguments + + <name> + + + Name of new QoS specifications. + + + + + <key=value> + + + Specifications for QoS. + + + + +
+
+ cinder qos-delete + usage: cinder qos-delete [--force <True|False>] <qos_specs> + +Deletes a specified qos specs. + + Positional arguments + + <qos_specs> + + + ID of QoS specifications. + + + + + + Optional arguments + + --force <True|False> + + + Enables or disables deletion of in-use QoS + specifications. Default=False. + + + + +
+
+ cinder qos-disassociate + usage: cinder qos-disassociate <qos_specs> <volume_type_id> + +Disassociates qos specs from specified volume type. + + Positional arguments + + <qos_specs> + + + ID of QoS specifications. + + + + + <volume_type_id> + + + ID of volume type. + + + + +
+
+ cinder qos-disassociate-all + usage: cinder qos-disassociate-all <qos_specs> + +Disassociates qos specs from all associations. + + Positional arguments + + <qos_specs> + + + ID of QoS specifications. + + + + +
+
+ cinder qos-get-association + usage: cinder qos-get-association <qos_specs> + +Gets all associations for specified qos specs. + + Positional arguments + + <qos_specs> + + + ID of QoS specifications. + + + + +
+
+ cinder qos-key + usage: cinder qos-key <qos_specs> <action> key=value [key=value ...] + +Sets or unsets specifications for a qos spec. + + Positional arguments + + <qos_specs> + + + ID of QoS specifications. + + + + + <action> + + + The action. Valid values are 'set' or 'unset.' + + + + + key=value + + + Metadata key and value pair to set or unset. For unset, specify + only the key. + + + + +
+
+ cinder qos-list + usage: cinder qos-list + +Lists qos specs. + +
+
+ cinder qos-show + usage: cinder qos-show <qos_specs> + +Shows a specified qos specs. + + Positional arguments + + <qos_specs> + + + ID of QoS specifications. + + + + +
+
+ cinder quota-class-show + usage: cinder quota-class-show <class> + +Lists quotas for a quota class. + + Positional arguments + + <class> + + + Name of quota class for which to list quotas. + + + + +
+
+ cinder quota-class-update + usage: cinder quota-class-update [--volumes <volumes>] + [--snapshots <snapshots>] + [--gigabytes <gigabytes>] + [--volume-type <volume_type_name>] + <class> + +Updates quotas for a quota class. + + Positional arguments + + <class> + + + Name of quota class for which to set quotas. + + + + + + Optional arguments + + --volumes <volumes> + + + The new "volumes" quota value. Default=None. + + + + + --snapshots <snapshots> + + + The new "snapshots" quota value. Default=None. + + + + + --gigabytes <gigabytes> + + + The new "gigabytes" quota value. Default=None. + + + + + --volume-type <volume_type_name> + + + Volume type. Default=None. + + + + +
+
+ cinder quota-defaults + usage: cinder quota-defaults <tenant_id> + +Lists default quotas for a tenant. + + Positional arguments + + <tenant_id> + + + ID of the tenant for which to list default quotas. + + + + +
+
+ cinder quota-delete + usage: cinder quota-delete <tenant_id> + +Delete the quotas for a tenant. + + Positional arguments + + <tenant_id> + + + UUID of tenant to delete the quotas for. + + + + +
+
+ cinder quota-show + usage: cinder quota-show <tenant_id> + +Lists quotas for a tenant. + + Positional arguments + + <tenant_id> + + + ID of the tenant for which to list quotas. + + + + +
+
+ cinder quota-update + usage: cinder quota-update [--volumes <volumes>] [--snapshots <snapshots>] + [--gigabytes <gigabytes>] + [--volume-type <volume_type_name>] + <tenant_id> + +Updates quotas for a tenant. + + Positional arguments + + <tenant_id> + + + ID of the tenant for which to set quotas. + + + + + + Optional arguments + + --volumes <volumes> + + + The new "volumes" quota value. Default=None. + + + + + --snapshots <snapshots> + + + The new "snapshots" quota value. Default=None. + + + + + --gigabytes <gigabytes> + + + The new "gigabytes" quota value. Default=None. + + + + + --volume-type <volume_type_name> + + + Volume type. Default=None. + + + + +
+
+ cinder quota-usage + usage: cinder quota-usage <tenant_id> + +Lists quota usage for a tenant. + + Positional arguments + + <tenant_id> + + + ID of the tenant for which to list quota usage. + + + + +
+
+ cinder rate-limits + usage: cinder rate-limits + +Lists rate limits for a user. + +
+
+ cinder readonly-mode-update + usage: cinder readonly-mode-update <volume> <True|true|False|false> + +Updates volume read-only access-mode flag. + + Positional arguments + + <volume> + + + ID of volume to update. + + + + + <True|true|False|false> + + + Enables or disables update of volume to read-only + access mode. + + + + +
+
+ cinder rename + usage: cinder rename [--display-description <display-description>] + <volume> [<display-name>] + +Renames a volume. + + Positional arguments + + <volume> + + + Name or ID of volume to rename. + + + + + <display-name> + + + New display name for volume. + + + + + + Optional arguments + + --display-description <display-description> + + + Volume description. Default=None. + + + + +
+
+ cinder reset-state + usage: cinder reset-state [--state <state>] <volume> [<volume> ...] + +Explicitly updates the volume state. + + Positional arguments + + <volume> + + + Name or ID of volume to modify. Separate multiple volumes + with a space. + + + + + + Optional arguments + + --state <state> + + + The state to assign to the volume. Valid values are + "available," "error," "creating," "deleting," or + "error_deleting." Default is "available." + + + + +
+
+ cinder service-disable + usage: cinder service-disable [--reason <reason>] <hostname> <binary> + +Disables the service. + + Positional arguments + + <hostname> + + + Host name. + + + + + <binary> + + + Service binary. + + + + + + Optional arguments + + --reason <reason> + + + Reason for disabling service. + + + + +
+
+ cinder service-enable + usage: cinder service-enable <hostname> <binary> + +Enables the service. + + Positional arguments + + <hostname> + + + Host name. + + + + + <binary> + + + Service binary. + + + + +
+
+ cinder service-list + usage: cinder service-list [--host <hostname>] [--binary <binary>] + +Lists all services. Filter by host and service binary. + + Optional arguments + + --host <hostname> + + + Host name. Default=None. + + + + + --binary <binary> + + + Service binary. Default=None. + + + + +
+
+ cinder set-bootable + usage: cinder set-bootable <volume> <True|true|False|false> + +Update bootable status of a volume. + + Positional arguments + + <volume> + + + ID of the volume to update. + + + + + <True|true|False|false> + + + Flag to indicate whether volume is bootable. + + + + +
+
+ cinder show + usage: cinder show <volume> + +Shows volume details. + + Positional arguments + + <volume> + + + Volume name or ID. + + + + +
+
+ cinder snapshot-create + usage: cinder snapshot-create [--force <True|False>] + [--display-name <display-name>] + [--display-description <display-description>] + <volume> + +Creates a snapshot. + + Positional arguments + + <volume> + + + Name or ID of volume to snapshot. + + + + + + Optional arguments + + --force <True|False> + + + 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 + available. Default=False. + + + + + --display-name <display-name> + + + The snapshot name. Default=None. + + + + + --display-description <display-description> + + + The snapshot description. Default=None. + + + + +
+
+ cinder snapshot-delete + usage: cinder snapshot-delete <snapshot> [<snapshot> ...] + +Remove one or more snapshots. + + Positional arguments + + <snapshot> + + + Name or ID of the snapshot(s) to delete. + + + + +
+
+ cinder snapshot-list + usage: cinder snapshot-list [--all-tenants [<0|1>]] + [--display-name <display-name>] + [--status <status>] [--volume-id <volume-id>] + +Lists all snapshots. + + Optional arguments + + --all-tenants [<0|1>] + + + Shows details for all tenants. Admin only. + + + + + --display-name <display-name> + + + Filters list by a display name. Default=None. + + + + + --status <status> + + + Filters list by a status. Default=None. + + + + + --volume-id <volume-id> + + + Filters list by a volume ID. Default=None. + + + + +
+
+ cinder snapshot-metadata + usage: cinder snapshot-metadata <snapshot> <action> <key=value> + [<key=value> ...] + +Sets or deletes snapshot metadata. + + Positional arguments + + <snapshot> + + + ID of snapshot for which to update metadata. + + + + + <action> + + + The action. Valid values are 'set' or 'unset.' + + + + + <key=value> + + + The metadata key and value pair to set or unset. For unset, + specify only the key. + + + + +
+
+ cinder snapshot-metadata-show + usage: cinder snapshot-metadata-show <snapshot> + +Shows snapshot metadata. + + Positional arguments + + <snapshot> + + + ID of snapshot. + + + + +
+
+ cinder snapshot-metadata-update-all + usage: cinder snapshot-metadata-update-all <snapshot> <key=value> + [<key=value> ...] + +Updates snapshot metadata. + + Positional arguments + + <snapshot> + + + ID of snapshot for which to update metadata. + + + + + <key=value> + + + Metadata key and value pair or pairs to update. Default=[]. + + + + +
+
+ cinder snapshot-rename + usage: cinder snapshot-rename [--display-description <display-description>] + <snapshot> [<display-name>] + +Renames a snapshot. + + Positional arguments + + <snapshot> + + + Name or ID of snapshot. + + + + + <display-name> + + + New display name for snapshot. + + + + + + Optional arguments + + --display-description <display-description> + + + Snapshot description. Default=None. + + + + +
+
+ cinder snapshot-reset-state + usage: cinder snapshot-reset-state [--state <state>] + <snapshot> [<snapshot> ...] + +Explicitly updates the snapshot state. + + Positional arguments + + <snapshot> + + + Name or ID of snapshot to modify. + + + + + + Optional arguments + + --state <state> + + + The state to assign to the snapshot. Valid values are + "available," "error," "creating," "deleting," or + "error_deleting." Default is "available." + + + + +
+
+ cinder snapshot-show + usage: cinder snapshot-show <snapshot> + +Shows snapshot details. + + Positional arguments + + <snapshot> + + + Name or ID of snapshot. + + + + +
+
+ cinder transfer-accept + usage: cinder transfer-accept <transfer> <auth_key> + +Accepts a volume transfer. + + Positional arguments + + <transfer> + + + ID of transfer to accept. + + + + + <auth_key> + + + Authentication key of transfer to accept. + + + + +
+
+ cinder transfer-create + usage: cinder transfer-create [--display-name <display-name>] <volume> + +Creates a volume transfer. + + Positional arguments + + <volume> + + + Name or ID of volume to transfer. + + + + + + Optional arguments + + --display-name <display-name> + + + Transfer name. Default=None. + + + + +
+
+ cinder transfer-delete + usage: cinder transfer-delete <transfer> + +Undoes a transfer. + + Positional arguments + + <transfer> + + + Name or ID of transfer to delete. + + + + +
+
+ cinder transfer-list + usage: cinder transfer-list + +Lists all transfers. + +
+
+ cinder transfer-show + usage: cinder transfer-show <transfer> + +Show transfer details. + + Positional arguments + + <transfer> + + + Name or ID of transfer to accept. + + + + +
+
+ cinder type-create + usage: cinder type-create <name> + +Creates a volume type. + + Positional arguments + + <name> + + + Name for the volume type. + + + + +
+
+ cinder type-delete + usage: cinder type-delete <id> + +Deletes a specified volume type. + + Positional arguments + + <id> + + + ID of volume type to delete. + + + + +
+
+ cinder type-key + usage: cinder type-key <vtype> <action> [<key=value> [<key=value> ...]] + +Sets or unsets extra_spec for a volume type. + + Positional arguments + + <vtype> + + + Name or ID of volume type. + + + + + <action> + + + The action. Valid values are 'set' or 'unset.' + + + + + <key=value> + + + The extra specs key and value pair to set or unset. For unset, + specify only the key. Default=None. + + + + +
+
+ cinder type-list + usage: cinder type-list + +Lists available 'volume types'. + +
+
+ cinder upload-to-image + usage: cinder upload-to-image [--force <True|False>] + [--container-format <container-format>] + [--disk-format <disk-format>] + <volume> <image-name> + +Uploads volume to Image Service as an image. + + Positional arguments + + <volume> + + + Name or ID of volume to upload to an image. + + + + + <image-name> + + + The new image name. + + + + + + Optional arguments + + --force <True|False> + + + Enables or disables upload of a volume that is + attached to an instance. Default=False. + + + + + --container-format <container-format> + + + Container format type. Default is bare. + + + + + --disk-format <disk-format> + + + Disk format type. Default is raw. + + + + +
+
+ +
+ Block Storage API v2 commands + + You can select an API version to use by adding the + --os-volume-api-version option or by setting + the corresponding environment variable: +$ export OS_VOLUME_API_VERSION=2 + +
+ cinder absolute-limits (v2) + usage: cinder --os-volume-api-version 2 absolute-limits + +Lists absolute limits for a user. + +
+
+ cinder availability-zone-list (v2) + usage: cinder --os-volume-api-version 2 availability-zone-list + +Lists all availability zones. + +
+
+ cinder backup-create (v2) + usage: cinder --os-volume-api-version 2 backup-create [--container <container>] [--name <name>] + [--description <description>] + <volume> + +Creates a volume backup. + + Positional arguments + + <volume> + + + Name or ID of volume to backup. + + + + + + Optional arguments + + --container <container> + + + Backup container name. Default=None. + + + + + --name <name> + + + Backup name. Default=None. + + + + + --description <description> + + + Backup description. Default=None. + + + + +
+
+ cinder backup-delete (v2) + usage: cinder --os-volume-api-version 2 backup-delete <backup> + +Removes a backup. + + Positional arguments + + <backup> + + + Name or ID of backup to delete. + + + + +
+
+ cinder backup-export (v2) + usage: cinder --os-volume-api-version 2 backup-export <backup> + +Export backup metadata record. + + Positional arguments + + <backup> + + + ID of the backup to export. + + + + +
+
+ cinder backup-import (v2) + usage: cinder --os-volume-api-version 2 backup-import <backup_service> <backup_url> + +Import backup metadata record. + + Positional arguments + + <backup_service> + + + Backup service to use for importing the backup. + + + + + <backup_url> + + + Backup URL for importing the backup metadata. + + + + +
+
+ cinder backup-list (v2) + usage: cinder --os-volume-api-version 2 backup-list + +Lists all backups. + +
+
+ cinder backup-restore (v2) + usage: cinder --os-volume-api-version 2 backup-restore [--volume <volume>] <backup> + +Restores a backup. + + Positional arguments + + <backup> + + + ID of backup to restore. + + + + + + Optional arguments + + --volume <volume> + + + Name or ID of volume to which to restore. Default=None. + + + + +
+
+ cinder backup-show (v2) + usage: cinder --os-volume-api-version 2 backup-show <backup> + +Shows backup details. + + Positional arguments + + <backup> + + + Name or ID of backup. + + + + +
+
+ cinder cgsnapshot-create (v2) + usage: cinder --os-volume-api-version 2 cgsnapshot-create [--name <name>] [--description <description>] + <consistencygroup> + +Creates a cgsnapshot. + + Positional arguments + + <consistencygroup> + + + Name or ID of a consistency group. + + + + + + Optional arguments + + --name <name> + + + Cgsnapshot name. Default=None. + + + + + --description <description> + + + Cgsnapshot description. Default=None. + + + + +
+
+ cinder cgsnapshot-delete (v2) + usage: cinder --os-volume-api-version 2 cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...] + +Removes one or more cgsnapshots. + + Positional arguments + + <cgsnapshot> + + + Name or ID of one or more cgsnapshots to be deleted. + + + + +
+
+ cinder cgsnapshot-list (v2) + usage: cinder --os-volume-api-version 2 cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>] + [--consistencygroup-id <consistencygroup_id>] + +Lists all cgsnapshots. + + Optional arguments + + --all-tenants [<0|1>] + + + Shows details for all tenants. Admin only. + + + + + --status <status> + + + Filters results by a status. Default=None. + + + + + --consistencygroup-id <consistencygroup_id> + + + Filters results by a consistency group ID. + Default=None. + + + + +
+
+ cinder cgsnapshot-show (v2) + usage: cinder --os-volume-api-version 2 cgsnapshot-show <cgsnapshot> + +Shows cgsnapshot details. + + Positional arguments + + <cgsnapshot> + + + Name or ID of cgsnapshot. + + + + +
+
+ cinder consisgroup-create (v2) + usage: cinder --os-volume-api-version 2 consisgroup-create [--name <name>] [--description <description>] + [--availability-zone <availability-zone>] + <volume-types> + +Creates a consistency group. + + Positional arguments + + <volume-types> + + + Volume types. + + + + + + Optional arguments + + --name <name> + + + Name of a consistency group. + + + + + --description <description> + + + Description of a consistency group. Default=None. + + + + + --availability-zone <availability-zone> + + + Availability zone for volume. Default=None. + + + + +
+
+ cinder consisgroup-delete (v2) + usage: cinder --os-volume-api-version 2 consisgroup-delete [--force] + <consistencygroup> [<consistencygroup> ...] + +Removes one or more consistency groups. + + Positional arguments + + <consistencygroup> + + + Name or ID of one or more consistency groups to be + deleted. + + + + + + Optional arguments + + --force + + + Allows or disallows consistency groups to be deleted. If + the consistency group is empty, it can be deleted + without the force flag. If the consistency group is not + empty, the force flag is required for it to be deleted. + + + + +
+
+ cinder consisgroup-list (v2) + usage: cinder --os-volume-api-version 2 consisgroup-list [--all-tenants [<0|1>]] + +Lists all consistencygroups. + + Optional arguments + + --all-tenants [<0|1>] + + + Shows details for all tenants. Admin only. + + + + +
+
+ cinder consisgroup-show (v2) + usage: cinder --os-volume-api-version 2 consisgroup-show <consistencygroup> + +Shows details of a consistency group. + + Positional arguments + + <consistencygroup> + + + Name or ID of a consistency group. + + + + +
+
+ cinder create (v2) + usage: cinder --os-volume-api-version 2 create [--consisgroup-id <consistencygroup-id>] + [--snapshot-id <snapshot-id>] + [--source-volid <source-volid>] + [--source-replica <source-replica>] + [--image-id <image-id>] [--name <name>] + [--description <description>] + [--volume-type <volume-type>] + [--availability-zone <availability-zone>] + [--metadata [<key=value> [<key=value> ...]]] + [--hint <key=value>] + [<size>] + +Creates a volume. + + Positional arguments + + <size> + + + Size of volume, in GBs. (Required unless snapshot-id + /source-volid is specified). + + + + + + Optional arguments + + --consisgroup-id <consistencygroup-id> + + + ID of a consistency group where the new volume belongs + to. Default=None. + + + + + --snapshot-id <snapshot-id> + + + Creates volume from snapshot ID. Default=None. + + + + + --source-volid <source-volid> + + + Creates volume from volume ID. Default=None. + + + + + --source-replica <source-replica> + + + Creates volume from replicated volume ID. + Default=None. + + + + + --image-id <image-id> + + + Creates volume from image ID. Default=None. + + + + + --name <name> + + + Volume name. Default=None. + + + + + --description <description> + + + Volume description. Default=None. + + + + + --volume-type <volume-type> + + + Volume type. Default=None. + + + + + --availability-zone <availability-zone> + + + Availability zone for volume. Default=None. + + + + + --metadata [<key=value> [<key=value> ...]] + + + Metadata key and value pairs. Default=None. + + + + + --hint <key=value> + + + Scheduler hint, like in nova. + + + + +
+
+ cinder credentials (v2) + usage: cinder --os-volume-api-version 2 credentials + +Shows user credentials returned from auth. + +
+
+ cinder delete (v2) + usage: cinder --os-volume-api-version 2 delete <volume> [<volume> ...] + +Removes one or more volumes. + + Positional arguments + + <volume> + + + Name or ID of volume or volumes to delete. + + + + +
+
+ cinder encryption-type-create (v2) + usage: cinder --os-volume-api-version 2 encryption-type-create [--cipher <cipher>] + [--key_size <key_size>] + [--control_location <control_location>] + <volume_type> <provider> + +Creates encryption type for a volume type. Admin only. + + Positional arguments + + <volume_type> + + + Name or ID of volume type. + + + + + <provider> + + + The class that provides encryption support. For + example, LuksEncryptor. + + + + + + Optional arguments + + --cipher <cipher> + + + The encryption algorithm or mode. For example, aes- + xts-plain64. Default=None. + + + + + --key_size <key_size> + + + Size of encryption key, in bits. For example, 128 or + 256. Default=None. + + + + + --control_location <control_location> + + + Notional service where encryption is performed. Valid + values are "front-end" or "back-end." For example, + front-end=Nova. Default is "front-end." + + + + +
+
+ cinder encryption-type-delete (v2) + usage: cinder --os-volume-api-version 2 encryption-type-delete <volume_type> + +Deletes encryption type for a volume type. Admin only. + + Positional arguments + + <volume_type> + + + Name or ID of volume type. + + + + +
+
+ cinder encryption-type-list (v2) + usage: cinder --os-volume-api-version 2 encryption-type-list + +Shows encryption type details for volume types. Admin only. + +
+
+ cinder encryption-type-show (v2) + usage: cinder --os-volume-api-version 2 encryption-type-show <volume_type> + +Shows encryption type details for a volume type. Admin only. + + Positional arguments + + <volume_type> + + + Name or ID of volume type. + + + + +
+
+ cinder endpoints (v2) + usage: cinder --os-volume-api-version 2 endpoints + +Discovers endpoints registered by authentication service. + +
+
+ cinder extend (v2) + usage: cinder --os-volume-api-version 2 extend <volume> <new_size> + +Attempts to extend size of an existing volume. + + Positional arguments + + <volume> + + + Name or ID of volume to extend. + + + + + <new_size> + + + New size of volume, in GBs. + + + + +
+
+ cinder extra-specs-list (v2) + usage: cinder --os-volume-api-version 2 extra-specs-list + +Lists current volume types and extra specs. + +
+
+ cinder force-delete (v2) + usage: cinder --os-volume-api-version 2 force-delete <volume> [<volume> ...] + +Attempts force-delete of volume, regardless of state. + + Positional arguments + + <volume> + + + Name or ID of volume or volumes to delete. + + + + +
+
+ cinder list (v2) + usage: cinder --os-volume-api-version 2 list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] + [--metadata [<key=value> [<key=value> ...]]] + [--marker <marker>] [--limit <limit>] + [--sort_key <sort_key>] [--sort_dir <sort_dir>] + +Lists all volumes. + + Optional arguments + + --all-tenants [<0|1>] + + + Shows details for all tenants. Admin only. + + + + + --name <name> + + + Filters results by a name. OPTIONAL: Default=None. + + + + + --status <status> + + + Filters results by a status. OPTIONAL: Default=None. + + + + + --metadata [<key=value> [<key=value> ...]] + + + Filters results by a metadata key and value pair. + OPTIONAL: Default=None. + + + + + --marker <marker> + + + Begin returning volumes that appear later in the + volume list than that represented by this volume id. + OPTIONAL: Default=None. + + + + + --limit <limit> + + + Maximum number of volumes to return. OPTIONAL: + Default=None. + + + + + --sort_key <sort_key> + + + Key to be sorted, should be (`id`, `status`, `size`, + `availability_zone`, `name`, `bootable`, + `created_at`). OPTIONAL: Default=None. + + + + + --sort_dir <sort_dir> + + + Sort direction, should be `desc` or `asc`. OPTIONAL: + Default=None. + + + + +
+
+ cinder list-extensions (v2) + usage: cinder --os-volume-api-version 2 list-extensions + +Lists all available os-api extensions. + +
+
+ cinder manage (v2) + usage: cinder --os-volume-api-version 2 manage [--source-name <source-name>] [--source-id <source-id>] + [--name <name>] [--description <description>] + [--volume-type <volume-type>] + [--availability-zone <availability-zone>] + [--metadata [<key=value> [<key=value> ...]]] [--bootable] + <host> [<key=value> [<key=value> ...]] + +Manage an existing volume. + + Positional arguments + + <host> + + + Cinder host on which the existing volume resides + + + + + <key=value> + + + Driver-specific reference to the existing volume as + key=value pairs + + + + + + Optional arguments + + --source-name <source-name> + + + Name of the volume to manage (Optional) + + + + + --source-id <source-id> + + + ID of the volume to manage (Optional) + + + + + --name <name> + + + Volume name (Optional, Default=None) + + + + + --description <description> Volume description (Optional, Default=None) @@ -952,251 +3428,29 @@ Add a new volume. + + --bootable + + + Specifies that the newly created volume should be + marked as bootable + + +
-
- cinder credentials command - usage: cinder credentials +
+ cinder metadata (v2) + usage: cinder --os-volume-api-version 2 metadata <volume> <action> <key=value> [<key=value> ...] -Show user credentials returned from auth. - -
-
- cinder delete command - usage: cinder delete <volume> [<volume> ...] - -Remove volume(s). +Sets or deletes volume metadata. Positional arguments <volume> - Name or ID of the volume(s) to delete. - - - - -
-
- cinder encryption-type-create command - usage: cinder encryption-type-create [--cipher <cipher>] - [--key_size <key_size>] - [--control_location <control_location>] - <volume_type> <provider> - -Create a new encryption type for a volume type (Admin Only). - - Positional arguments - - <volume_type> - - - Name or ID of the volume type - - - - - <provider> - - - Class providing encryption support (e.g. - LuksEncryptor) - - - - - - Optional arguments - - --cipher <cipher> - - - Encryption algorithm/mode to use (e.g., aes-xts- - plain64) (Optional, Default=None) - - - - - --key_size <key_size> - - - Size of the encryption key, in bits (e.g., 128, 256) - (Optional, Default=None) - - - - - --control_location <control_location> - - - Notional service where encryption is performed (e.g., - front-end=Nova) Values: 'front-end', 'back-end' - (Default='front-end') - - - - -
-
- cinder encryption-type-delete command - usage: cinder encryption-type-delete <volume_type> - -Delete the encryption type for a volume type (Admin Only). - - Positional arguments - - <volume_type> - - - Name or ID of the volume type - - - - -
-
- cinder encryption-type-list command - usage: cinder encryption-type-list - -List encryption type information for all volume types (Admin Only). - -
-
- cinder encryption-type-show command - usage: cinder encryption-type-show <volume_type> - -Show the encryption type information for a volume type (Admin Only). - - Positional arguments - - <volume_type> - - - Name or ID of the volume type - - - - -
-
- cinder endpoints command - usage: cinder endpoints - -Discover endpoints that get returned from the authenticate services. - -
-
- cinder extend command - usage: cinder extend <volume> <new-size> - -Attempt to extend the size of an existing volume. - - Positional arguments - - <volume> - - - Name or ID of the volume to extend. - - - - - <new-size> - - - New size of volume in GB - - - - -
-
- cinder extra-specs-list command - usage: cinder extra-specs-list - -Print a list of current 'volume types and extra specs' (Admin Only). - -
-
- cinder force-delete command - usage: cinder force-delete <volume> [<volume> ...] - -Attempt forced removal of volume(s), regardless of the state(s). - - Positional arguments - - <volume> - - - Name or ID of the volume(s) to delete. - - - - -
-
- cinder list command - usage: cinder list [--all-tenants [<0|1>]] [--display-name <display-name>] - [--status <status>] - [--metadata [<key=value> [<key=value> ...]]] - -List all the volumes. - - Optional arguments - - --all-tenants [<0|1>] - - - Display information from all tenants (Admin only). - - - - - --display-name <display-name> - - - Filter results by display-name - - - - - --status <status> - - - Filter results by status - - - - - --metadata [<key=value> [<key=value> ...]] - - - Filter results by metadata - - - - -
-
- cinder list-extensions command - usage: cinder list-extensions - -List all the os-api extensions that are available. - -
-
- cinder metadata command - usage: cinder metadata <volume> <action> <key=value> [<key=value> ...] - -Set or Delete metadata on a volume. - - Positional arguments - - <volume> - - - Name or ID of the volume to update metadata on. + Name or ID of volume for which to update metadata. @@ -1204,7 +3458,7 @@ Set or Delete metadata on a volume. <action> - Actions: 'set' or 'unset' + The action. Valid values are 'set' or 'unset.' @@ -1212,41 +3466,42 @@ Set or Delete metadata on a volume. <key=value> - Metadata to set/unset (only key is necessary on unset) + Metadata key and value pair to set or unset. For unset, specify + only the key.
-
- cinder metadata-show command - usage: cinder metadata-show <volume> +
+ cinder metadata-show (v2) + usage: cinder --os-volume-api-version 2 metadata-show <volume> -Show metadata of given volume. +Shows volume metadata. Positional arguments <volume> - ID of volume + ID of volume.
-
- cinder metadata-update-all command - usage: cinder metadata-update-all <volume> <key=value> [<key=value> ...] +
+ cinder metadata-update-all (v2) + usage: cinder --os-volume-api-version 2 metadata-update-all <volume> <key=value> [<key=value> ...] -Update all metadata of a volume. +Updates volume metadata. Positional arguments <volume> - ID of the volume to update metadata on. + ID of volume for which to update metadata. @@ -1254,24 +3509,24 @@ Update all metadata of a volume. <key=value> - Metadata entry/entries to update. + Metadata key and value pair or pairs to update.
-
- cinder migrate command - usage: cinder migrate [--force-host-copy <True|False>] <volume> <host> +
+ cinder migrate (v2) + usage: cinder --os-volume-api-version 2 migrate [--force-host-copy <True|False>] <volume> <host> -Migrate the volume to the new host. +Migrates volume to a new host. Positional arguments <volume> - ID of the volume to migrate + ID of volume to migrate. @@ -1279,7 +3534,7 @@ Migrate the volume to the new host. <host> - Destination host + Destination host. @@ -1290,26 +3545,26 @@ Migrate the volume to the new host. --force-host-copy <True|False> - Optional flag to force the use of the generic host- - based migration mechanism, bypassing driver - optimizations (Default=False). + Enables or disables generic host-based force- + migration, which bypasses driver optimizations. + Default=False.
-
- cinder qos-associate command - usage: cinder qos-associate <qos_specs> <volume_type_id> +
+ cinder qos-associate (v2) + usage: cinder --os-volume-api-version 2 qos-associate <qos_specs> <volume_type_id> -Associate qos specs with specific volume type. +Associates qos specs with specified volume type. Positional arguments <qos_specs> - ID of qos_specs. + ID of QoS specifications. @@ -1317,24 +3572,25 @@ Associate qos specs with specific volume type. <volume_type_id> - ID of volume type to be associated with. + ID of volume type with which to associate QoS + specifications.
-
- cinder qos-create command - usage: cinder qos-create <name> <key=value> [<key=value> ...] +
+ cinder qos-create (v2) + usage: cinder --os-volume-api-version 2 qos-create <name> <key=value> [<key=value> ...] -Create a new qos specs. +Creates a qos specs. Positional arguments <name> - Name of the new QoS specs + Name of new QoS specifications. @@ -1342,24 +3598,24 @@ Create a new qos specs. <key=value> - Specifications for QoS + QoS specifications.
-
- cinder qos-delete command - usage: cinder qos-delete [--force <True|False>] <qos_specs> +
+ cinder qos-delete (v2) + usage: cinder --os-volume-api-version 2 qos-delete [--force <True|False>] <qos_specs> -Delete a specific qos specs. +Deletes a specified qos specs. Positional arguments <qos_specs> - ID of the qos_specs to delete. + ID of QoS specifications to delete. @@ -1370,25 +3626,25 @@ Delete a specific qos specs. --force <True|False> - Optional flag that indicates whether to delete - specified qos specs even if it is in-use. + Enables or disables deletion of in-use QoS + specifications. Default=False.
-
- cinder qos-disassociate command - usage: cinder qos-disassociate <qos_specs> <volume_type_id> +
+ cinder qos-disassociate (v2) + usage: cinder --os-volume-api-version 2 qos-disassociate <qos_specs> <volume_type_id> -Disassociate qos specs from specific volume type. +Disassociates qos specs from specified volume type. Positional arguments <qos_specs> - ID of qos_specs. + ID of QoS specifications. @@ -1396,58 +3652,59 @@ Disassociate qos specs from specific volume type. <volume_type_id> - ID of volume type to be associated with. + ID of volume type with which to associate QoS + specifications.
-
- cinder qos-disassociate-all command - usage: cinder qos-disassociate-all <qos_specs> +
+ cinder qos-disassociate-all (v2) + usage: cinder --os-volume-api-version 2 qos-disassociate-all <qos_specs> -Disassociate qos specs from all of its associations. +Disassociates qos specs from all its associations. Positional arguments <qos_specs> - ID of qos_specs to be operate on. + ID of QoS specifications on which to operate.
-
- cinder qos-get-association command - usage: cinder qos-get-association <qos_specs> +
+ cinder qos-get-association (v2) + usage: cinder --os-volume-api-version 2 qos-get-association <qos_specs> -Get all associations of specific qos specs. +Lists all associations for specified qos specs. Positional arguments <qos_specs> - ID of the qos_specs. + ID of QoS specifications.
-
- cinder qos-key command - usage: cinder qos-key <qos_specs> <action> key=value [key=value ...] +
+ cinder qos-key (v2) + usage: cinder --os-volume-api-version 2 qos-key <qos_specs> <action> key=value [key=value ...] -Set or unset specifications for a qos spec. +Sets or unsets specifications for a qos spec. Positional arguments <qos_specs> - ID of qos specs + ID of QoS specifications. @@ -1455,7 +3712,7 @@ Set or unset specifications for a qos spec. <action> - Actions: 'set' or 'unset' + The action. Valid values are 'set' or 'unset.' @@ -1463,69 +3720,70 @@ Set or unset specifications for a qos spec. key=value - QoS specs to set/unset (only key is necessary on unset) + Metadata key and value pair to set or unset. For unset, specify + only the key.
-
- cinder qos-list command - usage: cinder qos-list +
+ cinder qos-list (v2) + usage: cinder --os-volume-api-version 2 qos-list -Get full list of qos specs. +Lists qos specs.
-
- cinder qos-show command - usage: cinder qos-show <qos_specs> +
+ cinder qos-show (v2) + usage: cinder --os-volume-api-version 2 qos-show <qos_specs> -Get a specific qos specs. +Shows qos specs details. Positional arguments <qos_specs> - ID of the qos_specs to show. + ID of QoS specifications to show.
-
- cinder quota-class-show command - usage: cinder quota-class-show <class> +
+ cinder quota-class-show (v2) + usage: cinder --os-volume-api-version 2 quota-class-show <class> -List the quotas for a quota class. +Lists quotas for a quota class. Positional arguments <class> - Name of quota class to list the quotas for. + Name of quota class for which to list quotas.
-
- cinder quota-class-update command - usage: cinder quota-class-update [--volumes <volumes>] +
+ cinder quota-class-update (v2) + usage: cinder --os-volume-api-version 2 quota-class-update [--volumes <volumes>] [--snapshots <snapshots>] [--gigabytes <gigabytes>] [--volume-type <volume_type_name>] - <class> + <class-name> -Update the quotas for a quota class. +Updates quotas for a quota class. Positional arguments - <class> + <class-name> - Name of quota class to set the quotas for. + Name of quota class for which to set quotas. @@ -1536,7 +3794,7 @@ Update the quotas for a quota class. --volumes <volumes> - New value for the "volumes" quota. + The new "volumes" quota value. Default=None. @@ -1544,7 +3802,7 @@ Update the quotas for a quota class. --snapshots <snapshots> - New value for the "snapshots" quota. + The new "snapshots" quota value. Default=None. @@ -1552,7 +3810,7 @@ Update the quotas for a quota class. --gigabytes <gigabytes> - New value for the "gigabytes" quota. + The new "gigabytes" quota value. Default=None. @@ -1560,32 +3818,32 @@ Update the quotas for a quota class. --volume-type <volume_type_name> - Volume type (Optional, Default=None) + Volume type. Default=None.
-
- cinder quota-defaults command - usage: cinder quota-defaults <tenant_id> +
+ cinder quota-defaults (v2) + usage: cinder --os-volume-api-version 2 quota-defaults <tenant_id> -List the default quotas for a tenant. +Lists default quotas for a tenant. Positional arguments <tenant_id> - UUID of tenant to list the default quotas for. + ID of tenant for which to list quota defaults.
-
- cinder quota-delete command - usage: cinder quota-delete <tenant_id> +
+ cinder quota-delete (v2) + usage: cinder --os-volume-api-version 2 quota-delete <tenant_id> Delete the quotas for a tenant. @@ -1600,38 +3858,38 @@ Delete the quotas for a tenant.
-
- cinder quota-show command - usage: cinder quota-show <tenant_id> +
+ cinder quota-show (v2) + usage: cinder --os-volume-api-version 2 quota-show <tenant_id> -List the quotas for a tenant. +Lists quotas for a tenant. Positional arguments <tenant_id> - UUID of tenant to list the quotas for. + ID of tenant for which to list quotas.
-
- cinder quota-update command - usage: cinder quota-update [--volumes <volumes>] [--snapshots <snapshots>] +
+ cinder quota-update (v2) + usage: cinder --os-volume-api-version 2 quota-update [--volumes <volumes>] [--snapshots <snapshots>] [--gigabytes <gigabytes>] [--volume-type <volume_type_name>] <tenant_id> -Update the quotas for a tenant. +Updates quotas for a tenant. Positional arguments <tenant_id> - UUID of tenant to set the quotas for. + ID of tenant for which to set quotas. @@ -1642,7 +3900,7 @@ Update the quotas for a tenant. --volumes <volumes> - New value for the "volumes" quota. + The new "volumes" quota value. Default=None. @@ -1650,7 +3908,7 @@ Update the quotas for a tenant. --snapshots <snapshots> - New value for the "snapshots" quota. + The new "snapshots" quota value. Default=None. @@ -1658,7 +3916,7 @@ Update the quotas for a tenant. --gigabytes <gigabytes> - New value for the "gigabytes" quota. + The new "gigabytes" quota value. Default=None. @@ -1666,48 +3924,48 @@ Update the quotas for a tenant. --volume-type <volume_type_name> - Volume type (Optional, Default=None) + Volume type. Default=None.
-
- cinder quota-usage command - usage: cinder quota-usage <tenant_id> +
+ cinder quota-usage (v2) + usage: cinder --os-volume-api-version 2 quota-usage <tenant_id> -List the quota usage for a tenant. +Lists quota usage for a tenant. Positional arguments <tenant_id> - UUID of tenant to list the quota usage for. + ID of tenant for which to list quota usage.
-
- cinder rate-limits command - usage: cinder rate-limits +
+ cinder rate-limits (v2) + usage: cinder --os-volume-api-version 2 rate-limits -Print a list of rate limits for a user +Lists rate limits for a user.
-
- cinder readonly-mode-update command - usage: cinder readonly-mode-update <volume> <True|true|False|false> +
+ cinder readonly-mode-update (v2) + usage: cinder --os-volume-api-version 2 readonly-mode-update <volume> <True|true|False|false> -Update volume read-only access mode read_only. +Updates volume read-only access-mode flag. Positional arguments <volume> - ID of the volume to update. + ID of volume to update. @@ -1715,34 +3973,33 @@ Update volume read-only access mode read_only. <True|true|False|false> - Flag to indicate whether to update volume to read-only + Enables or disables update of volume to read-only access mode.
-
- cinder rename command - usage: cinder rename [--display-description <display-description>] - <volume> [<display-name>] +
+ cinder rename (v2) + usage: cinder --os-volume-api-version 2 rename [--description <description>] <volume> [<name>] -Rename a volume. +Renames a volume. Positional arguments <volume> - Name or ID of the volume to rename. + Name or ID of volume to rename. - <display-name> + <name> - New display-name for the volume. + New name for volume. @@ -1750,27 +4007,61 @@ Rename a volume. Optional arguments - --display-description <display-description> + --description <description> - Optional volume description. (Default=None) + Volume description. Default=None.
-
- cinder reset-state command - usage: cinder reset-state [--state <state>] <volume> [<volume> ...] +
+ cinder replication-promote (v2) + usage: cinder --os-volume-api-version 2 replication-promote <volume> -Explicitly update the state of a volume. +Promote a secondary volume to primary for a relationship. Positional arguments <volume> - Name or ID of the volume to modify. + Name or ID of the volume to promote. + + + + +
+
+ cinder replication-reenable (v2) + usage: cinder --os-volume-api-version 2 replication-reenable <volume> + +Sync the secondary volume with primary for a relationship. + + Positional arguments + + <volume> + + + Name or ID of the volume to reenable replication. + + + + +
+
+ cinder reset-state (v2) + usage: cinder --os-volume-api-version 2 reset-state [--state <state>] <volume> [<volume> ...] + +Explicitly updates the volume state. + + Positional arguments + + <volume> + + + Name or ID of volume to modify. @@ -1781,26 +4072,63 @@ Explicitly update the state of a volume. --state <state> - Indicate which state to assign the volume. Options include - available, error, creating, deleting, error_deleting. If no - state is provided, available will be used. + The state to assign to the volume. Valid values are + "available," "error," "creating," "deleting," and + "error_deleting." Default=available.
-
- cinder service-disable command - usage: cinder service-disable [--reason <reason>] <hostname> <binary> +
+ cinder retype (v2) + usage: cinder --os-volume-api-version 2 retype [--migration-policy <never|on-demand>] + <volume> <volume-type> -Disable the service. +Changes the volume type for a volume. + + Positional arguments + + <volume> + + + Name or ID of volume for which to modify type. + + + + + <volume-type> + + + New volume type. + + + + + + Optional arguments + + --migration-policy <never|on-demand> + + + Migration policy during retype of volume. + + + + +
+
+ cinder service-disable (v2) + usage: cinder --os-volume-api-version 2 service-disable [--reason <reason>] <hostname> <binary> + +Disables the service. Positional arguments <hostname> - Name of host. + Host name. @@ -1825,18 +4153,18 @@ Disable the service.
-
- cinder service-enable command - usage: cinder service-enable <hostname> <binary> +
+ cinder service-enable (v2) + usage: cinder --os-volume-api-version 2 service-enable <hostname> <binary> -Enable the service. +Enables the service. Positional arguments <hostname> - Name of host. + Host name. @@ -1850,18 +4178,18 @@ Enable the service.
-
- cinder service-list command - usage: cinder service-list [--host <hostname>] [--binary <binary>] +
+ cinder service-list (v2) + usage: cinder --os-volume-api-version 2 service-list [--host <hostname>] [--binary <binary>] -List all the services. Filter by host & service binary. +Lists all services. Filter by host and service binary. Optional arguments --host <hostname> - Name of host. + Host name. Default=None. @@ -1869,44 +4197,68 @@ List all the services. Filter by host & service binary. --binary <binary> - Service binary. + Service binary. Default=None.
-
- cinder show command - usage: cinder show <volume> +
+ cinder set-bootable (v2) + usage: cinder --os-volume-api-version 2 set-bootable <volume> <True|true|False|false> -Show details about a volume. +Update bootable status of a volume. Positional arguments <volume> - Name or ID of the volume. + ID of the volume to update. + + + + + <True|true|False|false> + + + Flag to indicate whether volume is bootable.
-
- cinder snapshot-create command - usage: cinder snapshot-create [--force <True|False>] - [--display-name <display-name>] - [--display-description <display-description>] +
+ cinder show (v2) + usage: cinder --os-volume-api-version 2 show <volume> + +Shows volume details. + + Positional arguments + + <volume> + + + Name or ID of volume. + + + + +
+
+ cinder snapshot-create (v2) + usage: cinder --os-volume-api-version 2 snapshot-create [--force <True|False>] [--name <name>] + [--description <description>] <volume> -Add a new snapshot. +Creates a snapshot. Positional arguments <volume> - Name or ID of the volume to snapshot + Name or ID of volume to snapshot. @@ -1917,34 +4269,37 @@ Add a new snapshot. --force <True|False> - Optional flag to indicate whether to snapshot a volume - even if it's attached to an instance. (Default=False) + 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 + available. Default=False. - --display-name <display-name> + --name <name> - Optional snapshot name. (Default=None) + Snapshot name. Default=None. - --display-description <display-description> + --description <description> - Optional snapshot description. (Default=None) + Snapshot description. Default=None.
-
- cinder snapshot-delete command - usage: cinder snapshot-delete <snapshot> [<snapshot> ...] +
+ cinder snapshot-delete (v2) + usage: cinder --os-volume-api-version 2 snapshot-delete <snapshot> [<snapshot> ...] -Remove one or more snapshots. +Removes one or more snapshots. Positional arguments @@ -1957,28 +4312,27 @@ Remove one or more snapshots.
-
- cinder snapshot-list command - usage: cinder snapshot-list [--all-tenants [<0|1>]] - [--display-name <display-name>] +
+ 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>] -List all the snapshots. +Lists all snapshots. Optional arguments --all-tenants [<0|1>] - Display information from all tenants (Admin only). + Shows details for all tenants. Admin only. - --display-name <display-name> + --name <name> - Filter results by display-name + Filters results by a name. Default=None. @@ -1986,7 +4340,7 @@ List all the snapshots. --status <status> - Filter results by status + Filters results by a status. Default=None. @@ -1994,25 +4348,25 @@ List all the snapshots. --volume-id <volume-id> - Filter results by volume-id + Filters results by a volume ID. Default=None.
-
- cinder snapshot-metadata command - usage: cinder snapshot-metadata <snapshot> <action> <key=value> +
+ cinder snapshot-metadata (v2) + usage: cinder --os-volume-api-version 2 snapshot-metadata <snapshot> <action> <key=value> [<key=value> ...] -Set or Delete metadata of a snapshot. +Sets or deletes snapshot metadata. Positional arguments <snapshot> - ID of the snapshot to update metadata on. + ID of snapshot for which to update metadata. @@ -2020,7 +4374,7 @@ Set or Delete metadata of a snapshot. <action> - Actions: 'set' or 'unset' + The action. Valid values are 'set' or 'unset.' @@ -2028,42 +4382,43 @@ Set or Delete metadata of a snapshot. <key=value> - Metadata to set/unset (only key is necessary on unset) + Metadata key and value pair to set or unset. For unset, specify + only the key.
-
- cinder snapshot-metadata-show command - usage: cinder snapshot-metadata-show <snapshot> +
+ cinder snapshot-metadata-show (v2) + usage: cinder --os-volume-api-version 2 snapshot-metadata-show <snapshot> -Show metadata of given snapshot. +Shows snapshot metadata. Positional arguments <snapshot> - ID of snapshot + ID of snapshot.
-
- cinder snapshot-metadata-update-all command - usage: cinder snapshot-metadata-update-all <snapshot> <key=value> +
+ cinder snapshot-metadata-update-all (v2) + usage: cinder --os-volume-api-version 2 snapshot-metadata-update-all <snapshot> <key=value> [<key=value> ...] -Update all metadata of a snapshot. +Updates snapshot metadata. Positional arguments <snapshot> - ID of the snapshot to update metadata on. + ID of snapshot for which to update metadata. @@ -2071,33 +4426,33 @@ Update all metadata of a snapshot. <key=value> - Metadata entry/entries to update. + Metadata key and value pair to update.
-
- cinder snapshot-rename command - usage: cinder snapshot-rename [--display-description <display-description>] - <snapshot> [<display-name>] +
+ cinder snapshot-rename (v2) + usage: cinder --os-volume-api-version 2 snapshot-rename [--description <description>] + <snapshot> [<name>] -Rename a snapshot. +Renames a snapshot. Positional arguments <snapshot> - Name or ID of the snapshot. + Name or ID of snapshot. - <display-name> + <name> - New display-name for the snapshot. + New name for snapshot. @@ -2105,28 +4460,28 @@ Rename a snapshot. Optional arguments - --display-description <display-description> + --description <description> - Optional snapshot description. (Default=None) + Snapshot description. Default=None.
-
- cinder snapshot-reset-state command - usage: cinder snapshot-reset-state [--state <state>] +
+ cinder snapshot-reset-state (v2) + usage: cinder --os-volume-api-version 2 snapshot-reset-state [--state <state>] <snapshot> [<snapshot> ...] -Explicitly update the state of a snapshot. +Explicitly updates the snapshot state. Positional arguments <snapshot> - Name or ID of the snapshot to modify. + Name or ID of snapshot to modify. @@ -2137,35 +4492,34 @@ Explicitly update the state of a snapshot. --state <state> - Indicate which state to assign the snapshot. Options - include available, error, creating, deleting, - error_deleting. If no state is provided, available will be - used. + The state to assign to the snapshot. Valid values are + "available," "error," "creating," "deleting," and + "error_deleting." Default is "available."
-
- cinder snapshot-show command - usage: cinder snapshot-show <snapshot> +
+ cinder snapshot-show (v2) + usage: cinder --os-volume-api-version 2 snapshot-show <snapshot> -Show details about a snapshot. +Shows snapshot details. Positional arguments <snapshot> - Name or ID of the snapshot. + Name or ID of snapshot.
-
- cinder transfer-accept command - usage: cinder transfer-accept <transfer> <auth_key> +
+ cinder transfer-accept (v2) + usage: cinder --os-volume-api-version 2 transfer-accept <transfer> <auth_key> Accepts a volume transfer. @@ -2174,7 +4528,7 @@ Accepts a volume transfer. <transfer> - ID of the transfer to accept. + ID of transfer to accept. @@ -2182,15 +4536,15 @@ Accepts a volume transfer. <auth_key> - Auth key of the transfer to accept. + Authentication key of transfer to accept.
-
- cinder transfer-create command - usage: cinder transfer-create [--display-name <display-name>] <volume> +
+ cinder transfer-create (v2) + usage: cinder --os-volume-api-version 2 transfer-create [--name <name>] <volume> Creates a volume transfer. @@ -2199,7 +4553,7 @@ Creates a volume transfer. <volume> - Name or ID of the volume to transfer. + Name or ID of volume to transfer. @@ -2207,102 +4561,102 @@ Creates a volume transfer. Optional arguments - --display-name <display-name> + --name <name> - Optional transfer name. (Default=None) + Transfer name. Default=None.
-
- cinder transfer-delete command - usage: cinder transfer-delete <transfer> +
+ cinder transfer-delete (v2) + usage: cinder --os-volume-api-version 2 transfer-delete <transfer> -Undo a transfer. +Undoes a transfer. Positional arguments <transfer> - Name or ID of the transfer to delete. + Name or ID of transfer to delete.
-
- cinder transfer-list command - usage: cinder transfer-list +
+ cinder transfer-list (v2) + usage: cinder --os-volume-api-version 2 transfer-list -List all the transfers. +Lists all transfers.
-
- cinder transfer-show command - usage: cinder transfer-show <transfer> +
+ cinder transfer-show (v2) + usage: cinder --os-volume-api-version 2 transfer-show <transfer> -Show details about a transfer. +Shows transfer details. Positional arguments <transfer> - Name or ID of the transfer to accept. + Name or ID of transfer to accept.
-
- cinder type-create command - usage: cinder type-create <name> +
+ cinder type-create (v2) + usage: cinder --os-volume-api-version 2 type-create <name> -Create a new volume type. +Creates a volume type. Positional arguments <name> - Name of the new volume type + Name of new volume type.
-
- cinder type-delete command - usage: cinder type-delete <id> +
+ cinder type-delete (v2) + usage: cinder --os-volume-api-version 2 type-delete <id> -Delete a specific volume type. +Deletes a volume type. Positional arguments <id> - Name or ID of the volume type to delete + ID of volume type to delete.
-
- cinder type-key command - usage: cinder type-key <vtype> <action> [<key=value> [<key=value> ...]] +
+ cinder type-key (v2) + usage: cinder --os-volume-api-version 2 type-key <vtype> <action> <key=value> [<key=value> ...] -Set or unset extra_spec for a volume type. +Sets or unsets extra_spec for a volume type. Positional arguments <vtype> - Name or ID of the volume type + Name or ID of volume type. @@ -2310,7 +4664,7 @@ Set or unset extra_spec for a volume type. <action> - Actions: 'set' or 'unset' + The action. Valid values are 'set' or 'unset.' @@ -2318,34 +4672,51 @@ Set or unset extra_spec for a volume type. <key=value> - Extra_specs to set/unset (only key is necessary on unset) + The extra specs key and value pair to set or unset. For unset, + specify only the key.
-
- cinder type-list command - usage: cinder type-list +
+ cinder type-list (v2) + usage: cinder --os-volume-api-version 2 type-list -Print a list of available 'volume types'. +Lists available 'volume types'.
-
- cinder upload-to-image command - usage: cinder upload-to-image [--force <True|False>] - [--container-format <container-format>] - [--disk-format <disk-format>] - <volume> <image-name> +
+ cinder unmanage (v2) + usage: cinder --os-volume-api-version 2 unmanage <volume> -Upload volume to image service as image. Positional arguments <volume> - Name or ID of the volume to upload to an image + Name or ID of the volume to unmanage. + + + + +
+
+ cinder upload-to-image (v2) + usage: cinder --os-volume-api-version 2 upload-to-image [--force <True|False>] + [--container-format <container-format>] + [--disk-format <disk-format>] + <volume> <image-name> + +Uploads volume to Image Service as an image. + + Positional arguments + + <volume> + + + Name or ID of volume to snapshot. @@ -2353,7 +4724,7 @@ Upload volume to image service as image. <image-name> - Name for created image + The new image name. @@ -2364,8 +4735,8 @@ Upload volume to image service as image. --force <True|False> - Optional flag to indicate whether to upload a volume - even if it's attached to an instance. (Default=False) + Enables or disables upload of a volume that is + attached to an instance. Default=False. @@ -2373,7 +4744,7 @@ Upload volume to image service as image. --container-format <container-format> - Optional type for container format (Default=bare) + Container format type. Default is bare. @@ -2381,10 +4752,11 @@ Upload volume to image service as image. --disk-format <disk-format> - Optional type for disk format (Default=raw) + Disk format type. Default is raw.
+