1CINDER(1) python-cinderclient CINDER(1)
2
3
4
6 cinder - Client for OpenStack Block Storage API
7
8 The cinder client is the command-line interface (CLI) for the Block
9 Storage service (cinder) API and its extensions.
10
11 For help on a specific cinder command, enter:
12
13 $ 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
41 Optional Arguments
42 --collect-timing
43 Collect per-API call timing information.
44
45 --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
51 --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
56 --os-auth-type, --os-auth-plugin
57 Authentication type to use
58
59 --os-auth-url
60 Authentication URL
61
62 --os-cacert
63 Specify a CA bundle file to use in verifying a TLS (https)
64 server certificate. Defaults to env[OS_CACERT].
65
66 --os-cert
67 Defaults to env[OS_CERT].
68
69 --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
74 --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
79 --os-domain-id
80 Domain ID to scope to
81
82 --os-domain-name
83 Domain name to scope to
84
85 --os-endpoint
86 Use this API endpoint instead of the Service Catalog. Defaults
87 to env[CINDER_ENDPOINT].
88
89 --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
94 --os-key
95 Defaults to env[OS_KEY].
96
97 --os-password
98 User's password
99
100 --os-project-domain-id
101 Domain ID containing project
102
103 --os-project-domain-name
104 Domain name containing project
105
106 --os-project-id, --os-tenant-id
107 Project ID to scope to
108
109 --os-project-name, --os-tenant-name
110 Project name to scope to
111
112 --os-system-scope
113 Scope for system operations
114
115 --os-token
116 Defaults to env[OS_TOKEN].
117
118 --os-trust-id
119 Trust ID
120
121 --os-url
122 Defaults to env[OS_URL].
123
124 --os-user-domain-id
125 User's domain id
126
127 --os-user-domain-name
128 User's domain name
129
130 --os-user-id
131 User id
132
133 --os-username, --os-user-name
134 Username
135
136 --os-volume-api-version
137 Block Storage API version. Accepts X, X.Y (where X is major and
138 Y is minor part). NOTE: this client accepts only '3' for the
139 major version. Default=env[OS_VOLUME_API_VERSION].
140
141 --retries
142 Number of retries.
143
144 --service-name
145 Service name. Default=env[CINDER_SERVICE_NAME].
146
147 --service-type
148 Service type. For most actions, default is volume.
149
150 --timeout
151 Set request timeout (in seconds).
152
153 --version
154 show program's version number and exit
155
156 --volume-service-name
157 Volume service name. Default=env[CINDER_VOLUME_SERVICE_NAME].
158
159 -d, --debug
160 Shows debugging output.
161
162 Commands
163 absolute-limits
164 Lists absolute limits for a user.
165
166 api-version
167 Display the server API version information.
168
169 attachment-complete
170 Complete an attachment for a cinder volume.
171
172 attachment-create
173 Create an attachment for a cinder volume.
174
175 attachment-delete
176 Delete an attachment for a cinder volume.
177
178 attachment-list
179 Lists all attachments.
180
181 attachment-show
182 Show detailed information for attachment.
183
184 attachment-update
185 Update an attachment for a cinder volume.
186
187 availability-zone-list
188 Lists all availability zones.
189
190 backup-create
191 Creates a volume backup.
192
193 backup-delete
194 Removes one or more backups.
195
196 backup-export
197 Export backup metadata record.
198
199 backup-import
200 Import backup metadata record.
201
202 backup-list
203 Lists all backups.
204
205 backup-reset-state
206 Explicitly updates the backup state.
207
208 backup-restore
209 Restores a backup.
210
211 backup-show
212 Shows backup details.
213
214 backup-update
215 Updates a backup.
216
217 cgsnapshot-create
218 Creates a cgsnapshot.
219
220 cgsnapshot-delete
221 Removes one or more cgsnapshots.
222
223 cgsnapshot-list
224 Lists all cgsnapshots.
225
226 cgsnapshot-show
227 Shows cgsnapshot details.
228
229 cluster-disable
230 Disables clustered services.
231
232 cluster-enable
233 Enables clustered services.
234
235 cluster-list
236 Lists clustered services with optional filtering.
237
238 cluster-show
239 Show detailed information on a clustered service.
240
241 consisgroup-create
242 Creates a consistency group.
243
244 consisgroup-create-from-src
245 Creates a consistency group from a cgsnapshot or a source CG.
246
247 consisgroup-delete
248 Removes one or more consistency groups.
249
250 consisgroup-list
251 Lists all consistency groups.
252
253 consisgroup-show
254 Shows details of a consistency group.
255
256 consisgroup-update
257 Updates a consistency group.
258
259 create Creates a volume.
260
261 default-type-list
262 Lists all default volume types.
263
264 default-type-set
265 Sets a default volume type for a project.
266
267 default-type-unset
268 Unset default volume types.
269
270 delete Removes one or more volumes.
271
272 encryption-type-create
273 Creates encryption type for a volume type. Admin only.
274
275 encryption-type-delete
276 Deletes encryption type for a volume type. Admin only.
277
278 encryption-type-list
279 Shows encryption type details for volume types. Admin only.
280
281 encryption-type-show
282 Shows encryption type details for a volume type. Admin only.
283
284 encryption-type-update
285 Update encryption type information for a volume type (Admin
286 Only).
287
288 extend Attempts to extend size of an existing volume.
289
290 extra-specs-list
291 Lists current volume types and extra specs.
292
293 failover-host
294 Failover a replicating cinder-volume host.
295
296 force-delete
297 Attempts force-delete of volume, regardless of state.
298
299 freeze-host
300 Freeze and disable the specified cinder-volume host.
301
302 get-capabilities
303 Show backend volume stats and properties. Admin only.
304
305 get-pools
306 Show pool information for backends. Admin only.
307
308 group-create
309 Creates a group.
310
311 group-create-from-src
312 Creates a group from a group snapshot or a source group.
313
314 group-delete
315 Removes one or more groups.
316
317 group-disable-replication
318 Disables replication for group.
319
320 group-enable-replication
321 Enables replication for group.
322
323 group-failover-replication
324 Fails over replication for group.
325
326 group-list
327 Lists all groups.
328
329 group-list-replication-targets
330 Lists replication targets for group.
331
332 group-show
333 Shows details of a group.
334
335 group-snapshot-create
336 Creates a group snapshot.
337
338 group-snapshot-delete
339 Removes one or more group snapshots.
340
341 group-snapshot-list
342 Lists all group snapshots.
343
344 group-snapshot-show
345 Shows group snapshot details.
346
347 group-specs-list
348 Lists current group types and specs.
349
350 group-type-create
351 Creates a group type.
352
353 group-type-default
354 List the default group type.
355
356 group-type-delete
357 Deletes group type or types.
358
359 group-type-key
360 Sets or unsets group_spec for a group type.
361
362 group-type-list
363 Lists available 'group types'. (Admin only will see private
364 types)
365
366 group-type-show
367 Show group type details.
368
369 group-type-update
370 Updates group type name, description, and/or is_public.
371
372 group-update
373 Updates a group.
374
375 image-metadata
376 Sets or deletes volume image metadata.
377
378 image-metadata-show
379 Shows volume image metadata.
380
381 list Lists all volumes.
382
383 list-filters
384 List enabled filters.
385
386 manage Manage an existing volume.
387
388 manageable-list
389 Lists all manageable volumes.
390
391 message-delete
392 Removes one or more messages.
393
394 message-list
395 Lists all messages.
396
397 message-show
398 Shows message details.
399
400 metadata
401 Sets or deletes volume metadata.
402
403 metadata-show
404 Shows volume metadata.
405
406 metadata-update-all
407 Updates volume metadata.
408
409 migrate
410 Migrates volume to a new host.
411
412 qos-associate
413 Associates qos specs with specified volume type.
414
415 qos-create
416 Creates a qos specs.
417
418 qos-delete
419 Deletes a specified qos specs.
420
421 qos-disassociate
422 Disassociates qos specs from specified volume type.
423
424 qos-disassociate-all
425 Disassociates qos specs from all its associations.
426
427 qos-get-association
428 Lists all associations for specified qos specs.
429
430 qos-key
431 Sets or unsets specifications for a qos spec.
432
433 qos-list
434 Lists qos specs.
435
436 qos-show
437 Shows qos specs details.
438
439 quota-class-show
440 Lists quotas for a quota class.
441
442 quota-class-update
443 Updates quotas for a quota class.
444
445 quota-defaults
446 Lists default quotas for a tenant.
447
448 quota-delete
449 Delete the quotas for a tenant.
450
451 quota-show
452 Lists quotas for a tenant.
453
454 quota-update
455 Updates quotas for a tenant.
456
457 quota-usage
458 Lists quota usage for a tenant.
459
460 rate-limits
461 Lists rate limits for a user.
462
463 readonly-mode-update
464 Updates volume read-only access-mode flag.
465
466 reimage
467 Rebuilds a volume, overwriting all content with the specified
468 image
469
470 rename Renames a volume.
471
472 reset-state
473 Explicitly updates the entity state in the Cinder database.
474
475 retype Changes the volume type for a volume.
476
477 revert-to-snapshot
478 Revert a volume to the specified snapshot.
479
480 service-disable
481 Disables the service.
482
483 service-enable
484 Enables the service.
485
486 service-get-log
487 Gets the service log level.
488
489 service-list
490 Lists all services. Filter by host and service binary.
491
492 service-set-log
493 Sets the service log level.
494
495 set-bootable
496 Update bootable status of a volume.
497
498 show Shows volume details.
499
500 snapshot-create
501 Creates a snapshot.
502
503 snapshot-delete
504 Removes one or more snapshots.
505
506 snapshot-list
507 Lists all snapshots.
508
509 snapshot-manage
510 Manage an existing snapshot.
511
512 snapshot-manageable-list
513 Lists all manageable snapshots.
514
515 snapshot-metadata
516 Sets or deletes snapshot metadata.
517
518 snapshot-metadata-show
519 Shows snapshot metadata.
520
521 snapshot-metadata-update-all
522 Updates snapshot metadata.
523
524 snapshot-rename
525 Renames a snapshot.
526
527 snapshot-reset-state
528 Explicitly updates the snapshot state.
529
530 snapshot-show
531 Shows snapshot details.
532
533 snapshot-unmanage
534 Stop managing a snapshot.
535
536 summary
537 Get volumes summary.
538
539 thaw-host
540 Thaw and enable the specified cinder-volume host.
541
542 transfer-accept
543 Accepts a volume transfer.
544
545 transfer-create
546 Creates a volume transfer.
547
548 transfer-delete
549 Undoes a transfer.
550
551 transfer-list
552 Lists all transfers.
553
554 transfer-show
555 Shows transfer details.
556
557 type-access-add
558 Adds volume type access for the given project.
559
560 type-access-list
561 Print access information about the given volume type.
562
563 type-access-remove
564 Removes volume type access for the given project.
565
566 type-create
567 Creates a volume type.
568
569 type-default
570 List the default volume type.
571
572 type-delete
573 Deletes volume type or types.
574
575 type-key
576 Sets or unsets extra_spec for a volume type.
577
578 type-list
579 Lists available 'volume types'.
580
581 type-show
582 Show volume type details.
583
584 type-update
585 Updates volume type name, description, and/or is_public.
586
587 unmanage
588 Stop managing a volume.
589
590 upload-to-image
591 Uploads volume to Image Service as an image.
592
593 version-list
594 List all API versions.
595
596 work-cleanup
597 Request cleanup of services with optional filtering.
598
599 help Shows help about this program or one of its subcommands.
600
602 cinder absolute-limits
603 usage: cinder absolute-limits [<tenant_id>]
604
605 Lists absolute limits for a user.
606
607 Positional arguments:
608
609 <tenant_id>
610 Display information for a single tenant (Admin only).
611
612 cinder api-version
613 usage: cinder api-version
614
615 Display the server API version information.
616
617 cinder attachment-complete
618 usage: cinder attachment-complete <attachment> [<attachment> ...]
619
620 Complete an attachment for a cinder volume.
621
622 Positional arguments:
623
624 <attachment>
625 ID of attachment or attachments to delete.
626
627 cinder attachment-create
628 usage: cinder attachment-create [--connect <connect>]
629 [--initiator <initiator>] [--ip <ip>]
630 [--host <host>] [--platform <platform>]
631 [--ostype <ostype>] [--multipath <multipath>]
632 [--mountpoint <mountpoint>] [--mode <mode>]
633 <volume> [<server_id>]
634
635 Create an attachment for a cinder volume.
636
637 Positional arguments:
638
639 <volume>
640 Name or ID of volume or volumes to attach.
641
642 <server_id>
643 ID of server attaching to.
644
645 Optional arguments:
646
647 --connect <connect>
648 Make an active connection using provided connector info (True or
649 False).
650
651 --initiator <initiator>
652 iqn of the initiator attaching to. Default=None.
653
654 --ip <ip>
655 ip of the system attaching to. Default=None.
656
657 --host <host>
658 Name of the host attaching to. Default=None.
659
660 --platform <platform>
661 Platform type. Default=x86_64.
662
663 --ostype <ostype>
664 OS type. Default=linux2.
665
666 --multipath <multipath>
667 Use multipath. Default=False.
668
669 --mountpoint <mountpoint>
670 Mountpoint volume will be attached at. Default=None.
671
672 --mode <mode>
673 Mode of attachment, rw, ro and null, where null indicates we
674 want to honor any existing admin-metadata settings. De‐
675 fault=null.
676
677 cinder attachment-delete
678 usage: cinder attachment-delete <attachment> [<attachment> ...]
679
680 Delete an attachment for a cinder volume.
681
682 Positional arguments:
683
684 <attachment>
685 ID of attachment or attachments to delete.
686
687 cinder attachment-list
688 usage: cinder attachment-list [--all-tenants [<0|1>]]
689 [--volume-id <volume-id>] [--status <status>]
690 [--marker <marker>] [--limit <limit>]
691 [--sort <key>[:<direction>]]
692 [--tenant [<tenant>]]
693 [--filters [<key=value> ...]]
694
695 Lists all attachments.
696
697 Optional arguments:
698
699 --all-tenants <0|1>
700 Shows details for all tenants. Admin only.
701
702 --volume-id <volume-id>
703 Filters results by a volume ID. Default=None. This option is
704 deprecated and will be removed in newer release. Please use
705 '--filters' option which is introduced since 3.33 instead.
706
707 --status <status>
708 Filters results by a status. Default=None. This option is depre‐
709 cated and will be removed in newer release. Please use '--fil‐
710 ters' option which is introduced since 3.33 instead.
711
712 --marker <marker>
713 Begin returning attachments that appear later in attachment list
714 than that represented by this id. Default=None.
715
716 --limit <limit>
717 Maximum number of attachments to return. Default=None.
718
719 --sort <key>[:<direction>]
720 Comma-separated list of sort keys and directions in the form of
721 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
722 ity_zone, name, bootable, created_at, reference. Default=None.
723
724 --tenant <tenant>
725 Display information from single tenant (Admin only).
726
727 --filters <key=value>
728 Filter key and value pairs. Please use 'cinder list-filters' to
729 check enabled filters from server. Use 'key~=value' for inexact
730 filtering if the key supports. Default=None.
731
732 cinder attachment-show
733 usage: cinder attachment-show <attachment>
734
735 Show detailed information for attachment.
736
737 Positional arguments:
738
739 <attachment>
740 ID of attachment.
741
742 cinder attachment-update
743 usage: cinder attachment-update [--initiator <initiator>] [--ip <ip>]
744 [--host <host>] [--platform <platform>]
745 [--ostype <ostype>] [--multipath <multipath>]
746 [--mountpoint <mountpoint>]
747 <attachment>
748
749 Update an attachment for a cinder volume.
750
751 Positional arguments:
752
753 <attachment>
754 ID of attachment.
755
756 Optional arguments:
757
758 --initiator <initiator>
759 iqn of the initiator attaching to. Default=None.
760
761 --ip <ip>
762 ip of the system attaching to. Default=None.
763
764 --host <host>
765 Name of the host attaching to. Default=None.
766
767 --platform <platform>
768 Platform type. Default=x86_64.
769
770 --ostype <ostype>
771 OS type. Default=linux2.
772
773 --multipath <multipath>
774 Use multipath. Default=False.
775
776 --mountpoint <mountpoint>
777 Mountpoint volume will be attached at. Default=None.
778
779 cinder availability-zone-list
780 usage: cinder availability-zone-list
781
782 Lists all availability zones.
783
784 cinder backup-create
785 usage: cinder backup-create [--container <container>] [--name <name>]
786 [--description <description>] [--incremental]
787 [--force] [--snapshot-id <snapshot-id>]
788 [--metadata [<key=value> ...]]
789 [--availability-zone AVAILABILITY_ZONE]
790 <volume>
791
792 Creates a volume backup.
793
794 Positional arguments:
795
796 <volume>
797 Name or ID of volume to backup.
798
799 Optional arguments:
800
801 --container <container>
802 Backup container name. Default=None.
803
804 --name <name>
805 Backup name. Default=None.
806
807 --description <description>
808 Backup description. Default=None.
809
810 --incremental None
811 Incremental backup. Default=False.
812
813 --force None
814 Allows or disallows backup of a volume when the volume is at‐
815 tached to an instance. If set to True, backs up the volume
816 whether its status is "available" or "in-use". The backup of an
817 "in-use" volume means your data is crash consistent. De‐
818 fault=False.
819
820 --snapshot-id <snapshot-id>
821 ID of snapshot to backup. Default=None.
822
823 --metadata <key=value>
824 Metadata key and value pairs. Default=None.
825
826 --availability-zone None
827 AZ where the backup should be stored, by default it will be the
828 same as the source.
829
830 cinder backup-delete
831 usage: cinder backup-delete [--force] <backup> [<backup> ...]
832
833 Removes one or more backups.
834
835 Positional arguments:
836
837 <backup>
838 Name or ID of backup(s) to delete.
839
840 Optional arguments:
841
842 --force None
843 Allows deleting backup of a volume when its status is other than
844 "available" or "error". Default=False.
845
846 cinder backup-export
847 usage: cinder backup-export <backup>
848
849 Export backup metadata record.
850
851 Positional arguments:
852
853 <backup>
854 ID of the backup to export.
855
856 cinder backup-import
857 usage: cinder backup-import <backup_service> <backup_url>
858
859 Import backup metadata record.
860
861 Positional arguments:
862
863 <backup_service>
864 Backup service to use for importing the backup.
865
866 <backup_url>
867 Backup URL for importing the backup metadata.
868
869 cinder backup-list
870 usage: cinder backup-list [--all-tenants [<all_tenants>]] [--name <name>]
871 [--status <status>] [--volume-id <volume-id>]
872 [--marker <marker>] [--limit <limit>]
873 [--sort <key>[:<direction>]]
874 [--filters [<key=value> ...]]
875 [--with-count [<True|False>]]
876
877 Lists all backups.
878
879 Optional arguments:
880
881 --all-tenants <all_tenants>
882 Shows details for all tenants. Admin only.
883
884 --name <name>
885 Filters results by a name. Default=None. This option is depre‐
886 cated and will be removed in newer release. Please use '--fil‐
887 ters' option which is introduced since 3.33 instead.
888
889 --status <status>
890 Filters results by a status. Default=None. This option is depre‐
891 cated and will be removed in newer release. Please use '--fil‐
892 ters' option which is introduced since 3.33 instead.
893
894 --volume-id <volume-id>
895 Filters results by a volume ID. Default=None. This option is
896 deprecated and will be removed in newer release. Please use
897 '--filters' option which is introduced since 3.33 instead.
898
899 --marker <marker>
900 Begin returning backups that appear later in the backup list
901 than that represented by this id. Default=None.
902
903 --limit <limit>
904 Maximum number of backups to return. Default=None.
905
906 --sort <key>[:<direction>]
907 Comma-separated list of sort keys and directions in the form of
908 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
909 ity_zone, name, bootable, created_at, reference. Default=None.
910
911 --filters <key=value>
912 Filter key and value pairs. Please use 'cinder list-filters' to
913 check enabled filters from server. Use 'key~=value' for inexact
914 filtering if the key supports. Default=None.
915
916 --with-count <True|False>
917 Show total number of backup entities. This is useful when pagi‐
918 nation is applied in the request.
919
920 cinder backup-reset-state
921 usage: cinder backup-reset-state [--state <state>] <backup> [<backup> ...]
922
923 Explicitly updates the backup state.
924
925 Positional arguments:
926
927 <backup>
928 Name or ID of the backup to modify.
929
930 Optional arguments:
931
932 --state <state>
933 The state to assign to the backup. Valid values are "available",
934 "error". Default=available.
935
936 cinder backup-restore
937 usage: cinder backup-restore [--volume <volume>] [--name <name>]
938 [--volume-type <volume-type>]
939 [--availability-zone <AZ>]
940 <backup>
941
942 Restores a backup.
943
944 Positional arguments:
945
946 <backup>
947 Name or ID of backup to restore.
948
949 Optional arguments:
950
951 --volume <volume>
952 Name or ID of existing volume to which to restore. This is mutu‐
953 ally exclusive with --name and takes priority. Default=None.
954
955 --name <name>
956 Use the name for new volume creation to restore. This is mutu‐
957 ally exclusive with --volume and --volume takes priority. De‐
958 fault=None.
959
960 --volume-type <volume-type>
961 Volume type for the new volume creation to restore. This option
962 is not valid when used with the "volume" option. Default=None.
963
964 --availability-zone <AZ>
965 AZ for the new volume creation to restore. By default it will be
966 the same as backup AZ. This option is not valid when used with
967 the "volume" option. Default=None.
968
969 cinder backup-show
970 usage: cinder backup-show <backup>
971
972 Shows backup details.
973
974 Positional arguments:
975
976 <backup>
977 Name or ID of backup.
978
979 cinder backup-update
980 usage: cinder backup-update [--name [<name>]] [--description <description>]
981 [--metadata [<key=value> ...]]
982 <backup>
983
984 Updates a backup.
985
986 Positional arguments:
987
988 <backup>
989 Name or ID of backup to rename.
990
991 Optional arguments:
992
993 --name <name>
994 New name for backup.
995
996 --description <description>
997 Backup description. Default=None.
998
999 --metadata <key=value>
1000 Metadata key and value pairs. Default=None.
1001
1002 cinder cgsnapshot-create
1003 usage: cinder cgsnapshot-create [--name <name>] [--description <description>]
1004 <consistencygroup>
1005
1006 Creates a cgsnapshot.
1007
1008 Positional arguments:
1009
1010 <consistencygroup>
1011 Name or ID of a consistency group.
1012
1013 Optional arguments:
1014
1015 --name <name>
1016 Cgsnapshot name. Default=None.
1017
1018 --description <description>
1019 Cgsnapshot description. Default=None.
1020
1021 cinder cgsnapshot-delete
1022 usage: cinder cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]
1023
1024 Removes one or more cgsnapshots.
1025
1026 Positional arguments:
1027
1028 <cgsnapshot>
1029 Name or ID of one or more cgsnapshots to be deleted.
1030
1031 cinder cgsnapshot-list
1032 usage: cinder cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>]
1033 [--consistencygroup-id <consistencygroup_id>]
1034
1035 Lists all cgsnapshots.
1036
1037 Optional arguments:
1038
1039 --all-tenants <0|1>
1040 Shows details for all tenants. Admin only.
1041
1042 --status <status>
1043 Filters results by a status. Default=None.
1044
1045 --consistencygroup-id <consistencygroup_id>
1046 Filters results by a consistency group ID. Default=None.
1047
1048 cinder cgsnapshot-show
1049 usage: cinder cgsnapshot-show <cgsnapshot>
1050
1051 Shows cgsnapshot details.
1052
1053 Positional arguments:
1054
1055 <cgsnapshot>
1056 Name or ID of cgsnapshot.
1057
1058 cinder cluster-disable
1059 usage: cinder cluster-disable [--reason <reason>] [<binary>] <cluster-name>
1060
1061 Disables clustered services.
1062
1063 Positional arguments:
1064
1065 <binary>
1066 Binary to filter by. Default: cinder-volume.
1067
1068 <cluster-name>
1069 Name of the clustered services to update.
1070
1071 Optional arguments:
1072
1073 --reason <reason>
1074 Reason for disabling clustered service.
1075
1076 cinder cluster-enable
1077 usage: cinder cluster-enable [<binary>] <cluster-name>
1078
1079 Enables clustered services.
1080
1081 Positional arguments:
1082
1083 <binary>
1084 Binary to filter by. Default: cinder-volume.
1085
1086 <cluster-name>
1087 Name of the clustered services to update.
1088
1089 cinder cluster-list
1090 usage: cinder cluster-list [--name <name>] [--binary <binary>]
1091 [--is-up <True|true|False|false>]
1092 [--disabled <True|true|False|false>]
1093 [--num-hosts <num-hosts>]
1094 [--num-down-hosts <num-down-hosts>] [--detailed]
1095
1096 Lists clustered services with optional filtering.
1097
1098 Optional arguments:
1099
1100 --name <name>
1101 Filter by cluster name, without backend will list all clustered
1102 services from the same cluster. Default=None.
1103
1104 --binary <binary>
1105 Cluster binary. Default=None.
1106
1107 --is-up <True|true|False|false>
1108 Filter by up/down status. Default=None.
1109
1110 --disabled <True|true|False|false>
1111 Filter by disabled status. Default=None.
1112
1113 --num-hosts <num-hosts>
1114 Filter by number of hosts in the cluster.
1115
1116 --num-down-hosts <num-down-hosts>
1117 Filter by number of hosts that are down.
1118
1119 --detailed None
1120 Get detailed clustered service information (Default=False).
1121
1122 cinder cluster-show
1123 usage: cinder cluster-show [<binary>] <cluster-name>
1124
1125 Show detailed information on a clustered service.
1126
1127 Positional arguments:
1128
1129 <binary>
1130 Binary to filter by. Default: cinder-volume.
1131
1132 <cluster-name>
1133 Name of the clustered service to show.
1134
1135 cinder consisgroup-create
1136 usage: cinder consisgroup-create [--name <name>] [--description <description>]
1137 [--availability-zone <availability-zone>]
1138 <volume-types>
1139
1140 Creates a consistency group.
1141
1142 Positional arguments:
1143
1144 <volume-types>
1145 Volume types.
1146
1147 Optional arguments:
1148
1149 --name <name>
1150 Name of a consistency group.
1151
1152 --description <description>
1153 Description of a consistency group. Default=None.
1154
1155 --availability-zone <availability-zone>
1156 Availability zone for volume. Default=None.
1157
1158 cinder consisgroup-create-from-src
1159 usage: cinder consisgroup-create-from-src [--cgsnapshot <cgsnapshot>]
1160 [--source-cg <source-cg>]
1161 [--name <name>]
1162 [--description <description>]
1163
1164 Creates a consistency group from a cgsnapshot or a source CG.
1165
1166 Optional arguments:
1167
1168 --cgsnapshot <cgsnapshot>
1169 Name or ID of a cgsnapshot. Default=None.
1170
1171 --source-cg <source-cg>
1172 Name or ID of a source CG. Default=None.
1173
1174 --name <name>
1175 Name of a consistency group. Default=None.
1176
1177 --description <description>
1178 Description of a consistency group. Default=None.
1179
1180 cinder consisgroup-delete
1181 usage: cinder consisgroup-delete [--force]
1182 <consistencygroup> [<consistencygroup> ...]
1183
1184 Removes one or more consistency groups.
1185
1186 Positional arguments:
1187
1188 <consistencygroup>
1189 Name or ID of one or more consistency groups to be deleted.
1190
1191 Optional arguments:
1192
1193 --force None
1194 Allows or disallows consistency groups to be deleted. If the
1195 consistency group is empty, it can be deleted without the force
1196 flag. If the consistency group is not empty, the force flag is
1197 required for it to be deleted.
1198
1199 cinder consisgroup-list
1200 usage: cinder consisgroup-list [--all-tenants [<0|1>]]
1201
1202 Lists all consistency groups.
1203
1204 Optional arguments:
1205
1206 --all-tenants <0|1>
1207 Shows details for all tenants. Admin only.
1208
1209 cinder consisgroup-show
1210 usage: cinder consisgroup-show <consistencygroup>
1211
1212 Shows details of a consistency group.
1213
1214 Positional arguments:
1215
1216 <consistencygroup>
1217 Name or ID of a consistency group.
1218
1219 cinder consisgroup-update
1220 usage: cinder consisgroup-update [--name <name>] [--description <description>]
1221 [--add-volumes <uuid1,uuid2,......>]
1222 [--remove-volumes <uuid3,uuid4,......>]
1223 <consistencygroup>
1224
1225 Updates a consistency group.
1226
1227 Positional arguments:
1228
1229 <consistencygroup>
1230 Name or ID of a consistency group.
1231
1232 Optional arguments:
1233
1234 --name <name>
1235 New name for consistency group. Default=None.
1236
1237 --description <description>
1238 New description for consistency group. Default=None.
1239
1240 --add-volumes <uuid1,uuid2,......>
1241 UUID of one or more volumes to be added to the consistency
1242 group, separated by commas. Default=None.
1243
1244 --remove-volumes <uuid3,uuid4,......>
1245 UUID of one or more volumes to be removed from the consistency
1246 group, separated by commas. Default=None.
1247
1248 cinder create
1249 usage: cinder create [--consisgroup-id <consistencygroup-id>]
1250 [--group-id <group-id>] [--snapshot-id <snapshot-id>]
1251 [--source-volid <source-volid>] [--image-id <image-id>]
1252 [--image <image>] [--backup-id <backup-id>]
1253 [--name <name>] [--description <description>]
1254 [--volume-type <volume-type>]
1255 [--availability-zone <availability-zone>]
1256 [--metadata [<key=value> ...]] [--hint <key=value>]
1257 [--poll]
1258 [<size>]
1259
1260 Creates a volume.
1261
1262 Positional arguments:
1263
1264 <size> Size of volume, in GiBs. (Required unless snap‐
1265 shot-id/source-volid/backup-id is specified).
1266
1267 Optional arguments:
1268
1269 --consisgroup-id <consistencygroup-id>
1270 ID of a consistency group where the new volume belongs to. De‐
1271 fault=None.
1272
1273 --group-id <group-id>
1274 ID of a group where the new volume belongs to. Default=None.
1275
1276 --snapshot-id <snapshot-id>
1277 Creates volume from snapshot ID. Default=None.
1278
1279 --source-volid <source-volid>
1280 Creates volume from volume ID. Default=None.
1281
1282 --image-id <image-id>
1283 Creates volume from image ID. Default=None.
1284
1285 --image <image>
1286 Creates a volume from image (ID or name). Default=None.
1287
1288 --backup-id <backup-id>
1289 Creates a volume from backup ID. Default=None.
1290
1291 --name <name>
1292 Volume name. Default=None.
1293
1294 --description <description>
1295 Volume description. Default=None.
1296
1297 --volume-type <volume-type>
1298 Volume type. Default=None, that is, use the default volume type
1299 configured for the Block Storage API. You can see what type
1300 this is by using the 'cinder type-default' command.
1301
1302 --availability-zone <availability-zone>
1303 Availability zone for volume. Default=None.
1304
1305 --metadata <key=value>
1306 Metadata key and value pairs. Default=None.
1307
1308 --hint <key=value>
1309 Scheduler hint, similar to nova. Repeat option to set multiple
1310 hints. Values with the same key will be stored as a list.
1311
1312 --poll None
1313 Wait for volume creation until it completes.
1314
1315 cinder default-type-list
1316 usage: cinder default-type-list [--project-id <project_id>]
1317
1318 Lists all default volume types.
1319
1320 Optional arguments:
1321
1322 --project-id <project_id>
1323 ID of project for which to show the default type.
1324
1325 cinder default-type-set
1326 usage: cinder default-type-set <volume_type> <project_id>
1327
1328 Sets a default volume type for a project.
1329
1330 Positional arguments:
1331
1332 <volume_type>
1333 Name or ID of the volume type.
1334
1335 <project_id>
1336 ID of project for which to set default type.
1337
1338 cinder default-type-unset
1339 usage: cinder default-type-unset <project_id> [<project_id> ...]
1340
1341 Unset default volume types.
1342
1343 Positional arguments:
1344
1345 <project_id>
1346 ID of project for which to unset default type.
1347
1348 cinder delete
1349 usage: cinder delete [--cascade] <volume> [<volume> ...]
1350
1351 Removes one or more volumes.
1352
1353 Positional arguments:
1354
1355 <volume>
1356 Name or ID of volume or volumes to delete.
1357
1358 Optional arguments:
1359
1360 --cascade None
1361 Remove any snapshots along with volume. Default=False.
1362
1363 cinder encryption-type-create
1364 usage: cinder encryption-type-create [--cipher <cipher>]
1365 [--key-size <key_size>]
1366 [--control-location <control_location>]
1367 <volume_type> <provider>
1368
1369 Creates encryption type for a volume type. Admin only.
1370
1371 Positional arguments:
1372
1373 <volume_type>
1374 Name or ID of volume type.
1375
1376 <provider>
1377 The encryption provider format. For example, "luks" or "plain".
1378
1379 Optional arguments:
1380
1381 --cipher <cipher>
1382 The encryption algorithm or mode. For example, aes-xts-plain64.
1383 Default=None.
1384
1385 --key-size <key_size>
1386 Size of encryption key, in bits. For example, 128 or 256. De‐
1387 fault=None.
1388
1389 --control-location <control_location>
1390 Notional service where encryption is performed. Valid values are
1391 "front-end" or "back-end". For example, front-end=Nova. Default
1392 is "front-end".
1393
1394 cinder encryption-type-delete
1395 usage: cinder encryption-type-delete <volume_type>
1396
1397 Deletes encryption type for a volume type. Admin only.
1398
1399 Positional arguments:
1400
1401 <volume_type>
1402 Name or ID of volume type.
1403
1404 cinder encryption-type-list
1405 usage: cinder encryption-type-list
1406
1407 Shows encryption type details for volume types. Admin only.
1408
1409 cinder encryption-type-show
1410 usage: cinder encryption-type-show <volume_type>
1411
1412 Shows encryption type details for a volume type. Admin only.
1413
1414 Positional arguments:
1415
1416 <volume_type>
1417 Name or ID of volume type.
1418
1419 cinder encryption-type-update
1420 usage: cinder encryption-type-update [--provider <provider>]
1421 [--cipher [<cipher>]]
1422 [--key-size [<key-size>]]
1423 [--control-location <control-location>]
1424 <volume-type>
1425
1426 Update encryption type information for a volume type (Admin Only).
1427
1428 Positional arguments:
1429
1430 <volume-type>
1431 Name or ID of the volume type
1432
1433 Optional arguments:
1434
1435 --provider <provider>
1436 Encryption provider format (e.g. 'luks' or 'plain').
1437
1438 --cipher <cipher>
1439 Encryption algorithm/mode to use (e.g., aes-xts-plain64). Pro‐
1440 vide parameter without value to set to provider default.
1441
1442 --key-size <key-size>
1443 Size of the encryption key, in bits (e.g., 128, 256). Provide
1444 parameter without value to set to provider default.
1445
1446 --control-location <control-location>
1447 Notional service where encryption is performed (e.g.,
1448 front-end=Nova). Values: 'front-end', 'back-end'
1449
1450 cinder extend
1451 usage: cinder extend <volume> <new_size>
1452
1453 Attempts to extend size of an existing volume.
1454
1455 Positional arguments:
1456
1457 <volume>
1458 Name or ID of volume to extend.
1459
1460 <new_size>
1461 New size of volume, in GiBs.
1462
1463 cinder extra-specs-list
1464 usage: cinder extra-specs-list
1465
1466 Lists current volume types and extra specs.
1467
1468 cinder failover-host
1469 usage: cinder failover-host [--backend_id <backend-id>] <hostname>
1470
1471 Failover a replicating cinder-volume host.
1472
1473 Positional arguments:
1474
1475 <hostname>
1476 Host name.
1477
1478 Optional arguments:
1479
1480 --backend_id <backend-id>
1481 ID of backend to failover to (Default=None)
1482
1483 cinder force-delete
1484 usage: cinder force-delete <volume> [<volume> ...]
1485
1486 Attempts force-delete of volume, regardless of state.
1487
1488 Positional arguments:
1489
1490 <volume>
1491 Name or ID of volume or volumes to delete.
1492
1493 cinder freeze-host
1494 usage: cinder freeze-host <hostname>
1495
1496 Freeze and disable the specified cinder-volume host.
1497
1498 Positional arguments:
1499
1500 <hostname>
1501 Host name.
1502
1503 cinder get-capabilities
1504 usage: cinder get-capabilities <host>
1505
1506 Show backend volume stats and properties. Admin only.
1507
1508 Positional arguments:
1509
1510 <host> Cinder host to show backend volume stats and properties; takes
1511 the form: host@backend-name
1512
1513 cinder get-pools
1514 usage: cinder get-pools [--detail] [--filters [<key=value> ...]]
1515
1516 Show pool information for backends. Admin only.
1517
1518 Optional arguments:
1519
1520 --detail None
1521 Show detailed information about pools.
1522
1523 --filters <key=value>
1524 Filter key and value pairs. Please use 'cinder list-filters' to
1525 check enabled filters from server, Default=None.
1526
1527 cinder group-create
1528 usage: cinder group-create [--name <name>] [--description <description>]
1529 [--availability-zone <availability-zone>]
1530 <group-type> <volume-types>
1531
1532 Creates a group.
1533
1534 Positional arguments:
1535
1536 <group-type>
1537 Group type.
1538
1539 <volume-types>
1540 Comma-separated list of volume types.
1541
1542 Optional arguments:
1543
1544 --name <name>
1545 Name of a group.
1546
1547 --description <description>
1548 Description of a group. Default=None.
1549
1550 --availability-zone <availability-zone>
1551 Availability zone for group. Default=None.
1552
1553 cinder group-create-from-src
1554 usage: cinder group-create-from-src [--group-snapshot <group-snapshot>]
1555 [--source-group <source-group>]
1556 [--name <name>]
1557 [--description <description>]
1558
1559 Creates a group from a group snapshot or a source group.
1560
1561 Optional arguments:
1562
1563 --group-snapshot <group-snapshot>
1564 Name or ID of a group snapshot. Default=None.
1565
1566 --source-group <source-group>
1567 Name or ID of a source group. Default=None.
1568
1569 --name <name>
1570 Name of a group. Default=None.
1571
1572 --description <description>
1573 Description of a group. Default=None.
1574
1575 cinder group-delete
1576 usage: cinder group-delete [--delete-volumes] <group> [<group> ...]
1577
1578 Removes one or more groups.
1579
1580 Positional arguments:
1581
1582 <group>
1583 Name or ID of one or more groups to be deleted.
1584
1585 Optional arguments:
1586
1587 --delete-volumes None
1588 Allows or disallows groups to be deleted if they are not empty.
1589 If the group is empty, it can be deleted without the delete-vol‐
1590 umes flag. If the group is not empty, the delete-volumes flag is
1591 required for it to be deleted. If True, all volumes in the group
1592 will also be deleted.
1593
1594 cinder group-disable-replication
1595 usage: cinder group-disable-replication <group>
1596
1597 Disables replication for group.
1598
1599 Positional arguments:
1600
1601 <group>
1602 Name or ID of the group.
1603
1604 cinder group-enable-replication
1605 usage: cinder group-enable-replication <group>
1606
1607 Enables replication for group.
1608
1609 Positional arguments:
1610
1611 <group>
1612 Name or ID of the group.
1613
1614 cinder group-failover-replication
1615 usage: cinder group-failover-replication [--allow-attached-volume]
1616 [--secondary-backend-id <secondary_backend_id>]
1617 <group>
1618
1619 Fails over replication for group.
1620
1621 Positional arguments:
1622
1623 <group>
1624 Name or ID of the group.
1625
1626 Optional arguments:
1627
1628 --allow-attached-volume None
1629 Allows or disallows group with attached volumes to be failed
1630 over.
1631
1632 --secondary-backend-id <secondary_backend_id>
1633 Secondary backend id. Default=None.
1634
1635 cinder group-list
1636 usage: cinder group-list [--all-tenants [<0|1>]] [--filters [<key=value> ...]]
1637
1638 Lists all groups.
1639
1640 Optional arguments:
1641
1642 --all-tenants <0|1>
1643 Shows details for all tenants. Admin only.
1644
1645 --filters <key=value>
1646 Filter key and value pairs. Please use 'cinder list-filters' to
1647 check enabled filters from server. Use 'key~=value' for inexact
1648 filtering if the key supports. Default=None.
1649
1650 cinder group-list-replication-targets
1651 usage: cinder group-list-replication-targets <group>
1652
1653 Lists replication targets for group.
1654
1655 Positional arguments:
1656
1657 <group>
1658 Name or ID of the group.
1659
1660 cinder group-show
1661 usage: cinder group-show [--list-volume [<False|True>]] <group>
1662
1663 Shows details of a group.
1664
1665 Positional arguments:
1666
1667 <group>
1668 Name or ID of a group.
1669
1670 Optional arguments:
1671
1672 --list-volume <False|True>
1673 Shows volumes included in the group.
1674
1675 cinder group-snapshot-create
1676 usage: cinder group-snapshot-create [--name <name>]
1677 [--description <description>]
1678 <group>
1679
1680 Creates a group snapshot.
1681
1682 Positional arguments:
1683
1684 <group>
1685 Name or ID of a group.
1686
1687 Optional arguments:
1688
1689 --name <name>
1690 Group snapshot name. Default=None.
1691
1692 --description <description>
1693 Group snapshot description. Default=None.
1694
1695 cinder group-snapshot-delete
1696 usage: cinder group-snapshot-delete <group_snapshot> [<group_snapshot> ...]
1697
1698 Removes one or more group snapshots.
1699
1700 Positional arguments:
1701
1702 <group_snapshot>
1703 Name or ID of one or more group snapshots to be deleted.
1704
1705 cinder group-snapshot-list
1706 usage: cinder group-snapshot-list [--all-tenants [<0|1>]] [--status <status>]
1707 [--group-id <group_id>]
1708 [--filters [<key=value> ...]]
1709
1710 Lists all group snapshots.
1711
1712 Optional arguments:
1713
1714 --all-tenants <0|1>
1715 Shows details for all tenants. Admin only.
1716
1717 --status <status>
1718 Filters results by a status. Default=None. This option is depre‐
1719 cated and will be removed in newer release. Please use '--fil‐
1720 ters' option which is introduced since 3.33 instead.
1721
1722 --group-id <group_id>
1723 Filters results by a group ID. Default=None. This option is dep‐
1724 recated and will be removed in newer release. Please use '--fil‐
1725 ters' option which is introduced since 3.33 instead.
1726
1727 --filters <key=value>
1728 Filter key and value pairs. Please use 'cinder list-filters' to
1729 check enabled filters from server. Use 'key~=value' for inexact
1730 filtering if the key supports. Default=None.
1731
1732 cinder group-snapshot-show
1733 usage: cinder group-snapshot-show <group_snapshot>
1734
1735 Shows group snapshot details.
1736
1737 Positional arguments:
1738
1739 <group_snapshot>
1740 Name or ID of group snapshot.
1741
1742 cinder group-specs-list
1743 usage: cinder group-specs-list
1744
1745 Lists current group types and specs.
1746
1747 cinder group-type-create
1748 usage: cinder group-type-create [--description <description>]
1749 [--is-public <is-public>]
1750 <name>
1751
1752 Creates a group type.
1753
1754 Positional arguments:
1755
1756 <name> Name of new group type.
1757
1758 Optional arguments:
1759
1760 --description <description>
1761 Description of new group type.
1762
1763 --is-public <is-public>
1764 Make type accessible to the public (default true).
1765
1766 cinder group-type-default
1767 usage: cinder group-type-default
1768
1769 List the default group type.
1770
1771 cinder group-type-delete
1772 usage: cinder group-type-delete <group_type> [<group_type> ...]
1773
1774 Deletes group type or types.
1775
1776 Positional arguments:
1777
1778 <group_type>
1779 Name or ID of group type or types to delete.
1780
1781 cinder group-type-key
1782 usage: cinder group-type-key <gtype> <action> <key=value> [<key=value> ...]
1783
1784 Sets or unsets group_spec for a group type.
1785
1786 Positional arguments:
1787
1788 <gtype>
1789 Name or ID of group type.
1790
1791 <action>
1792 The action. Valid values are "set" or "unset."
1793
1794 <key=value>
1795 The group specs key and value pair to set or unset. For unset,
1796 specify only the key.
1797
1798 cinder group-type-list
1799 usage: cinder group-type-list [--filters [<key=value> ...]]
1800
1801 Lists available 'group types'. (Admin only will see private types)
1802
1803 Optional arguments:
1804
1805 --filters <key=value>
1806 Filter key and value pairs. Admin only.
1807
1808 cinder group-type-show
1809 usage: cinder group-type-show <group_type>
1810
1811 Show group type details.
1812
1813 Positional arguments:
1814
1815 <group_type>
1816 Name or ID of the group type.
1817
1818 cinder group-type-update
1819 usage: cinder group-type-update [--name <name>] [--description <description>]
1820 [--is-public <is-public>]
1821 <id>
1822
1823 Updates group type name, description, and/or is_public.
1824
1825 Positional arguments:
1826
1827 <id> ID of the group type.
1828
1829 Optional arguments:
1830
1831 --name <name>
1832 Name of the group type.
1833
1834 --description <description>
1835 Description of the group type.
1836
1837 --is-public <is-public>
1838 Make type accessible to the public or not.
1839
1840 cinder group-update
1841 usage: cinder group-update [--name <name>] [--description <description>]
1842 [--add-volumes <uuid1,uuid2,......>]
1843 [--remove-volumes <uuid3,uuid4,......>]
1844 <group>
1845
1846 Updates a group.
1847
1848 Positional arguments:
1849
1850 <group>
1851 Name or ID of a group.
1852
1853 Optional arguments:
1854
1855 --name <name>
1856 New name for group. Default=None.
1857
1858 --description <description>
1859 New description for group. Default=None.
1860
1861 --add-volumes <uuid1,uuid2,......>
1862 UUID of one or more volumes to be added to the group, separated
1863 by commas. Default=None.
1864
1865 --remove-volumes <uuid3,uuid4,......>
1866 UUID of one or more volumes to be removed from the group, sepa‐
1867 rated by commas. Default=None.
1868
1869 cinder image-metadata
1870 usage: cinder image-metadata <volume> <action> <key=value> [<key=value> ...]
1871
1872 Sets or deletes volume image metadata.
1873
1874 Positional arguments:
1875
1876 <volume>
1877 Name or ID of volume for which to update metadata.
1878
1879 <action>
1880 The action. Valid values are 'set' or 'unset.'
1881
1882 <key=value>
1883 Metadata key and value pair to set or unset. For unset, specify
1884 only the key.
1885
1886 cinder image-metadata-show
1887 usage: cinder image-metadata-show <volume>
1888
1889 Shows volume image metadata.
1890
1891 Positional arguments:
1892
1893 <volume>
1894 ID of volume.
1895
1896 cinder list
1897 usage: cinder list [--group_id <group_id>] [--all-tenants [<0|1>]]
1898 [--name <name>] [--status <status>]
1899 [--bootable [<True|true|False|false>]]
1900 [--migration_status <migration_status>]
1901 [--metadata [<key=value> ...]]
1902 [--image_metadata [<key=value> ...]] [--marker <marker>]
1903 [--limit <limit>] [--fields <fields>]
1904 [--sort <key>[:<direction>]] [--tenant [<tenant>]]
1905 [--filters [<key=value> ...]] [--with-count [<True|False>]]
1906
1907 Lists all volumes.
1908
1909 Optional arguments:
1910
1911 --group_id <group_id>
1912 Filters results by a group_id. Default=None.This option is dep‐
1913 recated and will be removed in newer release. Please use '--fil‐
1914 ters' option which is introduced since 3.33 instead.
1915
1916 --all-tenants <0|1>
1917 Shows details for all tenants. Admin only.
1918
1919 --name <name>
1920 Filters results by a name. Default=None. This option is depre‐
1921 cated and will be removed in newer release. Please use '--fil‐
1922 ters' option which is introduced since 3.33 instead.
1923
1924 --status <status>
1925 Filters results by a status. Default=None. This option is depre‐
1926 cated and will be removed in newer release. Please use '--fil‐
1927 ters' option which is introduced since 3.33 instead.
1928
1929 --bootable <True|true|False|false>
1930 Filters results by bootable status. Default=None. This option is
1931 deprecated and will be removed in newer release. Please use
1932 '--filters' option which is introduced since 3.33 instead.
1933
1934 --migration_status <migration_status>
1935 Filters results by a migration status. Default=None. Admin only.
1936 This option is deprecated and will be removed in newer release.
1937 Please use '--filters' option which is introduced since 3.33 in‐
1938 stead.
1939
1940 --metadata <key=value>
1941 Filters results by a metadata key and value pair. Default=None.
1942 This option is deprecated and will be removed in newer release.
1943 Please use '--filters' option which is introduced since 3.33 in‐
1944 stead.
1945
1946 --image_metadata <key=value>
1947 Filters results by a image metadata key and value pair. Require
1948 volume api version >=3.4. Default=None.This option is deprecated
1949 and will be removed in newer release. Please use '--filters' op‐
1950 tion which is introduced since 3.33 instead.
1951
1952 --marker <marker>
1953 Begin returning volumes that appear later in the volume list
1954 than that represented by this volume id. Default=None.
1955
1956 --limit <limit>
1957 Maximum number of volumes to return. Default=None.
1958
1959 --fields <fields>
1960 Comma-separated list of fields to display. Use the show command
1961 to see which fields are available. Unavailable/non-existent
1962 fields will be ignored. Default=None.
1963
1964 --sort <key>[:<direction>]
1965 Comma-separated list of sort keys and directions in the form of
1966 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
1967 ity_zone, name, bootable, created_at, reference. Default=None.
1968
1969 --tenant <tenant>
1970 Display information from single tenant (Admin only).
1971
1972 --filters <key=value>
1973 Filter key and value pairs. Please use 'cinder list-filters' to
1974 check enabled filters from server. Use 'key~=value' for inexact
1975 filtering if the key supports. Default=None.
1976
1977 --with-count <True|False>
1978 Show total number of volume entities. This is useful when pagi‐
1979 nation is applied in the request.
1980
1981 cinder list-filters
1982 usage: cinder list-filters [--resource <resource>]
1983
1984 List enabled filters.
1985
1986 Optional arguments:
1987
1988 --resource <resource>
1989 Show enabled filters for specified resource. Default=None.
1990
1991 cinder manage
1992 usage: cinder manage [--cluster CLUSTER] [--id-type <id-type>] [--name <name>]
1993 [--description <description>]
1994 [--volume-type <volume-type>]
1995 [--availability-zone <availability-zone>]
1996 [--metadata [<key=value> ...]] [--bootable]
1997 <host> <identifier>
1998
1999 Manage an existing volume.
2000
2001 Positional arguments:
2002
2003 <host> Cinder host on which the existing volume resides; takes the
2004 form: host@backend-name#pool
2005
2006 <identifier>
2007 Name or other Identifier for existing volume
2008
2009 Optional arguments:
2010
2011 --cluster None
2012 Cinder cluster on which the existing volume resides; takes the
2013 form: cluster@backend-name#pool
2014
2015 --id-type <id-type>
2016 Type of backend device identifier provided, typically
2017 source-name or source-id (Default=source-name)
2018
2019 --name <name>
2020 Volume name (Default=None)
2021
2022 --description <description>
2023 Volume description (Default=None)
2024
2025 --volume-type <volume-type>
2026 Volume type (Default=None)
2027
2028 --availability-zone <availability-zone>
2029 Availability zone for volume (Default=None)
2030
2031 --metadata <key=value>
2032 Metadata key=value pairs (Default=None)
2033
2034 --bootable None
2035 Specifies that the newly created volume should be marked as
2036 bootable
2037
2038 cinder manageable-list
2039 usage: cinder manageable-list [--detailed <detailed>] [--marker <marker>]
2040 [--limit <limit>] [--offset <offset>]
2041 [--sort <key>[:<direction>]] [--cluster CLUSTER]
2042 [<host>]
2043
2044 Lists all manageable volumes.
2045
2046 Positional arguments:
2047
2048 <host> Cinder host on which to list manageable volumes; takes the form:
2049 host@backend-name#pool
2050
2051 Optional arguments:
2052
2053 --detailed <detailed>
2054 Returned detailed information (default true).
2055
2056 --marker <marker>
2057 Begin returning volumes that appear later in the volume list
2058 than that represented by this reference. This reference should
2059 be json like. Default=None.
2060
2061 --limit <limit>
2062 Maximum number of volumes to return. Default=None.
2063
2064 --offset <offset>
2065 Number of volumes to skip after marker. Default=None.
2066
2067 --sort <key>[:<direction>]
2068 Comma-separated list of sort keys and directions in the form of
2069 <key>[:<asc|desc>]. Valid keys: size, reference. Default=None.
2070
2071 --cluster CLUSTER
2072 Cinder cluster on which to list manageable volumes; takes the
2073 form: cluster@backend-name#pool
2074
2075 cinder message-delete
2076 usage: cinder message-delete <message> [<message> ...]
2077
2078 Removes one or more messages.
2079
2080 Positional arguments:
2081
2082 <message>
2083 ID of one or more message to be deleted.
2084
2085 cinder message-list
2086 usage: cinder message-list [--marker <marker>] [--limit <limit>]
2087 [--sort <key>[:<direction>]]
2088 [--resource_uuid <resource_uuid>]
2089 [--resource_type <type>] [--event_id <id>]
2090 [--request_id <request_id>] [--level <level>]
2091 [--filters [<key=value> ...]]
2092
2093 Lists all messages.
2094
2095 Optional arguments:
2096
2097 --marker <marker>
2098 Begin returning message that appear later in the message list
2099 than that represented by this id. Default=None.
2100
2101 --limit <limit>
2102 Maximum number of messages to return. Default=None.
2103
2104 --sort <key>[:<direction>]
2105 Comma-separated list of sort keys and directions in the form of
2106 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
2107 ity_zone, name, bootable, created_at, reference. Default=None.
2108
2109 --resource_uuid <resource_uuid>
2110 Filters results by a resource uuid. Default=None. This option is
2111 deprecated and will be removed in newer release. Please use
2112 '--filters' option which is introduced since 3.33 instead.
2113
2114 --resource_type <type>
2115 Filters results by a resource type. Default=None. This option is
2116 deprecated and will be removed in newer release. Please use
2117 '--filters' option which is introduced since 3.33 instead.
2118
2119 --event_id <id>
2120 Filters results by event id. Default=None. This option is depre‐
2121 cated and will be removed in newer release. Please use '--fil‐
2122 ters' option which is introduced since 3.33 instead.
2123
2124 --request_id <request_id>
2125 Filters results by request id. Default=None. This option is dep‐
2126 recated and will be removed in newer release. Please use '--fil‐
2127 ters' option which is introduced since 3.33 instead.
2128
2129 --level <level>
2130 Filters results by the message level. Default=None. This option
2131 is deprecated and will be removed in newer release. Please use
2132 '--filters' option which is introduced since 3.33 instead.
2133
2134 --filters <key=value>
2135 Filter key and value pairs. Please use 'cinder list-filters' to
2136 check enabled filters from server. Use 'key~=value' for inexact
2137 filtering if the key supports. Default=None.
2138
2139 cinder message-show
2140 usage: cinder message-show <message>
2141
2142 Shows message details.
2143
2144 Positional arguments:
2145
2146 <message>
2147 ID of message.
2148
2149 cinder metadata
2150 usage: cinder metadata <volume> <action> <key=value> [<key=value> ...]
2151
2152 Sets or deletes volume metadata.
2153
2154 Positional arguments:
2155
2156 <volume>
2157 Name or ID of volume for which to update metadata.
2158
2159 <action>
2160 The action. Valid values are "set" or "unset."
2161
2162 <key=value>
2163 Metadata key and value pair to set or unset. For unset, specify
2164 only the key(s): <key key>
2165
2166 cinder metadata-show
2167 usage: cinder metadata-show <volume>
2168
2169 Shows volume metadata.
2170
2171 Positional arguments:
2172
2173 <volume>
2174 ID of volume.
2175
2176 cinder metadata-update-all
2177 usage: cinder metadata-update-all <volume> <key=value> [<key=value> ...]
2178
2179 Updates volume metadata.
2180
2181 Positional arguments:
2182
2183 <volume>
2184 ID of volume for which to update metadata.
2185
2186 <key=value>
2187 Metadata key and value pair or pairs to update.
2188
2189 cinder migrate
2190 usage: cinder migrate [--force-host-copy [<True|False>]]
2191 [--lock-volume [<True|False>]] [--cluster CLUSTER]
2192 <volume> [<host>]
2193
2194 Migrates volume to a new host.
2195
2196 Positional arguments:
2197
2198 <volume>
2199 ID of volume to migrate.
2200
2201 <host> Destination host. Takes the form: host@backend-name#pool
2202
2203 Optional arguments:
2204
2205 --force-host-copy <True|False>
2206 Enables or disables generic host-based force-migration, which
2207 bypasses driver optimizations. Default=False.
2208
2209 --lock-volume <True|False>
2210 Enables or disables the termination of volume migration caused
2211 by other commands. This option applies to the available volume.
2212 True means it locks the volume state and does not allow the mi‐
2213 gration to be aborted. The volume status will be in maintenance
2214 during the migration. False means it allows the volume migration
2215 to be aborted. The volume status is still in the original sta‐
2216 tus. Default=False.
2217
2218 --cluster None
2219 Destination cluster. Takes the form: cluster@backend-name#pool
2220
2221 cinder qos-associate
2222 usage: cinder qos-associate <qos_specs> <volume_type_id>
2223
2224 Associates qos specs with specified volume type.
2225
2226 Positional arguments:
2227
2228 <qos_specs>
2229 ID of QoS specifications.
2230
2231 <volume_type_id>
2232 ID of volume type with which to associate QoS specifications.
2233
2234 cinder qos-create
2235 usage: cinder qos-create <name> <key=value> [<key=value> ...]
2236
2237 Creates a qos specs.
2238
2239 Positional arguments:
2240
2241 <name> Name of new QoS specifications.
2242
2243 <key=value>
2244 QoS specifications.
2245
2246 cinder qos-delete
2247 usage: cinder qos-delete [--force [<True|False>]] <qos_specs>
2248
2249 Deletes a specified qos specs.
2250
2251 Positional arguments:
2252
2253 <qos_specs>
2254 ID of QoS specifications to delete.
2255
2256 Optional arguments:
2257
2258 --force <True|False>
2259 Enables or disables deletion of in-use QoS specifications. De‐
2260 fault=False.
2261
2262 cinder qos-disassociate
2263 usage: cinder qos-disassociate <qos_specs> <volume_type_id>
2264
2265 Disassociates qos specs from specified volume type.
2266
2267 Positional arguments:
2268
2269 <qos_specs>
2270 ID of QoS specifications.
2271
2272 <volume_type_id>
2273 ID of volume type with which to associate QoS specifications.
2274
2275 cinder qos-disassociate-all
2276 usage: cinder qos-disassociate-all <qos_specs>
2277
2278 Disassociates qos specs from all its associations.
2279
2280 Positional arguments:
2281
2282 <qos_specs>
2283 ID of QoS specifications on which to operate.
2284
2285 cinder qos-get-association
2286 usage: cinder qos-get-association <qos_specs>
2287
2288 Lists all associations for specified qos specs.
2289
2290 Positional arguments:
2291
2292 <qos_specs>
2293 ID of QoS specifications.
2294
2295 cinder qos-key
2296 usage: cinder qos-key <qos_specs> <action> key=value [key=value ...]
2297
2298 Sets or unsets specifications for a qos spec.
2299
2300 Positional arguments:
2301
2302 <qos_specs>
2303 ID of QoS specifications.
2304
2305 <action>
2306 The action. Valid values are "set" or "unset."
2307
2308 key=value
2309 Metadata key and value pair to set or unset. For unset, specify
2310 only the key.
2311
2312 cinder qos-list
2313 usage: cinder qos-list
2314
2315 Lists qos specs.
2316
2317 cinder qos-show
2318 usage: cinder qos-show <qos_specs>
2319
2320 Shows qos specs details.
2321
2322 Positional arguments:
2323
2324 <qos_specs>
2325 ID of QoS specifications to show.
2326
2327 cinder quota-class-show
2328 usage: cinder quota-class-show <class>
2329
2330 Lists quotas for a quota class.
2331
2332 Positional arguments:
2333
2334 <class>
2335 Name of quota class for which to list quotas.
2336
2337 cinder quota-class-update
2338 usage: cinder quota-class-update [--volumes <volumes>]
2339 [--snapshots <snapshots>]
2340 [--gigabytes <gigabytes>]
2341 [--backups <backups>]
2342 [--backup-gigabytes <backup_gigabytes>]
2343 [--volume-type <volume_type_name>]
2344 [--per-volume-gigabytes <per_volume_gigabytes>]
2345 <class_name>
2346
2347 Updates quotas for a quota class.
2348
2349 Positional arguments:
2350
2351 <class_name>
2352 Name of quota class for which to set quotas.
2353
2354 Optional arguments:
2355
2356 --volumes <volumes>
2357 The new "volumes" quota value. Default=None.
2358
2359 --snapshots <snapshots>
2360 The new "snapshots" quota value. Default=None.
2361
2362 --gigabytes <gigabytes>
2363 The new "gigabytes" quota value. Default=None.
2364
2365 --backups <backups>
2366 The new "backups" quota value. Default=None.
2367
2368 --backup-gigabytes <backup_gigabytes>
2369 The new "backup_gigabytes" quota value. Default=None.
2370
2371 --volume-type <volume_type_name>
2372 Volume type. Default=None.
2373
2374 --per-volume-gigabytes <per_volume_gigabytes>
2375 Set max volume size limit. Default=None.
2376
2377 cinder quota-defaults
2378 usage: cinder quota-defaults <tenant_id>
2379
2380 Lists default quotas for a tenant.
2381
2382 Positional arguments:
2383
2384 <tenant_id>
2385 ID of tenant for which to list quota defaults.
2386
2387 cinder quota-delete
2388 usage: cinder quota-delete <tenant_id>
2389
2390 Delete the quotas for a tenant.
2391
2392 Positional arguments:
2393
2394 <tenant_id>
2395 UUID of tenant to delete the quotas for.
2396
2397 cinder quota-show
2398 usage: cinder quota-show <tenant_id>
2399
2400 Lists quotas for a tenant.
2401
2402 Positional arguments:
2403
2404 <tenant_id>
2405 ID of tenant for which to list quotas.
2406
2407 cinder quota-update
2408 usage: cinder quota-update [--volumes <volumes>] [--snapshots <snapshots>]
2409 [--gigabytes <gigabytes>] [--backups <backups>]
2410 [--backup-gigabytes <backup_gigabytes>]
2411 [--groups <groups>]
2412 [--volume-type <volume_type_name>]
2413 [--per-volume-gigabytes <per_volume_gigabytes>]
2414 [--skip-validation <skip_validation>]
2415 <tenant_id>
2416
2417 Updates quotas for a tenant.
2418
2419 Positional arguments:
2420
2421 <tenant_id>
2422 ID of tenant for which to set quotas.
2423
2424 Optional arguments:
2425
2426 --volumes <volumes>
2427 The new "volumes" quota value. Default=None.
2428
2429 --snapshots <snapshots>
2430 The new "snapshots" quota value. Default=None.
2431
2432 --gigabytes <gigabytes>
2433 The new "gigabytes" quota value. Default=None.
2434
2435 --backups <backups>
2436 The new "backups" quota value. Default=None.
2437
2438 --backup-gigabytes <backup_gigabytes>
2439 The new "backup_gigabytes" quota value. Default=None.
2440
2441 --groups <groups>
2442 The new "groups" quota value. Default=None.
2443
2444 --volume-type <volume_type_name>
2445 Volume type. Default=None.
2446
2447 --per-volume-gigabytes <per_volume_gigabytes>
2448 Set max volume size limit. Default=None.
2449
2450 --skip-validation <skip_validation>
2451 Skip validate the existing resource quota. Default=False.
2452
2453 cinder quota-usage
2454 usage: cinder quota-usage <tenant_id>
2455
2456 Lists quota usage for a tenant.
2457
2458 Positional arguments:
2459
2460 <tenant_id>
2461 ID of tenant for which to list quota usage.
2462
2463 cinder rate-limits
2464 usage: cinder rate-limits [<tenant_id>]
2465
2466 Lists rate limits for a user.
2467
2468 Positional arguments:
2469
2470 <tenant_id>
2471 Display information for a single tenant (Admin only).
2472
2473 cinder readonly-mode-update
2474 usage: cinder readonly-mode-update <volume> <True|true|False|false>
2475
2476 Updates volume read-only access-mode flag.
2477
2478 Positional arguments:
2479
2480 <volume>
2481 ID of volume to update.
2482
2483 <True|true|False|false>
2484 Enables or disables update of volume to read-only access mode.
2485
2486 cinder reimage
2487 usage: cinder reimage [--reimage-reserved <True|False>] <volume> <image-id>
2488
2489 Rebuilds a volume, overwriting all content with the specified image
2490
2491 Positional arguments:
2492
2493 <volume>
2494 Name or ID of volume to reimage
2495
2496 <image-id>
2497 The image id of the image that will be used to reimage the vol‐
2498 ume.
2499
2500 Optional arguments:
2501
2502 --reimage-reserved <True|False>
2503 Enables or disables reimage for a volume that is in reserved
2504 state otherwise only volumes in "available" or "error" status
2505 may be re-imaged. Default=False.
2506
2507 cinder rename
2508 usage: cinder rename [--description <description>] <volume> [<name>]
2509
2510 Renames a volume.
2511
2512 Positional arguments:
2513
2514 <volume>
2515 Name or ID of volume to rename.
2516
2517 <name> New name for volume.
2518
2519 Optional arguments:
2520
2521 --description <description>
2522 Volume description. Default=None.
2523
2524 cinder reset-state
2525 usage: cinder reset-state [--type <type>] [--state <state>]
2526 [--attach-status <attach-status>]
2527 [--reset-migration-status]
2528 <entity> [<entity> ...]
2529
2530 Explicitly updates the entity state in the Cinder database.
2531
2532 Positional arguments:
2533
2534 <entity>
2535 Name or ID of entity to update.
2536
2537 Optional arguments:
2538
2539 --type <type>
2540 Type of entity to update. Available resources are: 'volume',
2541 'snapshot', 'backup', 'group' (since 3.20) and 'group-snapshot'
2542 (since 3.19), Default=volume.
2543
2544 --state <state>
2545 The state to assign to the entity. NOTE: This command simply
2546 changes the state of the entity in the database with no regard
2547 to actual status, exercise caution when using. Default=None,
2548 that means the state is unchanged.
2549
2550 --attach-status <attach-status>
2551 This is only used for a volume entity. The attach status to as‐
2552 sign to the volume in the database, with no regard to the actual
2553 status. Valid values are "attached" and "detached". De‐
2554 fault=None, that means the status is unchanged.
2555
2556 --reset-migration-status None
2557 This is only used for a volume entity. Clears the migration sta‐
2558 tus of the volume in the DataBase that indicates the volume is
2559 source or destination of volume migration, with no regard to the
2560 actual status.
2561
2562 cinder retype
2563 usage: cinder retype [--migration-policy <never|on-demand>]
2564 <volume> <volume-type>
2565
2566 Changes the volume type for a volume.
2567
2568 Positional arguments:
2569
2570 <volume>
2571 Name or ID of volume for which to modify type.
2572
2573 <volume-type>
2574 New volume type.
2575
2576 Optional arguments:
2577
2578 --migration-policy <never|on-demand>
2579 Migration policy during retype of volume.
2580
2581 cinder revert-to-snapshot
2582 usage: cinder revert-to-snapshot <snapshot>
2583
2584 Revert a volume to the specified snapshot.
2585
2586 Positional arguments:
2587
2588 <snapshot>
2589 Name or ID of the snapshot to restore. The snapshot must be the
2590 most recent one known to cinder.
2591
2592 cinder service-disable
2593 usage: cinder service-disable [--reason <reason>] <hostname> <binary>
2594
2595 Disables the service.
2596
2597 Positional arguments:
2598
2599 <hostname>
2600 Host name.
2601
2602 <binary>
2603 Service binary.
2604
2605 Optional arguments:
2606
2607 --reason <reason>
2608 Reason for disabling service.
2609
2610 cinder service-enable
2611 usage: cinder service-enable <hostname> <binary>
2612
2613 Enables the service.
2614
2615 Positional arguments:
2616
2617 <hostname>
2618 Host name.
2619
2620 <binary>
2621 Service binary.
2622
2623 cinder service-get-log
2624 usage: cinder service-get-log
2625 [--binary {,*,cinder-api,cinder-volume,cinder-scheduler,cinder-backup}]
2626 [--server SERVER] [--prefix PREFIX]
2627
2628 Gets the service log level.
2629
2630 Optional arguments:
2631
2632 --binary None
2633 Binary to query.
2634
2635 --server None
2636 Host or cluster value for service.
2637
2638 --prefix None
2639 Prefix for the log. ie: "sqlalchemy.".
2640
2641 cinder service-list
2642 usage: cinder service-list [--host <hostname>] [--binary <binary>]
2643 [--withreplication [<True|False>]]
2644
2645 Lists all services. Filter by host and service binary.
2646
2647 Optional arguments:
2648
2649 --host <hostname>
2650 Host name. Default=None.
2651
2652 --binary <binary>
2653 Service binary. Default=None.
2654
2655 --withreplication <True|False>
2656 Enables or disables display of Replication info for c-vol ser‐
2657 vices. Default=False.
2658
2659 cinder service-set-log
2660 usage: cinder service-set-log
2661 [--binary {,*,cinder-api,cinder-volume,cinder-scheduler,cinder-backup}]
2662 [--server SERVER] [--prefix PREFIX]
2663 <log-level>
2664
2665 Sets the service log level.
2666
2667 Positional arguments:
2668
2669 <log-level>
2670 Desired log level.
2671
2672 Optional arguments:
2673
2674 --binary None
2675 Binary to change.
2676
2677 --server None
2678 Host or cluster value for service.
2679
2680 --prefix None
2681 Prefix for the log. ie: "cinder.volume.drivers.".
2682
2683 cinder set-bootable
2684 usage: cinder set-bootable <volume> <True|true|False|false>
2685
2686 Update bootable status of a volume.
2687
2688 Positional arguments:
2689
2690 <volume>
2691 ID of the volume to update.
2692
2693 <True|true|False|false>
2694 Flag to indicate whether volume is bootable.
2695
2696 cinder show
2697 usage: cinder show <volume>
2698
2699 Shows volume details.
2700
2701 Positional arguments:
2702
2703 <volume>
2704 Name or ID of volume.
2705
2706 cinder snapshot-create
2707 usage: cinder snapshot-create [--name <name>] [--description <description>]
2708 [--metadata [<key=value> ...]]
2709 <volume>
2710
2711 Creates a snapshot.
2712
2713 Positional arguments:
2714
2715 <volume>
2716 Name or ID of volume to snapshot.
2717
2718 Optional arguments:
2719
2720 --name <name>
2721 Snapshot name. Default=None.
2722
2723 --description <description>
2724 Snapshot description. Default=None.
2725
2726 --metadata <key=value>
2727 Snapshot metadata key and value pairs. Default=None.
2728
2729 cinder snapshot-delete
2730 usage: cinder snapshot-delete [--force] <snapshot> [<snapshot> ...]
2731
2732 Removes one or more snapshots.
2733
2734 Positional arguments:
2735
2736 <snapshot>
2737 Name or ID of the snapshot(s) to delete.
2738
2739 Optional arguments:
2740
2741 --force None
2742 Allows deleting snapshot of a volume when its status is other
2743 than "available" or "error". Default=False.
2744
2745 cinder snapshot-list
2746 usage: cinder snapshot-list [--all-tenants [<0|1>]] [--name <name>]
2747 [--status <status>] [--volume-id <volume-id>]
2748 [--marker <marker>] [--limit <limit>]
2749 [--sort <key>[:<direction>]] [--tenant [<tenant>]]
2750 [--metadata [<key=value> ...]]
2751 [--filters [<key=value> ...]]
2752 [--with-count [<True|False>]]
2753
2754 Lists all snapshots.
2755
2756 Optional arguments:
2757
2758 --all-tenants <0|1>
2759 Shows details for all tenants. Admin only.
2760
2761 --name <name>
2762 Filters results by a name. Default=None. This option is depre‐
2763 cated and will be removed in newer release. Please use '--fil‐
2764 ters' option which is introduced since 3.33 instead.
2765
2766 --status <status>
2767 Filters results by a status. Default=None. This option is depre‐
2768 cated and will be removed in newer release. Please use '--fil‐
2769 ters' option which is introduced since 3.33 instead.
2770
2771 --volume-id <volume-id>
2772 Filters results by a volume ID. Default=None. This option is
2773 deprecated and will be removed in newer release. Please use
2774 '--filters' option which is introduced since 3.33 instead.
2775
2776 --marker <marker>
2777 Begin returning snapshots that appear later in the snapshot list
2778 than that represented by this id. Default=None.
2779
2780 --limit <limit>
2781 Maximum number of snapshots to return. Default=None.
2782
2783 --sort <key>[:<direction>]
2784 Comma-separated list of sort keys and directions in the form of
2785 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
2786 ity_zone, name, bootable, created_at, reference. Default=None.
2787
2788 --tenant <tenant>
2789 Display information from single tenant (Admin only).
2790
2791 --metadata <key=value>
2792 Filters results by a metadata key and value pair. Require volume
2793 api version >=3.22. Default=None. This option is deprecated and
2794 will be removed in newer release. Please use '--filters' option
2795 which is introduced since 3.33 instead.
2796
2797 --filters <key=value>
2798 Filter key and value pairs. Please use 'cinder list-filters' to
2799 check enabled filters from server. Use 'key~=value' for inexact
2800 filtering if the key supports. Default=None.
2801
2802 --with-count <True|False>
2803 Show total number of snapshot entities. This is useful when pag‐
2804 ination is applied in the request.
2805
2806 cinder snapshot-manage
2807 usage: cinder snapshot-manage [--id-type <id-type>] [--name <name>]
2808 [--description <description>]
2809 [--metadata [<key=value> ...]]
2810 <volume> <identifier>
2811
2812 Manage an existing snapshot.
2813
2814 Positional arguments:
2815
2816 <volume>
2817 Cinder volume that already exists in the volume backend.
2818
2819 <identifier>
2820 Name or other identifier for existing snapshot. This is backend
2821 specific.
2822
2823 Optional arguments:
2824
2825 --id-type <id-type>
2826 Type of backend device identifier provided, typically
2827 source-name or source-id (Default=source-name).
2828
2829 --name <name>
2830 Snapshot name (Default=None).
2831
2832 --description <description>
2833 Snapshot description (Default=None).
2834
2835 --metadata <key=value>
2836 Metadata key=value pairs (Default=None).
2837
2838 cinder snapshot-manageable-list
2839 usage: cinder snapshot-manageable-list [--detailed <detailed>]
2840 [--marker <marker>] [--limit <limit>]
2841 [--offset <offset>]
2842 [--sort <key>[:<direction>]]
2843 [--cluster CLUSTER]
2844 [<host>]
2845
2846 Lists all manageable snapshots.
2847
2848 Positional arguments:
2849
2850 <host> Cinder host on which to list manageable snapshots; takes the
2851 form: host@backend-name#pool
2852
2853 Optional arguments:
2854
2855 --detailed <detailed>
2856 Returned detailed information (default true).
2857
2858 --marker <marker>
2859 Begin returning volumes that appear later in the volume list
2860 than that represented by this reference. This reference should
2861 be json like. Default=None.
2862
2863 --limit <limit>
2864 Maximum number of volumes to return. Default=None.
2865
2866 --offset <offset>
2867 Number of volumes to skip after marker. Default=None.
2868
2869 --sort <key>[:<direction>]
2870 Comma-separated list of sort keys and directions in the form of
2871 <key>[:<asc|desc>]. Valid keys: size, reference. Default=None.
2872
2873 --cluster None
2874 Cinder cluster on which to list manageable snapshots; takes the
2875 form: cluster@backend-name#pool
2876
2877 cinder snapshot-metadata
2878 usage: cinder snapshot-metadata <snapshot> <action> <key=value>
2879 [<key=value> ...]
2880
2881 Sets or deletes snapshot metadata.
2882
2883 Positional arguments:
2884
2885 <snapshot>
2886 ID of snapshot for which to update metadata.
2887
2888 <action>
2889 The action. Valid values are "set" or "unset."
2890
2891 <key=value>
2892 Metadata key and value pair to set or unset. For unset, specify
2893 only the key.
2894
2895 cinder snapshot-metadata-show
2896 usage: cinder snapshot-metadata-show <snapshot>
2897
2898 Shows snapshot metadata.
2899
2900 Positional arguments:
2901
2902 <snapshot>
2903 ID of snapshot.
2904
2905 cinder snapshot-metadata-update-all
2906 usage: cinder snapshot-metadata-update-all <snapshot> <key=value>
2907 [<key=value> ...]
2908
2909 Updates snapshot metadata.
2910
2911 Positional arguments:
2912
2913 <snapshot>
2914 ID of snapshot for which to update metadata.
2915
2916 <key=value>
2917 Metadata key and value pair to update.
2918
2919 cinder snapshot-rename
2920 usage: cinder snapshot-rename [--description <description>]
2921 <snapshot> [<name>]
2922
2923 Renames a snapshot.
2924
2925 Positional arguments:
2926
2927 <snapshot>
2928 Name or ID of snapshot.
2929
2930 <name> New name for snapshot.
2931
2932 Optional arguments:
2933
2934 --description <description>
2935 Snapshot description. Default=None.
2936
2937 cinder snapshot-reset-state
2938 usage: cinder snapshot-reset-state [--state <state>]
2939 <snapshot> [<snapshot> ...]
2940
2941 Explicitly updates the snapshot state.
2942
2943 Positional arguments:
2944
2945 <snapshot>
2946 Name or ID of snapshot to modify.
2947
2948 Optional arguments:
2949
2950 --state <state>
2951 The state to assign to the snapshot. Valid values are "avail‐
2952 able", "error", "creating", "deleting", and "error_deleting".
2953 NOTE: This command simply changes the state of the Snapshot in
2954 the DataBase with no regard to actual status, exercise caution
2955 when using. Default=available.
2956
2957 cinder snapshot-show
2958 usage: cinder snapshot-show <snapshot>
2959
2960 Shows snapshot details.
2961
2962 Positional arguments:
2963
2964 <snapshot>
2965 Name or ID of snapshot.
2966
2967 cinder snapshot-unmanage
2968 usage: cinder snapshot-unmanage <snapshot>
2969
2970 Stop managing a snapshot.
2971
2972 Positional arguments:
2973
2974 <snapshot>
2975 Name or ID of the snapshot to unmanage.
2976
2977 cinder summary
2978 usage: cinder summary [--all-tenants [<0|1>]]
2979
2980 Get volumes summary.
2981
2982 Optional arguments:
2983
2984 --all-tenants <0|1>
2985 Shows details for all tenants. Admin only.
2986
2987 cinder thaw-host
2988 usage: cinder thaw-host <hostname>
2989
2990 Thaw and enable the specified cinder-volume host.
2991
2992 Positional arguments:
2993
2994 <hostname>
2995 Host name.
2996
2997 cinder transfer-accept
2998 usage: cinder transfer-accept <transfer> <auth_key>
2999
3000 Accepts a volume transfer.
3001
3002 Positional arguments:
3003
3004 <transfer>
3005 ID of transfer to accept.
3006
3007 <auth_key>
3008 Authentication key of transfer to accept.
3009
3010 cinder transfer-create
3011 usage: cinder transfer-create [--name <name>] [--no-snapshots] <volume>
3012
3013 Creates a volume transfer.
3014
3015 Positional arguments:
3016
3017 <volume>
3018 Name or ID of volume to transfer.
3019
3020 Optional arguments:
3021
3022 --name <name>
3023 Transfer name. Default=None.
3024
3025 --no-snapshots None
3026 Allows or disallows transfer volumes without snapshots. De‐
3027 fault=False.
3028
3029 cinder transfer-delete
3030 usage: cinder transfer-delete <transfer>
3031
3032 Undoes a transfer.
3033
3034 Positional arguments:
3035
3036 <transfer>
3037 Name or ID of transfer to delete.
3038
3039 cinder transfer-list
3040 usage: cinder transfer-list [--all-tenants [<0|1>]]
3041 [--sort <key>[:<direction>]]
3042 [--filters [<key=value> ...]]
3043
3044 Lists all transfers.
3045
3046 Optional arguments:
3047
3048 --all-tenants <0|1>
3049 Shows details for all tenants. Admin only.
3050
3051 --sort <key>[:<direction>]
3052 Sort keys and directions in the form of <key>[:<asc|desc>].
3053
3054 --filters <key=value>
3055 Filter key and value pairs.
3056
3057 cinder transfer-show
3058 usage: cinder transfer-show <transfer>
3059
3060 Shows transfer details.
3061
3062 Positional arguments:
3063
3064 <transfer>
3065 Name or ID of transfer to accept.
3066
3067 cinder type-access-add
3068 usage: cinder type-access-add --volume-type <volume_type> --project-id
3069 <project_id>
3070
3071 Adds volume type access for the given project.
3072
3073 Optional arguments:
3074
3075 --volume-type <volume_type>
3076 Volume type name or ID to add access for the given project.
3077
3078 --project-id <project_id>
3079 Project ID to add volume type access for.
3080
3081 cinder type-access-list
3082 usage: cinder type-access-list --volume-type <volume_type>
3083
3084 Print access information about the given volume type.
3085
3086 Optional arguments:
3087
3088 --volume-type <volume_type>
3089 Filter results by volume type name or ID.
3090
3091 cinder type-access-remove
3092 usage: cinder type-access-remove --volume-type <volume_type> --project-id
3093 <project_id>
3094
3095 Removes volume type access for the given project.
3096
3097 Optional arguments:
3098
3099 --volume-type <volume_type>
3100 Volume type name or ID to remove access for the given project.
3101
3102 --project-id <project_id>
3103 Project ID to remove volume type access for.
3104
3105 cinder type-create
3106 usage: cinder type-create [--description <description>]
3107 [--is-public <is-public>]
3108 <name>
3109
3110 Creates a volume type.
3111
3112 Positional arguments:
3113
3114 <name> Name of new volume type.
3115
3116 Optional arguments:
3117
3118 --description <description>
3119 Description of new volume type.
3120
3121 --is-public <is-public>
3122 Make type accessible to the public (default true).
3123
3124 cinder type-default
3125 usage: cinder type-default
3126
3127 List the default volume type.
3128
3129 cinder type-delete
3130 usage: cinder type-delete <vol_type> [<vol_type> ...]
3131
3132 Deletes volume type or types.
3133
3134 Positional arguments:
3135
3136 <vol_type>
3137 Name or ID of volume type or types to delete.
3138
3139 cinder type-key
3140 usage: cinder type-key <vtype> <action> <key=value> [<key=value> ...]
3141
3142 Sets or unsets extra_spec for a volume type.
3143
3144 Positional arguments:
3145
3146 <vtype>
3147 Name or ID of volume type.
3148
3149 <action>
3150 The action. Valid values are "set" or "unset."
3151
3152 <key=value>
3153 The extra specs key and value pair to set or unset. For unset,
3154 specify only the key.
3155
3156 cinder type-list
3157 usage: cinder type-list [--filters [<key=value> ...]]
3158
3159 Lists available 'volume types'.
3160
3161 Optional arguments:
3162
3163 --filters <key=value>
3164 Filter key and value pairs. Admin only.
3165
3166 cinder type-show
3167 usage: cinder type-show <volume_type>
3168
3169 Show volume type details.
3170
3171 Positional arguments:
3172
3173 <volume_type>
3174 Name or ID of the volume type.
3175
3176 cinder type-update
3177 usage: cinder type-update [--name <name>] [--description <description>]
3178 [--is-public <is-public>]
3179 <id>
3180
3181 Updates volume type name, description, and/or is_public.
3182
3183 Positional arguments:
3184
3185 <id> ID of the volume type.
3186
3187 Optional arguments:
3188
3189 --name <name>
3190 Name of the volume type.
3191
3192 --description <description>
3193 Description of the volume type.
3194
3195 --is-public <is-public>
3196 Make type accessible to the public or not.
3197
3198 cinder unmanage
3199 usage: cinder unmanage <volume>
3200
3201 Stop managing a volume.
3202
3203 Positional arguments:
3204
3205 <volume>
3206 Name or ID of the volume to unmanage.
3207
3208 cinder upload-to-image
3209 usage: cinder upload-to-image [--force [<True|False>]]
3210 [--container-format <container-format>]
3211 [--disk-format <disk-format>]
3212 [--visibility <public|private|community|shared>]
3213 [--protected <True|False>]
3214 <volume> <image-name>
3215
3216 Uploads volume to Image Service as an image.
3217
3218 Positional arguments:
3219
3220 <volume>
3221 Name or ID of volume to snapshot.
3222
3223 <image-name>
3224 The new image name.
3225
3226 Optional arguments:
3227
3228 --force <True|False>
3229 Enables or disables upload of a volume that is attached to an
3230 instance. Default=False. This option may not be supported by
3231 your cloud.
3232
3233 --container-format <container-format>
3234 Container format type. Default is bare.
3235
3236 --disk-format <disk-format>
3237 Disk format type. Default is raw.
3238
3239 --visibility <public|private|community|shared>
3240 Set image visibility to public, private, community or shared.
3241 Default=private.
3242
3243 --protected <True|False>
3244 Prevents image from being deleted. Default=False.
3245
3246 cinder version-list
3247 usage: cinder version-list
3248
3249 List all API versions.
3250
3251 cinder work-cleanup
3252 usage: cinder work-cleanup [--cluster <cluster-name>] [--host <hostname>]
3253 [--binary <binary>]
3254 [--is-up <True|true|False|false>]
3255 [--disabled <True|true|False|false>]
3256 [--resource-id <resource-id>]
3257 [--resource-type <Volume|Snapshot>]
3258 [--service-id <service-id>]
3259
3260 Request cleanup of services with optional filtering.
3261
3262 Optional arguments:
3263
3264 --cluster <cluster-name>
3265 Cluster name. Default=None.
3266
3267 --host <hostname>
3268 Service host name. Default=None.
3269
3270 --binary <binary>
3271 Service binary. Default=None.
3272
3273 --is-up <True|true|False|false>
3274 Filter by up/down status, if set to true services need to be up,
3275 if set to false services need to be down. Default is None,
3276 which means up/down status is ignored.
3277
3278 --disabled <True|true|False|false>
3279 Filter by disabled status. Default=None.
3280
3281 --resource-id <resource-id>
3282 UUID of a resource to cleanup. Default=None.
3283
3284 --resource-type <Volume|Snapshot>
3285 Type of resource to cleanup.
3286
3287 --service-id <service-id>
3288 The service id field from the DB, not the uuid of the service.
3289 Default=None.
3290
3291 cinder help
3292 usage: cinder help [<subcommand>]
3293
3294 Shows help about this program or one of its subcommands.
3295
3296 Positional arguments:
3297
3298 <subcommand>
3299 Shows help for <subcommand>.
3300
3302 OpenStack Contributors
3303
3305 OpenStack Contributors
3306
3307
3308
3309
33108.3.0 Jul 22, 2022 CINDER(1)