CINDER(1)

📦

version 9.9.0 · 8 versions

🦋 cinder(1) — python-cinderclient 🦋

💖 NAME 💖

cinder — Client for OpenStack Block Storage API.

Okay so the cinder client is literally the command-line interface (CLI) for the Block Storage service (cinder) API and its extensions. That’s the whole vibe, bestie.

Need help on one specific cinder command? Enter:

$ cinder help COMMAND

🫶 CINDER USAGE 🫶

Here’s the whole shape of it, no cap:

usage: cinder [--version] [-d] [--service-type <service-type>]
              [--service-name <service-name>]
              [--volume-service-name <volume-service-name>]
              [--os-endpoint-type <os-endpoint-type>]
              [--os-volume-api-version <volume-api-ver>]
              [--os-endpoint <os-endpoint>] [--retries <retries>] [--insecure]
              [--os-cacert <ca-certificate>] [--os-cert <certificate>]
              [--os-key <key>] [--timeout <seconds>] [--collect-timing]
              [--os-auth-type <name>] [--os-auth-url OS_AUTH_URL]
              [--os-system-scope OS_SYSTEM_SCOPE]
              [--os-domain-id OS_DOMAIN_ID] [--os-domain-name OS_DOMAIN_NAME]
              [--os-project-id OS_PROJECT_ID]
              [--os-project-name OS_PROJECT_NAME]
              [--os-project-domain-id OS_PROJECT_DOMAIN_ID]
              [--os-project-domain-name OS_PROJECT_DOMAIN_NAME]
              [--os-trust-id OS_TRUST_ID]
              [--os-default-domain-id OS_DEFAULT_DOMAIN_ID]
              [--os-default-domain-name OS_DEFAULT_DOMAIN_NAME]
              [--os-user-id OS_USER_ID] [--os-username OS_USERNAME]
              [--os-user-domain-id OS_USER_DOMAIN_ID]
              [--os-user-domain-name OS_USER_DOMAIN_NAME]
              [--os-password OS_PASSWORD] [--os-auth-strategy <auth-strategy>]
              [--os-url <url>]
                <subcommand> ...

✨ Optional Arguments ✨

--collect-timing — collects per-API call timing information. cute little timing receipts ✨
--insecure — explicitly allows the client to perform “insecure” TLS (https) requests. The server’s certificate will not be verified against any certificate authorities. This option should be used with caution.

⚠️ yes, “insecure” is doing exactly what it says on the tin. Be careful, bestie.

--os-auth-strategy — authentication strategy (Env: OS_AUTH_STRATEGY, default keystone). For now, any other value will disable the authentication.
--os-auth-type, --os-auth-plugin — authentication type to use.
--os-auth-url — authentication URL.
--os-cacert — specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to env[OS_CACERT].
--os-cert — the location for the keystore (PEM formatted) containing the public key of this client. Defaults to env[OS_CERT].
--os-default-domain-id — optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.
--os-default-domain-name — optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.
--os-domain-id — domain ID to scope to.
--os-domain-name — domain name to scope to.
--os-endpoint — use this API endpoint instead of the Service Catalog. Defaults to env[CINDER_ENDPOINT].
--os-endpoint-type — endpoint type, which is publicURL or internalURL. Default=env[OS_ENDPOINT_TYPE] or nova env[CINDER_ENDPOINT_TYPE] or publicURL.
--os-key — the location for the keystore (PEM formatted) containing the private key of this client. Defaults to env[OS_KEY].
--os-password — user’s password.
--os-project-domain-id — domain ID containing project.
--os-project-domain-name — domain name containing project.
--os-project-id, --os-tenant-id — project ID to scope to.
--os-project-name, --os-tenant-name — project name to scope to.
--os-system-scope — scope for system operations.
--os-trust-id — ID of the trust to use as a trustee use.
--os-url — defaults to env[OS_URL].
--os-user-domain-id — user’s domain id.
--os-user-domain-name — user’s domain name.
--os-user-id — user id.
--os-username, --os-user-name — username.
--os-volume-api-version — Block Storage API version. Accepts X, X.Y (where X is major and Y is minor part). NOTE: this client accepts only '3' for the major version. Default=env[OS_VOLUME_API_VERSION].
--retries — number of retries.
--service-name — service name. Default=env[CINDER_SERVICE_NAME].
--service-type — service type. For most actions, default is volume.
--timeout — set request timeout (in seconds).
--version — show program’s version number and exit.
--volume-service-name — volume service name. Default=env[CINDER_VOLUME_SERVICE_NAME].
-d, --debug — shows debugging output.

🎀 Commands 🎀

so many commands, bestie — here’s the full menu, no skips:

absolute-limits — lists absolute limits for a user.
api-version — displays the server API version information.
attachment-complete — completes an attachment for a cinder volume.
attachment-create — creates an attachment for a cinder volume.
attachment-delete — deletes an attachment for a cinder volume.
attachment-list — lists all attachments.
attachment-show — shows detailed information for an attachment.
attachment-update — updates an attachment for a cinder volume.
availability-zone-list — lists all availability zones.
backup-create — creates a volume backup.
backup-delete — removes one or more backups.
backup-export — exports a backup metadata record.
backup-import — imports a backup metadata record.
backup-list — lists all backups.
backup-reset-state — explicitly updates the backup state.
backup-restore — restores a backup.
backup-show — shows backup details.
backup-update — updates a backup.
cgsnapshot-create — creates a cgsnapshot.
cgsnapshot-delete — removes one or more cgsnapshots.
cgsnapshot-list — lists all cgsnapshots.
cgsnapshot-show — shows cgsnapshot details.
cluster-disable — disables clustered services.
cluster-enable — enables clustered services.
cluster-list — lists clustered services with optional filtering.
cluster-show — shows detailed information on a clustered service.
consisgroup-create — creates a consistency group.
consisgroup-create-from-src — creates a consistency group from a cgsnapshot or a source CG.
consisgroup-delete — removes one or more consistency groups.
consisgroup-list — lists all consistency groups.
consisgroup-show — shows details of a consistency group.
consisgroup-update — updates a consistency group.
create — creates a volume.
default-type-list — lists all default volume types.
default-type-set — sets a default volume type for a project.
default-type-unset — unsets default volume types.
delete — removes one or more volumes.
encryption-type-create — creates encryption type for a volume type. Admin only.
encryption-type-delete — deletes encryption type for a volume type. Admin only.
encryption-type-list — shows encryption type details for volume types. Admin only.
encryption-type-show — shows encryption type details for a volume type. Admin only.
encryption-type-update — updates encryption type information for a volume type (Admin Only).
extend — attempts to extend size of an existing volume.
extra-specs-list — lists current volume types and extra specs.
failover-host — failover a replicating cinder-volume host.
force-delete — attempts force-delete of volume, regardless of state.
freeze-host — freeze and disable the specified cinder-volume host.
get-capabilities — show backend volume stats and properties. Admin only.
get-pools — show pool information for backends. Admin only.
group-create — creates a group.
group-create-from-src — creates a group from a group snapshot or a source group.
group-delete — removes one or more groups.
group-disable-replication — disables replication for group.
group-enable-replication — enables replication for group.
group-failover-replication — fails over replication for group.
group-list — lists all groups.
group-list-replication-targets — lists replication targets for group.
group-show — shows details of a group.
group-snapshot-create — creates a group snapshot.
group-snapshot-delete — removes one or more group snapshots.
group-snapshot-list — lists all group snapshots.
group-snapshot-show — shows group snapshot details.
group-specs-list — lists current group types and specs.
group-type-create — creates a group type.
group-type-default — list the default group type.
group-type-delete — deletes group type or types.
group-type-key — sets or unsets group_spec for a group type.
group-type-list — lists available ‘group types’. (Admin only will see private types)
group-type-show — show group type details.
group-type-update — updates group type name, description, and/or is_public.
group-update — updates a group.
image-metadata — sets or deletes volume image metadata.
image-metadata-show — shows volume image metadata.
list — lists all volumes.
list-filters — list enabled filters.
manage — manage an existing volume.
manageable-list — lists all manageable volumes.
message-delete — removes one or more messages.
message-list — lists all messages.
message-show — shows message details.
metadata — sets or deletes volume metadata.
metadata-show — shows volume metadata.
metadata-update-all — updates volume metadata.
migrate — migrates volume to a new host.
qos-associate — associates qos specs with specified volume type.
qos-create — creates a qos specs.
qos-delete — deletes a specified qos specs.
qos-disassociate — unlinks qos specs from the volume type you name 🫶
qos-disassociate-all — unlinks qos specs from, like, all their associations, no survivors
qos-get-association — lists every association for the qos specs you point at
qos-key — sets or unsets specifications for a qos spec
qos-list — lists qos specs
qos-show — shows qos specs details
quota-class-show — lists quotas for a quota class
quota-class-update — updates quotas for a quota class
quota-defaults — lists default quotas for a tenant
quota-delete — deletes the quotas for a tenant (gone, deleted, bye 💀)
quota-show — lists quotas for a tenant
quota-update — updates quotas for a tenant
quota-usage — lists quota usage for a tenant
rate-limits — lists rate limits for a user
readonly-mode-update — updates the volume read-only access-mode flag
reimage — rebuilds a volume, overwriting all content with the specified image 😭
rename — renames a volume
reset-state — explicitly updates the entity state in the Cinder database
retype — changes the volume type for a volume
revert-to-snapshot — reverts a volume to the snapshot you specify
service-disable — disables the service
service-enable — enables the service
service-get-log — gets the service log level
service-list — lists all services. Filter by host and service binary.
service-set-log — sets the service log level
set-bootable — updates the bootable status of a volume
show — shows volume details
snapshot-create — creates a snapshot
snapshot-delete — removes one or more snapshots
snapshot-list — lists all snapshots
snapshot-manage — manages an existing snapshot
snapshot-manageable-list — lists all manageable snapshots
snapshot-metadata — sets or deletes snapshot metadata
snapshot-metadata-show — shows snapshot metadata
snapshot-metadata-update-all — updates snapshot metadata
snapshot-rename — renames a snapshot
snapshot-reset-state — explicitly updates the snapshot state
snapshot-show — shows snapshot details
snapshot-unmanage — stops managing a snapshot
summary — gets the volumes summary
thaw-host — thaws and enables the cinder-volume host you specify 🧊➡️🔥
transfer-accept — accepts a volume transfer
transfer-create — creates a volume transfer
transfer-delete — undoes a transfer
transfer-list — lists all transfers
transfer-show — shows transfer details
type-access-add — adds volume type access for the given project
type-access-list — prints access information about the given volume type
type-access-remove — removes volume type access for the given project
type-create — creates a volume type
type-default — lists the default volume type
type-delete — deletes a volume type or types
type-key — sets or unsets extra_spec for a volume type
type-list — lists available 'volume types'
type-show — shows volume type details
type-update — updates volume type name, description, and/or is_public
unmanage — stops managing a volume
upload-to-image — uploads a volume to the Image Service as an image
version-list — lists all API versions
work-cleanup — requests cleanup of services, with optional filtering
help — shows help about this program or one of its subcommands 🫶

