1CINDER(1)                     python-cinderclient                    CINDER(1)
2
3
4

NAME

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

CINDER USAGE

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).Default=env[OS_VOLUME_API_VERSION].
139
140       --retries
141              Number of retries.
142
143       --service-name
144              Service name. Default=env[CINDER_SERVICE_NAME].
145
146       --service-type
147              Service type. For most actions, default is volume.
148
149       --timeout
150              Set request timeout (in seconds).
151
152       --version
153              show program's version number and exit
154
155       --volume-service-name
156              Volume service name. Default=env[CINDER_VOLUME_SERVICE_NAME].
157
158       -d, --debug
159              Shows debugging output.
160
161   Commands
162       absolute-limits
163              Lists absolute limits for a user.
164
165       api-version
166              Display the server API version information.
167
168       attachment-complete
169              Complete an attachment for a cinder volume.
170
171       attachment-create
172              Create an attachment for a cinder volume.
173
174       attachment-delete
175              Delete an attachment for a cinder volume.
176
177       attachment-list
178              Lists all attachments.
179
180       attachment-show
181              Show detailed information for attachment.
182
183       attachment-update
184              Update an attachment for a cinder volume.
185
186       availability-zone-list
187              Lists all availability zones.
188
189       backup-create
190              Creates a volume backup.
191
192       backup-delete
193              Removes one or more backups.
194
195       backup-export
196              Export backup metadata record.
197
198       backup-import
199              Import backup metadata record.
200
201       backup-list
202              Lists all backups.
203
204       backup-reset-state
205              Explicitly updates the backup state.
206
207       backup-restore
208              Restores a backup.
209
210       backup-show
211              Shows backup details.
212
213       backup-update
214              Updates a backup.
215
216       cgsnapshot-create
217              Creates a cgsnapshot.
218
219       cgsnapshot-delete
220              Removes one or more cgsnapshots.
221
222       cgsnapshot-list
223              Lists all cgsnapshots.
224
225       cgsnapshot-show
226              Shows cgsnapshot details.
227
228       cluster-disable
229              Disables clustered services.
230
231       cluster-enable
232              Enables clustered services.
233
234       cluster-list
235              Lists clustered services with optional filtering.
236
237       cluster-show
238              Show detailed information on a clustered service.
239
240       consisgroup-create
241              Creates a consistency group.
242
243       consisgroup-create-from-src
244              Creates a consistency group from a cgsnapshot or a source CG.
245
246       consisgroup-delete
247              Removes one or more consistency groups.
248
249       consisgroup-list
250              Lists all consistency groups.
251
252       consisgroup-show
253              Shows details of a consistency group.
254
255       consisgroup-update
256              Updates a consistency group.
257
258       create Creates a volume.
259
260       default-type-list
261              Lists all default volume types.
262
263       default-type-set
264              Sets a default volume type for a project.
265
266       default-type-unset
267              Unset default volume types.
268
269       delete Removes one or more volumes.
270
271       encryption-type-create
272              Creates encryption type for a volume type. Admin only.
273
274       encryption-type-delete
275              Deletes encryption type for a volume type. Admin only.
276
277       encryption-type-list
278              Shows encryption type details for volume types. Admin only.
279
280       encryption-type-show
281              Shows encryption type details for a volume type. Admin only.
282
283       encryption-type-update
284              Update encryption type information  for  a  volume  type  (Admin
285              Only).
286
287       extend Attempts to extend size of an existing volume.
288
289       extra-specs-list
290              Lists current volume types and extra specs.
291
292       failover-host
293              Failover a replicating cinder-volume host.
294
295       force-delete
296              Attempts force-delete of volume, regardless of state.
297
298       freeze-host
299              Freeze and disable the specified cinder-volume host.
300
301       get-capabilities
302              Show backend volume stats and properties. Admin only.
303
304       get-pools
305              Show pool information for backends. Admin only.
306
307       group-create
308              Creates a group.
309
310       group-create-from-src
311              Creates a group from a group snapshot or a source group.
312
313       group-delete
314              Removes one or more groups.
315
316       group-disable-replication
317              Disables replication for group.
318
319       group-enable-replication
320              Enables replication for group.
321
322       group-failover-replication
323              Fails over replication for group.
324
325       group-list
326              Lists all groups.
327
328       group-list-replication-targets
329              Lists replication targets for group.
330
331       group-show
332              Shows details of a group.
333
334       group-snapshot-create
335              Creates a group snapshot.
336
337       group-snapshot-delete
338              Removes one or more group snapshots.
339
340       group-snapshot-list
341              Lists all group snapshots.
342
343       group-snapshot-show
344              Shows group snapshot details.
345
346       group-specs-list
347              Lists current group types and specs.
348
349       group-type-create
350              Creates a group type.
351
352       group-type-default
353              List the default group type.
354
355       group-type-delete
356              Deletes group type or types.
357
358       group-type-key
359              Sets or unsets group_spec for a group type.
360
361       group-type-list
362              Lists  available  'group  types'.  (Admin  only will see private
363              types)
364
365       group-type-show
366              Show group type details.
367
368       group-type-update
369              Updates group type name, description, and/or is_public.
370
371       group-update
372              Updates a group.
373
374       image-metadata
375              Sets or deletes volume image metadata.
376
377       image-metadata-show
378              Shows volume image metadata.
379
380       list   Lists all volumes.
381
382       list-filters
383              List enabled filters.
384
385       manage Manage an existing volume.
386
387       manageable-list
388              Lists all manageable volumes.
389
390       message-delete
391              Removes one or more messages.
392
393       message-list
394              Lists all messages.
395
396       message-show
397              Shows message details.
398
399       metadata
400              Sets or deletes volume metadata.
401
402       metadata-show
403              Shows volume metadata.
404
405       metadata-update-all
406              Updates volume metadata.
407
408       migrate
409              Migrates volume to a new host.
410
411       qos-associate
412              Associates qos specs with specified volume type.
413
414       qos-create
415              Creates a qos specs.
416
417       qos-delete
418              Deletes a specified qos specs.
419
420       qos-disassociate
421              Disassociates qos specs from specified volume type.
422
423       qos-disassociate-all
424              Disassociates qos specs from all its associations.
425
426       qos-get-association
427              Lists all associations for specified qos specs.
428
429       qos-key
430              Sets or unsets specifications for a qos spec.
431
432       qos-list
433              Lists qos specs.
434
435       qos-show
436              Shows qos specs details.
437
438       quota-class-show
439              Lists quotas for a quota class.
440
441       quota-class-update
442              Updates quotas for a quota class.
443
444       quota-defaults
445              Lists default quotas for a tenant.
446
447       quota-delete
448              Delete the quotas for a tenant.
449
450       quota-show
451              Lists quotas for a tenant.
452
453       quota-update
454              Updates quotas for a tenant.
455
456       quota-usage
457              Lists quota usage for a tenant.
458
459       rate-limits
460              Lists rate limits for a user.
461
462       readonly-mode-update
463              Updates volume read-only access-mode flag.
464
465       rename Renames a volume.
466
467       reset-state
468              Explicitly updates the entity state in the Cinder database.
469
470       retype Changes the volume type for a volume.
471
472       revert-to-snapshot
473              Revert a volume to the specified snapshot.
474
475       service-disable
476              Disables the service.
477
478       service-enable
479              Enables the service.
480
481       service-get-log
482              Gets the service log level.
483
484       service-list
485              Lists all services. Filter by host and service binary.
486
487       service-set-log
488              Sets the service log level.
489
490       set-bootable
491              Update bootable status of a volume.
492
493       show   Shows volume details.
494
495       snapshot-create
496              Creates a snapshot.
497
498       snapshot-delete
499              Removes one or more snapshots.
500
501       snapshot-list
502              Lists all snapshots.
503
504       snapshot-manage
505              Manage an existing snapshot.
506
507       snapshot-manageable-list
508              Lists all manageable snapshots.
509
510       snapshot-metadata
511              Sets or deletes snapshot metadata.
512
513       snapshot-metadata-show
514              Shows snapshot metadata.
515
516       snapshot-metadata-update-all
517              Updates snapshot metadata.
518
519       snapshot-rename
520              Renames a snapshot.
521
522       snapshot-reset-state
523              Explicitly updates the snapshot state.
524
525       snapshot-show
526              Shows snapshot details.
527
528       snapshot-unmanage
529              Stop managing a snapshot.
530
531       summary
532              Get volumes summary.
533
534       thaw-host
535              Thaw and enable the specified cinder-volume host.
536
537       transfer-accept
538              Accepts a volume transfer.
539
540       transfer-create
541              Creates a volume transfer.
542
543       transfer-delete
544              Undoes a transfer.
545
546       transfer-list
547              Lists all transfers.
548
549       transfer-show
550              Shows transfer details.
551
552       type-access-add
553              Adds volume type access for the given project.
554
555       type-access-list
556              Print access information about the given volume type.
557
558       type-access-remove
559              Removes volume type access for the given project.
560
561       type-create
562              Creates a volume type.
563
564       type-default
565              List the default volume type.
566
567       type-delete
568              Deletes volume type or types.
569
570       type-key
571              Sets or unsets extra_spec for a volume type.
572
573       type-list
574              Lists available 'volume types'.
575
576       type-show
577              Show volume type details.
578
579       type-update
580              Updates volume type name, description, and/or is_public.
581
582       unmanage
583              Stop managing a volume.
584
585       upload-to-image
586              Uploads volume to Image Service as an image.
587
588       version-list
589              List all API versions.
590
591       work-cleanup
592              Request cleanup of services with optional filtering.
593
594       help   Shows help about this program or one of its subcommands.
595

