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] [--service-type <service-type>]
17 [--service-name <service-name>]
18 [--volume-service-name <volume-service-name>]
19 [--os-endpoint-type <os-endpoint-type>]
20 [--os-volume-api-version <volume-api-ver>]
21 [--os-endpoint <os-endpoint>] [--retries <retries>] [--insecure]
22 [--os-cacert <ca-certificate>] [--os-cert <certificate>]
23 [--os-key <key>] [--timeout <seconds>] [--collect-timing]
24 [--os-auth-type <name>] [--os-auth-url OS_AUTH_URL]
25 [--os-system-scope OS_SYSTEM_SCOPE]
26 [--os-domain-id OS_DOMAIN_ID] [--os-domain-name OS_DOMAIN_NAME]
27 [--os-project-id OS_PROJECT_ID]
28 [--os-project-name OS_PROJECT_NAME]
29 [--os-project-domain-id OS_PROJECT_DOMAIN_ID]
30 [--os-project-domain-name OS_PROJECT_DOMAIN_NAME]
31 [--os-trust-id OS_TRUST_ID]
32 [--os-default-domain-id OS_DEFAULT_DOMAIN_ID]
33 [--os-default-domain-name OS_DEFAULT_DOMAIN_NAME]
34 [--os-user-id OS_USER_ID] [--os-username OS_USERNAME]
35 [--os-user-domain-id OS_USER_DOMAIN_ID]
36 [--os-user-domain-name OS_USER_DOMAIN_NAME]
37 [--os-password OS_PASSWORD] [--os-auth-strategy <auth-strategy>]
38 [--os-token <token>] [--os-url <url>]
39 <subcommand> ...
40 Optional Arguments
42 --collect-timing
43 Collect per-API call timing information.
44 --insecure
46 Explicitly allow client to perform "insecure" TLS (https) re‐
47 quests. The server's certificate will not be verified against
48 any certificate authorities. This option should be used with
49 caution.
50 --os-auth-strategy
52 Authentication strategy (Env: OS_AUTH_STRATEGY, default key‐
53 stone). For now, any other value will disable the authentica‐
54 tion.
55 --os-auth-type, --os-auth-plugin
57 Authentication type to use
58 --os-auth-url
60 Authentication URL
61 --os-cacert
63 Specify a CA bundle file to use in verifying a TLS (https)
64 server certificate. Defaults to env[OS_CACERT].
65 --os-cert
67 Defaults to env[OS_CERT].
68 --os-default-domain-id
70 Optional domain ID to use with v3 and v2 parameters. It will be
71 used for both the user and project domain in v3 and ignored in
72 v2 authentication.
73 --os-default-domain-name
75 Optional domain name to use with v3 API and v2 parameters. It
76 will be used for both the user and project domain in v3 and ig‐
77 nored in v2 authentication.
78 --os-domain-id
80 Domain ID to scope to
81 --os-domain-name
83 Domain name to scope to
84 --os-endpoint
86 Use this API endpoint instead of the Service Catalog. Defaults
87 to env[CINDER_ENDPOINT].
88 --os-endpoint-type
90 Endpoint type, which is publicURL or internalURL. De‐
91 fault=env[OS_ENDPOINT_TYPE] or nova env[CINDER_ENDPOINT_TYPE] or
92 publicURL.
93 --os-key
95 Defaults to env[OS_KEY].
96 --os-password
98 User's password
99 --os-project-domain-id
101 Domain ID containing project
102 --os-project-domain-name
104 Domain name containing project
105 --os-project-id, --os-tenant-id
107 Project ID to scope to
108 --os-project-name, --os-tenant-name
110 Project name to scope to
111 --os-system-scope
113 Scope for system operations
114 --os-token
116 Defaults to env[OS_TOKEN].
117 --os-trust-id
119 Trust ID
120 --os-url
122 Defaults to env[OS_URL].
123 --os-user-domain-id
125 User's domain id
126 --os-user-domain-name
128 User's domain name
129 --os-user-id
131 User id
132 --os-username, --os-user-name
134 Username
135 --os-volume-api-version
137 Block Storage API version. Accepts X, X.Y (where X is major and
138 Y is minor part).Default=env[OS_VOLUME_API_VERSION].
139 --retries
141 Number of retries.
142 --service-name
144 Service name. Default=env[CINDER_SERVICE_NAME].
145 --service-type
147 Service type. For most actions, default is volume.
148 --timeout
150 Set request timeout (in seconds).
151 --version
153 show program's version number and exit
154 --volume-service-name
156 Volume service name. Default=env[CINDER_VOLUME_SERVICE_NAME].
157 -d, --debug
159 Shows debugging output.
160 Commands
162 absolute-limits
163 Lists absolute limits for a user.
164 api-version
166 Display the server API version information.
167 attachment-complete
169 Complete an attachment for a cinder volume.
170 attachment-create
172 Create an attachment for a cinder volume.
173 attachment-delete
175 Delete an attachment for a cinder volume.
176 attachment-list
178 Lists all attachments.
179 attachment-show
181 Show detailed information for attachment.
182 attachment-update
184 Update an attachment for a cinder volume.
185 availability-zone-list
187 Lists all availability zones.
188 backup-create
190 Creates a volume backup.
191 backup-delete
193 Removes one or more backups.
194 backup-export
196 Export backup metadata record.
197 backup-import
199 Import backup metadata record.
200 backup-list
202 Lists all backups.
203 backup-reset-state
205 Explicitly updates the backup state.
206 backup-restore
208 Restores a backup.
209 backup-show
211 Shows backup details.
212 backup-update
214 Updates a backup.
215 cgsnapshot-create
217 Creates a cgsnapshot.
218 cgsnapshot-delete
220 Removes one or more cgsnapshots.
221 cgsnapshot-list
223 Lists all cgsnapshots.
224 cgsnapshot-show
226 Shows cgsnapshot details.
227 cluster-disable
229 Disables clustered services.
230 cluster-enable
232 Enables clustered services.
233 cluster-list
235 Lists clustered services with optional filtering.
236 cluster-show
238 Show detailed information on a clustered service.
239 consisgroup-create
241 Creates a consistency group.
242 consisgroup-create-from-src
244 Creates a consistency group from a cgsnapshot or a source CG.
245 consisgroup-delete
247 Removes one or more consistency groups.
248 consisgroup-list
250 Lists all consistency groups.
251 consisgroup-show
253 Shows details of a consistency group.
254 consisgroup-update
256 Updates a consistency group.
257 create Creates a volume.
259 default-type-list
261 Lists all default volume types.
262 default-type-set
264 Sets a default volume type for a project.
265 default-type-unset
267 Unset default volume types.
268 delete Removes one or more volumes.
270 encryption-type-create
272 Creates encryption type for a volume type. Admin only.
273 encryption-type-delete
275 Deletes encryption type for a volume type. Admin only.
276 encryption-type-list
278 Shows encryption type details for volume types. Admin only.
279 encryption-type-show
281 Shows encryption type details for a volume type. Admin only.
282 encryption-type-update
284 Update encryption type information for a volume type (Admin
285 Only).
286 extend Attempts to extend size of an existing volume.
288 extra-specs-list
290 Lists current volume types and extra specs.
291 failover-host
293 Failover a replicating cinder-volume host.
294 force-delete
296 Attempts force-delete of volume, regardless of state.
297 freeze-host
299 Freeze and disable the specified cinder-volume host.
300 get-capabilities
302 Show backend volume stats and properties. Admin only.
303 get-pools
305 Show pool information for backends. Admin only.
306 group-create
308 Creates a group.
309 group-create-from-src
311 Creates a group from a group snapshot or a source group.
312 group-delete
314 Removes one or more groups.
315 group-disable-replication
317 Disables replication for group.
318 group-enable-replication
320 Enables replication for group.
321 group-failover-replication
323 Fails over replication for group.
324 group-list
326 Lists all groups.
327 group-list-replication-targets
329 Lists replication targets for group.
330 group-show
332 Shows details of a group.
333 group-snapshot-create
335 Creates a group snapshot.
336 group-snapshot-delete
338 Removes one or more group snapshots.
339 group-snapshot-list
341 Lists all group snapshots.
342 group-snapshot-show
344 Shows group snapshot details.
345 group-specs-list
347 Lists current group types and specs.
348 group-type-create
350 Creates a group type.
351 group-type-default
353 List the default group type.
354 group-type-delete
356 Deletes group type or types.
357 group-type-key
359 Sets or unsets group_spec for a group type.
360 group-type-list
362 Lists available 'group types'. (Admin only will see private
363 types)
364 group-type-show
366 Show group type details.
367 group-type-update
369 Updates group type name, description, and/or is_public.
370 group-update
372 Updates a group.
373 image-metadata
375 Sets or deletes volume image metadata.
376 image-metadata-show
378 Shows volume image metadata.
379 list Lists all volumes.
381 list-filters
383 List enabled filters.
384 manage Manage an existing volume.
386 manageable-list
388 Lists all manageable volumes.
389 message-delete
391 Removes one or more messages.
392 message-list
394 Lists all messages.
395 message-show
397 Shows message details.
398 metadata
400 Sets or deletes volume metadata.
401 metadata-show
403 Shows volume metadata.
404 metadata-update-all
406 Updates volume metadata.
407 migrate
409 Migrates volume to a new host.
410 qos-associate
412 Associates qos specs with specified volume type.
413 qos-create
415 Creates a qos specs.
416 qos-delete
418 Deletes a specified qos specs.
419 qos-disassociate
421 Disassociates qos specs from specified volume type.
422 qos-disassociate-all
424 Disassociates qos specs from all its associations.
425 qos-get-association
427 Lists all associations for specified qos specs.
428 qos-key
430 Sets or unsets specifications for a qos spec.
431 qos-list
433 Lists qos specs.
434 qos-show
436 Shows qos specs details.
437 quota-class-show
439 Lists quotas for a quota class.
440 quota-class-update
442 Updates quotas for a quota class.
443 quota-defaults
445 Lists default quotas for a tenant.
446 quota-delete
448 Delete the quotas for a tenant.
449 quota-show
451 Lists quotas for a tenant.
452 quota-update
454 Updates quotas for a tenant.
455 quota-usage
457 Lists quota usage for a tenant.
458 rate-limits
460 Lists rate limits for a user.
461 readonly-mode-update
463 Updates volume read-only access-mode flag.
464 rename Renames a volume.
466 reset-state
468 Explicitly updates the entity state in the Cinder database.
469 retype Changes the volume type for a volume.
471 revert-to-snapshot
473 Revert a volume to the specified snapshot.
474 service-disable
476 Disables the service.
477 service-enable
479 Enables the service.
480 service-get-log
482 Gets the service log level.
483 service-list
485 Lists all services. Filter by host and service binary.
486 service-set-log
488 Sets the service log level.
489 set-bootable
491 Update bootable status of a volume.
492 show Shows volume details.
494 snapshot-create
496 Creates a snapshot.
497 snapshot-delete
499 Removes one or more snapshots.
500 snapshot-list
502 Lists all snapshots.
503 snapshot-manage
505 Manage an existing snapshot.
506 snapshot-manageable-list
508 Lists all manageable snapshots.
509 snapshot-metadata
511 Sets or deletes snapshot metadata.
512 snapshot-metadata-show
514 Shows snapshot metadata.
515 snapshot-metadata-update-all
517 Updates snapshot metadata.
518 snapshot-rename
520 Renames a snapshot.
521 snapshot-reset-state
523 Explicitly updates the snapshot state.
524 snapshot-show
526 Shows snapshot details.
527 snapshot-unmanage
529 Stop managing a snapshot.
530 summary
532 Get volumes summary.
533 thaw-host
535 Thaw and enable the specified cinder-volume host.
536 transfer-accept
538 Accepts a volume transfer.
539 transfer-create
541 Creates a volume transfer.
542 transfer-delete
544 Undoes a transfer.
545 transfer-list
547 Lists all transfers.
548 transfer-show
550 Shows transfer details.
551 type-access-add
553 Adds volume type access for the given project.
554 type-access-list
556 Print access information about the given volume type.
557 type-access-remove
559 Removes volume type access for the given project.
560 type-create
562 Creates a volume type.
563 type-default
565 List the default volume type.
566 type-delete
568 Deletes volume type or types.
569 type-key
571 Sets or unsets extra_spec for a volume type.
572 type-list
574 Lists available 'volume types'.
575 type-show
577 Show volume type details.
578 type-update
580 Updates volume type name, description, and/or is_public.
581 unmanage
583 Stop managing a volume.
584 upload-to-image
586 Uploads volume to Image Service as an image.
587 version-list
589 List all API versions.
590 work-cleanup
592 Request cleanup of services with optional filtering.
593 help Shows help about this program or one of its subcommands.
595
597 cinder absolute-limits
598 usage: cinder absolute-limits [<tenant_id>]
599 Lists absolute limits for a user.
601 Positional arguments:
603 <tenant_id>
605 Display information for a single tenant (Admin only).
606 cinder api-version
608 usage: cinder api-version
609 Display the server API version information.
611 cinder attachment-complete
613 usage: cinder attachment-complete <attachment> [<attachment> ...]
614 Complete an attachment for a cinder volume.
616 Positional arguments:
618 <attachment>
620 ID of attachment or attachments to delete.
621 cinder attachment-create
623 usage: cinder attachment-create [--connect <connect>]
624 [--initiator <initiator>] [--ip <ip>]
625 [--host <host>] [--platform <platform>]
626 [--ostype <ostype>] [--multipath <multipath>]
627 [--mountpoint <mountpoint>] [--mode <mode>]
628 <volume> <server_id>
629 Create an attachment for a cinder volume.
631 Positional arguments:
633 <volume>
635 Name or ID of volume or volumes to attach.
636 <server_id>
638 ID of server attaching to.
639 Optional arguments:
641 --connect <connect>
643 Make an active connection using provided connector info (True or
644 False).
645 --initiator <initiator>
647 iqn of the initiator attaching to. Default=None.
648 --ip <ip>
650 ip of the system attaching to. Default=None.
651 --host <host>
653 Name of the host attaching to. Default=None.
654 --platform <platform>
656 Platform type. Default=x86_64.
657 --ostype <ostype>
659 OS type. Default=linux2.
660 --multipath <multipath>
662 Use multipath. Default=False.
663 --mountpoint <mountpoint>
665 Mountpoint volume will be attached at. Default=None.
666 --mode <mode>
668 Mode of attachment, rw, ro and null, where null indicates we
669 want to honor any existing admin-metadata settings. De‐
670 fault=null.
671 cinder attachment-delete
673 usage: cinder attachment-delete <attachment> [<attachment> ...]
674 Delete an attachment for a cinder volume.
676 Positional arguments:
678 <attachment>
680 ID of attachment or attachments to delete.
681 cinder attachment-list
683 usage: cinder attachment-list [--all-tenants [<0|1>]]
684 [--volume-id <volume-id>] [--status <status>]
685 [--marker <marker>] [--limit <limit>]
686 [--sort <key>[:<direction>]]
687 [--tenant [<tenant>]]
688 [--filters [<key=value> ...]]
689 Lists all attachments.
691 Optional arguments:
693 --all-tenants <0|1>
695 Shows details for all tenants. Admin only.
696 --volume-id <volume-id>
698 Filters results by a volume ID. Default=None. This option is
699 deprecated and will be removed in newer release. Please use
700 '--filters' option which is introduced since 3.33 instead.
701 --status <status>
703 Filters results by a status. Default=None. This option is depre‐
704 cated and will be removed in newer release. Please use '--fil‐
705 ters' option which is introduced since 3.33 instead.
706 --marker <marker>
708 Begin returning attachments that appear later in attachment list
709 than that represented by this id. Default=None.
710 --limit <limit>
712 Maximum number of attachments to return. Default=None.
713 --sort <key>[:<direction>]
715 Comma-separated list of sort keys and directions in the form of
716 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
717 ity_zone, name, bootable, created_at, reference. Default=None.
718 --tenant <tenant>
720 Display information from single tenant (Admin only).
721 --filters <key=value>
723 Filter key and value pairs. Please use 'cinder list-filters' to
724 check enabled filters from server. Use 'key~=value' for inexact
725 filtering if the key supports. Default=None.
726 cinder attachment-show
728 usage: cinder attachment-show <attachment>
729 Show detailed information for attachment.
731 Positional arguments:
733 <attachment>
735 ID of attachment.
736 cinder attachment-update
738 usage: cinder attachment-update [--initiator <initiator>] [--ip <ip>]
739 [--host <host>] [--platform <platform>]
740 [--ostype <ostype>] [--multipath <multipath>]
741 [--mountpoint <mountpoint>]
742 <attachment>
743 Update an attachment for a cinder volume.
745 Positional arguments:
747 <attachment>
749 ID of attachment.
750 Optional arguments:
752 --initiator <initiator>
754 iqn of the initiator attaching to. Default=None.
755 --ip <ip>
757 ip of the system attaching to. Default=None.
758 --host <host>
760 Name of the host attaching to. Default=None.
761 --platform <platform>
763 Platform type. Default=x86_64.
764 --ostype <ostype>
766 OS type. Default=linux2.
767 --multipath <multipath>
769 Use multipath. Default=False.
770 --mountpoint <mountpoint>
772 Mountpoint volume will be attached at. Default=None.
773 cinder availability-zone-list
775 usage: cinder availability-zone-list
776 Lists all availability zones.
778 cinder backup-create
780 usage: cinder backup-create [--container <container>] [--name <name>]
781 [--description <description>] [--incremental]
782 [--force] [--snapshot-id <snapshot-id>]
783 [--metadata [<key=value> ...]]
784 [--availability-zone AVAILABILITY_ZONE]
785 <volume>
786 Creates a volume backup.
788 Positional arguments:
790 <volume>
792 Name or ID of volume to backup.
793 Optional arguments:
795 --container <container>
797 Backup container name. Default=None.
798 --name <name>
800 Backup name. Default=None.
801 --description <description>
803 Backup description. Default=None.
804 --incremental None
806 Incremental backup. Default=False.
807 --force None
809 Allows or disallows backup of a volume when the volume is at‐
810 tached to an instance. If set to True, backs up the volume
811 whether its status is "available" or "in-use". The backup of an
812 "in-use" volume means your data is crash consistent. De‐
813 fault=False.
814 --snapshot-id <snapshot-id>
816 ID of snapshot to backup. Default=None.
817 --metadata <key=value>
819 Metadata key and value pairs. Default=None.
820 --availability-zone None
822 AZ where the backup should be stored, by default it will be the
823 same as the source.
824 cinder backup-delete
826 usage: cinder backup-delete [--force] <backup> [<backup> ...]
827 Removes one or more backups.
829 Positional arguments:
831 <backup>
833 Name or ID of backup(s) to delete.
834 Optional arguments:
836 --force None
838 Allows deleting backup of a volume when its status is other than
839 "available" or "error". Default=False.
840 cinder backup-export
842 usage: cinder backup-export <backup>
843 Export backup metadata record.
845 Positional arguments:
847 <backup>
849 ID of the backup to export.
850 cinder backup-import
852 usage: cinder backup-import <backup_service> <backup_url>
853 Import backup metadata record.
855 Positional arguments:
857 <backup_service>
859 Backup service to use for importing the backup.
860 <backup_url>
862 Backup URL for importing the backup metadata.
863 cinder backup-list
865 usage: cinder backup-list [--all-tenants [<all_tenants>]] [--name <name>]
866 [--status <status>] [--volume-id <volume-id>]
867 [--marker <marker>] [--limit <limit>]
868 [--sort <key>[:<direction>]]
869 [--filters [<key=value> ...]]
870 [--with-count [<True|False>]]
871 Lists all backups.
873 Optional arguments:
875 --all-tenants <all_tenants>
877 Shows details for all tenants. Admin only.
878 --name <name>
880 Filters results by a name. Default=None. This option is depre‐
881 cated and will be removed in newer release. Please use '--fil‐
882 ters' option which is introduced since 3.33 instead.
883 --status <status>
885 Filters results by a status. 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 --volume-id <volume-id>
890 Filters results by a volume ID. Default=None. This option is
891 deprecated and will be removed in newer release. Please use
892 '--filters' option which is introduced since 3.33 instead.
893 --marker <marker>
895 Begin returning backups that appear later in the backup list
896 than that represented by this id. Default=None.
897 --limit <limit>
899 Maximum number of backups to return. Default=None.
900 --sort <key>[:<direction>]
902 Comma-separated list of sort keys and directions in the form of
903 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
904 ity_zone, name, bootable, created_at, reference. Default=None.
905 --filters <key=value>
907 Filter key and value pairs. Please use 'cinder list-filters' to
908 check enabled filters from server. Use 'key~=value' for inexact
909 filtering if the key supports. Default=None.
910 --with-count <True|False>
912 Show total number of backup entities. This is useful when pagi‐
913 nation is applied in the request.
914 cinder backup-reset-state
916 usage: cinder backup-reset-state [--state <state>] <backup> [<backup> ...]
917 Explicitly updates the backup state.
919 Positional arguments:
921 <backup>
923 Name or ID of the backup to modify.
924 Optional arguments:
926 --state <state>
928 The state to assign to the backup. Valid values are "available",
929 "error". Default=available.
930 cinder backup-restore
932 usage: cinder backup-restore [--volume <volume>] [--name <name>] <backup>
933 Restores a backup.
935 Positional arguments:
937 <backup>
939 Name or ID of backup to restore.
940 Optional arguments:
942 --volume <volume>
944 Name or ID of existing volume to which to restore. This is mutu‐
945 ally exclusive with --name and takes priority. Default=None.
946 --name <name>
948 Use the name for new volume creation to restore. This is mutu‐
949 ally exclusive with --volume (or the deprecated --volume-id) and
950 --volume (or --volume-id) takes priority. Default=None.
951 cinder backup-show
953 usage: cinder backup-show <backup>
954 Shows backup details.
956 Positional arguments:
958 <backup>
960 Name or ID of backup.
961 cinder backup-update
963 usage: cinder backup-update [--name [<name>]] [--description <description>]
964 [--metadata [<key=value> ...]]
965 <backup>
966 Updates 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 --metadata <key=value>
983 Metadata key and value pairs. Default=None.
984 cinder cgsnapshot-create
986 usage: cinder cgsnapshot-create [--name <name>] [--description <description>]
987 <consistencygroup>
988 Creates a cgsnapshot.
990 Positional arguments:
992 <consistencygroup>
994 Name or ID of a consistency group.
995 Optional arguments:
997 --name <name>
999 Cgsnapshot name. Default=None.
1000 --description <description>
1002 Cgsnapshot description. Default=None.
1003 cinder cgsnapshot-delete
1005 usage: cinder cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]
1006 Removes one or more cgsnapshots.
1008 Positional arguments:
1010 <cgsnapshot>
1012 Name or ID of one or more cgsnapshots to be deleted.
1013 cinder cgsnapshot-list
1015 usage: cinder cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>]
1016 [--consistencygroup-id <consistencygroup_id>]
1017 Lists all cgsnapshots.
1019 Optional arguments:
1021 --all-tenants <0|1>
1023 Shows details for all tenants. Admin only.
1024 --status <status>
1026 Filters results by a status. Default=None.
1027 --consistencygroup-id <consistencygroup_id>
1029 Filters results by a consistency group ID. Default=None.
1030 cinder cgsnapshot-show
1032 usage: cinder cgsnapshot-show <cgsnapshot>
1033 Shows cgsnapshot details.
1035 Positional arguments:
1037 <cgsnapshot>
1039 Name or ID of cgsnapshot.
1040 cinder cluster-disable
1042 usage: cinder cluster-disable [--reason <reason>] [<binary>] <cluster-name>
1043 Disables clustered services.
1045 Positional arguments:
1047 <binary>
1049 Binary to filter by. Default: cinder-volume.
1050 <cluster-name>
1052 Name of the clustered services to update.
1053 Optional arguments:
1055 --reason <reason>
1057 Reason for disabling clustered service.
1058 cinder cluster-enable
1060 usage: cinder cluster-enable [<binary>] <cluster-name>
1061 Enables clustered services.
1063 Positional arguments:
1065 <binary>
1067 Binary to filter by. Default: cinder-volume.
1068 <cluster-name>
1070 Name of the clustered services to update.
1071 cinder cluster-list
1073 usage: cinder cluster-list [--name <name>] [--binary <binary>]
1074 [--is-up <True|true|False|false>]
1075 [--disabled <True|true|False|false>]
1076 [--num-hosts <num-hosts>]
1077 [--num-down-hosts <num-down-hosts>] [--detailed]
1078 Lists clustered services with optional filtering.
1080 Optional arguments:
1082 --name <name>
1084 Filter by cluster name, without backend will list all clustered
1085 services from the same cluster. Default=None.
1086 --binary <binary>
1088 Cluster binary. Default=None.
1089 --is-up <True|true|False|false>
1091 Filter by up/down status. Default=None.
1092 --disabled <True|true|False|false>
1094 Filter by disabled status. Default=None.
1095 --num-hosts <num-hosts>
1097 Filter by number of hosts in the cluster.
1098 --num-down-hosts <num-down-hosts>
1100 Filter by number of hosts that are down.
1101 --detailed None
1103 Get detailed clustered service information (Default=False).
1104 cinder cluster-show
1106 usage: cinder cluster-show [<binary>] <cluster-name>
1107 Show detailed information on a clustered service.
1109 Positional arguments:
1111 <binary>
1113 Binary to filter by. Default: cinder-volume.
1114 <cluster-name>
1116 Name of the clustered service to show.
1117 cinder consisgroup-create
1119 usage: cinder consisgroup-create [--name <name>] [--description <description>]
1120 [--availability-zone <availability-zone>]
1121 <volume-types>
1122 Creates a consistency group.
1124 Positional arguments:
1126 <volume-types>
1128 Volume types.
1129 Optional arguments:
1131 --name <name>
1133 Name of a consistency group.
1134 --description <description>
1136 Description of a consistency group. Default=None.
1137 --availability-zone <availability-zone>
1139 Availability zone for volume. Default=None.
1140 cinder consisgroup-create-from-src
1142 usage: cinder consisgroup-create-from-src [--cgsnapshot <cgsnapshot>]
1143 [--source-cg <source-cg>]
1144 [--name <name>]
1145 [--description <description>]
1146 Creates a consistency group from a cgsnapshot or a source CG.
1148 Optional arguments:
1150 --cgsnapshot <cgsnapshot>
1152 Name or ID of a cgsnapshot. Default=None.
1153 --source-cg <source-cg>
1155 Name or ID of a source CG. Default=None.
1156 --name <name>
1158 Name of a consistency group. Default=None.
1159 --description <description>
1161 Description of a consistency group. Default=None.
1162 cinder consisgroup-delete
1164 usage: cinder consisgroup-delete [--force]
1165 <consistencygroup> [<consistencygroup> ...]
1166 Removes one or more consistency groups.
1168 Positional arguments:
1170 <consistencygroup>
1172 Name or ID of one or more consistency groups to be deleted.
1173 Optional arguments:
1175 --force None
1177 Allows or disallows consistency groups to be deleted. If the
1178 consistency group is empty, it can be deleted without the force
1179 flag. If the consistency group is not empty, the force flag is
1180 required for it to be deleted.
1181 cinder consisgroup-list
1183 usage: cinder consisgroup-list [--all-tenants [<0|1>]]
1184 Lists all consistency groups.
1186 Optional arguments:
1188 --all-tenants <0|1>
1190 Shows details for all tenants. Admin only.
1191 cinder consisgroup-show
1193 usage: cinder consisgroup-show <consistencygroup>
1194 Shows details of a consistency group.
1196 Positional arguments:
1198 <consistencygroup>
1200 Name or ID of a consistency group.
1201 cinder consisgroup-update
1203 usage: cinder consisgroup-update [--name <name>] [--description <description>]
1204 [--add-volumes <uuid1,uuid2,......>]
1205 [--remove-volumes <uuid3,uuid4,......>]
1206 <consistencygroup>
1207 Updates a consistency group.
1209 Positional arguments:
1211 <consistencygroup>
1213 Name or ID of a consistency group.
1214 Optional arguments:
1216 --name <name>
1218 New name for consistency group. Default=None.
1219 --description <description>
1221 New description for consistency group. Default=None.
1222 --add-volumes <uuid1,uuid2,......>
1224 UUID of one or more volumes to be added to the consistency
1225 group, separated by commas. Default=None.
1226 --remove-volumes <uuid3,uuid4,......>
1228 UUID of one or more volumes to be removed from the consistency
1229 group, separated by commas. Default=None.
1230 cinder create
1232 usage: cinder create [--consisgroup-id <consistencygroup-id>]
1233 [--group-id <group-id>] [--snapshot-id <snapshot-id>]
1234 [--source-volid <source-volid>] [--image-id <image-id>]
1235 [--image <image>] [--backup-id <backup-id>]
1236 [--name <name>] [--description <description>]
1237 [--volume-type <volume-type>]
1238 [--availability-zone <availability-zone>]
1239 [--metadata [<key=value> ...]] [--hint <key=value>]
1240 [--poll]
1241 [<size>]
1242 Creates a volume.
1244 Positional arguments:
1246 <size> Size of volume, in GiBs. (Required unless snap‐
1248 shot-id/source-volid/backup-id is specified).
1249 Optional arguments:
1251 --consisgroup-id <consistencygroup-id>
1253 ID of a consistency group where the new volume belongs to. De‐
1254 fault=None.
1255 --group-id <group-id>
1257 ID of a group where the new volume belongs to. Default=None.
1258 --snapshot-id <snapshot-id>
1260 Creates volume from snapshot ID. Default=None.
1261 --source-volid <source-volid>
1263 Creates volume from volume ID. Default=None.
1264 --image-id <image-id>
1266 Creates volume from image ID. Default=None.
1267 --image <image>
1269 Creates a volume from image (ID or name). Default=None.
1270 --backup-id <backup-id>
1272 Creates a volume from backup ID. Default=None.
1273 --name <name>
1275 Volume name. Default=None.
1276 --description <description>
1278 Volume description. Default=None.
1279 --volume-type <volume-type>
1281 Volume type. Default=None.
1282 --availability-zone <availability-zone>
1284 Availability zone for volume. Default=None.
1285 --metadata <key=value>
1287 Metadata key and value pairs. Default=None.
1288 --hint <key=value>
1290 Scheduler hint, similar to nova. Repeat option to set multiple
1291 hints. Values with the same key will be stored as a list.
1292 --poll None
1294 Wait for volume creation until it completes.
1295 cinder default-type-list
1297 usage: cinder default-type-list [--project-id <project_id>]
1298 Lists all default volume types.
1300 Optional arguments:
1302 --project-id <project_id>
1304 ID of project for which to show the default type.
1305 cinder default-type-set
1307 usage: cinder default-type-set <volume_type> <project_id>
1308 Sets a default volume type for a project.
1310 Positional arguments:
1312 <volume_type>
1314 Name or ID of the volume type.
1315 <project_id>
1317 ID of project for which to set default type.
1318 cinder default-type-unset
1320 usage: cinder default-type-unset <project_id> [<project_id> ...]
1321 Unset default volume types.
1323 Positional arguments:
1325 <project_id>
1327 ID of project for which to unset default type.
1328 cinder delete
1330 usage: cinder delete [--cascade] <volume> [<volume> ...]
1331 Removes one or more volumes.
1333 Positional arguments:
1335 <volume>
1337 Name or ID of volume or volumes to delete.
1338 Optional arguments:
1340 --cascade None
1342 Remove any snapshots along with volume. Default=False.
1343 cinder encryption-type-create
1345 usage: cinder encryption-type-create [--cipher <cipher>]
1346 [--key-size <key_size>]
1347 [--control-location <control_location>]
1348 <volume_type> <provider>
1349 Creates encryption type for a volume type. Admin only.
1351 Positional arguments:
1353 <volume_type>
1355 Name or ID of volume type.
1356 <provider>
1358 The encryption provider format. For example, "luks" or "plain".
1359 Optional arguments:
1361 --cipher <cipher>
1363 The encryption algorithm or mode. For example, aes-xts-plain64.
1364 Default=None.
1365 --key-size <key_size>
1367 Size of encryption key, in bits. For example, 128 or 256. De‐
1368 fault=None.
1369 --control-location <control_location>
1371 Notional service where encryption is performed. Valid values are
1372 "front-end" or "back-end". For example, front-end=Nova. Default
1373 is "front-end".
1374 cinder encryption-type-delete
1376 usage: cinder encryption-type-delete <volume_type>
1377 Deletes encryption type for a volume type. Admin only.
1379 Positional arguments:
1381 <volume_type>
1383 Name or ID of volume type.
1384 cinder encryption-type-list
1386 usage: cinder encryption-type-list
1387 Shows encryption type details for volume types. Admin only.
1389 cinder encryption-type-show
1391 usage: cinder encryption-type-show <volume_type>
1392 Shows encryption type details for a volume type. Admin only.
1394 Positional arguments:
1396 <volume_type>
1398 Name or ID of volume type.
1399 cinder encryption-type-update
1401 usage: cinder encryption-type-update [--provider <provider>]
1402 [--cipher [<cipher>]]
1403 [--key-size [<key-size>]]
1404 [--control-location <control-location>]
1405 <volume-type>
1406 Update encryption type information for a volume type (Admin Only).
1408 Positional arguments:
1410 <volume-type>
1412 Name or ID of the volume type
1413 Optional arguments:
1415 --provider <provider>
1417 Encryption provider format (e.g. 'luks' or 'plain').
1418 --cipher <cipher>
1420 Encryption algorithm/mode to use (e.g., aes-xts-plain64). Pro‐
1421 vide parameter without value to set to provider default.
1422 --key-size <key-size>
1424 Size of the encryption key, in bits (e.g., 128, 256). Provide
1425 parameter without value to set to provider default.
1426 --control-location <control-location>
1428 Notional service where encryption is performed (e.g.,
1429 front-end=Nova). Values: 'front-end', 'back-end'
1430 cinder extend
1432 usage: cinder extend <volume> <new_size>
1433 Attempts to extend size of an existing volume.
1435 Positional arguments:
1437 <volume>
1439 Name or ID of volume to extend.
1440 <new_size>
1442 New size of volume, in GiBs.
1443 cinder extra-specs-list
1445 usage: cinder extra-specs-list
1446 Lists current volume types and extra specs.
1448 cinder failover-host
1450 usage: cinder failover-host [--backend_id <backend-id>] <hostname>
1451 Failover a replicating cinder-volume host.
1453 Positional arguments:
1455 <hostname>
1457 Host name.
1458 Optional arguments:
1460 --backend_id <backend-id>
1462 ID of backend to failover to (Default=None)
1463 cinder force-delete
1465 usage: cinder force-delete <volume> [<volume> ...]
1466 Attempts force-delete of volume, regardless of state.
1468 Positional arguments:
1470 <volume>
1472 Name or ID of volume or volumes to delete.
1473 cinder freeze-host
1475 usage: cinder freeze-host <hostname>
1476 Freeze and disable the specified cinder-volume host.
1478 Positional arguments:
1480 <hostname>
1482 Host name.
1483 cinder get-capabilities
1485 usage: cinder get-capabilities <host>
1486 Show backend volume stats and properties. Admin only.
1488 Positional arguments:
1490 <host> Cinder host to show backend volume stats and properties; takes
1492 the form: host@backend-name
1493 cinder get-pools
1495 usage: cinder get-pools [--detail] [--filters [<key=value> ...]]
1496 Show pool information for backends. Admin only.
1498 Optional arguments:
1500 --detail None
1502 Show detailed information about pools.
1503 --filters <key=value>
1505 Filter key and value pairs. Please use 'cinder list-filters' to
1506 check enabled filters from server, Default=None.
1507 cinder group-create
1509 usage: cinder group-create [--name <name>] [--description <description>]
1510 [--availability-zone <availability-zone>]
1511 <group-type> <volume-types>
1512 Creates a group.
1514 Positional arguments:
1516 <group-type>
1518 Group type.
1519 <volume-types>
1521 Comma-separated list of volume types.
1522 Optional arguments:
1524 --name <name>
1526 Name of a group.
1527 --description <description>
1529 Description of a group. Default=None.
1530 --availability-zone <availability-zone>
1532 Availability zone for group. Default=None.
1533 cinder group-create-from-src
1535 usage: cinder group-create-from-src [--group-snapshot <group-snapshot>]
1536 [--source-group <source-group>]
1537 [--name <name>]
1538 [--description <description>]
1539 Creates a group from a group snapshot or a source group.
1541 Optional arguments:
1543 --group-snapshot <group-snapshot>
1545 Name or ID of a group snapshot. Default=None.
1546 --source-group <source-group>
1548 Name or ID of a source group. Default=None.
1549 --name <name>
1551 Name of a group. Default=None.
1552 --description <description>
1554 Description of a group. Default=None.
1555 cinder group-delete
1557 usage: cinder group-delete [--delete-volumes] <group> [<group> ...]
1558 Removes one or more groups.
1560 Positional arguments:
1562 <group>
1564 Name or ID of one or more groups to be deleted.
1565 Optional arguments:
1567 --delete-volumes None
1569 Allows or disallows groups to be deleted if they are not empty.
1570 If the group is empty, it can be deleted without the delete-vol‐
1571 umes flag. If the group is not empty, the delete-volumes flag is
1572 required for it to be deleted. If True, all volumes in the group
1573 will also be deleted.
1574 cinder group-disable-replication
1576 usage: cinder group-disable-replication <group>
1577 Disables replication for group.
1579 Positional arguments:
1581 <group>
1583 Name or ID of the group.
1584 cinder group-enable-replication
1586 usage: cinder group-enable-replication <group>
1587 Enables replication for group.
1589 Positional arguments:
1591 <group>
1593 Name or ID of the group.
1594 cinder group-failover-replication
1596 usage: cinder group-failover-replication [--allow-attached-volume]
1597 [--secondary-backend-id <secondary_backend_id>]
1598 <group>
1599 Fails over replication for group.
1601 Positional arguments:
1603 <group>
1605 Name or ID of the group.
1606 Optional arguments:
1608 --allow-attached-volume None
1610 Allows or disallows group with attached volumes to be failed
1611 over.
1612 --secondary-backend-id <secondary_backend_id>
1614 Secondary backend id. Default=None.
1615 cinder group-list
1617 usage: cinder group-list [--all-tenants [<0|1>]] [--filters [<key=value> ...]]
1618 Lists all groups.
1620 Optional arguments:
1622 --all-tenants <0|1>
1624 Shows details for all tenants. Admin only.
1625 --filters <key=value>
1627 Filter key and value pairs. Please use 'cinder list-filters' to
1628 check enabled filters from server. Use 'key~=value' for inexact
1629 filtering if the key supports. Default=None.
1630 cinder group-list-replication-targets
1632 usage: cinder group-list-replication-targets <group>
1633 Lists replication targets for group.
1635 Positional arguments:
1637 <group>
1639 Name or ID of the group.
1640 cinder group-show
1642 usage: cinder group-show [--list-volume [<False|True>]] <group>
1643 Shows details of a group.
1645 Positional arguments:
1647 <group>
1649 Name or ID of a group.
1650 Optional arguments:
1652 --list-volume <False|True>
1654 Shows volumes included in the group.
1655 cinder group-snapshot-create
1657 usage: cinder group-snapshot-create [--name <name>]
1658 [--description <description>]
1659 <group>
1660 Creates a group snapshot.
1662 Positional arguments:
1664 <group>
1666 Name or ID of a group.
1667 Optional arguments:
1669 --name <name>
1671 Group snapshot name. Default=None.
1672 --description <description>
1674 Group snapshot description. Default=None.
1675 cinder group-snapshot-delete
1677 usage: cinder group-snapshot-delete <group_snapshot> [<group_snapshot> ...]
1678 Removes one or more group snapshots.
1680 Positional arguments:
1682 <group_snapshot>
1684 Name or ID of one or more group snapshots to be deleted.
1685 cinder group-snapshot-list
1687 usage: cinder group-snapshot-list [--all-tenants [<0|1>]] [--status <status>]
1688 [--group-id <group_id>]
1689 [--filters [<key=value> ...]]
1690 Lists all group snapshots.
1692 Optional arguments:
1694 --all-tenants <0|1>
1696 Shows details for all tenants. Admin only.
1697 --status <status>
1699 Filters results by a status. Default=None. This option is depre‐
1700 cated and will be removed in newer release. Please use '--fil‐
1701 ters' option which is introduced since 3.33 instead.
1702 --group-id <group_id>
1704 Filters results by a group ID. Default=None. This option is dep‐
1705 recated and will be removed in newer release. Please use '--fil‐
1706 ters' option which is introduced since 3.33 instead.
1707 --filters <key=value>
1709 Filter key and value pairs. Please use 'cinder list-filters' to
1710 check enabled filters from server. Use 'key~=value' for inexact
1711 filtering if the key supports. Default=None.
1712 cinder group-snapshot-show
1714 usage: cinder group-snapshot-show <group_snapshot>
1715 Shows group snapshot details.
1717 Positional arguments:
1719 <group_snapshot>
1721 Name or ID of group snapshot.
1722 cinder group-specs-list
1724 usage: cinder group-specs-list
1725 Lists current group types and specs.
1727 cinder group-type-create
1729 usage: cinder group-type-create [--description <description>]
1730 [--is-public <is-public>]
1731 <name>
1732 Creates a group type.
1734 Positional arguments:
1736 <name> Name of new group type.
1738 Optional arguments:
1740 --description <description>
1742 Description of new group type.
1743 --is-public <is-public>
1745 Make type accessible to the public (default true).
1746 cinder group-type-default
1748 usage: cinder group-type-default
1749 List the default group type.
1751 cinder group-type-delete
1753 usage: cinder group-type-delete <group_type> [<group_type> ...]
1754 Deletes group type or types.
1756 Positional arguments:
1758 <group_type>
1760 Name or ID of group type or types to delete.
1761 cinder group-type-key
1763 usage: cinder group-type-key <gtype> <action> <key=value> [<key=value> ...]
1764 Sets or unsets group_spec for a group type.
1766 Positional arguments:
1768 <gtype>
1770 Name or ID of group type.
1771 <action>
1773 The action. Valid values are "set" or "unset."
1774 <key=value>
1776 The group specs key and value pair to set or unset. For unset,
1777 specify only the key.
1778 cinder group-type-list
1780 usage: cinder group-type-list [--filters [<key=value> ...]]
1781 Lists available 'group types'. (Admin only will see private types)
1783 Optional arguments:
1785 --filters <key=value>
1787 Filter key and value pairs. Admin only.
1788 cinder group-type-show
1790 usage: cinder group-type-show <group_type>
1791 Show group type details.
1793 Positional arguments:
1795 <group_type>
1797 Name or ID of the group type.
1798 cinder group-type-update
1800 usage: cinder group-type-update [--name <name>] [--description <description>]
1801 [--is-public <is-public>]
1802 <id>
1803 Updates group type name, description, and/or is_public.
1805 Positional arguments:
1807 <id> ID of the group type.
1809 Optional arguments:
1811 --name <name>
1813 Name of the group type.
1814 --description <description>
1816 Description of the group type.
1817 --is-public <is-public>
1819 Make type accessible to the public or not.
1820 cinder group-update
1822 usage: cinder group-update [--name <name>] [--description <description>]
1823 [--add-volumes <uuid1,uuid2,......>]
1824 [--remove-volumes <uuid3,uuid4,......>]
1825 <group>
1826 Updates a group.
1828 Positional arguments:
1830 <group>
1832 Name or ID of a group.
1833 Optional arguments:
1835 --name <name>
1837 New name for group. Default=None.
1838 --description <description>
1840 New description for group. Default=None.
1841 --add-volumes <uuid1,uuid2,......>
1843 UUID of one or more volumes to be added to the group, separated
1844 by commas. Default=None.
1845 --remove-volumes <uuid3,uuid4,......>
1847 UUID of one or more volumes to be removed from the group, sepa‐
1848 rated by commas. Default=None.
1849 cinder image-metadata
1851 usage: cinder image-metadata <volume> <action> <key=value> [<key=value> ...]
1852 Sets or deletes volume image metadata.
1854 Positional arguments:
1856 <volume>
1858 Name or ID of volume for which to update metadata.
1859 <action>
1861 The action. Valid values are 'set' or 'unset.'
1862 <key=value>
1864 Metadata key and value pair to set or unset. For unset, specify
1865 only the key.
1866 cinder image-metadata-show
1868 usage: cinder image-metadata-show <volume>
1869 Shows volume image metadata.
1871 Positional arguments:
1873 <volume>
1875 ID of volume.
1876 cinder list
1878 usage: cinder list [--group_id <group_id>] [--all-tenants [<0|1>]]
1879 [--name <name>] [--status <status>]
1880 [--bootable [<True|true|False|false>]]
1881 [--migration_status <migration_status>]
1882 [--metadata [<key=value> ...]]
1883 [--image_metadata [<key=value> ...]] [--marker <marker>]
1884 [--limit <limit>] [--fields <fields>]
1885 [--sort <key>[:<direction>]] [--tenant [<tenant>]]
1886 [--filters [<key=value> ...]] [--with-count [<True|False>]]
1887 Lists all volumes.
1889 Optional arguments:
1891 --group_id <group_id>
1893 Filters results by a group_id. Default=None.This option is dep‐
1894 recated and will be removed in newer release. Please use '--fil‐
1895 ters' option which is introduced since 3.33 instead.
1896 --all-tenants <0|1>
1898 Shows details for all tenants. Admin only.
1899 --name <name>
1901 Filters results by a name. Default=None. This option is depre‐
1902 cated and will be removed in newer release. Please use '--fil‐
1903 ters' option which is introduced since 3.33 instead.
1904 --status <status>
1906 Filters results by a status. Default=None. This option is depre‐
1907 cated and will be removed in newer release. Please use '--fil‐
1908 ters' option which is introduced since 3.33 instead.
1909 --bootable <True|true|False|false>
1911 Filters results by bootable status. Default=None. This option is
1912 deprecated and will be removed in newer release. Please use
1913 '--filters' option which is introduced since 3.33 instead.
1914 --migration_status <migration_status>
1916 Filters results by a migration status. Default=None. Admin only.
1917 This option is deprecated and will be removed in newer release.
1918 Please use '--filters' option which is introduced since 3.33 in‐
1919 stead.
1920 --metadata <key=value>
1922 Filters results by a metadata key and value pair. Default=None.
1923 This option is deprecated and will be removed in newer release.
1924 Please use '--filters' option which is introduced since 3.33 in‐
1925 stead.
1926 --image_metadata <key=value>
1928 Filters results by a image metadata key and value pair. Require
1929 volume api version >=3.4. Default=None.This option is deprecated
1930 and will be removed in newer release. Please use '--filters' op‐
1931 tion which is introduced since 3.33 instead.
1932 --marker <marker>
1934 Begin returning volumes that appear later in the volume list
1935 than that represented by this volume id. Default=None.
1936 --limit <limit>
1938 Maximum number of volumes to return. Default=None.
1939 --fields <fields>
1941 Comma-separated list of fields to display. Use the show command
1942 to see which fields are available. Unavailable/non-existent
1943 fields will be ignored. Default=None.
1944 --sort <key>[:<direction>]
1946 Comma-separated list of sort keys and directions in the form of
1947 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
1948 ity_zone, name, bootable, created_at, reference. Default=None.
1949 --tenant <tenant>
1951 Display information from single tenant (Admin only).
1952 --filters <key=value>
1954 Filter key and value pairs. Please use 'cinder list-filters' to
1955 check enabled filters from server. Use 'key~=value' for inexact
1956 filtering if the key supports. Default=None.
1957 --with-count <True|False>
1959 Show total number of volume entities. This is useful when pagi‐
1960 nation is applied in the request.
1961 cinder list-filters
1963 usage: cinder list-filters [--resource <resource>]
1964 List enabled filters.
1966 Optional arguments:
1968 --resource <resource>
1970 Show enabled filters for specified resource. Default=None.
1971 cinder manage
1973 usage: cinder manage [--cluster CLUSTER] [--id-type <id-type>] [--name <name>]
1974 [--description <description>]
1975 [--volume-type <volume-type>]
1976 [--availability-zone <availability-zone>]
1977 [--metadata [<key=value> ...]] [--bootable]
1978 <host> <identifier>
1979 Manage an existing volume.
1981 Positional arguments:
1983 <host> Cinder host on which the existing volume resides; takes the
1985 form: host@backend-name#pool
1986 <identifier>
1988 Name or other Identifier for existing volume
1989 Optional arguments:
1991 --cluster None
1993 Cinder cluster on which the existing volume resides; takes the
1994 form: cluster@backend-name#pool
1995 --id-type <id-type>
1997 Type of backend device identifier provided, typically
1998 source-name or source-id (Default=source-name)
1999 --name <name>
2001 Volume name (Default=None)
2002 --description <description>
2004 Volume description (Default=None)
2005 --volume-type <volume-type>
2007 Volume type (Default=None)
2008 --availability-zone <availability-zone>
2010 Availability zone for volume (Default=None)
2011 --metadata <key=value>
2013 Metadata key=value pairs (Default=None)
2014 --bootable None
2016 Specifies that the newly created volume should be marked as
2017 bootable
2018 cinder manageable-list
2020 usage: cinder manageable-list [--detailed <detailed>] [--marker <marker>]
2021 [--limit <limit>] [--offset <offset>]
2022 [--sort <key>[:<direction>]] [--cluster CLUSTER]
2023 [<host>]
2024 Lists all manageable volumes.
2026 Positional arguments:
2028 <host> Cinder host on which to list manageable volumes; takes the form:
2030 host@backend-name#pool
2031 Optional arguments:
2033 --detailed <detailed>
2035 Returned detailed information (default true).
2036 --marker <marker>
2038 Begin returning volumes that appear later in the volume list
2039 than that represented by this reference. This reference should
2040 be json like. Default=None.
2041 --limit <limit>
2043 Maximum number of volumes to return. Default=None.
2044 --offset <offset>
2046 Number of volumes to skip after marker. Default=None.
2047 --sort <key>[:<direction>]
2049 Comma-separated list of sort keys and directions in the form of
2050 <key>[:<asc|desc>]. Valid keys: size, reference. Default=None.
2051 --cluster CLUSTER
2053 Cinder cluster on which to list manageable volumes; takes the
2054 form: cluster@backend-name#pool
2055 cinder message-delete
2057 usage: cinder message-delete <message> [<message> ...]
2058 Removes one or more messages.
2060 Positional arguments:
2062 <message>
2064 ID of one or more message to be deleted.
2065 cinder message-list
2067 usage: cinder message-list [--marker <marker>] [--limit <limit>]
2068 [--sort <key>[:<direction>]]
2069 [--resource_uuid <resource_uuid>]
2070 [--resource_type <type>] [--event_id <id>]
2071 [--request_id <request_id>] [--level <level>]
2072 [--filters [<key=value> ...]]
2073 Lists all messages.
2075 Optional arguments:
2077 --marker <marker>
2079 Begin returning message that appear later in the message list
2080 than that represented by this id. Default=None.
2081 --limit <limit>
2083 Maximum number of messages to return. Default=None.
2084 --sort <key>[:<direction>]
2086 Comma-separated list of sort keys and directions in the form of
2087 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
2088 ity_zone, name, bootable, created_at, reference. Default=None.
2089 --resource_uuid <resource_uuid>
2091 Filters results by a resource uuid. Default=None. This option is
2092 deprecated and will be removed in newer release. Please use
2093 '--filters' option which is introduced since 3.33 instead.
2094 --resource_type <type>
2096 Filters results by a resource type. Default=None. This option is
2097 deprecated and will be removed in newer release. Please use
2098 '--filters' option which is introduced since 3.33 instead.
2099 --event_id <id>
2101 Filters results by event id. Default=None. This option is depre‐
2102 cated and will be removed in newer release. Please use '--fil‐
2103 ters' option which is introduced since 3.33 instead.
2104 --request_id <request_id>
2106 Filters results by request id. Default=None. This option is dep‐
2107 recated and will be removed in newer release. Please use '--fil‐
2108 ters' option which is introduced since 3.33 instead.
2109 --level <level>
2111 Filters results by the message level. Default=None. This option
2112 is deprecated and will be removed in newer release. Please use
2113 '--filters' option which is introduced since 3.33 instead.
2114 --filters <key=value>
2116 Filter key and value pairs. Please use 'cinder list-filters' to
2117 check enabled filters from server. Use 'key~=value' for inexact
2118 filtering if the key supports. Default=None.
2119 cinder message-show
2121 usage: cinder message-show <message>
2122 Shows message details.
2124 Positional arguments:
2126 <message>
2128 ID of message.
2129 cinder metadata
2131 usage: cinder metadata <volume> <action> <key=value> [<key=value> ...]
2132 Sets or deletes volume metadata.
2134 Positional arguments:
2136 <volume>
2138 Name or ID of volume for which to update metadata.
2139 <action>
2141 The action. Valid values are "set" or "unset."
2142 <key=value>
2144 Metadata key and value pair to set or unset. For unset, specify
2145 only the key(s): <key key>
2146 cinder metadata-show
2148 usage: cinder metadata-show <volume>
2149 Shows volume metadata.
2151 Positional arguments:
2153 <volume>
2155 ID of volume.
2156 cinder metadata-update-all
2158 usage: cinder metadata-update-all <volume> <key=value> [<key=value> ...]
2159 Updates volume metadata.
2161 Positional arguments:
2163 <volume>
2165 ID of volume for which to update metadata.
2166 <key=value>
2168 Metadata key and value pair or pairs to update.
2169 cinder migrate
2171 usage: cinder migrate [--force-host-copy [<True|False>]]
2172 [--lock-volume [<True|False>]] [--cluster CLUSTER]
2173 <volume> [<host>]
2174 Migrates volume to a new host.
2176 Positional arguments:
2178 <volume>
2180 ID of volume to migrate.
2181 <host> Destination host. Takes the form: host@backend-name#pool
2183 Optional arguments:
2185 --force-host-copy <True|False>
2187 Enables or disables generic host-based force-migration, which
2188 bypasses driver optimizations. Default=False.
2189 --lock-volume <True|False>
2191 Enables or disables the termination of volume migration caused
2192 by other commands. This option applies to the available volume.
2193 True means it locks the volume state and does not allow the mi‐
2194 gration to be aborted. The volume status will be in maintenance
2195 during the migration. False means it allows the volume migration
2196 to be aborted. The volume status is still in the original sta‐
2197 tus. Default=False.
2198 --cluster None
2200 Destination cluster. Takes the form: cluster@backend-name#pool
2201 cinder qos-associate
2203 usage: cinder qos-associate <qos_specs> <volume_type_id>
2204 Associates qos specs with specified volume type.
2206 Positional arguments:
2208 <qos_specs>
2210 ID of QoS specifications.
2211 <volume_type_id>
2213 ID of volume type with which to associate QoS specifications.
2214 cinder qos-create
2216 usage: cinder qos-create <name> <key=value> [<key=value> ...]
2217 Creates a qos specs.
2219 Positional arguments:
2221 <name> Name of new QoS specifications.
2223 <key=value>
2225 QoS specifications.
2226 cinder qos-delete
2228 usage: cinder qos-delete [--force [<True|False>]] <qos_specs>
2229 Deletes a specified qos specs.
2231 Positional arguments:
2233 <qos_specs>
2235 ID of QoS specifications to delete.
2236 Optional arguments:
2238 --force <True|False>
2240 Enables or disables deletion of in-use QoS specifications. De‐
2241 fault=False.
2242 cinder qos-disassociate
2244 usage: cinder qos-disassociate <qos_specs> <volume_type_id>
2245 Disassociates qos specs from specified volume type.
2247 Positional arguments:
2249 <qos_specs>
2251 ID of QoS specifications.
2252 <volume_type_id>
2254 ID of volume type with which to associate QoS specifications.
2255 cinder qos-disassociate-all
2257 usage: cinder qos-disassociate-all <qos_specs>
2258 Disassociates qos specs from all its associations.
2260 Positional arguments:
2262 <qos_specs>
2264 ID of QoS specifications on which to operate.
2265 cinder qos-get-association
2267 usage: cinder qos-get-association <qos_specs>
2268 Lists all associations for specified qos specs.
2270 Positional arguments:
2272 <qos_specs>
2274 ID of QoS specifications.
2275 cinder qos-key
2277 usage: cinder qos-key <qos_specs> <action> key=value [key=value ...]
2278 Sets or unsets specifications for a qos spec.
2280 Positional arguments:
2282 <qos_specs>
2284 ID of QoS specifications.
2285 <action>
2287 The action. Valid values are "set" or "unset."
2288 key=value
2290 Metadata key and value pair to set or unset. For unset, specify
2291 only the key.
2292 cinder qos-list
2294 usage: cinder qos-list
2295 Lists qos specs.
2297 cinder qos-show
2299 usage: cinder qos-show <qos_specs>
2300 Shows qos specs details.
2302 Positional arguments:
2304 <qos_specs>
2306 ID of QoS specifications to show.
2307 cinder quota-class-show
2309 usage: cinder quota-class-show <class>
2310 Lists quotas for a quota class.
2312 Positional arguments:
2314 <class>
2316 Name of quota class for which to list quotas.
2317 cinder quota-class-update
2319 usage: cinder quota-class-update [--volumes <volumes>]
2320 [--snapshots <snapshots>]
2321 [--gigabytes <gigabytes>]
2322 [--backups <backups>]
2323 [--backup-gigabytes <backup_gigabytes>]
2324 [--volume-type <volume_type_name>]
2325 [--per-volume-gigabytes <per_volume_gigabytes>]
2326 <class_name>
2327 Updates quotas for a quota class.
2329 Positional arguments:
2331 <class_name>
2333 Name of quota class for which to set quotas.
2334 Optional arguments:
2336 --volumes <volumes>
2338 The new "volumes" quota value. Default=None.
2339 --snapshots <snapshots>
2341 The new "snapshots" quota value. Default=None.
2342 --gigabytes <gigabytes>
2344 The new "gigabytes" quota value. Default=None.
2345 --backups <backups>
2347 The new "backups" quota value. Default=None.
2348 --backup-gigabytes <backup_gigabytes>
2350 The new "backup_gigabytes" quota value. Default=None.
2351 --volume-type <volume_type_name>
2353 Volume type. Default=None.
2354 --per-volume-gigabytes <per_volume_gigabytes>
2356 Set max volume size limit. Default=None.
2357 cinder quota-defaults
2359 usage: cinder quota-defaults <tenant_id>
2360 Lists default quotas for a tenant.
2362 Positional arguments:
2364 <tenant_id>
2366 ID of tenant for which to list quota defaults.
2367 cinder quota-delete
2369 usage: cinder quota-delete <tenant_id>
2370 Delete the quotas for a tenant.
2372 Positional arguments:
2374 <tenant_id>
2376 UUID of tenant to delete the quotas for.
2377 cinder quota-show
2379 usage: cinder quota-show <tenant_id>
2380 Lists quotas for a tenant.
2382 Positional arguments:
2384 <tenant_id>
2386 ID of tenant for which to list quotas.
2387 cinder quota-update
2389 usage: cinder quota-update [--volumes <volumes>] [--snapshots <snapshots>]
2390 [--gigabytes <gigabytes>] [--backups <backups>]
2391 [--backup-gigabytes <backup_gigabytes>]
2392 [--groups <groups>]
2393 [--volume-type <volume_type_name>]
2394 [--per-volume-gigabytes <per_volume_gigabytes>]
2395 [--skip-validation <skip_validation>]
2396 <tenant_id>
2397 Updates quotas for a tenant.
2399 Positional arguments:
2401 <tenant_id>
2403 ID of tenant for which to set quotas.
2404 Optional arguments:
2406 --volumes <volumes>
2408 The new "volumes" quota value. Default=None.
2409 --snapshots <snapshots>
2411 The new "snapshots" quota value. Default=None.
2412 --gigabytes <gigabytes>
2414 The new "gigabytes" quota value. Default=None.
2415 --backups <backups>
2417 The new "backups" quota value. Default=None.
2418 --backup-gigabytes <backup_gigabytes>
2420 The new "backup_gigabytes" quota value. Default=None.
2421 --groups <groups>
2423 The new "groups" quota value. Default=None.
2424 --volume-type <volume_type_name>
2426 Volume type. Default=None.
2427 --per-volume-gigabytes <per_volume_gigabytes>
2429 Set max volume size limit. Default=None.
2430 --skip-validation <skip_validation>
2432 Skip validate the existing resource quota. Default=False.
2433 cinder quota-usage
2435 usage: cinder quota-usage <tenant_id>
2436 Lists quota usage for a tenant.
2438 Positional arguments:
2440 <tenant_id>
2442 ID of tenant for which to list quota usage.
2443 cinder rate-limits
2445 usage: cinder rate-limits [<tenant_id>]
2446 Lists rate limits for a user.
2448 Positional arguments:
2450 <tenant_id>
2452 Display information for a single tenant (Admin only).
2453 cinder readonly-mode-update
2455 usage: cinder readonly-mode-update <volume> <True|true|False|false>
2456 Updates volume read-only access-mode flag.
2458 Positional arguments:
2460 <volume>
2462 ID of volume to update.
2463 <True|true|False|false>
2465 Enables or disables update of volume to read-only access mode.
2466 cinder rename
2468 usage: cinder rename [--description <description>] <volume> [<name>]
2469 Renames a volume.
2471 Positional arguments:
2473 <volume>
2475 Name or ID of volume to rename.
2476 <name> New name for volume.
2478 Optional arguments:
2480 --description <description>
2482 Volume description. Default=None.
2483 cinder reset-state
2485 usage: cinder reset-state [--type <type>] [--state <state>]
2486 [--attach-status <attach-status>]
2487 [--reset-migration-status]
2488 <entity> [<entity> ...]
2489 Explicitly updates the entity state in the Cinder database.
2491 Positional arguments:
2493 <entity>
2495 Name or ID of entity to update.
2496 Optional arguments:
2498 --type <type>
2500 Type of entity to update. Available resources are: 'volume',
2501 'snapshot', 'backup', 'group' (since 3.20) and 'group-snapshot'
2502 (since 3.19), Default=volume.
2503 --state <state>
2505 The state to assign to the entity. NOTE: This command simply
2506 changes the state of the entity in the database with no regard
2507 to actual status, exercise caution when using. Default=None,
2508 that means the state is unchanged.
2509 --attach-status <attach-status>
2511 This is only used for a volume entity. The attach status to as‐
2512 sign to the volume in the database, with no regard to the actual
2513 status. Valid values are "attached" and "detached". De‐
2514 fault=None, that means the status is unchanged.
2515 --reset-migration-status None
2517 This is only used for a volume entity. Clears the migration sta‐
2518 tus of the volume in the DataBase that indicates the volume is
2519 source or destination of volume migration, with no regard to the
2520 actual status.
2521 cinder retype
2523 usage: cinder retype [--migration-policy <never|on-demand>]
2524 <volume> <volume-type>
2525 Changes the volume type for a volume.
2527 Positional arguments:
2529 <volume>
2531 Name or ID of volume for which to modify type.
2532 <volume-type>
2534 New volume type.
2535 Optional arguments:
2537 --migration-policy <never|on-demand>
2539 Migration policy during retype of volume.
2540 cinder revert-to-snapshot
2542 usage: cinder revert-to-snapshot <snapshot>
2543 Revert a volume to the specified snapshot.
2545 Positional arguments:
2547 <snapshot>
2549 Name or ID of the snapshot to restore. The snapshot must be the
2550 most recent one known to cinder.
2551 cinder service-disable
2553 usage: cinder service-disable [--reason <reason>] <hostname> <binary>
2554 Disables the service.
2556 Positional arguments:
2558 <hostname>
2560 Host name.
2561 <binary>
2563 Service binary.
2564 Optional arguments:
2566 --reason <reason>
2568 Reason for disabling service.
2569 cinder service-enable
2571 usage: cinder service-enable <hostname> <binary>
2572 Enables the service.
2574 Positional arguments:
2576 <hostname>
2578 Host name.
2579 <binary>
2581 Service binary.
2582 cinder service-get-log
2584 usage: cinder service-get-log
2585 [--binary {,*,cinder-api,cinder-volume,cinder-scheduler,cinder-backup}]
2586 [--server SERVER] [--prefix PREFIX]
2587 Gets the service log level.
2589 Optional arguments:
2591 --binary None
2593 Binary to query.
2594 --server None
2596 Host or cluster value for service.
2597 --prefix None
2599 Prefix for the log. ie: "sqlalchemy.".
2600 cinder service-list
2602 usage: cinder service-list [--host <hostname>] [--binary <binary>]
2603 [--withreplication [<True|False>]]
2604 Lists all services. Filter by host and service binary.
2606 Optional arguments:
2608 --host <hostname>
2610 Host name. Default=None.
2611 --binary <binary>
2613 Service binary. Default=None.
2614 --withreplication <True|False>
2616 Enables or disables display of Replication info for c-vol ser‐
2617 vices. Default=False.
2618 cinder service-set-log
2620 usage: cinder service-set-log
2621 [--binary {,*,cinder-api,cinder-volume,cinder-scheduler,cinder-backup}]
2622 [--server SERVER] [--prefix PREFIX]
2623 <log-level>
2624 Sets the service log level.
2626 Positional arguments:
2628 <log-level>
2630 Desired log level.
2631 Optional arguments:
2633 --binary None
2635 Binary to change.
2636 --server None
2638 Host or cluster value for service.
2639 --prefix None
2641 Prefix for the log. ie: "cinder.volume.drivers.".
2642 cinder set-bootable
2644 usage: cinder set-bootable <volume> <True|true|False|false>
2645 Update bootable status of a volume.
2647 Positional arguments:
2649 <volume>
2651 ID of the volume to update.
2652 <True|true|False|false>
2654 Flag to indicate whether volume is bootable.
2655 cinder show
2657 usage: cinder show <volume>
2658 Shows volume details.
2660 Positional arguments:
2662 <volume>
2664 Name or ID of volume.
2665 cinder snapshot-create
2667 usage: cinder snapshot-create [--force [<True|False>]] [--name <name>]
2668 [--description <description>]
2669 [--metadata [<key=value> ...]]
2670 <volume>
2671 Creates a snapshot.
2673 Positional arguments:
2675 <volume>
2677 Name or ID of volume to snapshot.
2678 Optional arguments:
2680 --force <True|False>
2682 Allows or disallows snapshot of a volume when the volume is at‐
2683 tached to an instance. If set to True, ignores the current sta‐
2684 tus of the volume when attempting to snapshot it rather than
2685 forcing it to be available. Default=False.
2686 --name <name>
2688 Snapshot name. Default=None.
2689 --description <description>
2691 Snapshot description. Default=None.
2692 --metadata <key=value>
2694 Snapshot metadata key and value pairs. Default=None.
2695 cinder snapshot-delete
2697 usage: cinder snapshot-delete [--force] <snapshot> [<snapshot> ...]
2698 Removes one or more snapshots.
2700 Positional arguments:
2702 <snapshot>
2704 Name or ID of the snapshot(s) to delete.
2705 Optional arguments:
2707 --force None
2709 Allows deleting snapshot of a volume when its status is other
2710 than "available" or "error". Default=False.
2711 cinder snapshot-list
2713 usage: cinder snapshot-list [--all-tenants [<0|1>]] [--name <name>]
2714 [--status <status>] [--volume-id <volume-id>]
2715 [--marker <marker>] [--limit <limit>]
2716 [--sort <key>[:<direction>]] [--tenant [<tenant>]]
2717 [--metadata [<key=value> ...]]
2718 [--filters [<key=value> ...]]
2719 [--with-count [<True|False>]]
2720 Lists all snapshots.
2722 Optional arguments:
2724 --all-tenants <0|1>
2726 Shows details for all tenants. Admin only.
2727 --name <name>
2729 Filters results by a name. Default=None. This option is depre‐
2730 cated and will be removed in newer release. Please use '--fil‐
2731 ters' option which is introduced since 3.33 instead.
2732 --status <status>
2734 Filters results by a status. Default=None. This option is depre‐
2735 cated and will be removed in newer release. Please use '--fil‐
2736 ters' option which is introduced since 3.33 instead.
2737 --volume-id <volume-id>
2739 Filters results by a volume ID. Default=None. This option is
2740 deprecated and will be removed in newer release. Please use
2741 '--filters' option which is introduced since 3.33 instead.
2742 --marker <marker>
2744 Begin returning snapshots that appear later in the snapshot list
2745 than that represented by this id. Default=None.
2746 --limit <limit>
2748 Maximum number of snapshots to return. Default=None.
2749 --sort <key>[:<direction>]
2751 Comma-separated list of sort keys and directions in the form of
2752 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
2753 ity_zone, name, bootable, created_at, reference. Default=None.
2754 --tenant <tenant>
2756 Display information from single tenant (Admin only).
2757 --metadata <key=value>
2759 Filters results by a metadata key and value pair. Require volume
2760 api version >=3.22. Default=None. This option is deprecated and
2761 will be removed in newer release. Please use '--filters' option
2762 which is introduced since 3.33 instead.
2763 --filters <key=value>
2765 Filter key and value pairs. Please use 'cinder list-filters' to
2766 check enabled filters from server. Use 'key~=value' for inexact
2767 filtering if the key supports. Default=None.
2768 --with-count <True|False>
2770 Show total number of snapshot entities. This is useful when pag‐
2771 ination is applied in the request.
2772 cinder snapshot-manage
2774 usage: cinder snapshot-manage [--id-type <id-type>] [--name <name>]
2775 [--description <description>]
2776 [--metadata [<key=value> ...]]
2777 <volume> <identifier>
2778 Manage an existing snapshot.
2780 Positional arguments:
2782 <volume>
2784 Cinder volume that already exists in the volume backend.
2785 <identifier>
2787 Name or other identifier for existing snapshot. This is backend
2788 specific.
2789 Optional arguments:
2791 --id-type <id-type>
2793 Type of backend device identifier provided, typically
2794 source-name or source-id (Default=source-name).
2795 --name <name>
2797 Snapshot name (Default=None).
2798 --description <description>
2800 Snapshot description (Default=None).
2801 --metadata <key=value>
2803 Metadata key=value pairs (Default=None).
2804 cinder snapshot-manageable-list
2806 usage: cinder snapshot-manageable-list [--detailed <detailed>]
2807 [--marker <marker>] [--limit <limit>]
2808 [--offset <offset>]
2809 [--sort <key>[:<direction>]]
2810 [--cluster CLUSTER]
2811 [<host>]
2812 Lists all manageable snapshots.
2814 Positional arguments:
2816 <host> Cinder host on which to list manageable snapshots; takes the
2818 form: host@backend-name#pool
2819 Optional arguments:
2821 --detailed <detailed>
2823 Returned detailed information (default true).
2824 --marker <marker>
2826 Begin returning volumes that appear later in the volume list
2827 than that represented by this reference. This reference should
2828 be json like. Default=None.
2829 --limit <limit>
2831 Maximum number of volumes to return. Default=None.
2832 --offset <offset>
2834 Number of volumes to skip after marker. Default=None.
2835 --sort <key>[:<direction>]
2837 Comma-separated list of sort keys and directions in the form of
2838 <key>[:<asc|desc>]. Valid keys: size, reference. Default=None.
2839 --cluster None
2841 Cinder cluster on which to list manageable snapshots; takes the
2842 form: cluster@backend-name#pool
2843 cinder snapshot-metadata
2845 usage: cinder snapshot-metadata <snapshot> <action> <key=value>
2846 [<key=value> ...]
2847 Sets or deletes snapshot metadata.
2849 Positional arguments:
2851 <snapshot>
2853 ID of snapshot for which to update metadata.
2854 <action>
2856 The action. Valid values are "set" or "unset."
2857 <key=value>
2859 Metadata key and value pair to set or unset. For unset, specify
2860 only the key.
2861 cinder snapshot-metadata-show
2863 usage: cinder snapshot-metadata-show <snapshot>
2864 Shows snapshot metadata.
2866 Positional arguments:
2868 <snapshot>
2870 ID of snapshot.
2871 cinder snapshot-metadata-update-all
2873 usage: cinder snapshot-metadata-update-all <snapshot> <key=value>
2874 [<key=value> ...]
2875 Updates snapshot metadata.
2877 Positional arguments:
2879 <snapshot>
2881 ID of snapshot for which to update metadata.
2882 <key=value>
2884 Metadata key and value pair to update.
2885 cinder snapshot-rename
2887 usage: cinder snapshot-rename [--description <description>]
2888 <snapshot> [<name>]
2889 Renames a snapshot.
2891 Positional arguments:
2893 <snapshot>
2895 Name or ID of snapshot.
2896 <name> New name for snapshot.
2898 Optional arguments:
2900 --description <description>
2902 Snapshot description. Default=None.
2903 cinder snapshot-reset-state
2905 usage: cinder snapshot-reset-state [--state <state>]
2906 <snapshot> [<snapshot> ...]
2907 Explicitly updates the snapshot state.
2909 Positional arguments:
2911 <snapshot>
2913 Name or ID of snapshot to modify.
2914 Optional arguments:
2916 --state <state>
2918 The state to assign to the snapshot. Valid values are "avail‐
2919 able", "error", "creating", "deleting", and "error_deleting".
2920 NOTE: This command simply changes the state of the Snapshot in
2921 the DataBase with no regard to actual status, exercise caution
2922 when using. Default=available.
2923 cinder snapshot-show
2925 usage: cinder snapshot-show <snapshot>
2926 Shows snapshot details.
2928 Positional arguments:
2930 <snapshot>
2932 Name or ID of snapshot.
2933 cinder snapshot-unmanage
2935 usage: cinder snapshot-unmanage <snapshot>
2936 Stop managing a snapshot.
2938 Positional arguments:
2940 <snapshot>
2942 Name or ID of the snapshot to unmanage.
2943 cinder summary
2945 usage: cinder summary [--all-tenants [<0|1>]]
2946 Get volumes summary.
2948 Optional arguments:
2950 --all-tenants <0|1>
2952 Shows details for all tenants. Admin only.
2953 cinder thaw-host
2955 usage: cinder thaw-host <hostname>
2956 Thaw and enable the specified cinder-volume host.
2958 Positional arguments:
2960 <hostname>
2962 Host name.
2963 cinder transfer-accept
2965 usage: cinder transfer-accept <transfer> <auth_key>
2966 Accepts a volume transfer.
2968 Positional arguments:
2970 <transfer>
2972 ID of transfer to accept.
2973 <auth_key>
2975 Authentication key of transfer to accept.
2976 cinder transfer-create
2978 usage: cinder transfer-create [--name <name>] [--no-snapshots] <volume>
2979 Creates a volume transfer.
2981 Positional arguments:
2983 <volume>
2985 Name or ID of volume to transfer.
2986 Optional arguments:
2988 --name <name>
2990 Transfer name. Default=None.
2991 --no-snapshots None
2993 Allows or disallows transfer volumes without snapshots. De‐
2994 fault=False.
2995 cinder transfer-delete
2997 usage: cinder transfer-delete <transfer>
2998 Undoes a transfer.
3000 Positional arguments:
3002 <transfer>
3004 Name or ID of transfer to delete.
3005 cinder transfer-list
3007 usage: cinder transfer-list [--all-tenants [<0|1>]]
3008 [--sort <key>[:<direction>]]
3009 [--filters [<key=value> ...]]
3010 Lists all transfers.
3012 Optional arguments:
3014 --all-tenants <0|1>
3016 Shows details for all tenants. Admin only.
3017 --sort <key>[:<direction>]
3019 Sort keys and directions in the form of <key>[:<asc|desc>].
3020 --filters <key=value>
3022 Filter key and value pairs.
3023 cinder transfer-show
3025 usage: cinder transfer-show <transfer>
3026 Shows transfer details.
3028 Positional arguments:
3030 <transfer>
3032 Name or ID of transfer to accept.
3033 cinder type-access-add
3035 usage: cinder type-access-add --volume-type <volume_type> --project-id
3036 <project_id>
3037 Adds volume type access for the given project.
3039 Optional arguments:
3041 --volume-type <volume_type>
3043 Volume type name or ID to add access for the given project.
3044 --project-id <project_id>
3046 Project ID to add volume type access for.
3047 cinder type-access-list
3049 usage: cinder type-access-list --volume-type <volume_type>
3050 Print access information about the given volume type.
3052 Optional arguments:
3054 --volume-type <volume_type>
3056 Filter results by volume type name or ID.
3057 cinder type-access-remove
3059 usage: cinder type-access-remove --volume-type <volume_type> --project-id
3060 <project_id>
3061 Removes volume type access for the given project.
3063 Optional arguments:
3065 --volume-type <volume_type>
3067 Volume type name or ID to remove access for the given project.
3068 --project-id <project_id>
3070 Project ID to remove volume type access for.
3071 cinder type-create
3073 usage: cinder type-create [--description <description>]
3074 [--is-public <is-public>]
3075 <name>
3076 Creates a volume type.
3078 Positional arguments:
3080 <name> Name of new volume type.
3082 Optional arguments:
3084 --description <description>
3086 Description of new volume type.
3087 --is-public <is-public>
3089 Make type accessible to the public (default true).
3090 cinder type-default
3092 usage: cinder type-default
3093 List the default volume type.
3095 cinder type-delete
3097 usage: cinder type-delete <vol_type> [<vol_type> ...]
3098 Deletes volume type or types.
3100 Positional arguments:
3102 <vol_type>
3104 Name or ID of volume type or types to delete.
3105 cinder type-key
3107 usage: cinder type-key <vtype> <action> <key=value> [<key=value> ...]
3108 Sets or unsets extra_spec for a volume type.
3110 Positional arguments:
3112 <vtype>
3114 Name or ID of volume type.
3115 <action>
3117 The action. Valid values are "set" or "unset."
3118 <key=value>
3120 The extra specs key and value pair to set or unset. For unset,
3121 specify only the key.
3122 cinder type-list
3124 usage: cinder type-list [--filters [<key=value> ...]]
3125 Lists available 'volume types'.
3127 Optional arguments:
3129 --filters <key=value>
3131 Filter key and value pairs. Admin only.
3132 cinder type-show
3134 usage: cinder type-show <volume_type>
3135 Show volume type details.
3137 Positional arguments:
3139 <volume_type>
3141 Name or ID of the volume type.
3142 cinder type-update
3144 usage: cinder type-update [--name <name>] [--description <description>]
3145 [--is-public <is-public>]
3146 <id>
3147 Updates volume type name, description, and/or is_public.
3149 Positional arguments:
3151 <id> ID of the volume type.
3153 Optional arguments:
3155 --name <name>
3157 Name of the volume type.
3158 --description <description>
3160 Description of the volume type.
3161 --is-public <is-public>
3163 Make type accessible to the public or not.
3164 cinder unmanage
3166 usage: cinder unmanage <volume>
3167 Stop managing a volume.
3169 Positional arguments:
3171 <volume>
3173 Name or ID of the volume to unmanage.
3174 cinder upload-to-image
3176 usage: cinder upload-to-image [--force [<True|False>]]
3177 [--container-format <container-format>]
3178 [--disk-format <disk-format>]
3179 [--visibility <public|private|community|shared>]
3180 [--protected <True|False>]
3181 <volume> <image-name>
3182 Uploads volume to Image Service as an image.
3184 Positional arguments:
3186 <volume>
3188 Name or ID of volume to snapshot.
3189 <image-name>
3191 The new image name.
3192 Optional arguments:
3194 --force <True|False>
3196 Enables or disables upload of a volume that is attached to an
3197 instance. Default=False. This option may not be supported by
3198 your cloud.
3199 --container-format <container-format>
3201 Container format type. Default is bare.
3202 --disk-format <disk-format>
3204 Disk format type. Default is raw.
3205 --visibility <public|private|community|shared>
3207 Set image visibility to public, private, community or shared.
3208 Default=private.
3209 --protected <True|False>
3211 Prevents image from being deleted. Default=False.
3212 cinder version-list
3214 usage: cinder version-list
3215 List all API versions.
3217 cinder work-cleanup
3219 usage: cinder work-cleanup [--cluster <cluster-name>] [--host <hostname>]
3220 [--binary <binary>]
3221 [--is-up <True|true|False|false>]
3222 [--disabled <True|true|False|false>]
3223 [--resource-id <resource-id>]
3224 [--resource-type <Volume|Snapshot>]
3225 [--service-id <service-id>]
3226 Request cleanup of services with optional filtering.
3228 Optional arguments:
3230 --cluster <cluster-name>
3232 Cluster name. Default=None.
3233 --host <hostname>
3235 Service host name. Default=None.
3236 --binary <binary>
3238 Service binary. Default=None.
3239 --is-up <True|true|False|false>
3241 Filter by up/down status, if set to true services need to be up,
3242 if set to false services need to be down. Default is None,
3243 which means up/down status is ignored.
3244 --disabled <True|true|False|false>
3246 Filter by disabled status. Default=None.
3247 --resource-id <resource-id>
3249 UUID of a resource to cleanup. Default=None.
3250 --resource-type <Volume|Snapshot>
3252 Type of resource to cleanup.
3253 --service-id <service-id>
3255 The service id field from the DB, not the uuid of the service.
3256 Default=None.
3257 cinder help
3259 usage: cinder help [<subcommand>]
3260 Shows help about this program or one of its subcommands.
3262 Positional arguments:
3264 <subcommand>
3266 Shows help for <subcommand>.
3267
3269 OpenStack Contributors
3270
3272 OpenStack Contributors
32737.2.0 Jan 27, 2021 CINDER(1)