💖 COMMAND DETAILS 💖

okay this is the part where each command gets its own lil spotlight. buckle up bestie, there's a lot ✨

🎀 cinder absolute-limits

cinder absolute-limits [<tenant_id>]

Lists absolute limits for a user. That's the whole vibe.

Positional arguments:

<tenant_id> — display information for a single tenant. Admin only 🔒

🦋 cinder api-version

cinder api-version

Displays the server API version information. Short, sweet, iconic.

🌸 cinder attachment-complete

cinder attachment-complete <attachment> [<attachment> ...]

Completes an attachment for a cinder volume 💅

Positional arguments:

<attachment> — ID of attachment or attachments to delete.

ngl bestie, that description says "delete" but the command is complete — that's what the page literally says, so I'm handing it to you exactly as-is 🙈

🍓 cinder attachment-create

cinder attachment-create [--connect <connect>]
                         [--initiator <initiator>] [--ip <ip>]
                         [--host <host>] [--platform <platform>]
                         [--ostype <ostype>] [--multipath <multipath>]
                         [--mountpoint <mountpoint>] [--mode <mode>]
                         <volume> [<server_id>]

Creates an attachment for a cinder volume. yes, we're making a whole connection situation ✨

Positional arguments:

<volume> — name or ID of volume or volumes to attach.
<server_id> — ID of server attaching to.

Optional arguments:

--connect <connect> — make an active connection using the provided connector info (True or False).
--initiator <initiator> — iqn of the initiator attaching to. Default=None.
--ip <ip> — ip of the system attaching to. Default=None.
--host <host> — name of the host attaching to. Default=None.
--platform <platform> — platform type. Default=x86_64.
--ostype <ostype> — OS type. Default=linux2.
--multipath <multipath> — use multipath. Default=False.
--mountpoint <mountpoint> — mountpoint volume will be attached at. Default=None.
--mode <mode> — mode of attachment: rw, ro and null, where null indicates we want to honor any existing admin-metadata settings. Default=null.

💀 cinder attachment-delete

cinder attachment-delete <attachment> [<attachment> ...]

Deletes an attachment for a cinder volume. poof, gone 🫶

Positional arguments:

<attachment> — ID of attachment or attachments to delete.

🌈 cinder attachment-list

cinder attachment-list [--all-tenants [<0|1>]]
                       [--volume-id <volume-id>] [--status <status>]
                       [--marker <marker>] [--limit <limit>]
                       [--sort <key>[:<direction>]]
                       [--tenant [<tenant>]]
                       [--filters [<key=value> ...]]

Lists all attachments. every single one, main character energy 👑

Optional arguments:

--all-tenants <0|1> — shows details for all tenants. Admin only 🔒
--volume-id <volume-id> — filters results by a volume ID. Default=None. This option is deprecated and will be removed in a newer release. Please use the --filters option, which was introduced since 3.33 instead.
--status <status> — filters results by a status. Default=None. This option is deprecated and will be removed in a newer release. Please use the --filters option, which was introduced since 3.33 instead.
--marker <marker> — begin returning attachments that appear later in the attachment list than the one represented by this id. Default=None.
--limit <limit> — maximum number of attachments to return. Default=None.
--sort <key>[:<direction>] — comma-separated list of sort keys and directions in the form of <key>[:<asc|desc>]. Valid keys: id, status, size, availability_zone, name, bootable, created_at, reference. Default=None.
--tenant <tenant> — display information from single tenant. Admin only 🔒
--filters <key=value> — filter key and value pairs. Please use cinder list-filters to check enabled filters from the server. Use key~=value for inexact filtering if the key supports it. Default=None.

🧚 cinder attachment-show

cinder attachment-show <attachment>

Shows detailed information for an attachment. the full tea ☕

Positional arguments:

<attachment> — ID of attachment.

💜 cinder attachment-update

cinder attachment-update [--initiator <initiator>] [--ip <ip>]
                         [--host <host>] [--platform <platform>]
                         [--ostype <ostype>] [--multipath <multipath>]
                         [--mountpoint <mountpoint>]
                         <attachment>

Updates an attachment for a cinder volume. glow-up time ✨

Positional arguments:

<attachment> — ID of attachment.

Optional arguments:

--initiator <initiator> — iqn of the initiator attaching to. Default=None.
--ip <ip> — ip of the system attaching to. Default=None.
--host <host> — name of the host attaching to. Default=None.
--platform <platform> — platform type. Default=x86_64.
--ostype <ostype> — OS type. Default=linux2.
--multipath <multipath> — use multipath. Default=False.
--mountpoint <mountpoint> — mountpoint volume will be attached at. Default=None.

🌟 cinder availability-zone-list

cinder availability-zone-list

Lists all availability zones. that's it, that's the whole thing 💅

🎀 cinder backup-create

cinder backup-create [--container <container>] [--name <name>]
                     [--description <description>] [--incremental]
                     [--force] [--snapshot-id <snapshot-id>]
                     [--metadata [<key=value> ...]]
                     [--availability-zone AVAILABILITY_ZONE]
                     <volume>

Creates a volume backup. protecting your data with style 🫶

Positional arguments:

<volume> — name or ID of volume to backup.

Optional arguments:

--container <container> — backup container name. Default=None.
--name <name> — backup name. Default=None.
--description <description> — backup description. Default=None.
--incremental — incremental backup. Default=False.
--force — allows or disallows backup of a volume when the volume is attached to an instance. If set to True, backs up the volume whether its status is "available" or "in-use". The backup of an "in-use" volume means your data is crash consistent 😭 Default=False.
--snapshot-id <snapshot-id> — ID of snapshot to backup. Default=None.
--metadata <key=value> — metadata key and value pairs. Default=None.
--availability-zone — AZ where the backup should be stored; by default it will be the same as the source.

🌸 cinder backup-delete

cinder backup-delete [--force] <backup> [<backup> ...]

Removes one or more backups. the way that backup just leaves 💀

Positional arguments:

<backup> — name or ID of the backup(s) you're about to delete.

Optional arguments:

--force None — lets you delete a backup of a volume even when that volume's status is anything other than "available" or "error". Default=False. It's the override, so use it responsibly bestie 🫶

`cinder backup-export`

cinder backup-export <backup>

Exports the backup metadata record. ✨

Positional arguments:

<backup> — the ID of the backup you want to export.

`cinder backup-import`

cinder backup-import <backup_service> <backup_url>

Imports a backup metadata record. 🎀

Positional arguments:

<backup_service> — the backup service that gets used for importing the backup.
<backup_url> — the backup URL used for importing that backup metadata.

`cinder backup-list`

cinder backup-list [--all-tenants [<all_tenants>]] [--name <name>]
                   [--status <status>] [--volume-id <volume-id>]
                   [--marker <marker>] [--limit <limit>]
                   [--sort <key>[:<direction>]]
                   [--filters [<key=value> ...]]
                   [--with-count [<True|False>]]

Lists, you guessed it, all the backups. 💖

Optional arguments:

--all-tenants <all_tenants> — shows details for every tenant. Admin only, iykyk 🔑
--name <name> — filters results by a name. Default=None. ⚠️ Heads up: this option is deprecated and will be removed in a newer release — please use the --filters option, which has been around since 3.33 instead.
--status <status> — filters results by a status. Default=None. ⚠️ Also deprecated, also getting removed in a newer release — same deal, use --filters (introduced in 3.33) instead.
--volume-id <volume-id> — filters results by a volume ID. Default=None. ⚠️ Yep, deprecated too, will be removed in a newer release — --filters is the move, introduced since 3.33.
--marker <marker> — starts returning backups that show up later in the backup list than the one represented by this id. Default=None. It's giving "keep scrolling from here" energy.
--limit <limit> — max number of backups to return. Default=None.
--sort <key>[:<direction>] — comma-separated list of sort keys and directions, formatted as <key>[:<asc|desc>]. Valid keys: id, status, size, availability_zone, name, bootable, created_at, reference. Default=None.
--filters <key=value> — filter key and value pairs. Run cinder list-filters to check which filters the server has enabled. Use key~=value for inexact filtering if the key supports it. Default=None.
--with-count <True|False> — shows the total number of backup entities. Super useful when pagination is applied in the request. 🔥

`cinder backup-reset-state`

cinder backup-reset-state [--state <state>] <backup> [<backup> ...]

Explicitly updates the backup state. Main character energy: you're telling it how it is. 👑

Positional arguments:

<backup> — name or ID of the backup to modify.

Optional arguments:

--state <state> — the state you're assigning to the backup. Valid values are "available" and "error". Default=available.

`cinder backup-restore`

cinder backup-restore [--volume <volume>] [--name <name>]
                      [--volume-type <volume-type>]
                      [--availability-zone <AZ>]
                      <backup>

Restores a backup. The comeback era 🦋

Positional arguments:

<backup> — name or ID of the backup to restore.

Optional arguments:

--volume <volume> — name or ID of an existing volume to restore onto. This is mutually exclusive with --name and it takes priority. Default=None.
--name <name> — use this name for the new volume creation when restoring. Mutually exclusive with --volume, and --volume takes priority. Default=None.
--volume-type <volume-type> — volume type for the new volume creation when restoring. Not valid when used with the "volume" option. Default=None.
--availability-zone <AZ> — AZ for the new volume creation when restoring. By default it'll be the same as the backup AZ. Not valid when used with the "volume" option. Default=None.

`cinder backup-show`

cinder backup-show <backup>

Shows backup details. Receipts, basically 🧾✨

Positional arguments:

<backup> — name or ID of the backup.

`cinder backup-update`

cinder backup-update [--name [<name>]] [--description <description>]
                     [--metadata [<key=value> ...]]
                     <backup>

