-
Language:
English
-
Language:
English
Red Hat Training
A Red Hat training course is available for Red Hat OpenStack Platform
4.3. Block Storage API v1 Commands
4.3.1. cinder absolute-limits
usage: cinder absolute-limits [<tenant_id>]
Positional arguments
- <tenant_id>
Display information for a single tenant (Admin only).
4.3.2. cinder availability-zone-list
usage: cinder availability-zone-list
4.3.3. cinder backup-create
usage: cinder backup-create [--container <container>] [--name <name>] [--description <description>] [--incremental] [--force] [--snapshot-id <snapshot-id>] <volume>
Positional arguments
- <volume>
Name or ID of volume to backup.
Optional arguments
- --container <container>
Backup container name. Default=None.
- --name <name>
Backup name. Default=None.
- --description <description>
Backup description. Default=None.
- --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.
- --snapshot-id <snapshot-id>
ID of snapshot to backup. Default=None.
4.3.4. cinder backup-delete
usage: cinder backup-delete [--force] <backup> [<backup> ...]
Positional arguments
- <backup>
Name or ID of backup(s) to delete.
Optional arguments
- --force
Allows deleting backup of a volume when its status is other than
"available" or "error". Default=False.
4.3.5. cinder backup-export
usage: cinder backup-export <backup>
Positional arguments
- <backup>
ID of the backup to export.
4.3.6. cinder backup-import
usage: cinder backup-import <backup_service> <backup_url>
Positional arguments
- <backup_service>
Backup service to use for importing the backup.
- <backup_url>
Backup URL for importing the backup metadata.
4.3.7. cinder backup-list
usage: cinder backup-list [--all-tenants [<all_tenants>]] [--name <name>] [--status <status>] [--volume-id <volume-id>] [--marker <marker>] [--limit <limit>] [--sort <key>[:<direction>]]
Optional arguments
- --all-tenants [<all_tenants>]
Shows details for all tenants. Admin only.
- --name <name>
Filters results by a name. Default=None.
- --status <status>
Filters results by a status. Default=None.
- --volume-id <volume-id>
Filters results by a volume ID. Default=None.
- --marker <marker>
Begin returning backups that appear later in the
backup list than that represented by this id.
Default=None.
- --limit <limit>
Maximum number of backups to return. Default=None.
- --sort <key>[:<direction>]
Comma-separated list of sort keys and directions in
the form of <key>[:<asc|desc>]. Valid keys: id,
status, size, availability_zone, name, bootable,
created_at, reference. Default=None.
4.3.8. cinder backup-reset-state
usage: cinder backup-reset-state [--state <state>] <backup> [<backup> ...]
Positional arguments
- <backup>
Name or ID of the backup to modify.
Optional arguments
- --state <state>
The state to assign to the backup. Valid values are
"available", "error". Default=available.
4.3.9. cinder backup-restore
usage: cinder backup-restore [--volume <volume>] [--name <name>] <backup>
Positional arguments
- <backup>
Name or ID of backup to restore.
Optional arguments
- --volume <volume>
Name or ID of existing volume to which to restore. This
is mutually exclusive with --name and takes priority.
Default=None.
- --name <name>
Use the name for new volume creation to restore. This is
mutually exclusive with --volume (or the deprecated
--volume-id) and --volume (or --volume-id) takes
priority. Default=None.
4.3.10. cinder backup-show
usage: cinder backup-show <backup>
Positional arguments
- <backup>
Name or ID of backup.
4.3.11. cinder cgsnapshot-create
usage: cinder cgsnapshot-create [--name <name>] [--description <description>] <consistencygroup>
Positional arguments
- <consistencygroup>
Name or ID of a consistency group.
Optional arguments
- --name <name>
Cgsnapshot name. Default=None.
- --description <description>
Cgsnapshot description. Default=None.
4.3.12. cinder cgsnapshot-delete
usage: cinder cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]
Positional arguments
- <cgsnapshot>
Name or ID of one or more cgsnapshots to be deleted.
4.3.13. cinder cgsnapshot-list
usage: cinder cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>] [--consistencygroup-id <consistencygroup_id>]
Optional arguments
- --all-tenants [<0|1>]
Shows details for all tenants. Admin only.
- --status <status>
Filters results by a status. Default=None.
- --consistencygroup-id <consistencygroup_id>
Filters results by a consistency group ID.
Default=None.
4.3.14. cinder cgsnapshot-show
usage: cinder cgsnapshot-show <cgsnapshot>
Positional arguments
- <cgsnapshot>
Name or ID of cgsnapshot.
4.3.15. cinder consisgroup-create
usage: cinder consisgroup-create [--name <name>] [--description <description>] [--availability-zone <availability-zone>] <volume-types>
Positional arguments
- <volume-types>
Volume types.
Optional arguments
- --name <name>
Name of a consistency group.
- --description <description>
Description of a consistency group. Default=None.
- --availability-zone <availability-zone>
Availability zone for volume. Default=None.
4.3.16. cinder consisgroup-create-from-src
usage: cinder consisgroup-create-from-src [--cgsnapshot <cgsnapshot>] [--source-cg <source-cg>] [--name <name>] [--description <description>]
Optional arguments
- --cgsnapshot <cgsnapshot>
Name or ID of a cgsnapshot. Default=None.
- --source-cg <source-cg>
Name or ID of a source CG. Default=None.
- --name <name>
Name of a consistency group. Default=None.
- --description <description>
Description of a consistency group. Default=None.
4.3.17. cinder consisgroup-delete
usage: cinder consisgroup-delete [--force] <consistencygroup> [<consistencygroup> ...]
Positional arguments
- <consistencygroup>
Name or ID of one or more consistency groups to be
deleted.
Optional arguments
- --force
Allows or disallows consistency groups to be deleted. If
the consistency group is empty, it can be deleted
without the force flag. If the consistency group is not
empty, the force flag is required for it to be deleted.
4.3.18. cinder consisgroup-list
usage: cinder consisgroup-list [--all-tenants [<0|1>]]
Optional arguments
- --all-tenants [<0|1>]
Shows details for all tenants. Admin only.
4.3.19. cinder consisgroup-show
usage: cinder consisgroup-show <consistencygroup>
Positional arguments
- <consistencygroup>
Name or ID of a consistency group.
4.3.20. cinder consisgroup-update
usage: cinder consisgroup-update [--name <name>] [--description <description>] [--add-volumes <uuid1,uuid2,......>] [--remove-volumes <uuid3,uuid4,......>] <consistencygroup>
Positional arguments
- <consistencygroup>
Name or ID of a consistency group.
Optional arguments
- --name <name>
New name for consistency group. Default=None.
- --description <description>
New description for consistency group. Default=None.
- --add-volumes <uuid1,uuid2,......>
UUID of one or more volumes to be added to the
consistency group, separated by commas. Default=None.
- --remove-volumes <uuid3,uuid4,......>
UUID of one or more volumes to be removed from the
consistency group, separated by commas. Default=None.
4.3.21. cinder create
usage: cinder create [--consisgroup-id <consistencygroup-id>] [--snapshot-id <snapshot-id>] [--source-volid <source-volid>] [--source-replica <source-replica>] [--image-id <image-id>] [--image <image>] [--name <name>] [--description <description>] [--volume-type <volume-type>] [--availability-zone <availability-zone>] [--metadata [<key=value> [<key=value> ...]]] [--hint <key=value>] [--allow-multiattach] [<size>]
Positional arguments
- <size>
Size of volume, in GiBs. (Required unless snapshot-id
/source-volid is specified).
Optional arguments
- --consisgroup-id <consistencygroup-id>
ID of a consistency group where the new volume belongs
to. Default=None.
- --snapshot-id <snapshot-id>
Creates volume from snapshot ID. Default=None.
- --source-volid <source-volid>
Creates volume from volume ID. Default=None.
- --source-replica <source-replica>
Creates volume from replicated volume ID.
Default=None.
- --image-id <image-id>
Creates volume from image ID. Default=None.
- --image <image>
Creates a volume from image (ID or name).
Default=None.
- --name <name>
Volume name. Default=None.
- --description <description>
Volume description. Default=None.
- --volume-type <volume-type>
Volume type. Default=None.
- --availability-zone <availability-zone>
Availability zone for volume. Default=None.
- --metadata [<key=value> [<key=value> ...]]
Metadata key and value pairs. Default=None.
- --hint <key=value>
Scheduler hint, like in nova.
- --allow-multiattach
Allow volume to be attached more than once.
Default=False
4.3.22. cinder credentials
usage: cinder credentials
4.3.23. cinder delete
usage: cinder delete [--cascade] <volume> [<volume> ...]
Positional arguments
- <volume>
Name or ID of volume or volumes to delete.
Optional arguments
- --cascade
Remove any snapshots along with volume. Default=False.
4.3.24. cinder encryption-type-create
usage: cinder encryption-type-create [--cipher <cipher>] [--key_size <key_size>] [--control_location <control_location>] <volume_type> <provider>
Positional arguments
- <volume_type>
Name or ID of volume type.
- <provider>
The class that provides encryption support. For
example, LuksEncryptor.
Optional arguments
- --cipher <cipher>
The encryption algorithm or mode. For example, aes-
xts-plain64. Default=None.
- --key_size <key_size>
Size of encryption key, in bits. For example, 128 or
256. Default=None.
- --control_location <control_location>
Notional service where encryption is performed. Valid
values are "front-end" or "back-end." For example,
front-end=Nova. Default is "front-end."
4.3.25. cinder encryption-type-delete
usage: cinder encryption-type-delete <volume_type>
Positional arguments
- <volume_type>
Name or ID of volume type.
4.3.26. cinder encryption-type-list
usage: cinder encryption-type-list
4.3.27. cinder encryption-type-show
usage: cinder encryption-type-show <volume_type>
Positional arguments
- <volume_type>
Name or ID of volume type.
4.3.28. cinder encryption-type-update
usage: cinder encryption-type-update [--provider <provider>] [--cipher [<cipher>]] [--key-size [<key-size>]] [--control-location <control-location>] <volume-type>
Positional arguments
- <volume-type>
Name or ID of the volume type
Optional arguments
- --provider <provider>
Class providing encryption support (e.g.
LuksEncryptor) (Optional)
- --cipher [<cipher>]
Encryption algorithm/mode to use (e.g., aes-xts-
plain64). Provide parameter without value to set to
provider default. (Optional)
- --key-size [<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 <control-location>
Notional service where encryption is performed (e.g.,
front-end=Nova). Values: 'front-end', 'back-end'
(Optional)
4.3.29. cinder endpoints
usage: cinder endpoints
4.3.30. cinder extend
usage: cinder extend <volume> <new_size>
Positional arguments
- <volume>
Name or ID of volume to extend.
- <new_size>
New size of volume, in GiBs.
4.3.31. cinder extra-specs-list
usage: cinder extra-specs-list
4.3.32. cinder failover-host
usage: cinder failover-host [--backend_id <backend-id>] <hostname>
Positional arguments
- <hostname>
Host name.
Optional arguments
- --backend_id <backend-id>
ID of backend to failover to (Default=None)
4.3.33. cinder force-delete
usage: cinder force-delete <volume> [<volume> ...]
Positional arguments
- <volume>
Name or ID of volume or volumes to delete.
4.3.34. cinder freeze-host
usage: cinder freeze-host <hostname>
Positional arguments
- <hostname>
Host name.
4.3.35. cinder get-capabilities
usage: cinder get-capabilities <host>
Positional arguments
- <host>
Cinder host to show backend volume stats and properties; takes the
form: host@backend-name
4.3.36. cinder get-pools
usage: cinder get-pools [--detail]
Optional arguments
- --detail
Show detailed information about pools.
4.3.37. cinder group-show
usage: cinder group-show <group>
Positional arguments
- <group>
Name or ID of a group.
4.3.38. cinder image-metadata
usage: cinder image-metadata <volume> <action> <key=value> [<key=value> ...]
Positional arguments
- <volume>
Name or ID of volume for which to update metadata.
- <action>
The action. Valid values are 'set' or 'unset.'
- <key=value>
Metadata key and value pair to set or unset. For unset, specify
only the key.
4.3.39. cinder image-metadata-show
usage: cinder image-metadata-show <volume>
Positional arguments
- <volume>
ID of volume.
4.3.40. cinder list
usage: cinder list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] [--bootable [<True|true|False|false>]] [--migration_status <migration_status>] [--metadata [<key=value> [<key=value> ...]]] [--marker <marker>] [--limit <limit>] [--fields <fields>] [--sort <key>[:<direction>]] [--tenant [<tenant>]]
Optional arguments
- --all-tenants [<0|1>]
Shows details for all tenants. Admin only.
- --name <name>
Filters results by a name. Default=None.
- --status <status>
Filters results by a status. Default=None.
- --bootable [<True|true|False|false>]
Filters results by bootable status. Default=None.
- --migration_status <migration_status>
Filters results by a migration status. Default=None.
Admin only.
- --metadata [<key=value> [<key=value> ...]]
Filters results by a metadata key and value pair.
Default=None.
- --marker <marker>
Begin returning volumes that appear later in the
volume list than that represented by this volume id.
Default=None.
- --limit <limit>
Maximum number of volumes to return. Default=None.
- --fields <fields>
Comma-separated list of fields to display. Use the
show command to see which fields are available.
Unavailable/non-existent fields will be ignored.
Default=None.
- --sort <key>[:<direction>]
Comma-separated list of sort keys and directions in
the form of <key>[:<asc|desc>]. Valid keys: id,
status, size, availability_zone, name, bootable,
created_at, reference. Default=None.
- --tenant [<tenant>]
Display information from single tenant (Admin only).
4.3.41. cinder list-extensions
usage: cinder list-extensions
4.3.42. cinder manage
usage: cinder manage [--id-type <id-type>] [--name <name>] [--description <description>] [--volume-type <volume-type>] [--availability-zone <availability-zone>] [--metadata [<key=value> [<key=value> ...]]] [--bootable] <host> <identifier>
Positional arguments
- <host>
Cinder host on which the existing volume resides;
takes the form: host@backend-name#pool
- <identifier>
Name or other Identifier for existing volume
Optional arguments
- --id-type <id-type>
Type of backend device identifier provided, typically
source-name or source-id (Default=source-name)
- --name <name>
Volume name (Default=None)
- --description <description>
Volume description (Default=None)
- --volume-type <volume-type>
Volume type (Default=None)
- --availability-zone <availability-zone>
Availability zone for volume (Default=None)
- --metadata [<key=value> [<key=value> ...]]
Metadata key=value pairs (Default=None)
- --bootable
Specifies that the newly created volume should be
marked as bootable
4.3.43. cinder manageable-list
usage: cinder manageable-list [--detailed <detailed>] [--marker <marker>] [--limit <limit>] [--offset <offset>] [--sort <key>[:<direction>]] <host>
Positional arguments
- <host>
Cinder host on which to list manageable volumes; takes
the form: host@backend-name#pool
Optional arguments
- --detailed <detailed>
Returned detailed information (default true).
- --marker <marker>
Begin returning volumes that appear later in the
volume list than that represented by this volume id.
Default=None.
- --limit <limit>
Maximum number of volumes to return. Default=None.
- --offset <offset>
Number of volumes to skip after marker. Default=None.
- --sort <key>[:<direction>]
Comma-separated list of sort keys and directions in
the form of <key>[:<asc|desc>]. Valid keys: id,
status, size, availability_zone, name, bootable,
created_at, reference. Default=None.
4.3.44. cinder metadata
usage: cinder metadata <volume> <action> <key=value> [<key=value> ...]
Positional arguments
- <volume>
Name or ID of volume for which to update metadata.
- <action>
The action. Valid values are "set" or "unset."
- <key=value>
Metadata key and value pair to set or unset. For unset, specify
only the key. Supported until API version 3.14)
4.3.45. cinder metadata-show
usage: cinder metadata-show <volume>
Positional arguments
- <volume>
ID of volume.
4.3.46. cinder metadata-update-all
usage: cinder metadata-update-all <volume> <key=value> [<key=value> ...]
Positional arguments
- <volume>
ID of volume for which to update metadata.
- <key=value>
Metadata key and value pair or pairs to update.
4.3.47. cinder migrate
usage: cinder migrate [--force-host-copy [<True|False>]] [--lock-volume [<True|False>]] <volume> <host>
Positional arguments
- <volume>
ID of volume to migrate.
- <host>
Destination host. Takes the form: host@backend-
name#pool
Optional arguments
- --force-host-copy [<True|False>]
Enables or disables generic host-based force-
migration, which bypasses driver optimizations.
Default=False.
- --lock-volume [<True|False>]
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.
4.3.48. cinder qos-associate
usage: cinder qos-associate <qos_specs> <volume_type_id>
Positional arguments
- <qos_specs>
ID of QoS specifications.
- <volume_type_id>
ID of volume type with which to associate QoS
specifications.
4.3.49. cinder qos-create
usage: cinder qos-create <name> <key=value> [<key=value> ...]
Positional arguments
- <name>
Name of new QoS specifications.
- <key=value>
QoS specifications.
4.3.50. cinder qos-delete
usage: cinder qos-delete [--force [<True|False>]] <qos_specs>
Positional arguments
- <qos_specs>
ID of QoS specifications to delete.
Optional arguments
- --force [<True|False>]
Enables or disables deletion of in-use QoS
specifications. Default=False.
4.3.51. cinder qos-disassociate
usage: cinder qos-disassociate <qos_specs> <volume_type_id>
Positional arguments
- <qos_specs>
ID of QoS specifications.
- <volume_type_id>
ID of volume type with which to associate QoS
specifications.
4.3.52. cinder qos-disassociate-all
usage: cinder qos-disassociate-all <qos_specs>
Positional arguments
- <qos_specs>
ID of QoS specifications on which to operate.
4.3.53. cinder qos-get-association
usage: cinder qos-get-association <qos_specs>
Positional arguments
- <qos_specs>
ID of QoS specifications.
4.3.54. cinder qos-key
usage: cinder qos-key <qos_specs> <action> key=value [key=value ...]
Positional arguments
- <qos_specs>
ID of QoS specifications.
- <action>
The action. Valid values are "set" or "unset."
- key=value
Metadata key and value pair to set or unset. For unset, specify
only the key.
4.3.55. cinder qos-list
usage: cinder qos-list
4.3.56. cinder qos-show
usage: cinder qos-show <qos_specs>
Positional arguments
- <qos_specs>
ID of QoS specifications to show.
4.3.57. cinder quota-class-show
usage: cinder quota-class-show <class>
Positional arguments
- <class>
Name of quota class for which to list quotas.
4.3.58. cinder quota-class-update
usage: cinder quota-class-update [--volumes <volumes>] [--snapshots <snapshots>] [--gigabytes <gigabytes>] [--volume-type <volume_type_name>] <class_name>
Positional arguments
- <class_name>
Name of quota class for which to set quotas.
Optional arguments
- --volumes <volumes>
The new "volumes" quota value. Default=None.
- --snapshots <snapshots>
The new "snapshots" quota value. Default=None.
- --gigabytes <gigabytes>
The new "gigabytes" quota value. Default=None.
- --volume-type <volume_type_name>
Volume type. Default=None.
4.3.59. cinder quota-defaults
usage: cinder quota-defaults <tenant_id>
Positional arguments
- <tenant_id>
ID of tenant for which to list quota defaults.
4.3.60. cinder quota-delete
usage: cinder quota-delete <tenant_id>
Positional arguments
- <tenant_id>
UUID of tenant to delete the quotas for.
4.3.61. cinder quota-show
usage: cinder quota-show <tenant_id>
Positional arguments
- <tenant_id>
ID of tenant for which to list quotas.
4.3.62. cinder quota-update
usage: cinder quota-update [--volumes <volumes>] [--snapshots <snapshots>] [--gigabytes <gigabytes>] [--backups <backups>] [--backup-gigabytes <backup_gigabytes>] [--consistencygroups <consistencygroups>] [--volume-type <volume_type_name>] [--per-volume-gigabytes <per_volume_gigabytes>] <tenant_id>
Positional arguments
- <tenant_id>
ID of tenant for which to set quotas.
Optional arguments
- --volumes <volumes>
The new "volumes" quota value. Default=None.
- --snapshots <snapshots>
The new "snapshots" quota value. Default=None.
- --gigabytes <gigabytes>
The new "gigabytes" quota value. Default=None.
- --backups <backups>
The new "backups" quota value. Default=None.
- --backup-gigabytes <backup_gigabytes>
The new "backup_gigabytes" quota value. Default=None.
- --consistencygroups <consistencygroups>
The new "consistencygroups" quota value. Default=None.
- --volume-type <volume_type_name>
Volume type. Default=None.
- --per-volume-gigabytes <per_volume_gigabytes>
Set max volume size limit. Default=None.
4.3.63. cinder quota-usage
usage: cinder quota-usage <tenant_id>
Positional arguments
- <tenant_id>
ID of tenant for which to list quota usage.
4.3.64. cinder rate-limits
usage: cinder rate-limits [<tenant_id>]
Positional arguments
- <tenant_id>
Display information for a single tenant (Admin only).
4.3.65. cinder readonly-mode-update
usage: cinder readonly-mode-update <volume> <True|true|False|false>
Positional arguments
- <volume>
ID of volume to update.
- <True|true|False|false>
Enables or disables update of volume to read-only
access mode.
4.3.66. cinder rename
usage: cinder rename [--description <description>] <volume> [<name>]
Positional arguments
- <volume>
Name or ID of volume to rename.
- <name>
New name for volume.
Optional arguments
- --description <description>
Volume description. Default=None.
4.3.67. cinder replication-promote
usage: cinder replication-promote <volume>
Positional arguments
- <volume>
Name or ID of the volume to promote. The volume should have the
replica volume created with source-replica argument.
4.3.68. cinder replication-reenable
usage: cinder replication-reenable <volume>
Positional arguments
- <volume>
Name or ID of the volume to reenable replication. The replication-
status of the volume should be inactive.
4.3.69. cinder reset-state
usage: cinder reset-state [--state <state>] [--attach-status <attach-status>] [--reset-migration-status] <volume> [<volume> ...]
Positional arguments
- <volume>
Name or ID of volume to modify.
Optional arguments
- --state <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=None, that means the state is unchanged.
- --attach-status <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.
4.3.70. cinder retype
usage: cinder retype [--migration-policy <never|on-demand>] <volume> <volume-type>
Positional arguments
- <volume>
Name or ID of volume for which to modify type.
- <volume-type>
New volume type.
Optional arguments
- --migration-policy <never|on-demand>
Migration policy during retype of volume.
4.3.71. cinder service-disable
usage: cinder service-disable [--reason <reason>] <hostname> <binary>
Positional arguments
- <hostname>
Host name.
- <binary>
Service binary.
Optional arguments
- --reason <reason>
Reason for disabling service.
4.3.72. cinder service-enable
usage: cinder service-enable <hostname> <binary>
Positional arguments
- <hostname>
Host name.
- <binary>
Service binary.
4.3.73. cinder service-list
usage: cinder service-list [--host <hostname>] [--binary <binary>] [--withreplication [<True|False>]]
Optional arguments
- --host <hostname>
Host name. Default=None.
- --binary <binary>
Service binary. Default=None.
- --withreplication [<True|False>]
Enables or disables display of Replication info for
c-vol services. Default=False.
4.3.74. cinder set-bootable
usage: cinder set-bootable <volume> <True|true|False|false>
Positional arguments
- <volume>
ID of the volume to update.
- <True|true|False|false>
Flag to indicate whether volume is bootable.
4.3.75. cinder show
usage: cinder show <volume>
Positional arguments
- <volume>
Name or ID of volume.
4.3.76. cinder snapshot-create
usage: cinder snapshot-create [--force [<True|False>]] [--name <name>] [--description <description>] [--metadata [<key=value> [<key=value> ...]]] <volume>
Positional arguments
- <volume>
Name or ID of volume to snapshot.
Optional arguments
- --force [<True|False>]
Allows or disallows snapshot of a volume when the
volume is attached to an instance. If set to True,
ignores the current status of the volume when
attempting to snapshot it rather than forcing it to be
available. Default=False.
- --name <name>
Snapshot name. Default=None.
- --description <description>
Snapshot description. Default=None.
- --metadata [<key=value> [<key=value> ...]]
Snapshot metadata key and value pairs. Default=None.
4.3.77. cinder snapshot-delete
usage: cinder snapshot-delete [--force] <snapshot> [<snapshot> ...]
Positional arguments
- <snapshot>
Name or ID of the snapshot(s) to delete.
Optional arguments
- --force
Allows deleting snapshot of a volume when its status is other
than "available" or "error". Default=False.
4.3.78. cinder snapshot-list
usage: cinder snapshot-list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] [--volume-id <volume-id>] [--marker <marker>] [--limit <limit>] [--sort <key>[:<direction>]] [--tenant [<tenant>]]
Optional arguments
- --all-tenants [<0|1>]
Shows details for all tenants. Admin only.
- --name <name>
Filters results by a name. Default=None.
- --status <status>
Filters results by a status. Default=None.
- --volume-id <volume-id>
Filters results by a volume ID. Default=None.
- --marker <marker>
Begin returning snapshots that appear later in the
snapshot list than that represented by this id.
Default=None.
- --limit <limit>
Maximum number of snapshots to return. Default=None.
- --sort <key>[:<direction>]
Comma-separated list of sort keys and directions in
the form of <key>[:<asc|desc>]. Valid keys: id,
status, size, availability_zone, name, bootable,
created_at, reference. Default=None.
- --tenant [<tenant>]
Display information from single tenant (Admin only).
4.3.79. cinder snapshot-manage
usage: cinder snapshot-manage [--id-type <id-type>] [--name <name>] [--description <description>] [--metadata [<key=value> [<key=value> ...]]] <volume> <identifier>
Positional arguments
- <volume>
Cinder volume already exists in volume backend
- <identifier>
Name or other Identifier for existing snapshot
Optional arguments
- --id-type <id-type>
Type of backend device identifier provided, typically
source-name or source-id (Default=source-name)
- --name <name>
Snapshot name (Default=None)
- --description <description>
Snapshot description (Default=None)
- --metadata [<key=value> [<key=value> ...]]
Metadata key=value pairs (Default=None)
4.3.80. cinder snapshot-manageable-list
usage: cinder snapshot-manageable-list [--detailed <detailed>] [--marker <marker>] [--limit <limit>] [--offset <offset>] [--sort <key>[:<direction>]] <host>
Positional arguments
- <host>
Cinder host on which to list manageable snapshots;
takes the form: host@backend-name#pool
Optional arguments
- --detailed <detailed>
Returned detailed information (default true).
- --marker <marker>
Begin returning volumes that appear later in the
volume list than that represented by this volume id.
Default=None.
- --limit <limit>
Maximum number of volumes to return. Default=None.
- --offset <offset>
Number of volumes to skip after marker. Default=None.
- --sort <key>[:<direction>]
Comma-separated list of sort keys and directions in
the form of <key>[:<asc|desc>]. Valid keys: id,
status, size, availability_zone, name, bootable,
created_at, reference. Default=None.
4.3.81. cinder snapshot-metadata
usage: cinder snapshot-metadata <snapshot> <action> <key=value> [<key=value> ...]
Positional arguments
- <snapshot>
ID of snapshot for which to update metadata.
- <action>
The action. Valid values are "set" or "unset."
- <key=value>
Metadata key and value pair to set or unset. For unset, specify
only the key.
4.3.82. cinder snapshot-metadata-show
usage: cinder snapshot-metadata-show <snapshot>
Positional arguments
- <snapshot>
ID of snapshot.
4.3.83. cinder snapshot-metadata-update-all
usage: cinder snapshot-metadata-update-all <snapshot> <key=value> [<key=value> ...]
Positional arguments
- <snapshot>
ID of snapshot for which to update metadata.
- <key=value>
Metadata key and value pair to update.
4.3.84. cinder snapshot-rename
usage: cinder snapshot-rename [--description <description>] <snapshot> [<name>]
Positional arguments
- <snapshot>
Name or ID of snapshot.
- <name>
New name for snapshot.
Optional arguments
- --description <description>
Snapshot description. Default=None.
4.3.85. cinder snapshot-reset-state
usage: cinder snapshot-reset-state [--state <state>] <snapshot> [<snapshot> ...]
Positional arguments
- <snapshot>
Name or ID of snapshot to modify.
Optional arguments
- --state <state>
The state to assign to the snapshot. Valid values are
"available", "error", "creating", "deleting", 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.
4.3.86. cinder snapshot-show
usage: cinder snapshot-show <snapshot>
Positional arguments
- <snapshot>
Name or ID of snapshot.
4.3.87. cinder snapshot-unmanage
usage: cinder snapshot-unmanage <snapshot>
Positional arguments
- <snapshot>
Name or ID of the snapshot to unmanage.
4.3.88. cinder thaw-host
usage: cinder thaw-host <hostname>
Positional arguments
- <hostname>
Host name.
4.3.89. cinder transfer-accept
usage: cinder transfer-accept <transfer> <auth_key>
Positional arguments
- <transfer>
ID of transfer to accept.
- <auth_key>
Authentication key of transfer to accept.
4.3.90. cinder transfer-create
usage: cinder transfer-create [--name <name>] <volume>
Positional arguments
- <volume>
Name or ID of volume to transfer.
Optional arguments
- --name <name>
Transfer name. Default=None.
4.3.91. cinder transfer-delete
usage: cinder transfer-delete <transfer>
Positional arguments
- <transfer>
Name or ID of transfer to delete.
4.3.92. cinder transfer-list
usage: cinder transfer-list [--all-tenants [<0|1>]]
Optional arguments
- --all-tenants [<0|1>]
Shows details for all tenants. Admin only.
4.3.93. cinder transfer-show
usage: cinder transfer-show <transfer>
Positional arguments
- <transfer>
Name or ID of transfer to accept.
4.3.94. cinder type-access-add
usage: cinder type-access-add --volume-type <volume_type> --project-id <project_id>
Optional arguments
- --volume-type <volume_type>
Volume type name or ID to add access for the given
project.
- --project-id <project_id>
Project ID to add volume type access for.
4.3.95. cinder type-access-list
usage: cinder type-access-list --volume-type <volume_type>
Optional arguments
- --volume-type <volume_type>
Filter results by volume type name or ID.
4.3.96. cinder type-access-remove
usage: cinder type-access-remove --volume-type <volume_type> --project-id <project_id>
Optional arguments
- --volume-type <volume_type>
Volume type name or ID to remove access for the given
project.
- --project-id <project_id>
Project ID to remove volume type access for.
4.3.97. cinder type-create
usage: cinder type-create [--description <description>] [--is-public <is-public>] <name>
Positional arguments
- <name>
Name of new volume type.
Optional arguments
- --description <description>
Description of new volume type.
- --is-public <is-public>
Make type accessible to the public (default true).
4.3.98. cinder type-default
usage: cinder type-default
4.3.99. cinder type-delete
usage: cinder type-delete <vol_type> [<vol_type> ...]
Positional arguments
- <vol_type>
Name or ID of volume type or types to delete.
4.3.100. cinder type-key
usage: cinder type-key <vtype> <action> <key=value> [<key=value> ...]
Positional arguments
- <vtype>
Name or ID of volume type.
- <action>
The action. Valid values are "set" or "unset."
- <key=value>
The extra specs key and value pair to set or unset. For unset,
specify only the key.
4.3.101. cinder type-list
usage: cinder type-list
4.3.102. cinder type-show
usage: cinder type-show <volume_type>
Positional arguments
- <volume_type>
Name or ID of the volume type.
4.3.103. cinder type-update
usage: cinder type-update [--name <name>] [--description <description>] [--is-public <is-public>] <id>
Positional arguments
- <id>
ID of the volume type.
Optional arguments
- --name <name>
Name of the volume type.
- --description <description>
Description of the volume type.
- --is-public <is-public>
Make type accessible to the public or not.
4.3.104. cinder unmanage
usage: cinder unmanage <volume>
Positional arguments
- <volume>
Name or ID of the volume to unmanage.
4.3.105. cinder upload-to-image
usage: cinder upload-to-image [--force [<True|False>]] [--container-format <container-format>] [--disk-format <disk-format>] <volume> <image-name>
Positional arguments
- <volume>
Name or ID of volume to snapshot.
- <image-name>
The new image name.
Optional arguments
- --force [<True|False>]
Enables or disables upload of a volume that is
attached to an instance. Default=False. This option
may not be supported by your cloud.
- --container-format <container-format>
Container format type. Default is bare.
- --disk-format <disk-format>
Disk format type. Default is raw.