1CINDER(1) python-cinderclient CINDER(1)
2
6 cinder - Client for OpenStack Block Storage API
7 The cinder client is the command-line interface (CLI) for the Block
9 Storage service (cinder) API and its extensions.
10 For help on a specific cinder command, enter:
12 $ cinder help COMMAND
14
16 usage: cinder [--version] [-d] [--service-type <service-type>]
17 [--service-name <service-name>]
18 [--volume-service-name <volume-service-name>]
19 [--os-endpoint-type <os-endpoint-type>]
20 [--os-volume-api-version <volume-api-ver>]
21 [--os-endpoint <os-endpoint>] [--retries <retries>] [--insecure]
22 [--os-cacert <ca-certificate>] [--os-cert <certificate>]
23 [--os-key <key>] [--timeout <seconds>] [--collect-timing]
24 [--os-auth-type <name>] [--os-auth-url OS_AUTH_URL]
25 [--os-system-scope OS_SYSTEM_SCOPE]
26 [--os-domain-id OS_DOMAIN_ID] [--os-domain-name OS_DOMAIN_NAME]
27 [--os-project-id OS_PROJECT_ID]
28 [--os-project-name OS_PROJECT_NAME]
29 [--os-project-domain-id OS_PROJECT_DOMAIN_ID]
30 [--os-project-domain-name OS_PROJECT_DOMAIN_NAME]
31 [--os-trust-id OS_TRUST_ID]
32 [--os-default-domain-id OS_DEFAULT_DOMAIN_ID]
33 [--os-default-domain-name OS_DEFAULT_DOMAIN_NAME]
34 [--os-user-id OS_USER_ID] [--os-username OS_USERNAME]
35 [--os-user-domain-id OS_USER_DOMAIN_ID]
36 [--os-user-domain-name OS_USER_DOMAIN_NAME]
37 [--os-password OS_PASSWORD] [--os-auth-strategy <auth-strategy>]
38 [--os-token <token>] [--os-url <url>]
39 <subcommand> ...
40 Optional Arguments
42 --collect-timing
43 Collect per-API call timing information.
44 --insecure
46 Explicitly allow client to perform "insecure" TLS (https) re‐
47 quests. The server's certificate will not be verified against
48 any certificate authorities. This option should be used with
49 caution.
50 --os-auth-strategy
52 Authentication strategy (Env: OS_AUTH_STRATEGY, default key‐
53 stone). For now, any other value will disable the authentica‐
54 tion.
55 --os-auth-type, --os-auth-plugin
57 Authentication type to use
58 --os-auth-url
60 Authentication URL
61 --os-cacert
63 Specify a CA bundle file to use in verifying a TLS (https)
64 server certificate. Defaults to env[OS_CACERT].
65 --os-cert
67 The location for the keystore (PEM formatted) containing the
68 public key of this client. Defaults to env[OS_CERT].
69 --os-default-domain-id
71 Optional domain ID to use with v3 and v2 parameters. It will be
72 used for both the user and project domain in v3 and ignored in
73 v2 authentication.
74 --os-default-domain-name
76 Optional domain name to use with v3 API and v2 parameters. It
77 will be used for both the user and project domain in v3 and ig‐
78 nored in v2 authentication.
79 --os-domain-id
81 Domain ID to scope to
82 --os-domain-name
84 Domain name to scope to
85 --os-endpoint
87 Use this API endpoint instead of the Service Catalog. Defaults
88 to env[CINDER_ENDPOINT].
89 --os-endpoint-type
91 Endpoint type, which is publicURL or internalURL. De‐
92 fault=env[OS_ENDPOINT_TYPE] or nova env[CINDER_ENDPOINT_TYPE] or
93 publicURL.
94 --os-key
96 The location for the keystore (PEM formatted) containing the
97 private key of this client. Defaults to env[OS_KEY].
98 --os-password
100 User's password
101 --os-project-domain-id
103 Domain ID containing project
104 --os-project-domain-name
106 Domain name containing project
107 --os-project-id, --os-tenant-id
109 Project ID to scope to
110 --os-project-name, --os-tenant-name
112 Project name to scope to
113 --os-system-scope
115 Scope for system operations
116 --os-token
118 Defaults to env[OS_TOKEN].
119 --os-trust-id
121 ID of the trust to use as a trustee use
122 --os-url
124 Defaults to env[OS_URL].
125 --os-user-domain-id
127 User's domain id
128 --os-user-domain-name
130 User's domain name
131 --os-user-id
133 User id
134 --os-username, --os-user-name
136 Username
137 --os-volume-api-version
139 Block Storage API version. Accepts X, X.Y (where X is major and
140 Y is minor part). NOTE: this client accepts only '3' for the
141 major version. Default=env[OS_VOLUME_API_VERSION].
142 --retries
144 Number of retries.
145 --service-name
147 Service name. Default=env[CINDER_SERVICE_NAME].
148 --service-type
150 Service type. For most actions, default is volume.
151 --timeout
153 Set request timeout (in seconds).
154 --version
156 show program's version number and exit
157 --volume-service-name
159 Volume service name. Default=env[CINDER_VOLUME_SERVICE_NAME].
160 -d, --debug
162 Shows debugging output.
163 Commands
165 absolute-limits
166 Lists absolute limits for a user.
167 api-version
169 Display the server API version information.
170 attachment-complete
172 Complete an attachment for a cinder volume.
173 attachment-create
175 Create an attachment for a cinder volume.
176 attachment-delete
178 Delete an attachment for a cinder volume.
179 attachment-list
181 Lists all attachments.
182 attachment-show
184 Show detailed information for attachment.
185 attachment-update
187 Update an attachment for a cinder volume.
188 availability-zone-list
190 Lists all availability zones.
191 backup-create
193 Creates a volume backup.
194 backup-delete
196 Removes one or more backups.
197 backup-export
199 Export backup metadata record.
200 backup-import
202 Import backup metadata record.
203 backup-list
205 Lists all backups.
206 backup-reset-state
208 Explicitly updates the backup state.
209 backup-restore
211 Restores a backup.
212 backup-show
214 Shows backup details.
215 backup-update
217 Updates a backup.
218 cgsnapshot-create
220 Creates a cgsnapshot.
221 cgsnapshot-delete
223 Removes one or more cgsnapshots.
224 cgsnapshot-list
226 Lists all cgsnapshots.
227 cgsnapshot-show
229 Shows cgsnapshot details.
230 cluster-disable
232 Disables clustered services.
233 cluster-enable
235 Enables clustered services.
236 cluster-list
238 Lists clustered services with optional filtering.
239 cluster-show
241 Show detailed information on a clustered service.
242 consisgroup-create
244 Creates a consistency group.
245 consisgroup-create-from-src
247 Creates a consistency group from a cgsnapshot or a source CG.
248 consisgroup-delete
250 Removes one or more consistency groups.
251 consisgroup-list
253 Lists all consistency groups.
254 consisgroup-show
256 Shows details of a consistency group.
257 consisgroup-update
259 Updates a consistency group.
260 create Creates a volume.
262 default-type-list
264 Lists all default volume types.
265 default-type-set
267 Sets a default volume type for a project.
268 default-type-unset
270 Unset default volume types.
271 delete Removes one or more volumes.
273 encryption-type-create
275 Creates encryption type for a volume type. Admin only.
276 encryption-type-delete
278 Deletes encryption type for a volume type. Admin only.
279 encryption-type-list
281 Shows encryption type details for volume types. Admin only.
282 encryption-type-show
284 Shows encryption type details for a volume type. Admin only.
285 encryption-type-update
287 Update encryption type information for a volume type (Admin
288 Only).
289 extend Attempts to extend size of an existing volume.
291 extra-specs-list
293 Lists current volume types and extra specs.
294 failover-host
296 Failover a replicating cinder-volume host.
297 force-delete
299 Attempts force-delete of volume, regardless of state.
300 freeze-host
302 Freeze and disable the specified cinder-volume host.
303 get-capabilities
305 Show backend volume stats and properties. Admin only.
306 get-pools
308 Show pool information for backends. Admin only.
309 group-create
311 Creates a group.
312 group-create-from-src
314 Creates a group from a group snapshot or a source group.
315 group-delete
317 Removes one or more groups.
318 group-disable-replication
320 Disables replication for group.
321 group-enable-replication
323 Enables replication for group.
324 group-failover-replication
326 Fails over replication for group.
327 group-list
329 Lists all groups.
330 group-list-replication-targets
332 Lists replication targets for group.
333 group-show
335 Shows details of a group.
336 group-snapshot-create
338 Creates a group snapshot.
339 group-snapshot-delete
341 Removes one or more group snapshots.
342 group-snapshot-list
344 Lists all group snapshots.
345 group-snapshot-show
347 Shows group snapshot details.
348 group-specs-list
350 Lists current group types and specs.
351 group-type-create
353 Creates a group type.
354 group-type-default
356 List the default group type.
357 group-type-delete
359 Deletes group type or types.
360 group-type-key
362 Sets or unsets group_spec for a group type.
363 group-type-list
365 Lists available 'group types'. (Admin only will see private
366 types)
367 group-type-show
369 Show group type details.
370 group-type-update
372 Updates group type name, description, and/or is_public.
373 group-update
375 Updates a group.
376 image-metadata
378 Sets or deletes volume image metadata.
379 image-metadata-show
381 Shows volume image metadata.
382 list Lists all volumes.
384 list-filters
386 List enabled filters.
387 manage Manage an existing volume.
389 manageable-list
391 Lists all manageable volumes.
392 message-delete
394 Removes one or more messages.
395 message-list
397 Lists all messages.
398 message-show
400 Shows message details.
401 metadata
403 Sets or deletes volume metadata.
404 metadata-show
406 Shows volume metadata.
407 metadata-update-all
409 Updates volume metadata.
410 migrate
412 Migrates volume to a new host.
413 qos-associate
415 Associates qos specs with specified volume type.
416 qos-create
418 Creates a qos specs.
419 qos-delete
421 Deletes a specified qos specs.
422 qos-disassociate
424 Disassociates qos specs from specified volume type.
425 qos-disassociate-all
427 Disassociates qos specs from all its associations.
428 qos-get-association
430 Lists all associations for specified qos specs.
431 qos-key
433 Sets or unsets specifications for a qos spec.
434 qos-list
436 Lists qos specs.
437 qos-show
439 Shows qos specs details.
440 quota-class-show
442 Lists quotas for a quota class.
443 quota-class-update
445 Updates quotas for a quota class.
446 quota-defaults
448 Lists default quotas for a tenant.
449 quota-delete
451 Delete the quotas for a tenant.
452 quota-show
454 Lists quotas for a tenant.
455 quota-update
457 Updates quotas for a tenant.
458 quota-usage
460 Lists quota usage for a tenant.
461 rate-limits
463 Lists rate limits for a user.
464 readonly-mode-update
466 Updates volume read-only access-mode flag.
467 reimage
469 Rebuilds a volume, overwriting all content with the specified
470 image
471 rename Renames a volume.
473 reset-state
475 Explicitly updates the entity state in the Cinder database.
476 retype Changes the volume type for a volume.
478 revert-to-snapshot
480 Revert a volume to the specified snapshot.
481 service-disable
483 Disables the service.
484 service-enable
486 Enables the service.
487 service-get-log
489 Gets the service log level.
490 service-list
492 Lists all services. Filter by host and service binary.
493 service-set-log
495 Sets the service log level.
496 set-bootable
498 Update bootable status of a volume.
499 show Shows volume details.
501 snapshot-create
503 Creates a snapshot.
504 snapshot-delete
506 Removes one or more snapshots.
507 snapshot-list
509 Lists all snapshots.
510 snapshot-manage
512 Manage an existing snapshot.
513 snapshot-manageable-list
515 Lists all manageable snapshots.
516 snapshot-metadata
518 Sets or deletes snapshot metadata.
519 snapshot-metadata-show
521 Shows snapshot metadata.
522 snapshot-metadata-update-all
524 Updates snapshot metadata.
525 snapshot-rename
527 Renames a snapshot.
528 snapshot-reset-state
530 Explicitly updates the snapshot state.
531 snapshot-show
533 Shows snapshot details.
534 snapshot-unmanage
536 Stop managing a snapshot.
537 summary
539 Get volumes summary.
540 thaw-host
542 Thaw and enable the specified cinder-volume host.
543 transfer-accept
545 Accepts a volume transfer.
546 transfer-create
548 Creates a volume transfer.
549 transfer-delete
551 Undoes a transfer.
552 transfer-list
554 Lists all transfers.
555 transfer-show
557 Shows transfer details.
558 type-access-add
560 Adds volume type access for the given project.
561 type-access-list
563 Print access information about the given volume type.
564 type-access-remove
566 Removes volume type access for the given project.
567 type-create
569 Creates a volume type.
570 type-default
572 List the default volume type.
573 type-delete
575 Deletes volume type or types.
576 type-key
578 Sets or unsets extra_spec for a volume type.
579 type-list
581 Lists available 'volume types'.
582 type-show
584 Show volume type details.
585 type-update
587 Updates volume type name, description, and/or is_public.
588 unmanage
590 Stop managing a volume.
591 upload-to-image
593 Uploads volume to Image Service as an image.
594 version-list
596 List all API versions.
597 work-cleanup
599 Request cleanup of services with optional filtering.
600 help Shows help about this program or one of its subcommands.
602
604 cinder absolute-limits
605 usage: cinder absolute-limits [<tenant_id>]
606 Lists absolute limits for a user.
608 Positional arguments:
610 <tenant_id>
612 Display information for a single tenant (Admin only).
613 cinder api-version
615 usage: cinder api-version
616 Display the server API version information.
618 cinder attachment-complete
620 usage: cinder attachment-complete <attachment> [<attachment> ...]
621 Complete an attachment for a cinder volume.
623 Positional arguments:
625 <attachment>
627 ID of attachment or attachments to delete.
628 cinder attachment-create
630 usage: cinder attachment-create [--connect <connect>]
631 [--initiator <initiator>] [--ip <ip>]
632 [--host <host>] [--platform <platform>]
633 [--ostype <ostype>] [--multipath <multipath>]
634 [--mountpoint <mountpoint>] [--mode <mode>]
635 <volume> [<server_id>]
636 Create an attachment for a cinder volume.
638 Positional arguments:
640 <volume>
642 Name or ID of volume or volumes to attach.
643 <server_id>
645 ID of server attaching to.
646 Optional arguments:
648 --connect <connect>
650 Make an active connection using provided connector info (True or
651 False).
652 --initiator <initiator>
654 iqn of the initiator attaching to. Default=None.
655 --ip <ip>
657 ip of the system attaching to. Default=None.
658 --host <host>
660 Name of the host attaching to. Default=None.
661 --platform <platform>
663 Platform type. Default=x86_64.
664 --ostype <ostype>
666 OS type. Default=linux2.
667 --multipath <multipath>
669 Use multipath. Default=False.
670 --mountpoint <mountpoint>
672 Mountpoint volume will be attached at. Default=None.
673 --mode <mode>
675 Mode of attachment, rw, ro and null, where null indicates we
676 want to honor any existing admin-metadata settings. De‐
677 fault=null.
678 cinder attachment-delete
680 usage: cinder attachment-delete <attachment> [<attachment> ...]
681 Delete an attachment for a cinder volume.
683 Positional arguments:
685 <attachment>
687 ID of attachment or attachments to delete.
688 cinder attachment-list
690 usage: cinder attachment-list [--all-tenants [<0|1>]]
691 [--volume-id <volume-id>] [--status <status>]
692 [--marker <marker>] [--limit <limit>]
693 [--sort <key>[:<direction>]]
694 [--tenant [<tenant>]]
695 [--filters [<key=value> ...]]
696 Lists all attachments.
698 Optional arguments:
700 --all-tenants <0|1>
702 Shows details for all tenants. Admin only.
703 --volume-id <volume-id>
705 Filters results by a volume ID. Default=None. This option is
706 deprecated and will be removed in newer release. Please use
707 '--filters' option which is introduced since 3.33 instead.
708 --status <status>
710 Filters results by a status. Default=None. This option is depre‐
711 cated and will be removed in newer release. Please use '--fil‐
712 ters' option which is introduced since 3.33 instead.
713 --marker <marker>
715 Begin returning attachments that appear later in attachment list
716 than that represented by this id. Default=None.
717 --limit <limit>
719 Maximum number of attachments to return. Default=None.
720 --sort <key>[:<direction>]
722 Comma-separated list of sort keys and directions in the form of
723 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
724 ity_zone, name, bootable, created_at, reference. Default=None.
725 --tenant <tenant>
727 Display information from single tenant (Admin only).
728 --filters <key=value>
730 Filter key and value pairs. Please use 'cinder list-filters' to
731 check enabled filters from server. Use 'key~=value' for inexact
732 filtering if the key supports. Default=None.
733 cinder attachment-show
735 usage: cinder attachment-show <attachment>
736 Show detailed information for attachment.
738 Positional arguments:
740 <attachment>
742 ID of attachment.
743 cinder attachment-update
745 usage: cinder attachment-update [--initiator <initiator>] [--ip <ip>]
746 [--host <host>] [--platform <platform>]
747 [--ostype <ostype>] [--multipath <multipath>]
748 [--mountpoint <mountpoint>]
749 <attachment>
750 Update an attachment for a cinder volume.
752 Positional arguments:
754 <attachment>
756 ID of attachment.
757 Optional arguments:
759 --initiator <initiator>
761 iqn of the initiator attaching to. Default=None.
762 --ip <ip>
764 ip of the system attaching to. Default=None.
765 --host <host>
767 Name of the host attaching to. Default=None.
768 --platform <platform>
770 Platform type. Default=x86_64.
771 --ostype <ostype>
773 OS type. Default=linux2.
774 --multipath <multipath>
776 Use multipath. Default=False.
777 --mountpoint <mountpoint>
779 Mountpoint volume will be attached at. Default=None.
780 cinder availability-zone-list
782 usage: cinder availability-zone-list
783 Lists all availability zones.
785 cinder backup-create
787 usage: cinder backup-create [--container <container>] [--name <name>]
788 [--description <description>] [--incremental]
789 [--force] [--snapshot-id <snapshot-id>]
790 [--metadata [<key=value> ...]]
791 [--availability-zone AVAILABILITY_ZONE]
792 <volume>
793 Creates a volume backup.
795 Positional arguments:
797 <volume>
799 Name or ID of volume to backup.
800 Optional arguments:
802 --container <container>
804 Backup container name. Default=None.
805 --name <name>
807 Backup name. Default=None.
808 --description <description>
810 Backup description. Default=None.
811 --incremental None
813 Incremental backup. Default=False.
814 --force None
816 Allows or disallows backup of a volume when the volume is at‐
817 tached to an instance. If set to True, backs up the volume
818 whether its status is "available" or "in-use". The backup of an
819 "in-use" volume means your data is crash consistent. De‐
820 fault=False.
821 --snapshot-id <snapshot-id>
823 ID of snapshot to backup. Default=None.
824 --metadata <key=value>
826 Metadata key and value pairs. Default=None.
827 --availability-zone None
829 AZ where the backup should be stored, by default it will be the
830 same as the source.
831 cinder backup-delete
833 usage: cinder backup-delete [--force] <backup> [<backup> ...]
834 Removes one or more backups.
836 Positional arguments:
838 <backup>
840 Name or ID of backup(s) to delete.
841 Optional arguments:
843 --force None
845 Allows deleting backup of a volume when its status is other than
846 "available" or "error". Default=False.
847 cinder backup-export
849 usage: cinder backup-export <backup>
850 Export backup metadata record.
852 Positional arguments:
854 <backup>
856 ID of the backup to export.
857 cinder backup-import
859 usage: cinder backup-import <backup_service> <backup_url>
860 Import backup metadata record.
862 Positional arguments:
864 <backup_service>
866 Backup service to use for importing the backup.
867 <backup_url>
869 Backup URL for importing the backup metadata.
870 cinder backup-list
872 usage: cinder backup-list [--all-tenants [<all_tenants>]] [--name <name>]
873 [--status <status>] [--volume-id <volume-id>]
874 [--marker <marker>] [--limit <limit>]
875 [--sort <key>[:<direction>]]
876 [--filters [<key=value> ...]]
877 [--with-count [<True|False>]]
878 Lists all backups.
880 Optional arguments:
882 --all-tenants <all_tenants>
884 Shows details for all tenants. Admin only.
885 --name <name>
887 Filters results by a name. Default=None. This option is depre‐
888 cated and will be removed in newer release. Please use '--fil‐
889 ters' option which is introduced since 3.33 instead.
890 --status <status>
892 Filters results by a status. Default=None. This option is depre‐
893 cated and will be removed in newer release. Please use '--fil‐
894 ters' option which is introduced since 3.33 instead.
895 --volume-id <volume-id>
897 Filters results by a volume ID. Default=None. This option is
898 deprecated and will be removed in newer release. Please use
899 '--filters' option which is introduced since 3.33 instead.
900 --marker <marker>
902 Begin returning backups that appear later in the backup list
903 than that represented by this id. Default=None.
904 --limit <limit>
906 Maximum number of backups to return. Default=None.
907 --sort <key>[:<direction>]
909 Comma-separated list of sort keys and directions in the form of
910 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
911 ity_zone, name, bootable, created_at, reference. Default=None.
912 --filters <key=value>
914 Filter key and value pairs. Please use 'cinder list-filters' to
915 check enabled filters from server. Use 'key~=value' for inexact
916 filtering if the key supports. Default=None.
917 --with-count <True|False>
919 Show total number of backup entities. This is useful when pagi‐
920 nation is applied in the request.
921 cinder backup-reset-state
923 usage: cinder backup-reset-state [--state <state>] <backup> [<backup> ...]
924 Explicitly updates the backup state.
926 Positional arguments:
928 <backup>
930 Name or ID of the backup to modify.
931 Optional arguments:
933 --state <state>
935 The state to assign to the backup. Valid values are "available",
936 "error". Default=available.
937 cinder backup-restore
939 usage: cinder backup-restore [--volume <volume>] [--name <name>]
940 [--volume-type <volume-type>]
941 [--availability-zone <AZ>]
942 <backup>
943 Restores a backup.
945 Positional arguments:
947 <backup>
949 Name or ID of backup to restore.
950 Optional arguments:
952 --volume <volume>
954 Name or ID of existing volume to which to restore. This is mutu‐
955 ally exclusive with --name and takes priority. Default=None.
956 --name <name>
958 Use the name for new volume creation to restore. This is mutu‐
959 ally exclusive with --volume and --volume takes priority. De‐
960 fault=None.
961 --volume-type <volume-type>
963 Volume type for the new volume creation to restore. This option
964 is not valid when used with the "volume" option. Default=None.
965 --availability-zone <AZ>
967 AZ for the new volume creation to restore. By default it will be
968 the same as backup AZ. This option is not valid when used with
969 the "volume" option. Default=None.
970 cinder backup-show
972 usage: cinder backup-show <backup>
973 Shows backup details.
975 Positional arguments:
977 <backup>
979 Name or ID of backup.
980 cinder backup-update
982 usage: cinder backup-update [--name [<name>]] [--description <description>]
983 [--metadata [<key=value> ...]]
984 <backup>
985 Updates a backup.
987 Positional arguments:
989 <backup>
991 Name or ID of backup to rename.
992 Optional arguments:
994 --name <name>
996 New name for backup.
997 --description <description>
999 Backup description. Default=None.
1000 --metadata <key=value>
1002 Metadata key and value pairs. Default=None.
1003 cinder cgsnapshot-create
1005 usage: cinder cgsnapshot-create [--name <name>] [--description <description>]
1006 <consistencygroup>
1007 Creates a cgsnapshot.
1009 Positional arguments:
1011 <consistencygroup>
1013 Name or ID of a consistency group.
1014 Optional arguments:
1016 --name <name>
1018 Cgsnapshot name. Default=None.
1019 --description <description>
1021 Cgsnapshot description. Default=None.
1022 cinder cgsnapshot-delete
1024 usage: cinder cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]
1025 Removes one or more cgsnapshots.
1027 Positional arguments:
1029 <cgsnapshot>
1031 Name or ID of one or more cgsnapshots to be deleted.
1032 cinder cgsnapshot-list
1034 usage: cinder cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>]
1035 [--consistencygroup-id <consistencygroup_id>]
1036 Lists all cgsnapshots.
1038 Optional arguments:
1040 --all-tenants <0|1>
1042 Shows details for all tenants. Admin only.
1043 --status <status>
1045 Filters results by a status. Default=None.
1046 --consistencygroup-id <consistencygroup_id>
1048 Filters results by a consistency group ID. Default=None.
1049 cinder cgsnapshot-show
1051 usage: cinder cgsnapshot-show <cgsnapshot>
1052 Shows cgsnapshot details.
1054 Positional arguments:
1056 <cgsnapshot>
1058 Name or ID of cgsnapshot.
1059 cinder cluster-disable
1061 usage: cinder cluster-disable [--reason <reason>] [<binary>] <cluster-name>
1062 Disables clustered services.
1064 Positional arguments:
1066 <binary>
1068 Binary to filter by. Default: cinder-volume.
1069 <cluster-name>
1071 Name of the clustered services to update.
1072 Optional arguments:
1074 --reason <reason>
1076 Reason for disabling clustered service.
1077 cinder cluster-enable
1079 usage: cinder cluster-enable [<binary>] <cluster-name>
1080 Enables clustered services.
1082 Positional arguments:
1084 <binary>
1086 Binary to filter by. Default: cinder-volume.
1087 <cluster-name>
1089 Name of the clustered services to update.
1090 cinder cluster-list
1092 usage: cinder cluster-list [--name <name>] [--binary <binary>]
1093 [--is-up <True|true|False|false>]
1094 [--disabled <True|true|False|false>]
1095 [--num-hosts <num-hosts>]
1096 [--num-down-hosts <num-down-hosts>] [--detailed]
1097 Lists clustered services with optional filtering.
1099 Optional arguments:
1101 --name <name>
1103 Filter by cluster name, without backend will list all clustered
1104 services from the same cluster. Default=None.
1105 --binary <binary>
1107 Cluster binary. Default=None.
1108 --is-up <True|true|False|false>
1110 Filter by up/down status. Default=None.
1111 --disabled <True|true|False|false>
1113 Filter by disabled status. Default=None.
1114 --num-hosts <num-hosts>
1116 Filter by number of hosts in the cluster.
1117 --num-down-hosts <num-down-hosts>
1119 Filter by number of hosts that are down.
1120 --detailed None
1122 Get detailed clustered service information (Default=False).
1123 cinder cluster-show
1125 usage: cinder cluster-show [<binary>] <cluster-name>
1126 Show detailed information on a clustered service.
1128 Positional arguments:
1130 <binary>
1132 Binary to filter by. Default: cinder-volume.
1133 <cluster-name>
1135 Name of the clustered service to show.
1136 cinder consisgroup-create
1138 usage: cinder consisgroup-create [--name <name>] [--description <description>]
1139 [--availability-zone <availability-zone>]
1140 <volume-types>
1141 Creates a consistency group.
1143 Positional arguments:
1145 <volume-types>
1147 Volume types.
1148 Optional arguments:
1150 --name <name>
1152 Name of a consistency group.
1153 --description <description>
1155 Description of a consistency group. Default=None.
1156 --availability-zone <availability-zone>
1158 Availability zone for volume. Default=None.
1159 cinder consisgroup-create-from-src
1161 usage: cinder consisgroup-create-from-src [--cgsnapshot <cgsnapshot>]
1162 [--source-cg <source-cg>]
1163 [--name <name>]
1164 [--description <description>]
1165 Creates a consistency group from a cgsnapshot or a source CG.
1167 Optional arguments:
1169 --cgsnapshot <cgsnapshot>
1171 Name or ID of a cgsnapshot. Default=None.
1172 --source-cg <source-cg>
1174 Name or ID of a source CG. Default=None.
1175 --name <name>
1177 Name of a consistency group. Default=None.
1178 --description <description>
1180 Description of a consistency group. Default=None.
1181 cinder consisgroup-delete
1183 usage: cinder consisgroup-delete [--force]
1184 <consistencygroup> [<consistencygroup> ...]
1185 Removes one or more consistency groups.
1187 Positional arguments:
1189 <consistencygroup>
1191 Name or ID of one or more consistency groups to be deleted.
1192 Optional arguments:
1194 --force None
1196 Allows or disallows consistency groups to be deleted. If the
1197 consistency group is empty, it can be deleted without the force
1198 flag. If the consistency group is not empty, the force flag is
1199 required for it to be deleted.
1200 cinder consisgroup-list
1202 usage: cinder consisgroup-list [--all-tenants [<0|1>]]
1203 Lists all consistency groups.
1205 Optional arguments:
1207 --all-tenants <0|1>
1209 Shows details for all tenants. Admin only.
1210 cinder consisgroup-show
1212 usage: cinder consisgroup-show <consistencygroup>
1213 Shows details of a consistency group.
1215 Positional arguments:
1217 <consistencygroup>
1219 Name or ID of a consistency group.
1220 cinder consisgroup-update
1222 usage: cinder consisgroup-update [--name <name>] [--description <description>]
1223 [--add-volumes <uuid1,uuid2,......>]
1224 [--remove-volumes <uuid3,uuid4,......>]
1225 <consistencygroup>
1226 Updates a consistency group.
1228 Positional arguments:
1230 <consistencygroup>
1232 Name or ID of a consistency group.
1233 Optional arguments:
1235 --name <name>
1237 New name for consistency group. Default=None.
1238 --description <description>
1240 New description for consistency group. Default=None.
1241 --add-volumes <uuid1,uuid2,......>
1243 UUID of one or more volumes to be added to the consistency
1244 group, separated by commas. Default=None.
1245 --remove-volumes <uuid3,uuid4,......>
1247 UUID of one or more volumes to be removed from the consistency
1248 group, separated by commas. Default=None.
1249 cinder create
1251 usage: cinder create [--consisgroup-id <consistencygroup-id>]
1252 [--group-id <group-id>] [--snapshot-id <snapshot-id>]
1253 [--source-volid <source-volid>] [--image-id <image-id>]
1254 [--image <image>] [--backup-id <backup-id>]
1255 [--name <name>] [--description <description>]
1256 [--volume-type <volume-type>]
1257 [--availability-zone <availability-zone>]
1258 [--metadata [<key=value> ...]] [--hint <key=value>]
1259 [--poll]
1260 [<size>]
1261 Creates a volume.
1263 Positional arguments:
1265 <size> Size of volume, in GiBs. (Required unless snap‐
1267 shot-id/source-volid/backup-id is specified).
1268 Optional arguments:
1270 --consisgroup-id <consistencygroup-id>
1272 ID of a consistency group where the new volume belongs to. De‐
1273 fault=None.
1274 --group-id <group-id>
1276 ID of a group where the new volume belongs to. Default=None.
1277 --snapshot-id <snapshot-id>
1279 Creates volume from snapshot ID. Default=None.
1280 --source-volid <source-volid>
1282 Creates volume from volume ID. Default=None.
1283 --image-id <image-id>
1285 Creates volume from image ID. Default=None.
1286 --image <image>
1288 Creates a volume from image (ID or name). Default=None.
1289 --backup-id <backup-id>
1291 Creates a volume from backup ID. Default=None.
1292 --name <name>
1294 Volume name. Default=None.
1295 --description <description>
1297 Volume description. Default=None.
1298 --volume-type <volume-type>
1300 Volume type. Default=None, that is, use the default volume type
1301 configured for the Block Storage API. You can see what type
1302 this is by using the 'cinder type-default' command.
1303 --availability-zone <availability-zone>
1305 Availability zone for volume. Default=None.
1306 --metadata <key=value>
1308 Metadata key and value pairs. Default=None.
1309 --hint <key=value>
1311 Scheduler hint, similar to nova. Repeat option to set multiple
1312 hints. Values with the same key will be stored as a list.
1313 --poll None
1315 Wait for volume creation until it completes.
1316 cinder default-type-list
1318 usage: cinder default-type-list [--project-id <project_id>]
1319 Lists all default volume types.
1321 Optional arguments:
1323 --project-id <project_id>
1325 ID of project for which to show the default type.
1326 cinder default-type-set
1328 usage: cinder default-type-set <volume_type> <project_id>
1329 Sets a default volume type for a project.
1331 Positional arguments:
1333 <volume_type>
1335 Name or ID of the volume type.
1336 <project_id>
1338 ID of project for which to set default type.
1339 cinder default-type-unset
1341 usage: cinder default-type-unset <project_id> [<project_id> ...]
1342 Unset default volume types.
1344 Positional arguments:
1346 <project_id>
1348 ID of project for which to unset default type.
1349 cinder delete
1351 usage: cinder delete [--cascade] <volume> [<volume> ...]
1352 Removes one or more volumes.
1354 Positional arguments:
1356 <volume>
1358 Name or ID of volume or volumes to delete.
1359 Optional arguments:
1361 --cascade None
1363 Remove any snapshots along with volume. Default=False.
1364 cinder encryption-type-create
1366 usage: cinder encryption-type-create [--cipher <cipher>]
1367 [--key-size <key_size>]
1368 [--control-location <control_location>]
1369 <volume_type> <provider>
1370 Creates encryption type for a volume type. Admin only.
1372 Positional arguments:
1374 <volume_type>
1376 Name or ID of volume type.
1377 <provider>
1379 The encryption provider format. For example, "luks" or "plain".
1380 Optional arguments:
1382 --cipher <cipher>
1384 The encryption algorithm or mode. For example, aes-xts-plain64.
1385 Default=None.
1386 --key-size <key_size>
1388 Size of encryption key, in bits. For example, 128 or 256. De‐
1389 fault=None.
1390 --control-location <control_location>
1392 Notional service where encryption is performed. Valid values are
1393 "front-end" or "back-end". For example, front-end=Nova. Default
1394 is "front-end".
1395 cinder encryption-type-delete
1397 usage: cinder encryption-type-delete <volume_type>
1398 Deletes encryption type for a volume type. Admin only.
1400 Positional arguments:
1402 <volume_type>
1404 Name or ID of volume type.
1405 cinder encryption-type-list
1407 usage: cinder encryption-type-list
1408 Shows encryption type details for volume types. Admin only.
1410 cinder encryption-type-show
1412 usage: cinder encryption-type-show <volume_type>
1413 Shows encryption type details for a volume type. Admin only.
1415 Positional arguments:
1417 <volume_type>
1419 Name or ID of volume type.
1420 cinder encryption-type-update
1422 usage: cinder encryption-type-update [--provider <provider>]
1423 [--cipher [<cipher>]]
1424 [--key-size [<key-size>]]
1425 [--control-location <control-location>]
1426 <volume-type>
1427 Update encryption type information for a volume type (Admin Only).
1429 Positional arguments:
1431 <volume-type>
1433 Name or ID of the volume type
1434 Optional arguments:
1436 --provider <provider>
1438 Encryption provider format (e.g. 'luks' or 'plain').
1439 --cipher <cipher>
1441 Encryption algorithm/mode to use (e.g., aes-xts-plain64). Pro‐
1442 vide parameter without value to set to provider default.
1443 --key-size <key-size>
1445 Size of the encryption key, in bits (e.g., 128, 256). Provide
1446 parameter without value to set to provider default.
1447 --control-location <control-location>
1449 Notional service where encryption is performed (e.g.,
1450 front-end=Nova). Values: 'front-end', 'back-end'
1451 cinder extend
1453 usage: cinder extend <volume> <new_size>
1454 Attempts to extend size of an existing volume.
1456 Positional arguments:
1458 <volume>
1460 Name or ID of volume to extend.
1461 <new_size>
1463 New size of volume, in GiBs.
1464 cinder extra-specs-list
1466 usage: cinder extra-specs-list
1467 Lists current volume types and extra specs.
1469 cinder failover-host
1471 usage: cinder failover-host [--backend_id <backend-id>] <hostname>
1472 Failover a replicating cinder-volume host.
1474 Positional arguments:
1476 <hostname>
1478 Host name.
1479 Optional arguments:
1481 --backend_id <backend-id>
1483 ID of backend to failover to (Default=None)
1484 cinder force-delete
1486 usage: cinder force-delete <volume> [<volume> ...]
1487 Attempts force-delete of volume, regardless of state.
1489 Positional arguments:
1491 <volume>
1493 Name or ID of volume or volumes to delete.
1494 cinder freeze-host
1496 usage: cinder freeze-host <hostname>
1497 Freeze and disable the specified cinder-volume host.
1499 Positional arguments:
1501 <hostname>
1503 Host name.
1504 cinder get-capabilities
1506 usage: cinder get-capabilities <host>
1507 Show backend volume stats and properties. Admin only.
1509 Positional arguments:
1511 <host> Cinder host to show backend volume stats and properties; takes
1513 the form: host@backend-name
1514 cinder get-pools
1516 usage: cinder get-pools [--detail] [--filters [<key=value> ...]]
1517 Show pool information for backends. Admin only.
1519 Optional arguments:
1521 --detail None
1523 Show detailed information about pools.
1524 --filters <key=value>
1526 Filter key and value pairs. Please use 'cinder list-filters' to
1527 check enabled filters from server, Default=None.
1528 cinder group-create
1530 usage: cinder group-create [--name <name>] [--description <description>]
1531 [--availability-zone <availability-zone>]
1532 <group-type> <volume-types>
1533 Creates a group.
1535 Positional arguments:
1537 <group-type>
1539 Group type.
1540 <volume-types>
1542 Comma-separated list of volume types.
1543 Optional arguments:
1545 --name <name>
1547 Name of a group.
1548 --description <description>
1550 Description of a group. Default=None.
1551 --availability-zone <availability-zone>
1553 Availability zone for group. Default=None.
1554 cinder group-create-from-src
1556 usage: cinder group-create-from-src [--group-snapshot <group-snapshot>]
1557 [--source-group <source-group>]
1558 [--name <name>]
1559 [--description <description>]
1560 Creates a group from a group snapshot or a source group.
1562 Optional arguments:
1564 --group-snapshot <group-snapshot>
1566 Name or ID of a group snapshot. Default=None.
1567 --source-group <source-group>
1569 Name or ID of a source group. Default=None.
1570 --name <name>
1572 Name of a group. Default=None.
1573 --description <description>
1575 Description of a group. Default=None.
1576 cinder group-delete
1578 usage: cinder group-delete [--delete-volumes] <group> [<group> ...]
1579 Removes one or more groups.
1581 Positional arguments:
1583 <group>
1585 Name or ID of one or more groups to be deleted.
1586 Optional arguments:
1588 --delete-volumes None
1590 Allows or disallows groups to be deleted if they are not empty.
1591 If the group is empty, it can be deleted without the delete-vol‐
1592 umes flag. If the group is not empty, the delete-volumes flag is
1593 required for it to be deleted. If True, all volumes in the group
1594 will also be deleted.
1595 cinder group-disable-replication
1597 usage: cinder group-disable-replication <group>
1598 Disables replication for group.
1600 Positional arguments:
1602 <group>
1604 Name or ID of the group.
1605 cinder group-enable-replication
1607 usage: cinder group-enable-replication <group>
1608 Enables replication for group.
1610 Positional arguments:
1612 <group>
1614 Name or ID of the group.
1615 cinder group-failover-replication
1617 usage: cinder group-failover-replication [--allow-attached-volume]
1618 [--secondary-backend-id <secondary_backend_id>]
1619 <group>
1620 Fails over replication for group.
1622 Positional arguments:
1624 <group>
1626 Name or ID of the group.
1627 Optional arguments:
1629 --allow-attached-volume None
1631 Allows or disallows group with attached volumes to be failed
1632 over.
1633 --secondary-backend-id <secondary_backend_id>
1635 Secondary backend id. Default=None.
1636 cinder group-list
1638 usage: cinder group-list [--all-tenants [<0|1>]] [--filters [<key=value> ...]]
1639 Lists all groups.
1641 Optional arguments:
1643 --all-tenants <0|1>
1645 Shows details for all tenants. Admin only.
1646 --filters <key=value>
1648 Filter key and value pairs. Please use 'cinder list-filters' to
1649 check enabled filters from server. Use 'key~=value' for inexact
1650 filtering if the key supports. Default=None.
1651 cinder group-list-replication-targets
1653 usage: cinder group-list-replication-targets <group>
1654 Lists replication targets for group.
1656 Positional arguments:
1658 <group>
1660 Name or ID of the group.
1661 cinder group-show
1663 usage: cinder group-show [--list-volume [<False|True>]] <group>
1664 Shows details of a group.
1666 Positional arguments:
1668 <group>
1670 Name or ID of a group.
1671 Optional arguments:
1673 --list-volume <False|True>
1675 Shows volumes included in the group.
1676 cinder group-snapshot-create
1678 usage: cinder group-snapshot-create [--name <name>]
1679 [--description <description>]
1680 <group>
1681 Creates a group snapshot.
1683 Positional arguments:
1685 <group>
1687 Name or ID of a group.
1688 Optional arguments:
1690 --name <name>
1692 Group snapshot name. Default=None.
1693 --description <description>
1695 Group snapshot description. Default=None.
1696 cinder group-snapshot-delete
1698 usage: cinder group-snapshot-delete <group_snapshot> [<group_snapshot> ...]
1699 Removes one or more group snapshots.
1701 Positional arguments:
1703 <group_snapshot>
1705 Name or ID of one or more group snapshots to be deleted.
1706 cinder group-snapshot-list
1708 usage: cinder group-snapshot-list [--all-tenants [<0|1>]] [--status <status>]
1709 [--group-id <group_id>]
1710 [--filters [<key=value> ...]]
1711 Lists all group snapshots.
1713 Optional arguments:
1715 --all-tenants <0|1>
1717 Shows details for all tenants. Admin only.
1718 --status <status>
1720 Filters results by a status. Default=None. This option is depre‐
1721 cated and will be removed in newer release. Please use '--fil‐
1722 ters' option which is introduced since 3.33 instead.
1723 --group-id <group_id>
1725 Filters results by a group ID. Default=None. This option is dep‐
1726 recated and will be removed in newer release. Please use '--fil‐
1727 ters' option which is introduced since 3.33 instead.
1728 --filters <key=value>
1730 Filter key and value pairs. Please use 'cinder list-filters' to
1731 check enabled filters from server. Use 'key~=value' for inexact
1732 filtering if the key supports. Default=None.
1733 cinder group-snapshot-show
1735 usage: cinder group-snapshot-show <group_snapshot>
1736 Shows group snapshot details.
1738 Positional arguments:
1740 <group_snapshot>
1742 Name or ID of group snapshot.
1743 cinder group-specs-list
1745 usage: cinder group-specs-list
1746 Lists current group types and specs.
1748 cinder group-type-create
1750 usage: cinder group-type-create [--description <description>]
1751 [--is-public <is-public>]
1752 <name>
1753 Creates a group type.
1755 Positional arguments:
1757 <name> Name of new group type.
1759 Optional arguments:
1761 --description <description>
1763 Description of new group type.
1764 --is-public <is-public>
1766 Make type accessible to the public (default true).
1767 cinder group-type-default
1769 usage: cinder group-type-default
1770 List the default group type.
1772 cinder group-type-delete
1774 usage: cinder group-type-delete <group_type> [<group_type> ...]
1775 Deletes group type or types.
1777 Positional arguments:
1779 <group_type>
1781 Name or ID of group type or types to delete.
1782 cinder group-type-key
1784 usage: cinder group-type-key <gtype> <action> <key=value> [<key=value> ...]
1785 Sets or unsets group_spec for a group type.
1787 Positional arguments:
1789 <gtype>
1791 Name or ID of group type.
1792 <action>
1794 The action. Valid values are "set" or "unset."
1795 <key=value>
1797 The group specs key and value pair to set or unset. For unset,
1798 specify only the key.
1799 cinder group-type-list
1801 usage: cinder group-type-list [--filters [<key=value> ...]]
1802 Lists available 'group types'. (Admin only will see private types)
1804 Optional arguments:
1806 --filters <key=value>
1808 Filter key and value pairs. Admin only.
1809 cinder group-type-show
1811 usage: cinder group-type-show <group_type>
1812 Show group type details.
1814 Positional arguments:
1816 <group_type>
1818 Name or ID of the group type.
1819 cinder group-type-update
1821 usage: cinder group-type-update [--name <name>] [--description <description>]
1822 [--is-public <is-public>]
1823 <id>
1824 Updates group type name, description, and/or is_public.
1826 Positional arguments:
1828 <id> ID of the group type.
1830 Optional arguments:
1832 --name <name>
1834 Name of the group type.
1835 --description <description>
1837 Description of the group type.
1838 --is-public <is-public>
1840 Make type accessible to the public or not.
1841 cinder group-update
1843 usage: cinder group-update [--name <name>] [--description <description>]
1844 [--add-volumes <uuid1,uuid2,......>]
1845 [--remove-volumes <uuid3,uuid4,......>]
1846 <group>
1847 Updates a group.
1849 Positional arguments:
1851 <group>
1853 Name or ID of a group.
1854 Optional arguments:
1856 --name <name>
1858 New name for group. Default=None.
1859 --description <description>
1861 New description for group. Default=None.
1862 --add-volumes <uuid1,uuid2,......>
1864 UUID of one or more volumes to be added to the group, separated
1865 by commas. Default=None.
1866 --remove-volumes <uuid3,uuid4,......>
1868 UUID of one or more volumes to be removed from the group, sepa‐
1869 rated by commas. Default=None.
1870 cinder image-metadata
1872 usage: cinder image-metadata <volume> <action> <key=value> [<key=value> ...]
1873 Sets or deletes volume image metadata.
1875 Positional arguments:
1877 <volume>
1879 Name or ID of volume for which to update metadata.
1880 <action>
1882 The action. Valid values are 'set' or 'unset.'
1883 <key=value>
1885 Metadata key and value pair to set or unset. For unset, specify
1886 only the key.
1887 cinder image-metadata-show
1889 usage: cinder image-metadata-show <volume>
1890 Shows volume image metadata.
1892 Positional arguments:
1894 <volume>
1896 ID of volume.
1897 cinder list
1899 usage: cinder list [--group_id <group_id>] [--all-tenants [<0|1>]]
1900 [--name <name>] [--status <status>]
1901 [--bootable [<True|true|False|false>]]
1902 [--migration_status <migration_status>]
1903 [--metadata [<key=value> ...]]
1904 [--image_metadata [<key=value> ...]] [--marker <marker>]
1905 [--limit <limit>] [--fields <fields>]
1906 [--sort <key>[:<direction>]] [--tenant [<tenant>]]
1907 [--filters [<key=value> ...]] [--with-count [<True|False>]]
1908 Lists all volumes.
1910 Optional arguments:
1912 --group_id <group_id>
1914 Filters results by a group_id. Default=None.This option is dep‐
1915 recated and will be removed in newer release. Please use '--fil‐
1916 ters' option which is introduced since 3.33 instead.
1917 --all-tenants <0|1>
1919 Shows details for all tenants. Admin only.
1920 --name <name>
1922 Filters results by a name. Default=None. This option is depre‐
1923 cated and will be removed in newer release. Please use '--fil‐
1924 ters' option which is introduced since 3.33 instead.
1925 --status <status>
1927 Filters results by a status. Default=None. This option is depre‐
1928 cated and will be removed in newer release. Please use '--fil‐
1929 ters' option which is introduced since 3.33 instead.
1930 --bootable <True|true|False|false>
1932 Filters results by bootable status. Default=None. This option is
1933 deprecated and will be removed in newer release. Please use
1934 '--filters' option which is introduced since 3.33 instead.
1935 --migration_status <migration_status>
1937 Filters results by a migration status. Default=None. Admin only.
1938 This option is deprecated and will be removed in newer release.
1939 Please use '--filters' option which is introduced since 3.33 in‐
1940 stead.
1941 --metadata <key=value>
1943 Filters results by a metadata key and value pair. Default=None.
1944 This option is deprecated and will be removed in newer release.
1945 Please use '--filters' option which is introduced since 3.33 in‐
1946 stead.
1947 --image_metadata <key=value>
1949 Filters results by a image metadata key and value pair. Require
1950 volume api version >=3.4. Default=None.This option is deprecated
1951 and will be removed in newer release. Please use '--filters' op‐
1952 tion which is introduced since 3.33 instead.
1953 --marker <marker>
1955 Begin returning volumes that appear later in the volume list
1956 than that represented by this volume id. Default=None.
1957 --limit <limit>
1959 Maximum number of volumes to return. Default=None.
1960 --fields <fields>
1962 Comma-separated list of fields to display. Use the show command
1963 to see which fields are available. Unavailable/non-existent
1964 fields will be ignored. Default=None.
1965 --sort <key>[:<direction>]
1967 Comma-separated list of sort keys and directions in the form of
1968 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
1969 ity_zone, name, bootable, created_at, reference. Default=None.
1970 --tenant <tenant>
1972 Display information from single tenant (Admin only).
1973 --filters <key=value>
1975 Filter key and value pairs. Please use 'cinder list-filters' to
1976 check enabled filters from server. Use 'key~=value' for inexact
1977 filtering if the key supports. Default=None.
1978 --with-count <True|False>
1980 Show total number of volume entities. This is useful when pagi‐
1981 nation is applied in the request.
1982 cinder list-filters
1984 usage: cinder list-filters [--resource <resource>]
1985 List enabled filters.
1987 Optional arguments:
1989 --resource <resource>
1991 Show enabled filters for specified resource. Default=None.
1992 cinder manage
1994 usage: cinder manage [--cluster CLUSTER] [--id-type <id-type>] [--name <name>]
1995 [--description <description>]
1996 [--volume-type <volume-type>]
1997 [--availability-zone <availability-zone>]
1998 [--metadata [<key=value> ...]] [--bootable]
1999 <host> <identifier>
2000 Manage an existing volume.
2002 Positional arguments:
2004 <host> Cinder host on which the existing volume resides; takes the
2006 form: host@backend-name#pool
2007 <identifier>
2009 Name or other Identifier for existing volume
2010 Optional arguments:
2012 --cluster None
2014 Cinder cluster on which the existing volume resides; takes the
2015 form: cluster@backend-name#pool
2016 --id-type <id-type>
2018 Type of backend device identifier provided, typically
2019 source-name or source-id (Default=source-name)
2020 --name <name>
2022 Volume name (Default=None)
2023 --description <description>
2025 Volume description (Default=None)
2026 --volume-type <volume-type>
2028 Volume type (Default=None)
2029 --availability-zone <availability-zone>
2031 Availability zone for volume (Default=None)
2032 --metadata <key=value>
2034 Metadata key=value pairs (Default=None)
2035 --bootable None
2037 Specifies that the newly created volume should be marked as
2038 bootable
2039 cinder manageable-list
2041 usage: cinder manageable-list [--detailed <detailed>] [--marker <marker>]
2042 [--limit <limit>] [--offset <offset>]
2043 [--sort <key>[:<direction>]] [--cluster CLUSTER]
2044 [<host>]
2045 Lists all manageable volumes.
2047 Positional arguments:
2049 <host> Cinder host on which to list manageable volumes; takes the form:
2051 host@backend-name#pool
2052 Optional arguments:
2054 --detailed <detailed>
2056 Returned detailed information (default true).
2057 --marker <marker>
2059 Begin returning volumes that appear later in the volume list
2060 than that represented by this reference. This reference should
2061 be json like. Default=None.
2062 --limit <limit>
2064 Maximum number of volumes to return. Default=None.
2065 --offset <offset>
2067 Number of volumes to skip after marker. Default=None.
2068 --sort <key>[:<direction>]
2070 Comma-separated list of sort keys and directions in the form of
2071 <key>[:<asc|desc>]. Valid keys: size, reference. Default=None.
2072 --cluster CLUSTER
2074 Cinder cluster on which to list manageable volumes; takes the
2075 form: cluster@backend-name#pool
2076 cinder message-delete
2078 usage: cinder message-delete <message> [<message> ...]
2079 Removes one or more messages.
2081 Positional arguments:
2083 <message>
2085 ID of one or more message to be deleted.
2086 cinder message-list
2088 usage: cinder message-list [--marker <marker>] [--limit <limit>]
2089 [--sort <key>[:<direction>]]
2090 [--resource_uuid <resource_uuid>]
2091 [--resource_type <type>] [--event_id <id>]
2092 [--request_id <request_id>] [--level <level>]
2093 [--filters [<key=value> ...]]
2094 Lists all messages.
2096 Optional arguments:
2098 --marker <marker>
2100 Begin returning message that appear later in the message list
2101 than that represented by this id. Default=None.
2102 --limit <limit>
2104 Maximum number of messages to return. Default=None.
2105 --sort <key>[:<direction>]
2107 Comma-separated list of sort keys and directions in the form of
2108 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
2109 ity_zone, name, bootable, created_at, reference. Default=None.
2110 --resource_uuid <resource_uuid>
2112 Filters results by a resource uuid. Default=None. This option is
2113 deprecated and will be removed in newer release. Please use
2114 '--filters' option which is introduced since 3.33 instead.
2115 --resource_type <type>
2117 Filters results by a resource type. Default=None. This option is
2118 deprecated and will be removed in newer release. Please use
2119 '--filters' option which is introduced since 3.33 instead.
2120 --event_id <id>
2122 Filters results by event id. Default=None. This option is depre‐
2123 cated and will be removed in newer release. Please use '--fil‐
2124 ters' option which is introduced since 3.33 instead.
2125 --request_id <request_id>
2127 Filters results by request id. Default=None. This option is dep‐
2128 recated and will be removed in newer release. Please use '--fil‐
2129 ters' option which is introduced since 3.33 instead.
2130 --level <level>
2132 Filters results by the message level. Default=None. This option
2133 is deprecated and will be removed in newer release. Please use
2134 '--filters' option which is introduced since 3.33 instead.
2135 --filters <key=value>
2137 Filter key and value pairs. Please use 'cinder list-filters' to
2138 check enabled filters from server. Use 'key~=value' for inexact
2139 filtering if the key supports. Default=None.
2140 cinder message-show
2142 usage: cinder message-show <message>
2143 Shows message details.
2145 Positional arguments:
2147 <message>
2149 ID of message.
2150 cinder metadata
2152 usage: cinder metadata <volume> <action> <key=value> [<key=value> ...]
2153 Sets or deletes volume metadata.
2155 Positional arguments:
2157 <volume>
2159 Name or ID of volume for which to update metadata.
2160 <action>
2162 The action. Valid values are "set" or "unset."
2163 <key=value>
2165 Metadata key and value pair to set or unset. For unset, specify
2166 only the key(s): <key key>
2167 cinder metadata-show
2169 usage: cinder metadata-show <volume>
2170 Shows volume metadata.
2172 Positional arguments:
2174 <volume>
2176 ID of volume.
2177 cinder metadata-update-all
2179 usage: cinder metadata-update-all <volume> <key=value> [<key=value> ...]
2180 Updates volume metadata.
2182 Positional arguments:
2184 <volume>
2186 ID of volume for which to update metadata.
2187 <key=value>
2189 Metadata key and value pair or pairs to update.
2190 cinder migrate
2192 usage: cinder migrate [--force-host-copy [<True|False>]]
2193 [--lock-volume [<True|False>]] [--cluster CLUSTER]
2194 <volume> [<host>]
2195 Migrates volume to a new host.
2197 Positional arguments:
2199 <volume>
2201 ID of volume to migrate.
2202 <host> Destination host. Takes the form: host@backend-name#pool
2204 Optional arguments:
2206 --force-host-copy <True|False>
2208 Enables or disables generic host-based force-migration, which
2209 bypasses driver optimizations. Default=False.
2210 --lock-volume <True|False>
2212 Enables or disables the termination of volume migration caused
2213 by other commands. This option applies to the available volume.
2214 True means it locks the volume state and does not allow the mi‐
2215 gration to be aborted. The volume status will be in maintenance
2216 during the migration. False means it allows the volume migration
2217 to be aborted. The volume status is still in the original sta‐
2218 tus. Default=False.
2219 --cluster None
2221 Destination cluster. Takes the form: cluster@backend-name#pool
2222 cinder qos-associate
2224 usage: cinder qos-associate <qos_specs> <volume_type_id>
2225 Associates qos specs with specified volume type.
2227 Positional arguments:
2229 <qos_specs>
2231 ID of QoS specifications.
2232 <volume_type_id>
2234 ID of volume type with which to associate QoS specifications.
2235 cinder qos-create
2237 usage: cinder qos-create <name> <key=value> [<key=value> ...]
2238 Creates a qos specs.
2240 Positional arguments:
2242 <name> Name of new QoS specifications.
2244 <key=value>
2246 QoS specifications.
2247 cinder qos-delete
2249 usage: cinder qos-delete [--force [<True|False>]] <qos_specs>
2250 Deletes a specified qos specs.
2252 Positional arguments:
2254 <qos_specs>
2256 ID of QoS specifications to delete.
2257 Optional arguments:
2259 --force <True|False>
2261 Enables or disables deletion of in-use QoS specifications. De‐
2262 fault=False.
2263 cinder qos-disassociate
2265 usage: cinder qos-disassociate <qos_specs> <volume_type_id>
2266 Disassociates qos specs from specified volume type.
2268 Positional arguments:
2270 <qos_specs>
2272 ID of QoS specifications.
2273 <volume_type_id>
2275 ID of volume type with which to associate QoS specifications.
2276 cinder qos-disassociate-all
2278 usage: cinder qos-disassociate-all <qos_specs>
2279 Disassociates qos specs from all its associations.
2281 Positional arguments:
2283 <qos_specs>
2285 ID of QoS specifications on which to operate.
2286 cinder qos-get-association
2288 usage: cinder qos-get-association <qos_specs>
2289 Lists all associations for specified qos specs.
2291 Positional arguments:
2293 <qos_specs>
2295 ID of QoS specifications.
2296 cinder qos-key
2298 usage: cinder qos-key <qos_specs> <action> key=value [key=value ...]
2299 Sets or unsets specifications for a qos spec.
2301 Positional arguments:
2303 <qos_specs>
2305 ID of QoS specifications.
2306 <action>
2308 The action. Valid values are "set" or "unset."
2309 key=value
2311 Metadata key and value pair to set or unset. For unset, specify
2312 only the key.
2313 cinder qos-list
2315 usage: cinder qos-list
2316 Lists qos specs.
2318 cinder qos-show
2320 usage: cinder qos-show <qos_specs>
2321 Shows qos specs details.
2323 Positional arguments:
2325 <qos_specs>
2327 ID of QoS specifications to show.
2328 cinder quota-class-show
2330 usage: cinder quota-class-show <class>
2331 Lists quotas for a quota class.
2333 Positional arguments:
2335 <class>
2337 Name of quota class for which to list quotas.
2338 cinder quota-class-update
2340 usage: cinder quota-class-update [--volumes <volumes>]
2341 [--snapshots <snapshots>]
2342 [--gigabytes <gigabytes>]
2343 [--backups <backups>]
2344 [--backup-gigabytes <backup_gigabytes>]
2345 [--volume-type <volume_type_name>]
2346 [--per-volume-gigabytes <per_volume_gigabytes>]
2347 <class_name>
2348 Updates quotas for a quota class.
2350 Positional arguments:
2352 <class_name>
2354 Name of quota class for which to set quotas.
2355 Optional arguments:
2357 --volumes <volumes>
2359 The new "volumes" quota value. Default=None.
2360 --snapshots <snapshots>
2362 The new "snapshots" quota value. Default=None.
2363 --gigabytes <gigabytes>
2365 The new "gigabytes" quota value. Default=None.
2366 --backups <backups>
2368 The new "backups" quota value. Default=None.
2369 --backup-gigabytes <backup_gigabytes>
2371 The new "backup_gigabytes" quota value. Default=None.
2372 --volume-type <volume_type_name>
2374 Volume type. Default=None.
2375 --per-volume-gigabytes <per_volume_gigabytes>
2377 Set max volume size limit. Default=None.
2378 cinder quota-defaults
2380 usage: cinder quota-defaults <tenant_id>
2381 Lists default quotas for a tenant.
2383 Positional arguments:
2385 <tenant_id>
2387 ID of tenant for which to list quota defaults.
2388 cinder quota-delete
2390 usage: cinder quota-delete <tenant_id>
2391 Delete the quotas for a tenant.
2393 Positional arguments:
2395 <tenant_id>
2397 UUID of tenant to delete the quotas for.
2398 cinder quota-show
2400 usage: cinder quota-show <tenant_id>
2401 Lists quotas for a tenant.
2403 Positional arguments:
2405 <tenant_id>
2407 ID of tenant for which to list quotas.
2408 cinder quota-update
2410 usage: cinder quota-update [--volumes <volumes>] [--snapshots <snapshots>]
2411 [--gigabytes <gigabytes>] [--backups <backups>]
2412 [--backup-gigabytes <backup_gigabytes>]
2413 [--groups <groups>]
2414 [--volume-type <volume_type_name>]
2415 [--per-volume-gigabytes <per_volume_gigabytes>]
2416 [--skip-validation <skip_validation>]
2417 <tenant_id>
2418 Updates quotas for a tenant.
2420 Positional arguments:
2422 <tenant_id>
2424 ID of tenant for which to set quotas.
2425 Optional arguments:
2427 --volumes <volumes>
2429 The new "volumes" quota value. Default=None.
2430 --snapshots <snapshots>
2432 The new "snapshots" quota value. Default=None.
2433 --gigabytes <gigabytes>
2435 The new "gigabytes" quota value. Default=None.
2436 --backups <backups>
2438 The new "backups" quota value. Default=None.
2439 --backup-gigabytes <backup_gigabytes>
2441 The new "backup_gigabytes" quota value. Default=None.
2442 --groups <groups>
2444 The new "groups" quota value. Default=None.
2445 --volume-type <volume_type_name>
2447 Volume type. Default=None.
2448 --per-volume-gigabytes <per_volume_gigabytes>
2450 Set max volume size limit. Default=None.
2451 --skip-validation <skip_validation>
2453 Skip validate the existing resource quota. Default=False.
2454 cinder quota-usage
2456 usage: cinder quota-usage <tenant_id>
2457 Lists quota usage for a tenant.
2459 Positional arguments:
2461 <tenant_id>
2463 ID of tenant for which to list quota usage.
2464 cinder rate-limits
2466 usage: cinder rate-limits [<tenant_id>]
2467 Lists rate limits for a user.
2469 Positional arguments:
2471 <tenant_id>
2473 Display information for a single tenant (Admin only).
2474 cinder readonly-mode-update
2476 usage: cinder readonly-mode-update <volume> <True|true|False|false>
2477 Updates volume read-only access-mode flag.
2479 Positional arguments:
2481 <volume>
2483 ID of volume to update.
2484 <True|true|False|false>
2486 Enables or disables update of volume to read-only access mode.
2487 cinder reimage
2489 usage: cinder reimage [--reimage-reserved <True|False>] <volume> <image-id>
2490 Rebuilds a volume, overwriting all content with the specified image
2492 Positional arguments:
2494 <volume>
2496 Name or ID of volume to reimage
2497 <image-id>
2499 The image id of the image that will be used to reimage the vol‐
2500 ume.
2501 Optional arguments:
2503 --reimage-reserved <True|False>
2505 Enables or disables reimage for a volume that is in reserved
2506 state otherwise only volumes in "available" or "error" status
2507 may be re-imaged. Default=False.
2508 cinder rename
2510 usage: cinder rename [--description <description>] <volume> [<name>]
2511 Renames a volume.
2513 Positional arguments:
2515 <volume>
2517 Name or ID of volume to rename.
2518 <name> New name for volume.
2520 Optional arguments:
2522 --description <description>
2524 Volume description. Default=None.
2525 cinder reset-state
2527 usage: cinder reset-state [--type <type>] [--state <state>]
2528 [--attach-status <attach-status>]
2529 [--reset-migration-status]
2530 <entity> [<entity> ...]
2531 Explicitly updates the entity state in the Cinder database.
2533 Positional arguments:
2535 <entity>
2537 Name or ID of entity to update.
2538 Optional arguments:
2540 --type <type>
2542 Type of entity to update. Available resources are: 'volume',
2543 'snapshot', 'backup', 'group' (since 3.20) and 'group-snapshot'
2544 (since 3.19), Default=volume.
2545 --state <state>
2547 The state to assign to the entity. NOTE: This command simply
2548 changes the state of the entity in the database with no regard
2549 to actual status, exercise caution when using. Default=None,
2550 that means the state is unchanged.
2551 --attach-status <attach-status>
2553 This is only used for a volume entity. The attach status to as‐
2554 sign to the volume in the database, with no regard to the actual
2555 status. Valid values are "attached" and "detached". De‐
2556 fault=None, that means the status is unchanged.
2557 --reset-migration-status None
2559 This is only used for a volume entity. Clears the migration sta‐
2560 tus of the volume in the DataBase that indicates the volume is
2561 source or destination of volume migration, with no regard to the
2562 actual status.
2563 cinder retype
2565 usage: cinder retype [--migration-policy <never|on-demand>]
2566 <volume> <volume-type>
2567 Changes the volume type for a volume.
2569 Positional arguments:
2571 <volume>
2573 Name or ID of volume for which to modify type.
2574 <volume-type>
2576 New volume type.
2577 Optional arguments:
2579 --migration-policy <never|on-demand>
2581 Migration policy during retype of volume.
2582 cinder revert-to-snapshot
2584 usage: cinder revert-to-snapshot <snapshot>
2585 Revert a volume to the specified snapshot.
2587 Positional arguments:
2589 <snapshot>
2591 Name or ID of the snapshot to restore. The snapshot must be the
2592 most recent one known to cinder.
2593 cinder service-disable
2595 usage: cinder service-disable [--reason <reason>] <hostname> <binary>
2596 Disables the service.
2598 Positional arguments:
2600 <hostname>
2602 Host name.
2603 <binary>
2605 Service binary.
2606 Optional arguments:
2608 --reason <reason>
2610 Reason for disabling service.
2611 cinder service-enable
2613 usage: cinder service-enable <hostname> <binary>
2614 Enables the service.
2616 Positional arguments:
2618 <hostname>
2620 Host name.
2621 <binary>
2623 Service binary.
2624 cinder service-get-log
2626 usage: cinder service-get-log
2627 [--binary {,*,cinder-api,cinder-volume,cinder-scheduler,cinder-backup}]
2628 [--server SERVER] [--prefix PREFIX]
2629 Gets the service log level.
2631 Optional arguments:
2633 --binary None
2635 Binary to query.
2636 --server None
2638 Host or cluster value for service.
2639 --prefix None
2641 Prefix for the log. ie: "sqlalchemy.".
2642 cinder service-list
2644 usage: cinder service-list [--host <hostname>] [--binary <binary>]
2645 [--withreplication [<True|False>]]
2646 Lists all services. Filter by host and service binary.
2648 Optional arguments:
2650 --host <hostname>
2652 Host name. Default=None.
2653 --binary <binary>
2655 Service binary. Default=None.
2656 --withreplication <True|False>
2658 Enables or disables display of Replication info for c-vol ser‐
2659 vices. Default=False.
2660 cinder service-set-log
2662 usage: cinder service-set-log
2663 [--binary {,*,cinder-api,cinder-volume,cinder-scheduler,cinder-backup}]
2664 [--server SERVER] [--prefix PREFIX]
2665 <log-level>
2666 Sets the service log level.
2668 Positional arguments:
2670 <log-level>
2672 Desired log level.
2673 Optional arguments:
2675 --binary None
2677 Binary to change.
2678 --server None
2680 Host or cluster value for service.
2681 --prefix None
2683 Prefix for the log. ie: "cinder.volume.drivers.".
2684 cinder set-bootable
2686 usage: cinder set-bootable <volume> <True|true|False|false>
2687 Update bootable status of a volume.
2689 Positional arguments:
2691 <volume>
2693 ID of the volume to update.
2694 <True|true|False|false>
2696 Flag to indicate whether volume is bootable.
2697 cinder show
2699 usage: cinder show <volume>
2700 Shows volume details.
2702 Positional arguments:
2704 <volume>
2706 Name or ID of volume.
2707 cinder snapshot-create
2709 usage: cinder snapshot-create [--name <name>] [--description <description>]
2710 [--metadata [<key=value> ...]]
2711 <volume>
2712 Creates a snapshot.
2714 Positional arguments:
2716 <volume>
2718 Name or ID of volume to snapshot.
2719 Optional arguments:
2721 --name <name>
2723 Snapshot name. Default=None.
2724 --description <description>
2726 Snapshot description. Default=None.
2727 --metadata <key=value>
2729 Snapshot metadata key and value pairs. Default=None.
2730 cinder snapshot-delete
2732 usage: cinder snapshot-delete [--force] <snapshot> [<snapshot> ...]
2733 Removes one or more snapshots.
2735 Positional arguments:
2737 <snapshot>
2739 Name or ID of the snapshot(s) to delete.
2740 Optional arguments:
2742 --force None
2744 Allows deleting snapshot of a volume when its status is other
2745 than "available" or "error". Default=False.
2746 cinder snapshot-list
2748 usage: cinder snapshot-list [--all-tenants [<0|1>]] [--name <name>]
2749 [--status <status>] [--volume-id <volume-id>]
2750 [--marker <marker>] [--limit <limit>]
2751 [--sort <key>[:<direction>]] [--tenant [<tenant>]]
2752 [--metadata [<key=value> ...]]
2753 [--filters [<key=value> ...]]
2754 [--with-count [<True|False>]]
2755 Lists all snapshots.
2757 Optional arguments:
2759 --all-tenants <0|1>
2761 Shows details for all tenants. Admin only.
2762 --name <name>
2764 Filters results by a name. Default=None. This option is depre‐
2765 cated and will be removed in newer release. Please use '--fil‐
2766 ters' option which is introduced since 3.33 instead.
2767 --status <status>
2769 Filters results by a status. Default=None. This option is depre‐
2770 cated and will be removed in newer release. Please use '--fil‐
2771 ters' option which is introduced since 3.33 instead.
2772 --volume-id <volume-id>
2774 Filters results by a volume ID. Default=None. This option is
2775 deprecated and will be removed in newer release. Please use
2776 '--filters' option which is introduced since 3.33 instead.
2777 --marker <marker>
2779 Begin returning snapshots that appear later in the snapshot list
2780 than that represented by this id. Default=None.
2781 --limit <limit>
2783 Maximum number of snapshots to return. Default=None.
2784 --sort <key>[:<direction>]
2786 Comma-separated list of sort keys and directions in the form of
2787 <key>[:<asc|desc>]. Valid keys: id, status, size, availabil‐
2788 ity_zone, name, bootable, created_at, reference. Default=None.
2789 --tenant <tenant>
2791 Display information from single tenant (Admin only).
2792 --metadata <key=value>
2794 Filters results by a metadata key and value pair. Require volume
2795 api version >=3.22. Default=None. This option is deprecated and
2796 will be removed in newer release. Please use '--filters' option
2797 which is introduced since 3.33 instead.
2798 --filters <key=value>
2800 Filter key and value pairs. Please use 'cinder list-filters' to
2801 check enabled filters from server. Use 'key~=value' for inexact
2802 filtering if the key supports. Default=None.
2803 --with-count <True|False>
2805 Show total number of snapshot entities. This is useful when pag‐
2806 ination is applied in the request.
2807 cinder snapshot-manage
2809 usage: cinder snapshot-manage [--id-type <id-type>] [--name <name>]
2810 [--description <description>]
2811 [--metadata [<key=value> ...]]
2812 <volume> <identifier>
2813 Manage an existing snapshot.
2815 Positional arguments:
2817 <volume>
2819 Cinder volume that already exists in the volume backend.
2820 <identifier>
2822 Name or other identifier for existing snapshot. This is backend
2823 specific.
2824 Optional arguments:
2826 --id-type <id-type>
2828 Type of backend device identifier provided, typically
2829 source-name or source-id (Default=source-name).
2830 --name <name>
2832 Snapshot name (Default=None).
2833 --description <description>
2835 Snapshot description (Default=None).
2836 --metadata <key=value>
2838 Metadata key=value pairs (Default=None).
2839 cinder snapshot-manageable-list
2841 usage: cinder snapshot-manageable-list [--detailed <detailed>]
2842 [--marker <marker>] [--limit <limit>]
2843 [--offset <offset>]
2844 [--sort <key>[:<direction>]]
2845 [--cluster CLUSTER]
2846 [<host>]
2847 Lists all manageable snapshots.
2849 Positional arguments:
2851 <host> Cinder host on which to list manageable snapshots; takes the
2853 form: host@backend-name#pool
2854 Optional arguments:
2856 --detailed <detailed>
2858 Returned detailed information (default true).
2859 --marker <marker>
2861 Begin returning volumes that appear later in the volume list
2862 than that represented by this reference. This reference should
2863 be json like. Default=None.
2864 --limit <limit>
2866 Maximum number of volumes to return. Default=None.
2867 --offset <offset>
2869 Number of volumes to skip after marker. Default=None.
2870 --sort <key>[:<direction>]
2872 Comma-separated list of sort keys and directions in the form of
2873 <key>[:<asc|desc>]. Valid keys: size, reference. Default=None.
2874 --cluster None
2876 Cinder cluster on which to list manageable snapshots; takes the
2877 form: cluster@backend-name#pool
2878 cinder snapshot-metadata
2880 usage: cinder snapshot-metadata <snapshot> <action> <key=value>
2881 [<key=value> ...]
2882 Sets or deletes snapshot metadata.
2884 Positional arguments:
2886 <snapshot>
2888 ID of snapshot for which to update metadata.
2889 <action>
2891 The action. Valid values are "set" or "unset."
2892 <key=value>
2894 Metadata key and value pair to set or unset. For unset, specify
2895 only the key.
2896 cinder snapshot-metadata-show
2898 usage: cinder snapshot-metadata-show <snapshot>
2899 Shows snapshot metadata.
2901 Positional arguments:
2903 <snapshot>
2905 ID of snapshot.
2906 cinder snapshot-metadata-update-all
2908 usage: cinder snapshot-metadata-update-all <snapshot> <key=value>
2909 [<key=value> ...]
2910 Updates snapshot metadata.
2912 Positional arguments:
2914 <snapshot>
2916 ID of snapshot for which to update metadata.
2917 <key=value>
2919 Metadata key and value pair to update.
2920 cinder snapshot-rename
2922 usage: cinder snapshot-rename [--description <description>]
2923 <snapshot> [<name>]
2924 Renames a snapshot.
2926 Positional arguments:
2928 <snapshot>
2930 Name or ID of snapshot.
2931 <name> New name for snapshot.
2933 Optional arguments:
2935 --description <description>
2937 Snapshot description. Default=None.
2938 cinder snapshot-reset-state
2940 usage: cinder snapshot-reset-state [--state <state>]
2941 <snapshot> [<snapshot> ...]
2942 Explicitly updates the snapshot state.
2944 Positional arguments:
2946 <snapshot>
2948 Name or ID of snapshot to modify.
2949 Optional arguments:
2951 --state <state>
2953 The state to assign to the snapshot. Valid values are "avail‐
2954 able", "error", "creating", "deleting", and "error_deleting".
2955 NOTE: This command simply changes the state of the Snapshot in
2956 the DataBase with no regard to actual status, exercise caution
2957 when using. Default=available.
2958 cinder snapshot-show
2960 usage: cinder snapshot-show <snapshot>
2961 Shows snapshot details.
2963 Positional arguments:
2965 <snapshot>
2967 Name or ID of snapshot.
2968 cinder snapshot-unmanage
2970 usage: cinder snapshot-unmanage <snapshot>
2971 Stop managing a snapshot.
2973 Positional arguments:
2975 <snapshot>
2977 Name or ID of the snapshot to unmanage.
2978 cinder summary
2980 usage: cinder summary [--all-tenants [<0|1>]]
2981 Get volumes summary.
2983 Optional arguments:
2985 --all-tenants <0|1>
2987 Shows details for all tenants. Admin only.
2988 cinder thaw-host
2990 usage: cinder thaw-host <hostname>
2991 Thaw and enable the specified cinder-volume host.
2993 Positional arguments:
2995 <hostname>
2997 Host name.
2998 cinder transfer-accept
3000 usage: cinder transfer-accept <transfer> <auth_key>
3001 Accepts a volume transfer.
3003 Positional arguments:
3005 <transfer>
3007 ID of transfer to accept.
3008 <auth_key>
3010 Authentication key of transfer to accept.
3011 cinder transfer-create
3013 usage: cinder transfer-create [--name <name>] [--no-snapshots] <volume>
3014 Creates a volume transfer.
3016 Positional arguments:
3018 <volume>
3020 Name or ID of volume to transfer.
3021 Optional arguments:
3023 --name <name>
3025 Transfer name. Default=None.
3026 --no-snapshots None
3028 Allows or disallows transfer volumes without snapshots. De‐
3029 fault=False.
3030 cinder transfer-delete
3032 usage: cinder transfer-delete <transfer>
3033 Undoes a transfer.
3035 Positional arguments:
3037 <transfer>
3039 Name or ID of transfer to delete.
3040 cinder transfer-list
3042 usage: cinder transfer-list [--all-tenants [<0|1>]]
3043 [--sort <key>[:<direction>]]
3044 [--filters [<key=value> ...]]
3045 Lists all transfers.
3047 Optional arguments:
3049 --all-tenants <0|1>
3051 Shows details for all tenants. Admin only.
3052 --sort <key>[:<direction>]
3054 Sort keys and directions in the form of <key>[:<asc|desc>].
3055 --filters <key=value>
3057 Filter key and value pairs.
3058 cinder transfer-show
3060 usage: cinder transfer-show <transfer>
3061 Shows transfer details.
3063 Positional arguments:
3065 <transfer>
3067 Name or ID of transfer to accept.
3068 cinder type-access-add
3070 usage: cinder type-access-add --volume-type <volume_type> --project-id
3071 <project_id>
3072 Adds volume type access for the given project.
3074 Optional arguments:
3076 --volume-type <volume_type>
3078 Volume type name or ID to add access for the given project.
3079 --project-id <project_id>
3081 Project ID to add volume type access for.
3082 cinder type-access-list
3084 usage: cinder type-access-list --volume-type <volume_type>
3085 Print access information about the given volume type.
3087 Optional arguments:
3089 --volume-type <volume_type>
3091 Filter results by volume type name or ID.
3092 cinder type-access-remove
3094 usage: cinder type-access-remove --volume-type <volume_type> --project-id
3095 <project_id>
3096 Removes volume type access for the given project.
3098 Optional arguments:
3100 --volume-type <volume_type>
3102 Volume type name or ID to remove access for the given project.
3103 --project-id <project_id>
3105 Project ID to remove volume type access for.
3106 cinder type-create
3108 usage: cinder type-create [--description <description>]
3109 [--is-public <is-public>]
3110 <name>
3111 Creates a volume type.
3113 Positional arguments:
3115 <name> Name of new volume type.
3117 Optional arguments:
3119 --description <description>
3121 Description of new volume type.
3122 --is-public <is-public>
3124 Make type accessible to the public (default true).
3125 cinder type-default
3127 usage: cinder type-default
3128 List the default volume type.
3130 cinder type-delete
3132 usage: cinder type-delete <vol_type> [<vol_type> ...]
3133 Deletes volume type or types.
3135 Positional arguments:
3137 <vol_type>
3139 Name or ID of volume type or types to delete.
3140 cinder type-key
3142 usage: cinder type-key <vtype> <action> <key=value> [<key=value> ...]
3143 Sets or unsets extra_spec for a volume type.
3145 Positional arguments:
3147 <vtype>
3149 Name or ID of volume type.
3150 <action>
3152 The action. Valid values are "set" or "unset."
3153 <key=value>
3155 The extra specs key and value pair to set or unset. For unset,
3156 specify only the key.
3157 cinder type-list
3159 usage: cinder type-list [--filters [<key=value> ...]]
3160 Lists available 'volume types'.
3162 Optional arguments:
3164 --filters <key=value>
3166 Filter key and value pairs. Admin only.
3167 cinder type-show
3169 usage: cinder type-show <volume_type>
3170 Show volume type details.
3172 Positional arguments:
3174 <volume_type>
3176 Name or ID of the volume type.
3177 cinder type-update
3179 usage: cinder type-update [--name <name>] [--description <description>]
3180 [--is-public <is-public>]
3181 <id>
3182 Updates volume type name, description, and/or is_public.
3184 Positional arguments:
3186 <id> ID of the volume type.
3188 Optional arguments:
3190 --name <name>
3192 Name of the volume type.
3193 --description <description>
3195 Description of the volume type.
3196 --is-public <is-public>
3198 Make type accessible to the public or not.
3199 cinder unmanage
3201 usage: cinder unmanage <volume>
3202 Stop managing a volume.
3204 Positional arguments:
3206 <volume>
3208 Name or ID of the volume to unmanage.
3209 cinder upload-to-image
3211 usage: cinder upload-to-image [--force [<True|False>]]
3212 [--container-format <container-format>]
3213 [--disk-format <disk-format>]
3214 [--visibility <public|private|community|shared>]
3215 [--protected <True|False>]
3216 <volume> <image-name>
3217 Uploads volume to Image Service as an image.
3219 Positional arguments:
3221 <volume>
3223 Name or ID of volume to snapshot.
3224 <image-name>
3226 The new image name.
3227 Optional arguments:
3229 --force <True|False>
3231 Enables or disables upload of a volume that is attached to an
3232 instance. Default=False. This option may not be supported by
3233 your cloud.
3234 --container-format <container-format>
3236 Container format type. Default is bare.
3237 --disk-format <disk-format>
3239 Disk format type. Default is raw.
3240 --visibility <public|private|community|shared>
3242 Set image visibility to public, private, community or shared.
3243 Default=private.
3244 --protected <True|False>
3246 Prevents image from being deleted. Default=False.
3247 cinder version-list
3249 usage: cinder version-list
3250 List all API versions.
3252 cinder work-cleanup
3254 usage: cinder work-cleanup [--cluster <cluster-name>] [--host <hostname>]
3255 [--binary <binary>]
3256 [--is-up <True|true|False|false>]
3257 [--disabled <True|true|False|false>]
3258 [--resource-id <resource-id>]
3259 [--resource-type <Volume|Snapshot>]
3260 [--service-id <service-id>]
3261 Request cleanup of services with optional filtering.
3263 Optional arguments:
3265 --cluster <cluster-name>
3267 Cluster name. Default=None.
3268 --host <hostname>
3270 Service host name. Default=None.
3271 --binary <binary>
3273 Service binary. Default=None.
3274 --is-up <True|true|False|false>
3276 Filter by up/down status, if set to true services need to be up,
3277 if set to false services need to be down. Default is None,
3278 which means up/down status is ignored.
3279 --disabled <True|true|False|false>
3281 Filter by disabled status. Default=None.
3282 --resource-id <resource-id>
3284 UUID of a resource to cleanup. Default=None.
3285 --resource-type <Volume|Snapshot>
3287 Type of resource to cleanup.
3288 --service-id <service-id>
3290 The service id field from the DB, not the uuid of the service.
3291 Default=None.
3292 cinder help
3294 usage: cinder help [<subcommand>]
3295 Shows help about this program or one of its subcommands.
3297 Positional arguments:
3299 <subcommand>
3301 Shows help for <subcommand>.
3302
3304 OpenStack Contributors
3305
3307 OpenStack Contributors
33089.3.0 Jul 21, 2023 CINDER(1)