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       This chapter documents cinder version 2.2.0.
12
13       For help on a specific cinder command, enter:
14
15          $ cinder help COMMAND
16

CINDER USAGE

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

CINDER OPTIONAL ARGUMENTS

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

AUTHOR

3073       OpenStack Contributors
3074
3076       OpenStack Contributors
3077
3078
3079
3080
30814.2.0                            Jul 26, 2019                        CINDER(1)
Impressum