COMMAND DETAILS

597   cinder absolute-limits
598          usage: cinder absolute-limits [<tenant_id>]
599
600       Lists absolute limits for a user.
601
602       Positional arguments:
603
604       <tenant_id>
605              Display information for a single tenant (Admin only).
606
607   cinder api-version
608          usage: cinder api-version
609
610       Display the server API version information.
611
612   cinder attachment-complete
613          usage: cinder attachment-complete <attachment> [<attachment> ...]
614
615       Complete an attachment for a cinder volume.
616
617       Positional arguments:
618
619       <attachment>
620              ID of attachment or attachments to delete.
621
622   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
630       Create an attachment for a cinder volume.
631
632       Positional arguments:
633
634       <volume>
635              Name or ID of volume or volumes to attach.
636
637       <server_id>
638              ID of server attaching to.
639
640       Optional arguments:
641
642       --connect <connect>
643              Make an active connection using provided connector info (True or
644              False).
645
646       --initiator <initiator>
647              iqn of the initiator attaching to.  Default=None.
648
649       --ip <ip>
650              ip of the system attaching to.  Default=None.
651
652       --host <host>
653              Name of the host attaching to. Default=None.
654
655       --platform <platform>
656              Platform type. Default=x86_64.
657
658       --ostype <ostype>
659              OS type. Default=linux2.
660
661       --multipath <multipath>
662              Use multipath. Default=False.
663
664       --mountpoint <mountpoint>
665              Mountpoint volume will be attached at. Default=None.
666
667       --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
672   cinder attachment-delete
673          usage: cinder attachment-delete <attachment> [<attachment> ...]
674
675       Delete an attachment for a cinder volume.
676
677       Positional arguments:
678
679       <attachment>
680              ID of attachment or attachments to delete.
681
682   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
690       Lists all attachments.
691
692       Optional arguments:
693
694       --all-tenants <0|1>
695              Shows details for all tenants. Admin only.
696
697       --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
702       --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
707       --marker <marker>
708              Begin returning attachments that appear later in attachment list
709              than that represented by this id. Default=None.
710
711       --limit <limit>
712              Maximum number of attachments to return. Default=None.
713
714       --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
719       --tenant <tenant>
720              Display information from single tenant (Admin only).
721
722       --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
727   cinder attachment-show
728          usage: cinder attachment-show <attachment>
729
730       Show detailed information for attachment.
731
732       Positional arguments:
733
734       <attachment>
735              ID of attachment.
736
737   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
744       Update an attachment for a cinder volume.
745
746       Positional arguments:
747
748       <attachment>
749              ID of attachment.
750
751       Optional arguments:
752
753       --initiator <initiator>
754              iqn of the initiator attaching to.  Default=None.
755
756       --ip <ip>
757              ip of the system attaching to.  Default=None.
758
759       --host <host>
760              Name of the host attaching to. Default=None.
761
762       --platform <platform>
763              Platform type. Default=x86_64.
764
765       --ostype <ostype>
766              OS type. Default=linux2.
767
768       --multipath <multipath>
769              Use multipath. Default=False.
770
771       --mountpoint <mountpoint>
772              Mountpoint volume will be attached at. Default=None.
773
774   cinder availability-zone-list
775          usage: cinder availability-zone-list
776
777       Lists all availability zones.
778
779   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
787       Creates a volume backup.
788
789       Positional arguments:
790
791       <volume>
792              Name or ID of volume to backup.
793
794       Optional arguments:
795
796       --container <container>
797              Backup container name. Default=None.
798
799       --name <name>
800              Backup name. Default=None.
801
802       --description <description>
803              Backup description. Default=None.
804
805       --incremental None
806              Incremental backup. Default=False.
807
808       --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
815       --snapshot-id <snapshot-id>
816              ID of snapshot to backup. Default=None.
817
818       --metadata <key=value>
819              Metadata key and value pairs. Default=None.
820
821       --availability-zone None
822              AZ where the backup should be stored, by default it will be  the
823              same as the source.
824
825   cinder backup-delete
826          usage: cinder backup-delete [--force] <backup> [<backup> ...]
827
828       Removes one or more backups.
829
830       Positional arguments:
831
832       <backup>
833              Name or ID of backup(s) to delete.
834
835       Optional arguments:
836
837       --force None
838              Allows deleting backup of a volume when its status is other than
839              "available" or "error". Default=False.
840
841   cinder backup-export
842          usage: cinder backup-export <backup>
843
844       Export backup metadata record.
845
846       Positional arguments:
847
848       <backup>
849              ID of the backup to export.
850
851   cinder backup-import
852          usage: cinder backup-import <backup_service> <backup_url>
853
854       Import backup metadata record.
855
856       Positional arguments:
857
858       <backup_service>
859              Backup service to use for importing the backup.
860
861       <backup_url>
862              Backup URL for importing the backup metadata.
863
864   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
872       Lists all backups.
873
874       Optional arguments:
875
876       --all-tenants <all_tenants>
877              Shows details for all tenants. Admin only.
878
879       --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
884       --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
889       --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
894       --marker <marker>
895              Begin returning backups that appear later  in  the  backup  list
896              than that represented by this id. Default=None.
897
898       --limit <limit>
899              Maximum number of backups to return. Default=None.
900
901       --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
906       --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
911       --with-count <True|False>
912              Show  total number of backup entities. This is useful when pagi‐
913              nation is applied in the request.
914
915   cinder backup-reset-state
916          usage: cinder backup-reset-state [--state <state>] <backup> [<backup> ...]
917
918       Explicitly updates the backup state.
919
920       Positional arguments:
921
922       <backup>
923              Name or ID of the backup to modify.
924
925       Optional arguments:
926
927       --state <state>
928              The state to assign to the backup. Valid values are "available",
929              "error". Default=available.
930
931   cinder backup-restore
932          usage: cinder backup-restore [--volume <volume>] [--name <name>]
933                                       [--volume-type <volume-type>]
934                                       [--availability-zone <AZ>]
935                                       <backup>
936
937       Restores a backup.
938
939       Positional arguments:
940
941       <backup>
942              Name or ID of backup to restore.
943
944       Optional arguments:
945
946       --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
950       --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
955       --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
959       --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
964   cinder backup-show
965          usage: cinder backup-show <backup>
966
967       Shows backup details.
968
969       Positional arguments:
970
971       <backup>
972              Name or ID of backup.
973
974   cinder backup-update
975          usage: cinder backup-update [--name [<name>]] [--description <description>]
976                                      [--metadata [<key=value> ...]]
977                                      <backup>
978
979       Updates a backup.
980
981       Positional arguments:
982
983       <backup>
984              Name or ID of backup to rename.
985
986       Optional arguments:
987
988       --name <name>
989              New name for backup.
990
991       --description <description>
992              Backup description. Default=None.
993
994       --metadata <key=value>
995              Metadata key and value pairs. Default=None.
996
997   cinder cgsnapshot-create
998          usage: cinder cgsnapshot-create [--name <name>] [--description <description>]
999                                          <consistencygroup>
1000
1001       Creates a cgsnapshot.
1002
1003       Positional arguments:
1004
1005       <consistencygroup>
1006              Name or ID of a consistency group.
1007
1008       Optional arguments:
1009
1010       --name <name>
1011              Cgsnapshot name. Default=None.
1012
1013       --description <description>
1014              Cgsnapshot description. Default=None.
1015
1016   cinder cgsnapshot-delete
1017          usage: cinder cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]
1018
1019       Removes one or more cgsnapshots.
1020
1021       Positional arguments:
1022
1023       <cgsnapshot>
1024              Name or ID of one or more cgsnapshots to be deleted.
1025
1026   cinder cgsnapshot-list
1027          usage: cinder cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>]
1028                                        [--consistencygroup-id <consistencygroup_id>]
1029
1030       Lists all cgsnapshots.
1031
1032       Optional arguments:
1033
1034       --all-tenants <0|1>
1035              Shows details for all tenants. Admin only.
1036
1037       --status <status>
1038              Filters results by a status. Default=None.
1039
1040       --consistencygroup-id <consistencygroup_id>
1041              Filters results by a consistency group ID. Default=None.
1042
1043   cinder cgsnapshot-show
1044          usage: cinder cgsnapshot-show <cgsnapshot>
1045
1046       Shows cgsnapshot details.
1047
1048       Positional arguments:
1049
1050       <cgsnapshot>
1051              Name or ID of cgsnapshot.
1052
1053   cinder cluster-disable
1054          usage: cinder cluster-disable [--reason <reason>] [<binary>] <cluster-name>
1055
1056       Disables clustered services.
1057
1058       Positional arguments:
1059
1060       <binary>
1061              Binary to filter by.  Default: cinder-volume.
1062
1063       <cluster-name>
1064              Name of the clustered services to update.
1065
1066       Optional arguments:
1067
1068       --reason <reason>
1069              Reason for disabling clustered service.
1070
1071   cinder cluster-enable
1072          usage: cinder cluster-enable [<binary>] <cluster-name>
1073
1074       Enables clustered services.
1075
1076       Positional arguments:
1077
1078       <binary>
1079              Binary to filter by.  Default: cinder-volume.
1080
1081       <cluster-name>
1082              Name of the clustered services to update.
1083
1084   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
1091       Lists clustered services with optional filtering.
1092
1093       Optional arguments:
1094
1095       --name <name>
1096              Filter  by cluster name, without backend will list all clustered
1097              services from the same cluster. Default=None.
1098
1099       --binary <binary>
1100              Cluster binary. Default=None.
1101
1102       --is-up <True|true|False|false>
1103              Filter by up/down status. Default=None.
1104
1105       --disabled <True|true|False|false>
1106              Filter by disabled status. Default=None.
1107
1108       --num-hosts <num-hosts>
1109              Filter by number of hosts in the cluster.
1110
1111       --num-down-hosts <num-down-hosts>
1112              Filter by number of hosts that are down.
1113
1114       --detailed None
1115              Get detailed clustered service information (Default=False).
1116
1117   cinder cluster-show
1118          usage: cinder cluster-show [<binary>] <cluster-name>
1119
1120       Show detailed information on a clustered service.
1121
1122       Positional arguments:
1123
1124       <binary>
1125              Binary to filter by.  Default: cinder-volume.
1126
1127       <cluster-name>
1128              Name of the clustered service to show.
1129
1130   cinder consisgroup-create
1131          usage: cinder consisgroup-create [--name <name>] [--description <description>]
1132                                           [--availability-zone <availability-zone>]
1133                                           <volume-types>
1134
1135       Creates a consistency group.
1136
1137       Positional arguments:
1138
1139       <volume-types>
1140              Volume types.
1141
1142       Optional arguments:
1143
1144       --name <name>
1145              Name of a consistency group.
1146
1147       --description <description>
1148              Description of a consistency group. Default=None.
1149
1150       --availability-zone <availability-zone>
1151              Availability zone for volume. Default=None.
1152
1153   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
1159       Creates a consistency group from a cgsnapshot or a source CG.
1160
1161       Optional arguments:
1162
1163       --cgsnapshot <cgsnapshot>
1164              Name or ID of a cgsnapshot. Default=None.
1165
1166       --source-cg <source-cg>
1167              Name or ID of a source CG. Default=None.
1168
1169       --name <name>
1170              Name of a consistency group. Default=None.
1171
1172       --description <description>
1173              Description of a consistency group. Default=None.
1174
1175   cinder consisgroup-delete
1176          usage: cinder consisgroup-delete [--force]
1177                                           <consistencygroup> [<consistencygroup> ...]
1178
1179       Removes one or more consistency groups.
1180
1181       Positional arguments:
1182
1183       <consistencygroup>
1184              Name or ID of one or more consistency groups to be deleted.
1185
1186       Optional arguments:
1187
1188       --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
1194   cinder consisgroup-list
1195          usage: cinder consisgroup-list [--all-tenants [<0|1>]]
1196
1197       Lists all consistency groups.
1198
1199       Optional arguments:
1200
1201       --all-tenants <0|1>
1202              Shows details for all tenants. Admin only.
1203
1204   cinder consisgroup-show
1205          usage: cinder consisgroup-show <consistencygroup>
1206
1207       Shows details of a consistency group.
1208
1209       Positional arguments:
1210
1211       <consistencygroup>
1212              Name or ID of a consistency group.
1213
1214   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
1220       Updates a consistency group.
1221
1222       Positional arguments:
1223
1224       <consistencygroup>
1225              Name or ID of a consistency group.
1226
1227       Optional arguments:
1228
1229       --name <name>
1230              New name for consistency group. Default=None.
1231
1232       --description <description>
1233              New description for consistency group. Default=None.
1234
1235       --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
1239       --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
1243   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
1255       Creates a volume.
1256
1257       Positional arguments:
1258
1259       <size> Size    of    volume,    in   GiBs.   (Required   unless   snap‐
1260              shot-id/source-volid/backup-id is specified).
1261
1262       Optional arguments:
1263
1264       --consisgroup-id <consistencygroup-id>
1265              ID of a consistency group where the new volume belongs  to.  De‐
1266              fault=None.
1267
1268       --group-id <group-id>
1269              ID of a group where the new volume belongs to. Default=None.
1270
1271       --snapshot-id <snapshot-id>
1272              Creates volume from snapshot ID. Default=None.
1273
1274       --source-volid <source-volid>
1275              Creates volume from volume ID. Default=None.
1276
1277       --image-id <image-id>
1278              Creates volume from image ID. Default=None.
1279
1280       --image <image>
1281              Creates a volume from image (ID or name). Default=None.
1282
1283       --backup-id <backup-id>
1284              Creates a volume from backup ID. Default=None.
1285
1286       --name <name>
1287              Volume name. Default=None.
1288
1289       --description <description>
1290              Volume description. Default=None.
1291
1292       --volume-type <volume-type>
1293              Volume type. Default=None.
1294
1295       --availability-zone <availability-zone>
1296              Availability zone for volume. Default=None.
1297
1298       --metadata <key=value>
1299              Metadata key and value pairs. Default=None.
1300
1301       --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
1305       --poll None
1306              Wait for volume creation until it completes.
1307
1308   cinder default-type-list
1309          usage: cinder default-type-list [--project-id <project_id>]
1310
1311       Lists all default volume types.
1312
1313       Optional arguments:
1314
1315       --project-id <project_id>
1316              ID of project for which to show the default type.
1317
1318   cinder default-type-set
1319          usage: cinder default-type-set <volume_type> <project_id>
1320
1321       Sets a default volume type for a project.
1322
1323       Positional arguments:
1324
1325       <volume_type>
1326              Name or ID of the volume type.
1327
1328       <project_id>
1329              ID of project for which to set default type.
1330
1331   cinder default-type-unset
1332          usage: cinder default-type-unset <project_id> [<project_id> ...]
1333
1334       Unset default volume types.
1335
1336       Positional arguments:
1337
1338       <project_id>
1339              ID of project for which to unset default type.
1340
1341   cinder delete
1342          usage: cinder delete [--cascade] <volume> [<volume> ...]
1343
1344       Removes one or more volumes.
1345
1346       Positional arguments:
1347
1348       <volume>
1349              Name or ID of volume or volumes to delete.
1350
1351       Optional arguments:
1352
1353       --cascade None
1354              Remove any snapshots along with volume. Default=False.
1355
1356   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
1362       Creates encryption type for a volume type. Admin only.
1363
1364       Positional arguments:
1365
1366       <volume_type>
1367              Name or ID of volume type.
1368
1369       <provider>
1370              The encryption provider format. For example, "luks" or "plain".
1371
1372       Optional arguments:
1373
1374       --cipher <cipher>
1375              The encryption algorithm or mode. For example,  aes-xts-plain64.
1376              Default=None.
1377
1378       --key-size <key_size>
1379              Size  of  encryption  key, in bits. For example, 128 or 256. De‐
1380              fault=None.
1381
1382       --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
1387   cinder encryption-type-delete
1388          usage: cinder encryption-type-delete <volume_type>
1389
1390       Deletes encryption type for a volume type. Admin only.
1391
1392       Positional arguments:
1393
1394       <volume_type>
1395              Name or ID of volume type.
1396
1397   cinder encryption-type-list
1398          usage: cinder encryption-type-list
1399
1400       Shows encryption type details for volume types. Admin only.
1401
1402   cinder encryption-type-show
1403          usage: cinder encryption-type-show <volume_type>
1404
1405       Shows encryption type details for a volume type. Admin only.
1406
1407       Positional arguments:
1408
1409       <volume_type>
1410              Name or ID of volume type.
1411
1412   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
1419       Update encryption type information for a volume type (Admin Only).
1420
1421       Positional arguments:
1422
1423       <volume-type>
1424              Name or ID of the volume type
1425
1426       Optional arguments:
1427
1428       --provider <provider>
1429              Encryption provider format (e.g. 'luks' or 'plain').
1430
1431       --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
1435       --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
1439       --control-location <control-location>
1440              Notional  service   where   encryption   is   performed   (e.g.,
1441              front-end=Nova). Values: 'front-end', 'back-end'
1442
1443   cinder extend
1444          usage: cinder extend <volume> <new_size>
1445
1446       Attempts to extend size of an existing volume.
1447
1448       Positional arguments:
1449
1450       <volume>
1451              Name or ID of volume to extend.
1452
1453       <new_size>
1454              New size of volume, in GiBs.
1455
1456   cinder extra-specs-list
1457          usage: cinder extra-specs-list
1458
1459       Lists current volume types and extra specs.
1460
1461   cinder failover-host
1462          usage: cinder failover-host [--backend_id <backend-id>] <hostname>
1463
1464       Failover a replicating cinder-volume host.
1465
1466       Positional arguments:
1467
1468       <hostname>
1469              Host name.
1470
1471       Optional arguments:
1472
1473       --backend_id <backend-id>
1474              ID of backend to failover to (Default=None)
1475
1476   cinder force-delete
1477          usage: cinder force-delete <volume> [<volume> ...]
1478
1479       Attempts force-delete of volume, regardless of state.
1480
1481       Positional arguments:
1482
1483       <volume>
1484              Name or ID of volume or volumes to delete.
1485
1486   cinder freeze-host
1487          usage: cinder freeze-host <hostname>
1488
1489       Freeze and disable the specified cinder-volume host.
1490
1491       Positional arguments:
1492
1493       <hostname>
1494              Host name.
1495
1496   cinder get-capabilities
1497          usage: cinder get-capabilities <host>
1498
1499       Show backend volume stats and properties. Admin only.
1500
1501       Positional arguments:
1502
1503       <host> Cinder  host  to show backend volume stats and properties; takes
1504              the form: host@backend-name
1505
1506   cinder get-pools
1507          usage: cinder get-pools [--detail] [--filters [<key=value> ...]]
1508
1509       Show pool information for backends. Admin only.
1510
1511       Optional arguments:
1512
1513       --detail None
1514              Show detailed information about pools.
1515
1516       --filters <key=value>
1517              Filter key and value pairs. Please use 'cinder list-filters'  to
1518              check enabled filters from server, Default=None.
1519
1520   cinder group-create
1521          usage: cinder group-create [--name <name>] [--description <description>]
1522                                     [--availability-zone <availability-zone>]
1523                                     <group-type> <volume-types>
1524
1525       Creates a group.
1526
1527       Positional arguments:
1528
1529       <group-type>
1530              Group type.
1531
1532       <volume-types>
1533              Comma-separated list of volume types.
1534
1535       Optional arguments:
1536
1537       --name <name>
1538              Name of a group.
1539
1540       --description <description>
1541              Description of a group. Default=None.
1542
1543       --availability-zone <availability-zone>
1544              Availability zone for group. Default=None.
1545
1546   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
1552       Creates a group from a group snapshot or a source group.
1553
1554       Optional arguments:
1555
1556       --group-snapshot <group-snapshot>
1557              Name or ID of a group snapshot. Default=None.
1558
1559       --source-group <source-group>
1560              Name or ID of a source group. Default=None.
1561
1562       --name <name>
1563              Name of a group. Default=None.
1564
1565       --description <description>
1566              Description of a group. Default=None.
1567
1568   cinder group-delete
1569          usage: cinder group-delete [--delete-volumes] <group> [<group> ...]
1570
1571       Removes one or more groups.
1572
1573       Positional arguments:
1574
1575       <group>
1576              Name or ID of one or more groups to be deleted.
1577
1578       Optional arguments:
1579
1580       --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
1587   cinder group-disable-replication
1588          usage: cinder group-disable-replication <group>
1589
1590       Disables replication for group.
1591
1592       Positional arguments:
1593
1594       <group>
1595              Name or ID of the group.
1596
1597   cinder group-enable-replication
1598          usage: cinder group-enable-replication <group>
1599
1600       Enables replication for group.
1601
1602       Positional arguments:
1603
1604       <group>
1605              Name or ID of the group.
1606
1607   cinder group-failover-replication
1608          usage: cinder group-failover-replication [--allow-attached-volume]
1609                                                   [--secondary-backend-id <secondary_backend_id>]
1610                                                   <group>
1611
1612       Fails over replication for group.
1613
1614       Positional arguments:
1615
1616       <group>
1617              Name or ID of the group.
1618
1619       Optional arguments:
1620
1621       --allow-attached-volume None
1622              Allows  or  disallows  group  with attached volumes to be failed
1623              over.
1624
1625       --secondary-backend-id <secondary_backend_id>
1626              Secondary backend id. Default=None.
1627
1628   cinder group-list
1629          usage: cinder group-list [--all-tenants [<0|1>]] [--filters [<key=value> ...]]
1630
1631       Lists all groups.
1632
1633       Optional arguments:
1634
1635       --all-tenants <0|1>
1636              Shows details for all tenants. Admin only.
1637
1638       --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
1643   cinder group-list-replication-targets
1644          usage: cinder group-list-replication-targets <group>
1645
1646       Lists replication targets for group.
1647
1648       Positional arguments:
1649
1650       <group>
1651              Name or ID of the group.
1652
1653   cinder group-show
1654          usage: cinder group-show [--list-volume [<False|True>]] <group>
1655
1656       Shows details of a group.
1657
1658       Positional arguments:
1659
1660       <group>
1661              Name or ID of a group.
1662
1663       Optional arguments:
1664
1665       --list-volume <False|True>
1666              Shows volumes included in the group.
1667
1668   cinder group-snapshot-create
1669          usage: cinder group-snapshot-create [--name <name>]
1670                                              [--description <description>]
1671                                              <group>
1672
1673       Creates a group snapshot.
1674
1675       Positional arguments:
1676
1677       <group>
1678              Name or ID of a group.
1679
1680       Optional arguments:
1681
1682       --name <name>
1683              Group snapshot name. Default=None.
1684
1685       --description <description>
1686              Group snapshot description. Default=None.
1687
1688   cinder group-snapshot-delete
1689          usage: cinder group-snapshot-delete <group_snapshot> [<group_snapshot> ...]
1690
1691       Removes one or more group snapshots.
1692
1693       Positional arguments:
1694
1695       <group_snapshot>
1696              Name or ID of one or more group snapshots to be deleted.
1697
1698   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
1703       Lists all group snapshots.
1704
1705       Optional arguments:
1706
1707       --all-tenants <0|1>
1708              Shows details for all tenants. Admin only.
1709
1710       --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
1715       --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
1720       --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
1725   cinder group-snapshot-show
1726          usage: cinder group-snapshot-show <group_snapshot>
1727
1728       Shows group snapshot details.
1729
1730       Positional arguments:
1731
1732       <group_snapshot>
1733              Name or ID of group snapshot.
1734
1735   cinder group-specs-list
1736          usage: cinder group-specs-list
1737
1738       Lists current group types and specs.
1739
1740   cinder group-type-create
1741          usage: cinder group-type-create [--description <description>]
1742                                          [--is-public <is-public>]
1743                                          <name>
1744
1745       Creates a group type.
1746
1747       Positional arguments:
1748
1749       <name> Name of new group type.
1750
1751       Optional arguments:
1752
1753       --description <description>
1754              Description of new group type.
1755
1756       --is-public <is-public>
1757              Make type accessible to the public (default true).
1758
1759   cinder group-type-default
1760          usage: cinder group-type-default
1761
1762       List the default group type.
1763
1764   cinder group-type-delete
1765          usage: cinder group-type-delete <group_type> [<group_type> ...]
1766
1767       Deletes group type or types.
1768
1769       Positional arguments:
1770
1771       <group_type>
1772              Name or ID of group type or types to delete.
1773
1774   cinder group-type-key
1775          usage: cinder group-type-key <gtype> <action> <key=value> [<key=value> ...]
1776
1777       Sets or unsets group_spec for a group type.
1778
1779       Positional arguments:
1780
1781       <gtype>
1782              Name or ID of group type.
1783
1784       <action>
1785              The action. Valid values are "set" or "unset."
1786
1787       <key=value>
1788              The group specs key and value pair to set or unset.  For  unset,
1789              specify only the key.
1790
1791   cinder group-type-list
1792          usage: cinder group-type-list [--filters [<key=value> ...]]
1793
1794       Lists available 'group types'. (Admin only will see private types)
1795
1796       Optional arguments:
1797
1798       --filters <key=value>
1799              Filter key and value pairs. Admin only.
1800
1801   cinder group-type-show
1802          usage: cinder group-type-show <group_type>
1803
1804       Show group type details.
1805
1806       Positional arguments:
1807
1808       <group_type>
1809              Name or ID of the group type.
1810
1811   cinder group-type-update
1812          usage: cinder group-type-update [--name <name>] [--description <description>]
1813                                          [--is-public <is-public>]
1814                                          <id>
1815
1816       Updates group type name, description, and/or is_public.
1817
1818       Positional arguments:
1819
1820       <id>   ID of the group type.
1821
1822       Optional arguments:
1823
1824       --name <name>
1825              Name of the group type.
1826
1827       --description <description>
1828              Description of the group type.
1829
1830       --is-public <is-public>
1831              Make type accessible to the public or not.
1832
1833   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
1839       Updates a group.
1840
1841       Positional arguments:
1842
1843       <group>
1844              Name or ID of a group.
1845
1846       Optional arguments:
1847
1848       --name <name>
1849              New name for group. Default=None.
1850
1851       --description <description>
1852              New description for group. Default=None.
1853
1854       --add-volumes <uuid1,uuid2,......>
1855              UUID  of one or more volumes to be added to the group, separated
1856              by commas. Default=None.
1857
1858       --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
1862   cinder image-metadata
1863          usage: cinder image-metadata <volume> <action> <key=value> [<key=value> ...]
1864
1865       Sets or deletes volume image metadata.
1866
1867       Positional arguments:
1868
1869       <volume>
1870              Name or ID of volume for which to update metadata.
1871
1872       <action>
1873              The action. Valid values are 'set' or 'unset.'
1874
1875       <key=value>
1876              Metadata  key and value pair to set or unset. For unset, specify
1877              only the key.
1878
1879   cinder image-metadata-show
1880          usage: cinder image-metadata-show <volume>
1881
1882       Shows volume image metadata.
1883
1884       Positional arguments:
1885
1886       <volume>
1887              ID of volume.
1888
1889   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
1900       Lists all volumes.
1901
1902       Optional arguments:
1903
1904       --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
1909       --all-tenants <0|1>
1910              Shows details for all tenants. Admin only.
1911
1912       --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
1917       --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
1922       --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
1927       --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
1933       --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
1939       --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
1945       --marker <marker>
1946              Begin  returning  volumes  that  appear later in the volume list
1947              than that represented by this volume id. Default=None.
1948
1949       --limit <limit>
1950              Maximum number of volumes to return. Default=None.
1951
1952       --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
1957       --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
1962       --tenant <tenant>
1963              Display information from single tenant (Admin only).
1964
1965       --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
1970       --with-count <True|False>
1971              Show total number of volume entities. This is useful when  pagi‐
1972              nation is applied in the request.
1973
1974   cinder list-filters
1975          usage: cinder list-filters [--resource <resource>]
1976
1977       List enabled filters.
1978
1979       Optional arguments:
1980
1981       --resource <resource>
1982              Show enabled filters for specified resource. Default=None.
1983
1984   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
1992       Manage an existing volume.
1993
1994       Positional arguments:
1995
1996       <host> Cinder  host  on  which  the  existing volume resides; takes the
1997              form: host@backend-name#pool
1998
1999       <identifier>
2000              Name or other Identifier for existing volume
2001
2002       Optional arguments:
2003
2004       --cluster None
2005              Cinder cluster on which the existing volume resides;  takes  the
2006              form: cluster@backend-name#pool
2007
2008       --id-type <id-type>
2009              Type   of   backend   device   identifier   provided,  typically
2010              source-name or source-id (Default=source-name)
2011
2012       --name <name>
2013              Volume name (Default=None)
2014
2015       --description <description>
2016              Volume description (Default=None)
2017
2018       --volume-type <volume-type>
2019              Volume type (Default=None)
2020
2021       --availability-zone <availability-zone>
2022              Availability zone for volume (Default=None)
2023
2024       --metadata <key=value>
2025              Metadata key=value pairs (Default=None)
2026
2027       --bootable None
2028              Specifies that the newly created  volume  should  be  marked  as
2029              bootable
2030
2031   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
2037       Lists all manageable volumes.
2038
2039       Positional arguments:
2040
2041       <host> Cinder host on which to list manageable volumes; takes the form:
2042              host@backend-name#pool
2043
2044       Optional arguments:
2045
2046       --detailed <detailed>
2047              Returned detailed information (default true).
2048
2049       --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
2054       --limit <limit>
2055              Maximum number of volumes to return. Default=None.
2056
2057       --offset <offset>
2058              Number of volumes to skip after marker. Default=None.
2059
2060       --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
2064       --cluster CLUSTER
2065              Cinder  cluster  on  which to list manageable volumes; takes the
2066              form: cluster@backend-name#pool
2067
2068   cinder message-delete
2069          usage: cinder message-delete <message> [<message> ...]
2070
2071       Removes one or more messages.
2072
2073       Positional arguments:
2074
2075       <message>
2076              ID of one or more message to be deleted.
2077
2078   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
2086       Lists all messages.
2087
2088       Optional arguments:
2089
2090       --marker <marker>
2091              Begin returning message that appear later in  the  message  list
2092              than that represented by this id. Default=None.
2093
2094       --limit <limit>
2095              Maximum number of messages to return. Default=None.
2096
2097       --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
2102       --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
2107       --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
2112       --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
2117       --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
2122       --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
2127       --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
2132   cinder message-show
2133          usage: cinder message-show <message>
2134
2135       Shows message details.
2136
2137       Positional arguments:
2138
2139       <message>
2140              ID of message.
2141
2142   cinder metadata
2143          usage: cinder metadata <volume> <action> <key=value> [<key=value> ...]
2144
2145       Sets or deletes volume metadata.
2146
2147       Positional arguments:
2148
2149       <volume>
2150              Name or ID of volume for which to update metadata.
2151
2152       <action>
2153              The action. Valid values are "set" or "unset."
2154
2155       <key=value>
2156              Metadata  key and value pair to set or unset. For unset, specify
2157              only the key(s): <key key>
2158
2159   cinder metadata-show
2160          usage: cinder metadata-show <volume>
2161
2162       Shows volume metadata.
2163
2164       Positional arguments:
2165
2166       <volume>
2167              ID of volume.
2168
2169   cinder metadata-update-all
2170          usage: cinder metadata-update-all <volume> <key=value> [<key=value> ...]
2171
2172       Updates volume metadata.
2173
2174       Positional arguments:
2175
2176       <volume>
2177              ID of volume for which to update metadata.
2178
2179       <key=value>
2180              Metadata key and value pair or pairs to update.
2181
2182   cinder migrate
2183          usage: cinder migrate [--force-host-copy [<True|False>]]
2184                                [--lock-volume [<True|False>]] [--cluster CLUSTER]
2185                                <volume> [<host>]
2186
2187       Migrates volume to a new host.
2188
2189       Positional arguments:
2190
2191       <volume>
2192              ID of volume to migrate.
2193
2194       <host> Destination host. Takes the form: host@backend-name#pool
2195
2196       Optional arguments:
2197
2198       --force-host-copy <True|False>
2199              Enables or disables generic  host-based  force-migration,  which
2200              bypasses driver optimizations. Default=False.
2201
2202       --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
2211       --cluster None
2212              Destination cluster. Takes the form: cluster@backend-name#pool
2213
2214   cinder qos-associate
2215          usage: cinder qos-associate <qos_specs> <volume_type_id>
2216
2217       Associates qos specs with specified volume type.
2218
2219       Positional arguments:
2220
2221       <qos_specs>
2222              ID of QoS specifications.
2223
2224       <volume_type_id>
2225              ID of volume type with which to associate QoS specifications.
2226
2227   cinder qos-create
2228          usage: cinder qos-create <name> <key=value> [<key=value> ...]
2229
2230       Creates a qos specs.
2231
2232       Positional arguments:
2233
2234       <name> Name of new QoS specifications.
2235
2236       <key=value>
2237              QoS specifications.
2238
2239   cinder qos-delete
2240          usage: cinder qos-delete [--force [<True|False>]] <qos_specs>
2241
2242       Deletes a specified qos specs.
2243
2244       Positional arguments:
2245
2246       <qos_specs>
2247              ID of QoS specifications to delete.
2248
2249       Optional arguments:
2250
2251       --force <True|False>
2252              Enables  or  disables deletion of in-use QoS specifications. De‐
2253              fault=False.
2254
2255   cinder qos-disassociate
2256          usage: cinder qos-disassociate <qos_specs> <volume_type_id>
2257
2258       Disassociates qos specs from specified volume type.
2259
2260       Positional arguments:
2261
2262       <qos_specs>
2263              ID of QoS specifications.
2264
2265       <volume_type_id>
2266              ID of volume type with which to associate QoS specifications.
2267
2268   cinder qos-disassociate-all
2269          usage: cinder qos-disassociate-all <qos_specs>
2270
2271       Disassociates qos specs from all its associations.
2272
2273       Positional arguments:
2274
2275       <qos_specs>
2276              ID of QoS specifications on which to operate.
2277
2278   cinder qos-get-association
2279          usage: cinder qos-get-association <qos_specs>
2280
2281       Lists all associations for specified qos specs.
2282
2283       Positional arguments:
2284
2285       <qos_specs>
2286              ID of QoS specifications.
2287
2288   cinder qos-key
2289          usage: cinder qos-key <qos_specs> <action> key=value [key=value ...]
2290
2291       Sets or unsets specifications for a qos spec.
2292
2293       Positional arguments:
2294
2295       <qos_specs>
2296              ID of QoS specifications.
2297
2298       <action>
2299              The action. Valid values are "set" or "unset."
2300
2301       key=value
2302              Metadata key and value pair to set or unset. For unset,  specify
2303              only the key.
2304
2305   cinder qos-list
2306          usage: cinder qos-list
2307
2308       Lists qos specs.
2309
2310   cinder qos-show
2311          usage: cinder qos-show <qos_specs>
2312
2313       Shows qos specs details.
2314
2315       Positional arguments:
2316
2317       <qos_specs>
2318              ID of QoS specifications to show.
2319
2320   cinder quota-class-show
2321          usage: cinder quota-class-show <class>
2322
2323       Lists quotas for a quota class.
2324
2325       Positional arguments:
2326
2327       <class>
2328              Name of quota class for which to list quotas.
2329
2330   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
2340       Updates quotas for a quota class.
2341
2342       Positional arguments:
2343
2344       <class_name>
2345              Name of quota class for which to set quotas.
2346
2347       Optional arguments:
2348
2349       --volumes <volumes>
2350              The new "volumes" quota value. Default=None.
2351
2352       --snapshots <snapshots>
2353              The new "snapshots" quota value. Default=None.
2354
2355       --gigabytes <gigabytes>
2356              The new "gigabytes" quota value. Default=None.
2357
2358       --backups <backups>
2359              The new "backups" quota value. Default=None.
2360
2361       --backup-gigabytes <backup_gigabytes>
2362              The new "backup_gigabytes" quota value. Default=None.
2363
2364       --volume-type <volume_type_name>
2365              Volume type. Default=None.
2366
2367       --per-volume-gigabytes <per_volume_gigabytes>
2368              Set max volume size limit. Default=None.
2369
2370   cinder quota-defaults
2371          usage: cinder quota-defaults <tenant_id>
2372
2373       Lists default quotas for a tenant.
2374
2375       Positional arguments:
2376
2377       <tenant_id>
2378              ID of tenant for which to list quota defaults.
2379
2380   cinder quota-delete
2381          usage: cinder quota-delete <tenant_id>
2382
2383       Delete the quotas for a tenant.
2384
2385       Positional arguments:
2386
2387       <tenant_id>
2388              UUID of tenant to delete the quotas for.
2389
2390   cinder quota-show
2391          usage: cinder quota-show <tenant_id>
2392
2393       Lists quotas for a tenant.
2394
2395       Positional arguments:
2396
2397       <tenant_id>
2398              ID of tenant for which to list quotas.
2399
2400   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
2410       Updates quotas for a tenant.
2411
2412       Positional arguments:
2413
2414       <tenant_id>
2415              ID of tenant for which to set quotas.
2416
2417       Optional arguments:
2418
2419       --volumes <volumes>
2420              The new "volumes" quota value. Default=None.
2421
2422       --snapshots <snapshots>
2423              The new "snapshots" quota value. Default=None.
2424
2425       --gigabytes <gigabytes>
2426              The new "gigabytes" quota value. Default=None.
2427
2428       --backups <backups>
2429              The new "backups" quota value. Default=None.
2430
2431       --backup-gigabytes <backup_gigabytes>
2432              The new "backup_gigabytes" quota value. Default=None.
2433
2434       --groups <groups>
2435              The new "groups" quota value. Default=None.
2436
2437       --volume-type <volume_type_name>
2438              Volume type. Default=None.
2439
2440       --per-volume-gigabytes <per_volume_gigabytes>
2441              Set max volume size limit. Default=None.
2442
2443       --skip-validation <skip_validation>
2444              Skip validate the existing resource quota. Default=False.
2445
2446   cinder quota-usage
2447          usage: cinder quota-usage <tenant_id>
2448
2449       Lists quota usage for a tenant.
2450
2451       Positional arguments:
2452
2453       <tenant_id>
2454              ID of tenant for which to list quota usage.
2455
2456   cinder rate-limits
2457          usage: cinder rate-limits [<tenant_id>]
2458
2459       Lists rate limits for a user.
2460
2461       Positional arguments:
2462
2463       <tenant_id>
2464              Display information for a single tenant (Admin only).
2465
2466   cinder readonly-mode-update
2467          usage: cinder readonly-mode-update <volume> <True|true|False|false>
2468
2469       Updates volume read-only access-mode flag.
2470
2471       Positional arguments:
2472
2473       <volume>
2474              ID of volume to update.
2475
2476       <True|true|False|false>
2477              Enables or disables update of volume to read-only access mode.
2478
2479   cinder rename
2480          usage: cinder rename [--description <description>] <volume> [<name>]
2481
2482       Renames a volume.
2483
2484       Positional arguments:
2485
2486       <volume>
2487              Name or ID of volume to rename.
2488
2489       <name> New name for volume.
2490
2491       Optional arguments:
2492
2493       --description <description>
2494              Volume description. Default=None.
2495
2496   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
2502       Explicitly updates the entity state in the Cinder database.
2503
2504       Positional arguments:
2505
2506       <entity>
2507              Name or ID of entity to update.
2508
2509       Optional arguments:
2510
2511       --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
2516       --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
2522       --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
2528       --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
2534   cinder retype
2535          usage: cinder retype [--migration-policy <never|on-demand>]
2536                               <volume> <volume-type>
2537
2538       Changes the volume type for a volume.
2539
2540       Positional arguments:
2541
2542       <volume>
2543              Name or ID of volume for which to modify type.
2544
2545       <volume-type>
2546              New volume type.
2547
2548       Optional arguments:
2549
2550       --migration-policy <never|on-demand>
2551              Migration policy during retype of volume.
2552
2553   cinder revert-to-snapshot
2554          usage: cinder revert-to-snapshot <snapshot>
2555
2556       Revert a volume to the specified snapshot.
2557
2558       Positional arguments:
2559
2560       <snapshot>
2561              Name or ID of the snapshot to restore. The snapshot must be  the
2562              most recent one known to cinder.
2563
2564   cinder service-disable
2565          usage: cinder service-disable [--reason <reason>] <hostname> <binary>
2566
2567       Disables the service.
2568
2569       Positional arguments:
2570
2571       <hostname>
2572              Host name.
2573
2574       <binary>
2575              Service binary.
2576
2577       Optional arguments:
2578
2579       --reason <reason>
2580              Reason for disabling service.
2581
2582   cinder service-enable
2583          usage: cinder service-enable <hostname> <binary>
2584
2585       Enables the service.
2586
2587       Positional arguments:
2588
2589       <hostname>
2590              Host name.
2591
2592       <binary>
2593              Service binary.
2594
2595   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
2600       Gets the service log level.
2601
2602       Optional arguments:
2603
2604       --binary None
2605              Binary to query.
2606
2607       --server None
2608              Host or cluster value for service.
2609
2610       --prefix None
2611              Prefix for the log. ie: "sqlalchemy.".
2612
2613   cinder service-list
2614          usage: cinder service-list [--host <hostname>] [--binary <binary>]
2615                                     [--withreplication [<True|False>]]
2616
2617       Lists all services. Filter by host and service binary.
2618
2619       Optional arguments:
2620
2621       --host <hostname>
2622              Host name. Default=None.
2623
2624       --binary <binary>
2625              Service binary. Default=None.
2626
2627       --withreplication <True|False>
2628              Enables  or  disables display of Replication info for c-vol ser‐
2629              vices. Default=False.
2630
2631   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
2637       Sets the service log level.
2638
2639       Positional arguments:
2640
2641       <log-level>
2642              Desired log level.
2643
2644       Optional arguments:
2645
2646       --binary None
2647              Binary to change.
2648
2649       --server None
2650              Host or cluster value for service.
2651
2652       --prefix None
2653              Prefix for the log. ie: "cinder.volume.drivers.".
2654
2655   cinder set-bootable
2656          usage: cinder set-bootable <volume> <True|true|False|false>
2657
2658       Update bootable status of a volume.
2659
2660       Positional arguments:
2661
2662       <volume>
2663              ID of the volume to update.
2664
2665       <True|true|False|false>
2666              Flag to indicate whether volume is bootable.
2667
2668   cinder show
2669          usage: cinder show <volume>
2670
2671       Shows volume details.
2672
2673       Positional arguments:
2674
2675       <volume>
2676              Name or ID of volume.
2677
2678   cinder snapshot-create
2679          usage: cinder snapshot-create [--force [<True|False>]] [--name <name>]
2680                                        [--description <description>]
2681                                        [--metadata [<key=value> ...]]
2682                                        <volume>
2683
2684       Creates a snapshot.
2685
2686       Positional arguments:
2687
2688       <volume>
2689              Name or ID of volume to snapshot.
2690
2691       Optional arguments:
2692
2693       --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
2699       --name <name>
2700              Snapshot name. Default=None.
2701
2702       --description <description>
2703              Snapshot description. Default=None.
2704
2705       --metadata <key=value>
2706              Snapshot metadata key and value pairs. Default=None.
2707
2708   cinder snapshot-delete
2709          usage: cinder snapshot-delete [--force] <snapshot> [<snapshot> ...]
2710
2711       Removes one or more snapshots.
2712
2713       Positional arguments:
2714
2715       <snapshot>
2716              Name or ID of the snapshot(s) to delete.
2717
2718       Optional arguments:
2719
2720       --force None
2721              Allows  deleting  snapshot  of a volume when its status is other
2722              than "available" or "error". Default=False.
2723
2724   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
2733       Lists all snapshots.
2734
2735       Optional arguments:
2736
2737       --all-tenants <0|1>
2738              Shows details for all tenants. Admin only.
2739
2740       --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
2745       --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
2750       --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
2755       --marker <marker>
2756              Begin returning snapshots that appear later in the snapshot list
2757              than that represented by this id. Default=None.
2758
2759       --limit <limit>
2760              Maximum number of snapshots to return. Default=None.
2761
2762       --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
2767       --tenant <tenant>
2768              Display information from single tenant (Admin only).
2769
2770       --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
2776       --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
2781       --with-count <True|False>
2782              Show total number of snapshot entities. This is useful when pag‐
2783              ination is applied in the request.
2784
2785   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
2791       Manage an existing snapshot.
2792
2793       Positional arguments:
2794
2795       <volume>
2796              Cinder volume that already exists in the volume backend.
2797
2798       <identifier>
2799              Name  or other identifier for existing snapshot. This is backend
2800              specific.
2801
2802       Optional arguments:
2803
2804       --id-type <id-type>
2805              Type  of   backend   device   identifier   provided,   typically
2806              source-name or source-id (Default=source-name).
2807
2808       --name <name>
2809              Snapshot name (Default=None).
2810
2811       --description <description>
2812              Snapshot description (Default=None).
2813
2814       --metadata <key=value>
2815              Metadata key=value pairs (Default=None).
2816
2817   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
2825       Lists all manageable snapshots.
2826
2827       Positional arguments:
2828
2829       <host> Cinder  host  on  which  to list manageable snapshots; takes the
2830              form: host@backend-name#pool
2831
2832       Optional arguments:
2833
2834       --detailed <detailed>
2835              Returned detailed information (default true).
2836
2837       --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
2842       --limit <limit>
2843              Maximum number of volumes to return. Default=None.
2844
2845       --offset <offset>
2846              Number of volumes to skip after marker. Default=None.
2847
2848       --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
2852       --cluster None
2853              Cinder  cluster on which to list manageable snapshots; takes the
2854              form: cluster@backend-name#pool
2855
2856   cinder snapshot-metadata
2857          usage: cinder snapshot-metadata <snapshot> <action> <key=value>
2858                                          [<key=value> ...]
2859
2860       Sets or deletes snapshot metadata.
2861
2862       Positional arguments:
2863
2864       <snapshot>
2865              ID of snapshot for which to update metadata.
2866
2867       <action>
2868              The action. Valid values are "set" or "unset."
2869
2870       <key=value>
2871              Metadata key and value pair to set or unset. For unset,  specify
2872              only the key.
2873
2874   cinder snapshot-metadata-show
2875          usage: cinder snapshot-metadata-show <snapshot>
2876
2877       Shows snapshot metadata.
2878
2879       Positional arguments:
2880
2881       <snapshot>
2882              ID of snapshot.
2883
2884   cinder snapshot-metadata-update-all
2885          usage: cinder snapshot-metadata-update-all <snapshot> <key=value>
2886                                                     [<key=value> ...]
2887
2888       Updates snapshot metadata.
2889
2890       Positional arguments:
2891
2892       <snapshot>
2893              ID of snapshot for which to update metadata.
2894
2895       <key=value>
2896              Metadata key and value pair to update.
2897
2898   cinder snapshot-rename
2899          usage: cinder snapshot-rename [--description <description>]
2900                                        <snapshot> [<name>]
2901
2902       Renames a snapshot.
2903
2904       Positional arguments:
2905
2906       <snapshot>
2907              Name or ID of snapshot.
2908
2909       <name> New name for snapshot.
2910
2911       Optional arguments:
2912
2913       --description <description>
2914              Snapshot description. Default=None.
2915
2916   cinder snapshot-reset-state
2917          usage: cinder snapshot-reset-state [--state <state>]
2918                                             <snapshot> [<snapshot> ...]
2919
2920       Explicitly updates the snapshot state.
2921
2922       Positional arguments:
2923
2924       <snapshot>
2925              Name or ID of snapshot to modify.
2926
2927       Optional arguments:
2928
2929       --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
2936   cinder snapshot-show
2937          usage: cinder snapshot-show <snapshot>
2938
2939       Shows snapshot details.
2940
2941       Positional arguments:
2942
2943       <snapshot>
2944              Name or ID of snapshot.
2945
2946   cinder snapshot-unmanage
2947          usage: cinder snapshot-unmanage <snapshot>
2948
2949       Stop managing a snapshot.
2950
2951       Positional arguments:
2952
2953       <snapshot>
2954              Name or ID of the snapshot to unmanage.
2955
2956   cinder summary
2957          usage: cinder summary [--all-tenants [<0|1>]]
2958
2959       Get volumes summary.
2960
2961       Optional arguments:
2962
2963       --all-tenants <0|1>
2964              Shows details for all tenants. Admin only.
2965
2966   cinder thaw-host
2967          usage: cinder thaw-host <hostname>
2968
2969       Thaw and enable the specified cinder-volume host.
2970
2971       Positional arguments:
2972
2973       <hostname>
2974              Host name.
2975
2976   cinder transfer-accept
2977          usage: cinder transfer-accept <transfer> <auth_key>
2978
2979       Accepts a volume transfer.
2980
2981       Positional arguments:
2982
2983       <transfer>
2984              ID of transfer to accept.
2985
2986       <auth_key>
2987              Authentication key of transfer to accept.
2988
2989   cinder transfer-create
2990          usage: cinder transfer-create [--name <name>] [--no-snapshots] <volume>
2991
2992       Creates a volume transfer.
2993
2994       Positional arguments:
2995
2996       <volume>
2997              Name or ID of volume to transfer.
2998
2999       Optional arguments:
3000
3001       --name <name>
3002              Transfer name. Default=None.
3003
3004       --no-snapshots None
3005              Allows  or  disallows  transfer  volumes  without snapshots. De‐
3006              fault=False.
3007
3008   cinder transfer-delete
3009          usage: cinder transfer-delete <transfer>
3010
3011       Undoes a transfer.
3012
3013       Positional arguments:
3014
3015       <transfer>
3016              Name or ID of transfer to delete.
3017
3018   cinder transfer-list
3019          usage: cinder transfer-list [--all-tenants [<0|1>]]
3020                                      [--sort <key>[:<direction>]]
3021                                      [--filters [<key=value> ...]]
3022
3023       Lists all transfers.
3024
3025       Optional arguments:
3026
3027       --all-tenants <0|1>
3028              Shows details for all tenants. Admin only.
3029
3030       --sort <key>[:<direction>]
3031              Sort keys and directions in the form of <key>[:<asc|desc>].
3032
3033       --filters <key=value>
3034              Filter key and value pairs.
3035
3036   cinder transfer-show
3037          usage: cinder transfer-show <transfer>
3038
3039       Shows transfer details.
3040
3041       Positional arguments:
3042
3043       <transfer>
3044              Name or ID of transfer to accept.
3045
3046   cinder type-access-add
3047          usage: cinder type-access-add --volume-type <volume_type> --project-id
3048                                        <project_id>
3049
3050       Adds volume type access for the given project.
3051
3052       Optional arguments:
3053
3054       --volume-type <volume_type>
3055              Volume type name or ID to add access for the given project.
3056
3057       --project-id <project_id>
3058              Project ID to add volume type access for.
3059
3060   cinder type-access-list
3061          usage: cinder type-access-list --volume-type <volume_type>
3062
3063       Print access information about the given volume type.
3064
3065       Optional arguments:
3066
3067       --volume-type <volume_type>
3068              Filter results by volume type name or ID.
3069
3070   cinder type-access-remove
3071          usage: cinder type-access-remove --volume-type <volume_type> --project-id
3072                                           <project_id>
3073
3074       Removes volume type access for the given project.
3075
3076       Optional arguments:
3077
3078       --volume-type <volume_type>
3079              Volume type name or ID to remove access for the given project.
3080
3081       --project-id <project_id>
3082              Project ID to remove volume type access for.
3083
3084   cinder type-create
3085          usage: cinder type-create [--description <description>]
3086                                    [--is-public <is-public>]
3087                                    <name>
3088
3089       Creates a volume type.
3090
3091       Positional arguments:
3092
3093       <name> Name of new volume type.
3094
3095       Optional arguments:
3096
3097       --description <description>
3098              Description of new volume type.
3099
3100       --is-public <is-public>
3101              Make type accessible to the public (default true).
3102
3103   cinder type-default
3104          usage: cinder type-default
3105
3106       List the default volume type.
3107
3108   cinder type-delete
3109          usage: cinder type-delete <vol_type> [<vol_type> ...]
3110
3111       Deletes volume type or types.
3112
3113       Positional arguments:
3114
3115       <vol_type>
3116              Name or ID of volume type or types to delete.
3117
3118   cinder type-key
3119          usage: cinder type-key <vtype> <action> <key=value> [<key=value> ...]
3120
3121       Sets or unsets extra_spec for a volume type.
3122
3123       Positional arguments:
3124
3125       <vtype>
3126              Name or ID of volume type.
3127
3128       <action>
3129              The action. Valid values are "set" or "unset."
3130
3131       <key=value>
3132              The extra specs key and value pair to set or unset.  For  unset,
3133              specify only the key.
3134
3135   cinder type-list
3136          usage: cinder type-list [--filters [<key=value> ...]]
3137
3138       Lists available 'volume types'.
3139
3140       Optional arguments:
3141
3142       --filters <key=value>
3143              Filter key and value pairs. Admin only.
3144
3145   cinder type-show
3146          usage: cinder type-show <volume_type>
3147
3148       Show volume type details.
3149
3150       Positional arguments:
3151
3152       <volume_type>
3153              Name or ID of the volume type.
3154
3155   cinder type-update
3156          usage: cinder type-update [--name <name>] [--description <description>]
3157                                    [--is-public <is-public>]
3158                                    <id>
3159
3160       Updates volume type name, description, and/or is_public.
3161
3162       Positional arguments:
3163
3164       <id>   ID of the volume type.
3165
3166       Optional arguments:
3167
3168       --name <name>
3169              Name of the volume type.
3170
3171       --description <description>
3172              Description of the volume type.
3173
3174       --is-public <is-public>
3175              Make type accessible to the public or not.
3176
3177   cinder unmanage
3178          usage: cinder unmanage <volume>
3179
3180       Stop managing a volume.
3181
3182       Positional arguments:
3183
3184       <volume>
3185              Name or ID of the volume to unmanage.
3186
3187   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
3195       Uploads volume to Image Service as an image.
3196
3197       Positional arguments:
3198
3199       <volume>
3200              Name or ID of volume to snapshot.
3201
3202       <image-name>
3203              The new image name.
3204
3205       Optional arguments:
3206
3207       --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
3212       --container-format <container-format>
3213              Container format type. Default is bare.
3214
3215       --disk-format <disk-format>
3216              Disk format type. Default is raw.
3217
3218       --visibility <public|private|community|shared>
3219              Set  image  visibility  to public, private, community or shared.
3220              Default=private.
3221
3222       --protected <True|False>
3223              Prevents image from being deleted. Default=False.
3224
3225   cinder version-list
3226          usage: cinder version-list
3227
3228       List all API versions.
3229
3230   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
3239       Request cleanup of services with optional filtering.
3240
3241       Optional arguments:
3242
3243       --cluster <cluster-name>
3244              Cluster name. Default=None.
3245
3246       --host <hostname>
3247              Service host name. Default=None.
3248
3249       --binary <binary>
3250              Service binary. Default=None.
3251
3252       --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
3257       --disabled <True|true|False|false>
3258              Filter by disabled status. Default=None.
3259
3260       --resource-id <resource-id>
3261              UUID of a resource to cleanup. Default=None.
3262
3263       --resource-type <Volume|Snapshot>
3264              Type of resource to cleanup.
3265
3266       --service-id <service-id>
3267              The service id field from the DB, not the uuid of  the  service.
3268              Default=None.
3269
3270   cinder help
3271          usage: cinder help [<subcommand>]
3272
3273       Shows help about this program or one of its subcommands.
3274
3275       Positional arguments:
3276
3277       <subcommand>
3278              Shows help for <subcommand>.
3279

AUTHOR

3281       OpenStack Contributors
3282
3284       OpenStack Contributors
3285
3286
3287
3288
32897.4.0                            Jan 21, 2022                        CINDER(1)
Impressum