1CINDER(1) python-cinderclient CINDER(1)
2
6 cinder - Client for OpenStack Block Storage API
7 The cinder client is the command-line interface (CLI) for the Block
9 Storage service (cinder) API and its extensions.
10 This chapter documents cinder version 2.2.0.
12 For help on a specific cinder command, enter:
14 $ cinder help COMMAND
16
18 usage: cinder [--version] [-d] [--os-auth-system <os-auth-system>]
19 [--os-auth-type <os-auth-type>] [--service-type <service-type>]
20 [--service-name <service-name>]
21 [--volume-service-name <volume-service-name>]
22 [--os-endpoint-type <os-endpoint-type>]
23 [--endpoint-type <endpoint-type>]
24 [--os-volume-api-version <volume-api-ver>]
25 [--bypass-url <bypass-url>] [--os-endpoint <os-endpoint>]
26 [--retries <retries>] [--profile HMAC_KEY]
27 [--os-auth-strategy <auth-strategy>]
28 [--os-username <auth-user-name>] [--os-password <auth-password>]
29 [--os-tenant-name <auth-tenant-name>]
30 [--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>]
31 [--os-user-id <auth-user-id>]
32 [--os-user-domain-id <auth-user-domain-id>]
33 [--os-user-domain-name <auth-user-domain-name>]
34 [--os-project-id <auth-project-id>]
35 [--os-project-name <auth-project-name>]
36 [--os-project-domain-id <auth-project-domain-id>]
37 [--os-project-domain-name <auth-project-domain-name>]
38 [--os-region-name <region-name>] [--os-token <token>]
39 [--os-url <url>] [--insecure] [--os-cacert <ca-certificate>]
40 [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>]
41 <subcommand> ...
42 Subcommands:
44 absolute-limits
46 Lists absolute limits for a user.
47 api-version
49 Display the server API version information. (Supported by API
50 versions 3.0 - 3.latest) [hint: use ‘–os-volume-api-version’
51 flag to show help message for proper version]
52 attachment-create
54 Create an attachment for a cinder volume. (Supported by API ver‐
55 sions 3.27 - 3.latest) [hint: use ‘–os-volume-api-version’ flag
56 to show help message for proper version]
57 attachment-delete
59 Delete an attachment for a cinder volume. (Supported by API ver‐
60 sions 3.27 - 3.latest) [hint: use ‘–os-volume-api-version’ flag
61 to show help message for proper version]
62 attachment-list
64 Lists all attachments. (Supported by API versions 3.27 - 3.lat‐
65 est) [hint: use ‘–os-volume-api-version’ flag to show help mes‐
66 sage for proper version]
67 attachment-show
69 Show detailed information for attachment. (Supported by API ver‐
70 sions 3.27 - 3.latest) [hint: use ‘–os-volume-api-version’ flag
71 to show help message for proper version]
72 attachment-update
74 Update an attachment for a cinder volume. (Supported by API ver‐
75 sions 3.27 - 3.latest) [hint: use ‘–os-volume-api-version’ flag
76 to show help message for proper version]
77 availability-zone-list
79 Lists all availability zones.
80 backup-create
82 Creates a volume backup.
83 backup-delete
85 Removes one or more backups.
86 backup-export
88 Export backup metadata record.
89 backup-import
91 Import backup metadata record.
92 backup-list
94 Lists all backups.
95 backup-reset-state
97 Explicitly updates the backup state.
98 backup-restore
100 Restores a backup.
101 backup-show
103 Shows backup details.
104 backup-update
106 Renames a backup. (Supported by API versions 3.9 -3.latest)
107 [hint: use ‘–os-volume-api-version’ flag to show help message
108 for proper version]
109 cgsnapshot-create
111 Creates a cgsnapshot.
112 cgsnapshot-delete
114 Removes one or more cgsnapshots.
115 cgsnapshot-list
117 Lists all cgsnapshots.
118 cgsnapshot-show
120 Shows cgsnapshot details.
121 cluster-disable
123 Disables clustered services. (Supported by API versions 3.7 -
124 3.latest) [hint: use ‘–os-volume-api-version’ flag to show help
125 message for proper version]
126 cluster-enable
128 Enables clustered services. (Supported by API versions 3.7 -
129 3.latest) [hint: use ‘–os-volume-api-version’ flag to show help
130 message for proper version]
131 cluster-list
133 Lists clustered services with optional filtering. (Supported by
134 API versions 3.7 - 3.latest) [hint: use ‘–os-volume-api-version’
135 flag to show help message for proper version]
136 cluster-show
138 Show detailed information on a clustered service. (Supported by
139 API versions 3.7 - 3.latest) [hint: use ‘–os-volume-api-version’
140 flag to show help message for proper version]
141 consisgroup-create
143 Creates a consistency group.
144 consisgroup-create-from-src
146 Creates a consistency group from a cgsnapshot or a source CG.
147 consisgroup-delete
149 Removes one or more consistency groups.
150 consisgroup-list
152 Lists all consistency groups.
153 consisgroup-show
155 Shows details of a consistency group.
156 consisgroup-update
158 Updates a consistency group.
159 create Creates a volume.
161 credentials
163 Shows user credentials returned from auth.
164 delete Removes one or more volumes.
166 encryption-type-create
168 Creates encryption type for a volume type. Admin only.
169 encryption-type-delete
171 Deletes encryption type for a volume type. Admin only.
172 encryption-type-list
174 Shows encryption type details for volume types. Admin only.
175 encryption-type-show
177 Shows encryption type details for a volume type. Admin only.
178 encryption-type-update
180 Update encryption type information for a volume type (Admin
181 Only).
182 endpoints
184 Discovers endpoints registered by authentication service.
185 extend Attempts to extend size of an existing volume.
187 extra-specs-list
189 Lists current volume types and extra specs.
190 failover-host
192 Failover a replicating cinder-volume host.
193 force-delete
195 Attempts force-delete of volume, regardless of state.
196 freeze-host
198 Freeze and disable the specified cinder-volume host.
199 get-capabilities
201 Show backend volume stats and properties. Admin only.
202 get-pools
204 Show pool information for backends. Admin only.
205 group-create
207 Creates a group. (Supported by API versions 3.13 -3.latest)
208 [hint: use ‘–os-volume-api-version’ flag to show help message
209 for proper version]
210 group-create-from-src
212 Creates a group from a group snapshot or a source group. (Sup‐
213 ported by API versions 3.14 - 3.latest) [hint: use ‘–os-vol‐
214 ume-api-version’ flag to show help message for proper version]
215 group-delete
217 Removes one or more groups. (Supported by API versions 3.13 -
218 3.latest) [hint: use ‘–os-volume-api-version’ flag to show help
219 message for proper version]
220 group-list
222 Lists all groups. (Supported by API versions 3.13 -3.latest)
223 [hint: use ‘–os-volume-api-version’ flag to show help message
224 for proper version]
225 group-show
227 Shows details of a group. (Supported by API versions 3.13 -
228 3.latest) [hint: use ‘–os-volume-api-version’ flag to show help
229 message for proper version]
230 group-snapshot-create
232 Creates a group snapshot. (Supported by API versions 3.14 -
233 3.latest) [hint: use ‘–os-volume-api-version’ flag to show help
234 message for proper version]
235 group-snapshot-delete
237 Removes one or more group snapshots. (Supported by API versions
238 3.14 - 3.latest) [hint: use ‘–os-volume-api-version’ flag to
239 show help message for proper version]
240 group-snapshot-list
242 Lists all group snapshots. (Supported by API versions 3.14 -
243 3.latest) [hint: use ‘–os-volume-api-version’ flag to show help
244 message for proper version]
245 group-snapshot-show
247 Shows group snapshot details. (Supported by API versions 3.14 -
248 3.latest) [hint: use ‘–os-volume-api-version’ flag to show help
249 message for proper version]
250 group-specs-list
252 Lists current group types and specs. (Supported by API versions
253 3.11 - 3.latest) [hint: use ‘–os-volume-api-version’ flag to
254 show help message for proper version]
255 group-type-create
257 Creates a group type. (Supported by API versions 3.11 - 3.lat‐
258 est) [hint: use ‘–os-volume-api-version’ flag to show help mes‐
259 sage for proper version]
260 group-type-default
262 List the default group type. (Supported by API versions 3.11 -
263 3.latest) [hint: use ‘–os-volume-api-version’ flag to show help
264 message for proper version]
265 group-type-delete
267 Deletes group type or types. (Supported by API versions 3.11 -
268 3.latest) [hint: use ‘–os-volume-api-version’ flag to show help
269 message for proper version]
270 group-type-key
272 Sets or unsets group_spec for a group type. (Supported by API
273 versions 3.11 - 3.latest) [hint: use ‘–os-volume-api-version’
274 flag to show help message for proper version]
275 group-type-list
277 Lists available ‘group types’. (Admin only will see private
278 types) (Supported by API versions 3.11 -3.latest) [hint: use
279 ‘–os-volume-api-version’ flag to show help message for proper
280 version]
281 group-type-show
283 Show group type details. (Supported by API versions 3.11 -
284 3.latest) [hint: use ‘–os-volume-api-version’ flag to show help
285 message for proper version]
286 group-type-update
288 Updates group type name, description, and/or is_public. (Sup‐
289 ported by API versions 3.11 - 3.latest) [hint: use ‘–os-vol‐
290 ume-api-version’ flag to show help message for proper version]
291 group-update
293 Updates a group. (Supported by API versions 3.13 -3.latest)
294 [hint: use ‘–os-volume-api-version’ flag to show help message
295 for proper version]
296 image-metadata
298 Sets or deletes volume image metadata.
299 image-metadata-show
301 Shows volume image metadata.
302 list Lists all volumes.
304 list-filters
306 (Supported by API versions 3.33 - 3.latest) [hint: use ‘–os-vol‐
307 ume-api-version’ flag to show help message for proper version]
308 manage Manage an existing volume.
310 manageable-list
312 Lists all manageable volumes. (Supported by API versions 3.8 -
313 3.latest) [hint: use ‘–os-volume-api-version’ flag to show help
314 message for proper version]
315 message-delete
317 Removes one or more messages. (Supported by API versions 3.3 -
318 3.latest) [hint: use ‘–os-volume-api-version’ flag to show help
319 message for proper version]
320 message-list
322 Lists all messages. (Supported by API versions 3.3 -3.latest)
323 [hint: use ‘–os-volume-api-version’ flag to show help message
324 for proper version]
325 message-show
327 Shows message details. (Supported by API versions 3.3 - 3.lat‐
328 est) [hint: use ‘–os-volume-api-version’ flag to show help mes‐
329 sage for proper version]
330 metadata
332 Sets or deletes volume metadata.
333 metadata-show
335 Shows volume metadata.
336 metadata-update-all
338 Updates volume metadata.
339 migrate
341 Migrates volume to a new host.
342 qos-associate
344 Associates qos specs with specified volume type.
345 qos-create
347 Creates a qos specs.
348 qos-delete
350 Deletes a specified qos specs.
351 qos-disassociate
353 Disassociates qos specs from specified volume type.
354 qos-disassociate-all
356 Disassociates qos specs from all its associations.
357 qos-get-association
359 Lists all associations for specified qos specs.
360 qos-key
362 Sets or unsets specifications for a qos spec.
363 qos-list
365 Lists qos specs.
366 qos-show
368 Shows qos specs details.
369 quota-class-show
371 Lists quotas for a quota class.
372 quota-class-update
374 Updates quotas for a quota class.
375 quota-defaults
377 Lists default quotas for a tenant.
378 quota-delete
380 Delete the quotas for a tenant.
381 quota-show
383 Lists quotas for a tenant.
384 quota-update
386 Updates quotas for a tenant.
387 quota-usage
389 Lists quota usage for a tenant.
390 rate-limits
392 Lists rate limits for a user.
393 readonly-mode-update
395 Updates volume read-only access-mode flag.
396 rename Renames a volume.
398 replication-promote
400 Promote a secondary volume to primary for a relationship.
401 replication-reenable
403 Sync the secondary volume with primary for a relationship.
404 reset-state
406 Explicitly updates the entity state in the Cinder database.
407 retype Changes the volume type for a volume.
409 service-disable
411 Disables the service.
412 service-enable
414 Enables the service.
415 service-list
417 Lists all services. Filter by host and service binary. (Sup‐
418 ported by API versions 3.0 - 3.latest) [hint: use ‘–os-vol‐
419 ume-api-version’ flag to show help message for proper version]
420 set-bootable
422 Update bootable status of a volume.
423 show Shows volume details.
425 snapshot-create
427 Creates a snapshot.
428 snapshot-delete
430 Removes one or more snapshots.
431 snapshot-list
433 Lists all snapshots.
434 snapshot-manage
436 Manage an existing snapshot.
437 snapshot-manageable-list
439 Lists all manageable snapshots. (Supported by API versions 3.8 -
440 3.latest) [hint: use ‘–os-volume-api-version’ flag to show help
441 message for proper version]
442 snapshot-metadata
444 Sets or deletes snapshot metadata.
445 snapshot-metadata-show
447 Shows snapshot metadata.
448 snapshot-metadata-update-all
450 Updates snapshot metadata.
451 snapshot-rename
453 Renames a snapshot.
454 snapshot-reset-state
456 Explicitly updates the snapshot state.
457 snapshot-show
459 Shows snapshot details.
460 snapshot-unmanage
462 Stop managing a snapshot.
463 thaw-host
465 Thaw and enable the specified cinder-volume host.
466 transfer-accept
468 Accepts a volume transfer.
469 transfer-create
471 Creates a volume transfer.
472 transfer-delete
474 Undoes a transfer.
475 transfer-list
477 Lists all transfers.
478 transfer-show
480 Shows transfer details.
481 type-access-add
483 Adds volume type access for the given project.
484 type-access-list
486 Print access information about the given volume type.
487 type-access-remove
489 Removes volume type access for the given project.
490 type-create
492 Creates a volume type.
493 type-default
495 List the default volume type.
496 type-delete
498 Deletes volume type or types.
499 type-key
501 Sets or unsets extra_spec for a volume type.
502 type-list
504 Lists available ‘volume types’.
505 type-show
507 Show volume type details.
508 type-update
510 Updates volume type name, description, and/or is_public.
511 unmanage
513 Stop managing a volume.
514 upload-to-image
516 Uploads volume to Image Service as an image.
517 version-list
519 List all API versions. (Supported by API versions 3.0 - 3.lat‐
520 est) [hint: use ‘–os-volume-api-version’ flag to show help mes‐
521 sage for proper version]
522 bash-completion
524 Prints arguments for bash_completion.
525 help Shows help about this program or one of its subcommands.
527 list-extensions
529
531 --version
532 show program’s version number and exit
533 -d, --debug
535 Shows debugging output.
536 --os-auth-system <os-auth-system>
538 DEPRECATED! Use –os-auth-type. Defaults to env[OS_AUTH_SYSTEM].
539 --os-auth-type <os-auth-type>
541 Defaults to env[OS_AUTH_TYPE].
542 --service-type <service-type>
544 Service type. For most actions, default is volume.
545 --service-name <service-name>
547 Service name. Default= env[CINDER_SERVICE_NAME].
548 --volume-service-name <volume-service-name>
550 Volume service name. Default= env[CINDER_VOLUME_SERVICE_NAME].
551 --os-endpoint-type <os-endpoint-type>
553 Endpoint type, which is publicURL or internalURL. Default=
554 env[OS_ENDPOINT_TYPE] or nova env[CINDER_ENDPOINT_TYPE] or pub‐
555 licURL.
556 --endpoint-type <endpoint-type>
558 DEPRECATED! Use –os-endpoint-type.
559 --os-volume-api-version <volume-api-ver>
561 Block Storage API version. Accepts X, X.Y (where X is major and
562 Y is minor part).Default= env[OS_VOLUME_API_VERSION].
563 --bypass-url <bypass-url>
565 DEPRECATED! Use os_endpoint. Use this API endpoint instead of
566 the Service Catalog. Defaults to env[CINDERCLIENT_BYPASS_URL].
567 --os-endpoint <os-endpoint>
569 Use this API endpoint instead of the Service Catalog. Defaults
570 to env[CINDER_ENDPOINT].
571 --retries <retries>
573 Number of retries.
574 --profile HMAC_KEY
576 HMAC key to use for encrypting context data for performance pro‐
577 filing of operation. This key needs to match the one configured
578 on the cinder api server. Without key the profiling will not be
579 triggered even if osprofiler is enabled on server side.
580 --os-auth-strategy <auth-strategy>
582 Authentication strategy (Env: OS_AUTH_STRATEGY, default key‐
583 stone). For now, any other value will disable the authentica‐
584 tion.
585 --os-username <auth-user-name>
587 OpenStack user name. Default= env[OS_USERNAME].
588 --os-password <auth-password>
590 Password for OpenStack user. Default= env[OS_PASSWORD].
591 --os-tenant-name <auth-tenant-name>
593 Tenant name. Default= env[OS_TENANT_NAME].
594 --os-tenant-id <auth-tenant-id>
596 ID for the tenant. Default= env[OS_TENANT_ID].
597 --os-auth-url <auth-url>
599 URL for the authentication service. Default= env[OS_AUTH_URL].
600 --os-user-id <auth-user-id>
602 Authentication user ID (Env: OS_USER_ID).
603 --os-user-domain-id <auth-user-domain-id>
605 OpenStack user domain ID. Defaults to env[OS_USER_DOMAIN_ID].
606 --os-user-domain-name <auth-user-domain-name>
608 OpenStack user domain name. Defaults to
609 env[OS_USER_DOMAIN_NAME].
610 --os-project-id <auth-project-id>
612 Another way to specify tenant ID. This option is mutually exclu‐
613 sive with –os-tenant-id. Defaults to env[OS_PROJECT_ID].
614 --os-project-name <auth-project-name>
616 Another way to specify tenant name. This option is mutually
617 exclusive with –os-tenant-name. Defaults to
618 env[OS_PROJECT_NAME].
619 --os-project-domain-id <auth-project-domain-id>
621 Defaults to env[OS_PROJECT_DOMAIN_ID].
622 --os-project-domain-name <auth-project-domain-name>
624 Defaults to env[OS_PROJECT_DOMAIN_NAME].
625 --os-region-name <region-name>
627 Region name. Default= env[OS_REGION_NAME].
628 --os-token <token>
630 Defaults to env[OS_TOKEN].
631 --os-url <url>
633 Defaults to env[OS_URL].
634 cinder absolute-limits
636 usage: cinder absolute-limits [<tenant_id>]
637 Lists absolute limits for a user.
639 Positional arguments:
641 <tenant_id>
643 Display information for a single tenant (Admin only).
644 cinder api-version
646 usage: cinder api-version
647 Display the server API version information.
649 cinder attachment-create
651 usage: cinder attachment-create [--connect <connect>]
652 [--initiator <initiator>] [--ip <ip>]
653 [--host <host>] [--platform <platform>]
654 [--ostype <ostype>] [--multipath <multipath>]
655 [--mountpoint <mountpoint>]
656 <volume> <server_id>
657 Create an attachment for a cinder volume.
659 Positional arguments:
661 <volume>
663 Name or ID of volume or volumes to attach.
664 <server_id>
666 ID of server attaching to.
667 Optional arguments:
669 --connect <connect>
671 Make an active connection using provided connector info (True or
672 False).
673 --initiator <initiator>
675 iqn of the initiator attaching to. Default=None.
676 --ip <ip>
678 ip of the system attaching to. Default=None.
679 --host <host>
681 Name of the host attaching to. Default=None.
682 --platform <platform>
684 Platform type. Default=x86_64.
685 --ostype <ostype>
687 OS type. Default=linux2.
688 --multipath <multipath>
690 Use multipath. Default=False.
691 --mountpoint <mountpoint>
693 Mountpoint volume will be attached at. Default=None.
694 cinder attachment-delete
696 usage: cinder attachment-delete <attachment> [<attachment> ...]
697 Delete an attachment for a cinder volume.
699 Positional arguments:
701 <attachment>
703 ID of attachment or attachments to delete.
704 cinder attachment-list
706 usage: cinder attachment-list [--all-tenants [<0|1>]]
707 [--volume-id <volume-id>] [--status <status>]
708 [--marker <marker>] [--limit <limit>]
709 [--sort <key>[:<direction>]]
710 [--tenant [<tenant>]]
711 [--filters [<key=value> [<key=value> ...]]]
712 Lists all attachments.
714 Optional arguments:
716 --all-tenants [<0|1>]
718 Shows details for all tenants. Admin only.
719 --volume-id <volume-id>
721 Filters results by a volume ID. Default=None. This option is
722 deprecated and will be removed in newer release. Please use
723 ‘–filters’ option which is introduced since 3.33 instead.
724 --status <status>
726 Filters results by a status. Default=None. This option is depre‐
727 cated and will be removed in newer release. Please use ‘–fil‐
728 ters’ option which is introduced since 3.33 instead.
729 --marker <marker>
731 Begin returning attachments that appear later in attachment list
732 than that represented by this id. Default=None.
733 --limit <limit>
735 Maximum number of attachments to return. Default=None.
736 --sort <key>[:<direction>]
738 Comma-separated list of sort keys and directions in the form of
739 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
740 ity_zone, name, bootable, created_at, reference. Default=None.
741 --tenant [<tenant>]
743 Display information from single tenant (Admin only).
744 --filters [<key=value> [<key=value> ...]]
746 Filter key and value pairs. Please use ‘cinder list-filters’ to
747 check enabled filters from server, Default=None. (Supported by
748 API version 3.33 and later)
749 cinder attachment-show
751 usage: cinder attachment-show <attachment>
752 Show detailed information for attachment.
754 Positional arguments:
756 <attachment>
758 ID of attachment.
759 cinder attachment-update
761 usage: cinder attachment-update [--initiator <initiator>] [--ip <ip>]
762 [--host <host>] [--platform <platform>]
763 [--ostype <ostype>] [--multipath <multipath>]
764 [--mountpoint <mountpoint>]
765 <attachment>
766 Update an attachment for a cinder volume. This call is designed to be
768 more of an attachment completion than anything else. It expects the
769 value of a connector object to notify the driver that the volume is
770 going to be connected and where it’s being connected to.
771 Positional arguments:
773 <attachment>
775 ID of attachment.
776 Optional arguments:
778 --initiator <initiator>
780 iqn of the initiator attaching to. Default=None.
781 --ip <ip>
783 ip of the system attaching to. Default=None.
784 --host <host>
786 Name of the host attaching to. Default=None.
787 --platform <platform>
789 Platform type. Default=x86_64.
790 --ostype <ostype>
792 OS type. Default=linux2.
793 --multipath <multipath>
795 Use multipath. Default=False.
796 --mountpoint <mountpoint>
798 Mountpoint volume will be attached at. Default=None.
799 cinder availability-zone-list
801 usage: cinder availability-zone-list
802 Lists all availability zones.
804 cinder backup-create
806 usage: cinder backup-create [--container <container>] [--name <name>]
807 [--description <description>] [--incremental]
808 [--force] [--snapshot-id <snapshot-id>]
809 <volume>
810 Creates a volume backup.
812 Positional arguments:
814 <volume>
816 Name or ID of volume to backup.
817 Optional arguments:
819 --container <container>
821 Backup container name. Default=None.
822 --name <name>
824 Backup name. Default=None.
825 --description <description>
827 Backup description. Default=None.
828 --incremental
830 Incremental backup. Default=False.
831 --force
833 Allows or disallows backup of a volume when the volume is
834 attached to an instance. If set to True, backs up the volume
835 whether its status is “available” or “in-use”. The backup of an
836 “in-use” volume means your data is crash consistent.
837 Default=False.
838 --snapshot-id <snapshot-id>
840 ID of snapshot to backup. Default=None.
841 cinder backup-delete
843 usage: cinder backup-delete [--force] <backup> [<backup> ...]
844 Removes one or more backups.
846 Positional arguments:
848 <backup>
850 Name or ID of backup(s) to delete.
851 Optional arguments:
853 --force
855 Allows deleting backup of a volume when its status is other than
856 “available” or “error”. Default=False.
857 cinder backup-export
859 usage: cinder backup-export <backup>
860 Export backup metadata record.
862 Positional arguments:
864 <backup>
866 ID of the backup to export.
867 cinder backup-import
869 usage: cinder backup-import <backup_service> <backup_url>
870 Import backup metadata record.
872 Positional arguments:
874 <backup_service>
876 Backup service to use for importing the backup.
877 <backup_url>
879 Backup URL for importing the backup metadata.
880 cinder backup-list
882 usage: cinder backup-list [--all-tenants [<all_tenants>]] [--name <name>]
883 [--status <status>] [--volume-id <volume-id>]
884 [--marker <marker>] [--limit <limit>]
885 [--sort <key>[:<direction>]]
886 [--filters [<key=value> [<key=value> ...]]]
887 Lists all backups.
889 Optional arguments:
891 --all-tenants [<all_tenants>]
893 Shows details for all tenants. Admin only.
894 --name <name>
896 Filters results by a name. Default=None. This option is depre‐
897 cated and will be removed in newer release. Please use ‘–fil‐
898 ters’ option which is introduced since 3.33 instead.
899 --status <status>
901 Filters results by a status. Default=None. This option is depre‐
902 cated and will be removed in newer release. Please use ‘–fil‐
903 ters’ option which is introduced since 3.33 instead.
904 --volume-id <volume-id>
906 Filters results by a volume ID. Default=None. This option is
907 deprecated and will be removed in newer release. Please use
908 ‘–filters’ option which is introduced since 3.33 instead.
909 --marker <marker>
911 Begin returning backups that appear later in the backup list
912 than that represented by this id. Default=None.
913 --limit <limit>
915 Maximum number of backups to return. Default=None.
916 --sort <key>[:<direction>]
918 Comma-separated list of sort keys and directions in the form of
919 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
920 ity_zone, name, bootable, created_at, reference. Default=None.
921 --filters [<key=value> [<key=value> ...]]
923 Filter key and value pairs. Please use ‘cinder list-filters’ to
924 check enabled filters from server, Default=None. (Supported by
925 API version 3.33 and later)
926 cinder backup-reset-state
928 usage: cinder backup-reset-state [--state <state>] <backup> [<backup> ...]
929 Explicitly updates the backup state.
931 Positional arguments:
933 <backup>
935 Name or ID of the backup to modify.
936 Optional arguments:
938 --state <state>
940 The state to assign to the backup. Valid values are “available”,
941 “error”. Default=available.
942 cinder backup-restore
944 usage: cinder backup-restore [--volume <volume>] [--name <name>] <backup>
945 Restores a backup.
947 Positional arguments:
949 <backup>
951 Name or ID of backup to restore.
952 Optional arguments:
954 --volume <volume>
956 Name or ID of existing volume to which to restore. This is mutu‐
957 ally exclusive with –name and takes priority. Default=None.
958 --name <name>
960 Use the name for new volume creation to restore. This is mutu‐
961 ally exclusive with –volume (or the deprecated –volume-id) and
962 –volume (or –volume-id) takes priority. Default=None.
963 cinder backup-show
965 usage: cinder backup-show <backup>
966 Shows backup details.
968 Positional arguments:
970 <backup>
972 Name or ID of backup.
973 cinder backup-update
975 usage: cinder backup-update [--name [<name>]] [--description <description>]
976 <backup>
977 Renames a backup.
979 Positional arguments:
981 <backup>
983 Name or ID of backup to rename.
984 Optional arguments:
986 --name [<name>]
988 New name for backup.
989 --description <description>
991 Backup description. Default=None.
992 cinder cgsnapshot-create
994 usage: cinder cgsnapshot-create [--name <name>] [--description <description>]
995 <consistencygroup>
996 Creates a cgsnapshot.
998 Positional arguments:
1000 <consistencygroup>
1002 Name or ID of a consistency group.
1003 Optional arguments:
1005 --name <name>
1007 Cgsnapshot name. Default=None.
1008 --description <description>
1010 Cgsnapshot description. Default=None.
1011 cinder cgsnapshot-delete
1013 usage: cinder cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]
1014 Removes one or more cgsnapshots.
1016 Positional arguments:
1018 <cgsnapshot>
1020 Name or ID of one or more cgsnapshots to be deleted.
1021 cinder cgsnapshot-list
1023 usage: cinder cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>]
1024 [--consistencygroup-id <consistencygroup_id>]
1025 Lists all cgsnapshots.
1027 Optional arguments:
1029 --all-tenants [<0|1>]
1031 Shows details for all tenants. Admin only.
1032 --status <status>
1034 Filters results by a status. Default=None.
1035 --consistencygroup-id <consistencygroup_id>
1037 Filters results by a consistency group ID. Default=None.
1038 cinder cgsnapshot-show
1040 usage: cinder cgsnapshot-show <cgsnapshot>
1041 Shows cgsnapshot details.
1043 Positional arguments:
1045 <cgsnapshot>
1047 Name or ID of cgsnapshot.
1048 cinder cluster-disable
1050 usage: cinder cluster-disable [--reason <reason>] [<binary>] <cluster-name>
1051 Disables clustered services.
1053 Positional arguments:
1055 <binary>
1057 Binary to filter by. Default: cinder-volume.
1058 <cluster-name>
1060 Name of the clustered services to update.
1061 Optional arguments:
1063 --reason <reason>
1065 Reason for disabling clustered service.
1066 cinder cluster-enable
1068 usage: cinder cluster-enable [<binary>] <cluster-name>
1069 Enables clustered services.
1071 Positional arguments:
1073 <binary>
1075 Binary to filter by. Default: cinder-volume.
1076 <cluster-name>
1078 Name of the clustered services to update.
1079 cinder cluster-list
1081 usage: cinder cluster-list [--name <name>] [--binary <binary>]
1082 [--is-up <True|true|False|false>]
1083 [--disabled <True|true|False|false>]
1084 [--num-hosts <num-hosts>]
1085 [--num-down-hosts <num-down-hosts>] [--detailed]
1086 Lists clustered services with optional filtering.
1088 Optional arguments:
1090 --name <name>
1092 Filter by cluster name, without backend will list all clustered
1093 services from the same cluster. Default=None.
1094 --binary <binary>
1096 Cluster binary. Default=None.
1097 --is-up <True|true|False|false>
1099 Filter by up/dow status. Default=None.
1100 --disabled <True|true|False|false>
1102 Filter by disabled status. Default=None.
1103 --num-hosts <num-hosts>
1105 Filter by number of hosts in the cluster.
1106 --num-down-hosts <num-down-hosts>
1108 Filter by number of hosts that are down.
1109 --detailed
1111 Get detailed clustered service information (Default=False).
1112 cinder cluster-show
1114 usage: cinder cluster-show [<binary>] <cluster-name>
1115 Show detailed information on a clustered service.
1117 Positional arguments:
1119 <binary>
1121 Binary to filter by. Default: cinder-volume.
1122 <cluster-name>
1124 Name of the clustered service to show.
1125 cinder consisgroup-create
1127 usage: cinder consisgroup-create [--name <name>] [--description <description>]
1128 [--availability-zone <availability-zone>]
1129 <volume-types>
1130 Creates a consistency group.
1132 Positional arguments:
1134 <volume-types>
1136 Volume types.
1137 Optional arguments:
1139 --name <name>
1141 Name of a consistency group.
1142 --description <description>
1144 Description of a consistency group. Default=None.
1145 --availability-zone <availability-zone>
1147 Availability zone for volume. Default=None.
1148 cinder consisgroup-create-from-src
1150 usage: cinder consisgroup-create-from-src [--cgsnapshot <cgsnapshot>]
1151 [--source-cg <source-cg>]
1152 [--name <name>]
1153 [--description <description>]
1154 Creates a consistency group from a cgsnapshot or a source CG.
1156 Optional arguments:
1158 --cgsnapshot <cgsnapshot>
1160 Name or ID of a cgsnapshot. Default=None.
1161 --source-cg <source-cg>
1163 Name or ID of a source CG. Default=None.
1164 --name <name>
1166 Name of a consistency group. Default=None.
1167 --description <description>
1169 Description of a consistency group. Default=None.
1170 cinder consisgroup-delete
1172 usage: cinder consisgroup-delete [--force]
1173 <consistencygroup> [<consistencygroup> ...]
1174 Removes one or more consistency groups.
1176 Positional arguments:
1178 <consistencygroup>
1180 Name or ID of one or more consistency groups to be deleted.
1181 Optional arguments:
1183 --force
1185 Allows or disallows consistency groups to be deleted. If the
1186 consistency group is empty, it can be deleted without the force
1187 flag. If the consistency group is not empty, the force flag is
1188 required for it to be deleted.
1189 cinder consisgroup-list
1191 usage: cinder consisgroup-list [--all-tenants [<0|1>]]
1192 Lists all consistency groups.
1194 Optional arguments:
1196 --all-tenants [<0|1>]
1198 Shows details for all tenants. Admin only.
1199 cinder consisgroup-show
1201 usage: cinder consisgroup-show <consistencygroup>
1202 Shows details of a consistency group.
1204 Positional arguments:
1206 <consistencygroup>
1208 Name or ID of a consistency group.
1209 cinder consisgroup-update
1211 usage: cinder consisgroup-update [--name <name>] [--description <description>]
1212 [--add-volumes <uuid1,uuid2,......>]
1213 [--remove-volumes <uuid3,uuid4,......>]
1214 <consistencygroup>
1215 Updates a consistency group.
1217 Positional arguments:
1219 <consistencygroup>
1221 Name or ID of a consistency group.
1222 Optional arguments:
1224 --name <name>
1226 New name for consistency group. Default=None.
1227 --description <description>
1229 New description for consistency group. Default=None.
1230 --add-volumes <uuid1,uuid2,......>
1232 UUID of one or more volumes to be added to the consistency
1233 group, separated by commas. Default=None.
1234 --remove-volumes <uuid3,uuid4,......>
1236 UUID of one or more volumes to be removed from the consistency
1237 group, separated by commas. Default=None.
1238 cinder create
1240 usage: cinder create [--consisgroup-id <consistencygroup-id>]
1241 [--group-id <group-id>] [--snapshot-id <snapshot-id>]
1242 [--source-volid <source-volid>]
1243 [--source-replica <source-replica>]
1244 [--image-id <image-id>] [--image <image>] [--name <name>]
1245 [--description <description>]
1246 [--volume-type <volume-type>]
1247 [--availability-zone <availability-zone>]
1248 [--metadata [<key=value> [<key=value> ...]]]
1249 [--hint <key=value>] [--allow-multiattach]
1250 [<size>]
1251 Creates a volume.
1253 Positional arguments:
1255 <size> Size of volume, in GiBs. (Required unless snapshot-id
1257 /source-volid is specified).
1258 Optional arguments:
1260 --consisgroup-id <consistencygroup-id>
1262 ID of a consistency group where the new volume belongs to.
1263 Default=None.
1264 --group-id <group-id>
1266 ID of a group where the new volume belongs to. Default=None.
1267 (Supported by API version 3.13 and later)
1268 --snapshot-id <snapshot-id>
1270 Creates volume from snapshot ID. Default=None.
1271 --source-volid <source-volid>
1273 Creates volume from volume ID. Default=None.
1274 --source-replica <source-replica>
1276 Creates volume from replicated volume ID. Default=None.
1277 --image-id <image-id>
1279 Creates volume from image ID. Default=None.
1280 --image <image>
1282 Creates a volume from image (ID or name). Default=None.
1283 --name <name>
1285 Volume name. Default=None.
1286 --description <description>
1288 Volume description. Default=None.
1289 --volume-type <volume-type>
1291 Volume type. Default=None.
1292 --availability-zone <availability-zone>
1294 Availability zone for volume. Default=None.
1295 --metadata [<key=value> [<key=value> ...]]
1297 Metadata key and value pairs. Default=None.
1298 --hint <key=value>
1300 Scheduler hint, like in nova.
1301 --allow-multiattach
1303 Allow volume to be attached more than once. Default=False
1304 cinder credentials
1306 usage: cinder credentials
1307 Shows user credentials returned from auth.
1309 cinder delete
1311 usage: cinder delete [--cascade] <volume> [<volume> ...]
1312 Removes one or more volumes.
1314 Positional arguments:
1316 <volume>
1318 Name or ID of volume or volumes to delete.
1319 Optional arguments:
1321 --cascade
1323 Remove any snapshots along with volume. Default=False.
1324 cinder encryption-type-create
1326 usage: cinder encryption-type-create [--cipher <cipher>]
1327 [--key-size <key_size>]
1328 [--control-location <control_location>]
1329 <volume_type> <provider>
1330 Creates encryption type for a volume type. Admin only.
1332 Positional arguments:
1334 <volume_type>
1336 Name or ID of volume type.
1337 <provider>
1339 The class that provides encryption support. For example, LuksEn‐
1340 cryptor.
1341 Optional arguments:
1343 --cipher <cipher>
1345 The encryption algorithm or mode. For example, aes-xts-plain64.
1346 Default=None.
1347 --key-size <key_size>
1349 Size of encryption key, in bits. For example, 128 or 256.
1350 Default=None.
1351 --control-location <control_location>
1353 Notional service where encryption is performed. Valid values are
1354 “front-end” or “back-end.” For example, front-end=Nova. Default
1355 is “front-end.”
1356 cinder encryption-type-delete
1358 usage: cinder encryption-type-delete <volume_type>
1359 Deletes encryption type for a volume type. Admin only.
1361 Positional arguments:
1363 <volume_type>
1365 Name or ID of volume type.
1366 cinder encryption-type-list
1368 usage: cinder encryption-type-list
1369 Shows encryption type details for volume types. Admin only.
1371 cinder encryption-type-show
1373 usage: cinder encryption-type-show <volume_type>
1374 Shows encryption type details for a volume type. Admin only.
1376 Positional arguments:
1378 <volume_type>
1380 Name or ID of volume type.
1381 cinder encryption-type-update
1383 usage: cinder encryption-type-update [--provider <provider>]
1384 [--cipher [<cipher>]]
1385 [--key-size [<key-size>]]
1386 [--control-location <control-location>]
1387 <volume-type>
1388 Update encryption type information for a volume type (Admin Only).
1390 Positional arguments:
1392 <volume-type>
1394 Name or ID of the volume type
1395 Optional arguments:
1397 --provider <provider>
1399 Class providing encryption support (e.g. LuksEncryptor)
1400 --cipher [<cipher>]
1402 Encryption algorithm/mode to use (e.g., aes-xts-plain64). Pro‐
1403 vide parameter without value to set to provider default.
1404 --key-size [<key-size>]
1406 Size of the encryption key, in bits (e.g., 128, 256). Provide
1407 parameter without value to set to provider default.
1408 --control-location <control-location>
1410 Notional service where encryption is performed (e.g.,
1411 front-end=Nova). Values: ‘front-end’, ‘back-end’
1412 cinder endpoints
1414 usage: cinder endpoints
1415 Discovers endpoints registered by authentication service.
1417 cinder extend
1419 usage: cinder extend <volume> <new_size>
1420 Attempts to extend size of an existing volume.
1422 Positional arguments:
1424 <volume>
1426 Name or ID of volume to extend.
1427 <new_size>
1429 New size of volume, in GiBs.
1430 cinder extra-specs-list
1432 usage: cinder extra-specs-list
1433 Lists current volume types and extra specs.
1435 cinder failover-host
1437 usage: cinder failover-host [--backend_id <backend-id>] <hostname>
1438 Failover a replicating cinder-volume host.
1440 Positional arguments:
1442 <hostname>
1444 Host name.
1445 Optional arguments:
1447 --backend_id <backend-id>
1449 ID of backend to failover to (Default=None)
1450 cinder force-delete
1452 usage: cinder force-delete <volume> [<volume> ...]
1453 Attempts force-delete of volume, regardless of state.
1455 Positional arguments:
1457 <volume>
1459 Name or ID of volume or volumes to delete.
1460 cinder freeze-host
1462 usage: cinder freeze-host <hostname>
1463 Freeze and disable the specified cinder-volume host.
1465 Positional arguments:
1467 <hostname>
1469 Host name.
1470 cinder get-capabilities
1472 usage: cinder get-capabilities <host>
1473 Show backend volume stats and properties. Admin only.
1475 Positional arguments:
1477 <host> Cinder host to show backend volume stats and properties; takes
1479 the form: host@backend-name
1480 cinder get-pools
1482 usage: cinder get-pools [--detail] [--filters [<key=value> [<key=value> ...]]]
1483 Show pool information for backends. Admin only.
1485 Optional arguments:
1487 --detail
1489 Show detailed information about pools.
1490 --filters [<key=value> [<key=value> ...]]
1492 Filter key and value pairs. Please use ‘cinder list-filters’ to
1493 check enabled filters from server, Default=None. (Supported by
1494 API version 3.33 and later)
1495 cinder group-create
1497 usage: cinder group-create [--name <name>] [--description <description>]
1498 [--availability-zone <availability-zone>]
1499 <group-type> <volume-types>
1500 Creates a group.
1502 Positional arguments:
1504 <group-type>
1506 Group type.
1507 <volume-types>
1509 Comma-separated list of volume types.
1510 Optional arguments:
1512 --name <name>
1514 Name of a group.
1515 --description <description>
1517 Description of a group. Default=None.
1518 --availability-zone <availability-zone>
1520 Availability zone for group. Default=None.
1521 cinder group-create-from-src
1523 usage: cinder group-create-from-src [--group-snapshot <group-snapshot>]
1524 [--source-group <source-group>]
1525 [--name <name>]
1526 [--description <description>]
1527 Creates a group from a group snapshot or a source group.
1529 Optional arguments:
1531 --group-snapshot <group-snapshot>
1533 Name or ID of a group snapshot. Default=None.
1534 --source-group <source-group>
1536 Name or ID of a source group. Default=None.
1537 --name <name>
1539 Name of a group. Default=None.
1540 --description <description>
1542 Description of a group. Default=None.
1543 cinder group-delete
1545 usage: cinder group-delete [--delete-volumes] <group> [<group> ...]
1546 Removes one or more groups.
1548 Positional arguments:
1550 <group>
1552 Name or ID of one or more groups to be deleted.
1553 Optional arguments:
1555 --delete-volumes
1557 Allows or disallows groups to be deleted if they are not empty.
1558 If the group is empty, it can be deleted without the delete-vol‐
1559 umes flag. If the group is not empty, the delete-volumes flag is
1560 required for it to be deleted. If True, all volumes in the group
1561 will also be deleted.
1562 cinder group-list
1564 usage: cinder group-list [--all-tenants [<0|1>]]
1565 [--filters [<key=value> [<key=value> ...]]]
1566 Lists all groups.
1568 Optional arguments:
1570 --all-tenants [<0|1>]
1572 Shows details for all tenants. Admin only.
1573 --filters [<key=value> [<key=value> ...]]
1575 Filter key and value pairs. Please use ‘cinder list-filters’ to
1576 check enabled filters from server, Default=None. (Supported by
1577 API version 3.33 and later)
1578 cinder group-show
1580 usage: cinder group-show <group>
1581 Shows details of a group.
1583 Positional arguments:
1585 <group>
1587 Name or ID of a group.
1588 cinder group-snapshot-create
1590 usage: cinder group-snapshot-create [--name <name>]
1591 [--description <description>]
1592 <group>
1593 Creates a group snapshot.
1595 Positional arguments:
1597 <group>
1599 Name or ID of a group.
1600 Optional arguments:
1602 --name <name>
1604 Group snapshot name. Default=None.
1605 --description <description>
1607 Group snapshot description. Default=None.
1608 cinder group-snapshot-delete
1610 usage: cinder group-snapshot-delete <group_snapshot> [<group_snapshot> ...]
1611 Removes one or more group snapshots.
1613 Positional arguments:
1615 <group_snapshot>
1617 Name or ID of one or more group snapshots to be deleted.
1618 cinder group-snapshot-list
1620 usage: cinder group-snapshot-list [--all-tenants [<0|1>]] [--status <status>]
1621 [--group-id <group_id>]
1622 [--filters [<key=value> [<key=value> ...]]]
1623 Lists all group snapshots.
1625 Optional arguments:
1627 --all-tenants [<0|1>]
1629 Shows details for all tenants. Admin only.
1630 --status <status>
1632 Filters results by a status. Default=None. This option is depre‐
1633 cated and will be removed in newer release. Please use ‘–fil‐
1634 ters’ option which is introduced since 3.33 instead.
1635 --group-id <group_id>
1637 Filters results by a group ID. Default=None. This option is dep‐
1638 recated and will be removed in newer release. Please use ‘–fil‐
1639 ters’ option which is introduced since 3.33 instead.
1640 --filters [<key=value> [<key=value> ...]]
1642 Filter key and value pairs. Please use ‘cinder list-filters’ to
1643 check enabled filters from server, Default=None. (Supported by
1644 API version 3.33 and later)
1645 cinder group-snapshot-show
1647 usage: cinder group-snapshot-show <group_snapshot>
1648 Shows group snapshot details.
1650 Positional arguments:
1652 <group_snapshot>
1654 Name or ID of group snapshot.
1655 cinder group-specs-list
1657 usage: cinder group-specs-list
1658 Lists current group types and specs.
1660 cinder group-type-create
1662 usage: cinder group-type-create [--description <description>]
1663 [--is-public <is-public>]
1664 <name>
1665 Creates a group type.
1667 Positional arguments:
1669 <name> Name of new group type.
1671 Optional arguments:
1673 --description <description>
1675 Description of new group type.
1676 --is-public <is-public>
1678 Make type accessible to the public (default true).
1679 cinder group-type-default
1681 usage: cinder group-type-default
1682 List the default group type.
1684 cinder group-type-delete
1686 usage: cinder group-type-delete <group_type> [<group_type> ...]
1687 Deletes group type or types.
1689 Positional arguments:
1691 <group_type>
1693 Name or ID of group type or types to delete.
1694 cinder group-type-key
1696 usage: cinder group-type-key <gtype> <action> <key=value> [<key=value> ...]
1697 Sets or unsets group_spec for a group type.
1699 Positional arguments:
1701 <gtype>
1703 Name or ID of group type.
1704 <action>
1706 The action. Valid values are “set” or “unset.”
1707 <key=value>
1709 The group specs key and value pair to set or unset. For unset,
1710 specify only the key.
1711 cinder group-type-list
1713 usage: cinder group-type-list
1714 Lists available ‘group types’. (Admin only will see private types)
1716 cinder group-type-show
1718 usage: cinder group-type-show <group_type>
1719 Show group type details.
1721 Positional arguments:
1723 <group_type>
1725 Name or ID of the group type.
1726 cinder group-type-update
1728 usage: cinder group-type-update [--name <name>] [--description <description>]
1729 [--is-public <is-public>]
1730 <id>
1731 Updates group type name, description, and/or is_public.
1733 Positional arguments:
1735 <id> ID of the group type.
1737 Optional arguments:
1739 --name <name>
1741 Name of the group type.
1742 --description <description>
1744 Description of the group type.
1745 --is-public <is-public>
1747 Make type accessible to the public or not.
1748 cinder group-update
1750 usage: cinder group-update [--name <name>] [--description <description>]
1751 [--add-volumes <uuid1,uuid2,......>]
1752 [--remove-volumes <uuid3,uuid4,......>]
1753 <group>
1754 Updates a group.
1756 Positional arguments:
1758 <group>
1760 Name or ID of a group.
1761 Optional arguments:
1763 --name <name>
1765 New name for group. Default=None.
1766 --description <description>
1768 New description for group. Default=None.
1769 --add-volumes <uuid1,uuid2,......>
1771 UUID of one or more volumes to be added to the group, separated
1772 by commas. Default=None.
1773 --remove-volumes <uuid3,uuid4,......>
1775 UUID of one or more volumes to be removed from the group, sepa‐
1776 rated by commas. Default=None.
1777 cinder image-metadata
1779 usage: cinder image-metadata <volume> <action> <key=value> [<key=value> ...]
1780 Sets or deletes volume image metadata.
1782 Positional arguments:
1784 <volume>
1786 Name or ID of volume for which to update metadata.
1787 <action>
1789 The action. Valid values are ‘set’ or ‘unset.’
1790 <key=value>
1792 Metadata key and value pair to set or unset. For unset, specify
1793 only the key.
1794 cinder image-metadata-show
1796 usage: cinder image-metadata-show <volume>
1797 Shows volume image metadata.
1799 Positional arguments:
1801 <volume>
1803 ID of volume.
1804 cinder list
1806 usage: cinder list [--group_id <group_id>] [--all-tenants [<0|1>]]
1807 [--name <name>] [--status <status>]
1808 [--bootable [<True|true|False|false>]]
1809 [--migration_status <migration_status>]
1810 [--metadata [<key=value> [<key=value> ...]]]
1811 [--image_metadata [<key=value> [<key=value> ...]]]
1812 [--marker <marker>] [--limit <limit>] [--fields <fields>]
1813 [--sort <key>[:<direction>]] [--tenant [<tenant>]]
1814 [--filters [<key=value> [<key=value> ...]]]
1815 Lists all volumes.
1817 Optional arguments:
1819 --group_id <group_id>
1821 Filters results by a group_id. Default=None.This option is dep‐
1822 recated and will be removed in newer release. Please use ‘–fil‐
1823 ters’ option which is introduced since 3.33 instead. (Supported
1824 by API version 3.10 and later)
1825 --all-tenants [<0|1>]
1827 Shows details for all tenants. Admin only.
1828 --name <name>
1830 Filters results by a name. Default=None. This option is depre‐
1831 cated and will be removed in newer release. Please use ‘–fil‐
1832 ters’ option which is introduced since 3.33 instead.
1833 --status <status>
1835 Filters results by a status. Default=None. This option is depre‐
1836 cated and will be removed in newer release. Please use ‘–fil‐
1837 ters’ option which is introduced since 3.33 instead.
1838 --bootable [<True|true|False|false>]
1840 Filters results by bootable status. Default=None. This option is
1841 deprecated and will be removed in newer release. Please use
1842 ‘–filters’ option which is introduced since 3.33 instead.
1843 --migration_status <migration_status>
1845 Filters results by a migration status. Default=None. Admin
1846 only. This option is deprecated and will be removed in newer
1847 release. Please use ‘–filters’ option which is introduced since
1848 3.33 instead.
1849 --metadata [<key=value> [<key=value> ...]]
1851 Filters results by a metadata key and value pair. Default=None.
1852 This option is deprecated and will be removed in newer release.
1853 Please use ‘–filters’ option which is introduced since 3.33
1854 instead.
1855 --image_metadata [<key=value> [<key=value> ...]]
1857 Filters results by a image metadata key and value pair. Require
1858 volume api version >=3.4. Default=None.This option is depre‐
1859 cated and will be removed in newer release. Please use ‘–fil‐
1860 ters’ option which is introduced since 3.33 instead. (Supported
1861 by API version 3.4 and later)
1862 --marker <marker>
1864 Begin returning volumes that appear later in the volume list
1865 than that represented by this volume id. Default=None.
1866 --limit <limit>
1868 Maximum number of volumes to return. Default=None.
1869 --fields <fields>
1871 Comma-separated list of fields to display. Use the show command
1872 to see which fields are available. Unavailable/non-existent
1873 fields will be ignored. Default=None.
1874 --sort <key>[:<direction>]
1876 Comma-separated list of sort keys and directions in the form of
1877 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
1878 ity_zone, name, bootable, created_at, reference. Default=None.
1879 --tenant [<tenant>]
1881 Display information from single tenant (Admin only).
1882 --filters [<key=value> [<key=value> ...]]
1884 Filter key and value pairs. Please use ‘cinder list-filters’ to
1885 check enabled filters from server, Default=None. (Supported by
1886 API version 3.33 and later)
1887 cinder list-extensions
1889 usage: cinder list-extensions
1890 cinder list-filters
1892 usage: cinder list-filters [--resource <resource>]
1893 Optional arguments:
1895 --resource <resource>
1897 Show enabled filters for specified resource. Default=None.
1898 cinder manage
1900 usage: cinder manage [--id-type <id-type>] [--name <name>]
1901 [--description <description>]
1902 [--volume-type <volume-type>]
1903 [--availability-zone <availability-zone>]
1904 [--metadata [<key=value> [<key=value> ...]]] [--bootable]
1905 <host> <identifier>
1906 Manage an existing volume.
1908 Positional arguments:
1910 <host> Cinder host on which the existing volume resides; takes the
1912 form: host@backend-name#pool
1913 <identifier>
1915 Name or other Identifier for existing volume
1916 Optional arguments:
1918 --id-type <id-type>
1920 Type of backend device identifier provided, typically
1921 source-name or source-id (Default=source-name)
1922 --name <name>
1924 Volume name (Default=None)
1925 --description <description>
1927 Volume description (Default=None)
1928 --volume-type <volume-type>
1930 Volume type (Default=None)
1931 --availability-zone <availability-zone>
1933 Availability zone for volume (Default=None)
1934 --metadata [<key=value> [<key=value> ...]]
1936 Metadata key=value pairs (Default=None)
1937 --bootable
1939 Specifies that the newly created volume should be marked as
1940 bootable
1941 cinder manageable-list
1943 usage: cinder manageable-list [--detailed <detailed>] [--marker <marker>]
1944 [--limit <limit>] [--offset <offset>]
1945 [--sort <key>[:<direction>]]
1946 <host>
1947 Lists all manageable volumes.
1949 Positional arguments:
1951 <host> Cinder host on which to list manageable volumes; takes the form:
1953 host@backend-name#pool
1954 Optional arguments:
1956 --detailed <detailed>
1958 Returned detailed information (default true).
1959 --marker <marker>
1961 Begin returning volumes that appear later in the volume list
1962 than that represented by this reference. This reference should
1963 be json like. Default=None.
1964 --limit <limit>
1966 Maximum number of volumes to return. Default=None.
1967 --offset <offset>
1969 Number of volumes to skip after marker. Default=None.
1970 --sort <key>[:<direction>]
1972 Comma-separated list of sort keys and directions in the form of
1973 <key>[:<asc|desc>]. Valid keys: size, reference. Default=None.
1974 cinder message-delete
1976 usage: cinder message-delete <message> [<message> ...]
1977 Removes one or more messages.
1979 Positional arguments:
1981 <message>
1983 ID of one or more message to be deleted.
1984 cinder message-list
1986 usage: cinder message-list [--marker <marker>] [--limit <limit>]
1987 [--sort <key>[:<direction>]]
1988 [--resource_uuid <resource_uuid>]
1989 [--resource_type <type>] [--event_id <id>]
1990 [--request_id <request_id>] [--level <level>]
1991 [--filters [<key=value> [<key=value> ...]]]
1992 Lists all messages.
1994 Optional arguments:
1996 --marker <marker>
1998 Begin returning message that appear later in the message list
1999 than that represented by this id. Default=None. (Supported by
2000 API version 3.5 and later)
2001 --limit <limit>
2003 Maximum number of messages to return. Default=None. (Supported
2004 by API version 3.5 and later)
2005 --sort <key>[:<direction>]
2007 Comma-separated list of sort keys and directions in the form of
2008 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
2009 ity_zone, name, bootable, created_at, reference. Default=None.
2010 (Supported by API version 3.5 and later)
2011 --resource_uuid <resource_uuid>
2013 Filters results by a resource uuid. Default=None. This option is
2014 deprecated and will be removed in newer release. Please use
2015 ‘–filters’ option which is introduced since 3.33 instead.
2016 --resource_type <type>
2018 Filters results by a resource type. Default=None. This option is
2019 deprecated and will be removed in newer release. Please use
2020 ‘–filters’ option which is introduced since 3.33 instead.
2021 --event_id <id>
2023 Filters results by event id. Default=None. This option is depre‐
2024 cated and will be removed in newer release. Please use ‘–fil‐
2025 ters’ option which is introduced since 3.33 instead.
2026 --request_id <request_id>
2028 Filters results by request id. Default=None. This option is dep‐
2029 recated and will be removed in newer release. Please use ‘–fil‐
2030 ters’ option which is introduced since 3.33 instead.
2031 --level <level>
2033 Filters results by the message level. Default=None. This option
2034 is deprecated and will be removed in newer release. Please use
2035 ‘–filters’ option which is introduced since 3.33 instead.
2036 --filters [<key=value> [<key=value> ...]]
2038 Filter key and value pairs. Please use ‘cinder list-filters’ to
2039 check enabled filters from server, Default=None. (Supported by
2040 API version 3.33 and later)
2041 cinder message-show
2043 usage: cinder message-show <message>
2044 Shows message details.
2046 Positional arguments:
2048 <message>
2050 ID of message.
2051 cinder metadata
2053 usage: cinder metadata <volume> <action> <key=value> [<key=value> ...]
2054 Sets or deletes volume metadata.
2056 Positional arguments:
2058 <volume>
2060 Name or ID of volume for which to update metadata.
2061 <action>
2063 The action. Valid values are “set” or “unset.”
2064 <key=value>
2066 Metadata key and value pair to set or unset. For unset, specify
2067 only the key(s): <key key> (Supported by API version 3.15 and
2068 later)
2069 cinder metadata-show
2071 usage: cinder metadata-show <volume>
2072 Shows volume metadata.
2074 Positional arguments:
2076 <volume>
2078 ID of volume.
2079 cinder metadata-update-all
2081 usage: cinder metadata-update-all <volume> <key=value> [<key=value> ...]
2082 Updates volume metadata.
2084 Positional arguments:
2086 <volume>
2088 ID of volume for which to update metadata.
2089 <key=value>
2091 Metadata key and value pair or pairs to update.
2092 cinder migrate
2094 usage: cinder migrate [--force-host-copy [<True|False>]]
2095 [--lock-volume [<True|False>]]
2096 <volume> <host>
2097 Migrates volume to a new host.
2099 Positional arguments:
2101 <volume>
2103 ID of volume to migrate.
2104 <host> Destination host. Takes the form: host@backend-name#pool
2106 Optional arguments:
2108 --force-host-copy [<True|False>]
2110 Enables or disables generic host-based force-migration, which
2111 bypasses driver optimizations. Default=False.
2112 --lock-volume [<True|False>]
2114 Enables or disables the termination of volume migration caused
2115 by other commands. This option applies to the available volume.
2116 True means it locks the volume state and does not allow the
2117 migration to be aborted. The volume status will be in mainte‐
2118 nance during the migration. False means it allows the volume
2119 migration to be aborted. The volume status is still in the orig‐
2120 inal status. Default=False.
2121 cinder qos-associate
2123 usage: cinder qos-associate <qos_specs> <volume_type_id>
2124 Associates qos specs with specified volume type.
2126 Positional arguments:
2128 <qos_specs>
2130 ID of QoS specifications.
2131 <volume_type_id>
2133 ID of volume type with which to associate QoS specifications.
2134 cinder qos-create
2136 usage: cinder qos-create <name> <key=value> [<key=value> ...]
2137 Creates a qos specs.
2139 Positional arguments:
2141 <name> Name of new QoS specifications.
2143 <key=value>
2145 QoS specifications.
2146 cinder qos-delete
2148 usage: cinder qos-delete [--force [<True|False>]] <qos_specs>
2149 Deletes a specified qos specs.
2151 Positional arguments:
2153 <qos_specs>
2155 ID of QoS specifications to delete.
2156 Optional arguments:
2158 --force [<True|False>]
2160 Enables or disables deletion of in-use QoS specifications.
2161 Default=False.
2162 cinder qos-disassociate
2164 usage: cinder qos-disassociate <qos_specs> <volume_type_id>
2165 Disassociates qos specs from specified volume type.
2167 Positional arguments:
2169 <qos_specs>
2171 ID of QoS specifications.
2172 <volume_type_id>
2174 ID of volume type with which to associate QoS specifications.
2175 cinder qos-disassociate-all
2177 usage: cinder qos-disassociate-all <qos_specs>
2178 Disassociates qos specs from all its associations.
2180 Positional arguments:
2182 <qos_specs>
2184 ID of QoS specifications on which to operate.
2185 cinder qos-get-association
2187 usage: cinder qos-get-association <qos_specs>
2188 Lists all associations for specified qos specs.
2190 Positional arguments:
2192 <qos_specs>
2194 ID of QoS specifications.
2195 cinder qos-key
2197 usage: cinder qos-key <qos_specs> <action> key=value [key=value ...]
2198 Sets or unsets specifications for a qos spec.
2200 Positional arguments:
2202 <qos_specs>
2204 ID of QoS specifications.
2205 <action>
2207 The action. Valid values are “set” or “unset.”
2208 key=value
2210 Metadata key and value pair to set or unset. For unset, specify
2211 only the key.
2212 cinder qos-list
2214 usage: cinder qos-list
2215 Lists qos specs.
2217 cinder qos-show
2219 usage: cinder qos-show <qos_specs>
2220 Shows qos specs details.
2222 Positional arguments:
2224 <qos_specs>
2226 ID of QoS specifications to show.
2227 cinder quota-class-show
2229 usage: cinder quota-class-show <class>
2230 Lists quotas for a quota class.
2232 Positional arguments:
2234 <class>
2236 Name of quota class for which to list quotas.
2237 cinder quota-class-update
2239 usage: cinder quota-class-update [--volumes <volumes>]
2240 [--snapshots <snapshots>]
2241 [--gigabytes <gigabytes>]
2242 [--volume-type <volume_type_name>]
2243 <class_name>
2244 Updates quotas for a quota class.
2246 Positional arguments:
2248 <class_name>
2250 Name of quota class for which to set quotas.
2251 Optional arguments:
2253 --volumes <volumes>
2255 The new “volumes” quota value. Default=None.
2256 --snapshots <snapshots>
2258 The new “snapshots” quota value. Default=None.
2259 --gigabytes <gigabytes>
2261 The new “gigabytes” quota value. Default=None.
2262 --volume-type <volume_type_name>
2264 Volume type. Default=None.
2265 cinder quota-defaults
2267 usage: cinder quota-defaults <tenant_id>
2268 Lists default quotas for a tenant.
2270 Positional arguments:
2272 <tenant_id>
2274 ID of tenant for which to list quota defaults.
2275 cinder quota-delete
2277 usage: cinder quota-delete <tenant_id>
2278 Delete the quotas for a tenant.
2280 Positional arguments:
2282 <tenant_id>
2284 UUID of tenant to delete the quotas for.
2285 cinder quota-show
2287 usage: cinder quota-show <tenant_id>
2288 Lists quotas for a tenant.
2290 Positional arguments:
2292 <tenant_id>
2294 ID of tenant for which to list quotas.
2295 cinder quota-update
2297 usage: cinder quota-update [--volumes <volumes>] [--snapshots <snapshots>]
2298 [--gigabytes <gigabytes>] [--backups <backups>]
2299 [--backup-gigabytes <backup_gigabytes>]
2300 [--consistencygroups <consistencygroups>]
2301 [--groups <groups>]
2302 [--volume-type <volume_type_name>]
2303 [--per-volume-gigabytes <per_volume_gigabytes>]
2304 <tenant_id>
2305 Updates quotas for a tenant.
2307 Positional arguments:
2309 <tenant_id>
2311 ID of tenant for which to set quotas.
2312 Optional arguments:
2314 --volumes <volumes>
2316 The new “volumes” quota value. Default=None.
2317 --snapshots <snapshots>
2319 The new “snapshots” quota value. Default=None.
2320 --gigabytes <gigabytes>
2322 The new “gigabytes” quota value. Default=None.
2323 --backups <backups>
2325 The new “backups” quota value. Default=None.
2326 --backup-gigabytes <backup_gigabytes>
2328 The new “backup_gigabytes” quota value. Default=None.
2329 --consistencygroups <consistencygroups>
2331 The new “consistencygroups” quota value. Default=None.
2332 --groups <groups>
2334 The new “groups” quota value. Default=None. (Supported by API
2335 version 3.13 and later)
2336 --volume-type <volume_type_name>
2338 Volume type. Default=None.
2339 --per-volume-gigabytes <per_volume_gigabytes>
2341 Set max volume size limit. Default=None.
2342 cinder quota-usage
2344 usage: cinder quota-usage <tenant_id>
2345 Lists quota usage for a tenant.
2347 Positional arguments:
2349 <tenant_id>
2351 ID of tenant for which to list quota usage.
2352 cinder rate-limits
2354 usage: cinder rate-limits [<tenant_id>]
2355 Lists rate limits for a user.
2357 Positional arguments:
2359 <tenant_id>
2361 Display information for a single tenant (Admin only).
2362 cinder readonly-mode-update
2364 usage: cinder readonly-mode-update <volume> <True|true|False|false>
2365 Updates volume read-only access-mode flag.
2367 Positional arguments:
2369 <volume>
2371 ID of volume to update.
2372 <True|true|False|false>
2374 Enables or disables update of volume to read-only access mode.
2375 cinder rename
2377 usage: cinder rename [--description <description>] <volume> [<name>]
2378 Renames a volume.
2380 Positional arguments:
2382 <volume>
2384 Name or ID of volume to rename.
2385 <name> New name for volume.
2387 Optional arguments:
2389 --description <description>
2391 Volume description. Default=None.
2392 cinder replication-promote
2394 usage: cinder replication-promote <volume>
2395 Promote a secondary volume to primary for a relationship.
2397 Positional arguments:
2399 <volume>
2401 Name or ID of the volume to promote. The volume should have the
2402 replica volume created with source-replica argument.
2403 cinder replication-reenable
2405 usage: cinder replication-reenable <volume>
2406 Sync the secondary volume with primary for a relationship.
2408 Positional arguments:
2410 <volume>
2412 Name or ID of the volume to reenable replication. The replica‐
2413 tion-status of the volume should be inactive.
2414 cinder reset-state
2416 usage: cinder reset-state [--type <type>] [--state <state>]
2417 [--attach-status <attach-status>]
2418 [--reset-migration-status]
2419 <entity> [<entity> ...]
2420 Explicitly updates the entity state in the Cinder database. Being a
2422 database change only, this has no impact on the true state of the
2423 entity and may not match the actual state. This can render a entity
2424 unusable in the case of changing to the ‘available’ state.
2425 Positional arguments:
2427 <entity>
2429 Name or ID of entity to update.
2430 Optional arguments:
2432 --type <type>
2434 Type of entity to update. Available resources are: ‘volume’,
2435 ‘snapshot’, ‘backup’, ‘group’ (since 3.20) and ‘group-snapshot’
2436 (since 3.19), Default=volume.
2437 --state <state>
2439 The state to assign to the entity. NOTE: This command simply
2440 changes the state of the entity in the database with no regard
2441 to actual status, exercise caution when using. Default=None,
2442 that means the state is unchanged.
2443 --attach-status <attach-status>
2445 This is only used for a volume entity. The attach status to
2446 assign to the volume in the database, with no regard to the
2447 actual status. Valid values are “attached” and “detached”.
2448 Default=None, that means the status is unchanged.
2449 --reset-migration-status
2451 This is only used for a volume entity. Clears the migration sta‐
2452 tus of the volume in the DataBase that indicates the volume is
2453 source or destination of volume migration, with no regard to the
2454 actual status.
2455 cinder retype
2457 usage: cinder retype [--migration-policy <never|on-demand>]
2458 <volume> <volume-type>
2459 Changes the volume type for a volume.
2461 Positional arguments:
2463 <volume>
2465 Name or ID of volume for which to modify type.
2466 <volume-type>
2468 New volume type.
2469 Optional arguments:
2471 --migration-policy <never|on-demand>
2473 Migration policy during retype of volume.
2474 cinder service-disable
2476 usage: cinder service-disable [--reason <reason>] <hostname> <binary>
2477 Disables the service.
2479 Positional arguments:
2481 <hostname>
2483 Host name.
2484 <binary>
2486 Service binary.
2487 Optional arguments:
2489 --reason <reason>
2491 Reason for disabling service.
2492 cinder service-enable
2494 usage: cinder service-enable <hostname> <binary>
2495 Enables the service.
2497 Positional arguments:
2499 <hostname>
2501 Host name.
2502 <binary>
2504 Service binary.
2505 cinder service-list
2507 usage: cinder service-list [--host <hostname>] [--binary <binary>]
2508 [--withreplication [<True|False>]]
2509 Lists all services. Filter by host and service binary.
2511 Optional arguments:
2513 --host <hostname>
2515 Host name. Default=None.
2516 --binary <binary>
2518 Service binary. Default=None.
2519 --withreplication [<True|False>]
2521 Enables or disables display of Replication info for c-vol ser‐
2522 vices. Default=False. (Supported by API version 3.7 and later)
2523 cinder set-bootable
2525 usage: cinder set-bootable <volume> <True|true|False|false>
2526 Update bootable status of a volume.
2528 Positional arguments:
2530 <volume>
2532 ID of the volume to update.
2533 <True|true|False|false>
2535 Flag to indicate whether volume is bootable.
2536 cinder show
2538 usage: cinder show <volume>
2539 Shows volume details.
2541 Positional arguments:
2543 <volume>
2545 Name or ID of volume.
2546 cinder snapshot-create
2548 usage: cinder snapshot-create [--force [<True|False>]] [--name <name>]
2549 [--description <description>]
2550 [--metadata [<key=value> [<key=value> ...]]]
2551 <volume>
2552 Creates a snapshot.
2554 Positional arguments:
2556 <volume>
2558 Name or ID of volume to snapshot.
2559 Optional arguments:
2561 --force [<True|False>]
2563 Allows or disallows snapshot of a volume when the volume is
2564 attached to an instance. If set to True, ignores the current
2565 status of the volume when attempting to snapshot it rather than
2566 forcing it to be available. Default=False.
2567 --name <name>
2569 Snapshot name. Default=None.
2570 --description <description>
2572 Snapshot description. Default=None.
2573 --metadata [<key=value> [<key=value> ...]]
2575 Snapshot metadata key and value pairs. Default=None.
2576 cinder snapshot-delete
2578 usage: cinder snapshot-delete [--force] <snapshot> [<snapshot> ...]
2579 Removes one or more snapshots.
2581 Positional arguments:
2583 <snapshot>
2585 Name or ID of the snapshot(s) to delete.
2586 Optional arguments:
2588 --force
2590 Allows deleting snapshot of a volume when its status is other
2591 than “available” or “error”. Default=False.
2592 cinder snapshot-list
2594 usage: cinder snapshot-list [--all-tenants [<0|1>]] [--name <name>]
2595 [--status <status>] [--volume-id <volume-id>]
2596 [--marker <marker>] [--limit <limit>]
2597 [--sort <key>[:<direction>]] [--tenant [<tenant>]]
2598 [--metadata [<key=value> [<key=value> ...]]]
2599 [--filters [<key=value> [<key=value> ...]]]
2600 Lists all snapshots.
2602 Optional arguments:
2604 --all-tenants [<0|1>]
2606 Shows details for all tenants. Admin only.
2607 --name <name>
2609 Filters results by a name. Default=None. This option is depre‐
2610 cated and will be removed in newer release. Please use ‘–fil‐
2611 ters’ option which is introduced since 3.33 instead.
2612 --status <status>
2614 Filters results by a status. Default=None. This option is depre‐
2615 cated and will be removed in newer release. Please use ‘–fil‐
2616 ters’ option which is introduced since 3.33 instead.
2617 --volume-id <volume-id>
2619 Filters results by a volume ID. Default=None. This option is
2620 deprecated and will be removed in newer release. Please use
2621 ‘–filters’ option which is introduced since 3.33 instead.
2622 --marker <marker>
2624 Begin returning snapshots that appear later in the snapshot list
2625 than that represented by this id. Default=None.
2626 --limit <limit>
2628 Maximum number of snapshots to return. Default=None.
2629 --sort <key>[:<direction>]
2631 Comma-separated list of sort keys and directions in the form of
2632 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
2633 ity_zone, name, bootable, created_at, reference. Default=None.
2634 --tenant [<tenant>]
2636 Display information from single tenant (Admin only).
2637 --metadata [<key=value> [<key=value> ...]]
2639 Filters results by a metadata key and value pair. Require vol‐
2640 ume api version >=3.22. Default=None. This option is deprecated
2641 and will be removed in newer release. Please use ‘–filters’
2642 option which is introduced since 3.33 instead. (Supported by API
2643 version 3.22 and later)
2644 --filters [<key=value> [<key=value> ...]]
2646 Filter key and value pairs. Please use ‘cinder list-filters’ to
2647 check enabled filters from server, Default=None. (Supported by
2648 API version 3.33 and later)
2649 cinder snapshot-manage
2651 usage: cinder snapshot-manage [--id-type <id-type>] [--name <name>]
2652 [--description <description>]
2653 [--metadata [<key=value> [<key=value> ...]]]
2654 <volume> <identifier>
2655 Manage an existing snapshot.
2657 Positional arguments:
2659 <volume>
2661 Cinder volume already exists in volume backend
2662 <identifier>
2664 Name or other Identifier for existing snapshot
2665 Optional arguments:
2667 --id-type <id-type>
2669 Type of backend device identifier provided, typically
2670 source-name or source-id (Default=source-name)
2671 --name <name>
2673 Snapshot name (Default=None)
2674 --description <description>
2676 Snapshot description (Default=None)
2677 --metadata [<key=value> [<key=value> ...]]
2679 Metadata key=value pairs (Default=None)
2680 cinder snapshot-manageable-list
2682 usage: cinder snapshot-manageable-list [--detailed <detailed>]
2683 [--marker <marker>] [--limit <limit>]
2684 [--offset <offset>]
2685 [--sort <key>[:<direction>]]
2686 <host>
2687 Lists all manageable snapshots.
2689 Positional arguments:
2691 <host> Cinder host on which to list manageable snapshots; takes the
2693 form: host@backend-name#pool
2694 Optional arguments:
2696 --detailed <detailed>
2698 Returned detailed information (default true).
2699 --marker <marker>
2701 Begin returning volumes that appear later in the volume list
2702 than that represented by this reference. This reference should
2703 be json like. Default=None.
2704 --limit <limit>
2706 Maximum number of volumes to return. Default=None.
2707 --offset <offset>
2709 Number of volumes to skip after marker. Default=None.
2710 --sort <key>[:<direction>]
2712 Comma-separated list of sort keys and directions in the form of
2713 <key>[:<asc|desc>]. Valid keys: size, reference. Default=None.
2714 cinder snapshot-metadata
2716 usage: cinder snapshot-metadata <snapshot> <action> <key=value>
2717 [<key=value> ...]
2718 Sets or deletes snapshot metadata.
2720 Positional arguments:
2722 <snapshot>
2724 ID of snapshot for which to update metadata.
2725 <action>
2727 The action. Valid values are “set” or “unset.”
2728 <key=value>
2730 Metadata key and value pair to set or unset. For unset, specify
2731 only the key.
2732 cinder snapshot-metadata-show
2734 usage: cinder snapshot-metadata-show <snapshot>
2735 Shows snapshot metadata.
2737 Positional arguments:
2739 <snapshot>
2741 ID of snapshot.
2742 cinder snapshot-metadata-update-all
2744 usage: cinder snapshot-metadata-update-all <snapshot> <key=value>
2745 [<key=value> ...]
2746 Updates snapshot metadata.
2748 Positional arguments:
2750 <snapshot>
2752 ID of snapshot for which to update metadata.
2753 <key=value>
2755 Metadata key and value pair to update.
2756 cinder snapshot-rename
2758 usage: cinder snapshot-rename [--description <description>]
2759 <snapshot> [<name>]
2760 Renames a snapshot.
2762 Positional arguments:
2764 <snapshot>
2766 Name or ID of snapshot.
2767 <name> New name for snapshot.
2769 Optional arguments:
2771 --description <description>
2773 Snapshot description. Default=None.
2774 cinder snapshot-reset-state
2776 usage: cinder snapshot-reset-state [--state <state>]
2777 <snapshot> [<snapshot> ...]
2778 Explicitly updates the snapshot state.
2780 Positional arguments:
2782 <snapshot>
2784 Name or ID of snapshot to modify.
2785 Optional arguments:
2787 --state <state>
2789 The state to assign to the snapshot. Valid values are “avail‐
2790 able”, “error”, “creating”, “deleting”, and “error_deleting”.
2791 NOTE: This command simply changes the state of the Snapshot in
2792 the DataBase with no regard to actual status, exercise caution
2793 when using. Default=available.
2794 cinder snapshot-show
2796 usage: cinder snapshot-show <snapshot>
2797 Shows snapshot details.
2799 Positional arguments:
2801 <snapshot>
2803 Name or ID of snapshot.
2804 cinder snapshot-unmanage
2806 usage: cinder snapshot-unmanage <snapshot>
2807 Stop managing a snapshot.
2809 Positional arguments:
2811 <snapshot>
2813 Name or ID of the snapshot to unmanage.
2814 cinder thaw-host
2816 usage: cinder thaw-host <hostname>
2817 Thaw and enable the specified cinder-volume host.
2819 Positional arguments:
2821 <hostname>
2823 Host name.
2824 cinder transfer-accept
2826 usage: cinder transfer-accept <transfer> <auth_key>
2827 Accepts a volume transfer.
2829 Positional arguments:
2831 <transfer>
2833 ID of transfer to accept.
2834 <auth_key>
2836 Authentication key of transfer to accept.
2837 cinder transfer-create
2839 usage: cinder transfer-create [--name <name>] <volume>
2840 Creates a volume transfer.
2842 Positional arguments:
2844 <volume>
2846 Name or ID of volume to transfer.
2847 Optional arguments:
2849 --name <name>
2851 Transfer name. Default=None.
2852 cinder transfer-delete
2854 usage: cinder transfer-delete <transfer>
2855 Undoes a transfer.
2857 Positional arguments:
2859 <transfer>
2861 Name or ID of transfer to delete.
2862 cinder transfer-list
2864 usage: cinder transfer-list [--all-tenants [<0|1>]]
2865 Lists all transfers.
2867 Optional arguments:
2869 --all-tenants [<0|1>]
2871 Shows details for all tenants. Admin only.
2872 cinder transfer-show
2874 usage: cinder transfer-show <transfer>
2875 Shows transfer details.
2877 Positional arguments:
2879 <transfer>
2881 Name or ID of transfer to accept.
2882 cinder type-access-add
2884 usage: cinder type-access-add --volume-type <volume_type> --project-id
2885 <project_id>
2886 Adds volume type access for the given project.
2888 Optional arguments:
2890 --volume-type <volume_type>
2892 Volume type name or ID to add access for the given project.
2893 --project-id <project_id>
2895 Project ID to add volume type access for.
2896 cinder type-access-list
2898 usage: cinder type-access-list --volume-type <volume_type>
2899 Print access information about the given volume type.
2901 Optional arguments:
2903 --volume-type <volume_type>
2905 Filter results by volume type name or ID.
2906 cinder type-access-remove
2908 usage: cinder type-access-remove --volume-type <volume_type> --project-id
2909 <project_id>
2910 Removes volume type access for the given project.
2912 Optional arguments:
2914 --volume-type <volume_type>
2916 Volume type name or ID to remove access for the given project.
2917 --project-id <project_id>
2919 Project ID to remove volume type access for.
2920 cinder type-create
2922 usage: cinder type-create [--description <description>]
2923 [--is-public <is-public>]
2924 <name>
2925 Creates a volume type.
2927 Positional arguments:
2929 <name> Name of new volume type.
2931 Optional arguments:
2933 --description <description>
2935 Description of new volume type.
2936 --is-public <is-public>
2938 Make type accessible to the public (default true).
2939 cinder type-default
2941 usage: cinder type-default
2942 List the default volume type.
2944 cinder type-delete
2946 usage: cinder type-delete <vol_type> [<vol_type> ...]
2947 Deletes volume type or types.
2949 Positional arguments:
2951 <vol_type>
2953 Name or ID of volume type or types to delete.
2954 cinder type-key
2956 usage: cinder type-key <vtype> <action> <key=value> [<key=value> ...]
2957 Sets or unsets extra_spec for a volume type.
2959 Positional arguments:
2961 <vtype>
2963 Name or ID of volume type.
2964 <action>
2966 The action. Valid values are “set” or “unset.”
2967 <key=value>
2969 The extra specs key and value pair to set or unset. For unset,
2970 specify only the key.
2971 cinder type-list
2973 usage: cinder type-list
2974 Lists available ‘volume types’. (Only admin and tenant users will see
2976 private types)
2977 cinder type-show
2979 usage: cinder type-show <volume_type>
2980 Show volume type details.
2982 Positional arguments:
2984 <volume_type>
2986 Name or ID of the volume type.
2987 cinder type-update
2989 usage: cinder type-update [--name <name>] [--description <description>]
2990 [--is-public <is-public>]
2991 <id>
2992 Updates volume type name, description, and/or is_public.
2994 Positional arguments:
2996 <id> ID of the volume type.
2998 Optional arguments:
3000 --name <name>
3002 Name of the volume type.
3003 --description <description>
3005 Description of the volume type.
3006 --is-public <is-public>
3008 Make type accessible to the public or not.
3009 cinder unmanage
3011 usage: cinder unmanage <volume>
3012 Stop managing a volume.
3014 Positional arguments:
3016 <volume>
3018 Name or ID of the volume to unmanage.
3019 cinder upload-to-image
3021 usage: cinder upload-to-image [--force [<True|False>]]
3022 [--container-format <container-format>]
3023 [--disk-format <disk-format>]
3024 [--visibility <public|private>]
3025 [--protected <True|False>]
3026 <volume> <image-name>
3027 Uploads volume to Image Service as an image.
3029 Positional arguments:
3031 <volume>
3033 Name or ID of volume to snapshot.
3034 <image-name>
3036 The new image name.
3037 Optional arguments:
3039 --force [<True|False>]
3041 Enables or disables upload of a volume that is attached to an
3042 instance. Default=False. This option may not be supported by
3043 your cloud.
3044 --container-format <container-format>
3046 Container format type. Default is bare.
3047 --disk-format <disk-format>
3049 Disk format type. Default is raw.
3050 --visibility <public|private>
3052 Set image visibility to either public or private. Default=pri‐
3053 vate. (Supported by API version 3.1 and later)
3054 --protected <True|False>
3056 Prevents image from being deleted. Default=False. (Supported by
3057 API version 3.1 and later)
3058 cinder version-list
3060 usage: cinder version-list
3061 List all API versions.
3063
3065 OpenStack Contributors
3066
3068 OpenStack Contributors
30693.5.0 Feb 02, 2019 CINDER(1)