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 For help on a specific cinder command, enter:
12 $ cinder help COMMAND
14
16 usage: cinder [--version] [-d] [--os-auth-system <os-auth-system>]
17 [--os-auth-type <os-auth-type>] [--service-type <service-type>]
18 [--service-name <service-name>]
19 [--volume-service-name <volume-service-name>]
20 [--os-endpoint-type <os-endpoint-type>]
21 [--endpoint-type <endpoint-type>]
22 [--os-volume-api-version <volume-api-ver>]
23 [--os-endpoint <os-endpoint>]
24 [--retries <retries>] [--profile HMAC_KEY]
25 [--os-auth-strategy <auth-strategy>]
26 [--os-username <auth-user-name>] [--os-password <auth-password>]
27 [--os-tenant-name <auth-tenant-name>]
28 [--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>]
29 [--os-user-id <auth-user-id>]
30 [--os-user-domain-id <auth-user-domain-id>]
31 [--os-user-domain-name <auth-user-domain-name>]
32 [--os-project-id <auth-project-id>]
33 [--os-project-name <auth-project-name>]
34 [--os-project-domain-id <auth-project-domain-id>]
35 [--os-project-domain-name <auth-project-domain-name>]
36 [--os-region-name <region-name>] [--os-token <token>]
37 [--os-url <url>] [--insecure] [--os-cacert <ca-certificate>]
38 [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>]
39 <subcommand> ...
40 Subcommands:
42 absolute-limits
44 Lists absolute limits for a user.
45 api-version
47 Display the server API version information. (Supported by API
48 versions 3.0 - 3.latest) [hint: use '--os-volume-api-version'
49 flag to show help message for proper version]
50 attachment-create
52 Create an attachment for a cinder volume. (Supported by API ver‐
53 sions 3.27 - 3.latest) [hint: use '--os-volume-api-version' flag
54 to show help message for proper version]
55 attachment-delete
57 Delete an attachment for a cinder volume. (Supported by API ver‐
58 sions 3.27 - 3.latest) [hint: use '--os-volume-api-version' flag
59 to show help message for proper version]
60 attachment-list
62 Lists all attachments. (Supported by API versions 3.27 - 3.lat‐
63 est) [hint: use '--os-volume-api-version' flag to show help mes‐
64 sage for proper version]
65 attachment-show
67 Show detailed information for attachment. (Supported by API ver‐
68 sions 3.27 - 3.latest) [hint: use '--os-volume-api-version' flag
69 to show help message for proper version]
70 attachment-update
72 Update an attachment for a cinder volume. (Supported by API ver‐
73 sions 3.27 - 3.latest) [hint: use '--os-volume-api-version' flag
74 to show help message for proper version]
75 availability-zone-list
77 Lists all availability zones.
78 backup-create
80 Creates a volume backup.
81 backup-delete
83 Removes one or more backups.
84 backup-export
86 Export backup metadata record.
87 backup-import
89 Import backup metadata record.
90 backup-list
92 Lists all backups.
93 backup-reset-state
95 Explicitly updates the backup state.
96 backup-restore
98 Restores a backup.
99 backup-show
101 Shows backup details.
102 backup-update
104 Renames a backup. (Supported by API versions 3.9 -3.latest)
105 [hint: use '--os-volume-api-version' flag to show help message
106 for proper version]
107 cgsnapshot-create
109 Creates a cgsnapshot.
110 cgsnapshot-delete
112 Removes one or more cgsnapshots.
113 cgsnapshot-list
115 Lists all cgsnapshots.
116 cgsnapshot-show
118 Shows cgsnapshot details.
119 cluster-disable
121 Disables clustered services. (Supported by API versions 3.7 -
122 3.latest) [hint: use '--os-volume-api-version' flag to show help
123 message for proper version]
124 cluster-enable
126 Enables clustered services. (Supported by API versions 3.7 -
127 3.latest) [hint: use '--os-volume-api-version' flag to show help
128 message for proper version]
129 cluster-list
131 Lists clustered services with optional filtering. (Supported by
132 API versions 3.7 - 3.latest) [hint: use '--os-volume-api-ver‐
133 sion' flag to show help message for proper version]
134 cluster-show
136 Show detailed information on a clustered service. (Supported by
137 API versions 3.7 - 3.latest) [hint: use '--os-volume-api-ver‐
138 sion' flag to show help message for proper version]
139 consisgroup-create
141 Creates a consistency group.
142 consisgroup-create-from-src
144 Creates a consistency group from a cgsnapshot or a source CG.
145 consisgroup-delete
147 Removes one or more consistency groups.
148 consisgroup-list
150 Lists all consistency groups.
151 consisgroup-show
153 Shows details of a consistency group.
154 consisgroup-update
156 Updates a consistency group.
157 create Creates a volume.
159 credentials
161 Shows user credentials returned from auth.
162 delete Removes one or more volumes.
164 encryption-type-create
166 Creates encryption type for a volume type. Admin only.
167 encryption-type-delete
169 Deletes encryption type for a volume type. Admin only.
170 encryption-type-list
172 Shows encryption type details for volume types. Admin only.
173 encryption-type-show
175 Shows encryption type details for a volume type. Admin only.
176 encryption-type-update
178 Update encryption type information for a volume type (Admin
179 Only).
180 endpoints
182 Discovers endpoints registered by authentication service.
183 extend Attempts to extend size of an existing volume.
185 extra-specs-list
187 Lists current volume types and extra specs.
188 failover-host
190 Failover a replicating cinder-volume host.
191 force-delete
193 Attempts force-delete of volume, regardless of state.
194 freeze-host
196 Freeze and disable the specified cinder-volume host.
197 get-capabilities
199 Show backend volume stats and properties. Admin only.
200 get-pools
202 Show pool information for backends. Admin only.
203 group-create
205 Creates a group. (Supported by API versions 3.13 -3.latest)
206 [hint: use '--os-volume-api-version' flag to show help message
207 for proper version]
208 group-create-from-src
210 Creates a group from a group snapshot or a source group. (Sup‐
211 ported by API versions 3.14 - 3.latest) [hint: use '--os-vol‐
212 ume-api-version' flag to show help message for proper version]
213 group-delete
215 Removes one or more groups. (Supported by API versions 3.13 -
216 3.latest) [hint: use '--os-volume-api-version' flag to show help
217 message for proper version]
218 group-list
220 Lists all groups. (Supported by API versions 3.13 -3.latest)
221 [hint: use '--os-volume-api-version' flag to show help message
222 for proper version]
223 group-show
225 Shows details of a group. (Supported by API versions 3.13 -
226 3.latest) [hint: use '--os-volume-api-version' flag to show help
227 message for proper version]
228 group-snapshot-create
230 Creates a group snapshot. (Supported by API versions 3.14 -
231 3.latest) [hint: use '--os-volume-api-version' flag to show help
232 message for proper version]
233 group-snapshot-delete
235 Removes one or more group snapshots. (Supported by API versions
236 3.14 - 3.latest) [hint: use '--os-volume-api-version' flag to
237 show help message for proper version]
238 group-snapshot-list
240 Lists all group snapshots. (Supported by API versions 3.14 -
241 3.latest) [hint: use '--os-volume-api-version' flag to show help
242 message for proper version]
243 group-snapshot-show
245 Shows group snapshot details. (Supported by API versions 3.14 -
246 3.latest) [hint: use '--os-volume-api-version' flag to show help
247 message for proper version]
248 group-specs-list
250 Lists current group types and specs. (Supported by API versions
251 3.11 - 3.latest) [hint: use '--os-volume-api-version' flag to
252 show help message for proper version]
253 group-type-create
255 Creates a group type. (Supported by API versions 3.11 - 3.lat‐
256 est) [hint: use '--os-volume-api-version' flag to show help mes‐
257 sage for proper version]
258 group-type-default
260 List the default group type. (Supported by API versions 3.11 -
261 3.latest) [hint: use '--os-volume-api-version' flag to show help
262 message for proper version]
263 group-type-delete
265 Deletes group type or types. (Supported by API versions 3.11 -
266 3.latest) [hint: use '--os-volume-api-version' flag to show help
267 message for proper version]
268 group-type-key
270 Sets or unsets group_spec for a group type. (Supported by API
271 versions 3.11 - 3.latest) [hint: use '--os-volume-api-version'
272 flag to show help message for proper version]
273 group-type-list
275 Lists available 'group types'. (Admin only will see private
276 types) (Supported by API versions 3.11 -3.latest) [hint: use
277 '--os-volume-api-version' flag to show help message for proper
278 version]
279 group-type-show
281 Show group type details. (Supported by API versions 3.11 -
282 3.latest) [hint: use '--os-volume-api-version' flag to show help
283 message for proper version]
284 group-type-update
286 Updates group type name, description, and/or is_public. (Sup‐
287 ported by API versions 3.11 - 3.latest) [hint: use '--os-vol‐
288 ume-api-version' flag to show help message for proper version]
289 group-update
291 Updates a group. (Supported by API versions 3.13 -3.latest)
292 [hint: use '--os-volume-api-version' flag to show help message
293 for proper version]
294 image-metadata
296 Sets or deletes volume image metadata.
297 image-metadata-show
299 Shows volume image metadata.
300 list Lists all volumes.
302 list-filters
304 (Supported by API versions 3.33 - 3.latest) [hint: use
305 '--os-volume-api-version' flag to show help message for proper
306 version]
307 manage Manage an existing volume.
309 manageable-list
311 Lists all manageable volumes. (Supported by API versions 3.8 -
312 3.latest) [hint: use '--os-volume-api-version' flag to show help
313 message for proper version]
314 message-delete
316 Removes one or more messages. (Supported by API versions 3.3 -
317 3.latest) [hint: use '--os-volume-api-version' flag to show help
318 message for proper version]
319 message-list
321 Lists all messages. (Supported by API versions 3.3 -3.latest)
322 [hint: use '--os-volume-api-version' flag to show help message
323 for proper version]
324 message-show
326 Shows message details. (Supported by API versions 3.3 - 3.lat‐
327 est) [hint: use '--os-volume-api-version' flag to show help mes‐
328 sage for proper version]
329 metadata
331 Sets or deletes volume metadata.
332 metadata-show
334 Shows volume metadata.
335 metadata-update-all
337 Updates volume metadata.
338 migrate
340 Migrates volume to a new host.
341 qos-associate
343 Associates qos specs with specified volume type.
344 qos-create
346 Creates a qos specs.
347 qos-delete
349 Deletes a specified qos specs.
350 qos-disassociate
352 Disassociates qos specs from specified volume type.
353 qos-disassociate-all
355 Disassociates qos specs from all its associations.
356 qos-get-association
358 Lists all associations for specified qos specs.
359 qos-key
361 Sets or unsets specifications for a qos spec.
362 qos-list
364 Lists qos specs.
365 qos-show
367 Shows qos specs details.
368 quota-class-show
370 Lists quotas for a quota class.
371 quota-class-update
373 Updates quotas for a quota class.
374 quota-defaults
376 Lists default quotas for a tenant.
377 quota-delete
379 Delete the quotas for a tenant.
380 quota-show
382 Lists quotas for a tenant.
383 quota-update
385 Updates quotas for a tenant.
386 quota-usage
388 Lists quota usage for a tenant.
389 rate-limits
391 Lists rate limits for a user.
392 readonly-mode-update
394 Updates volume read-only access-mode flag.
395 rename Renames a volume.
397 reset-state
399 Explicitly updates the entity state in the Cinder database.
400 retype Changes the volume type for a volume.
402 service-disable
404 Disables the service.
405 service-enable
407 Enables the service.
408 service-list
410 Lists all services. Filter by host and service binary. (Sup‐
411 ported by API versions 3.0 - 3.latest) [hint: use '--os-vol‐
412 ume-api-version' flag to show help message for proper version]
413 set-bootable
415 Update bootable status of a volume.
416 show Shows volume details.
418 snapshot-create
420 Creates a snapshot.
421 snapshot-delete
423 Removes one or more snapshots.
424 snapshot-list
426 Lists all snapshots.
427 snapshot-manage
429 Manage an existing snapshot.
430 snapshot-manageable-list
432 Lists all manageable snapshots. (Supported by API versions 3.8 -
433 3.latest) [hint: use '--os-volume-api-version' flag to show help
434 message for proper version]
435 snapshot-metadata
437 Sets or deletes snapshot metadata.
438 snapshot-metadata-show
440 Shows snapshot metadata.
441 snapshot-metadata-update-all
443 Updates snapshot metadata.
444 snapshot-rename
446 Renames a snapshot.
447 snapshot-reset-state
449 Explicitly updates the snapshot state.
450 snapshot-show
452 Shows snapshot details.
453 snapshot-unmanage
455 Stop managing a snapshot.
456 thaw-host
458 Thaw and enable the specified cinder-volume host.
459 transfer-accept
461 Accepts a volume transfer.
462 transfer-create
464 Creates a volume transfer.
465 transfer-delete
467 Undoes a transfer.
468 transfer-list
470 Lists all transfers.
471 transfer-show
473 Shows transfer details.
474 type-access-add
476 Adds volume type access for the given project.
477 type-access-list
479 Print access information about the given volume type.
480 type-access-remove
482 Removes volume type access for the given project.
483 type-create
485 Creates a volume type.
486 type-default
488 List the default volume type.
489 type-delete
491 Deletes volume type or types.
492 type-key
494 Sets or unsets extra_spec for a volume type.
495 type-list
497 Lists available 'volume types'.
498 type-show
500 Show volume type details.
501 type-update
503 Updates volume type name, description, and/or is_public.
504 unmanage
506 Stop managing a volume.
507 upload-to-image
509 Uploads volume to Image Service as an image.
510 version-list
512 List all API versions. (Supported by API versions 3.0 - 3.lat‐
513 est) [hint: use '--os-volume-api-version' flag to show help mes‐
514 sage for proper version]
515 bash-completion
517 Prints arguments for bash_completion.
518 help Shows help about this program or one of its subcommands.
520 list-extensions
522
524 --version
525 show program's version number and exit
526 -d, --debug
528 Shows debugging output.
529 --os-auth-system <os-auth-system>
531 DEPRECATED! Use --os-auth-type. Defaults to env[OS_AUTH_SYSTEM].
532 --os-auth-type <os-auth-type>
534 Defaults to env[OS_AUTH_TYPE].
535 --service-type <service-type>
537 Service type. For most actions, default is volume.
538 --service-name <service-name>
540 Service name. Default= env[CINDER_SERVICE_NAME].
541 --volume-service-name <volume-service-name>
543 Volume service name. Default= env[CINDER_VOLUME_SERVICE_NAME].
544 --os-endpoint-type <os-endpoint-type>
546 Endpoint type, which is publicURL or internalURL. Default=
547 env[OS_ENDPOINT_TYPE] or nova env[CINDER_ENDPOINT_TYPE] or pub‐
548 licURL.
549 --endpoint-type <endpoint-type>
551 DEPRECATED! Use --os-endpoint-type.
552 --os-volume-api-version <volume-api-ver>
554 Block Storage API version. Accepts X, X.Y (where X is major and
555 Y is minor part).Default= env[OS_VOLUME_API_VERSION].
556 --os-endpoint <os-endpoint>
558 Use this API endpoint instead of the Service Catalog.
559 Default=``env[CINDER_ENDPOINT]``
560 --retries <retries>
562 Number of retries.
563 --profile HMAC_KEY
565 HMAC key to use for encrypting context data for performance pro‐
566 filing of operation. This key needs to match the one configured
567 on the cinder api server. Without key the profiling will not be
568 triggered even if osprofiler is enabled on server side.
569 --os-auth-strategy <auth-strategy>
571 Authentication strategy (Env: OS_AUTH_STRATEGY, default key‐
572 stone). For now, any other value will disable the authentica‐
573 tion.
574 --os-username <auth-user-name>
576 OpenStack user name. Default= env[OS_USERNAME].
577 --os-password <auth-password>
579 Password for OpenStack user. Default= env[OS_PASSWORD].
580 --os-tenant-name <auth-tenant-name>
582 Tenant name. Default= env[OS_TENANT_NAME].
583 --os-tenant-id <auth-tenant-id>
585 ID for the tenant. Default= env[OS_TENANT_ID].
586 --os-auth-url <auth-url>
588 URL for the authentication service. Default= env[OS_AUTH_URL].
589 --os-user-id <auth-user-id>
591 Authentication user ID (Env: OS_USER_ID).
592 --os-user-domain-id <auth-user-domain-id>
594 OpenStack user domain ID. Defaults to env[OS_USER_DOMAIN_ID].
595 --os-user-domain-name <auth-user-domain-name>
597 OpenStack user domain name. Defaults to
598 env[OS_USER_DOMAIN_NAME].
599 --os-project-id <auth-project-id>
601 Another way to specify tenant ID. This option is mutually exclu‐
602 sive with --os-tenant-id. Defaults to env[OS_PROJECT_ID].
603 --os-project-name <auth-project-name>
605 Another way to specify tenant name. This option is mutually
606 exclusive with --os-tenant-name. Defaults to
607 env[OS_PROJECT_NAME].
608 --os-project-domain-id <auth-project-domain-id>
610 Defaults to env[OS_PROJECT_DOMAIN_ID].
611 --os-project-domain-name <auth-project-domain-name>
613 Defaults to env[OS_PROJECT_DOMAIN_NAME].
614 --os-region-name <region-name>
616 Region name. Default= env[OS_REGION_NAME].
617 --os-token <token>
619 Defaults to env[OS_TOKEN].
620 --os-url <url>
622 Defaults to env[OS_URL].
623 cinder absolute-limits
625 usage: cinder absolute-limits [<tenant_id>]
626 Lists absolute limits for a user.
628 Positional arguments:
630 <tenant_id>
632 Display information for a single tenant (Admin only).
633 cinder api-version
635 usage: cinder api-version
636 Display the server API version information.
638 cinder attachment-create
640 usage: cinder attachment-create [--connect <connect>]
641 [--initiator <initiator>] [--ip <ip>]
642 [--host <host>] [--platform <platform>]
643 [--ostype <ostype>] [--multipath <multipath>]
644 [--mountpoint <mountpoint>]
645 <volume> <server_id>
646 Create an attachment for a cinder volume.
648 Positional arguments:
650 <volume>
652 Name or ID of volume or volumes to attach.
653 <server_id>
655 ID of server attaching to.
656 Optional arguments:
658 --connect <connect>
660 Make an active connection using provided connector info (True or
661 False).
662 --initiator <initiator>
664 iqn of the initiator attaching to. Default=None.
665 --ip <ip>
667 ip of the system attaching to. Default=None.
668 --host <host>
670 Name of the host attaching to. Default=None.
671 --platform <platform>
673 Platform type. Default=x86_64.
674 --ostype <ostype>
676 OS type. Default=linux2.
677 --multipath <multipath>
679 Use multipath. Default=False.
680 --mountpoint <mountpoint>
682 Mountpoint volume will be attached at. Default=None.
683 cinder attachment-delete
685 usage: cinder attachment-delete <attachment> [<attachment> ...]
686 Delete an attachment for a cinder volume.
688 Positional arguments:
690 <attachment>
692 ID of attachment or attachments to delete.
693 cinder attachment-list
695 usage: cinder attachment-list [--all-tenants [<0|1>]]
696 [--volume-id <volume-id>] [--status <status>]
697 [--marker <marker>] [--limit <limit>]
698 [--sort <key>[:<direction>]]
699 [--tenant [<tenant>]]
700 [--filters [<key=value> [<key=value> ...]]]
701 Lists all attachments.
703 Optional arguments:
705 --all-tenants [<0|1>]
707 Shows details for all tenants. Admin only.
708 --volume-id <volume-id>
710 Filters results by a volume ID. Default=None. This option is
711 deprecated and will be removed in newer release. Please use
712 '--filters' option which is introduced since 3.33 instead.
713 --status <status>
715 Filters results by a status. Default=None. This option is depre‐
716 cated and will be removed in newer release. Please use '--fil‐
717 ters' option which is introduced since 3.33 instead.
718 --marker <marker>
720 Begin returning attachments that appear later in attachment list
721 than that represented by this id. Default=None.
722 --limit <limit>
724 Maximum number of attachments to return. Default=None.
725 --sort <key>[:<direction>]
727 Comma-separated list of sort keys and directions in the form of
728 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
729 ity_zone, name, bootable, created_at, reference. Default=None.
730 --tenant [<tenant>]
732 Display information from single tenant (Admin only).
733 --filters [<key=value> [<key=value> ...]]
735 Filter key and value pairs. Please use 'cinder list-filters' to
736 check enabled filters from server, Default=None. (Supported by
737 API version 3.33 and later)
738 cinder attachment-show
740 usage: cinder attachment-show <attachment>
741 Show detailed information for attachment.
743 Positional arguments:
745 <attachment>
747 ID of attachment.
748 cinder attachment-update
750 usage: cinder attachment-update [--initiator <initiator>] [--ip <ip>]
751 [--host <host>] [--platform <platform>]
752 [--ostype <ostype>] [--multipath <multipath>]
753 [--mountpoint <mountpoint>]
754 <attachment>
755 Update an attachment for a cinder volume. This call is designed to be
757 more of an attachment completion than anything else. It expects the
758 value of a connector object to notify the driver that the volume is
759 going to be connected and where it's being connected to.
760 Positional arguments:
762 <attachment>
764 ID of attachment.
765 Optional arguments:
767 --initiator <initiator>
769 iqn of the initiator attaching to. Default=None.
770 --ip <ip>
772 ip of the system attaching to. Default=None.
773 --host <host>
775 Name of the host attaching to. Default=None.
776 --platform <platform>
778 Platform type. Default=x86_64.
779 --ostype <ostype>
781 OS type. Default=linux2.
782 --multipath <multipath>
784 Use multipath. Default=False.
785 --mountpoint <mountpoint>
787 Mountpoint volume will be attached at. Default=None.
788 cinder availability-zone-list
790 usage: cinder availability-zone-list
791 Lists all availability zones.
793 cinder backup-create
795 usage: cinder backup-create [--container <container>] [--name <name>]
796 [--description <description>] [--incremental]
797 [--force] [--snapshot-id <snapshot-id>]
798 <volume>
799 Creates a volume backup.
801 Positional arguments:
803 <volume>
805 Name or ID of volume to backup.
806 Optional arguments:
808 --container <container>
810 Backup container name. Default=None.
811 --name <name>
813 Backup name. Default=None.
814 --description <description>
816 Backup description. Default=None.
817 --incremental
819 Incremental backup. Default=False.
820 --force
822 Allows or disallows backup of a volume when the volume is
823 attached to an instance. If set to True, backs up the volume
824 whether its status is "available" or "in-use". The backup of an
825 "in-use" volume means your data is crash consistent.
826 Default=False.
827 --snapshot-id <snapshot-id>
829 ID of snapshot to backup. Default=None.
830 cinder backup-delete
832 usage: cinder backup-delete [--force] <backup> [<backup> ...]
833 Removes one or more backups.
835 Positional arguments:
837 <backup>
839 Name or ID of backup(s) to delete.
840 Optional arguments:
842 --force
844 Allows deleting backup of a volume when its status is other than
845 "available" or "error". Default=False.
846 cinder backup-export
848 usage: cinder backup-export <backup>
849 Export backup metadata record.
851 Positional arguments:
853 <backup>
855 ID of the backup to export.
856 cinder backup-import
858 usage: cinder backup-import <backup_service> <backup_url>
859 Import backup metadata record.
861 Positional arguments:
863 <backup_service>
865 Backup service to use for importing the backup.
866 <backup_url>
868 Backup URL for importing the backup metadata.
869 cinder backup-list
871 usage: cinder backup-list [--all-tenants [<all_tenants>]] [--name <name>]
872 [--status <status>] [--volume-id <volume-id>]
873 [--marker <marker>] [--limit <limit>]
874 [--sort <key>[:<direction>]]
875 [--filters [<key=value> [<key=value> ...]]]
876 Lists all backups.
878 Optional arguments:
880 --all-tenants [<all_tenants>]
882 Shows details for all tenants. Admin only.
883 --name <name>
885 Filters results by a name. Default=None. This option is depre‐
886 cated and will be removed in newer release. Please use '--fil‐
887 ters' option which is introduced since 3.33 instead.
888 --status <status>
890 Filters results by a status. Default=None. This option is depre‐
891 cated and will be removed in newer release. Please use '--fil‐
892 ters' option which is introduced since 3.33 instead.
893 --volume-id <volume-id>
895 Filters results by a volume ID. Default=None. This option is
896 deprecated and will be removed in newer release. Please use
897 '--filters' option which is introduced since 3.33 instead.
898 --marker <marker>
900 Begin returning backups that appear later in the backup list
901 than that represented by this id. Default=None.
902 --limit <limit>
904 Maximum number of backups to return. Default=None.
905 --sort <key>[:<direction>]
907 Comma-separated list of sort keys and directions in the form of
908 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
909 ity_zone, name, bootable, created_at, reference. Default=None.
910 --filters [<key=value> [<key=value> ...]]
912 Filter key and value pairs. Please use 'cinder list-filters' to
913 check enabled filters from server, Default=None. (Supported by
914 API version 3.33 and later)
915 cinder backup-reset-state
917 usage: cinder backup-reset-state [--state <state>] <backup> [<backup> ...]
918 Explicitly updates the backup state.
920 Positional arguments:
922 <backup>
924 Name or ID of the backup to modify.
925 Optional arguments:
927 --state <state>
929 The state to assign to the backup. Valid values are "available",
930 "error". Default=available.
931 cinder backup-restore
933 usage: cinder backup-restore [--volume <volume>] [--name <name>] <backup>
934 Restores a backup.
936 Positional arguments:
938 <backup>
940 Name or ID of backup to restore.
941 Optional arguments:
943 --volume <volume>
945 Name or ID of existing volume to which to restore. This is mutu‐
946 ally exclusive with --name and takes priority. Default=None.
947 --name <name>
949 Use the name for new volume creation to restore. This is mutu‐
950 ally exclusive with --volume (or the deprecated --volume-id) and
951 --volume (or --volume-id) takes priority. Default=None.
952 cinder backup-show
954 usage: cinder backup-show <backup>
955 Shows backup details.
957 Positional arguments:
959 <backup>
961 Name or ID of backup.
962 cinder backup-update
964 usage: cinder backup-update [--name [<name>]] [--description <description>]
965 <backup>
966 Renames a backup.
968 Positional arguments:
970 <backup>
972 Name or ID of backup to rename.
973 Optional arguments:
975 --name [<name>]
977 New name for backup.
978 --description <description>
980 Backup description. Default=None.
981 cinder cgsnapshot-create
983 usage: cinder cgsnapshot-create [--name <name>] [--description <description>]
984 <consistencygroup>
985 Creates a cgsnapshot.
987 Positional arguments:
989 <consistencygroup>
991 Name or ID of a consistency group.
992 Optional arguments:
994 --name <name>
996 Cgsnapshot name. Default=None.
997 --description <description>
999 Cgsnapshot description. Default=None.
1000 cinder cgsnapshot-delete
1002 usage: cinder cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]
1003 Removes one or more cgsnapshots.
1005 Positional arguments:
1007 <cgsnapshot>
1009 Name or ID of one or more cgsnapshots to be deleted.
1010 cinder cgsnapshot-list
1012 usage: cinder cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>]
1013 [--consistencygroup-id <consistencygroup_id>]
1014 Lists all cgsnapshots.
1016 Optional arguments:
1018 --all-tenants [<0|1>]
1020 Shows details for all tenants. Admin only.
1021 --status <status>
1023 Filters results by a status. Default=None.
1024 --consistencygroup-id <consistencygroup_id>
1026 Filters results by a consistency group ID. Default=None.
1027 cinder cgsnapshot-show
1029 usage: cinder cgsnapshot-show <cgsnapshot>
1030 Shows cgsnapshot details.
1032 Positional arguments:
1034 <cgsnapshot>
1036 Name or ID of cgsnapshot.
1037 cinder cluster-disable
1039 usage: cinder cluster-disable [--reason <reason>] [<binary>] <cluster-name>
1040 Disables clustered services.
1042 Positional arguments:
1044 <binary>
1046 Binary to filter by. Default: cinder-volume.
1047 <cluster-name>
1049 Name of the clustered services to update.
1050 Optional arguments:
1052 --reason <reason>
1054 Reason for disabling clustered service.
1055 cinder cluster-enable
1057 usage: cinder cluster-enable [<binary>] <cluster-name>
1058 Enables clustered services.
1060 Positional arguments:
1062 <binary>
1064 Binary to filter by. Default: cinder-volume.
1065 <cluster-name>
1067 Name of the clustered services to update.
1068 cinder cluster-list
1070 usage: cinder cluster-list [--name <name>] [--binary <binary>]
1071 [--is-up <True|true|False|false>]
1072 [--disabled <True|true|False|false>]
1073 [--num-hosts <num-hosts>]
1074 [--num-down-hosts <num-down-hosts>] [--detailed]
1075 Lists clustered services with optional filtering.
1077 Optional arguments:
1079 --name <name>
1081 Filter by cluster name, without backend will list all clustered
1082 services from the same cluster. Default=None.
1083 --binary <binary>
1085 Cluster binary. Default=None.
1086 --is-up <True|true|False|false>
1088 Filter by up/dow status. Default=None.
1089 --disabled <True|true|False|false>
1091 Filter by disabled status. Default=None.
1092 --num-hosts <num-hosts>
1094 Filter by number of hosts in the cluster.
1095 --num-down-hosts <num-down-hosts>
1097 Filter by number of hosts that are down.
1098 --detailed
1100 Get detailed clustered service information (Default=False).
1101 cinder cluster-show
1103 usage: cinder cluster-show [<binary>] <cluster-name>
1104 Show detailed information on a clustered service.
1106 Positional arguments:
1108 <binary>
1110 Binary to filter by. Default: cinder-volume.
1111 <cluster-name>
1113 Name of the clustered service to show.
1114 cinder consisgroup-create
1116 usage: cinder consisgroup-create [--name <name>] [--description <description>]
1117 [--availability-zone <availability-zone>]
1118 <volume-types>
1119 Creates a consistency group.
1121 Positional arguments:
1123 <volume-types>
1125 Volume types.
1126 Optional arguments:
1128 --name <name>
1130 Name of a consistency group.
1131 --description <description>
1133 Description of a consistency group. Default=None.
1134 --availability-zone <availability-zone>
1136 Availability zone for volume. Default=None.
1137 cinder consisgroup-create-from-src
1139 usage: cinder consisgroup-create-from-src [--cgsnapshot <cgsnapshot>]
1140 [--source-cg <source-cg>]
1141 [--name <name>]
1142 [--description <description>]
1143 Creates a consistency group from a cgsnapshot or a source CG.
1145 Optional arguments:
1147 --cgsnapshot <cgsnapshot>
1149 Name or ID of a cgsnapshot. Default=None.
1150 --source-cg <source-cg>
1152 Name or ID of a source CG. Default=None.
1153 --name <name>
1155 Name of a consistency group. Default=None.
1156 --description <description>
1158 Description of a consistency group. Default=None.
1159 cinder consisgroup-delete
1161 usage: cinder consisgroup-delete [--force]
1162 <consistencygroup> [<consistencygroup> ...]
1163 Removes one or more consistency groups.
1165 Positional arguments:
1167 <consistencygroup>
1169 Name or ID of one or more consistency groups to be deleted.
1170 Optional arguments:
1172 --force
1174 Allows or disallows consistency groups to be deleted. If the
1175 consistency group is empty, it can be deleted without the force
1176 flag. If the consistency group is not empty, the force flag is
1177 required for it to be deleted.
1178 cinder consisgroup-list
1180 usage: cinder consisgroup-list [--all-tenants [<0|1>]]
1181 Lists all consistency groups.
1183 Optional arguments:
1185 --all-tenants [<0|1>]
1187 Shows details for all tenants. Admin only.
1188 cinder consisgroup-show
1190 usage: cinder consisgroup-show <consistencygroup>
1191 Shows details of a consistency group.
1193 Positional arguments:
1195 <consistencygroup>
1197 Name or ID of a consistency group.
1198 cinder consisgroup-update
1200 usage: cinder consisgroup-update [--name <name>] [--description <description>]
1201 [--add-volumes <uuid1,uuid2,......>]
1202 [--remove-volumes <uuid3,uuid4,......>]
1203 <consistencygroup>
1204 Updates a consistency group.
1206 Positional arguments:
1208 <consistencygroup>
1210 Name or ID of a consistency group.
1211 Optional arguments:
1213 --name <name>
1215 New name for consistency group. Default=None.
1216 --description <description>
1218 New description for consistency group. Default=None.
1219 --add-volumes <uuid1,uuid2,......>
1221 UUID of one or more volumes to be added to the consistency
1222 group, separated by commas. Default=None.
1223 --remove-volumes <uuid3,uuid4,......>
1225 UUID of one or more volumes to be removed from the consistency
1226 group, separated by commas. Default=None.
1227 cinder create
1229 usage: cinder create [--consisgroup-id <consistencygroup-id>]
1230 [--group-id <group-id>] [--snapshot-id <snapshot-id>]
1231 [--source-volid <source-volid>]
1232 [--source-replica <source-replica>]
1233 [--image-id <image-id>] [--image <image>] [--name <name>]
1234 [--description <description>]
1235 [--volume-type <volume-type>]
1236 [--availability-zone <availability-zone>]
1237 [--metadata [<key=value> [<key=value> ...]]]
1238 [--hint <key=value>] [--allow-multiattach]
1239 [<size>]
1240 Creates a volume.
1242 Positional arguments:
1244 <size> Size of volume, in GiBs. (Required unless snapshot-id
1246 /source-volid is specified).
1247 Optional arguments:
1249 --consisgroup-id <consistencygroup-id>
1251 ID of a consistency group where the new volume belongs to.
1252 Default=None.
1253 --group-id <group-id>
1255 ID of a group where the new volume belongs to. Default=None.
1256 (Supported by API version 3.13 and later)
1257 --snapshot-id <snapshot-id>
1259 Creates volume from snapshot ID. Default=None.
1260 --source-volid <source-volid>
1262 Creates volume from volume ID. Default=None.
1263 --source-replica <source-replica>
1265 Creates volume from replicated volume ID. Default=None.
1266 --image-id <image-id>
1268 Creates volume from image ID. Default=None.
1269 --image <image>
1271 Creates a volume from image (ID or name). Default=None.
1272 --name <name>
1274 Volume name. Default=None.
1275 --description <description>
1277 Volume description. Default=None.
1278 --volume-type <volume-type>
1280 Volume type. Default=None.
1281 --availability-zone <availability-zone>
1283 Availability zone for volume. Default=None.
1284 --metadata [<key=value> [<key=value> ...]]
1286 Metadata key and value pairs. Default=None.
1287 --hint <key=value>
1289 Scheduler hint, like in nova.
1290 --allow-multiattach
1292 Allow volume to be attached more than once. Default=False
1293 cinder credentials
1295 usage: cinder credentials
1296 Shows user credentials returned from auth.
1298 cinder delete
1300 usage: cinder delete [--cascade] <volume> [<volume> ...]
1301 Removes one or more volumes.
1303 Positional arguments:
1305 <volume>
1307 Name or ID of volume or volumes to delete.
1308 Optional arguments:
1310 --cascade
1312 Remove any snapshots along with volume. Default=False.
1313 cinder encryption-type-create
1315 usage: cinder encryption-type-create [--cipher <cipher>]
1316 [--key-size <key_size>]
1317 [--control-location <control_location>]
1318 <volume_type> <provider>
1319 Creates encryption type for a volume type. Admin only.
1321 Positional arguments:
1323 <volume_type>
1325 Name or ID of volume type.
1326 <provider>
1328 The class that provides encryption support. For example, LuksEn‐
1329 cryptor.
1330 Optional arguments:
1332 --cipher <cipher>
1334 The encryption algorithm or mode. For example, aes-xts-plain64.
1335 Default=None.
1336 --key-size <key_size>
1338 Size of encryption key, in bits. For example, 128 or 256.
1339 Default=None.
1340 --control-location <control_location>
1342 Notional service where encryption is performed. Valid values are
1343 "front-end" or "back-end." For example, front-end=Nova. Default
1344 is "front-end."
1345 cinder encryption-type-delete
1347 usage: cinder encryption-type-delete <volume_type>
1348 Deletes encryption type for a volume type. Admin only.
1350 Positional arguments:
1352 <volume_type>
1354 Name or ID of volume type.
1355 cinder encryption-type-list
1357 usage: cinder encryption-type-list
1358 Shows encryption type details for volume types. Admin only.
1360 cinder encryption-type-show
1362 usage: cinder encryption-type-show <volume_type>
1363 Shows encryption type details for a volume type. Admin only.
1365 Positional arguments:
1367 <volume_type>
1369 Name or ID of volume type.
1370 cinder encryption-type-update
1372 usage: cinder encryption-type-update [--provider <provider>]
1373 [--cipher [<cipher>]]
1374 [--key-size [<key-size>]]
1375 [--control-location <control-location>]
1376 <volume-type>
1377 Update encryption type information for a volume type (Admin Only).
1379 Positional arguments:
1381 <volume-type>
1383 Name or ID of the volume type
1384 Optional arguments:
1386 --provider <provider>
1388 Class providing encryption support (e.g. LuksEncryptor)
1389 --cipher [<cipher>]
1391 Encryption algorithm/mode to use (e.g., aes-xts-plain64). Pro‐
1392 vide parameter without value to set to provider default.
1393 --key-size [<key-size>]
1395 Size of the encryption key, in bits (e.g., 128, 256). Provide
1396 parameter without value to set to provider default.
1397 --control-location <control-location>
1399 Notional service where encryption is performed (e.g.,
1400 front-end=Nova). Values: 'front-end', 'back-end'
1401 cinder endpoints
1403 usage: cinder endpoints
1404 Discovers endpoints registered by authentication service.
1406 cinder extend
1408 usage: cinder extend <volume> <new_size>
1409 Attempts to extend size of an existing volume.
1411 Positional arguments:
1413 <volume>
1415 Name or ID of volume to extend.
1416 <new_size>
1418 New size of volume, in GiBs.
1419 cinder extra-specs-list
1421 usage: cinder extra-specs-list
1422 Lists current volume types and extra specs.
1424 cinder failover-host
1426 usage: cinder failover-host [--backend_id <backend-id>] <hostname>
1427 Failover a replicating cinder-volume host.
1429 Positional arguments:
1431 <hostname>
1433 Host name.
1434 Optional arguments:
1436 --backend_id <backend-id>
1438 ID of backend to failover to (Default=None)
1439 cinder force-delete
1441 usage: cinder force-delete <volume> [<volume> ...]
1442 Attempts force-delete of volume, regardless of state.
1444 Positional arguments:
1446 <volume>
1448 Name or ID of volume or volumes to delete.
1449 cinder freeze-host
1451 usage: cinder freeze-host <hostname>
1452 Freeze and disable the specified cinder-volume host.
1454 Positional arguments:
1456 <hostname>
1458 Host name.
1459 cinder get-capabilities
1461 usage: cinder get-capabilities <host>
1462 Show backend volume stats and properties. Admin only.
1464 Positional arguments:
1466 <host> Cinder host to show backend volume stats and properties; takes
1468 the form: host@backend-name
1469 cinder get-pools
1471 usage: cinder get-pools [--detail] [--filters [<key=value> [<key=value> ...]]]
1472 Show pool information for backends. Admin only.
1474 Optional arguments:
1476 --detail
1478 Show detailed information about pools.
1479 --filters [<key=value> [<key=value> ...]]
1481 Filter key and value pairs. Please use 'cinder list-filters' to
1482 check enabled filters from server, Default=None. (Supported by
1483 API version 3.33 and later)
1484 cinder group-create
1486 usage: cinder group-create [--name <name>] [--description <description>]
1487 [--availability-zone <availability-zone>]
1488 <group-type> <volume-types>
1489 Creates a group.
1491 Positional arguments:
1493 <group-type>
1495 Group type.
1496 <volume-types>
1498 Comma-separated list of volume types.
1499 Optional arguments:
1501 --name <name>
1503 Name of a group.
1504 --description <description>
1506 Description of a group. Default=None.
1507 --availability-zone <availability-zone>
1509 Availability zone for group. Default=None.
1510 cinder group-create-from-src
1512 usage: cinder group-create-from-src [--group-snapshot <group-snapshot>]
1513 [--source-group <source-group>]
1514 [--name <name>]
1515 [--description <description>]
1516 Creates a group from a group snapshot or a source group.
1518 Optional arguments:
1520 --group-snapshot <group-snapshot>
1522 Name or ID of a group snapshot. Default=None.
1523 --source-group <source-group>
1525 Name or ID of a source group. Default=None.
1526 --name <name>
1528 Name of a group. Default=None.
1529 --description <description>
1531 Description of a group. Default=None.
1532 cinder group-delete
1534 usage: cinder group-delete [--delete-volumes] <group> [<group> ...]
1535 Removes one or more groups.
1537 Positional arguments:
1539 <group>
1541 Name or ID of one or more groups to be deleted.
1542 Optional arguments:
1544 --delete-volumes
1546 Allows or disallows groups to be deleted if they are not empty.
1547 If the group is empty, it can be deleted without the delete-vol‐
1548 umes flag. If the group is not empty, the delete-volumes flag is
1549 required for it to be deleted. If True, all volumes in the group
1550 will also be deleted.
1551 cinder group-list
1553 usage: cinder group-list [--all-tenants [<0|1>]]
1554 [--filters [<key=value> [<key=value> ...]]]
1555 Lists all groups.
1557 Optional arguments:
1559 --all-tenants [<0|1>]
1561 Shows details for all tenants. Admin only.
1562 --filters [<key=value> [<key=value> ...]]
1564 Filter key and value pairs. Please use 'cinder list-filters' to
1565 check enabled filters from server, Default=None. (Supported by
1566 API version 3.33 and later)
1567 cinder group-show
1569 usage: cinder group-show <group>
1570 Shows details of a group.
1572 Positional arguments:
1574 <group>
1576 Name or ID of a group.
1577 cinder group-snapshot-create
1579 usage: cinder group-snapshot-create [--name <name>]
1580 [--description <description>]
1581 <group>
1582 Creates a group snapshot.
1584 Positional arguments:
1586 <group>
1588 Name or ID of a group.
1589 Optional arguments:
1591 --name <name>
1593 Group snapshot name. Default=None.
1594 --description <description>
1596 Group snapshot description. Default=None.
1597 cinder group-snapshot-delete
1599 usage: cinder group-snapshot-delete <group_snapshot> [<group_snapshot> ...]
1600 Removes one or more group snapshots.
1602 Positional arguments:
1604 <group_snapshot>
1606 Name or ID of one or more group snapshots to be deleted.
1607 cinder group-snapshot-list
1609 usage: cinder group-snapshot-list [--all-tenants [<0|1>]] [--status <status>]
1610 [--group-id <group_id>]
1611 [--filters [<key=value> [<key=value> ...]]]
1612 Lists all group snapshots.
1614 Optional arguments:
1616 --all-tenants [<0|1>]
1618 Shows details for all tenants. Admin only.
1619 --status <status>
1621 Filters results by a status. Default=None. This option is depre‐
1622 cated and will be removed in newer release. Please use '--fil‐
1623 ters' option which is introduced since 3.33 instead.
1624 --group-id <group_id>
1626 Filters results by a group ID. Default=None. This option is dep‐
1627 recated and will be removed in newer release. Please use '--fil‐
1628 ters' option which is introduced since 3.33 instead.
1629 --filters [<key=value> [<key=value> ...]]
1631 Filter key and value pairs. Please use 'cinder list-filters' to
1632 check enabled filters from server, Default=None. (Supported by
1633 API version 3.33 and later)
1634 cinder group-snapshot-show
1636 usage: cinder group-snapshot-show <group_snapshot>
1637 Shows group snapshot details.
1639 Positional arguments:
1641 <group_snapshot>
1643 Name or ID of group snapshot.
1644 cinder group-specs-list
1646 usage: cinder group-specs-list
1647 Lists current group types and specs.
1649 cinder group-type-create
1651 usage: cinder group-type-create [--description <description>]
1652 [--is-public <is-public>]
1653 <name>
1654 Creates a group type.
1656 Positional arguments:
1658 <name> Name of new group type.
1660 Optional arguments:
1662 --description <description>
1664 Description of new group type.
1665 --is-public <is-public>
1667 Make type accessible to the public (default true).
1668 cinder group-type-default
1670 usage: cinder group-type-default
1671 List the default group type.
1673 cinder group-type-delete
1675 usage: cinder group-type-delete <group_type> [<group_type> ...]
1676 Deletes group type or types.
1678 Positional arguments:
1680 <group_type>
1682 Name or ID of group type or types to delete.
1683 cinder group-type-key
1685 usage: cinder group-type-key <gtype> <action> <key=value> [<key=value> ...]
1686 Sets or unsets group_spec for a group type.
1688 Positional arguments:
1690 <gtype>
1692 Name or ID of group type.
1693 <action>
1695 The action. Valid values are "set" or "unset."
1696 <key=value>
1698 The group specs key and value pair to set or unset. For unset,
1699 specify only the key.
1700 cinder group-type-list
1702 usage: cinder group-type-list
1703 Lists available 'group types'. (Admin only will see private types)
1705 cinder group-type-show
1707 usage: cinder group-type-show <group_type>
1708 Show group type details.
1710 Positional arguments:
1712 <group_type>
1714 Name or ID of the group type.
1715 cinder group-type-update
1717 usage: cinder group-type-update [--name <name>] [--description <description>]
1718 [--is-public <is-public>]
1719 <id>
1720 Updates group type name, description, and/or is_public.
1722 Positional arguments:
1724 <id> ID of the group type.
1726 Optional arguments:
1728 --name <name>
1730 Name of the group type.
1731 --description <description>
1733 Description of the group type.
1734 --is-public <is-public>
1736 Make type accessible to the public or not.
1737 cinder group-update
1739 usage: cinder group-update [--name <name>] [--description <description>]
1740 [--add-volumes <uuid1,uuid2,......>]
1741 [--remove-volumes <uuid3,uuid4,......>]
1742 <group>
1743 Updates a group.
1745 Positional arguments:
1747 <group>
1749 Name or ID of a group.
1750 Optional arguments:
1752 --name <name>
1754 New name for group. Default=None.
1755 --description <description>
1757 New description for group. Default=None.
1758 --add-volumes <uuid1,uuid2,......>
1760 UUID of one or more volumes to be added to the group, separated
1761 by commas. Default=None.
1762 --remove-volumes <uuid3,uuid4,......>
1764 UUID of one or more volumes to be removed from the group, sepa‐
1765 rated by commas. Default=None.
1766 cinder image-metadata
1768 usage: cinder image-metadata <volume> <action> <key=value> [<key=value> ...]
1769 Sets or deletes volume image metadata.
1771 Positional arguments:
1773 <volume>
1775 Name or ID of volume for which to update metadata.
1776 <action>
1778 The action. Valid values are 'set' or 'unset.'
1779 <key=value>
1781 Metadata key and value pair to set or unset. For unset, specify
1782 only the key.
1783 cinder image-metadata-show
1785 usage: cinder image-metadata-show <volume>
1786 Shows volume image metadata.
1788 Positional arguments:
1790 <volume>
1792 ID of volume.
1793 cinder list
1795 usage: cinder list [--group_id <group_id>] [--all-tenants [<0|1>]]
1796 [--name <name>] [--status <status>]
1797 [--bootable [<True|true|False|false>]]
1798 [--migration_status <migration_status>]
1799 [--metadata [<key=value> [<key=value> ...]]]
1800 [--image_metadata [<key=value> [<key=value> ...]]]
1801 [--marker <marker>] [--limit <limit>] [--fields <fields>]
1802 [--sort <key>[:<direction>]] [--tenant [<tenant>]]
1803 [--filters [<key=value> [<key=value> ...]]]
1804 Lists all volumes.
1806 Optional arguments:
1808 --group_id <group_id>
1810 Filters results by a group_id. Default=None.This option is dep‐
1811 recated and will be removed in newer release. Please use '--fil‐
1812 ters' option which is introduced since 3.33 instead. (Supported
1813 by API version 3.10 and later)
1814 --all-tenants [<0|1>]
1816 Shows details for all tenants. Admin only.
1817 --name <name>
1819 Filters results by a name. Default=None. This option is depre‐
1820 cated and will be removed in newer release. Please use '--fil‐
1821 ters' option which is introduced since 3.33 instead.
1822 --status <status>
1824 Filters results by a status. Default=None. This option is depre‐
1825 cated and will be removed in newer release. Please use '--fil‐
1826 ters' option which is introduced since 3.33 instead.
1827 --bootable [<True|true|False|false>]
1829 Filters results by bootable status. Default=None. This option is
1830 deprecated and will be removed in newer release. Please use
1831 '--filters' option which is introduced since 3.33 instead.
1832 --migration_status <migration_status>
1834 Filters results by a migration status. Default=None. Admin
1835 only. This option is deprecated and will be removed in newer
1836 release. Please use '--filters' option which is introduced since
1837 3.33 instead.
1838 --metadata [<key=value> [<key=value> ...]]
1840 Filters results by a metadata key and value pair. Default=None.
1841 This option is deprecated and will be removed in newer release.
1842 Please use '--filters' option which is introduced since 3.33
1843 instead.
1844 --image_metadata [<key=value> [<key=value> ...]]
1846 Filters results by a image metadata key and value pair. Require
1847 volume api version >=3.4. Default=None.This option is depre‐
1848 cated and will be removed in newer release. Please use '--fil‐
1849 ters' option which is introduced since 3.33 instead. (Supported
1850 by API version 3.4 and later)
1851 --marker <marker>
1853 Begin returning volumes that appear later in the volume list
1854 than that represented by this volume id. Default=None.
1855 --limit <limit>
1857 Maximum number of volumes to return. Default=None.
1858 --fields <fields>
1860 Comma-separated list of fields to display. Use the show command
1861 to see which fields are available. Unavailable/non-existent
1862 fields will be ignored. Default=None.
1863 --sort <key>[:<direction>]
1865 Comma-separated list of sort keys and directions in the form of
1866 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
1867 ity_zone, name, bootable, created_at, reference. Default=None.
1868 --tenant [<tenant>]
1870 Display information from single tenant (Admin only).
1871 --filters [<key=value> [<key=value> ...]]
1873 Filter key and value pairs. Please use the cinder list-filters
1874 command to check enabled filters from server. Default=None.
1875 (Supported by API version 3.33 and later)
1876 Time Comparison Filters
1878 Beginning with API version 3.60, you can apply time comparison
1880 filtering to the created_at and updated at fields. Time must be
1881 expressed in ISO 8601 format: CCYY-MM-DDThh:mm:ss±hh:mm. The
1882 ±hh:mm value, if included, returns the time zone as an offset
1883 from UTC.
1884 To use time comparison filtering, use the standard key=value
1886 syntax for the --filters option. The allowable keys are:
1887 · created_at
1889 · updated_at
1891 The value is a time comparison statement, which is specified as
1893 follows: a comparison operator, followed immediately by a colon
1894 (:), followed immediately by a time expressed in ISO 8601 for‐
1895 mat. You can filter by a time range by appending a comma (,)
1896 followed a second time comparison statement.
1897 Six comparison operators are supported:
1899 · gt (greater than) - return results more recent than the speci‐
1901 fied time
1902 · gte (greater than or equal) - return any results matching the
1904 specified time and also any more recent results
1905 · eq (equal) - return any results matching the specified time
1907 exactly
1908 · neq (not equal) - return any results that do not match the
1910 specified time
1911 · lt (less than) - return results older than the specified time
1913 · lte (less than or equal) - return any results matching the
1915 specified time and also any older results
1916 Examples
1918 To filter the response to volumes created before 15 January
1920 2020:
1921 cinder list --filters created_at=lt:2020-01-15T00:00:00
1923 To filter the response to those volumes updated in February
1925 2020:
1926 cinder list --filters updated_at=gte:2020-02-01T00:00:00,lt:2020-03-01T00:00:00
1928 See the Block Storage API v3 Reference for more information.
1930 cinder list-extensions
1932 usage: cinder list-extensions
1933 cinder list-filters
1935 usage: cinder list-filters [--resource <resource>]
1936 Optional arguments:
1938 --resource <resource>
1940 Show enabled filters for specified resource. Default=None.
1941 cinder manage
1943 usage: cinder manage [--id-type <id-type>] [--name <name>]
1944 [--description <description>]
1945 [--volume-type <volume-type>]
1946 [--availability-zone <availability-zone>]
1947 [--metadata [<key=value> [<key=value> ...]]] [--bootable]
1948 <host> <identifier>
1949 Manage an existing volume.
1951 Positional arguments:
1953 <host> Cinder host on which the existing volume resides; takes the
1955 form: host@backend-name#pool
1956 <identifier>
1958 Name or other Identifier for existing volume
1959 Optional arguments:
1961 --id-type <id-type>
1963 Type of backend device identifier provided, typically
1964 source-name or source-id (Default=source-name)
1965 --name <name>
1967 Volume name (Default=None)
1968 --description <description>
1970 Volume description (Default=None)
1971 --volume-type <volume-type>
1973 Volume type (Default=None)
1974 --availability-zone <availability-zone>
1976 Availability zone for volume (Default=None)
1977 --metadata [<key=value> [<key=value> ...]]
1979 Metadata key=value pairs (Default=None)
1980 --bootable
1982 Specifies that the newly created volume should be marked as
1983 bootable
1984 cinder manageable-list
1986 usage: cinder manageable-list [--detailed <detailed>] [--marker <marker>]
1987 [--limit <limit>] [--offset <offset>]
1988 [--sort <key>[:<direction>]]
1989 <host>
1990 Lists all manageable volumes.
1992 Positional arguments:
1994 <host> Cinder host on which to list manageable volumes; takes the form:
1996 host@backend-name#pool
1997 Optional arguments:
1999 --detailed <detailed>
2001 Returned detailed information (default true).
2002 --marker <marker>
2004 Begin returning volumes that appear later in the volume list
2005 than that represented by this reference. This reference should
2006 be json like. Default=None.
2007 --limit <limit>
2009 Maximum number of volumes to return. Default=None.
2010 --offset <offset>
2012 Number of volumes to skip after marker. Default=None.
2013 --sort <key>[:<direction>]
2015 Comma-separated list of sort keys and directions in the form of
2016 <key>[:<asc|desc>]. Valid keys: size, reference. Default=None.
2017 cinder message-delete
2019 usage: cinder message-delete <message> [<message> ...]
2020 Removes one or more messages.
2022 Positional arguments:
2024 <message>
2026 ID of one or more message to be deleted.
2027 cinder message-list
2029 usage: cinder message-list [--marker <marker>] [--limit <limit>]
2030 [--sort <key>[:<direction>]]
2031 [--resource_uuid <resource_uuid>]
2032 [--resource_type <type>] [--event_id <id>]
2033 [--request_id <request_id>] [--level <level>]
2034 [--filters [<key=value> [<key=value> ...]]]
2035 Lists all messages.
2037 Optional arguments:
2039 --marker <marker>
2041 Begin returning message that appear later in the message list
2042 than that represented by this id. Default=None. (Supported by
2043 API version 3.5 and later)
2044 --limit <limit>
2046 Maximum number of messages to return. Default=None. (Supported
2047 by API version 3.5 and later)
2048 --sort <key>[:<direction>]
2050 Comma-separated list of sort keys and directions in the form of
2051 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
2052 ity_zone, name, bootable, created_at, reference. Default=None.
2053 (Supported by API version 3.5 and later)
2054 --resource_uuid <resource_uuid>
2056 Filters results by a resource uuid. Default=None. This option is
2057 deprecated and will be removed in newer release. Please use
2058 '--filters' option which is introduced since 3.33 instead.
2059 --resource_type <type>
2061 Filters results by a resource type. Default=None. This option is
2062 deprecated and will be removed in newer release. Please use
2063 '--filters' option which is introduced since 3.33 instead.
2064 --event_id <id>
2066 Filters results by event id. Default=None. This option is depre‐
2067 cated and will be removed in newer release. Please use '--fil‐
2068 ters' option which is introduced since 3.33 instead.
2069 --request_id <request_id>
2071 Filters results by request id. Default=None. This option is dep‐
2072 recated and will be removed in newer release. Please use '--fil‐
2073 ters' option which is introduced since 3.33 instead.
2074 --level <level>
2076 Filters results by the message level. Default=None. This option
2077 is deprecated and will be removed in newer release. Please use
2078 '--filters' option which is introduced since 3.33 instead.
2079 --filters [<key=value> [<key=value> ...]]
2081 Filter key and value pairs. Please use 'cinder list-filters' to
2082 check enabled filters from server, Default=None. (Supported by
2083 API version 3.33 and later)
2084 cinder message-show
2086 usage: cinder message-show <message>
2087 Shows message details.
2089 Positional arguments:
2091 <message>
2093 ID of message.
2094 cinder metadata
2096 usage: cinder metadata <volume> <action> <key=value> [<key=value> ...]
2097 Sets or deletes volume metadata.
2099 Positional arguments:
2101 <volume>
2103 Name or ID of volume for which to update metadata.
2104 <action>
2106 The action. Valid values are "set" or "unset."
2107 <key=value>
2109 Metadata key and value pair to set or unset. For unset, specify
2110 only the key(s): <key key> (Supported by API version 3.15 and
2111 later)
2112 cinder metadata-show
2114 usage: cinder metadata-show <volume>
2115 Shows volume metadata.
2117 Positional arguments:
2119 <volume>
2121 ID of volume.
2122 cinder metadata-update-all
2124 usage: cinder metadata-update-all <volume> <key=value> [<key=value> ...]
2125 Updates volume metadata.
2127 Positional arguments:
2129 <volume>
2131 ID of volume for which to update metadata.
2132 <key=value>
2134 Metadata key and value pair or pairs to update.
2135 cinder migrate
2137 usage: cinder migrate [--force-host-copy [<True|False>]]
2138 [--lock-volume [<True|False>]]
2139 <volume> <host>
2140 Migrates volume to a new host.
2142 Positional arguments:
2144 <volume>
2146 ID of volume to migrate.
2147 <host> Destination host. Takes the form: host@backend-name#pool
2149 Optional arguments:
2151 --force-host-copy [<True|False>]
2153 Enables or disables generic host-based force-migration, which
2154 bypasses driver optimizations. Default=False.
2155 --lock-volume [<True|False>]
2157 Enables or disables the termination of volume migration caused
2158 by other commands. This option applies to the available volume.
2159 True means it locks the volume state and does not allow the
2160 migration to be aborted. The volume status will be in mainte‐
2161 nance during the migration. False means it allows the volume
2162 migration to be aborted. The volume status is still in the orig‐
2163 inal status. Default=False.
2164 cinder qos-associate
2166 usage: cinder qos-associate <qos_specs> <volume_type_id>
2167 Associates qos specs with specified volume type.
2169 Positional arguments:
2171 <qos_specs>
2173 ID of QoS specifications.
2174 <volume_type_id>
2176 ID of volume type with which to associate QoS specifications.
2177 cinder qos-create
2179 usage: cinder qos-create <name> <key=value> [<key=value> ...]
2180 Creates a qos specs.
2182 Positional arguments:
2184 <name> Name of new QoS specifications.
2186 <key=value>
2188 QoS specifications.
2189 cinder qos-delete
2191 usage: cinder qos-delete [--force [<True|False>]] <qos_specs>
2192 Deletes a specified qos specs.
2194 Positional arguments:
2196 <qos_specs>
2198 ID of QoS specifications to delete.
2199 Optional arguments:
2201 --force [<True|False>]
2203 Enables or disables deletion of in-use QoS specifications.
2204 Default=False.
2205 cinder qos-disassociate
2207 usage: cinder qos-disassociate <qos_specs> <volume_type_id>
2208 Disassociates qos specs from specified volume type.
2210 Positional arguments:
2212 <qos_specs>
2214 ID of QoS specifications.
2215 <volume_type_id>
2217 ID of volume type with which to associate QoS specifications.
2218 cinder qos-disassociate-all
2220 usage: cinder qos-disassociate-all <qos_specs>
2221 Disassociates qos specs from all its associations.
2223 Positional arguments:
2225 <qos_specs>
2227 ID of QoS specifications on which to operate.
2228 cinder qos-get-association
2230 usage: cinder qos-get-association <qos_specs>
2231 Lists all associations for specified qos specs.
2233 Positional arguments:
2235 <qos_specs>
2237 ID of QoS specifications.
2238 cinder qos-key
2240 usage: cinder qos-key <qos_specs> <action> key=value [key=value ...]
2241 Sets or unsets specifications for a qos spec.
2243 Positional arguments:
2245 <qos_specs>
2247 ID of QoS specifications.
2248 <action>
2250 The action. Valid values are "set" or "unset."
2251 key=value
2253 Metadata key and value pair to set or unset. For unset, specify
2254 only the key.
2255 cinder qos-list
2257 usage: cinder qos-list
2258 Lists qos specs.
2260 cinder qos-show
2262 usage: cinder qos-show <qos_specs>
2263 Shows qos specs details.
2265 Positional arguments:
2267 <qos_specs>
2269 ID of QoS specifications to show.
2270 cinder quota-class-show
2272 usage: cinder quota-class-show <class>
2273 Lists quotas for a quota class.
2275 Positional arguments:
2277 <class>
2279 Name of quota class for which to list quotas.
2280 cinder quota-class-update
2282 usage: cinder quota-class-update [--volumes <volumes>]
2283 [--snapshots <snapshots>]
2284 [--gigabytes <gigabytes>]
2285 [--volume-type <volume_type_name>]
2286 <class_name>
2287 Updates quotas for a quota class.
2289 Positional arguments:
2291 <class_name>
2293 Name of quota class for which to set quotas.
2294 Optional arguments:
2296 --volumes <volumes>
2298 The new "volumes" quota value. Default=None.
2299 --snapshots <snapshots>
2301 The new "snapshots" quota value. Default=None.
2302 --gigabytes <gigabytes>
2304 The new "gigabytes" quota value. Default=None.
2305 --volume-type <volume_type_name>
2307 Volume type. Default=None.
2308 cinder quota-defaults
2310 usage: cinder quota-defaults <tenant_id>
2311 Lists default quotas for a tenant.
2313 Positional arguments:
2315 <tenant_id>
2317 ID of tenant for which to list quota defaults.
2318 cinder quota-delete
2320 usage: cinder quota-delete <tenant_id>
2321 Delete the quotas for a tenant.
2323 Positional arguments:
2325 <tenant_id>
2327 UUID of tenant to delete the quotas for.
2328 cinder quota-show
2330 usage: cinder quota-show <tenant_id>
2331 Lists quotas for a tenant.
2333 Positional arguments:
2335 <tenant_id>
2337 ID of tenant for which to list quotas.
2338 cinder quota-update
2340 usage: cinder quota-update [--volumes <volumes>] [--snapshots <snapshots>]
2341 [--gigabytes <gigabytes>] [--backups <backups>]
2342 [--backup-gigabytes <backup_gigabytes>]
2343 [--consistencygroups <consistencygroups>]
2344 [--groups <groups>]
2345 [--volume-type <volume_type_name>]
2346 [--per-volume-gigabytes <per_volume_gigabytes>]
2347 <tenant_id>
2348 Updates quotas for a tenant.
2350 Positional arguments:
2352 <tenant_id>
2354 ID of tenant for which to set quotas.
2355 Optional arguments:
2357 --volumes <volumes>
2359 The new "volumes" quota value. Default=None.
2360 --snapshots <snapshots>
2362 The new "snapshots" quota value. Default=None.
2363 --gigabytes <gigabytes>
2365 The new "gigabytes" quota value. Default=None.
2366 --backups <backups>
2368 The new "backups" quota value. Default=None.
2369 --backup-gigabytes <backup_gigabytes>
2371 The new "backup_gigabytes" quota value. Default=None.
2372 --consistencygroups <consistencygroups>
2374 The new "consistencygroups" quota value. Default=None.
2375 --groups <groups>
2377 The new "groups" quota value. Default=None. (Supported by API
2378 version 3.13 and later)
2379 --volume-type <volume_type_name>
2381 Volume type. Default=None.
2382 --per-volume-gigabytes <per_volume_gigabytes>
2384 Set max volume size limit. Default=None.
2385 cinder quota-usage
2387 usage: cinder quota-usage <tenant_id>
2388 Lists quota usage for a tenant.
2390 Positional arguments:
2392 <tenant_id>
2394 ID of tenant for which to list quota usage.
2395 cinder rate-limits
2397 usage: cinder rate-limits [<tenant_id>]
2398 Lists rate limits for a user.
2400 Positional arguments:
2402 <tenant_id>
2404 Display information for a single tenant (Admin only).
2405 cinder readonly-mode-update
2407 usage: cinder readonly-mode-update <volume> <True|true|False|false>
2408 Updates volume read-only access-mode flag.
2410 Positional arguments:
2412 <volume>
2414 ID of volume to update.
2415 <True|true|False|false>
2417 Enables or disables update of volume to read-only access mode.
2418 cinder rename
2420 usage: cinder rename [--description <description>] <volume> [<name>]
2421 Renames a volume.
2423 Positional arguments:
2425 <volume>
2427 Name or ID of volume to rename.
2428 <name> New name for volume.
2430 Optional arguments:
2432 --description <description>
2434 Volume description. Default=None.
2435 cinder replication-promote
2437 usage: cinder replication-promote <volume>
2438 Promote a secondary volume to primary for a relationship.
2440 Positional arguments:
2442 <volume>
2444 Name or ID of the volume to promote. The volume should have the
2445 replica volume created with source-replica argument.
2446 cinder replication-reenable
2448 usage: cinder replication-reenable <volume>
2449 Sync the secondary volume with primary for a relationship.
2451 Positional arguments:
2453 <volume>
2455 Name or ID of the volume to reenable replication. The replica‐
2456 tion-status of the volume should be inactive.
2457 cinder reset-state
2459 usage: cinder reset-state [--type <type>] [--state <state>]
2460 [--attach-status <attach-status>]
2461 [--reset-migration-status]
2462 <entity> [<entity> ...]
2463 Explicitly updates the entity state in the Cinder database. Being a
2465 database change only, this has no impact on the true state of the
2466 entity and may not match the actual state. This can render a entity
2467 unusable in the case of changing to the 'available' state.
2468 Positional arguments:
2470 <entity>
2472 Name or ID of entity to update.
2473 Optional arguments:
2475 --type <type>
2477 Type of entity to update. Available resources are: 'volume',
2478 'snapshot', 'backup', 'group' (since 3.20) and 'group-snapshot'
2479 (since 3.19), Default=volume.
2480 --state <state>
2482 The state to assign to the entity. NOTE: This command simply
2483 changes the state of the entity in the database with no regard
2484 to actual status, exercise caution when using. Default=None,
2485 that means the state is unchanged.
2486 --attach-status <attach-status>
2488 This is only used for a volume entity. The attach status to
2489 assign to the volume in the database, with no regard to the
2490 actual status. Valid values are "attached" and "detached".
2491 Default=None, that means the status is unchanged.
2492 --reset-migration-status
2494 This is only used for a volume entity. Clears the migration sta‐
2495 tus of the volume in the DataBase that indicates the volume is
2496 source or destination of volume migration, with no regard to the
2497 actual status.
2498 cinder retype
2500 usage: cinder retype [--migration-policy <never|on-demand>]
2501 <volume> <volume-type>
2502 Changes the volume type for a volume.
2504 Positional arguments:
2506 <volume>
2508 Name or ID of volume for which to modify type.
2509 <volume-type>
2511 New volume type.
2512 Optional arguments:
2514 --migration-policy <never|on-demand>
2516 Migration policy during retype of volume.
2517 cinder service-disable
2519 usage: cinder service-disable [--reason <reason>] <hostname> <binary>
2520 Disables the service.
2522 Positional arguments:
2524 <hostname>
2526 Host name.
2527 <binary>
2529 Service binary.
2530 Optional arguments:
2532 --reason <reason>
2534 Reason for disabling service.
2535 cinder service-enable
2537 usage: cinder service-enable <hostname> <binary>
2538 Enables the service.
2540 Positional arguments:
2542 <hostname>
2544 Host name.
2545 <binary>
2547 Service binary.
2548 cinder service-list
2550 usage: cinder service-list [--host <hostname>] [--binary <binary>]
2551 [--withreplication [<True|False>]]
2552 Lists all services. Filter by host and service binary.
2554 Optional arguments:
2556 --host <hostname>
2558 Host name. Default=None.
2559 --binary <binary>
2561 Service binary. Default=None.
2562 --withreplication [<True|False>]
2564 Enables or disables display of Replication info for c-vol ser‐
2565 vices. Default=False. (Supported by API version 3.7 and later)
2566 cinder set-bootable
2568 usage: cinder set-bootable <volume> <True|true|False|false>
2569 Update bootable status of a volume.
2571 Positional arguments:
2573 <volume>
2575 ID of the volume to update.
2576 <True|true|False|false>
2578 Flag to indicate whether volume is bootable.
2579 cinder show
2581 usage: cinder show <volume>
2582 Shows volume details.
2584 Positional arguments:
2586 <volume>
2588 Name or ID of volume.
2589 cinder snapshot-create
2591 usage: cinder snapshot-create [--force [<True|False>]] [--name <name>]
2592 [--description <description>]
2593 [--metadata [<key=value> [<key=value> ...]]]
2594 <volume>
2595 Creates a snapshot.
2597 Positional arguments:
2599 <volume>
2601 Name or ID of volume to snapshot.
2602 Optional arguments:
2604 --force [<True|False>]
2606 Allows or disallows snapshot of a volume when the volume is
2607 attached to an instance. If set to True, ignores the current
2608 status of the volume when attempting to snapshot it rather than
2609 forcing it to be available. Default=False.
2610 --name <name>
2612 Snapshot name. Default=None.
2613 --description <description>
2615 Snapshot description. Default=None.
2616 --metadata [<key=value> [<key=value> ...]]
2618 Snapshot metadata key and value pairs. Default=None.
2619 cinder snapshot-delete
2621 usage: cinder snapshot-delete [--force] <snapshot> [<snapshot> ...]
2622 Removes one or more snapshots.
2624 Positional arguments:
2626 <snapshot>
2628 Name or ID of the snapshot(s) to delete.
2629 Optional arguments:
2631 --force
2633 Allows deleting snapshot of a volume when its status is other
2634 than "available" or "error". Default=False.
2635 cinder snapshot-list
2637 usage: cinder snapshot-list [--all-tenants [<0|1>]] [--name <name>]
2638 [--status <status>] [--volume-id <volume-id>]
2639 [--marker <marker>] [--limit <limit>]
2640 [--sort <key>[:<direction>]] [--tenant [<tenant>]]
2641 [--metadata [<key=value> [<key=value> ...]]]
2642 [--filters [<key=value> [<key=value> ...]]]
2643 Lists all snapshots.
2645 Optional arguments:
2647 --all-tenants [<0|1>]
2649 Shows details for all tenants. Admin only.
2650 --name <name>
2652 Filters results by a name. Default=None. This option is depre‐
2653 cated and will be removed in newer release. Please use '--fil‐
2654 ters' option which is introduced since 3.33 instead.
2655 --status <status>
2657 Filters results by a status. Default=None. This option is depre‐
2658 cated and will be removed in newer release. Please use '--fil‐
2659 ters' option which is introduced since 3.33 instead.
2660 --volume-id <volume-id>
2662 Filters results by a volume ID. Default=None. This option is
2663 deprecated and will be removed in newer release. Please use
2664 '--filters' option which is introduced since 3.33 instead.
2665 --marker <marker>
2667 Begin returning snapshots that appear later in the snapshot list
2668 than that represented by this id. Default=None.
2669 --limit <limit>
2671 Maximum number of snapshots to return. Default=None.
2672 --sort <key>[:<direction>]
2674 Comma-separated list of sort keys and directions in the form of
2675 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
2676 ity_zone, name, bootable, created_at, reference. Default=None.
2677 --tenant [<tenant>]
2679 Display information from single tenant (Admin only).
2680 --metadata [<key=value> [<key=value> ...]]
2682 Filters results by a metadata key and value pair. Require vol‐
2683 ume api version >=3.22. Default=None. This option is deprecated
2684 and will be removed in newer release. Please use '--filters'
2685 option which is introduced since 3.33 instead. (Supported by API
2686 version 3.22 and later)
2687 --filters [<key=value> [<key=value> ...]]
2689 Filter key and value pairs. Please use 'cinder list-filters' to
2690 check enabled filters from server, Default=None. (Supported by
2691 API version 3.33 and later)
2692 cinder snapshot-manage
2694 usage: cinder snapshot-manage [--id-type <id-type>] [--name <name>]
2695 [--description <description>]
2696 [--metadata [<key=value> [<key=value> ...]]]
2697 <volume> <identifier>
2698 Manage an existing snapshot.
2700 Positional arguments:
2702 <volume>
2704 Cinder volume already exists in volume backend
2705 <identifier>
2707 Name or other Identifier for existing snapshot
2708 Optional arguments:
2710 --id-type <id-type>
2712 Type of backend device identifier provided, typically
2713 source-name or source-id (Default=source-name)
2714 --name <name>
2716 Snapshot name (Default=None)
2717 --description <description>
2719 Snapshot description (Default=None)
2720 --metadata [<key=value> [<key=value> ...]]
2722 Metadata key=value pairs (Default=None)
2723 cinder snapshot-manageable-list
2725 usage: cinder snapshot-manageable-list [--detailed <detailed>]
2726 [--marker <marker>] [--limit <limit>]
2727 [--offset <offset>]
2728 [--sort <key>[:<direction>]]
2729 <host>
2730 Lists all manageable snapshots.
2732 Positional arguments:
2734 <host> Cinder host on which to list manageable snapshots; takes the
2736 form: host@backend-name#pool
2737 Optional arguments:
2739 --detailed <detailed>
2741 Returned detailed information (default true).
2742 --marker <marker>
2744 Begin returning volumes that appear later in the volume list
2745 than that represented by this reference. This reference should
2746 be json like. Default=None.
2747 --limit <limit>
2749 Maximum number of volumes to return. Default=None.
2750 --offset <offset>
2752 Number of volumes to skip after marker. Default=None.
2753 --sort <key>[:<direction>]
2755 Comma-separated list of sort keys and directions in the form of
2756 <key>[:<asc|desc>]. Valid keys: size, reference. Default=None.
2757 cinder snapshot-metadata
2759 usage: cinder snapshot-metadata <snapshot> <action> <key=value>
2760 [<key=value> ...]
2761 Sets or deletes snapshot metadata.
2763 Positional arguments:
2765 <snapshot>
2767 ID of snapshot for which to update metadata.
2768 <action>
2770 The action. Valid values are "set" or "unset."
2771 <key=value>
2773 Metadata key and value pair to set or unset. For unset, specify
2774 only the key.
2775 cinder snapshot-metadata-show
2777 usage: cinder snapshot-metadata-show <snapshot>
2778 Shows snapshot metadata.
2780 Positional arguments:
2782 <snapshot>
2784 ID of snapshot.
2785 cinder snapshot-metadata-update-all
2787 usage: cinder snapshot-metadata-update-all <snapshot> <key=value>
2788 [<key=value> ...]
2789 Updates snapshot metadata.
2791 Positional arguments:
2793 <snapshot>
2795 ID of snapshot for which to update metadata.
2796 <key=value>
2798 Metadata key and value pair to update.
2799 cinder snapshot-rename
2801 usage: cinder snapshot-rename [--description <description>]
2802 <snapshot> [<name>]
2803 Renames a snapshot.
2805 Positional arguments:
2807 <snapshot>
2809 Name or ID of snapshot.
2810 <name> New name for snapshot.
2812 Optional arguments:
2814 --description <description>
2816 Snapshot description. Default=None.
2817 cinder snapshot-reset-state
2819 usage: cinder snapshot-reset-state [--state <state>]
2820 <snapshot> [<snapshot> ...]
2821 Explicitly updates the snapshot state.
2823 Positional arguments:
2825 <snapshot>
2827 Name or ID of snapshot to modify.
2828 Optional arguments:
2830 --state <state>
2832 The state to assign to the snapshot. Valid values are "avail‐
2833 able", "error", "creating", "deleting", and "error_deleting".
2834 NOTE: This command simply changes the state of the Snapshot in
2835 the DataBase with no regard to actual status, exercise caution
2836 when using. Default=available.
2837 cinder snapshot-show
2839 usage: cinder snapshot-show <snapshot>
2840 Shows snapshot details.
2842 Positional arguments:
2844 <snapshot>
2846 Name or ID of snapshot.
2847 cinder snapshot-unmanage
2849 usage: cinder snapshot-unmanage <snapshot>
2850 Stop managing a snapshot.
2852 Positional arguments:
2854 <snapshot>
2856 Name or ID of the snapshot to unmanage.
2857 cinder thaw-host
2859 usage: cinder thaw-host <hostname>
2860 Thaw and enable the specified cinder-volume host.
2862 Positional arguments:
2864 <hostname>
2866 Host name.
2867 cinder transfer-accept
2869 usage: cinder transfer-accept <transfer> <auth_key>
2870 Accepts a volume transfer.
2872 Positional arguments:
2874 <transfer>
2876 ID of transfer to accept.
2877 <auth_key>
2879 Authentication key of transfer to accept.
2880 cinder transfer-create
2882 usage: cinder transfer-create [--name <name>] <volume>
2883 Creates a volume transfer.
2885 Positional arguments:
2887 <volume>
2889 Name or ID of volume to transfer.
2890 Optional arguments:
2892 --name <name>
2894 Transfer name. Default=None.
2895 cinder transfer-delete
2897 usage: cinder transfer-delete <transfer>
2898 Undoes a transfer.
2900 Positional arguments:
2902 <transfer>
2904 Name or ID of transfer to delete.
2905 cinder transfer-list
2907 usage: cinder transfer-list [--all-tenants [<0|1>]]
2908 Lists all transfers.
2910 Optional arguments:
2912 --all-tenants [<0|1>]
2914 Shows details for all tenants. Admin only.
2915 cinder transfer-show
2917 usage: cinder transfer-show <transfer>
2918 Shows transfer details.
2920 Positional arguments:
2922 <transfer>
2924 Name or ID of transfer to accept.
2925 cinder type-access-add
2927 usage: cinder type-access-add --volume-type <volume_type> --project-id
2928 <project_id>
2929 Adds volume type access for the given project.
2931 Optional arguments:
2933 --volume-type <volume_type>
2935 Volume type name or ID to add access for the given project.
2936 --project-id <project_id>
2938 Project ID to add volume type access for.
2939 cinder type-access-list
2941 usage: cinder type-access-list --volume-type <volume_type>
2942 Print access information about the given volume type.
2944 Optional arguments:
2946 --volume-type <volume_type>
2948 Filter results by volume type name or ID.
2949 cinder type-access-remove
2951 usage: cinder type-access-remove --volume-type <volume_type> --project-id
2952 <project_id>
2953 Removes volume type access for the given project.
2955 Optional arguments:
2957 --volume-type <volume_type>
2959 Volume type name or ID to remove access for the given project.
2960 --project-id <project_id>
2962 Project ID to remove volume type access for.
2963 cinder type-create
2965 usage: cinder type-create [--description <description>]
2966 [--is-public <is-public>]
2967 <name>
2968 Creates a volume type.
2970 Positional arguments:
2972 <name> Name of new volume type.
2974 Optional arguments:
2976 --description <description>
2978 Description of new volume type.
2979 --is-public <is-public>
2981 Make type accessible to the public (default true).
2982 cinder type-default
2984 usage: cinder type-default
2985 List the default volume type.
2987 cinder type-delete
2989 usage: cinder type-delete <vol_type> [<vol_type> ...]
2990 Deletes volume type or types.
2992 Positional arguments:
2994 <vol_type>
2996 Name or ID of volume type or types to delete.
2997 cinder type-key
2999 usage: cinder type-key <vtype> <action> <key=value> [<key=value> ...]
3000 Sets or unsets extra_spec for a volume type.
3002 Positional arguments:
3004 <vtype>
3006 Name or ID of volume type.
3007 <action>
3009 The action. Valid values are "set" or "unset."
3010 <key=value>
3012 The extra specs key and value pair to set or unset. For unset,
3013 specify only the key.
3014 cinder type-list
3016 usage: cinder type-list [--filters <key=value> [<key=value> ...]]
3017 Lists available 'volume types'. (Only admin and tenant users will see
3019 private types)
3020 Optional arguments:
3022 --filters [<key=value> [<key=value> ...]]
3024 Filter key and value pairs. Please use 'cinder list-filters' to
3025 check enabled filters from server, Default=None. (Supported by
3026 API version 3.52 and later)
3027 cinder type-show
3029 usage: cinder type-show <volume_type>
3030 Show volume type details.
3032 Positional arguments:
3034 <volume_type>
3036 Name or ID of the volume type.
3037 cinder type-update
3039 usage: cinder type-update [--name <name>] [--description <description>]
3040 [--is-public <is-public>]
3041 <id>
3042 Updates volume type name, description, and/or is_public.
3044 Positional arguments:
3046 <id> ID of the volume type.
3048 Optional arguments:
3050 --name <name>
3052 Name of the volume type.
3053 --description <description>
3055 Description of the volume type.
3056 --is-public <is-public>
3058 Make type accessible to the public or not.
3059 cinder unmanage
3061 usage: cinder unmanage <volume>
3062 Stop managing a volume.
3064 Positional arguments:
3066 <volume>
3068 Name or ID of the volume to unmanage.
3069 cinder upload-to-image
3071 usage: cinder upload-to-image [--force [<True|False>]]
3072 [--container-format <container-format>]
3073 [--disk-format <disk-format>]
3074 [--visibility <public|private>]
3075 [--protected <True|False>]
3076 <volume> <image-name>
3077 Uploads volume to Image Service as an image.
3079 Positional arguments:
3081 <volume>
3083 Name or ID of volume to snapshot.
3084 <image-name>
3086 The new image name.
3087 Optional arguments:
3089 --force [<True|False>]
3091 Enables or disables upload of a volume that is attached to an
3092 instance. Default=False. This option may not be supported by
3093 your cloud.
3094 --container-format <container-format>
3096 Container format type. Default is bare.
3097 --disk-format <disk-format>
3099 Disk format type. Default is raw.
3100 --visibility <public|private>
3102 Set image visibility to either public or private. Default=pri‐
3103 vate. (Supported by API version 3.1 and later)
3104 --protected <True|False>
3106 Prevents image from being deleted. Default=False. (Supported by
3107 API version 3.1 and later)
3108 cinder version-list
3110 usage: cinder version-list
3111 List all API versions.
3113
3115 OpenStack Contributors
3116
3118 OpenStack Contributors
31197.0.0 Jul 29, 2020 CINDER(1)