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

COMMAND DETAILS

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

AUTHOR

3304       OpenStack Contributors
3305
3307       OpenStack Contributors
3308
3309
3310
3311
33129.3.0                            Jul 21, 2023                        CINDER(1)
Impressum