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] [--os-auth-system <os-auth-system>]
17                        [--os-auth-type <os-auth-type>] [--service-type <service-type>]
18                        [--service-name <service-name>]
19                        [--volume-service-name <volume-service-name>]
20                        [--os-endpoint-type <os-endpoint-type>]
21                        [--endpoint-type <endpoint-type>]
22                        [--os-volume-api-version <volume-api-ver>]
23                        [--bypass-url <bypass-url>] [--os-endpoint <os-endpoint>]
24                        [--retries <retries>] [--profile HMAC_KEY]
25                        [--os-auth-strategy <auth-strategy>]
26                        [--os-username <auth-user-name>] [--os-password <auth-password>]
27                        [--os-tenant-name <auth-tenant-name>]
28                        [--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>]
29                        [--os-user-id <auth-user-id>]
30                        [--os-user-domain-id <auth-user-domain-id>]
31                        [--os-user-domain-name <auth-user-domain-name>]
32                        [--os-project-id <auth-project-id>]
33                        [--os-project-name <auth-project-name>]
34                        [--os-project-domain-id <auth-project-domain-id>]
35                        [--os-project-domain-name <auth-project-domain-name>]
36                        [--os-region-name <region-name>] [--os-token <token>]
37                        [--os-url <url>] [--insecure] [--os-cacert <ca-certificate>]
38                        [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>]
39                        <subcommand> ...
40
41       Subcommands:
42
43       absolute-limits
44              Lists absolute limits for a user.
45
46       api-version
47              Display the server API version information.  (Supported  by  API
48              versions  3.0  -  3.latest) [hint: use '--os-volume-api-version'
49              flag to show help message for proper version]
50
51       attachment-create
52              Create an attachment for a cinder volume. (Supported by API ver‐
53              sions 3.27 - 3.latest) [hint: use '--os-volume-api-version' flag
54              to show help message for proper version]
55
56       attachment-delete
57              Delete an attachment for a cinder volume. (Supported by API ver‐
58              sions 3.27 - 3.latest) [hint: use '--os-volume-api-version' flag
59              to show help message for proper version]
60
61       attachment-list
62              Lists all attachments. (Supported by API versions 3.27 -  3.lat‐
63              est) [hint: use '--os-volume-api-version' flag to show help mes‐
64              sage for proper version]
65
66       attachment-show
67              Show detailed information for attachment. (Supported by API ver‐
68              sions 3.27 - 3.latest) [hint: use '--os-volume-api-version' flag
69              to show help message for proper version]
70
71       attachment-update
72              Update an attachment for a cinder volume. (Supported by API ver‐
73              sions 3.27 - 3.latest) [hint: use '--os-volume-api-version' flag
74              to show help message for proper version]
75
76       availability-zone-list
77              Lists all availability zones.
78
79       backup-create
80              Creates a volume backup.
81
82       backup-delete
83              Removes one or more backups.
84
85       backup-export
86              Export backup metadata record.
87
88       backup-import
89              Import backup metadata record.
90
91       backup-list
92              Lists all backups.
93
94       backup-reset-state
95              Explicitly updates the backup state.
96
97       backup-restore
98              Restores a backup.
99
100       backup-show
101              Shows backup details.
102
103       backup-update
104              Renames a backup.  (Supported by  API  versions  3.9  -3.latest)
105              [hint:  use  '--os-volume-api-version' flag to show help message
106              for proper version]
107
108       cgsnapshot-create
109              Creates a cgsnapshot.
110
111       cgsnapshot-delete
112              Removes one or more cgsnapshots.
113
114       cgsnapshot-list
115              Lists all cgsnapshots.
116
117       cgsnapshot-show
118              Shows cgsnapshot details.
119
120       cluster-disable
121              Disables clustered services. (Supported by API  versions  3.7  -
122              3.latest) [hint: use '--os-volume-api-version' flag to show help
123              message for proper version]
124
125       cluster-enable
126              Enables clustered services. (Supported by  API  versions  3.7  -
127              3.latest) [hint: use '--os-volume-api-version' flag to show help
128              message for proper version]
129
130       cluster-list
131              Lists clustered services with optional filtering.  (Supported by
132              API  versions  3.7  - 3.latest) [hint: use '--os-volume-api-ver‐
133              sion' flag to show help message for proper version]
134
135       cluster-show
136              Show detailed information on a clustered service.  (Supported by
137              API  versions  3.7  - 3.latest) [hint: use '--os-volume-api-ver‐
138              sion' flag to show help message for proper version]
139
140       consisgroup-create
141              Creates a consistency group.
142
143       consisgroup-create-from-src
144              Creates a consistency group from a cgsnapshot or a source CG.
145
146       consisgroup-delete
147              Removes one or more consistency groups.
148
149       consisgroup-list
150              Lists all consistency groups.
151
152       consisgroup-show
153              Shows details of a consistency group.
154
155       consisgroup-update
156              Updates a consistency group.
157
158       create Creates a volume.
159
160       credentials
161              Shows user credentials returned from auth.
162
163       delete Removes one or more volumes.
164
165       encryption-type-create
166              Creates encryption type for a volume type. Admin only.
167
168       encryption-type-delete
169              Deletes encryption type for a volume type. Admin only.
170
171       encryption-type-list
172              Shows encryption type details for volume types. Admin only.
173
174       encryption-type-show
175              Shows encryption type details for a volume type. Admin only.
176
177       encryption-type-update
178              Update encryption type information  for  a  volume  type  (Admin
179              Only).
180
181       endpoints
182              Discovers endpoints registered by authentication service.
183
184       extend Attempts to extend size of an existing volume.
185
186       extra-specs-list
187              Lists current volume types and extra specs.
188
189       failover-host
190              Failover a replicating cinder-volume host.
191
192       force-delete
193              Attempts force-delete of volume, regardless of state.
194
195       freeze-host
196              Freeze and disable the specified cinder-volume host.
197
198       get-capabilities
199              Show backend volume stats and properties. Admin only.
200
201       get-pools
202              Show pool information for backends. Admin only.
203
204       group-create
205              Creates  a  group.   (Supported  by API versions 3.13 -3.latest)
206              [hint: use '--os-volume-api-version' flag to show  help  message
207              for proper version]
208
209       group-create-from-src
210              Creates  a  group from a group snapshot or a source group. (Sup‐
211              ported by API versions 3.14 - 3.latest)  [hint:  use  '--os-vol‐
212              ume-api-version' flag to show help message for proper version]
213
214       group-delete
215              Removes  one  or  more groups. (Supported by API versions 3.13 -
216              3.latest) [hint: use '--os-volume-api-version' flag to show help
217              message for proper version]
218
219       group-list
220              Lists  all  groups.   (Supported by API versions 3.13 -3.latest)
221              [hint: use '--os-volume-api-version' flag to show  help  message
222              for proper version]
223
224       group-show
225              Shows  details  of  a  group.  (Supported by API versions 3.13 -
226              3.latest) [hint: use '--os-volume-api-version' flag to show help
227              message for proper version]
228
229       group-snapshot-create
230              Creates  a  group  snapshot.  (Supported  by API versions 3.14 -
231              3.latest) [hint: use '--os-volume-api-version' flag to show help
232              message for proper version]
233
234       group-snapshot-delete
235              Removes  one or more group snapshots. (Supported by API versions
236              3.14 - 3.latest) [hint: use  '--os-volume-api-version'  flag  to
237              show help message for proper version]
238
239       group-snapshot-list
240              Lists  all  group  snapshots.  (Supported by API versions 3.14 -
241              3.latest) [hint: use '--os-volume-api-version' flag to show help
242              message for proper version]
243
244       group-snapshot-show
245              Shows  group snapshot details. (Supported by API versions 3.14 -
246              3.latest) [hint: use '--os-volume-api-version' flag to show help
247              message for proper version]
248
249       group-specs-list
250              Lists  current group types and specs. (Supported by API versions
251              3.11 - 3.latest) [hint: use  '--os-volume-api-version'  flag  to
252              show help message for proper version]
253
254       group-type-create
255              Creates  a  group type. (Supported by API versions 3.11 - 3.lat‐
256              est) [hint: use '--os-volume-api-version' flag to show help mes‐
257              sage for proper version]
258
259       group-type-default
260              List  the  default group type. (Supported by API versions 3.11 -
261              3.latest) [hint: use '--os-volume-api-version' flag to show help
262              message for proper version]
263
264       group-type-delete
265              Deletes  group  type or types. (Supported by API versions 3.11 -
266              3.latest) [hint: use '--os-volume-api-version' flag to show help
267              message for proper version]
268
269       group-type-key
270              Sets  or  unsets  group_spec for a group type. (Supported by API
271              versions 3.11 - 3.latest) [hint:  use  '--os-volume-api-version'
272              flag to show help message for proper version]
273
274       group-type-list
275              Lists  available  'group  types'.  (Admin  only will see private
276              types) (Supported by API versions  3.11  -3.latest)  [hint:  use
277              '--os-volume-api-version'  flag  to show help message for proper
278              version]
279
280       group-type-show
281              Show group type details.  (Supported  by  API  versions  3.11  -
282              3.latest) [hint: use '--os-volume-api-version' flag to show help
283              message for proper version]
284
285       group-type-update
286              Updates group type name, description,  and/or  is_public.  (Sup‐
287              ported  by  API  versions 3.11 - 3.latest) [hint: use '--os-vol‐
288              ume-api-version' flag to show help message for proper version]
289
290       group-update
291              Updates a group.  (Supported by  API  versions  3.13  -3.latest)
292              [hint:  use  '--os-volume-api-version' flag to show help message
293              for proper version]
294
295       image-metadata
296              Sets or deletes volume image metadata.
297
298       image-metadata-show
299              Shows volume image metadata.
300
301       list   Lists all volumes.
302
303       list-filters
304              (Supported  by  API  versions  3.33  -  3.latest)   [hint:   use
305              '--os-volume-api-version'  flag  to show help message for proper
306              version]
307
308       manage Manage an existing volume.
309
310       manageable-list
311              Lists all manageable volumes. (Supported by API versions  3.8  -
312              3.latest) [hint: use '--os-volume-api-version' flag to show help
313              message for proper version]
314
315       message-delete
316              Removes one or more messages. (Supported by API versions  3.3  -
317              3.latest) [hint: use '--os-volume-api-version' flag to show help
318              message for proper version]
319
320       message-list
321              Lists all messages.  (Supported by API versions  3.3  -3.latest)
322              [hint:  use  '--os-volume-api-version' flag to show help message
323              for proper version]
324
325       message-show
326              Shows message details. (Supported by API versions 3.3  -  3.lat‐
327              est) [hint: use '--os-volume-api-version' flag to show help mes‐
328              sage for proper version]
329
330       metadata
331              Sets or deletes volume metadata.
332
333       metadata-show
334              Shows volume metadata.
335
336       metadata-update-all
337              Updates volume metadata.
338
339       migrate
340              Migrates volume to a new host.
341
342       qos-associate
343              Associates qos specs with specified volume type.
344
345       qos-create
346              Creates a qos specs.
347
348       qos-delete
349              Deletes a specified qos specs.
350
351       qos-disassociate
352              Disassociates qos specs from specified volume type.
353
354       qos-disassociate-all
355              Disassociates qos specs from all its associations.
356
357       qos-get-association
358              Lists all associations for specified qos specs.
359
360       qos-key
361              Sets or unsets specifications for a qos spec.
362
363       qos-list
364              Lists qos specs.
365
366       qos-show
367              Shows qos specs details.
368
369       quota-class-show
370              Lists quotas for a quota class.
371
372       quota-class-update
373              Updates quotas for a quota class.
374
375       quota-defaults
376              Lists default quotas for a tenant.
377
378       quota-delete
379              Delete the quotas for a tenant.
380
381       quota-show
382              Lists quotas for a tenant.
383
384       quota-update
385              Updates quotas for a tenant.
386
387       quota-usage
388              Lists quota usage for a tenant.
389
390       rate-limits
391              Lists rate limits for a user.
392
393       readonly-mode-update
394              Updates volume read-only access-mode flag.
395
396       rename Renames a volume.
397
398       reset-state
399              Explicitly updates the entity state in the Cinder database.
400
401       retype Changes the volume type for a volume.
402
403       service-disable
404              Disables the service.
405
406       service-enable
407              Enables the service.
408
409       service-list
410              Lists all services. Filter by host and  service  binary.   (Sup‐
411              ported  by  API  versions  3.0 - 3.latest) [hint: use '--os-vol‐
412              ume-api-version' flag to show help message for proper version]
413
414       set-bootable
415              Update bootable status of a volume.
416
417       show   Shows volume details.
418
419       snapshot-create
420              Creates a snapshot.
421
422       snapshot-delete
423              Removes one or more snapshots.
424
425       snapshot-list
426              Lists all snapshots.
427
428       snapshot-manage
429              Manage an existing snapshot.
430
431       snapshot-manageable-list
432              Lists all manageable snapshots. (Supported by API versions 3.8 -
433              3.latest) [hint: use '--os-volume-api-version' flag to show help
434              message for proper version]
435
436       snapshot-metadata
437              Sets or deletes snapshot metadata.
438
439       snapshot-metadata-show
440              Shows snapshot metadata.
441
442       snapshot-metadata-update-all
443              Updates snapshot metadata.
444
445       snapshot-rename
446              Renames a snapshot.
447
448       snapshot-reset-state
449              Explicitly updates the snapshot state.
450
451       snapshot-show
452              Shows snapshot details.
453
454       snapshot-unmanage
455              Stop managing a snapshot.
456
457       thaw-host
458              Thaw and enable the specified cinder-volume host.
459
460       transfer-accept
461              Accepts a volume transfer.
462
463       transfer-create
464              Creates a volume transfer.
465
466       transfer-delete
467              Undoes a transfer.
468
469       transfer-list
470              Lists all transfers.
471
472       transfer-show
473              Shows transfer details.
474
475       type-access-add
476              Adds volume type access for the given project.
477
478       type-access-list
479              Print access information about the given volume type.
480
481       type-access-remove
482              Removes volume type access for the given project.
483
484       type-create
485              Creates a volume type.
486
487       type-default
488              List the default volume type.
489
490       type-delete
491              Deletes volume type or types.
492
493       type-key
494              Sets or unsets extra_spec for a volume type.
495
496       type-list
497              Lists available 'volume types'.
498
499       type-show
500              Show volume type details.
501
502       type-update
503              Updates volume type name, description, and/or is_public.
504
505       unmanage
506              Stop managing a volume.
507
508       upload-to-image
509              Uploads volume to Image Service as an image.
510
511       version-list
512              List all API versions. (Supported by API versions 3.0  -  3.lat‐
513              est) [hint: use '--os-volume-api-version' flag to show help mes‐
514              sage for proper version]
515
516       bash-completion
517              Prints arguments for bash_completion.
518
519       help   Shows help about this program or one of its subcommands.
520
521       list-extensions
522

CINDER OPTIONAL ARGUMENTS

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

AUTHOR

3065       OpenStack Contributors
3066
3068       OpenStack Contributors
3069
3070
3071
3072
3073                                 Jan 30, 2020                        CINDER(1)
Impressum