From 9aed6fb195179b2f045a24b895783f13de4991de Mon Sep 17 00:00:00 2001 From: KATO Tomoyuki Date: Tue, 12 Jan 2016 07:34:05 +0900 Subject: [PATCH] Update CLI reference for python-cinderclient Change-Id: Idf3b26dccfad7c10010dacee4f68686f733f0fcc Implements: blueprint cli-ref-rst --- doc/cli-ref-rst/source/cinder.rst | 5147 +++++++++++++++++++++++++++++ doc/cli-ref-rst/source/index.rst | 1 + 2 files changed, 5148 insertions(+) create mode 100644 doc/cli-ref-rst/source/cinder.rst diff --git a/doc/cli-ref-rst/source/cinder.rst b/doc/cli-ref-rst/source/cinder.rst new file mode 100644 index 0000000000..183ad6c46f --- /dev/null +++ b/doc/cli-ref-rst/source/cinder.rst @@ -0,0 +1,5147 @@ +.. This file is automatically generated, do not edit + +========================================= +Block Storage service command-line client +========================================= + +The cinder client is the command-line interface (CLI) for +the Block Storage service API and its extensions. + +This chapter documents :command:`cinder` version ``1.5.0``. + +For help on a specific :command:`cinder` command, enter: + +.. code-block:: console + + $ cinder help COMMAND + +.. _cinder_command_usage: + +cinder usage +~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder [--version] [-d] [--os-auth-system ] + [--service-type ] [--service-name ] + [--volume-service-name ] + [--os-endpoint-type ] + [--endpoint-type ] + [--os-volume-api-version ] + [--bypass-url ] [--retries ] + [--os-auth-strategy ] + [--os-username ] [--os-password ] + [--os-tenant-name ] + [--os-tenant-id ] [--os-auth-url ] + [--os-user-id ] + [--os-user-domain-id ] + [--os-user-domain-name ] + [--os-project-id ] + [--os-project-name ] + [--os-project-domain-id ] + [--os-project-domain-name ] + [--os-region-name ] [--os-token ] + [--os-url ] [--insecure] [--os-cacert ] + [--os-cert ] [--os-key ] [--timeout ] + ... + +Subcommands +----------- + +``absolute-limits`` + Lists absolute limits for a user. + +``availability-zone-list`` + Lists all availability zones. + +``backup-create`` + Creates a volume backup. + +``backup-delete`` + Removes a backup. + +``backup-export`` + Export backup metadata record. + +``backup-import`` + Import backup metadata record. + +``backup-list`` + Lists all backups. + +``backup-reset-state`` + Explicitly updates the backup state. + +``backup-restore`` + Restores a backup. + +``backup-show`` + Shows backup details. + +``cgsnapshot-create`` + Creates a cgsnapshot. + +``cgsnapshot-delete`` + Removes one or more cgsnapshots. + +``cgsnapshot-list`` + Lists all cgsnapshots. + +``cgsnapshot-show`` + Shows cgsnapshot details. + +``consisgroup-create`` + Creates a consistency group. + +``consisgroup-create-from-src`` + Creates a consistency group from a cgsnapshot or a + source CG. + +``consisgroup-delete`` + Removes one or more consistency groups. + +``consisgroup-list`` + Lists all consistencygroups. + +``consisgroup-show`` + Shows details of a consistency group. + +``consisgroup-update`` + Updates a consistencygroup. + +``create`` + Creates a volume. + +``credentials`` + Shows user credentials returned from auth. + +``delete`` + Removes one or more volumes. + +``encryption-type-create`` + Creates encryption type for a volume type. Admin only. + +``encryption-type-delete`` + Deletes encryption type for a volume type. Admin only. + +``encryption-type-list`` + Shows encryption type details for volume types. Admin + only. + +``encryption-type-show`` + Shows encryption type details for a volume type. Admin + only. + +``encryption-type-update`` + Update encryption type information for a volume type + (Admin Only). + +``endpoints`` + Discovers endpoints registered by authentication + service. + +``extend`` + Attempts to extend size of an existing volume. + +``extra-specs-list`` + Lists current volume types and extra specs. + +``force-delete`` + Attempts force-delete of volume, regardless of state. + +``get-capabilities`` + Show backend volume stats and properties. Admin only. + +``get-pools`` + Show pool information for backends. Admin only. + +``image-metadata`` + Sets or deletes volume image metadata. + +``image-metadata-show`` + Shows volume image metadata. + +``list`` + Lists all volumes. + +``manage`` + Manage an existing volume. + +``metadata`` + Sets or deletes volume metadata. + +``metadata-show`` + Shows volume metadata. + +``metadata-update-all`` + Updates volume metadata. + +``migrate`` + Migrates volume to a new host. + +``qos-associate`` + Associates qos specs with specified volume type. + +``qos-create`` + Creates a qos specs. + +``qos-delete`` + Deletes a specified qos specs. + +``qos-disassociate`` + Disassociates qos specs from specified volume type. + +``qos-disassociate-all`` + Disassociates qos specs from all its associations. + +``qos-get-association`` + Lists all associations for specified qos specs. + +``qos-key`` + Sets or unsets specifications for a qos spec. + +``qos-list`` + Lists qos specs. + +``qos-show`` + Shows qos specs details. + +``quota-class-show`` + Lists quotas for a quota class. + +``quota-class-update`` + Updates quotas for a quota class. + +``quota-defaults`` + Lists default quotas for a tenant. + +``quota-delete`` + Delete the quotas for a tenant. + +``quota-show`` + Lists quotas for a tenant. + +``quota-update`` + Updates quotas for a tenant. + +``quota-usage`` + Lists quota usage for a tenant. + +``rate-limits`` + Lists rate limits for a user. + +``readonly-mode-update`` + Updates volume read-only access-mode flag. + +``rename`` + Renames a volume. + +``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`` + Promote a secondary volume to primary for a + relationship. + +``replication-reenable`` + Sync the secondary volume with primary for a + relationship. + +``reset-state`` + Explicitly updates the volume state in the Cinder + database. + +``retype`` + Changes the volume type for a volume. + +``service-disable`` + Disables the service. + +``service-enable`` + Enables the service. + +``service-list`` + Lists all services. Filter by host and service binary. + +``set-bootable`` + Update bootable status of a volume. + +``show`` + Shows volume details. + +``snapshot-create`` + Creates a snapshot. + +``snapshot-delete`` + Removes one or more snapshots. + +``snapshot-list`` + Lists all snapshots. + +``snapshot-metadata`` + Sets or deletes snapshot metadata. + +``snapshot-metadata-show`` + Shows snapshot metadata. + +``snapshot-metadata-update-all`` + Updates snapshot metadata. + +``snapshot-rename`` + Renames a snapshot. + +``snapshot-reset-state`` + Explicitly updates the snapshot state. + +``snapshot-show`` + Shows snapshot details. + +``transfer-accept`` + Accepts a volume transfer. + +``transfer-create`` + Creates a volume transfer. + +``transfer-delete`` + Undoes a transfer. + +``transfer-list`` + Lists all transfers. + +``transfer-show`` + Shows transfer details. + +``type-access-add`` + Adds volume type access for the given project. + +``type-access-list`` + Print access information about the given volume type. + +``type-access-remove`` + Removes volume type access for the given project. + +``type-create`` + Creates a volume type. + +``type-default`` + List the default volume type. + +``type-delete`` + Deletes a volume type. + +``type-key`` + Sets or unsets extra_spec for a volume type. + +``type-list`` + Lists available 'volume types'. (Admin only will see + private types) + +``type-show`` + Show volume type details. + +``type-update`` + Updates volume type name ,description and/or + is_public. + +``unmanage`` + Stop managing a volume. + +``upload-to-image`` + Uploads volume to Image Service as an image. + +``bash-completion`` + Prints arguments for bash_completion. + +``help`` + Shows help about this program or one of its + subcommands. + +``list-extensions`` + Lists all available os-api extensions. + +.. _cinder_command_options: + +cinder optional arguments +~~~~~~~~~~~~~~~~~~~~~~~~~ + +``--version`` + show program's version number and exit + +``-d, --debug`` + Shows debugging output. + +``--os-auth-system `` + Defaults to ``env[OS_AUTH_SYSTEM]``. + +``--service-type `` + Service type. For most actions, default is volume. + +``--service-name `` + Service name. Default= ``env[CINDER_SERVICE_NAME]``. + +``--volume-service-name `` + Volume service name. + Default= ``env[CINDER_VOLUME_SERVICE_NAME]``. + +``--os-endpoint-type `` + Endpoint type, which is publicURL or internalURL. + Default= ``env[OS_ENDPOINT_TYPE]`` or nova + ``env[CINDER_ENDPOINT_TYPE]`` or publicURL. + +``--endpoint-type `` + **DEPRECATED!** Use :option:`--os-endpoint-type`. + +``--os-volume-api-version `` + Block Storage API version. Valid values are 1 or 2. + Default= ``env[OS_VOLUME_API_VERSION]``. + +``--bypass-url `` + Use this API endpoint instead of the Service Catalog. + Defaults to ``env[CINDERCLIENT_BYPASS_URL]``. + +``--retries `` + Number of retries. + +``--os-auth-strategy `` + Authentication strategy (Env: OS_AUTH_STRATEGY, + default keystone). For now, any other value will + disable the authentication. + +``--os-username `` + OpenStack user name. Default= ``env[OS_USERNAME]``. + +``--os-password `` + Password for OpenStack user. Default= ``env[OS_PASSWORD]``. + +``--os-tenant-name `` + Tenant name. Default= ``env[OS_TENANT_NAME]``. + +``--os-tenant-id `` + ID for the tenant. Default= ``env[OS_TENANT_ID]``. + +``--os-auth-url `` + URL for the authentication service. + Default= ``env[OS_AUTH_URL]``. + +``--os-user-id `` + Authentication user ID (Env: OS_USER_ID). + +``--os-user-domain-id `` + OpenStack user domain ID. Defaults to + ``env[OS_USER_DOMAIN_ID]``. + +``--os-user-domain-name `` + OpenStack user domain name. Defaults to + ``env[OS_USER_DOMAIN_NAME]``. + +``--os-project-id `` + Another way to specify tenant ID. This option is + mutually exclusive with :option:`--os-tenant-id`. Defaults to + ``env[OS_PROJECT_ID]``. + +``--os-project-name `` + Another way to specify tenant name. This option is + mutually exclusive with :option:`--os-tenant-name`. Defaults to + ``env[OS_PROJECT_NAME]``. + +``--os-project-domain-id `` + Defaults to ``env[OS_PROJECT_DOMAIN_ID]``. + +``--os-project-domain-name `` + Defaults to ``env[OS_PROJECT_DOMAIN_NAME]``. + +``--os-region-name `` + Region name. Default= ``env[OS_REGION_NAME]``. + +``--os-token `` + Defaults to ``env[OS_TOKEN]``. + +``--os-url `` + Defaults to ``env[OS_URL]``. + +``--insecure`` + Explicitly allow client to perform "insecure" TLS + (https) requests. The server's certificate will not be + verified against any certificate authorities. This + option should be used with caution. + +``--os-cacert `` + Specify a CA bundle file to use in verifying a TLS + (https) server certificate. Defaults to + ``env[OS_CACERT]``. + +``--os-cert `` + Defaults to ``env[OS_CERT]``. + +``--os-key `` + Defaults to ``env[OS_KEY]``. + +``--timeout `` + Set request timeout (in seconds). + +Block Storage API v1 commands +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. _cinder_absolute-limits: + +cinder absolute-limits +~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder absolute-limits + +Lists absolute limits for a user. + +.. _cinder_availability-zone-list: + +cinder availability-zone-list +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder availability-zone-list + +Lists all availability zones. + +.. _cinder_backup-create: + +cinder backup-create +~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder backup-create [--container ] [--name ] + [--description ] [--incremental] + [--force] + + +Creates a volume backup. + +Positional arguments +-------------------- + +```` + Name or ID of volume to backup. + +Optional arguments +------------------ + +``--container `` + Backup container name. Default=None. + +``--name `` + Backup name. Default=None. + +``--description `` + Backup description. Default=None. + +``--incremental`` + Incremental backup. Default=False. + +``--force`` + Allows or disallows backup of a volume when the volume + is attached to an instance. If set to True, backs up + the volume whether its status is "available" or "in- + use". The backup of an "in-use" volume means your data + is crash consistent. Default=False. + +.. _cinder_backup-delete: + +cinder backup-delete +~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder backup-delete + +Removes a backup. + +Positional arguments +-------------------- + +```` + Name or ID of backup to delete. + +.. _cinder_backup-export: + +cinder backup-export +~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder backup-export + +Export backup metadata record. + +Positional arguments +-------------------- + +```` + ID of the backup to export. + +.. _cinder_backup-import: + +cinder backup-import +~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder backup-import + +Import backup metadata record. + +Positional arguments +-------------------- + +```` + Backup service to use for importing the backup. + +```` + Backup URL for importing the backup metadata. + +.. _cinder_backup-list: + +cinder backup-list +~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder backup-list [--all-tenants []] [--name ] + [--status ] [--volume-id ] + [--marker ] [--limit ] + [--sort [:]] + +Lists all backups. + +Optional arguments +------------------ + +``--all-tenants []`` + Shows details for all tenants. Admin only. + +``--name `` + Filters results by a name. Default=None. + +``--status `` + Filters results by a status. Default=None. + +``--volume-id `` + Filters results by a volume ID. Default=None. + +``--marker `` + Begin returning backups that appear later in the + backup list than that represented by this id. + Default=None. + +``--limit `` + Maximum number of backups to return. Default=None. + +``--sort [:]`` + Comma-separated list of sort keys and directions in + the form of [:]. Valid keys: id, + status, size, availability_zone, name, bootable, + created_at. Default=None. + +.. _cinder_backup-reset-state: + +cinder backup-reset-state +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder backup-reset-state [--state ] [ ...] + +Explicitly updates the backup state. + +Positional arguments +-------------------- + +```` + Name or ID of the backup to modify. + +Optional arguments +------------------ + +``--state `` + The state to assign to the backup. Valid values are + "available", "error", "creating", "deleting", and + "error_deleting". Default=available. + +.. _cinder_backup-restore: + +cinder backup-restore +~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder backup-restore [--volume ] + +Restores a backup. + +Positional arguments +-------------------- + +```` + ID of backup to restore. + +Optional arguments +------------------ + +``--volume `` + Name or ID of volume to which to restore. Default=None. + +.. _cinder_backup-show: + +cinder backup-show +~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder backup-show + +Shows backup details. + +Positional arguments +-------------------- + +```` + Name or ID of backup. + +.. _cinder_cgsnapshot-create: + +cinder cgsnapshot-create +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder cgsnapshot-create [--name ] [--description ] + + +Creates a cgsnapshot. + +Positional arguments +-------------------- + +```` + Name or ID of a consistency group. + +Optional arguments +------------------ + +``--name `` + Cgsnapshot name. Default=None. + +``--description `` + Cgsnapshot description. Default=None. + +.. _cinder_cgsnapshot-delete: + +cinder cgsnapshot-delete +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder cgsnapshot-delete [ ...] + +Removes one or more cgsnapshots. + +Positional arguments +-------------------- + +```` + Name or ID of one or more cgsnapshots to be deleted. + +.. _cinder_cgsnapshot-list: + +cinder cgsnapshot-list +~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder cgsnapshot-list [--all-tenants [<0|1>]] [--status ] + [--consistencygroup-id ] + +Lists all cgsnapshots. + +Optional arguments +------------------ + +``--all-tenants [<0|1>]`` + Shows details for all tenants. Admin only. + +``--status `` + Filters results by a status. Default=None. + +``--consistencygroup-id `` + Filters results by a consistency group ID. + Default=None. + +.. _cinder_cgsnapshot-show: + +cinder cgsnapshot-show +~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder cgsnapshot-show + +Shows cgsnapshot details. + +Positional arguments +-------------------- + +```` + Name or ID of cgsnapshot. + +.. _cinder_consisgroup-create: + +cinder consisgroup-create +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder consisgroup-create [--name ] [--description ] + [--availability-zone ] + + +Creates a consistency group. + +Positional arguments +-------------------- + +```` + Volume types. + +Optional arguments +------------------ + +``--name `` + Name of a consistency group. + +``--description `` + Description of a consistency group. Default=None. + +``--availability-zone `` + Availability zone for volume. Default=None. + +.. _cinder_consisgroup-create-from-src: + +cinder consisgroup-create-from-src +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder consisgroup-create-from-src [--cgsnapshot ] + [--source-cg ] + [--name ] + [--description ] + +Creates a consistency group from a cgsnapshot or a source CG. + +Optional arguments +------------------ + +``--cgsnapshot `` + Name or ID of a cgsnapshot. Default=None. + +``--source-cg `` + Name or ID of a source CG. Default=None. + +``--name `` + Name of a consistency group. Default=None. + +``--description `` + Description of a consistency group. Default=None. + +.. _cinder_consisgroup-delete: + +cinder consisgroup-delete +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder consisgroup-delete [--force] + [ ...] + +Removes one or more consistency groups. + +Positional arguments +-------------------- + +```` + 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: + +cinder consisgroup-list +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder 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: + +cinder consisgroup-show +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder consisgroup-show + +Shows details of a consistency group. + +Positional arguments +-------------------- + +```` + Name or ID of a consistency group. + +.. _cinder_consisgroup-update: + +cinder consisgroup-update +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder consisgroup-update [--name ] [--description ] + [--add-volumes ] + [--remove-volumes ] + + +Updates a consistencygroup. + +Positional arguments +-------------------- + +```` + Name or ID of a consistency group. + +Optional arguments +------------------ + +``--name `` + New name for consistency group. Default=None. + +``--description `` + New description for consistency group. Default=None. + +``--add-volumes `` + UUID of one or more volumes to be added to the + consistency group, separated by commas. Default=None. + +``--remove-volumes `` + UUID of one or more volumes to be removed from the + consistency group, separated by commas. Default=None. + +.. _cinder_create: + +cinder create +~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder create [--consisgroup-id ] + [--snapshot-id ] + [--source-volid ] + [--source-replica ] + [--image-id ] [--image ] [--name ] + [--description ] + [--volume-type ] + [--availability-zone ] + [--metadata [ [ ...]]] + [--hint ] [--allow-multiattach] + [] + +Creates a volume. + +Positional arguments +-------------------- + +```` + Size of volume, in GiBs. (Required unless snapshot-id + /source-volid is specified). + +Optional arguments +------------------ + +``--consisgroup-id `` + ID of a consistency group where the new volume belongs + to. Default=None. + +``--snapshot-id `` + Creates volume from snapshot ID. Default=None. + +``--source-volid `` + Creates volume from volume ID. Default=None. + +``--source-replica `` + Creates volume from replicated volume ID. + Default=None. + +``--image-id `` + Creates volume from image ID. Default=None. + +``--image `` + Creates a volume from image (ID or name). + Default=None. + +``--name `` + Volume name. Default=None. + +``--description `` + Volume description. Default=None. + +``--volume-type `` + Volume type. Default=None. + +``--availability-zone `` + Availability zone for volume. Default=None. + +``--metadata [ [ ...]]`` + Metadata key and value pairs. Default=None. + +``--hint `` + Scheduler hint, like in nova. + +``--allow-multiattach`` + Allow volume to be attached more than once. + Default=False + +.. _cinder_credentials: + +cinder credentials +~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder credentials + +Shows user credentials returned from auth. + +.. _cinder_delete: + +cinder delete +~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder delete [ ...] + +Removes one or more volumes. + +Positional arguments +-------------------- + +```` + Name or ID of volume or volumes to delete. + +.. _cinder_encryption-type-create: + +cinder encryption-type-create +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder encryption-type-create [--cipher ] + [--key_size ] + [--control_location ] + + +Creates encryption type for a volume type. Admin only. + +Positional arguments +-------------------- + +```` + Name or ID of volume type. + +```` + The class that provides encryption support. For + example, LuksEncryptor. + +Optional arguments +------------------ + +``--cipher `` + The encryption algorithm or mode. For example, aes- + xts-plain64. Default=None. + +``--key_size `` + Size of encryption key, in bits. For example, 128 or + 256. Default=None. + +``--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: + +cinder encryption-type-delete +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder encryption-type-delete + +Deletes encryption type for a volume type. Admin only. + +Positional arguments +-------------------- + +```` + Name or ID of volume type. + +.. _cinder_encryption-type-list: + +cinder encryption-type-list +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder encryption-type-list + +Shows encryption type details for volume types. Admin only. + +.. _cinder_encryption-type-show: + +cinder encryption-type-show +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder encryption-type-show + +Shows encryption type details for a volume type. Admin only. + +Positional arguments +-------------------- + +```` + Name or ID of volume type. + +.. _cinder_encryption-type-update: + +cinder encryption-type-update +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder encryption-type-update [--provider ] + [--cipher []] + [--key-size []] + [--control-location ] + + +Update encryption type information for a volume type (Admin Only). + +Positional arguments +-------------------- + +```` + Name or ID of the volume type + +Optional arguments +------------------ + +``--provider `` + Class providing encryption support (e.g. + LuksEncryptor) (Optional) + +``--cipher []`` + Encryption algorithm/mode to use (e.g., aes-xts- + plain64). Provide parameter without value to set to + provider default. (Optional) + +``--key-size []`` + Size of the encryption key, in bits (e.g., 128, 256). + Provide parameter without value to set to provider + default. (Optional) + +``--control-location `` + Notional service where encryption is performed (e.g., + front-end=Nova). Values: 'front-end', 'back-end' + (Optional) + +.. _cinder_endpoints: + +cinder endpoints +~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder endpoints + +Discovers endpoints registered by authentication service. + +.. _cinder_extend: + +cinder extend +~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder extend + +Attempts to extend size of an existing volume. + +Positional arguments +-------------------- + +```` + Name or ID of volume to extend. + +```` + New size of volume, in GiBs. + +.. _cinder_extra-specs-list: + +cinder extra-specs-list +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder extra-specs-list + +Lists current volume types and extra specs. + +.. _cinder_force-delete: + +cinder force-delete +~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder force-delete [ ...] + +Attempts force-delete of volume, regardless of state. + +Positional arguments +-------------------- + +```` + Name or ID of volume or volumes to delete. + +.. _cinder_get-capabilities: + +cinder get-capabilities +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder get-capabilities + +Show backend volume stats and properties. Admin only. + +Positional arguments +-------------------- + +```` + Cinder host to show backend volume stats and properties; takes the + form: host@backend-name + +.. _cinder_get-pools: + +cinder get-pools +~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder get-pools [--detail] + +Show pool information for backends. Admin only. + +Optional arguments +------------------ + +``--detail`` + Show detailed information about pools. + +.. _cinder_image-metadata: + +cinder image-metadata +~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder image-metadata [ ...] + +Sets or deletes volume image metadata. + +Positional arguments +-------------------- + +```` + Name or ID of volume for which to update metadata. + +```` + The action. Valid values are 'set' or 'unset.' + +```` + Metadata key and value pair to set or unset. For unset, specify + only the key. + +.. _cinder_image-metadata-show: + +cinder image-metadata-show +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder image-metadata-show + +Shows volume image metadata. + +Positional arguments +-------------------- + +```` + ID of volume. + +.. _cinder_list: + +cinder list +~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder list [--all-tenants [<0|1>]] [--name ] [--status ] + [--migration_status ] + [--metadata [ [ ...]]] + [--marker ] [--limit ] + [--sort [:]] [--tenant []] + +Lists all volumes. + +Optional arguments +------------------ + +``--all-tenants [<0|1>]`` + Shows details for all tenants. Admin only. + +``--name `` + Filters results by a name. Default=None. + +``--status `` + Filters results by a status. Default=None. + +``--migration_status `` + Filters results by a migration status. Default=None. + Admin only. + +``--metadata [ [ ...]]`` + Filters results by a metadata key and value pair. + Default=None. + +``--marker `` + Begin returning volumes that appear later in the + volume list than that represented by this volume id. + Default=None. + +``--limit `` + Maximum number of volumes to return. Default=None. + +``--sort [:]`` + Comma-separated list of sort keys and directions in + the form of [:]. Valid keys: id, + status, size, availability_zone, name, bootable, + created_at. Default=None. + +``--tenant []`` + Display information from single tenant (Admin only). + +.. _cinder_list-extensions: + +cinder list-extensions +~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder list-extensions + +Lists all available os-api extensions. + +.. _cinder_manage: + +cinder manage +~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder manage [--id-type ] [--name ] + [--description ] + [--volume-type ] + [--availability-zone ] + [--metadata [ [ ...]]] [--bootable] + + +Manage an existing volume. + +Positional arguments +-------------------- + +```` + Cinder host on which the existing volume resides; + takes the form: host@backend-name#pool + +```` + Name or other Identifier for existing volume + +Optional arguments +------------------ + +``--id-type `` + Type of backend device identifier provided, typically + source-name or source-id (Default=source-name) + +``--name `` + Volume name (Default=None) + +``--description `` + Volume description (Default=None) + +``--volume-type `` + Volume type (Default=None) + +``--availability-zone `` + Availability zone for volume (Default=None) + +``--metadata [ [ ...]]`` + Metadata key=value pairs (Default=None) + +``--bootable`` + Specifies that the newly created volume should be + marked as bootable + +.. _cinder_metadata: + +cinder metadata +~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder metadata [ ...] + +Sets or deletes volume metadata. + +Positional arguments +-------------------- + +```` + Name or ID of volume for which to update metadata. + +```` + The action. Valid values are "set" or "unset." + +```` + Metadata key and value pair to set or unset. For unset, specify + only the key. + +.. _cinder_metadata-show: + +cinder metadata-show +~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder metadata-show + +Shows volume metadata. + +Positional arguments +-------------------- + +```` + ID of volume. + +.. _cinder_metadata-update-all: + +cinder metadata-update-all +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder metadata-update-all [ ...] + +Updates volume metadata. + +Positional arguments +-------------------- + +```` + ID of volume for which to update metadata. + +```` + Metadata key and value pair or pairs to update. + +.. _cinder_migrate: + +cinder migrate +~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder migrate [--force-host-copy []] + [--lock-volume []] + + +Migrates volume to a new host. + +Positional arguments +-------------------- + +```` + ID of volume to migrate. + +```` + Destination host. Takes the form: host@backend- + name#pool + +Optional arguments +------------------ + +``--force-host-copy []`` + Enables or disables generic host-based force- + migration, which bypasses driver optimizations. + Default=False. + +``--lock-volume []`` + Enables or disables the termination of volume + migration caused by other commands. This option + applies to the available volume. True means it locks + the volume state and does not allow the migration to + be aborted. The volume status will be in maintenance + during the migration. False means it allows the volume + migration to be aborted. The volume status is still in + the original status. Default=False. + +.. _cinder_qos-associate: + +cinder qos-associate +~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder qos-associate + +Associates qos specs with specified volume type. + +Positional arguments +-------------------- + +```` + ID of QoS specifications. + +```` + ID of volume type with which to associate QoS + specifications. + +.. _cinder_qos-create: + +cinder qos-create +~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder qos-create [ ...] + +Creates a qos specs. + +Positional arguments +-------------------- + +```` + Name of new QoS specifications. + +```` + QoS specifications. + +.. _cinder_qos-delete: + +cinder qos-delete +~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder qos-delete [--force []] + +Deletes a specified qos specs. + +Positional arguments +-------------------- + +```` + ID of QoS specifications to delete. + +Optional arguments +------------------ + +``--force []`` + Enables or disables deletion of in-use QoS + specifications. Default=False. + +.. _cinder_qos-disassociate: + +cinder qos-disassociate +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder qos-disassociate + +Disassociates qos specs from specified volume type. + +Positional arguments +-------------------- + +```` + ID of QoS specifications. + +```` + ID of volume type with which to associate QoS + specifications. + +.. _cinder_qos-disassociate-all: + +cinder qos-disassociate-all +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder qos-disassociate-all + +Disassociates qos specs from all its associations. + +Positional arguments +-------------------- + +```` + ID of QoS specifications on which to operate. + +.. _cinder_qos-get-association: + +cinder qos-get-association +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder qos-get-association + +Lists all associations for specified qos specs. + +Positional arguments +-------------------- + +```` + ID of QoS specifications. + +.. _cinder_qos-key: + +cinder qos-key +~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder qos-key key=value [key=value ...] + +Sets or unsets specifications for a qos spec. + +Positional arguments +-------------------- + +```` + ID of QoS specifications. + +```` + 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: + +cinder qos-list +~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder qos-list + +Lists qos specs. + +.. _cinder_qos-show: + +cinder qos-show +~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder qos-show + +Shows qos specs details. + +Positional arguments +-------------------- + +```` + ID of QoS specifications to show. + +.. _cinder_quota-class-show: + +cinder quota-class-show +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder quota-class-show + +Lists quotas for a quota class. + +Positional arguments +-------------------- + +```` + Name of quota class for which to list quotas. + +.. _cinder_quota-class-update: + +cinder quota-class-update +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder quota-class-update [--volumes ] + [--snapshots ] + [--gigabytes ] + [--volume-type ] + + +Updates quotas for a quota class. + +Positional arguments +-------------------- + +```` + Name of quota class for which to set quotas. + +Optional arguments +------------------ + +``--volumes `` + The new "volumes" quota value. Default=None. + +``--snapshots `` + The new "snapshots" quota value. Default=None. + +``--gigabytes `` + The new "gigabytes" quota value. Default=None. + +``--volume-type `` + Volume type. Default=None. + +.. _cinder_quota-defaults: + +cinder quota-defaults +~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder quota-defaults + +Lists default quotas for a tenant. + +Positional arguments +-------------------- + +```` + ID of tenant for which to list quota defaults. + +.. _cinder_quota-delete: + +cinder quota-delete +~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder quota-delete + +Delete the quotas for a tenant. + +Positional arguments +-------------------- + +```` + UUID of tenant to delete the quotas for. + +.. _cinder_quota-show: + +cinder quota-show +~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder quota-show + +Lists quotas for a tenant. + +Positional arguments +-------------------- + +```` + ID of tenant for which to list quotas. + +.. _cinder_quota-update: + +cinder quota-update +~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder quota-update [--volumes ] [--snapshots ] + [--gigabytes ] [--backups ] + [--backup-gigabytes ] + [--consistencygroups ] + [--volume-type ] + [--per-volume-gigabytes ] + + +Updates quotas for a tenant. + +Positional arguments +-------------------- + +```` + ID of tenant for which to set quotas. + +Optional arguments +------------------ + +``--volumes `` + The new "volumes" quota value. Default=None. + +``--snapshots `` + The new "snapshots" quota value. Default=None. + +``--gigabytes `` + The new "gigabytes" quota value. Default=None. + +``--backups `` + The new "backups" quota value. Default=None. + +``--backup-gigabytes `` + The new "backup_gigabytes" quota value. Default=None. + +``--consistencygroups `` + The new "consistencygroups" quota value. Default=None. + +``--volume-type `` + Volume type. Default=None. + +``--per-volume-gigabytes `` + Set max volume size limit. Default=None. + +.. _cinder_quota-usage: + +cinder quota-usage +~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder quota-usage + +Lists quota usage for a tenant. + +Positional arguments +-------------------- + +```` + ID of tenant for which to list quota usage. + +.. _cinder_rate-limits: + +cinder rate-limits +~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder rate-limits + +Lists rate limits for a user. + +.. _cinder_readonly-mode-update: + +cinder readonly-mode-update +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder readonly-mode-update + +Updates volume read-only access-mode flag. + +Positional arguments +-------------------- + +```` + ID of volume to update. + +```` + Enables or disables update of volume to read-only + access mode. + +.. _cinder_rename: + +cinder rename +~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder rename [--description ] [] + +Renames a volume. + +Positional arguments +-------------------- + +```` + Name or ID of volume to rename. + +```` + New name for volume. + +Optional arguments +------------------ + +``--description `` + Volume description. Default=None. + +.. _cinder_replication-disable: + +cinder replication-disable +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder replication-disable + +Disables volume replication on a given volume. + +Positional arguments +-------------------- + +```` + ID of volume to disable replication. + +.. _cinder_replication-enable: + +cinder replication-enable +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder replication-enable + +Enables volume replication on a given volume. + +Positional arguments +-------------------- + +```` + ID of volume to enable replication. + +.. _cinder_replication-failover: + +cinder replication-failover +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder replication-failover + +Failover a volume to a secondary target + +Positional arguments +-------------------- + +```` + ID of volume to failover. + +```` + A unqiue identifier that represents a failover target. + +.. _cinder_replication-list-targets: + +cinder replication-list-targets +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder replication-list-targets + +List replication targets available for a volume. + +Positional arguments +-------------------- + +```` + ID of volume to list available replication targets. + +.. _cinder_replication-promote: + +cinder replication-promote +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder replication-promote + +Promote a secondary volume to primary for a relationship. + +Positional arguments +-------------------- + +```` + Name or ID of the volume to promote. The volume should have the + replica volume created with source-replica argument. + +.. _cinder_replication-reenable: + +cinder replication-reenable +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder replication-reenable + +Sync the secondary volume with primary for a relationship. + +Positional arguments +-------------------- + +```` + Name or ID of the volume to reenable replication. The replication- + status of the volume should be inactive. + +.. _cinder_reset-state: + +cinder reset-state +~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder reset-state [--state ] [--attach-status ] + [--reset-migration-status] + [ ...] + +Explicitly updates the volume state in the Cinder database. Note that this +does not affect whether the volume is actually attached to the Nova compute +host or instance and can result in an unusable volume. Being a database change +only, this has no impact on the true state of the volume and may not match the +actual state. This can render a volume unusable in the case of change to the +'available' state. + +Positional arguments +-------------------- + +```` + Name or ID of volume to modify. + +Optional arguments +------------------ + +``--state `` + The state to assign to the volume. Valid values are + "available", "error", "creating", "deleting", "in- + use", "attaching", "detaching", "error_deleting" and + "maintenance". NOTE: This command simply changes the + state of the Volume in the DataBase with no regard to + actual status, exercise caution when using. + Default=available. + +``--attach-status `` + The attach status to assign to the volume in the + DataBase, with no regard to the actual status. Valid + values are "attached" and "detached". Default=None, + that means the status is unchanged. + +``--reset-migration-status`` + Clears the migration status of the volume in the + DataBase that indicates the volume is source or + destination of volume migration, with no regard to the + actual status. + +.. _cinder_retype: + +cinder retype +~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder retype [--migration-policy ] + + +Changes the volume type for a volume. + +Positional arguments +-------------------- + +```` + Name or ID of volume for which to modify type. + +```` + New volume type. + +Optional arguments +------------------ + +``--migration-policy `` + Migration policy during retype of volume. + +.. _cinder_service-disable: + +cinder service-disable +~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder service-disable [--reason ] + +Disables the service. + +Positional arguments +-------------------- + +```` + Host name. + +```` + Service binary. + +Optional arguments +------------------ + +``--reason `` + Reason for disabling service. + +.. _cinder_service-enable: + +cinder service-enable +~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder service-enable + +Enables the service. + +Positional arguments +-------------------- + +```` + Host name. + +```` + Service binary. + +.. _cinder_service-list: + +cinder service-list +~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder service-list [--host ] [--binary ] + +Lists all services. Filter by host and service binary. + +Optional arguments +------------------ + +``--host `` + Host name. Default=None. + +``--binary `` + Service binary. Default=None. + +.. _cinder_set-bootable: + +cinder set-bootable +~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder set-bootable + +Update bootable status of a volume. + +Positional arguments +-------------------- + +```` + ID of the volume to update. + +```` + Flag to indicate whether volume is bootable. + +.. _cinder_show: + +cinder show +~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder show + +Shows volume details. + +Positional arguments +-------------------- + +```` + Name or ID of volume. + +.. _cinder_snapshot-create: + +cinder snapshot-create +~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder snapshot-create [--force []] [--name ] + [--description ] + [--metadata [ [ ...]]] + + +Creates a snapshot. + +Positional arguments +-------------------- + +```` + Name or ID of volume to snapshot. + +Optional arguments +------------------ + +``--force []`` + 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. + +``--name `` + Snapshot name. Default=None. + +``--description `` + Snapshot description. Default=None. + +``--metadata [ [ ...]]`` + Snapshot metadata key and value pairs. Default=None. + +.. _cinder_snapshot-delete: + +cinder snapshot-delete +~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder snapshot-delete [ ...] + +Removes one or more snapshots. + +Positional arguments +-------------------- + +```` + Name or ID of the snapshot(s) to delete. + +.. _cinder_snapshot-list: + +cinder snapshot-list +~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder snapshot-list [--all-tenants [<0|1>]] [--name ] + [--status ] [--volume-id ] + [--marker ] [--limit ] + [--sort [:]] + +Lists all snapshots. + +Optional arguments +------------------ + +``--all-tenants [<0|1>]`` + Shows details for all tenants. Admin only. + +``--name `` + Filters results by a name. Default=None. + +``--status `` + Filters results by a status. Default=None. + +``--volume-id `` + Filters results by a volume ID. Default=None. + +``--marker `` + Begin returning snapshots that appear later in the + snapshot list than that represented by this id. + Default=None. + +``--limit `` + Maximum number of snapshots to return. Default=None. + +``--sort [:]`` + Comma-separated list of sort keys and directions in + the form of [:]. Valid keys: id, + status, size, availability_zone, name, bootable, + created_at. Default=None. + +.. _cinder_snapshot-metadata: + +cinder snapshot-metadata +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder snapshot-metadata + [ ...] + +Sets or deletes snapshot metadata. + +Positional arguments +-------------------- + +```` + ID of snapshot for which to update metadata. + +```` + The action. Valid values are "set" or "unset." + +```` + Metadata key and value pair to set or unset. For unset, specify + only the key. + +.. _cinder_snapshot-metadata-show: + +cinder snapshot-metadata-show +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder snapshot-metadata-show + +Shows snapshot metadata. + +Positional arguments +-------------------- + +```` + ID of snapshot. + +.. _cinder_snapshot-metadata-update-all: + +cinder snapshot-metadata-update-all +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder snapshot-metadata-update-all + [ ...] + +Updates snapshot metadata. + +Positional arguments +-------------------- + +```` + ID of snapshot for which to update metadata. + +```` + Metadata key and value pair to update. + +.. _cinder_snapshot-rename: + +cinder snapshot-rename +~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder snapshot-rename [--description ] + [] + +Renames a snapshot. + +Positional arguments +-------------------- + +```` + Name or ID of snapshot. + +```` + New name for snapshot. + +Optional arguments +------------------ + +``--description `` + Snapshot description. Default=None. + +.. _cinder_snapshot-reset-state: + +cinder snapshot-reset-state +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder snapshot-reset-state [--state ] + [ ...] + +Explicitly updates the snapshot state. + +Positional arguments +-------------------- + +```` + Name or ID of snapshot to modify. + +Optional arguments +------------------ + +``--state `` + The state to assign to the snapshot. Valid values are + "available", "error", "creating", "deleting", and + "error_deleting". NOTE: This command simply changes the + state of the Snapshot in the DataBase with no regard to + actual status, exercise caution when using. + Default=available. + +.. _cinder_snapshot-show: + +cinder snapshot-show +~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder snapshot-show + +Shows snapshot details. + +Positional arguments +-------------------- + +```` + Name or ID of snapshot. + +.. _cinder_transfer-accept: + +cinder transfer-accept +~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder transfer-accept + +Accepts a volume transfer. + +Positional arguments +-------------------- + +```` + ID of transfer to accept. + +```` + Authentication key of transfer to accept. + +.. _cinder_transfer-create: + +cinder transfer-create +~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder transfer-create [--name ] + +Creates a volume transfer. + +Positional arguments +-------------------- + +```` + Name or ID of volume to transfer. + +Optional arguments +------------------ + +``--name `` + Transfer name. Default=None. + +.. _cinder_transfer-delete: + +cinder transfer-delete +~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder transfer-delete + +Undoes a transfer. + +Positional arguments +-------------------- + +```` + Name or ID of transfer to delete. + +.. _cinder_transfer-list: + +cinder transfer-list +~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder transfer-list [--all-tenants [<0|1>]] + +Lists all transfers. + +Optional arguments +------------------ + +``--all-tenants [<0|1>]`` + Shows details for all tenants. Admin only. + +.. _cinder_transfer-show: + +cinder transfer-show +~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder transfer-show + +Shows transfer details. + +Positional arguments +-------------------- + +```` + Name or ID of transfer to accept. + +.. _cinder_type-access-add: + +cinder type-access-add +~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder type-access-add --volume-type --project-id + + +Adds volume type access for the given project. + +Optional arguments +------------------ + +``--volume-type `` + Volume type name or ID to add access for the given + project. + +``--project-id `` + Project ID to add volume type access for. + +.. _cinder_type-access-list: + +cinder type-access-list +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder type-access-list --volume-type + +Print access information about the given volume type. + +Optional arguments +------------------ + +``--volume-type `` + Filter results by volume type name or ID. + +.. _cinder_type-access-remove: + +cinder type-access-remove +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder type-access-remove --volume-type --project-id + + +Removes volume type access for the given project. + +Optional arguments +------------------ + +``--volume-type `` + Volume type name or ID to remove access for the given + project. + +``--project-id `` + Project ID to remove volume type access for. + +.. _cinder_type-create: + +cinder type-create +~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder type-create [--description ] + [--is-public ] + + +Creates a volume type. + +Positional arguments +-------------------- + +```` + Name of new volume type. + +Optional arguments +------------------ + +``--description `` + Description of new volume type. + +``--is-public `` + Make type accessible to the public (default true). + +.. _cinder_type-default: + +cinder type-default +~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder type-default + +List the default volume type. + +.. _cinder_type-delete: + +cinder type-delete +~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder type-delete + +Deletes a volume type. + +Positional arguments +-------------------- + +```` + ID of volume type to delete. + +.. _cinder_type-key: + +cinder type-key +~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder type-key [ ...] + +Sets or unsets extra_spec for a volume type. + +Positional arguments +-------------------- + +```` + Name or ID of volume type. + +```` + The action. Valid values are "set" or "unset." + +```` + The extra specs key and value pair to set or unset. For unset, + specify only the key. + +.. _cinder_type-list: + +cinder type-list +~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder type-list + +Lists available 'volume types'. (Admin only will see private types) + +.. _cinder_type-show: + +cinder type-show +~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder type-show + +Show volume type details. + +Positional arguments +-------------------- + +```` + Name or ID of the volume type. + +.. _cinder_type-update: + +cinder type-update +~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder type-update [--name ] [--description ] + [--is-public ] + + +Updates volume type name ,description and/or is_public. + +Positional arguments +-------------------- + +```` + ID of the volume type. + +Optional arguments +------------------ + +``--name `` + Name of the volume type. + +``--description `` + Description of the volume type. + +``--is-public `` + Make type accessible to the public or not. + +.. _cinder_unmanage: + +cinder unmanage +~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder unmanage + +Stop managing a volume. + +Positional arguments +-------------------- + +```` + Name or ID of the volume to unmanage. + +.. _cinder_upload-to-image: + +cinder upload-to-image +~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder upload-to-image [--force []] + [--container-format ] + [--disk-format ] + + +Uploads volume to Image Service as an image. + +Positional arguments +-------------------- + +```` + Name or ID of volume to snapshot. + +```` + The new image name. + +Optional arguments +------------------ + +``--force []`` + Enables or disables upload of a volume that is + attached to an instance. Default=False. + +``--container-format `` + Container format type. Default is bare. + +``--disk-format `` + Disk format type. Default is raw. + + +Block Storage API v2 commands +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You can select an API version to use by adding the +:option:`--os-volume-api-version` parameter or by +setting the corresponding environment variable: + +.. code-block:: console + + export OS_VOLUME_API_VERSION=2 + +.. _cinder_absolute-limits_v2: + +cinder absolute-limits (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 absolute-limits + +Lists absolute limits for a user. + +.. _cinder_availability-zone-list_v2: + +cinder availability-zone-list (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 availability-zone-list + +Lists all availability zones. + +.. _cinder_backup-create_v2: + +cinder backup-create (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 backup-create [--container ] [--name ] + [--description ] [--incremental] + [--force] + + +Creates a volume backup. + +Positional arguments +-------------------- + +```` + Name or ID of volume to backup. + +Optional arguments +------------------ + +``--container `` + Backup container name. Default=None. + +``--name `` + Backup name. Default=None. + +``--description `` + Backup description. Default=None. + +``--incremental`` + Incremental backup. Default=False. + +``--force`` + Allows or disallows backup of a volume when the volume + is attached to an instance. If set to True, backs up + the volume whether its status is "available" or "in- + use". The backup of an "in-use" volume means your data + is crash consistent. Default=False. + +.. _cinder_backup-delete_v2: + +cinder backup-delete (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 backup-delete + +Removes a backup. + +Positional arguments +-------------------- + +```` + Name or ID of backup to delete. + +.. _cinder_backup-export_v2: + +cinder backup-export (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 backup-export + +Export backup metadata record. + +Positional arguments +-------------------- + +```` + ID of the backup to export. + +.. _cinder_backup-import_v2: + +cinder backup-import (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 backup-import + +Import backup metadata record. + +Positional arguments +-------------------- + +```` + Backup service to use for importing the backup. + +```` + Backup URL for importing the backup metadata. + +.. _cinder_backup-list_v2: + +cinder backup-list (v2) +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 backup-list [--all-tenants []] [--name ] + [--status ] [--volume-id ] + [--marker ] [--limit ] + [--sort [:]] + +Lists all backups. + +Optional arguments +------------------ + +``--all-tenants []`` + Shows details for all tenants. Admin only. + +``--name `` + Filters results by a name. Default=None. + +``--status `` + Filters results by a status. Default=None. + +``--volume-id `` + Filters results by a volume ID. Default=None. + +``--marker `` + Begin returning backups that appear later in the + backup list than that represented by this id. + Default=None. + +``--limit `` + Maximum number of backups to return. Default=None. + +``--sort [:]`` + Comma-separated list of sort keys and directions in + the form of [:]. Valid keys: id, + status, size, availability_zone, name, bootable, + created_at. Default=None. + +.. _cinder_backup-reset-state_v2: + +cinder backup-reset-state (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 backup-reset-state [--state ] [ ...] + +Explicitly updates the backup state. + +Positional arguments +-------------------- + +```` + Name or ID of the backup to modify. + +Optional arguments +------------------ + +``--state `` + The state to assign to the backup. Valid values are + "available", "error", "creating", "deleting", and + "error_deleting". Default=available. + +.. _cinder_backup-restore_v2: + +cinder backup-restore (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 backup-restore [--volume ] + +Restores a backup. + +Positional arguments +-------------------- + +```` + ID of backup to restore. + +Optional arguments +------------------ + +``--volume `` + Name or ID of volume to which to restore. Default=None. + +.. _cinder_backup-show_v2: + +cinder backup-show (v2) +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 backup-show + +Shows backup details. + +Positional arguments +-------------------- + +```` + Name or ID of backup. + +.. _cinder_cgsnapshot-create_v2: + +cinder cgsnapshot-create (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 cgsnapshot-create [--name ] [--description ] + + +Creates a cgsnapshot. + +Positional arguments +-------------------- + +```` + Name or ID of a consistency group. + +Optional arguments +------------------ + +``--name `` + Cgsnapshot name. Default=None. + +``--description `` + Cgsnapshot description. Default=None. + +.. _cinder_cgsnapshot-delete_v2: + +cinder cgsnapshot-delete (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 cgsnapshot-delete [ ...] + +Removes one or more cgsnapshots. + +Positional arguments +-------------------- + +```` + Name or ID of one or more cgsnapshots to be deleted. + +.. _cinder_cgsnapshot-list_v2: + +cinder cgsnapshot-list (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 cgsnapshot-list [--all-tenants [<0|1>]] [--status ] + [--consistencygroup-id ] + +Lists all cgsnapshots. + +Optional arguments +------------------ + +``--all-tenants [<0|1>]`` + Shows details for all tenants. Admin only. + +``--status `` + Filters results by a status. Default=None. + +``--consistencygroup-id `` + Filters results by a consistency group ID. + Default=None. + +.. _cinder_cgsnapshot-show_v2: + +cinder cgsnapshot-show (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 cgsnapshot-show + +Shows cgsnapshot details. + +Positional arguments +-------------------- + +```` + Name or ID of cgsnapshot. + +.. _cinder_consisgroup-create_v2: + +cinder consisgroup-create (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 consisgroup-create [--name ] [--description ] + [--availability-zone ] + + +Creates a consistency group. + +Positional arguments +-------------------- + +```` + Volume types. + +Optional arguments +------------------ + +``--name `` + Name of a consistency group. + +``--description `` + Description of a consistency group. Default=None. + +``--availability-zone `` + Availability zone for volume. Default=None. + +.. _cinder_consisgroup-create-from-src_v2: + +cinder consisgroup-create-from-src (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 consisgroup-create-from-src [--cgsnapshot ] + [--source-cg ] + [--name ] + [--description ] + +Creates a consistency group from a cgsnapshot or a source CG. + +Optional arguments +------------------ + +``--cgsnapshot `` + Name or ID of a cgsnapshot. Default=None. + +``--source-cg `` + Name or ID of a source CG. Default=None. + +``--name `` + Name of a consistency group. Default=None. + +``--description `` + Description of a consistency group. Default=None. + +.. _cinder_consisgroup-delete_v2: + +cinder consisgroup-delete (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 consisgroup-delete [--force] + [ ...] + +Removes one or more consistency groups. + +Positional arguments +-------------------- + +```` + 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: + +cinder consisgroup-list (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + 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: + +cinder consisgroup-show (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 consisgroup-show + +Shows details of a consistency group. + +Positional arguments +-------------------- + +```` + Name or ID of a consistency group. + +.. _cinder_consisgroup-update_v2: + +cinder consisgroup-update (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 consisgroup-update [--name ] [--description ] + [--add-volumes ] + [--remove-volumes ] + + +Updates a consistencygroup. + +Positional arguments +-------------------- + +```` + Name or ID of a consistency group. + +Optional arguments +------------------ + +``--name `` + New name for consistency group. Default=None. + +``--description `` + New description for consistency group. Default=None. + +``--add-volumes `` + UUID of one or more volumes to be added to the + consistency group, separated by commas. Default=None. + +``--remove-volumes `` + UUID of one or more volumes to be removed from the + consistency group, separated by commas. Default=None. + +.. _cinder_create_v2: + +cinder create (v2) +~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 create [--consisgroup-id ] + [--snapshot-id ] + [--source-volid ] + [--source-replica ] + [--image-id ] [--image ] [--name ] + [--description ] + [--volume-type ] + [--availability-zone ] + [--metadata [ [ ...]]] + [--hint ] [--allow-multiattach] + [] + +Creates a volume. + +Positional arguments +-------------------- + +```` + Size of volume, in GiBs. (Required unless snapshot-id + /source-volid is specified). + +Optional arguments +------------------ + +``--consisgroup-id `` + ID of a consistency group where the new volume belongs + to. Default=None. + +``--snapshot-id `` + Creates volume from snapshot ID. Default=None. + +``--source-volid `` + Creates volume from volume ID. Default=None. + +``--source-replica `` + Creates volume from replicated volume ID. + Default=None. + +``--image-id `` + Creates volume from image ID. Default=None. + +``--image `` + Creates a volume from image (ID or name). + Default=None. + +``--name `` + Volume name. Default=None. + +``--description `` + Volume description. Default=None. + +``--volume-type `` + Volume type. Default=None. + +``--availability-zone `` + Availability zone for volume. Default=None. + +``--metadata [ [ ...]]`` + Metadata key and value pairs. Default=None. + +``--hint `` + Scheduler hint, like in nova. + +``--allow-multiattach`` + Allow volume to be attached more than once. + Default=False + +.. _cinder_credentials_v2: + +cinder credentials (v2) +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 credentials + +Shows user credentials returned from auth. + +.. _cinder_delete_v2: + +cinder delete (v2) +~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 delete [ ...] + +Removes one or more volumes. + +Positional arguments +-------------------- + +```` + Name or ID of volume or volumes to delete. + +.. _cinder_encryption-type-create_v2: + +cinder encryption-type-create (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 encryption-type-create [--cipher ] + [--key_size ] + [--control_location ] + + +Creates encryption type for a volume type. Admin only. + +Positional arguments +-------------------- + +```` + Name or ID of volume type. + +```` + The class that provides encryption support. For + example, LuksEncryptor. + +Optional arguments +------------------ + +``--cipher `` + The encryption algorithm or mode. For example, aes- + xts-plain64. Default=None. + +``--key_size `` + Size of encryption key, in bits. For example, 128 or + 256. Default=None. + +``--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: + +cinder encryption-type-delete (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 encryption-type-delete + +Deletes encryption type for a volume type. Admin only. + +Positional arguments +-------------------- + +```` + Name or ID of volume type. + +.. _cinder_encryption-type-list_v2: + +cinder encryption-type-list (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 encryption-type-list + +Shows encryption type details for volume types. Admin only. + +.. _cinder_encryption-type-show_v2: + +cinder encryption-type-show (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 encryption-type-show + +Shows encryption type details for a volume type. Admin only. + +Positional arguments +-------------------- + +```` + Name or ID of volume type. + +.. _cinder_encryption-type-update_v2: + +cinder encryption-type-update (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 encryption-type-update [--provider ] + [--cipher []] + [--key-size []] + [--control-location ] + + +Update encryption type information for a volume type (Admin Only). + +Positional arguments +-------------------- + +```` + Name or ID of the volume type + +Optional arguments +------------------ + +``--provider `` + Class providing encryption support (e.g. + LuksEncryptor) (Optional) + +``--cipher []`` + Encryption algorithm/mode to use (e.g., aes-xts- + plain64). Provide parameter without value to set to + provider default. (Optional) + +``--key-size []`` + Size of the encryption key, in bits (e.g., 128, 256). + Provide parameter without value to set to provider + default. (Optional) + +``--control-location `` + Notional service where encryption is performed (e.g., + front-end=Nova). Values: 'front-end', 'back-end' + (Optional) + +.. _cinder_endpoints_v2: + +cinder endpoints (v2) +~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 endpoints + +Discovers endpoints registered by authentication service. + +.. _cinder_extend_v2: + +cinder extend (v2) +~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 extend + +Attempts to extend size of an existing volume. + +Positional arguments +-------------------- + +```` + Name or ID of volume to extend. + +```` + New size of volume, in GiBs. + +.. _cinder_extra-specs-list_v2: + +cinder extra-specs-list (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 extra-specs-list + +Lists current volume types and extra specs. + +.. _cinder_force-delete_v2: + +cinder force-delete (v2) +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 force-delete [ ...] + +Attempts force-delete of volume, regardless of state. + +Positional arguments +-------------------- + +```` + Name or ID of volume or volumes to delete. + +.. _cinder_get-capabilities_v2: + +cinder get-capabilities (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 get-capabilities + +Show backend volume stats and properties. Admin only. + +Positional arguments +-------------------- + +```` + Cinder host to show backend volume stats and properties; takes the + form: host@backend-name + +.. _cinder_get-pools_v2: + +cinder get-pools (v2) +~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 get-pools [--detail] + +Show pool information for backends. Admin only. + +Optional arguments +------------------ + +``--detail`` + Show detailed information about pools. + +.. _cinder_image-metadata_v2: + +cinder image-metadata (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 image-metadata [ ...] + +Sets or deletes volume image metadata. + +Positional arguments +-------------------- + +```` + Name or ID of volume for which to update metadata. + +```` + The action. Valid values are 'set' or 'unset.' + +```` + Metadata key and value pair to set or unset. For unset, specify + only the key. + +.. _cinder_image-metadata-show_v2: + +cinder image-metadata-show (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 image-metadata-show + +Shows volume image metadata. + +Positional arguments +-------------------- + +```` + ID of volume. + +.. _cinder_list_v2: + +cinder list (v2) +~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 list [--all-tenants [<0|1>]] [--name ] [--status ] + [--migration_status ] + [--metadata [ [ ...]]] + [--marker ] [--limit ] + [--sort [:]] [--tenant []] + +Lists all volumes. + +Optional arguments +------------------ + +``--all-tenants [<0|1>]`` + Shows details for all tenants. Admin only. + +``--name `` + Filters results by a name. Default=None. + +``--status `` + Filters results by a status. Default=None. + +``--migration_status `` + Filters results by a migration status. Default=None. + Admin only. + +``--metadata [ [ ...]]`` + Filters results by a metadata key and value pair. + Default=None. + +``--marker `` + Begin returning volumes that appear later in the + volume list than that represented by this volume id. + Default=None. + +``--limit `` + Maximum number of volumes to return. Default=None. + +``--sort [:]`` + Comma-separated list of sort keys and directions in + the form of [:]. Valid keys: id, + status, size, availability_zone, name, bootable, + created_at. Default=None. + +``--tenant []`` + Display information from single tenant (Admin only). + +.. _cinder_list-extensions_v2: + +cinder list-extensions (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 list-extensions + +Lists all available os-api extensions. + +.. _cinder_manage_v2: + +cinder manage (v2) +~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 manage [--id-type ] [--name ] + [--description ] + [--volume-type ] + [--availability-zone ] + [--metadata [ [ ...]]] [--bootable] + + +Manage an existing volume. + +Positional arguments +-------------------- + +```` + Cinder host on which the existing volume resides; + takes the form: host@backend-name#pool + +```` + Name or other Identifier for existing volume + +Optional arguments +------------------ + +``--id-type `` + Type of backend device identifier provided, typically + source-name or source-id (Default=source-name) + +``--name `` + Volume name (Default=None) + +``--description `` + Volume description (Default=None) + +``--volume-type `` + Volume type (Default=None) + +``--availability-zone `` + Availability zone for volume (Default=None) + +``--metadata [ [ ...]]`` + Metadata key=value pairs (Default=None) + +``--bootable`` + Specifies that the newly created volume should be + marked as bootable + +.. _cinder_metadata_v2: + +cinder metadata (v2) +~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 metadata [ ...] + +Sets or deletes volume metadata. + +Positional arguments +-------------------- + +```` + Name or ID of volume for which to update metadata. + +```` + The action. Valid values are "set" or "unset." + +```` + Metadata key and value pair to set or unset. For unset, specify + only the key. + +.. _cinder_metadata-show_v2: + +cinder metadata-show (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 metadata-show + +Shows volume metadata. + +Positional arguments +-------------------- + +```` + ID of volume. + +.. _cinder_metadata-update-all_v2: + +cinder metadata-update-all (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 metadata-update-all [ ...] + +Updates volume metadata. + +Positional arguments +-------------------- + +```` + ID of volume for which to update metadata. + +```` + Metadata key and value pair or pairs to update. + +.. _cinder_migrate_v2: + +cinder migrate (v2) +~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 migrate [--force-host-copy []] + [--lock-volume []] + + +Migrates volume to a new host. + +Positional arguments +-------------------- + +```` + ID of volume to migrate. + +```` + Destination host. Takes the form: host@backend- + name#pool + +Optional arguments +------------------ + +``--force-host-copy []`` + Enables or disables generic host-based force- + migration, which bypasses driver optimizations. + Default=False. + +``--lock-volume []`` + Enables or disables the termination of volume + migration caused by other commands. This option + applies to the available volume. True means it locks + the volume state and does not allow the migration to + be aborted. The volume status will be in maintenance + during the migration. False means it allows the volume + migration to be aborted. The volume status is still in + the original status. Default=False. + +.. _cinder_qos-associate_v2: + +cinder qos-associate (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 qos-associate + +Associates qos specs with specified volume type. + +Positional arguments +-------------------- + +```` + ID of QoS specifications. + +```` + ID of volume type with which to associate QoS + specifications. + +.. _cinder_qos-create_v2: + +cinder qos-create (v2) +~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 qos-create [ ...] + +Creates a qos specs. + +Positional arguments +-------------------- + +```` + Name of new QoS specifications. + +```` + QoS specifications. + +.. _cinder_qos-delete_v2: + +cinder qos-delete (v2) +~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 qos-delete [--force []] + +Deletes a specified qos specs. + +Positional arguments +-------------------- + +```` + ID of QoS specifications to delete. + +Optional arguments +------------------ + +``--force []`` + Enables or disables deletion of in-use QoS + specifications. Default=False. + +.. _cinder_qos-disassociate_v2: + +cinder qos-disassociate (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 qos-disassociate + +Disassociates qos specs from specified volume type. + +Positional arguments +-------------------- + +```` + ID of QoS specifications. + +```` + ID of volume type with which to associate QoS + specifications. + +.. _cinder_qos-disassociate-all_v2: + +cinder qos-disassociate-all (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 qos-disassociate-all + +Disassociates qos specs from all its associations. + +Positional arguments +-------------------- + +```` + ID of QoS specifications on which to operate. + +.. _cinder_qos-get-association_v2: + +cinder qos-get-association (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 qos-get-association + +Lists all associations for specified qos specs. + +Positional arguments +-------------------- + +```` + ID of QoS specifications. + +.. _cinder_qos-key_v2: + +cinder qos-key (v2) +~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 qos-key key=value [key=value ...] + +Sets or unsets specifications for a qos spec. + +Positional arguments +-------------------- + +```` + ID of QoS specifications. + +```` + 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_v2: + +cinder qos-list (v2) +~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 qos-list + +Lists qos specs. + +.. _cinder_qos-show_v2: + +cinder qos-show (v2) +~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 qos-show + +Shows qos specs details. + +Positional arguments +-------------------- + +```` + ID of QoS specifications to show. + +.. _cinder_quota-class-show_v2: + +cinder quota-class-show (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 quota-class-show + +Lists quotas for a quota class. + +Positional arguments +-------------------- + +```` + Name of quota class for which to list quotas. + +.. _cinder_quota-class-update_v2: + +cinder quota-class-update (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 quota-class-update [--volumes ] + [--snapshots ] + [--gigabytes ] + [--volume-type ] + + +Updates quotas for a quota class. + +Positional arguments +-------------------- + +```` + Name of quota class for which to set quotas. + +Optional arguments +------------------ + +``--volumes `` + The new "volumes" quota value. Default=None. + +``--snapshots `` + The new "snapshots" quota value. Default=None. + +``--gigabytes `` + The new "gigabytes" quota value. Default=None. + +``--volume-type `` + Volume type. Default=None. + +.. _cinder_quota-defaults_v2: + +cinder quota-defaults (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 quota-defaults + +Lists default quotas for a tenant. + +Positional arguments +-------------------- + +```` + ID of tenant for which to list quota defaults. + +.. _cinder_quota-delete_v2: + +cinder quota-delete (v2) +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 quota-delete + +Delete the quotas for a tenant. + +Positional arguments +-------------------- + +```` + UUID of tenant to delete the quotas for. + +.. _cinder_quota-show_v2: + +cinder quota-show (v2) +~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 quota-show + +Lists quotas for a tenant. + +Positional arguments +-------------------- + +```` + ID of tenant for which to list quotas. + +.. _cinder_quota-update_v2: + +cinder quota-update (v2) +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 quota-update [--volumes ] [--snapshots ] + [--gigabytes ] [--backups ] + [--backup-gigabytes ] + [--consistencygroups ] + [--volume-type ] + [--per-volume-gigabytes ] + + +Updates quotas for a tenant. + +Positional arguments +-------------------- + +```` + ID of tenant for which to set quotas. + +Optional arguments +------------------ + +``--volumes `` + The new "volumes" quota value. Default=None. + +``--snapshots `` + The new "snapshots" quota value. Default=None. + +``--gigabytes `` + The new "gigabytes" quota value. Default=None. + +``--backups `` + The new "backups" quota value. Default=None. + +``--backup-gigabytes `` + The new "backup_gigabytes" quota value. Default=None. + +``--consistencygroups `` + The new "consistencygroups" quota value. Default=None. + +``--volume-type `` + Volume type. Default=None. + +``--per-volume-gigabytes `` + Set max volume size limit. Default=None. + +.. _cinder_quota-usage_v2: + +cinder quota-usage (v2) +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 quota-usage + +Lists quota usage for a tenant. + +Positional arguments +-------------------- + +```` + ID of tenant for which to list quota usage. + +.. _cinder_rate-limits_v2: + +cinder rate-limits (v2) +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 rate-limits + +Lists rate limits for a user. + +.. _cinder_readonly-mode-update_v2: + +cinder readonly-mode-update (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 readonly-mode-update + +Updates volume read-only access-mode flag. + +Positional arguments +-------------------- + +```` + ID of volume to update. + +```` + Enables or disables update of volume to read-only + access mode. + +.. _cinder_rename_v2: + +cinder rename (v2) +~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 rename [--description ] [] + +Renames a volume. + +Positional arguments +-------------------- + +```` + Name or ID of volume to rename. + +```` + New name for volume. + +Optional arguments +------------------ + +``--description `` + Volume description. Default=None. + +.. _cinder_replication-disable_v2: + +cinder replication-disable (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 replication-disable + +Disables volume replication on a given volume. + +Positional arguments +-------------------- + +```` + ID of volume to disable replication. + +.. _cinder_replication-enable_v2: + +cinder replication-enable (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 replication-enable + +Enables volume replication on a given volume. + +Positional arguments +-------------------- + +```` + ID of volume to enable replication. + +.. _cinder_replication-failover_v2: + +cinder replication-failover (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 replication-failover + +Failover a volume to a secondary target + +Positional arguments +-------------------- + +```` + ID of volume to failover. + +```` + A unqiue identifier that represents a failover target. + +.. _cinder_replication-list-targets_v2: + +cinder replication-list-targets (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 replication-list-targets + +List replication targets available for a volume. + +Positional arguments +-------------------- + +```` + ID of volume to list available replication targets. + +.. _cinder_replication-promote_v2: + +cinder replication-promote (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 replication-promote + +Promote a secondary volume to primary for a relationship. + +Positional arguments +-------------------- + +```` + Name or ID of the volume to promote. The volume should have the + replica volume created with source-replica argument. + +.. _cinder_replication-reenable_v2: + +cinder replication-reenable (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 replication-reenable + +Sync the secondary volume with primary for a relationship. + +Positional arguments +-------------------- + +```` + Name or ID of the volume to reenable replication. The replication- + status of the volume should be inactive. + +.. _cinder_reset-state_v2: + +cinder reset-state (v2) +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 reset-state [--state ] [--attach-status ] + [--reset-migration-status] + [ ...] + +Explicitly updates the volume state in the Cinder database. Note that this +does not affect whether the volume is actually attached to the Nova compute +host or instance and can result in an unusable volume. Being a database change +only, this has no impact on the true state of the volume and may not match the +actual state. This can render a volume unusable in the case of change to the +'available' state. + +Positional arguments +-------------------- + +```` + Name or ID of volume to modify. + +Optional arguments +------------------ + +``--state `` + The state to assign to the volume. Valid values are + "available", "error", "creating", "deleting", "in- + use", "attaching", "detaching", "error_deleting" and + "maintenance". NOTE: This command simply changes the + state of the Volume in the DataBase with no regard to + actual status, exercise caution when using. + Default=available. + +``--attach-status `` + The attach status to assign to the volume in the + DataBase, with no regard to the actual status. Valid + values are "attached" and "detached". Default=None, + that means the status is unchanged. + +``--reset-migration-status`` + Clears the migration status of the volume in the + DataBase that indicates the volume is source or + destination of volume migration, with no regard to the + actual status. + +.. _cinder_retype_v2: + +cinder retype (v2) +~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 retype [--migration-policy ] + + +Changes the volume type for a volume. + +Positional arguments +-------------------- + +```` + Name or ID of volume for which to modify type. + +```` + New volume type. + +Optional arguments +------------------ + +``--migration-policy `` + Migration policy during retype of volume. + +.. _cinder_service-disable_v2: + +cinder service-disable (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 service-disable [--reason ] + +Disables the service. + +Positional arguments +-------------------- + +```` + Host name. + +```` + Service binary. + +Optional arguments +------------------ + +``--reason `` + Reason for disabling service. + +.. _cinder_service-enable_v2: + +cinder service-enable (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 service-enable + +Enables the service. + +Positional arguments +-------------------- + +```` + Host name. + +```` + Service binary. + +.. _cinder_service-list_v2: + +cinder service-list (v2) +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 service-list [--host ] [--binary ] + +Lists all services. Filter by host and service binary. + +Optional arguments +------------------ + +``--host `` + Host name. Default=None. + +``--binary `` + Service binary. Default=None. + +.. _cinder_set-bootable_v2: + +cinder set-bootable (v2) +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 set-bootable + +Update bootable status of a volume. + +Positional arguments +-------------------- + +```` + ID of the volume to update. + +```` + Flag to indicate whether volume is bootable. + +.. _cinder_show_v2: + +cinder show (v2) +~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 show + +Shows volume details. + +Positional arguments +-------------------- + +```` + Name or ID of volume. + +.. _cinder_snapshot-create_v2: + +cinder snapshot-create (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 snapshot-create [--force []] [--name ] + [--description ] + [--metadata [ [ ...]]] + + +Creates a snapshot. + +Positional arguments +-------------------- + +```` + Name or ID of volume to snapshot. + +Optional arguments +------------------ + +``--force []`` + 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. + +``--name `` + Snapshot name. Default=None. + +``--description `` + Snapshot description. Default=None. + +``--metadata [ [ ...]]`` + Snapshot metadata key and value pairs. Default=None. + +.. _cinder_snapshot-delete_v2: + +cinder snapshot-delete (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 snapshot-delete [ ...] + +Removes one or more snapshots. + +Positional arguments +-------------------- + +```` + Name or ID of the snapshot(s) to delete. + +.. _cinder_snapshot-list_v2: + +cinder snapshot-list (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 snapshot-list [--all-tenants [<0|1>]] [--name ] + [--status ] [--volume-id ] + [--marker ] [--limit ] + [--sort [:]] + +Lists all snapshots. + +Optional arguments +------------------ + +``--all-tenants [<0|1>]`` + Shows details for all tenants. Admin only. + +``--name `` + Filters results by a name. Default=None. + +``--status `` + Filters results by a status. Default=None. + +``--volume-id `` + Filters results by a volume ID. Default=None. + +``--marker `` + Begin returning snapshots that appear later in the + snapshot list than that represented by this id. + Default=None. + +``--limit `` + Maximum number of snapshots to return. Default=None. + +``--sort [:]`` + Comma-separated list of sort keys and directions in + the form of [:]. Valid keys: id, + status, size, availability_zone, name, bootable, + created_at. Default=None. + +.. _cinder_snapshot-metadata_v2: + +cinder snapshot-metadata (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 snapshot-metadata + [ ...] + +Sets or deletes snapshot metadata. + +Positional arguments +-------------------- + +```` + ID of snapshot for which to update metadata. + +```` + The action. Valid values are "set" or "unset." + +```` + Metadata key and value pair to set or unset. For unset, specify + only the key. + +.. _cinder_snapshot-metadata-show_v2: + +cinder snapshot-metadata-show (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 snapshot-metadata-show + +Shows snapshot metadata. + +Positional arguments +-------------------- + +```` + ID of snapshot. + +.. _cinder_snapshot-metadata-update-all_v2: + +cinder snapshot-metadata-update-all (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 snapshot-metadata-update-all + [ ...] + +Updates snapshot metadata. + +Positional arguments +-------------------- + +```` + ID of snapshot for which to update metadata. + +```` + Metadata key and value pair to update. + +.. _cinder_snapshot-rename_v2: + +cinder snapshot-rename (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 snapshot-rename [--description ] + [] + +Renames a snapshot. + +Positional arguments +-------------------- + +```` + Name or ID of snapshot. + +```` + New name for snapshot. + +Optional arguments +------------------ + +``--description `` + Snapshot description. Default=None. + +.. _cinder_snapshot-reset-state_v2: + +cinder snapshot-reset-state (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 snapshot-reset-state [--state ] + [ ...] + +Explicitly updates the snapshot state. + +Positional arguments +-------------------- + +```` + Name or ID of snapshot to modify. + +Optional arguments +------------------ + +``--state `` + The state to assign to the snapshot. Valid values are + "available", "error", "creating", "deleting", and + "error_deleting". NOTE: This command simply changes the + state of the Snapshot in the DataBase with no regard to + actual status, exercise caution when using. + Default=available. + +.. _cinder_snapshot-show_v2: + +cinder snapshot-show (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 snapshot-show + +Shows snapshot details. + +Positional arguments +-------------------- + +```` + Name or ID of snapshot. + +.. _cinder_transfer-accept_v2: + +cinder transfer-accept (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 transfer-accept + +Accepts a volume transfer. + +Positional arguments +-------------------- + +```` + ID of transfer to accept. + +```` + Authentication key of transfer to accept. + +.. _cinder_transfer-create_v2: + +cinder transfer-create (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 transfer-create [--name ] + +Creates a volume transfer. + +Positional arguments +-------------------- + +```` + Name or ID of volume to transfer. + +Optional arguments +------------------ + +``--name `` + Transfer name. Default=None. + +.. _cinder_transfer-delete_v2: + +cinder transfer-delete (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 transfer-delete + +Undoes a transfer. + +Positional arguments +-------------------- + +```` + Name or ID of transfer to delete. + +.. _cinder_transfer-list_v2: + +cinder transfer-list (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 transfer-list [--all-tenants [<0|1>]] + +Lists all transfers. + +Optional arguments +------------------ + +``--all-tenants [<0|1>]`` + Shows details for all tenants. Admin only. + +.. _cinder_transfer-show_v2: + +cinder transfer-show (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 transfer-show + +Shows transfer details. + +Positional arguments +-------------------- + +```` + Name or ID of transfer to accept. + +.. _cinder_type-access-add_v2: + +cinder type-access-add (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 type-access-add --volume-type --project-id + + +Adds volume type access for the given project. + +Optional arguments +------------------ + +``--volume-type `` + Volume type name or ID to add access for the given + project. + +``--project-id `` + Project ID to add volume type access for. + +.. _cinder_type-access-list_v2: + +cinder type-access-list (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 type-access-list --volume-type + +Print access information about the given volume type. + +Optional arguments +------------------ + +``--volume-type `` + Filter results by volume type name or ID. + +.. _cinder_type-access-remove_v2: + +cinder type-access-remove (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 type-access-remove --volume-type --project-id + + +Removes volume type access for the given project. + +Optional arguments +------------------ + +``--volume-type `` + Volume type name or ID to remove access for the given + project. + +``--project-id `` + Project ID to remove volume type access for. + +.. _cinder_type-create_v2: + +cinder type-create (v2) +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 type-create [--description ] + [--is-public ] + + +Creates a volume type. + +Positional arguments +-------------------- + +```` + Name of new volume type. + +Optional arguments +------------------ + +``--description `` + Description of new volume type. + +``--is-public `` + Make type accessible to the public (default true). + +.. _cinder_type-default_v2: + +cinder type-default (v2) +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 type-default + +List the default volume type. + +.. _cinder_type-delete_v2: + +cinder type-delete (v2) +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 type-delete + +Deletes a volume type. + +Positional arguments +-------------------- + +```` + ID of volume type to delete. + +.. _cinder_type-key_v2: + +cinder type-key (v2) +~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 type-key [ ...] + +Sets or unsets extra_spec for a volume type. + +Positional arguments +-------------------- + +```` + Name or ID of volume type. + +```` + The action. Valid values are "set" or "unset." + +```` + The extra specs key and value pair to set or unset. For unset, + specify only the key. + +.. _cinder_type-list_v2: + +cinder type-list (v2) +~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 type-list + +Lists available 'volume types'. (Admin only will see private types) + +.. _cinder_type-show_v2: + +cinder type-show (v2) +~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 type-show + +Show volume type details. + +Positional arguments +-------------------- + +```` + Name or ID of the volume type. + +.. _cinder_type-update_v2: + +cinder type-update (v2) +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 type-update [--name ] [--description ] + [--is-public ] + + +Updates volume type name ,description and/or is_public. + +Positional arguments +-------------------- + +```` + ID of the volume type. + +Optional arguments +------------------ + +``--name `` + Name of the volume type. + +``--description `` + Description of the volume type. + +``--is-public `` + Make type accessible to the public or not. + +.. _cinder_unmanage_v2: + +cinder unmanage (v2) +~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 unmanage + +Stop managing a volume. + +Positional arguments +-------------------- + +```` + Name or ID of the volume to unmanage. + +.. _cinder_upload-to-image_v2: + +cinder upload-to-image (v2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: cinder --os-volume-api-version 2 upload-to-image [--force []] + [--container-format ] + [--disk-format ] + + +Uploads volume to Image Service as an image. + +Positional arguments +-------------------- + +```` + Name or ID of volume to snapshot. + +```` + The new image name. + +Optional arguments +------------------ + +``--force []`` + Enables or disables upload of a volume that is + attached to an instance. Default=False. + +``--container-format `` + Container format type. Default is bare. + +``--disk-format `` + Disk format type. Default is raw. + diff --git a/doc/cli-ref-rst/source/index.rst b/doc/cli-ref-rst/source/index.rst index 1cb9ef30b9..b22c3c22e0 100644 --- a/doc/cli-ref-rst/source/index.rst +++ b/doc/cli-ref-rst/source/index.rst @@ -19,6 +19,7 @@ Contents overview murano ironic + cinder neutron-misc common/app_support