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>]
933 [--volume-type <volume-type>]
934 [--availability-zone <AZ>]
935 <backup>
936 Restores a backup.
938 Positional arguments:
940 <backup>
942 Name or ID of backup to restore.
943 Optional arguments:
945 --volume <volume>
947 Name or ID of existing volume to which to restore. This is mutu‐
948 ally exclusive with --name and takes priority. Default=None.
949 --name <name>
951 Use the name for new volume creation to restore. This is mutu‐
952 ally exclusive with --volume and --volume takes priority. De‐
953 fault=None.
954 --volume-type <volume-type>
956 Volume type for the new volume creation to restore. This option
957 is not valid when used with the "volume" option. Default=None.
958 --availability-zone <AZ>
960 AZ for the new volume creation to restore. By default it will be
961 the same as backup AZ. This option is not valid when used with
962 the "volume" option. Default=None.
963 cinder backup-show
965 usage: cinder backup-show <backup>
966 Shows backup details.
968 Positional arguments:
970 <backup>
972 Name or ID of backup.
973 cinder backup-update
975 usage: cinder backup-update [--name [<name>]] [--description <description>]
976 [--metadata [<key=value> ...]]
977 <backup>
978 Updates a backup.
980 Positional arguments:
982 <backup>
984 Name or ID of backup to rename.
985 Optional arguments:
987 --name <name>
989 New name for backup.
990 --description <description>
992 Backup description. Default=None.
993 --metadata <key=value>
995 Metadata key and value pairs. Default=None.
996 cinder cgsnapshot-create
998 usage: cinder cgsnapshot-create [--name <name>] [--description <description>]
999 <consistencygroup>
1000 Creates a cgsnapshot.
1002 Positional arguments:
1004 <consistencygroup>
1006 Name or ID of a consistency group.
1007 Optional arguments:
1009 --name <name>
1011 Cgsnapshot name. Default=None.
1012 --description <description>
1014 Cgsnapshot description. Default=None.
1015 cinder cgsnapshot-delete
1017 usage: cinder cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]
1018 Removes one or more cgsnapshots.
1020 Positional arguments:
1022 <cgsnapshot>
1024 Name or ID of one or more cgsnapshots to be deleted.
1025 cinder cgsnapshot-list
1027 usage: cinder cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>]
1028 [--consistencygroup-id <consistencygroup_id>]
1029 Lists all cgsnapshots.
1031 Optional arguments:
1033 --all-tenants <0|1>
1035 Shows details for all tenants. Admin only.
1036 --status <status>
1038 Filters results by a status. Default=None.
1039 --consistencygroup-id <consistencygroup_id>
1041 Filters results by a consistency group ID. Default=None.
1042 cinder cgsnapshot-show
1044 usage: cinder cgsnapshot-show <cgsnapshot>
1045 Shows cgsnapshot details.
1047 Positional arguments:
1049 <cgsnapshot>
1051 Name or ID of cgsnapshot.
1052 cinder cluster-disable
1054 usage: cinder cluster-disable [--reason <reason>] [<binary>] <cluster-name>
1055 Disables clustered services.
1057 Positional arguments:
1059 <binary>
1061 Binary to filter by. Default: cinder-volume.
1062 <cluster-name>
1064 Name of the clustered services to update.
1065 Optional arguments:
1067 --reason <reason>
1069 Reason for disabling clustered service.
1070 cinder cluster-enable
1072 usage: cinder cluster-enable [<binary>] <cluster-name>
1073 Enables clustered services.
1075 Positional arguments:
1077 <binary>
1079 Binary to filter by. Default: cinder-volume.
1080 <cluster-name>
1082 Name of the clustered services to update.
1083 cinder cluster-list
1085 usage: cinder cluster-list [--name <name>] [--binary <binary>]
1086 [--is-up <True|true|False|false>]
1087 [--disabled <True|true|False|false>]
1088 [--num-hosts <num-hosts>]
1089 [--num-down-hosts <num-down-hosts>] [--detailed]
1090 Lists clustered services with optional filtering.
1092 Optional arguments:
1094 --name <name>
1096 Filter by cluster name, without backend will list all clustered
1097 services from the same cluster. Default=None.
1098 --binary <binary>
1100 Cluster binary. Default=None.
1101 --is-up <True|true|False|false>
1103 Filter by up/down status. Default=None.
1104 --disabled <True|true|False|false>
1106 Filter by disabled status. Default=None.
1107 --num-hosts <num-hosts>
1109 Filter by number of hosts in the cluster.
1110 --num-down-hosts <num-down-hosts>
1112 Filter by number of hosts that are down.
1113 --detailed None
1115 Get detailed clustered service information (Default=False).
1116 cinder cluster-show
1118 usage: cinder cluster-show [<binary>] <cluster-name>
1119 Show detailed information on a clustered service.
1121 Positional arguments:
1123 <binary>
1125 Binary to filter by. Default: cinder-volume.
1126 <cluster-name>
1128 Name of the clustered service to show.
1129 cinder consisgroup-create
1131 usage: cinder consisgroup-create [--name <name>] [--description <description>]
1132 [--availability-zone <availability-zone>]
1133 <volume-types>
1134 Creates a consistency group.
1136 Positional arguments:
1138 <volume-types>
1140 Volume types.
1141 Optional arguments:
1143 --name <name>
1145 Name of a consistency group.
1146 --description <description>
1148 Description of a consistency group. Default=None.
1149 --availability-zone <availability-zone>
1151 Availability zone for volume. Default=None.
1152 cinder consisgroup-create-from-src
1154 usage: cinder consisgroup-create-from-src [--cgsnapshot <cgsnapshot>]
1155 [--source-cg <source-cg>]
1156 [--name <name>]
1157 [--description <description>]
1158 Creates a consistency group from a cgsnapshot or a source CG.
1160 Optional arguments:
1162 --cgsnapshot <cgsnapshot>
1164 Name or ID of a cgsnapshot. Default=None.
1165 --source-cg <source-cg>
1167 Name or ID of a source CG. Default=None.
1168 --name <name>
1170 Name of a consistency group. Default=None.
1171 --description <description>
1173 Description of a consistency group. Default=None.
1174 cinder consisgroup-delete
1176 usage: cinder consisgroup-delete [--force]
1177 <consistencygroup> [<consistencygroup> ...]
1178 Removes one or more consistency groups.
1180 Positional arguments:
1182 <consistencygroup>
1184 Name or ID of one or more consistency groups to be deleted.
1185 Optional arguments:
1187 --force None
1189 Allows or disallows consistency groups to be deleted. If the
1190 consistency group is empty, it can be deleted without the force
1191 flag. If the consistency group is not empty, the force flag is
1192 required for it to be deleted.
1193 cinder consisgroup-list
1195 usage: cinder consisgroup-list [--all-tenants [<0|1>]]
1196 Lists all consistency groups.
1198 Optional arguments:
1200 --all-tenants <0|1>
1202 Shows details for all tenants. Admin only.
1203 cinder consisgroup-show
1205 usage: cinder consisgroup-show <consistencygroup>
1206 Shows details of a consistency group.
1208 Positional arguments:
1210 <consistencygroup>
1212 Name or ID of a consistency group.
1213 cinder consisgroup-update
1215 usage: cinder consisgroup-update [--name <name>] [--description <description>]
1216 [--add-volumes <uuid1,uuid2,......>]
1217 [--remove-volumes <uuid3,uuid4,......>]
1218 <consistencygroup>
1219 Updates a consistency group.
1221 Positional arguments:
1223 <consistencygroup>
1225 Name or ID of a consistency group.
1226 Optional arguments:
1228 --name <name>
1230 New name for consistency group. Default=None.
1231 --description <description>
1233 New description for consistency group. Default=None.
1234 --add-volumes <uuid1,uuid2,......>
1236 UUID of one or more volumes to be added to the consistency
1237 group, separated by commas. Default=None.
1238 --remove-volumes <uuid3,uuid4,......>
1240 UUID of one or more volumes to be removed from the consistency
1241 group, separated by commas. Default=None.
1242 cinder create
1244 usage: cinder create [--consisgroup-id <consistencygroup-id>]
1245 [--group-id <group-id>] [--snapshot-id <snapshot-id>]
1246 [--source-volid <source-volid>] [--image-id <image-id>]
1247 [--image <image>] [--backup-id <backup-id>]
1248 [--name <name>] [--description <description>]
1249 [--volume-type <volume-type>]
1250 [--availability-zone <availability-zone>]
1251 [--metadata [<key=value> ...]] [--hint <key=value>]
1252 [--poll]
1253 [<size>]
1254 Creates a volume.
1256 Positional arguments:
1258 <size> Size of volume, in GiBs. (Required unless snap‐
1260 shot-id/source-volid/backup-id is specified).
1261 Optional arguments:
1263 --consisgroup-id <consistencygroup-id>
1265 ID of a consistency group where the new volume belongs to. De‐
1266 fault=None.
1267 --group-id <group-id>
1269 ID of a group where the new volume belongs to. Default=None.
1270 --snapshot-id <snapshot-id>
1272 Creates volume from snapshot ID. Default=None.
1273 --source-volid <source-volid>
1275 Creates volume from volume ID. Default=None.
1276 --image-id <image-id>
1278 Creates volume from image ID. Default=None.
1279 --image <image>
1281 Creates a volume from image (ID or name). Default=None.
1282 --backup-id <backup-id>
1284 Creates a volume from backup ID. Default=None.
1285 --name <name>
1287 Volume name. Default=None.
1288 --description <description>
1290 Volume description. Default=None.
1291 --volume-type <volume-type>
1293 Volume type. Default=None.
1294 --availability-zone <availability-zone>
1296 Availability zone for volume. Default=None.
1297 --metadata <key=value>
1299 Metadata key and value pairs. Default=None.
1300 --hint <key=value>
1302 Scheduler hint, similar to nova. Repeat option to set multiple
1303 hints. Values with the same key will be stored as a list.
1304 --poll None
1306 Wait for volume creation until it completes.
1307 cinder default-type-list
1309 usage: cinder default-type-list [--project-id <project_id>]
1310 Lists all default volume types.
1312 Optional arguments:
1314 --project-id <project_id>
1316 ID of project for which to show the default type.
1317 cinder default-type-set
1319 usage: cinder default-type-set <volume_type> <project_id>
1320 Sets a default volume type for a project.
1322 Positional arguments:
1324 <volume_type>
1326 Name or ID of the volume type.
1327 <project_id>
1329 ID of project for which to set default type.
1330 cinder default-type-unset
1332 usage: cinder default-type-unset <project_id> [<project_id> ...]
1333 Unset default volume types.
1335 Positional arguments:
1337 <project_id>
1339 ID of project for which to unset default type.
1340 cinder delete
1342 usage: cinder delete [--cascade] <volume> [<volume> ...]
1343 Removes one or more volumes.
1345 Positional arguments:
1347 <volume>
1349 Name or ID of volume or volumes to delete.
1350 Optional arguments:
1352 --cascade None
1354 Remove any snapshots along with volume. Default=False.
1355 cinder encryption-type-create
1357 usage: cinder encryption-type-create [--cipher <cipher>]
1358 [--key-size <key_size>]
1359 [--control-location <control_location>]
1360 <volume_type> <provider>
1361 Creates encryption type for a volume type. Admin only.
1363 Positional arguments:
1365 <volume_type>
1367 Name or ID of volume type.
1368 <provider>
1370 The encryption provider format. For example, "luks" or "plain".
1371 Optional arguments:
1373 --cipher <cipher>
1375 The encryption algorithm or mode. For example, aes-xts-plain64.
1376 Default=None.
1377 --key-size <key_size>
1379 Size of encryption key, in bits. For example, 128 or 256. De‐
1380 fault=None.
1381 --control-location <control_location>
1383 Notional service where encryption is performed. Valid values are
1384 "front-end" or "back-end". For example, front-end=Nova. Default
1385 is "front-end".
1386 cinder encryption-type-delete
1388 usage: cinder encryption-type-delete <volume_type>
1389 Deletes encryption type for a volume type. Admin only.
1391 Positional arguments:
1393 <volume_type>
1395 Name or ID of volume type.
1396 cinder encryption-type-list
1398 usage: cinder encryption-type-list
1399 Shows encryption type details for volume types. Admin only.
1401 cinder encryption-type-show
1403 usage: cinder encryption-type-show <volume_type>
1404 Shows encryption type details for a volume type. Admin only.
1406 Positional arguments:
1408 <volume_type>
1410 Name or ID of volume type.
1411 cinder encryption-type-update
1413 usage: cinder encryption-type-update [--provider <provider>]
1414 [--cipher [<cipher>]]
1415 [--key-size [<key-size>]]
1416 [--control-location <control-location>]
1417 <volume-type>
1418 Update encryption type information for a volume type (Admin Only).
1420 Positional arguments:
1422 <volume-type>
1424 Name or ID of the volume type
1425 Optional arguments:
1427 --provider <provider>
1429 Encryption provider format (e.g. 'luks' or 'plain').
1430 --cipher <cipher>
1432 Encryption algorithm/mode to use (e.g., aes-xts-plain64). Pro‐
1433 vide parameter without value to set to provider default.
1434 --key-size <key-size>
1436 Size of the encryption key, in bits (e.g., 128, 256). Provide
1437 parameter without value to set to provider default.
1438 --control-location <control-location>
1440 Notional service where encryption is performed (e.g.,
1441 front-end=Nova). Values: 'front-end', 'back-end'
1442 cinder extend
1444 usage: cinder extend <volume> <new_size>
1445 Attempts to extend size of an existing volume.
1447 Positional arguments:
1449 <volume>
1451 Name or ID of volume to extend.
1452 <new_size>
1454 New size of volume, in GiBs.
1455 cinder extra-specs-list
1457 usage: cinder extra-specs-list
1458 Lists current volume types and extra specs.
1460 cinder failover-host
1462 usage: cinder failover-host [--backend_id <backend-id>] <hostname>
1463 Failover a replicating cinder-volume host.
1465 Positional arguments:
1467 <hostname>
1469 Host name.
1470 Optional arguments:
1472 --backend_id <backend-id>
1474 ID of backend to failover to (Default=None)
1475 cinder force-delete
1477 usage: cinder force-delete <volume> [<volume> ...]
1478 Attempts force-delete of volume, regardless of state.
1480 Positional arguments:
1482 <volume>
1484 Name or ID of volume or volumes to delete.
1485 cinder freeze-host
1487 usage: cinder freeze-host <hostname>
1488 Freeze and disable the specified cinder-volume host.
1490 Positional arguments:
1492 <hostname>
1494 Host name.
1495 cinder get-capabilities
1497 usage: cinder get-capabilities <host>
1498 Show backend volume stats and properties. Admin only.
1500 Positional arguments:
1502 <host> Cinder host to show backend volume stats and properties; takes
1504 the form: host@backend-name
1505 cinder get-pools
1507 usage: cinder get-pools [--detail] [--filters [<key=value> ...]]
1508 Show pool information for backends. Admin only.
1510 Optional arguments:
1512 --detail None
1514 Show detailed information about pools.
1515 --filters <key=value>
1517 Filter key and value pairs. Please use 'cinder list-filters' to
1518 check enabled filters from server, Default=None.
1519 cinder group-create
1521 usage: cinder group-create [--name <name>] [--description <description>]
1522 [--availability-zone <availability-zone>]
1523 <group-type> <volume-types>
1524 Creates a group.
1526 Positional arguments:
1528 <group-type>
1530 Group type.
1531 <volume-types>
1533 Comma-separated list of volume types.
1534 Optional arguments:
1536 --name <name>
1538 Name of a group.
1539 --description <description>
1541 Description of a group. Default=None.
1542 --availability-zone <availability-zone>
1544 Availability zone for group. Default=None.
1545 cinder group-create-from-src
1547 usage: cinder group-create-from-src [--group-snapshot <group-snapshot>]
1548 [--source-group <source-group>]
1549 [--name <name>]
1550 [--description <description>]
1551 Creates a group from a group snapshot or a source group.
1553 Optional arguments:
1555 --group-snapshot <group-snapshot>
1557 Name or ID of a group snapshot. Default=None.
1558 --source-group <source-group>
1560 Name or ID of a source group. Default=None.
1561 --name <name>
1563 Name of a group. Default=None.
1564 --description <description>
1566 Description of a group. Default=None.
1567 cinder group-delete
1569 usage: cinder group-delete [--delete-volumes] <group> [<group> ...]
1570 Removes one or more groups.
1572 Positional arguments:
1574 <group>
1576 Name or ID of one or more groups to be deleted.
1577 Optional arguments:
1579 --delete-volumes None
1581 Allows or disallows groups to be deleted if they are not empty.
1582 If the group is empty, it can be deleted without the delete-vol‐
1583 umes flag. If the group is not empty, the delete-volumes flag is
1584 required for it to be deleted. If True, all volumes in the group
1585 will also be deleted.
1586 cinder group-disable-replication
1588 usage: cinder group-disable-replication <group>
1589 Disables replication for group.
1591 Positional arguments:
1593 <group>
1595 Name or ID of the group.
1596 cinder group-enable-replication
1598 usage: cinder group-enable-replication <group>
1599 Enables replication for group.
1601 Positional arguments:
1603 <group>
1605 Name or ID of the group.
1606 cinder group-failover-replication
1608 usage: cinder group-failover-replication [--allow-attached-volume]
1609 [--secondary-backend-id <secondary_backend_id>]
1610 <group>
1611 Fails over replication for group.
1613 Positional arguments:
1615 <group>
1617 Name or ID of the group.
1618 Optional arguments:
1620 --allow-attached-volume None
1622 Allows or disallows group with attached volumes to be failed
1623 over.
1624 --secondary-backend-id <secondary_backend_id>
1626 Secondary backend id. Default=None.
1627 cinder group-list
1629 usage: cinder group-list [--all-tenants [<0|1>]] [--filters [<key=value> ...]]
1630 Lists all groups.
1632 Optional arguments:
1634 --all-tenants <0|1>
1636 Shows details for all tenants. Admin only.
1637 --filters <key=value>
1639 Filter key and value pairs. Please use 'cinder list-filters' to
1640 check enabled filters from server. Use 'key~=value' for inexact
1641 filtering if the key supports. Default=None.
1642 cinder group-list-replication-targets
1644 usage: cinder group-list-replication-targets <group>
1645 Lists replication targets for group.
1647 Positional arguments:
1649 <group>
1651 Name or ID of the group.
1652 cinder group-show
1654 usage: cinder group-show [--list-volume [<False|True>]] <group>
1655 Shows details of a group.
1657 Positional arguments:
1659 <group>
1661 Name or ID of a group.
1662 Optional arguments:
1664 --list-volume <False|True>
1666 Shows volumes included in the group.
1667 cinder group-snapshot-create
1669 usage: cinder group-snapshot-create [--name <name>]
1670 [--description <description>]
1671 <group>
1672 Creates a group snapshot.
1674 Positional arguments:
1676 <group>
1678 Name or ID of a group.
1679 Optional arguments:
1681 --name <name>
1683 Group snapshot name. Default=None.
1684 --description <description>
1686 Group snapshot description. Default=None.
1687 cinder group-snapshot-delete
1689 usage: cinder group-snapshot-delete <group_snapshot> [<group_snapshot> ...]
1690 Removes one or more group snapshots.
1692 Positional arguments:
1694 <group_snapshot>
1696 Name or ID of one or more group snapshots to be deleted.
1697 cinder group-snapshot-list
1699 usage: cinder group-snapshot-list [--all-tenants [<0|1>]] [--status <status>]
1700 [--group-id <group_id>]
1701 [--filters [<key=value> ...]]
1702 Lists all group snapshots.
1704 Optional arguments:
1706 --all-tenants <0|1>
1708 Shows details for all tenants. Admin only.
1709 --status <status>
1711 Filters results by a status. Default=None. This option is depre‐
1712 cated and will be removed in newer release. Please use '--fil‐
1713 ters' option which is introduced since 3.33 instead.
1714 --group-id <group_id>
1716 Filters results by a group ID. Default=None. This option is dep‐
1717 recated and will be removed in newer release. Please use '--fil‐
1718 ters' option which is introduced since 3.33 instead.
1719 --filters <key=value>
1721 Filter key and value pairs. Please use 'cinder list-filters' to
1722 check enabled filters from server. Use 'key~=value' for inexact
1723 filtering if the key supports. Default=None.
1724 cinder group-snapshot-show
1726 usage: cinder group-snapshot-show <group_snapshot>
1727 Shows group snapshot details.
1729 Positional arguments:
1731 <group_snapshot>
1733 Name or ID of group snapshot.
1734 cinder group-specs-list
1736 usage: cinder group-specs-list
1737 Lists current group types and specs.
1739 cinder group-type-create
1741 usage: cinder group-type-create [--description <description>]
1742 [--is-public <is-public>]
1743 <name>
1744 Creates a group type.
1746 Positional arguments:
1748 <name> Name of new group type.
1750 Optional arguments:
1752 --description <description>
1754 Description of new group type.
1755 --is-public <is-public>
1757 Make type accessible to the public (default true).
1758 cinder group-type-default
1760 usage: cinder group-type-default
1761 List the default group type.
1763 cinder group-type-delete
1765 usage: cinder group-type-delete <group_type> [<group_type> ...]
1766 Deletes group type or types.
1768 Positional arguments:
1770 <group_type>
1772 Name or ID of group type or types to delete.
1773 cinder group-type-key
1775 usage: cinder group-type-key <gtype> <action> <key=value> [<key=value> ...]
1776 Sets or unsets group_spec for a group type.
1778 Positional arguments:
1780 <gtype>
1782 Name or ID of group type.
1783 <action>
1785 The action. Valid values are "set" or "unset."
1786 <key=value>
1788 The group specs key and value pair to set or unset. For unset,
1789 specify only the key.
1790 cinder group-type-list
1792 usage: cinder group-type-list [--filters [<key=value> ...]]
1793 Lists available 'group types'. (Admin only will see private types)
1795 Optional arguments:
1797 --filters <key=value>
1799 Filter key and value pairs. Admin only.
1800 cinder group-type-show
1802 usage: cinder group-type-show <group_type>
1803 Show group type details.
1805 Positional arguments:
1807 <group_type>
1809 Name or ID of the group type.
1810 cinder group-type-update
1812 usage: cinder group-type-update [--name <name>] [--description <description>]
1813 [--is-public <is-public>]
1814 <id>
1815 Updates group type name, description, and/or is_public.
1817 Positional arguments:
1819 <id> ID of the group type.
1821 Optional arguments:
1823 --name <name>
1825 Name of the group type.
1826 --description <description>
1828 Description of the group type.
1829 --is-public <is-public>
1831 Make type accessible to the public or not.
1832 cinder group-update
1834 usage: cinder group-update [--name <name>] [--description <description>]
1835 [--add-volumes <uuid1,uuid2,......>]
1836 [--remove-volumes <uuid3,uuid4,......>]
1837 <group>
1838 Updates a group.
1840 Positional arguments:
1842 <group>
1844 Name or ID of a group.
1845 Optional arguments:
1847 --name <name>
1849 New name for group. Default=None.
1850 --description <description>
1852 New description for group. Default=None.
1853 --add-volumes <uuid1,uuid2,......>
1855 UUID of one or more volumes to be added to the group, separated
1856 by commas. Default=None.
1857 --remove-volumes <uuid3,uuid4,......>
1859 UUID of one or more volumes to be removed from the group, sepa‐
1860 rated by commas. Default=None.
1861 cinder image-metadata
1863 usage: cinder image-metadata <volume> <action> <key=value> [<key=value> ...]
1864 Sets or deletes volume image metadata.
1866 Positional arguments:
1868 <volume>
1870 Name or ID of volume for which to update metadata.
1871 <action>
1873 The action. Valid values are 'set' or 'unset.'
1874 <key=value>
1876 Metadata key and value pair to set or unset. For unset, specify
1877 only the key.
1878 cinder image-metadata-show
1880 usage: cinder image-metadata-show <volume>
1881 Shows volume image metadata.
1883 Positional arguments:
1885 <volume>
1887 ID of volume.
1888 cinder list
1890 usage: cinder list [--group_id <group_id>] [--all-tenants [<0|1>]]
1891 [--name <name>] [--status <status>]
1892 [--bootable [<True|true|False|false>]]
1893 [--migration_status <migration_status>]
1894 [--metadata [<key=value> ...]]
1895 [--image_metadata [<key=value> ...]] [--marker <marker>]
1896 [--limit <limit>] [--fields <fields>]
1897 [--sort <key>[:<direction>]] [--tenant [<tenant>]]
1898 [--filters [<key=value> ...]] [--with-count [<True|False>]]
1899 Lists all volumes.
1901 Optional arguments:
1903 --group_id <group_id>
1905 Filters results by a group_id. Default=None.This option is dep‐
1906 recated and will be removed in newer release. Please use '--fil‐
1907 ters' option which is introduced since 3.33 instead.
1908 --all-tenants <0|1>
1910 Shows details for all tenants. Admin only.
1911 --name <name>
1913 Filters results by a name. Default=None. This option is depre‐
1914 cated and will be removed in newer release. Please use '--fil‐
1915 ters' option which is introduced since 3.33 instead.
1916 --status <status>
1918 Filters results by a status. Default=None. This option is depre‐
1919 cated and will be removed in newer release. Please use '--fil‐
1920 ters' option which is introduced since 3.33 instead.
1921 --bootable <True|true|False|false>
1923 Filters results by bootable status. Default=None. This option is
1924 deprecated and will be removed in newer release. Please use
1925 '--filters' option which is introduced since 3.33 instead.
1926 --migration_status <migration_status>
1928 Filters results by a migration status. Default=None. Admin only.
1929 This option is deprecated and will be removed in newer release.
1930 Please use '--filters' option which is introduced since 3.33 in‐
1931 stead.
1932 --metadata <key=value>
1934 Filters results by a metadata key and value pair. Default=None.
1935 This option is deprecated and will be removed in newer release.
1936 Please use '--filters' option which is introduced since 3.33 in‐
1937 stead.
1938 --image_metadata <key=value>
1940 Filters results by a image metadata key and value pair. Require
1941 volume api version >=3.4. Default=None.This option is deprecated
1942 and will be removed in newer release. Please use '--filters' op‐
1943 tion which is introduced since 3.33 instead.
1944 --marker <marker>
1946 Begin returning volumes that appear later in the volume list
1947 than that represented by this volume id. Default=None.
1948 --limit <limit>
1950 Maximum number of volumes to return. Default=None.
1951 --fields <fields>
1953 Comma-separated list of fields to display. Use the show command
1954 to see which fields are available. Unavailable/non-existent
1955 fields will be ignored. Default=None.
1956 --sort <key>[:<direction>]
1958 Comma-separated list of sort keys and directions in the form of
1959 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
1960 ity_zone, name, bootable, created_at, reference. Default=None.
1961 --tenant <tenant>
1963 Display information from single tenant (Admin only).
1964 --filters <key=value>
1966 Filter key and value pairs. Please use 'cinder list-filters' to
1967 check enabled filters from server. Use 'key~=value' for inexact
1968 filtering if the key supports. Default=None.
1969 --with-count <True|False>
1971 Show total number of volume entities. This is useful when pagi‐
1972 nation is applied in the request.
1973 cinder list-filters
1975 usage: cinder list-filters [--resource <resource>]
1976 List enabled filters.
1978 Optional arguments:
1980 --resource <resource>
1982 Show enabled filters for specified resource. Default=None.
1983 cinder manage
1985 usage: cinder manage [--cluster CLUSTER] [--id-type <id-type>] [--name <name>]
1986 [--description <description>]
1987 [--volume-type <volume-type>]
1988 [--availability-zone <availability-zone>]
1989 [--metadata [<key=value> ...]] [--bootable]
1990 <host> <identifier>
1991 Manage an existing volume.
1993 Positional arguments:
1995 <host> Cinder host on which the existing volume resides; takes the
1997 form: host@backend-name#pool
1998 <identifier>
2000 Name or other Identifier for existing volume
2001 Optional arguments:
2003 --cluster None
2005 Cinder cluster on which the existing volume resides; takes the
2006 form: cluster@backend-name#pool
2007 --id-type <id-type>
2009 Type of backend device identifier provided, typically
2010 source-name or source-id (Default=source-name)
2011 --name <name>
2013 Volume name (Default=None)
2014 --description <description>
2016 Volume description (Default=None)
2017 --volume-type <volume-type>
2019 Volume type (Default=None)
2020 --availability-zone <availability-zone>
2022 Availability zone for volume (Default=None)
2023 --metadata <key=value>
2025 Metadata key=value pairs (Default=None)
2026 --bootable None
2028 Specifies that the newly created volume should be marked as
2029 bootable
2030 cinder manageable-list
2032 usage: cinder manageable-list [--detailed <detailed>] [--marker <marker>]
2033 [--limit <limit>] [--offset <offset>]
2034 [--sort <key>[:<direction>]] [--cluster CLUSTER]
2035 [<host>]
2036 Lists all manageable volumes.
2038 Positional arguments:
2040 <host> Cinder host on which to list manageable volumes; takes the form:
2042 host@backend-name#pool
2043 Optional arguments:
2045 --detailed <detailed>
2047 Returned detailed information (default true).
2048 --marker <marker>
2050 Begin returning volumes that appear later in the volume list
2051 than that represented by this reference. This reference should
2052 be json like. Default=None.
2053 --limit <limit>
2055 Maximum number of volumes to return. Default=None.
2056 --offset <offset>
2058 Number of volumes to skip after marker. Default=None.
2059 --sort <key>[:<direction>]
2061 Comma-separated list of sort keys and directions in the form of
2062 <key>[:<asc|desc>]. Valid keys: size, reference. Default=None.
2063 --cluster CLUSTER
2065 Cinder cluster on which to list manageable volumes; takes the
2066 form: cluster@backend-name#pool
2067 cinder message-delete
2069 usage: cinder message-delete <message> [<message> ...]
2070 Removes one or more messages.
2072 Positional arguments:
2074 <message>
2076 ID of one or more message to be deleted.
2077 cinder message-list
2079 usage: cinder message-list [--marker <marker>] [--limit <limit>]
2080 [--sort <key>[:<direction>]]
2081 [--resource_uuid <resource_uuid>]
2082 [--resource_type <type>] [--event_id <id>]
2083 [--request_id <request_id>] [--level <level>]
2084 [--filters [<key=value> ...]]
2085 Lists all messages.
2087 Optional arguments:
2089 --marker <marker>
2091 Begin returning message that appear later in the message list
2092 than that represented by this id. Default=None.
2093 --limit <limit>
2095 Maximum number of messages to return. Default=None.
2096 --sort <key>[:<direction>]
2098 Comma-separated list of sort keys and directions in the form of
2099 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
2100 ity_zone, name, bootable, created_at, reference. Default=None.
2101 --resource_uuid <resource_uuid>
2103 Filters results by a resource uuid. Default=None. This option is
2104 deprecated and will be removed in newer release. Please use
2105 '--filters' option which is introduced since 3.33 instead.
2106 --resource_type <type>
2108 Filters results by a resource type. Default=None. This option is
2109 deprecated and will be removed in newer release. Please use
2110 '--filters' option which is introduced since 3.33 instead.
2111 --event_id <id>
2113 Filters results by event id. Default=None. This option is depre‐
2114 cated and will be removed in newer release. Please use '--fil‐
2115 ters' option which is introduced since 3.33 instead.
2116 --request_id <request_id>
2118 Filters results by request id. Default=None. This option is dep‐
2119 recated and will be removed in newer release. Please use '--fil‐
2120 ters' option which is introduced since 3.33 instead.
2121 --level <level>
2123 Filters results by the message level. Default=None. This option
2124 is deprecated and will be removed in newer release. Please use
2125 '--filters' option which is introduced since 3.33 instead.
2126 --filters <key=value>
2128 Filter key and value pairs. Please use 'cinder list-filters' to
2129 check enabled filters from server. Use 'key~=value' for inexact
2130 filtering if the key supports. Default=None.
2131 cinder message-show
2133 usage: cinder message-show <message>
2134 Shows message details.
2136 Positional arguments:
2138 <message>
2140 ID of message.
2141 cinder metadata
2143 usage: cinder metadata <volume> <action> <key=value> [<key=value> ...]
2144 Sets or deletes volume metadata.
2146 Positional arguments:
2148 <volume>
2150 Name or ID of volume for which to update metadata.
2151 <action>
2153 The action. Valid values are "set" or "unset."
2154 <key=value>
2156 Metadata key and value pair to set or unset. For unset, specify
2157 only the key(s): <key key>
2158 cinder metadata-show
2160 usage: cinder metadata-show <volume>
2161 Shows volume metadata.
2163 Positional arguments:
2165 <volume>
2167 ID of volume.
2168 cinder metadata-update-all
2170 usage: cinder metadata-update-all <volume> <key=value> [<key=value> ...]
2171 Updates volume metadata.
2173 Positional arguments:
2175 <volume>
2177 ID of volume for which to update metadata.
2178 <key=value>
2180 Metadata key and value pair or pairs to update.
2181 cinder migrate
2183 usage: cinder migrate [--force-host-copy [<True|False>]]
2184 [--lock-volume [<True|False>]] [--cluster CLUSTER]
2185 <volume> [<host>]
2186 Migrates volume to a new host.
2188 Positional arguments:
2190 <volume>
2192 ID of volume to migrate.
2193 <host> Destination host. Takes the form: host@backend-name#pool
2195 Optional arguments:
2197 --force-host-copy <True|False>
2199 Enables or disables generic host-based force-migration, which
2200 bypasses driver optimizations. Default=False.
2201 --lock-volume <True|False>
2203 Enables or disables the termination of volume migration caused
2204 by other commands. This option applies to the available volume.
2205 True means it locks the volume state and does not allow the mi‐
2206 gration to be aborted. The volume status will be in maintenance
2207 during the migration. False means it allows the volume migration
2208 to be aborted. The volume status is still in the original sta‐
2209 tus. Default=False.
2210 --cluster None
2212 Destination cluster. Takes the form: cluster@backend-name#pool
2213 cinder qos-associate
2215 usage: cinder qos-associate <qos_specs> <volume_type_id>
2216 Associates qos specs with specified volume type.
2218 Positional arguments:
2220 <qos_specs>
2222 ID of QoS specifications.
2223 <volume_type_id>
2225 ID of volume type with which to associate QoS specifications.
2226 cinder qos-create
2228 usage: cinder qos-create <name> <key=value> [<key=value> ...]
2229 Creates a qos specs.
2231 Positional arguments:
2233 <name> Name of new QoS specifications.
2235 <key=value>
2237 QoS specifications.
2238 cinder qos-delete
2240 usage: cinder qos-delete [--force [<True|False>]] <qos_specs>
2241 Deletes a specified qos specs.
2243 Positional arguments:
2245 <qos_specs>
2247 ID of QoS specifications to delete.
2248 Optional arguments:
2250 --force <True|False>
2252 Enables or disables deletion of in-use QoS specifications. De‐
2253 fault=False.
2254 cinder qos-disassociate
2256 usage: cinder qos-disassociate <qos_specs> <volume_type_id>
2257 Disassociates qos specs from specified volume type.
2259 Positional arguments:
2261 <qos_specs>
2263 ID of QoS specifications.
2264 <volume_type_id>
2266 ID of volume type with which to associate QoS specifications.
2267 cinder qos-disassociate-all
2269 usage: cinder qos-disassociate-all <qos_specs>
2270 Disassociates qos specs from all its associations.
2272 Positional arguments:
2274 <qos_specs>
2276 ID of QoS specifications on which to operate.
2277 cinder qos-get-association
2279 usage: cinder qos-get-association <qos_specs>
2280 Lists all associations for specified qos specs.
2282 Positional arguments:
2284 <qos_specs>
2286 ID of QoS specifications.
2287 cinder qos-key
2289 usage: cinder qos-key <qos_specs> <action> key=value [key=value ...]
2290 Sets or unsets specifications for a qos spec.
2292 Positional arguments:
2294 <qos_specs>
2296 ID of QoS specifications.
2297 <action>
2299 The action. Valid values are "set" or "unset."
2300 key=value
2302 Metadata key and value pair to set or unset. For unset, specify
2303 only the key.
2304 cinder qos-list
2306 usage: cinder qos-list
2307 Lists qos specs.
2309 cinder qos-show
2311 usage: cinder qos-show <qos_specs>
2312 Shows qos specs details.
2314 Positional arguments:
2316 <qos_specs>
2318 ID of QoS specifications to show.
2319 cinder quota-class-show
2321 usage: cinder quota-class-show <class>
2322 Lists quotas for a quota class.
2324 Positional arguments:
2326 <class>
2328 Name of quota class for which to list quotas.
2329 cinder quota-class-update
2331 usage: cinder quota-class-update [--volumes <volumes>]
2332 [--snapshots <snapshots>]
2333 [--gigabytes <gigabytes>]
2334 [--backups <backups>]
2335 [--backup-gigabytes <backup_gigabytes>]
2336 [--volume-type <volume_type_name>]
2337 [--per-volume-gigabytes <per_volume_gigabytes>]
2338 <class_name>
2339 Updates quotas for a quota class.
2341 Positional arguments:
2343 <class_name>
2345 Name of quota class for which to set quotas.
2346 Optional arguments:
2348 --volumes <volumes>
2350 The new "volumes" quota value. Default=None.
2351 --snapshots <snapshots>
2353 The new "snapshots" quota value. Default=None.
2354 --gigabytes <gigabytes>
2356 The new "gigabytes" quota value. Default=None.
2357 --backups <backups>
2359 The new "backups" quota value. Default=None.
2360 --backup-gigabytes <backup_gigabytes>
2362 The new "backup_gigabytes" quota value. Default=None.
2363 --volume-type <volume_type_name>
2365 Volume type. Default=None.
2366 --per-volume-gigabytes <per_volume_gigabytes>
2368 Set max volume size limit. Default=None.
2369 cinder quota-defaults
2371 usage: cinder quota-defaults <tenant_id>
2372 Lists default quotas for a tenant.
2374 Positional arguments:
2376 <tenant_id>
2378 ID of tenant for which to list quota defaults.
2379 cinder quota-delete
2381 usage: cinder quota-delete <tenant_id>
2382 Delete the quotas for a tenant.
2384 Positional arguments:
2386 <tenant_id>
2388 UUID of tenant to delete the quotas for.
2389 cinder quota-show
2391 usage: cinder quota-show <tenant_id>
2392 Lists quotas for a tenant.
2394 Positional arguments:
2396 <tenant_id>
2398 ID of tenant for which to list quotas.
2399 cinder quota-update
2401 usage: cinder quota-update [--volumes <volumes>] [--snapshots <snapshots>]
2402 [--gigabytes <gigabytes>] [--backups <backups>]
2403 [--backup-gigabytes <backup_gigabytes>]
2404 [--groups <groups>]
2405 [--volume-type <volume_type_name>]
2406 [--per-volume-gigabytes <per_volume_gigabytes>]
2407 [--skip-validation <skip_validation>]
2408 <tenant_id>
2409 Updates quotas for a tenant.
2411 Positional arguments:
2413 <tenant_id>
2415 ID of tenant for which to set quotas.
2416 Optional arguments:
2418 --volumes <volumes>
2420 The new "volumes" quota value. Default=None.
2421 --snapshots <snapshots>
2423 The new "snapshots" quota value. Default=None.
2424 --gigabytes <gigabytes>
2426 The new "gigabytes" quota value. Default=None.
2427 --backups <backups>
2429 The new "backups" quota value. Default=None.
2430 --backup-gigabytes <backup_gigabytes>
2432 The new "backup_gigabytes" quota value. Default=None.
2433 --groups <groups>
2435 The new "groups" quota value. Default=None.
2436 --volume-type <volume_type_name>
2438 Volume type. Default=None.
2439 --per-volume-gigabytes <per_volume_gigabytes>
2441 Set max volume size limit. Default=None.
2442 --skip-validation <skip_validation>
2444 Skip validate the existing resource quota. Default=False.
2445 cinder quota-usage
2447 usage: cinder quota-usage <tenant_id>
2448 Lists quota usage for a tenant.
2450 Positional arguments:
2452 <tenant_id>
2454 ID of tenant for which to list quota usage.
2455 cinder rate-limits
2457 usage: cinder rate-limits [<tenant_id>]
2458 Lists rate limits for a user.
2460 Positional arguments:
2462 <tenant_id>
2464 Display information for a single tenant (Admin only).
2465 cinder readonly-mode-update
2467 usage: cinder readonly-mode-update <volume> <True|true|False|false>
2468 Updates volume read-only access-mode flag.
2470 Positional arguments:
2472 <volume>
2474 ID of volume to update.
2475 <True|true|False|false>
2477 Enables or disables update of volume to read-only access mode.
2478 cinder rename
2480 usage: cinder rename [--description <description>] <volume> [<name>]
2481 Renames a volume.
2483 Positional arguments:
2485 <volume>
2487 Name or ID of volume to rename.
2488 <name> New name for volume.
2490 Optional arguments:
2492 --description <description>
2494 Volume description. Default=None.
2495 cinder reset-state
2497 usage: cinder reset-state [--type <type>] [--state <state>]
2498 [--attach-status <attach-status>]
2499 [--reset-migration-status]
2500 <entity> [<entity> ...]
2501 Explicitly updates the entity state in the Cinder database.
2503 Positional arguments:
2505 <entity>
2507 Name or ID of entity to update.
2508 Optional arguments:
2510 --type <type>
2512 Type of entity to update. Available resources are: 'volume',
2513 'snapshot', 'backup', 'group' (since 3.20) and 'group-snapshot'
2514 (since 3.19), Default=volume.
2515 --state <state>
2517 The state to assign to the entity. NOTE: This command simply
2518 changes the state of the entity in the database with no regard
2519 to actual status, exercise caution when using. Default=None,
2520 that means the state is unchanged.
2521 --attach-status <attach-status>
2523 This is only used for a volume entity. The attach status to as‐
2524 sign to the volume in the database, with no regard to the actual
2525 status. Valid values are "attached" and "detached". De‐
2526 fault=None, that means the status is unchanged.
2527 --reset-migration-status None
2529 This is only used for a volume entity. Clears the migration sta‐
2530 tus of the volume in the DataBase that indicates the volume is
2531 source or destination of volume migration, with no regard to the
2532 actual status.
2533 cinder retype
2535 usage: cinder retype [--migration-policy <never|on-demand>]
2536 <volume> <volume-type>
2537 Changes the volume type for a volume.
2539 Positional arguments:
2541 <volume>
2543 Name or ID of volume for which to modify type.
2544 <volume-type>
2546 New volume type.
2547 Optional arguments:
2549 --migration-policy <never|on-demand>
2551 Migration policy during retype of volume.
2552 cinder revert-to-snapshot
2554 usage: cinder revert-to-snapshot <snapshot>
2555 Revert a volume to the specified snapshot.
2557 Positional arguments:
2559 <snapshot>
2561 Name or ID of the snapshot to restore. The snapshot must be the
2562 most recent one known to cinder.
2563 cinder service-disable
2565 usage: cinder service-disable [--reason <reason>] <hostname> <binary>
2566 Disables the service.
2568 Positional arguments:
2570 <hostname>
2572 Host name.
2573 <binary>
2575 Service binary.
2576 Optional arguments:
2578 --reason <reason>
2580 Reason for disabling service.
2581 cinder service-enable
2583 usage: cinder service-enable <hostname> <binary>
2584 Enables the service.
2586 Positional arguments:
2588 <hostname>
2590 Host name.
2591 <binary>
2593 Service binary.
2594 cinder service-get-log
2596 usage: cinder service-get-log
2597 [--binary {,*,cinder-api,cinder-volume,cinder-scheduler,cinder-backup}]
2598 [--server SERVER] [--prefix PREFIX]
2599 Gets the service log level.
2601 Optional arguments:
2603 --binary None
2605 Binary to query.
2606 --server None
2608 Host or cluster value for service.
2609 --prefix None
2611 Prefix for the log. ie: "sqlalchemy.".
2612 cinder service-list
2614 usage: cinder service-list [--host <hostname>] [--binary <binary>]
2615 [--withreplication [<True|False>]]
2616 Lists all services. Filter by host and service binary.
2618 Optional arguments:
2620 --host <hostname>
2622 Host name. Default=None.
2623 --binary <binary>
2625 Service binary. Default=None.
2626 --withreplication <True|False>
2628 Enables or disables display of Replication info for c-vol ser‐
2629 vices. Default=False.
2630 cinder service-set-log
2632 usage: cinder service-set-log
2633 [--binary {,*,cinder-api,cinder-volume,cinder-scheduler,cinder-backup}]
2634 [--server SERVER] [--prefix PREFIX]
2635 <log-level>
2636 Sets the service log level.
2638 Positional arguments:
2640 <log-level>
2642 Desired log level.
2643 Optional arguments:
2645 --binary None
2647 Binary to change.
2648 --server None
2650 Host or cluster value for service.
2651 --prefix None
2653 Prefix for the log. ie: "cinder.volume.drivers.".
2654 cinder set-bootable
2656 usage: cinder set-bootable <volume> <True|true|False|false>
2657 Update bootable status of a volume.
2659 Positional arguments:
2661 <volume>
2663 ID of the volume to update.
2664 <True|true|False|false>
2666 Flag to indicate whether volume is bootable.
2667 cinder show
2669 usage: cinder show <volume>
2670 Shows volume details.
2672 Positional arguments:
2674 <volume>
2676 Name or ID of volume.
2677 cinder snapshot-create
2679 usage: cinder snapshot-create [--force [<True|False>]] [--name <name>]
2680 [--description <description>]
2681 [--metadata [<key=value> ...]]
2682 <volume>
2683 Creates a snapshot.
2685 Positional arguments:
2687 <volume>
2689 Name or ID of volume to snapshot.
2690 Optional arguments:
2692 --force <True|False>
2694 Allows or disallows snapshot of a volume when the volume is at‐
2695 tached to an instance. If set to True, ignores the current sta‐
2696 tus of the volume when attempting to snapshot it rather than
2697 forcing it to be available. Default=False.
2698 --name <name>
2700 Snapshot name. Default=None.
2701 --description <description>
2703 Snapshot description. Default=None.
2704 --metadata <key=value>
2706 Snapshot metadata key and value pairs. Default=None.
2707 cinder snapshot-delete
2709 usage: cinder snapshot-delete [--force] <snapshot> [<snapshot> ...]
2710 Removes one or more snapshots.
2712 Positional arguments:
2714 <snapshot>
2716 Name or ID of the snapshot(s) to delete.
2717 Optional arguments:
2719 --force None
2721 Allows deleting snapshot of a volume when its status is other
2722 than "available" or "error". Default=False.
2723 cinder snapshot-list
2725 usage: cinder snapshot-list [--all-tenants [<0|1>]] [--name <name>]
2726 [--status <status>] [--volume-id <volume-id>]
2727 [--marker <marker>] [--limit <limit>]
2728 [--sort <key>[:<direction>]] [--tenant [<tenant>]]
2729 [--metadata [<key=value> ...]]
2730 [--filters [<key=value> ...]]
2731 [--with-count [<True|False>]]
2732 Lists all snapshots.
2734 Optional arguments:
2736 --all-tenants <0|1>
2738 Shows details for all tenants. Admin only.
2739 --name <name>
2741 Filters results by a name. Default=None. This option is depre‐
2742 cated and will be removed in newer release. Please use '--fil‐
2743 ters' option which is introduced since 3.33 instead.
2744 --status <status>
2746 Filters results by a status. Default=None. This option is depre‐
2747 cated and will be removed in newer release. Please use '--fil‐
2748 ters' option which is introduced since 3.33 instead.
2749 --volume-id <volume-id>
2751 Filters results by a volume ID. Default=None. This option is
2752 deprecated and will be removed in newer release. Please use
2753 '--filters' option which is introduced since 3.33 instead.
2754 --marker <marker>
2756 Begin returning snapshots that appear later in the snapshot list
2757 than that represented by this id. Default=None.
2758 --limit <limit>
2760 Maximum number of snapshots to return. Default=None.
2761 --sort <key>[:<direction>]
2763 Comma-separated list of sort keys and directions in the form of
2764 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
2765 ity_zone, name, bootable, created_at, reference. Default=None.
2766 --tenant <tenant>
2768 Display information from single tenant (Admin only).
2769 --metadata <key=value>
2771 Filters results by a metadata key and value pair. Require volume
2772 api version >=3.22. Default=None. This option is deprecated and
2773 will be removed in newer release. Please use '--filters' option
2774 which is introduced since 3.33 instead.
2775 --filters <key=value>
2777 Filter key and value pairs. Please use 'cinder list-filters' to
2778 check enabled filters from server. Use 'key~=value' for inexact
2779 filtering if the key supports. Default=None.
2780 --with-count <True|False>
2782 Show total number of snapshot entities. This is useful when pag‐
2783 ination is applied in the request.
2784 cinder snapshot-manage
2786 usage: cinder snapshot-manage [--id-type <id-type>] [--name <name>]
2787 [--description <description>]
2788 [--metadata [<key=value> ...]]
2789 <volume> <identifier>
2790 Manage an existing snapshot.
2792 Positional arguments:
2794 <volume>
2796 Cinder volume that already exists in the volume backend.
2797 <identifier>
2799 Name or other identifier for existing snapshot. This is backend
2800 specific.
2801 Optional arguments:
2803 --id-type <id-type>
2805 Type of backend device identifier provided, typically
2806 source-name or source-id (Default=source-name).
2807 --name <name>
2809 Snapshot name (Default=None).
2810 --description <description>
2812 Snapshot description (Default=None).
2813 --metadata <key=value>
2815 Metadata key=value pairs (Default=None).
2816 cinder snapshot-manageable-list
2818 usage: cinder snapshot-manageable-list [--detailed <detailed>]
2819 [--marker <marker>] [--limit <limit>]
2820 [--offset <offset>]
2821 [--sort <key>[:<direction>]]
2822 [--cluster CLUSTER]
2823 [<host>]
2824 Lists all manageable snapshots.
2826 Positional arguments:
2828 <host> Cinder host on which to list manageable snapshots; takes the
2830 form: host@backend-name#pool
2831 Optional arguments:
2833 --detailed <detailed>
2835 Returned detailed information (default true).
2836 --marker <marker>
2838 Begin returning volumes that appear later in the volume list
2839 than that represented by this reference. This reference should
2840 be json like. Default=None.
2841 --limit <limit>
2843 Maximum number of volumes to return. Default=None.
2844 --offset <offset>
2846 Number of volumes to skip after marker. Default=None.
2847 --sort <key>[:<direction>]
2849 Comma-separated list of sort keys and directions in the form of
2850 <key>[:<asc|desc>]. Valid keys: size, reference. Default=None.
2851 --cluster None
2853 Cinder cluster on which to list manageable snapshots; takes the
2854 form: cluster@backend-name#pool
2855 cinder snapshot-metadata
2857 usage: cinder snapshot-metadata <snapshot> <action> <key=value>
2858 [<key=value> ...]
2859 Sets or deletes snapshot metadata.
2861 Positional arguments:
2863 <snapshot>
2865 ID of snapshot for which to update metadata.
2866 <action>
2868 The action. Valid values are "set" or "unset."
2869 <key=value>
2871 Metadata key and value pair to set or unset. For unset, specify
2872 only the key.
2873 cinder snapshot-metadata-show
2875 usage: cinder snapshot-metadata-show <snapshot>
2876 Shows snapshot metadata.
2878 Positional arguments:
2880 <snapshot>
2882 ID of snapshot.
2883 cinder snapshot-metadata-update-all
2885 usage: cinder snapshot-metadata-update-all <snapshot> <key=value>
2886 [<key=value> ...]
2887 Updates snapshot metadata.
2889 Positional arguments:
2891 <snapshot>
2893 ID of snapshot for which to update metadata.
2894 <key=value>
2896 Metadata key and value pair to update.
2897 cinder snapshot-rename
2899 usage: cinder snapshot-rename [--description <description>]
2900 <snapshot> [<name>]
2901 Renames a snapshot.
2903 Positional arguments:
2905 <snapshot>
2907 Name or ID of snapshot.
2908 <name> New name for snapshot.
2910 Optional arguments:
2912 --description <description>
2914 Snapshot description. Default=None.
2915 cinder snapshot-reset-state
2917 usage: cinder snapshot-reset-state [--state <state>]
2918 <snapshot> [<snapshot> ...]
2919 Explicitly updates the snapshot state.
2921 Positional arguments:
2923 <snapshot>
2925 Name or ID of snapshot to modify.
2926 Optional arguments:
2928 --state <state>
2930 The state to assign to the snapshot. Valid values are "avail‐
2931 able", "error", "creating", "deleting", and "error_deleting".
2932 NOTE: This command simply changes the state of the Snapshot in
2933 the DataBase with no regard to actual status, exercise caution
2934 when using. Default=available.
2935 cinder snapshot-show
2937 usage: cinder snapshot-show <snapshot>
2938 Shows snapshot details.
2940 Positional arguments:
2942 <snapshot>
2944 Name or ID of snapshot.
2945 cinder snapshot-unmanage
2947 usage: cinder snapshot-unmanage <snapshot>
2948 Stop managing a snapshot.
2950 Positional arguments:
2952 <snapshot>
2954 Name or ID of the snapshot to unmanage.
2955 cinder summary
2957 usage: cinder summary [--all-tenants [<0|1>]]
2958 Get volumes summary.
2960 Optional arguments:
2962 --all-tenants <0|1>
2964 Shows details for all tenants. Admin only.
2965 cinder thaw-host
2967 usage: cinder thaw-host <hostname>
2968 Thaw and enable the specified cinder-volume host.
2970 Positional arguments:
2972 <hostname>
2974 Host name.
2975 cinder transfer-accept
2977 usage: cinder transfer-accept <transfer> <auth_key>
2978 Accepts a volume transfer.
2980 Positional arguments:
2982 <transfer>
2984 ID of transfer to accept.
2985 <auth_key>
2987 Authentication key of transfer to accept.
2988 cinder transfer-create
2990 usage: cinder transfer-create [--name <name>] [--no-snapshots] <volume>
2991 Creates a volume transfer.
2993 Positional arguments:
2995 <volume>
2997 Name or ID of volume to transfer.
2998 Optional arguments:
3000 --name <name>
3002 Transfer name. Default=None.
3003 --no-snapshots None
3005 Allows or disallows transfer volumes without snapshots. De‐
3006 fault=False.
3007 cinder transfer-delete
3009 usage: cinder transfer-delete <transfer>
3010 Undoes a transfer.
3012 Positional arguments:
3014 <transfer>
3016 Name or ID of transfer to delete.
3017 cinder transfer-list
3019 usage: cinder transfer-list [--all-tenants [<0|1>]]
3020 [--sort <key>[:<direction>]]
3021 [--filters [<key=value> ...]]
3022 Lists all transfers.
3024 Optional arguments:
3026 --all-tenants <0|1>
3028 Shows details for all tenants. Admin only.
3029 --sort <key>[:<direction>]
3031 Sort keys and directions in the form of <key>[:<asc|desc>].
3032 --filters <key=value>
3034 Filter key and value pairs.
3035 cinder transfer-show
3037 usage: cinder transfer-show <transfer>
3038 Shows transfer details.
3040 Positional arguments:
3042 <transfer>
3044 Name or ID of transfer to accept.
3045 cinder type-access-add
3047 usage: cinder type-access-add --volume-type <volume_type> --project-id
3048 <project_id>
3049 Adds volume type access for the given project.
3051 Optional arguments:
3053 --volume-type <volume_type>
3055 Volume type name or ID to add access for the given project.
3056 --project-id <project_id>
3058 Project ID to add volume type access for.
3059 cinder type-access-list
3061 usage: cinder type-access-list --volume-type <volume_type>
3062 Print access information about the given volume type.
3064 Optional arguments:
3066 --volume-type <volume_type>
3068 Filter results by volume type name or ID.
3069 cinder type-access-remove
3071 usage: cinder type-access-remove --volume-type <volume_type> --project-id
3072 <project_id>
3073 Removes volume type access for the given project.
3075 Optional arguments:
3077 --volume-type <volume_type>
3079 Volume type name or ID to remove access for the given project.
3080 --project-id <project_id>
3082 Project ID to remove volume type access for.
3083 cinder type-create
3085 usage: cinder type-create [--description <description>]
3086 [--is-public <is-public>]
3087 <name>
3088 Creates a volume type.
3090 Positional arguments:
3092 <name> Name of new volume type.
3094 Optional arguments:
3096 --description <description>
3098 Description of new volume type.
3099 --is-public <is-public>
3101 Make type accessible to the public (default true).
3102 cinder type-default
3104 usage: cinder type-default
3105 List the default volume type.
3107 cinder type-delete
3109 usage: cinder type-delete <vol_type> [<vol_type> ...]
3110 Deletes volume type or types.
3112 Positional arguments:
3114 <vol_type>
3116 Name or ID of volume type or types to delete.
3117 cinder type-key
3119 usage: cinder type-key <vtype> <action> <key=value> [<key=value> ...]
3120 Sets or unsets extra_spec for a volume type.
3122 Positional arguments:
3124 <vtype>
3126 Name or ID of volume type.
3127 <action>
3129 The action. Valid values are "set" or "unset."
3130 <key=value>
3132 The extra specs key and value pair to set or unset. For unset,
3133 specify only the key.
3134 cinder type-list
3136 usage: cinder type-list [--filters [<key=value> ...]]
3137 Lists available 'volume types'.
3139 Optional arguments:
3141 --filters <key=value>
3143 Filter key and value pairs. Admin only.
3144 cinder type-show
3146 usage: cinder type-show <volume_type>
3147 Show volume type details.
3149 Positional arguments:
3151 <volume_type>
3153 Name or ID of the volume type.
3154 cinder type-update
3156 usage: cinder type-update [--name <name>] [--description <description>]
3157 [--is-public <is-public>]
3158 <id>
3159 Updates volume type name, description, and/or is_public.
3161 Positional arguments:
3163 <id> ID of the volume type.
3165 Optional arguments:
3167 --name <name>
3169 Name of the volume type.
3170 --description <description>
3172 Description of the volume type.
3173 --is-public <is-public>
3175 Make type accessible to the public or not.
3176 cinder unmanage
3178 usage: cinder unmanage <volume>
3179 Stop managing a volume.
3181 Positional arguments:
3183 <volume>
3185 Name or ID of the volume to unmanage.
3186 cinder upload-to-image
3188 usage: cinder upload-to-image [--force [<True|False>]]
3189 [--container-format <container-format>]
3190 [--disk-format <disk-format>]
3191 [--visibility <public|private|community|shared>]
3192 [--protected <True|False>]
3193 <volume> <image-name>
3194 Uploads volume to Image Service as an image.
3196 Positional arguments:
3198 <volume>
3200 Name or ID of volume to snapshot.
3201 <image-name>
3203 The new image name.
3204 Optional arguments:
3206 --force <True|False>
3208 Enables or disables upload of a volume that is attached to an
3209 instance. Default=False. This option may not be supported by
3210 your cloud.
3211 --container-format <container-format>
3213 Container format type. Default is bare.
3214 --disk-format <disk-format>
3216 Disk format type. Default is raw.
3217 --visibility <public|private|community|shared>
3219 Set image visibility to public, private, community or shared.
3220 Default=private.
3221 --protected <True|False>
3223 Prevents image from being deleted. Default=False.
3224 cinder version-list
3226 usage: cinder version-list
3227 List all API versions.
3229 cinder work-cleanup
3231 usage: cinder work-cleanup [--cluster <cluster-name>] [--host <hostname>]
3232 [--binary <binary>]
3233 [--is-up <True|true|False|false>]
3234 [--disabled <True|true|False|false>]
3235 [--resource-id <resource-id>]
3236 [--resource-type <Volume|Snapshot>]
3237 [--service-id <service-id>]
3238 Request cleanup of services with optional filtering.
3240 Optional arguments:
3242 --cluster <cluster-name>
3244 Cluster name. Default=None.
3245 --host <hostname>
3247 Service host name. Default=None.
3248 --binary <binary>
3250 Service binary. Default=None.
3251 --is-up <True|true|False|false>
3253 Filter by up/down status, if set to true services need to be up,
3254 if set to false services need to be down. Default is None,
3255 which means up/down status is ignored.
3256 --disabled <True|true|False|false>
3258 Filter by disabled status. Default=None.
3259 --resource-id <resource-id>
3261 UUID of a resource to cleanup. Default=None.
3262 --resource-type <Volume|Snapshot>
3264 Type of resource to cleanup.
3265 --service-id <service-id>
3267 The service id field from the DB, not the uuid of the service.
3268 Default=None.
3269 cinder help
3271 usage: cinder help [<subcommand>]
3272 Shows help about this program or one of its subcommands.
3274 Positional arguments:
3276 <subcommand>
3278 Shows help for <subcommand>.
3279
3281 OpenStack Contributors
3282
3284 OpenStack Contributors
32857.4.0 Jul 23, 2021 CINDER(1)