Updates a backup. Glow-up time 💅

Positional arguments:

<backup> — name or ID of the backup you're renaming.

Optional arguments:

--name <name> — the new name for the backup.
--description <description> — backup description. Default=None.
--metadata <key=value> — metadata key and value pairs. Default=None.

`cinder cgsnapshot-create`

cinder cgsnapshot-create [--name <name>] [--description <description>]
                         <consistencygroup>

Creates a cgsnapshot. 🎀

Positional arguments:

<consistencygroup> — name or ID of a consistency group.

Optional arguments:

--name <name> — cgsnapshot name. Default=None.
--description <description> — cgsnapshot description. Default=None.

`cinder cgsnapshot-delete`

cinder cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]

Removes one or more cgsnapshots. Bye bestie 👋💀

Positional arguments:

<cgsnapshot> — name or ID of one or more cgsnapshots to be deleted.

`cinder cgsnapshot-list`

cinder cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>]
                       [--consistencygroup-id <consistencygroup_id>]

Lists all the cgsnapshots. 🌸

Optional arguments:

--all-tenants <0|1> — shows details for all tenants. Admin only.
--status <status> — filters results by a status. Default=None.
--consistencygroup-id <consistencygroup_id> — filters results by a consistency group ID. Default=None.

`cinder cgsnapshot-show`

cinder cgsnapshot-show <cgsnapshot>

Shows cgsnapshot details. No cap, it just tells you things. 🔍

Positional arguments:

<cgsnapshot> — name or ID of the cgsnapshot.

`cinder cluster-disable`

cinder cluster-disable [--reason <reason>] [<binary>] <cluster-name>

Disables clustered services. It's giving "we're closed" 🚫

Positional arguments:

<binary> — binary to filter by. Default: cinder-volume.
<cluster-name> — name of the clustered services to update.

Optional arguments:

--reason <reason> — the reason for disabling the clustered service.

`cinder cluster-enable`

cinder cluster-enable [<binary>] <cluster-name>

Enables clustered services. We're so back 🔥

Positional arguments:

<binary> — binary to filter by. Default: cinder-volume.
<cluster-name> — name of the clustered services to update.

`cinder cluster-list`

cinder cluster-list [--name <name>] [--binary <binary>]
                    [--is-up <True|true|False|false>]
                    [--disabled <True|true|False|false>]
                    [--num-hosts <num-hosts>]
                    [--num-down-hosts <num-down-hosts>] [--detailed]

Lists clustered services, with optional filtering. ✨

Optional arguments:

--name <name> — filter by cluster name; without a backend it'll list all clustered services from the same cluster. Default=None.
--binary <binary> — cluster binary. Default=None.
--is-up <True|true|False|false> — filter by up/down status. Default=None.
--disabled <True|true|False|false> — filter by disabled status. Default=None.
--num-hosts <num-hosts> — filter by the number of hosts in the cluster.
--num-down-hosts <num-down-hosts> — filter by the number of hosts that are down.
--detailed None — get detailed clustered service information (Default=False).

`cinder cluster-show`

cinder cluster-show [<binary>] <cluster-name>

Shows detailed information on a clustered service. Receipts, detailed edition 🧾

Positional arguments:

<binary> — binary to filter by. Default: cinder-volume.
<cluster-name> — name of the clustered service to show.

`cinder consisgroup-create`

cinder consisgroup-create [--name <name>] [--description <description>]
                          [--availability-zone <availability-zone>]
                          <volume-types>

Creates a consistency group. Group chat, but make it storage 💬💖

Positional arguments:

<volume-types> — volume types.

Optional arguments:

--name <name> — name of the consistency group.
--description <description> — description of the consistency group. Default=None.
--availability-zone <availability-zone> — availability zone for the volume. Default=None.

`cinder consisgroup-create-from-src`

cinder consisgroup-create-from-src [--cgsnapshot <cgsnapshot>]
                                   [--source-cg <source-cg>]
                                   [--name <name>]
                                   [--description <description>]

Creates a consistency group from a cgsnapshot or a source CG. Remix, basically 🎧

Optional arguments:

--cgsnapshot <cgsnapshot> — name or ID of a cgsnapshot. Default=None.
--source-cg <source-cg> — name or ID of a source CG. Default=None.
--name <name> — name of the consistency group. Default=None.
--description <description> — description of the consistency group. Default=None.

`cinder consisgroup-delete`

cinder consisgroup-delete [--force]
                          <consistencygroup> [<consistencygroup> ...]

Removes one or more consistency groups. 🗑️

Positional arguments:

<consistencygroup> — name or ID of one or more consistency groups to be deleted.

Optional arguments:

--force None — allows or disallows consistency groups to be deleted. Here's the deal: if the consistency group is empty, it can be deleted without the force flag. If the consistency group is not empty, the force flag is required for it to be deleted. ⚠️ Note the "not empty" part — that's where you actually need it.

`cinder consisgroup-list`

cinder consisgroup-list [--all-tenants [<0|1>]]

Lists all consistency groups. 👑

Optional arguments:

--all-tenants <0|1> — shows details for all tenants. Admin only.

`cinder consisgroup-show`

cinder consisgroup-show <consistencygroup>

Shows details of a consistency group. 🦋

Positional arguments:

<consistencygroup> — name or ID of a consistency group.

💅 `cinder consisgroup-update`

usage: cinder consisgroup-update [--name <name>] [--description <description>]
                                 [--add-volumes <uuid1,uuid2,......>]
                                 [--remove-volumes <uuid3,uuid4,......>]
                                 <consistencygroup>

Updates a consistency group. Glow-up time ✨

Positional arguments:

<consistencygroup> — name or ID of a consistency group.

Optional arguments:

--name <name> — new name for the consistency group. Default=None.
--description <description> — new description for the consistency group. Default=None.
--add-volumes <uuid1,uuid2,......> — UUID(s) of one or more volumes to add to the consistency group, separated by commas. Default=None.
--remove-volumes <uuid3,uuid4,......> — UUID(s) of one or more volumes to remove from the consistency group, separated by commas. Default=None.

🌸 `cinder create`

usage: cinder create [--consisgroup-id <consistencygroup-id>]
                     [--group-id <group-id>] [--snapshot-id <snapshot-id>]
                     [--source-volid <source-volid>] [--image-id <image-id>]
                     [--image <image>] [--backup-id <backup-id>]
                     [--name <name>] [--description <description>]
                     [--volume-type <volume-type>]
                     [--availability-zone <availability-zone>]
                     [--metadata [<key=value> ...]] [--hint <key=value>]
                     [--poll]
                     [<size>]

Creates a volume. The main character command, honestly 👑 you'll be using this one a lot.

Positional arguments:

<size> — size of the volume, in GiBs. It's required unless you specify snapshot-id/source-volid/backup-id.

Optional arguments:

--consisgroup-id <consistencygroup-id> — ID of a consistency group the new volume belongs to. Default=None.
--group-id <group-id> — ID of a group the new volume belongs to. Default=None.
--snapshot-id <snapshot-id> — creates the volume from a snapshot ID. Default=None.
--source-volid <source-volid> — creates the volume from a volume ID. Default=None.
--image-id <image-id> — creates the volume from an image ID. Default=None.
--image <image> — creates a volume from an image (ID or name). Default=None.
--backup-id <backup-id> — creates a volume from a backup ID. Default=None.
--name <name> — volume name. Default=None.
--description <description> — volume description. Default=None.
--volume-type <volume-type> — volume type. Default=None, meaning it uses the default volume type configured for the Block Storage API. Wanna peep what that is? Run cinder type-default, bestie 🔍
--availability-zone <availability-zone> — availability zone for the volume. Default=None.
--metadata [<key=value> ...] — metadata key and value pairs. Default=None.
--hint <key=value> — scheduler hint, similar to nova. Repeat the option to set multiple hints; values with the same key get stored as a list.
--poll None — wait for volume creation until it completes. (yes the manpage really prints None there, we don't question the ancients 💀)

🦋 `cinder default-type-list`

usage: cinder default-type-list [--project-id <project_id>]

Lists all default volume types.

Optional arguments:

--project-id <project_id> — ID of the project to show the default type for.

🎀 `cinder default-type-set`

usage: cinder default-type-set <volume_type> <project_id>

Sets a default volume type for a project.

Positional arguments:

<volume_type> — name or ID of the volume type.
<project_id> — ID of the project to set the default type for.

✨ `cinder default-type-unset`

usage: cinder default-type-unset <project_id> [<project_id> ...]

Unset default volume types. Group activity, you can do a bunch at once 🫶

Positional arguments:

<project_id> — ID of the project to unset the default type for.

💀 `cinder delete`

usage: cinder delete [--cascade] <volume> [<volume> ...]

Removes one or more volumes. No going back, so vibe check twice 😭

Positional arguments:

<volume> — name or ID of the volume (or volumes) to delete.

Optional arguments:

--cascade None — remove any snapshots along with the volume. Default=False.

⚠️ Real talk: this is destructive. --cascade takes the snapshots down with it too.

🔐 `cinder encryption-type-create`

usage: cinder encryption-type-create [--cipher <cipher>]
                                     [--key-size <key_size>]
                                     [--control-location <control_location>]
                                     <volume_type> <provider>

Creates an encryption type for a volume type. Admin only, so don't come for me if it says no 🚫

Positional arguments:

<volume_type> — name or ID of the volume type.
<provider> — the encryption provider format. For example, "luks" or "plain".

Optional arguments:

--cipher <cipher> — the encryption algorithm or mode. For example, aes-xts-plain64. Default=None.
--key-size <key_size> — size of the encryption key, in bits. For example, 128 or 256. Default=None.
--control-location <control_location> — notional service where encryption is performed. Valid values are "front-end" or "back-end". For example, front-end=Nova. Default is "front-end".

🗑️ `cinder encryption-type-delete`

usage: cinder encryption-type-delete <volume_type>

Deletes the encryption type for a volume type. Admin only.

Positional arguments:

<volume_type> — name or ID of the volume type.

📋 `cinder encryption-type-list`

usage: cinder encryption-type-list

Shows encryption type details for volume types. Admin only. No args, just vibes ✨

🔍 `cinder encryption-type-show`

usage: cinder encryption-type-show <volume_type>

Shows encryption type details for one specific volume type. Admin only.

Positional arguments:

<volume_type> — name or ID of the volume type.

🛠️ `cinder encryption-type-update`

usage: cinder encryption-type-update [--provider <provider>]
                                     [--cipher [<cipher>]]
                                     [--key-size [<key-size>]]
                                     [--control-location <control-location>]
                                     <volume-type>

Update encryption type information for a volume type (Admin Only).

Positional arguments:

<volume-type> — name or ID of the volume type.

Optional arguments:

--provider <provider> — encryption provider format (e.g. 'luks' or 'plain').
--cipher [<cipher>] — encryption algorithm/mode to use (e.g., aes-xts-plain64). Heads up: provide the parameter without a value to set it to the provider default 👀
--key-size [<key-size>] — size of the encryption key, in bits (e.g., 128, 256). Same deal: provide the parameter without a value to set it to the provider default.
--control-location <control-location> — notional service where encryption is performed (e.g., front-end=Nova). Values: 'front-end', 'back-end'.

📏 `cinder extend`

usage: cinder extend <volume> <new_size>

Attempts to extend the size of an existing volume. Growth era 🌱 (note the "attempts" — it tries, it does not promise).

Positional arguments:

<volume> — name or ID of the volume to extend.
<new_size> — new size of the volume, in GiBs.

🧾 `cinder extra-specs-list`

usage: cinder extra-specs-list

Lists current volume types and extra specs. Zero arguments, maximum usefulness.

🔄 `cinder failover-host`

usage: cinder failover-host [--backend_id <backend-id>] <hostname>

Failover a replicating cinder-volume host.

Positional arguments:

<hostname> — host name.

Optional arguments:

--backend_id <backend-id> — ID of the backend to failover to (Default=None).

💥 `cinder force-delete`

usage: cinder force-delete <volume> [<volume> ...]

Attempts a force-delete of the volume, regardless of state. Yeah. It does not care what state it's in, it's deleting it 😤

Positional arguments:

<volume> — name or ID of the volume (or volumes) to delete.

⚠️ "Regardless of state" is doing a lot of heavy lifting in that sentence. Be sure, bestie.

🧊 `cinder freeze-host`

usage: cinder freeze-host <hostname>

Freeze and disable the specified cinder-volume host.

Positional arguments:

<hostname> — host name.

📊 `cinder get-capabilities`

usage: cinder get-capabilities <host>

Show backend volume stats and properties. Admin only.

Positional arguments:

<host> — cinder host to show backend volume stats and properties for; takes the form host@backend-name.

🏊 `cinder get-pools`

usage: cinder get-pools [--detail] [--filters [<key=value> ...]]

Show pool information for backends. Admin only.

Optional arguments:

--detail None — show detailed information about pools.
--filters [<key=value> ...] — filter key and value pairs. Please use cinder list-filters to check the enabled filters from the server. Default=None.

👯 `cinder group-create`

usage: cinder group-create [--name <name>] [--description <description>]
                           [--availability-zone <availability-zone>]
                           <group-type> <volume-types>

Creates a group.

Positional arguments:

<group-type> — group type.
<volume-types> — comma-separated list of volume types.

Optional arguments:

--name <name> — name of the group.
--description <description> — description of the group. Default=None.
--availability-zone <availability-zone> — availability zone for the group. Default=None.

🌱 `cinder group-create-from-src`

usage: cinder group-create-from-src [--group-snapshot <group-snapshot>]
                                    [--source-group <source-group>]
                                    [--name <name>]
                                    [--description <description>]

Creates a group from a group snapshot or a source group.

Optional arguments:

--group-snapshot <group-snapshot> — name or ID of a group snapshot. Default=None.
--source-group <source-group> — name or ID of a source group. Default=None.
--name <name> — name of the group. Default=None.
--description <description> — description of the group. Default=None.

🗑️ `cinder group-delete`

usage: cinder group-delete [--delete-volumes] <group> [<group> ...]

Removes one or more groups.

Positional arguments:

<group> — name or ID of one or more groups to be deleted.

Optional arguments:

--delete-volumes None — allows or disallows groups to be deleted if they're not empty. Let me spell it out 🗣️ if the group is empty, it can be deleted without the delete-volumes flag. If the group is not empty, the delete-volumes flag is required for it to be deleted. If True, all volumes in the group will also be deleted.

⚠️ That last bit means the volumes go too. All of them. Read it twice, then read it again.

🚫 `cinder group-disable-replication`

usage: cinder group-disable-replication <group>

Disables replication for the group.

Positional arguments:

<group> — name or ID of the group.

cinder group-enable-replication

usage: cinder group-enable-replication <group>

okay so this one turns on replication for a group. slay for redundancy 💅

Positional arguments:

<group> — name or ID of the group. give it the group's name or its ID, either works 🫶

cinder group-failover-replication

usage: cinder group-failover-replication [--allow-attached-volume]
                                         [--secondary-backend-id <secondary_backend_id>]
                                         <group>

fails over replication for a group. dramatic main character moment for your storage 🔥

Positional arguments:

<group> — name or ID of the group.

Optional arguments:

--allow-attached-volume — value is None. this allows or disallows a group that has attached volumes to be failed over. so yes, it's deciding whether attached volumes get to come along.
--secondary-backend-id <secondary_backend_id> — the secondary backend id. Default=None.

cinder group-list

usage: cinder group-list [--all-tenants [<0|1>]] [--filters [<key=value> ...]]

lists all groups. window shopping for groups ✨

Optional arguments:

--all-tenants <0|1> — shows details for all tenants. admin only 👑
--filters <key=value> — filter key and value pairs. please use cinder list-filters to check which filters are enabled on the server. use key~=value for inexact filtering, if the key supports it. Default=None.

cinder group-list-replication-targets

usage: cinder group-list-replication-targets <group>

lists the replication targets for a group 🎯

Positional arguments:

<group> — name or ID of the group.

cinder group-show

usage: cinder group-show [--list-volume [<False|True>]] <group>

shows the details of a group. the full vibe check 🦋

Positional arguments:

<group> — name or ID of a group.

Optional arguments:

--list-volume <False|True> — shows the volumes included in the group.

cinder group-snapshot-create

usage: cinder group-snapshot-create [--name <name>]
                                    [--description <description>]
                                    <group>

creates a group snapshot. saving the moment, literally 📸

Positional arguments:

<group> — name or ID of a group.

Optional arguments:

--name <name> — group snapshot name. Default=None.
--description <description> — group snapshot description. Default=None.

cinder group-snapshot-delete

usage: cinder group-snapshot-delete <group_snapshot> [<group_snapshot> ...]

removes one or more group snapshots. bye bestie 💀

Positional arguments:

<group_snapshot> — name or ID of one or more group snapshots to be deleted.

cinder group-snapshot-list

usage: cinder group-snapshot-list [--all-tenants [<0|1>]] [--status <status>]
                                  [--group-id <group_id>]
                                  [--filters [<key=value> ...]]

lists all group snapshots 💖

Optional arguments:

--all-tenants <0|1> — shows details for all tenants. admin only 👑
--status <status> — filters results by a status. Default=None. ⚠️ this option is deprecated and will be removed in a newer release. please use the --filters option instead, which was introduced since 3.33.
--group-id <group_id> — filters results by a group ID. Default=None. ⚠️ also deprecated, also getting removed in a newer release. again: use --filters, introduced since 3.33.
--filters <key=value> — filter key and value pairs. check which filters your server has enabled with cinder list-filters. if a key supports it, use key~=value for inexact filtering. Default=None.

cinder group-snapshot-show

usage: cinder group-snapshot-show <group_snapshot>

shows group snapshot details 🌸

Positional arguments:

<group_snapshot> — name or ID of group snapshot.

cinder group-specs-list

usage: cinder group-specs-list

lists the current group types and specs. no args, no stress ✨

cinder group-type-create

usage: cinder group-type-create [--description <description>]
                                [--is-public <is-public>]
                                <name>

creates a group type 🎀

Positional arguments:

<name> — name of the new group type.

Optional arguments:

--description <description> — description of the new group type.
--is-public <is-public> — make the type accessible to the public (default true).

cinder group-type-default

usage: cinder group-type-default

lists the default group type. the one that's just built different 👑

cinder group-type-delete

usage: cinder group-type-delete <group_type> [<group_type> ...]

deletes a group type or several of them 💅

Positional arguments:

<group_type> — name or ID of the group type or types to delete.

cinder group-type-key

usage: cinder group-type-key <gtype> <action> <key=value> [<key=value> ...]

sets or unsets group_spec for a group type.

Positional arguments:

<gtype> — name or ID of group type.
<action> — the action. valid values are "set" or "unset."
<key=value> — the group specs key and value pair to set or unset. for unset, specify only the key.

ngl the unset dance is easy to fumble: for unset you pass just the key, not a pair 🙈

cinder group-type-list

usage: cinder group-type-list [--filters [<key=value> ...]]

lists the available 'group types'. (admin only will see private types) 👀

Optional arguments:

--filters <key=value> — filter key and value pairs. admin only.

cinder group-type-show

usage: cinder group-type-show <group_type>

shows group type details 🦋

Positional arguments:

<group_type> — name or ID of the group type.

cinder group-type-update

usage: cinder group-type-update [--name <name>] [--description <description>]
                                [--is-public <is-public>]
                                <id>

updates a group type's name, description, and/or is_public. glow-up time ✨

Positional arguments:

<id> — ID of the group type.

Optional arguments:

--name <name> — name of the group type.
--description <description> — description of the group type.
--is-public <is-public> — make the type accessible to the public or not.

cinder group-update

usage: cinder group-update [--name <name>] [--description <description>]
                           [--add-volumes <uuid1,uuid2,......>]
                           [--remove-volumes <uuid3,uuid4,......>]
                           <group>

updates a group. mix and match the flags, she's flexible 💜

Positional arguments:

<group> — name or ID of a group.

Optional arguments:

--name <name> — new name for the group. Default=None.
--description <description> — new description for the group. Default=None.
--add-volumes <uuid1,uuid2,......> — UUID of one or more volumes to be added to the group, separated by commas. Default=None.
--remove-volumes <uuid3,uuid4,......> — UUID of one or more volumes to be removed from the group, separated by commas. Default=None.

cinder image-metadata

usage: cinder image-metadata <volume> <action> <key=value> [<key=value> ...]

sets or deletes volume image metadata 🎀

Positional arguments:

<volume> — name or ID of the volume whose metadata you're updating.
<action> — the action. valid values are 'set' or 'unset.'
<key=value> — metadata key and value pair to set or unset. for unset, specify only the key.

cinder image-metadata-show

usage: cinder image-metadata-show <volume>

shows volume image metadata 🔍

Positional arguments:

<volume> — ID of volume.

cinder list

usage: cinder list [--group_id <group_id>] [--all-tenants [<0|1>]]
                   [--name <name>] [--status <status>]
                   [--bootable [<True|true|False|false>]]
                   [--migration_status <migration_status>]
                   [--metadata [<key=value> ...]]
                   [--image_metadata [<key=value> ...]] [--marker <marker>]
                   [--limit <limit>] [--fields <fields>]
                   [--sort <key>[:<direction>]] [--tenant [<tenant>]]
                   [--filters [<key=value> ...]] [--with-count [<True|False>]]

lists all volumes. the classic, the icon, the one you'll type a thousand times 💅

Optional arguments:

--group_id <group_id> — filters results by a group_id. Default=None. ⚠️ deprecated, will be removed in a newer release — use the --filters option instead, introduced since 3.33.
--all-tenants <0|1> — shows details for all tenants. admin only 👑
--name <name> — filters results by a name. Default=None. ⚠️ deprecated, will be removed in a newer release — use --filters (since 3.33).
--status <status> — filters results by a status. Default=None. ⚠️ deprecated, will be removed in a newer release — use --filters (since 3.33).
--bootable <True|true|False|false> — filters results by bootable status. Default=None. ⚠️ deprecated, will be removed in a newer release — use --filters (since 3.33).
--migration_status <migration_status> — filters results by a migration status. Default=None. admin only. ⚠️ deprecated, will be removed in a newer release — use --filters (since 3.33).
--metadata <key=value> — filters results by a metadata key and value pair. Default=None. ⚠️ deprecated, will be removed in a newer release — use --filters (since 3.33).
--image_metadata <key=value> — filters results by an image metadata key and value pair. requires volume api version >=3.4. Default=None. ⚠️ deprecated, will be removed in a newer release — use --filters (since 3.33).
--marker <marker> — begin returning volumes that appear later in the volume list than the one represented by this volume id. Default=None.
--limit <limit> — maximum number of volumes to return. Default=None.
--fields <fields> — comma-separated list of fields to display. use the show command to see which fields are available. unavailable/non-existent fields will be ignored. Default=None.
--sort <key>[:<direction>] — comma-separated list of sort keys and directions in the form of <key>[:<asc|desc>]. valid keys: id, status, size, availability_zone, name, bootable, created_at, reference. Default=None.
--tenant <tenant> — display information from single tenant (admin only).

lowkey a whole museum of deprecated flags in here 😭 the move is --filters for basically all of it, fr fr 🫶

--filters <key=value> — filter by key and value pairs 💅 run cinder list-filters to peep which filters your server actually has enabled. If a key supports it, use key~=value for inexact (fuzzy) matching. Default=None.
--with-count <True|False> — shows the total number of volume entities. Lowkey the move when pagination is applied in the request, fr fr.

🎀 `cinder list-filters`

usage: cinder list-filters [--resource <resource>]

Lists enabled filters. That's it, that's the whole vibe ✨

Optional arguments:

--resource <resource> — show the enabled filters for a specified resource. Default=None.

🦋 `cinder manage`

usage: cinder manage [--cluster CLUSTER] [--id-type <id-type>] [--name <name>]
                     [--description <description>]
                     [--volume-type <volume-type>]
                     [--availability-zone <availability-zone>]
                     [--metadata [<key=value> ...]] [--bootable]
                     <host> <identifier>

Manage an existing volume — like adopting a stray volume into the family 🫶

Positional arguments:

<host> — the Cinder host on which the existing volume resides; takes the form: host@backend-name#pool
<identifier> — name or other identifier for the existing volume

Optional arguments:

--cluster None — the Cinder cluster on which the existing volume resides; takes the form: cluster@backend-name#pool. (yes, the placeholder literally says None, iconic 💀)
--id-type <id-type> — the type of backend device identifier you're providing, typically source-name or source-id (Default=source-name)
--name <name> — volume name (Default=None)
--description <description> — volume description (Default=None)
--volume-type <volume-type> — volume type (Default=None)
--availability-zone <availability-zone> — availability zone for the volume (Default=None)
--metadata <key=value> — metadata key=value pairs (Default=None)
--bootable None — specifies that the newly created volume should be marked as bootable

🌸 `cinder manageable-list`

usage: cinder manageable-list [--detailed <detailed>] [--marker <marker>]
                              [--limit <limit>] [--offset <offset>]
                              [--sort <key>[:<direction>]] [--cluster CLUSTER]
                              [<host>]

Lists all manageable volumes. Scouting the vibes before you commit 👀

Positional arguments:

<host> — Cinder host on which to list manageable volumes; takes the form: host@backend-name#pool

Optional arguments:

--detailed <detailed> — returned detailed information (default true).
--marker <marker> — begin returning volumes that appear later in the volume list than the one represented by this reference. This reference should be json like. Default=None.
--limit <limit> — maximum number of volumes to return. Default=None.
--offset <offset> — number of volumes to skip after the marker. Default=None.
--sort <key>[:<direction>] — comma-separated list of sort keys and directions in the form of <key>[:<asc|desc>]. Valid keys: size, reference. Default=None.
--cluster CLUSTER — Cinder cluster on which to list manageable volumes; takes the form: cluster@backend-name#pool

💜 `cinder message-delete`

usage: cinder message-delete <message> [<message> ...]

Removes one or more messages. Yeet 🗑️

Positional arguments:

<message> — ID of one or more message to be deleted.

🧚 `cinder message-list`

usage: cinder message-list [--marker <marker>] [--limit <limit>]
                           [--sort <key>[:<direction>]]
                           [--resource_uuid <resource_uuid>]
                           [--resource_type <type>] [--event_id <id>]
                           [--request_id <request_id>] [--level <level>]
                           [--filters [<key=value> ...]]

Lists all messages 📬

Optional arguments:

--marker <marker> — begin returning messages that appear later in the message list than the one represented by this id. Default=None.
--limit <limit> — maximum number of messages to return. Default=None.
--sort <key>[:<direction>] — comma-separated list of sort keys and directions in the form of <key>[:<asc|desc>]. Valid keys: id, status, size, availability_zone, name, bootable, created_at, reference. Default=None.
--resource_uuid <resource_uuid> — filters results by a resource uuid. Default=None. > ⚠️ This option is deprecated and will be removed in a newer release. Please use the --filters option, which is introduced since 3.33 instead. 😭
--resource_type <type> — filters results by a resource type. Default=None. > ⚠️ This option is deprecated and will be removed in a newer release. Please use the --filters option, which is introduced since 3.33 instead.
--event_id <id> — filters results by event id. Default=None. > ⚠️ This option is deprecated and will be removed in a newer release. Please use the --filters option, which is introduced since 3.33 instead.
--request_id <request_id> — filters results by request id. Default=None. > ⚠️ This option is deprecated and will be removed in a newer release. Please use the --filters option, which is introduced since 3.33 instead.
--level <level> — filters results by the message level. Default=None. > ⚠️ This option is deprecated and will be removed in a newer release. Please use the --filters option, which is introduced since 3.33 instead.
--filters <key=value> — filter key and value pairs. Please use cinder list-filters to check enabled filters from the server. Use key~=value for inexact filtering if the key supports it. Default=None.

⭐ `cinder message-show`

usage: cinder message-show <message>

Shows message details. Spill the tea on one specific message 🍵

Positional arguments:

<message> — ID of message.

🌈 `cinder metadata`

usage: cinder metadata <volume> <action> <key=value> [<key=value> ...]

Sets or deletes volume metadata.

Positional arguments:

<volume> — name or ID of volume for which to update metadata.
<action> — the action. Valid values are "set" or "unset."
<key=value> — metadata key and value pair to set or unset. For unset, specify only the key(s): <key key>

🍓 `cinder metadata-show`

usage: cinder metadata-show <volume>

Shows volume metadata. Peek at the tags, no cap 💅

Positional arguments:

<volume> — ID of volume.

👑 `cinder metadata-update-all`

usage: cinder metadata-update-all <volume> <key=value> [<key=value> ...]

Updates volume metadata.

Positional arguments:

<volume> — ID of volume for which to update metadata.
<key=value> — metadata key and value pair or pairs to update.

🔥 `cinder migrate`

usage: cinder migrate [--force-host-copy [<True|False>]]
                      [--lock-volume [<True|False>]] [--cluster CLUSTER]
                      <volume> [<host>]

Migrates volume to a new host. Moving day, bestie 🚚

Positional arguments:

<volume> — ID of volume to migrate.
<host> — destination host. Takes the form: host@backend-name#pool

Optional arguments:

--force-host-copy <True|False> — enables or disables generic host-based force-migration, which bypasses driver optimizations. Default=False.
--lock-volume <True|False> — enables or disables the termination of volume migration caused by other commands. This option applies to the available volume. True means it locks the volume state and does not allow the migration to be aborted. The volume status will be in maintenance during the migration. False means it allows the volume migration to be aborted. The volume status is still in the original status. Default=False.
--cluster None — destination cluster. Takes the form: cluster@backend-name#pool

💖 `cinder qos-associate`

usage: cinder qos-associate <qos_specs> <volume_type_id>

Associates qos specs with specified volume type. Matchmaker, matchmaker 🫶

Positional arguments:

<qos_specs> — ID of QoS specifications.
<volume_type_id> — ID of volume type with which to associate QoS specifications.

✨ `cinder qos-create`

usage: cinder qos-create <name> <key=value> [<key=value> ...]

Creates a qos specs. Making a whole new QoS bestie from scratch 🎀

Positional arguments:

<name> — name of new QoS specifications.
<key=value> — QoS specifications.

💀 `cinder qos-delete`

usage: cinder qos-delete [--force [<True|False>]] <qos_specs>

Deletes a specified qos specs.

Positional arguments:

<qos_specs> — ID of QoS specifications to delete.

Optional arguments:

--force <True|False> — enables or disables deletion of in-use QoS specifications. Default=False. (careful with this one, it's giving "delete anyway" energy 😭)

🦋 `cinder qos-disassociate`

usage: cinder qos-disassociate <qos_specs> <volume_type_id>

Disassociates qos specs from specified volume type. Breaking up, but make it storage 💔

Positional arguments:

<qos_specs> — ID of QoS specifications.
<volume_type_id> — ID of volume type with which to associate QoS specifications.

🌸 `cinder qos-disassociate-all`

usage: cinder qos-disassociate-all <qos_specs>

Disassociates qos specs from all its associations. Full-on clean slate 🧹

Positional arguments:

<qos_specs> — ID of QoS specifications on which to operate.

🧚 `cinder qos-get-association`

usage: cinder qos-get-association <qos_specs>

Lists all associations for specified qos specs. Who's linked to who 👀

Positional arguments:

<qos_specs> — ID of QoS specifications.

🎀 `cinder qos-key`

usage: cinder qos-key <qos_specs> <action> key=value [key=value ...]

Sets or unsets specifications for a qos spec.

Positional arguments:

<qos_specs> — ID of QoS specifications.
<action> — the action. Valid values are "set" or "unset."
key=value — metadata key and value pair to set or unset. For unset, specify only the key.

🌈 `cinder qos-list`

usage: cinder qos-list

Lists qos specs. No args, no notes, just vibes ✨

🍓 `cinder qos-show`

usage: cinder qos-show <qos_specs>

Shows qos specs details.

Positional arguments:

<qos_specs> — ID of QoS specifications to show.

👑 `cinder quota-class-show`

usage: cinder quota-class-show <class>

Lists quotas for a quota class.

Positional arguments:

<class> — name of quota class for which to list quotas.

`cinder quota-class-update`

usage: cinder quota-class-update [--volumes <volumes>]
                                 [--snapshots <snapshots>]
                                 [--gigabytes <gigabytes>]
                                 [--backups <backups>]
                                 [--backup-gigabytes <backup_gigabytes>]
                                 [--volume-type <volume_type_name>]
                                 [--per-volume-gigabytes <per_volume_gigabytes>]
                                 <class_name>

okay so this one updates the quotas for a whole quota class 💅 like you're setting the vibe for everybody in that class at once, no cap.

Positional arguments:

<class_name> — the name of the quota class you're setting quotas for 🎀

Optional arguments:

--volumes <volumes> — the new "volumes" quota value. Default=None ✨
--snapshots <snapshots> — the new "snapshots" quota value. Default=None 🌸
--gigabytes <gigabytes> — the new "gigabytes" quota value. Default=None 💖
--backups <backups> — the new "backups" quota value. Default=None 🦋
--backup-gigabytes <backup_gigabytes> — the new "backup_gigabytes" quota value. Default=None 🍓
--volume-type <volume_type_name> — volume type. Default=None 👑
--per-volume-gigabytes <per_volume_gigabytes> — sets the max volume size limit. Default=None ⭐

`cinder quota-defaults`

usage: cinder quota-defaults <tenant_id>

Lists the default quotas for a tenant — like, what everyone starts with before anyone customizes anything. the baseline. the factory settings of your storage life 🙈

Positional arguments:

<tenant_id> — ID of the tenant you wanna list quota defaults for 💜

`cinder quota-delete`

usage: cinder quota-delete <tenant_id>

Deletes the quotas for a tenant. that's it, that's the whole thing. gone. poof. 💀

Positional arguments:

<tenant_id> — UUID of the tenant to delete the quotas for 🎀

`cinder quota-show`

usage: cinder quota-show <tenant_id>

Lists the quotas for a tenant. current numbers, right now, no guessing bestie 💅

Positional arguments:

<tenant_id> — ID of the tenant you wanna list quotas for ✨

`cinder quota-update`

usage: cinder quota-update [--volumes <volumes>] [--snapshots <snapshots>]
                           [--gigabytes <gigabytes>] [--backups <backups>]
                           [--backup-gigabytes <backup_gigabytes>]
                           [--groups <groups>]
                           [--volume-type <volume_type_name>]
                           [--per-volume-gigabytes <per_volume_gigabytes>]
                           [--skip-validation <skip_validation>]
                           <tenant_id>

Updates the quotas for a tenant. the main character of quota commands tbh 👑

Positional arguments:

<tenant_id> — ID of the tenant you're setting quotas for 🫶

Optional arguments:

--volumes <volumes> — the new "volumes" quota value. Default=None 🌸
--snapshots <snapshots> — the new "snapshots" quota value. Default=None 💖
--gigabytes <gigabytes> — the new "gigabytes" quota value. Default=None 🦋
--backups <backups> — the new "backups" quota value. Default=None 🍓
--backup-gigabytes <backup_gigabytes> — the new "backup_gigabytes" quota value. Default=None ⭐
--groups <groups> — the new "groups" quota value. Default=None 🌈
--volume-type <volume_type_name> — volume type. Default=None 💜
--per-volume-gigabytes <per_volume_gigabytes> — sets the max volume size limit. Default=None 🎀
--skip-validation <skip_validation> — skips validating the existing resource quota. Default=False 🙈

`cinder quota-usage`

usage: cinder quota-usage <tenant_id>

Lists the quota usage for a tenant — so like, not the limit, but how much of it you're actually eating through rn 😭

Positional arguments:

<tenant_id> — ID of the tenant you wanna list quota usage for ✨

`cinder rate-limits`

usage: cinder rate-limits [<tenant_id>]

Lists the rate limits for a user. speed check but make it API 💅

Positional arguments:

<tenant_id> — display information for a single tenant (Admin only) 🔥

`cinder readonly-mode-update`

usage: cinder readonly-mode-update <volume> <True|true|False|false>

Updates the volume's read-only access-mode flag — basically flipping the "don't touch" sign on or off 🎀

Positional arguments:

<volume> — ID of the volume to update 🌸
<True|true|False|false> — enables or disables updating the volume to read-only access mode. (yes, all four spellings are valid, we don't judge 💖)

`cinder reimage`

usage: cinder reimage [--reimage-reserved <True|False>] <volume> <image-id>

Rebuilds a volume, overwriting all content with the specified image. ⚠️ like — all content. everything. bestie the old data is NOT coming back, ok? this one's giving "no undo button" 💀

Positional arguments:

<volume> — name or ID of the volume to reimage 🦋
<image-id> — the image id of the image that's gonna be used to reimage the volume ⭐

Optional arguments:

--reimage-reserved <True|False> — enables or disables reimage for a volume that's in a reserved state; otherwise only volumes in "available" or "error" status may be re-imaged. Default=False 👑

`cinder rename`

usage: cinder rename [--description <description>] <volume> [<name>]

Renames a volume. glow-up but for labels 💅

Positional arguments:

<volume> — name or ID of the volume to rename 🎀
<name> — new name for the volume ✨

Optional arguments:

--description <description> — volume description. Default=None 🌸

`cinder reset-state`

usage: cinder reset-state [--type <type>] [--state <state>]
                          [--attach-status <attach-status>]
                          [--reset-migration-status]
                          <entity> [<entity> ...]

Explicitly updates the entity state in the Cinder database. and bestie when I say "explicitly" I mean it does exactly what you tell it and checks absolutely nothing 😭 read the warnings below, fr fr.

Positional arguments:

<entity> — name or ID of the entity to update 🦋

Optional arguments:

--type <type> — the type of entity to update. Available resources are: 'volume', 'snapshot', 'backup', 'group' (since 3.20) and 'group-snapshot' (since 3.19). Default=volume 👑
--state <state> — the state to assign to the entity. NOTE: this command simply changes the state of the entity in the database with no regard to actual status, so exercise caution when using it 🙈 Default=None, which means the state is unchanged.
--attach-status <attach-status> — only used for a volume entity. The attach status to assign to the volume in the database, with no regard to the actual status. Valid values are "attached" and "detached". Default=None, which means the status is unchanged ⚠️
--reset-migration-status None — only used for a volume entity. Clears the migration status of the volume in the DataBase that indicates the volume is the source or destination of a volume migration, with no regard to the actual status 💀

okay real talk — every one of these options writes straight to the database and ignores what's actually true about the resource. that's the whole point of the command and also the whole danger. caution, bestie. caution. 🫶

`cinder retype`

usage: cinder retype [--migration-policy <never|on-demand>]
                     <volume> <volume-type>

Changes the volume type for a volume. outfit change, but for storage 🎀

Positional arguments:

<volume> — name or ID of the volume whose type you're modifying 💜
<volume-type> — the new volume type ✨

Optional arguments:

--migration-policy <never|on-demand> — the migration policy during retype of the volume 🌸

`cinder revert-to-snapshot`

usage: cinder revert-to-snapshot <snapshot>

Reverts a volume to the specified snapshot. time travel, lowkey 🦋✨

Positional arguments:

<snapshot> — name or ID of the snapshot to restore. The snapshot must be the most recent one known to Cinder. no old snapshots, no exceptions 😭

`cinder service-disable`

usage: cinder service-disable [--reason <reason>] <hostname> <binary>

Disables the service 🚫

Positional arguments:

<hostname> — host name 🎀
<binary> — service binary ⭐

Optional arguments:

--reason <reason> — reason for disabling the service 🌸

`cinder service-enable`

usage: cinder service-enable <hostname> <binary>

Enables the service ✅ the reverse of the previous one, we love symmetry 💅

Positional arguments:

<hostname> — host name 🎀
<binary> — service binary ⭐

`cinder service-get-log`

usage: cinder service-get-log
                             [--binary {,*,cinder-api,cinder-volume,cinder-scheduler,cinder-backup}]
                             [--server SERVER] [--prefix PREFIX]

Gets the service log level 👀

Optional arguments:

--binary None — binary to query 🦋
--server None — host or cluster value for the service 💜
--prefix None — prefix for the log, i.e.: "sqlalchemy." ✨

`cinder service-list`

usage: cinder service-list [--host <hostname>] [--binary <binary>]
                           [--withreplication [<True|False>]]

Lists all services, and you can filter by host and service binary 🎀

Optional arguments:

--host <hostname> — host name. Default=None 🌸
--binary <binary> — service binary. Default=None ⭐
--withreplication <True|False> — enables or disables display of Replication info for c-vol services. Default=False 🔥

`cinder service-set-log`

usage: cinder service-set-log
                             [--binary {,*,cinder-api,cinder-volume,cinder-scheduler,cinder-backup}]
                             [--server SERVER] [--prefix PREFIX]
                             <log-level>

Sets the service log level. turning the volume up (or down) on logging 🔊

Positional arguments:

<log-level> — desired log level 🎀

Optional arguments:

--binary None — binary to change 🦋
--server None — host or cluster value for the service 💜
--prefix None — prefix for the log, i.e.: "cinder.volume.drivers." ✨

`cinder set-bootable`

usage: cinder set-bootable <volume> <True|true|False|false>

Update the bootable status of a volume. is it a boot volume or isn't it? you decide. you have the power 👑💅

Positional arguments:

<volume> — ID of the volume to update 🌸
<True|true|False|false> — flag to indicate whether the volume is bootable ⭐

`cinder show`

usage: cinder show <volume>

Shows volume details. the full tea ☕ on a volume 🫶

Positional arguments:

<volume> — name or ID of the volume 🎀

`cinder snapshot-create`

usage: cinder snapshot-create [--name <name>] [--description <description>]
                              [--metadata [<key=value> ...]]
                              <volume>

Creates a snapshot 📸 the way you preserve a moment forever, but for data 💖

Positional arguments:

<volume> — name or ID of the volume to snapshot 🦋

Optional arguments:

--name <name> — snapshot name. Default=None 🌸
--description <description> — snapshot description. Default=None ✨
--metadata <key=value> — snapshot metadata key and value pairs. Default=None 🎀

`cinder snapshot-delete`

usage: cinder snapshot-delete [--force] <snapshot> [<snapshot> ...]

Removes one or more snapshots. plural. multiple. clean slate energy 💀✨

Positional arguments:

<snapshot> — name or ID of the snapshot(s) to delete 🦋

Optional arguments:

--force None — allows deleting a snapshot of a volume when its status is something other than "available" or "error". Default=False ⚠️

`cinder snapshot-list`

cinder snapshot-list [--all-tenants [<0|1>]] [--name <name>]
                     [--status <status>] [--volume-id <volume-id>]
                     [--marker <marker>] [--limit <limit>]
                     [--sort <key>[:<direction>]] [--tenant [<tenant>]]
                     [--metadata [<key=value> ...]]
                     [--filters [<key=value> ...]]
                     [--with-count [<True|False>]]

Okay bestie, this one just lists all the snapshots. All of them. Every last one. 🦋

Optional arguments:

--all-tenants <0|1> — shows the deets for all tenants. Admin only, so if you're not admin… it's giving "locked out of the group chat" 😭
--name <name> — filters results by a name. Default=None. Deprecated alert 🚨 this option is deprecated and will be removed in a newer release. Please use '--filters' option, which was introduced since 3.33 instead.
--status <status> — filters results by a status. Default=None. Also deprecated and also getting removed in a newer release. Same energy: use '--filters' (introduced since 3.33) instead. 💅
--volume-id <volume-id> — filters results by a volume ID. Default=None. Yep, deprecated, yep, being removed in a newer release, yep, please use '--filters' since 3.33 instead. 🫶
--marker <marker> — starts returning snapshots that appear later in the snapshot list than the one represented by this id. Default=None. It's literally "start after this one" energy.
--limit <limit> — the max number of snapshots to return. Default=None. Boundaries, we love them ✨
--sort <key>[:<direction>] — comma-separated list of sort keys and directions in the form <key>[:<asc|desc>]. Valid keys: id, status, size, availability_zone, name, bootable, created_at, reference. Default=None. Sort your life out, iconically. 👑
--tenant <tenant> — display information from a single tenant (Admin only).
--metadata <key=value> — filters results by a metadata key and value pair. Requires volume api version >=3.22. Default=None. Deprecated — will be removed in a newer release. Please use '--filters', introduced since 3.33, instead. 🙈
--filters <key=value> — filter key and value pairs. Please use 'cinder list-filters' to check the enabled filters on the server. Use 'key~=value' for inexact filtering if the key supports it. Default=None. This is the new hotness, bestie 💚
--with-count <True|False> — show the total number of snapshot entities. So useful when pagination is applied in the request. Count them, queen. 🔥

`cinder snapshot-manage`

cinder snapshot-manage [--id-type <id-type>] [--name <name>]
                       [--description <description>]
                       [--metadata [<key=value> ...]]
                       <volume> <identifier>

Manages an existing snapshot — like, adopting one that already exists on the backend into Cinder's whole world. 🧚

Positional arguments:

<volume> — the Cinder volume that already exists in the volume backend.
<identifier> — the name or other identifier for the existing snapshot. This is, and I cannot stress this enough, backend specific. 💀

Optional arguments:

--id-type <id-type> — the type of backend device identifier provided, typically source-name or source-id (Default=source-name).
--name <name> — snapshot name (Default=None).
--description <description> — snapshot description (Default=None).
--metadata <key=value> — metadata key=value pairs (Default=None).

`cinder snapshot-manageable-list`

cinder snapshot-manageable-list [--detailed <detailed>]
                                [--marker <marker>] [--limit <limit>]
                                [--offset <offset>]
                                [--sort <key>[:<direction>]]
                                [--cluster CLUSTER]
                                [<host>]

Lists all the manageable snapshots. Window shopping, basically. 🛍️

Positional arguments:

<host> — the Cinder host on which to list manageable snapshots; takes the form: host@backend-name#pool

Optional arguments:

--detailed <detailed> — returned detailed information (default true).
--marker <marker> — begin returning volumes that appear later in the volume list than the one represented by this reference. This reference should be json like. Default=None. (Yes, it says volumes — we're just relaying the message, don't shoot the messenger 🫠)
--limit <limit> — maximum number of volumes to return. Default=None.
--offset <offset> — number of volumes to skip after the marker. Default=None.
--sort <key>[:<direction>] — comma-separated list of sort keys and directions in the form <key>[:<asc|desc>]. Valid keys: size, reference. Default=None.
--cluster None — the Cinder cluster on which to list manageable snapshots; takes the form: cluster@backend-name#pool

`cinder snapshot-metadata`

cinder snapshot-metadata <snapshot> <action> <key=value>
                         [<key=value> ...]

Sets or deletes snapshot metadata. Set it, unset it, we're flexible. 💅

Positional arguments:

<snapshot> — ID of the snapshot whose metadata we're updating.
<action> — the action. Valid values are "set" or "unset."
<key=value> — the metadata key and value pair to set or unset. For unset, specify only the key. 🎀

`cinder snapshot-metadata-show`

cinder snapshot-metadata-show <snapshot>

Shows snapshot metadata. Peek at the vibes. 👀

Positional arguments:

<snapshot> — ID of snapshot.

`cinder snapshot-metadata-update-all`

cinder snapshot-metadata-update-all <snapshot> <key=value>
                                    [<key=value> ...]

Updates snapshot metadata. All of it. Go off. 🔥

Positional arguments:

<snapshot> — ID of the snapshot whose metadata we're updating.
<key=value> — the metadata key and value pair to update.

`cinder snapshot-rename`

cinder snapshot-rename [--description <description>]
                       <snapshot> [<name>]

Renames a snapshot. New name, same energy. ✨

Positional arguments:

<snapshot> — name or ID of the snapshot.
<name> — new name for the snapshot.

Optional arguments:

--description <description> — snapshot description. Default=None.

`cinder snapshot-reset-state`

cinder snapshot-reset-state [--state <state>]
                            <snapshot> [<snapshot> ...]

Explicitly updates the snapshot state. You're just… telling it what to be. 😳

Positional arguments:

<snapshot> — name or ID of the snapshot to modify.

Optional arguments:

--state <state> — the state to assign to the snapshot. Valid values are "available", "error", "creating", "deleting", and "error_deleting". Default=available.

⚠️ NOTE: this command simply changes the state of the Snapshot in the DataBase with no regard to the actual status. Exercise caution when using. Like, genuinely — it does not check reality. It just types a new word in the DB and walks away. 💀

`cinder snapshot-show`

cinder snapshot-show <snapshot>

Shows snapshot details. The full dossier. 🕵️‍♀️

Positional arguments:

<snapshot> — name or ID of the snapshot.

`cinder snapshot-unmanage`

cinder snapshot-unmanage <snapshot>

Stop managing a snapshot. It's not you, it's… okay it's kind of you. ✌️

Positional arguments:

<snapshot> — name or ID of the snapshot to unmanage.

`cinder summary`

cinder summary [--all-tenants [<0|1>]]

Get a volumes summary. The TL;DR of your storage. 📊

Optional arguments:

--all-tenants <0|1> — shows details for all tenants. Admin only.

`cinder thaw-host`

cinder thaw-host <hostname>

Thaws and enables the specified cinder-volume host. Un-freeze the queen. 🧊➡️🔥

Positional arguments:

<hostname> — host name.

`cinder transfer-accept`

cinder transfer-accept <transfer> <auth_key>

Accepts a volume transfer. Say yes to the volume. 💍

Positional arguments:

<transfer> — ID of the transfer to accept.
<auth_key> — authentication key of the transfer to accept.

`cinder transfer-create`

cinder transfer-create [--name <name>] [--no-snapshots] <volume>

Creates a volume transfer. Pack it up and send it. 📦

Positional arguments:

<volume> — name or ID of the volume to transfer.

Optional arguments:

--name <name> — transfer name. Default=None.
--no-snapshots None — allows or disallows transfer of volumes without snapshots. Default=False.

`cinder transfer-delete`

cinder transfer-delete <transfer> [<transfer> ...]

Undoes a transfer. Never mind, actually. 🙈

Positional arguments:

<transfer> — name or ID of the transfer to delete.

`cinder transfer-list`

cinder transfer-list [--all-tenants [<0|1>]]
                     [--sort <key>[:<direction>]]
                     [--filters [<key=value> ...]]

Lists all transfers. All of them, lined up. 🌈

Optional arguments:

--all-tenants <0|1> — shows details for all tenants. Admin only.
--sort <key>[:<direction>] — sort keys and directions in the form of <key>[:<asc|desc>].
--filters <key=value> — filter key and value pairs.

`cinder transfer-show`

cinder transfer-show <transfer>

Shows transfer details. Receipts, basically. 🧾

Positional arguments:

<transfer> — name or ID of the transfer to accept. (Yes, "accept" — that's what it says, bestie, we don't edit the source 💅)

`cinder type-access-add`

cinder type-access-add --volume-type <volume_type> --project-id
                       <project_id>

Adds volume type access for the given project. Let them in. 🫶

Optional arguments:

--volume-type <volume_type> — volume type name or ID to add access for the given project.
--project-id <project_id> — project ID to add volume type access for.

`cinder type-access-list`

cinder type-access-list --volume-type <volume_type>

Prints access information about the given volume type. Who's allowed in the club. 🎟️

Optional arguments:

--volume-type <volume_type> — filter results by volume type name or ID.

`cinder type-access-remove`

cinder type-access-remove --volume-type <volume_type> --project-id
                          <project_id>

Removes volume type access for the given project. Revoking the invite, lowkey brutal. 😭

Optional arguments:

--volume-type <volume_type> — volume type name or ID to remove access for the given project.
--project-id <project_id> — project ID to remove volume type access for.

`cinder type-create`

cinder type-create [--description <description>]
                   [--is-public <is-public>]
                   <name>

Creates a volume type. Birth of an icon. 👑

Positional arguments:

<name> — name of the new volume type.

Optional arguments:

--description <description> — description of the new volume type.
--is-public <is-public> — make the type accessible to the public (default true).

`cinder type-default`

cinder type-default

List the default volume type. The main character of types. ⭐

`cinder type-delete`

cinder type-delete <vol_type> [<vol_type> ...]

(and that's where this part hands off, bestie — more coming 🦋)

Deletes volume type or types. Poof, gone, bye bestie 👋

Positional arguments:

<vol_type> — Name or ID of the volume type or types you're yeeting. Delete responsibly 💅

`cinder type-key`

cinder type-key <vtype> <action> <key=value> [<key=value> ...]

Sets or unsets extra_spec for a volume type. Think of it as customizing the vibe of a volume type ✨

Positional arguments:

<vtype> — Name or ID of the volume type.
<action> — The action. Valid values are "set" or "unset."
<key=value> — The extra specs key and value pair to set or unset. For unset, specify only the key — no value, she's on a solo journey 🙈

`cinder type-list`

cinder type-list [--filters [<key=value> ...]]

Lists available 'volume types'. A whole lineup, main character energy 👑

Optional arguments:

--filters <key=value> — Filter key and value pairs. Admin only. No sneaking in without the badge 🔐

`cinder type-show`

cinder type-show <volume_type>

Show volume type details. The full lore 🫶

Positional arguments:

<volume_type> — Name or ID of the volume type.

`cinder type-update`

cinder type-update [--name <name>] [--description <description>]
                   [--is-public <is-public>]
                   <id>

Updates volume type name, description, and/or is_public. Glow-up era 🌸

Positional arguments:

<id> — ID of the volume type.

Optional arguments:

--name <name> — Name of the volume type.
--description <description> — Description of the volume type.
--is-public <is-public> — Make type accessible to the public or not. Public or private, choose your era 💖

`cinder unmanage`

cinder unmanage <volume>

Stop managing a volume. It's not you, it's me — Cinder's stepping back 🦋

Positional arguments:

<volume> — Name or ID of the volume to unmanage.

`cinder upload-to-image`

cinder upload-to-image [--force [<True|False>]]
                       [--container-format <container-format>]
                       [--disk-format <disk-format>]
                       [--visibility <public|private|community|shared>]
                       [--protected <True|False>]
                       <volume> <image-name>

Uploads volume to Image Service as an image. Volume to image, a full transformation arc 🔥

Positional arguments:

<volume> — Name or ID of volume to snapshot.
<image-name> — The new image name.

Optional arguments:

--force <True|False> — Enables or disables upload of a volume that is attached to an instance. Default=False. This option may not be supported by your cloud — check before you commit, bestie 😭
--container-format <container-format> — Container format type. Default is bare.
--disk-format <disk-format> — Disk format type. Default is raw.
--visibility <public|private|community|shared> — Set image visibility to public, private, community or shared. Default=private.
--protected <True|False> — Prevents image from being deleted. Default=False. Protective energy, we love to see it 🛡️

`cinder version-list`

cinder version-list

List all API versions. Just vibes and version numbers, no cap ⭐

`cinder work-cleanup`

cinder work-cleanup [--cluster <cluster-name>] [--host <hostname>]
                    [--binary <binary>]
                    [--is-up <True|true|False|false>]
                    [--disabled <True|true|False|false>]
                    [--resource-id <resource-id>]
                    [--resource-type <Volume|Snapshot>]
                    [--service-id <service-id>]

Request cleanup of services with optional filtering. Tidy up, sparkle joy, etc 🧹✨

Optional arguments:

--cluster <cluster-name> — Cluster name. Default=None.
--host <hostname> — Service host name. Default=None.
--binary <binary> — Service binary. Default=None.
--is-up <True|true|False|false> — Filter by up/down status, if set to true services need to be up, if set to false services need to be down. Default is None, which means up/down status is ignored.
--disabled <True|true|False|false> — Filter by disabled status. Default=None.
--resource-id <resource-id> — UUID of a resource to cleanup. Default=None.
--resource-type <Volume|Snapshot> — Type of resource to cleanup.
--service-id <service-id> — The service id field from the DB, not the uuid of the service. Default=None. Important distinction, iykyk 💀

`cinder help`

cinder help [<subcommand>]

Shows help about this program or one of its subcommands. When in doubt, ask for help — literally 🌈

Positional arguments:

<subcommand> — Shows help for <subcommand>.

👑 AUTHOR

OpenStack Contributors

🎀 COPYRIGHT

OpenStack Contributors

aaaand that's the whole page bestie, we ate and left no crumbs 💅✨ This one's version 9.9.0, dated Mar 31, 2026, source CINDER(1) — iconically timeless, fr fr 💜🫶

📦 where this page comes from

epel 10: python3-cinderclient 9.9.0-2.el10_3 · Apache-2.0
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on 2026-11-06: a language model's rewrite of the original, under its terms

CINDER(1)

🦋 cinder(1) — python-cinderclient 🦋

💖 NAME 💖

🫶 CINDER USAGE 🫶

✨ Optional Arguments ✨

🎀 Commands 🎀

💖 COMMAND DETAILS 💖

🎀 cinder absolute-limits

🦋 cinder api-version

🌸 cinder attachment-complete

🍓 cinder attachment-create

💀 cinder attachment-delete

🌈 cinder attachment-list

🧚 cinder attachment-show

💜 cinder attachment-update

🌟 cinder availability-zone-list

🎀 cinder backup-create

🌸 cinder backup-delete

cinder backup-export

cinder backup-import

cinder backup-list

cinder backup-reset-state

cinder backup-restore

cinder backup-show

cinder backup-update

cinder cgsnapshot-create

cinder cgsnapshot-delete

cinder cgsnapshot-list

cinder cgsnapshot-show

cinder cluster-disable

cinder cluster-enable

cinder cluster-list

cinder cluster-show

cinder consisgroup-create

cinder consisgroup-create-from-src

cinder consisgroup-delete

cinder consisgroup-list

cinder consisgroup-show

💅 cinder consisgroup-update

🌸 cinder create

🦋 cinder default-type-list

🎀 cinder default-type-set

✨ cinder default-type-unset

💀 cinder delete

🔐 cinder encryption-type-create

🗑️ cinder encryption-type-delete

📋 cinder encryption-type-list

🔍 cinder encryption-type-show

🛠️ cinder encryption-type-update

📏 cinder extend

🧾 cinder extra-specs-list

🔄 cinder failover-host

💥 cinder force-delete

🧊 cinder freeze-host

📊 cinder get-capabilities

🏊 cinder get-pools

👯 cinder group-create

🌱 cinder group-create-from-src

🗑️ cinder group-delete

🚫 cinder group-disable-replication

cinder group-enable-replication

cinder group-failover-replication

cinder group-list

cinder group-list-replication-targets

cinder group-show

cinder group-snapshot-create

cinder group-snapshot-delete

cinder group-snapshot-list

cinder group-snapshot-show

cinder group-specs-list

cinder group-type-create

cinder group-type-default

cinder group-type-delete

cinder group-type-key

cinder group-type-list

cinder group-type-show

cinder group-type-update

cinder group-update

cinder image-metadata

cinder image-metadata-show

`cinder backup-export`

`cinder backup-import`

`cinder backup-list`

`cinder backup-reset-state`

`cinder backup-restore`

`cinder backup-show`

`cinder backup-update`

`cinder cgsnapshot-create`

`cinder cgsnapshot-delete`

`cinder cgsnapshot-list`

`cinder cgsnapshot-show`

`cinder cluster-disable`

`cinder cluster-enable`

`cinder cluster-list`

`cinder cluster-show`

`cinder consisgroup-create`

`cinder consisgroup-create-from-src`

`cinder consisgroup-delete`

`cinder consisgroup-list`

`cinder consisgroup-show`

💅 `cinder consisgroup-update`

🌸 `cinder create`

🦋 `cinder default-type-list`

🎀 `cinder default-type-set`

✨ `cinder default-type-unset`

💀 `cinder delete`

🔐 `cinder encryption-type-create`

🗑️ `cinder encryption-type-delete`

📋 `cinder encryption-type-list`

🔍 `cinder encryption-type-show`

🛠️ `cinder encryption-type-update`

📏 `cinder extend`

🧾 `cinder extra-specs-list`

🔄 `cinder failover-host`

💥 `cinder force-delete`

🧊 `cinder freeze-host`

📊 `cinder get-capabilities`

🏊 `cinder get-pools`

👯 `cinder group-create`

🌱 `cinder group-create-from-src`

🗑️ `cinder group-delete`

🚫 `cinder group-disable-replication`

🎀 `cinder list-filters`

🦋 `cinder manage`

🌸 `cinder manageable-list`

💜 `cinder message-delete`

🧚 `cinder message-list`

⭐ `cinder message-show`

🌈 `cinder metadata`

🍓 `cinder metadata-show`

👑 `cinder metadata-update-all`

🔥 `cinder migrate`

💖 `cinder qos-associate`

✨ `cinder qos-create`

💀 `cinder qos-delete`

🦋 `cinder qos-disassociate`

🌸 `cinder qos-disassociate-all`

🧚 `cinder qos-get-association`

🎀 `cinder qos-key`

🌈 `cinder qos-list`

🍓 `cinder qos-show`

👑 `cinder quota-class-show`

`cinder quota-class-update`

`cinder quota-defaults`

`cinder quota-delete`

`cinder quota-show`

`cinder quota-update`

`cinder quota-usage`

`cinder rate-limits`

`cinder readonly-mode-update`

`cinder reimage`

`cinder rename`

`cinder reset-state`

`cinder retype`

`cinder revert-to-snapshot`

`cinder service-disable`

`cinder service-enable`

`cinder service-get-log`

`cinder service-list`

`cinder service-set-log`