`orca volume`¶

Manage block storage volumes & snapshots (Cinder).

The reference below is generated from the live CLI by mkdocs-click. It always reflects the version installed.

orca volume¶

Manage block storage volumes & snapshots.

Usage:

orca volume [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

attachment: Manage volume attachments (low-level).
attachment-complete: [deprecated, use 'volume attachment complete' instead]
attachment-create: [deprecated, use 'volume attachment create' instead]
attachment-delete: [deprecated, use 'volume attachment delete' instead]
attachment-list: [deprecated, use 'volume attachment list' instead]
attachment-set: [deprecated, use 'volume attachment set' instead]
attachment-show: [deprecated, use 'volume attachment show' instead]
backend: Inspect Cinder backend driver capabilities (admin).
backup: Manage Cinder backups.
backup-create: [deprecated, use 'volume backup create' instead]
backup-delete: [deprecated, use 'volume backup delete' instead]
backup-list: [deprecated, use 'volume backup list' instead]
backup-restore: [deprecated, use 'volume backup restore' instead]
backup-show: [deprecated, use 'volume backup show' instead]
cluster: Manage Cinder active/active clusters (admin).
create: Create a volume.
delete: Delete a volume.
extend: Extend a volume to a larger size.
group: Manage consistency / generic volume groups.
group-create: [deprecated, use 'volume group create' instead]
group-delete: [deprecated, use 'volume group delete' instead]
group-list: [deprecated, use 'volume group list' instead]
group-show: [deprecated, use 'volume group show' instead]
group-snapshot-create: [deprecated, use 'volume group snapshot create' instead]
group-snapshot-delete: [deprecated, use 'volume group snapshot delete' instead]
group-snapshot-list: [deprecated, use 'volume group snapshot list' instead]
group-snapshot-show: [deprecated, use 'volume group snapshot show' instead]
group-type-create: [deprecated, use 'volume group type create' instead]
group-type-delete: [deprecated, use 'volume group type delete' instead]
group-type-list: [deprecated, use 'volume group type list' instead]
group-type-set: [deprecated, use 'volume group type set' instead]
group-type-show: [deprecated, use 'volume group type show' instead]
group-type-unset: [deprecated, use 'volume group type unset' instead]
group-update: [deprecated, use 'volume group update' instead]
host: Inspect Cinder hosts (admin).
list: List volumes.
log-level: Inspect or change live log levels of Cinder services (admin).
manageable: Discover Cinder-manageable existing backend resources (admin).
message: User-facing Cinder messages (failures, info).
message-delete: [deprecated, use 'volume message delete' instead]
message-list: [deprecated, use 'volume message list' instead]
message-show: [deprecated, use 'volume message show' instead]
migrate: Migrate a volume to a different Cinder host/backend.
pool: Inspect Cinder scheduler backend pools (admin).
qos: QoS specifications.
qos-associate: [deprecated, use 'volume qos associate' instead]
qos-create: [deprecated, use 'volume qos create' instead]
qos-delete: [deprecated, use 'volume qos delete' instead]
qos-disassociate: [deprecated, use 'volume qos disassociate' instead]
qos-list: [deprecated, use 'volume qos list' instead]
qos-set: [deprecated, use 'volume qos set' instead]
qos-show: [deprecated, use 'volume qos show' instead]
resource-filter: List/show server-side filters available for Cinder list APIs (admin).
retype: Change volume type.
revert: Revert a volume to a previous snapshot (OSC-parity alias).
revert-to-snapshot: [deprecated, use 'volume snapshot revert' instead]
service: Cinder backend services (admin).
service-list: [deprecated, use 'volume service list' instead]
service-set: [deprecated, use 'volume service set' instead]
set: Set volume properties, metadata, or flags.
set-bootable: Set bootable flag (deprecated — use 'volume set --bootable').
set-readonly: Set read-only flag (deprecated — use 'volume set --read-only').
show: Show volume details.
snapshot: Manage volume snapshots.
snapshot-create: [deprecated, use 'volume snapshot create' instead]
snapshot-delete: [deprecated, use 'volume snapshot delete' instead]
snapshot-list: [deprecated, use 'volume snapshot list' instead]
snapshot-set: [deprecated, use 'volume snapshot set' instead]
snapshot-show: [deprecated, use 'volume snapshot show' instead]
summary: Show aggregated volume count and total size for the project.
transfer: Volume transfers between projects.
transfer-accept: [deprecated, use 'volume transfer accept' instead]
transfer-create: [deprecated, use 'volume transfer create' instead]
transfer-delete: [deprecated, use 'volume transfer delete' instead]
transfer-list: [deprecated, use 'volume transfer list' instead]
transfer-show: [deprecated, use 'volume transfer show' instead]
tree: Display a volume / snapshot dependency tree.
type: Volume types.
type-access-add: [deprecated, use 'volume type access add' instead]
type-access-list: [deprecated, use 'volume type access list' instead]
type-access-remove: [deprecated, use 'volume type access remove' instead]
type-create: [deprecated, use 'volume type create' instead]
type-delete: [deprecated, use 'volume type delete' instead]
type-list: [deprecated, use 'volume type list' instead]
type-set: [deprecated, use 'volume type set' instead]
type-show: [deprecated, use 'volume type show' instead]
unset: Unset volume metadata keys.
update: Update volume name or description.
upload-to-image: Materialize a volume's data as a downloadable Glance image.

orca volume attachment¶

Manage volume attachments (low-level).

Usage:

orca volume attachment [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

complete: Mark a volume attachment as complete (os-complete action).
create: Create a volume attachment (Cinder v3 attachment API).
delete: Delete a volume attachment.
list: List volume attachments (Cinder v3 attachment API).
set: Update (finalize) a volume attachment with connector info.
show: Show a volume attachment.

orca volume attachment complete¶

Mark a volume attachment as complete (os-complete action).

Usage:

orca volume attachment complete [OPTIONS] ATTACHMENT_ID

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca volume attachment create¶

Create a volume attachment (Cinder v3 attachment API).

Examples: orca volume attachment-create orca volume attachment-create --mode ro orca volume attachment-create --connector '{"host": "myhost"}'

Usage:

orca volume attachment create [OPTIONS] VOLUME_ID INSTANCE_ID

Options:

Name	Type	Description	Default
`--mode`	choice (`rw` \| `ro`)	Attach mode: read-write or read-only.	`rw`
`--connector`	text	Connector info as JSON (host, initiator, etc.).	None
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume attachment delete¶

Delete a volume attachment.

Usage:

orca volume attachment delete [OPTIONS] ATTACHMENT_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume attachment list¶

List volume attachments (Cinder v3 attachment API).

Usage:

orca volume attachment list [OPTIONS]

Options:

Name	Type	Description	Default
`--volume-id`	text	Filter by volume ID.	None
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume attachment set¶

Update (finalize) a volume attachment with connector info.

Usage:

orca volume attachment set [OPTIONS] ATTACHMENT_ID

Options:

Name	Type	Description	Default
`--connector`	text	Updated connector info as JSON.	`Sentinel.UNSET`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume attachment show¶

Show a volume attachment.

Usage:

orca volume attachment show [OPTIONS] ATTACHMENT_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume attachment-complete¶

Mark a volume attachment as complete (os-complete action).

Usage:

orca volume attachment-complete [OPTIONS] ATTACHMENT_ID

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca volume attachment-create¶

Create a volume attachment (Cinder v3 attachment API).

Examples: orca volume attachment-create orca volume attachment-create --mode ro orca volume attachment-create --connector '{"host": "myhost"}'

Usage:

orca volume attachment-create [OPTIONS] VOLUME_ID INSTANCE_ID

Options:

Name	Type	Description	Default
`--mode`	choice (`rw` \| `ro`)	Attach mode: read-write or read-only.	`rw`
`--connector`	text	Connector info as JSON (host, initiator, etc.).	None
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume attachment-delete¶

Delete a volume attachment.

Usage:

orca volume attachment-delete [OPTIONS] ATTACHMENT_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume attachment-list¶

List volume attachments (Cinder v3 attachment API).

Usage:

orca volume attachment-list [OPTIONS]

Options:

Name	Type	Description	Default
`--volume-id`	text	Filter by volume ID.	None
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume attachment-set¶

Update (finalize) a volume attachment with connector info.

Usage:

orca volume attachment-set [OPTIONS] ATTACHMENT_ID

Options:

Name	Type	Description	Default
`--connector`	text	Updated connector info as JSON.	`Sentinel.UNSET`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume attachment-show¶

Show a volume attachment.

Usage:

orca volume attachment-show [OPTIONS] ATTACHMENT_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume backend¶

Inspect Cinder backend driver capabilities (admin).

Usage:

orca volume backend [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

capability: Backend capabilities — OSC volume backend capability show.
pool: Cinder scheduler pools, surfaced under volume backend.

orca volume backend capability¶

Backend capabilities — OSC volume backend capability show.

Usage:

orca volume backend capability [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

capability: Show the capabilities advertised by a backend driver.

orca volume backend capability capability¶

Show the capabilities advertised by a backend driver.

Useful for debugging scheduler decisions or onboarding a new backend. Returns the raw driver capabilities dict.

Example: orca volume backend capability cinder@lvm

Usage:

orca volume backend capability capability [OPTIONS] HOST

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume backend pool¶

Cinder scheduler pools, surfaced under volume backend.

Usage:

orca volume backend pool [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

list: List Cinder scheduler backend pools.

orca volume backend pool list¶

List Cinder scheduler backend pools.

Usage:

orca volume backend pool list [OPTIONS]

Options:

Name	Type	Description	Default
`--detail`	boolean	Include detailed capabilities per pool.	`False`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume backup¶

Manage Cinder backups.

Usage:

orca volume backup [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

create: Create a Cinder backup of a volume.
delete: Delete a volume backup.
list: List Cinder volume backups.
record: Export / import backup records for cross-cloud migration (admin).
restore: Restore a Cinder backup to a volume.
set: Update a backup's name, description, or metadata.
show: Show details of a volume backup.
unset: Remove metadata keys from a backup.

orca volume backup create¶

Create a Cinder backup of a volume.

Examples: orca volume backup-create --name my-backup orca volume backup-create --incremental --wait orca volume backup-create --force # while attached

Usage:

orca volume backup create [OPTIONS] VOLUME_ID

Options:

Name	Type	Description	Default
`--name`	text	Backup name.	None
`--description`	text	Backup description.	None
`--container`	text	Swift container for the backup.	None
`--incremental`	boolean	Create an incremental backup.	`False`
`--force`	boolean	Backup even if the volume is attached (may create inconsistent backup).	`False`
`--snapshot-id`	text	Create backup from a specific snapshot instead of the volume.	None
`--wait`	boolean	Wait until the backup reaches 'available' status.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume backup delete¶

Delete a volume backup.

Usage:

orca volume backup delete [OPTIONS] BACKUP_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--force`	boolean	Force deletion even if backup is not available.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume backup list¶

List Cinder volume backups.

Usage:

orca volume backup list [OPTIONS]

Options:

Name	Type	Description	Default
`--all-projects`	boolean	List backups from all projects (admin).	`False`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume backup record¶

Export / import backup records for cross-cloud migration (admin).

Usage:

orca volume backup record [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

export: Export a backup record (admin) — JSON dump usable to re-import.
import: Recreate a backup entry from a previously exported record (admin).

orca volume backup record export¶

Export a backup record (admin) — JSON dump usable to re-import.

The record contains the metadata needed to recreate the backup entry on another Cinder deployment via volume backup record import (the actual backup data must already live in shared storage like Swift / Ceph).

Examples: orca volume backup record export -o /tmp/rec.json orca volume backup record export | jq .

Usage:

orca volume backup record export [OPTIONS] BACKUP_ID

Options:

Name	Type	Description	Default
`--output`, `-o`	text	Write the record to a file (JSON) instead of stdout.	None
`--help`	boolean	Show this message and exit.	`False`

orca volume backup record import¶

Recreate a backup entry from a previously exported record (admin).

Two ways to feed the record: either pass --backup-service / --backup-url directly, or point --file at the JSON file produced by volume backup record export.

Examples: orca volume backup record import -f /tmp/rec.json orca volume backup record import --backup-service swift --backup-url

Usage:

orca volume backup record import [OPTIONS]

Options:

Name	Type	Description	Default
`--backup-service`	text	Backup service identifier from the exported record (e.g. `cinder.backup.drivers.swift.SwiftBackupDriver`).	`Sentinel.UNSET`
`--backup-url`	text	The base64 `backup_url` from the exported record. Mutually exclusive with --file.	None
`--file`, `-f`	path	Path to a JSON file produced by `volume backup record export` — reads `backup_service` and `backup_url` from it (overrides --backup-service / --backup-url).	None
`--help`	boolean	Show this message and exit.	`False`

orca volume backup restore¶

Restore a Cinder backup to a volume.

If --volume-id is not specified, a new volume is created.

Examples: orca volume backup-restore orca volume backup-restore --name restored-vol --wait

Usage:

orca volume backup restore [OPTIONS] BACKUP_ID

Options:

Name	Type	Description	Default
`--volume-id`	text	Restore to an existing volume ID (must be same size).	None
`--name`	text	Name for the new restored volume.	None
`--wait`	boolean	Wait until the restored volume is available.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume backup set¶

Update a backup's name, description, or metadata.

Usage:

orca volume backup set [OPTIONS] BACKUP_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--property`	text	Metadata key=value (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume backup show¶

Show details of a volume backup.

Usage:

orca volume backup show [OPTIONS] BACKUP_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume backup unset¶

Remove metadata keys from a backup.

Usage:

orca volume backup unset [OPTIONS] BACKUP_ID

Options:

Name	Type	Description	Default
`--property`	text	Metadata key to remove (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume backup-create¶

Create a Cinder backup of a volume.

Examples: orca volume backup-create --name my-backup orca volume backup-create --incremental --wait orca volume backup-create --force # while attached

Usage:

orca volume backup-create [OPTIONS] VOLUME_ID

Options:

Name	Type	Description	Default
`--name`	text	Backup name.	None
`--description`	text	Backup description.	None
`--container`	text	Swift container for the backup.	None
`--incremental`	boolean	Create an incremental backup.	`False`
`--force`	boolean	Backup even if the volume is attached (may create inconsistent backup).	`False`
`--snapshot-id`	text	Create backup from a specific snapshot instead of the volume.	None
`--wait`	boolean	Wait until the backup reaches 'available' status.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume backup-delete¶

Delete a volume backup.

Usage:

orca volume backup-delete [OPTIONS] BACKUP_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--force`	boolean	Force deletion even if backup is not available.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume backup-list¶

List Cinder volume backups.

Usage:

orca volume backup-list [OPTIONS]

Options:

Name	Type	Description	Default
`--all-projects`	boolean	List backups from all projects (admin).	`False`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume backup-restore¶

Restore a Cinder backup to a volume.

If --volume-id is not specified, a new volume is created.

Examples: orca volume backup-restore orca volume backup-restore --name restored-vol --wait

Usage:

orca volume backup-restore [OPTIONS] BACKUP_ID

Options:

Name	Type	Description	Default
`--volume-id`	text	Restore to an existing volume ID (must be same size).	None
`--name`	text	Name for the new restored volume.	None
`--wait`	boolean	Wait until the restored volume is available.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume backup-show¶

Show details of a volume backup.

Usage:

orca volume backup-show [OPTIONS] BACKUP_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume cluster¶

Manage Cinder active/active clusters (admin).

Maps to OSC openstack block storage cluster …. Requires Cinder micro-version >= 3.7 on the cloud.

Usage:

orca volume cluster [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

list: List Cinder clusters.
set: Enable/disable a cluster or set a disable-reason.
show: Show one Cinder cluster.

orca volume cluster list¶

List Cinder clusters.

Usage:

orca volume cluster list [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Filter by cluster name.	`Sentinel.UNSET`
`--binary`	text	Filter by service binary (e.g. cinder-volume).	`Sentinel.UNSET`
`--detail`	boolean	Include extended fields.	`False`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume cluster set¶

Enable/disable a cluster or set a disable-reason.

Usage:

orca volume cluster set [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--binary`	text	Service binary (required if ambiguous).	`Sentinel.UNSET`
`--disable`	boolean	Disable the cluster.	None
`--enable`	boolean	Enable the cluster.	None
`--disable-reason`	text	Reason recorded when disabling.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume cluster show¶

Show one Cinder cluster.

Usage:

orca volume cluster show [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--binary`	text	Disambiguate when several binaries share a cluster name.	`Sentinel.UNSET`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume create¶

Create a volume.

Interactive wizard: orca volume create -i

Usage:

orca volume create [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Volume name.	None
`--size`	integer	Size in GB.	None
`--type`	text	Volume type.	None
`--description`	text	Volume description.	None
`--snapshot-id`	text	Create from snapshot.	None
`--source-vol`	text	Create from existing volume (clone).	None
`--image-id`	text	Create from image.	None
`--wait`	boolean	Wait until the volume reaches 'available' status.	`False`
`--interactive`, `-i`	boolean	Step-by-step wizard — choose name, size, and type interactively.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume delete¶

Delete a volume.

Usage:

orca volume delete [OPTIONS] VOLUME_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--dry-run`	boolean	Show what would be deleted without deleting.	`False`
`--wait`	boolean	Wait until the volume is fully deleted.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume extend¶

Extend a volume to a larger size.

Usage:

orca volume extend [OPTIONS] VOLUME_ID

Options:

Name	Type	Description	Default
`--size`	integer	New size in GB (must be larger).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume group¶

Manage consistency / generic volume groups.

Usage:

orca volume group [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

create: Create a volume group.
delete: Delete a volume group.
failover: Fail a replicated group over to its secondary backend (admin).
list: List volume groups.
set: Update a volume group (OSC-parity alias for group update).
show: Show a volume group.
snapshot: Group snapshots — atomic snapshots across a group of volumes.
type: Group types.
update: Update a volume group — rename or add/remove volumes.

orca volume group create¶

Create a volume group.

Example: orca volume group-create my-group \ --group-type \ --volume-type

Usage:

orca volume group create [OPTIONS] [NAME]

Options:

Name	Type	Description	Default
`--group-type`	text	Group type ID.	`Sentinel.UNSET`
`--volume-type`	text	Volume type ID (repeatable).	`Sentinel.UNSET`
`--description`	text	Description.	None
`--availability-zone`	text	Availability zone.	None
`--help`	boolean	Show this message and exit.	`False`

orca volume group delete¶

Delete a volume group.

Example: orca volume group-delete orca volume group-delete --delete-volumes

Usage:

orca volume group delete [OPTIONS] GROUP_ID

Options:

Name	Type	Description	Default
`--delete-volumes`	boolean	Also delete all volumes in the group.	`False`
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume group failover¶

Fail a replicated group over to its secondary backend (admin).

Triggers Cinder's failover_replication group action. The group must have replication_status == enabled on a replication- capable driver.

Examples: orca volume group failover orca volume group failover --secondary-backend-id ceph-dr orca volume group failover --allow-attached-volume

Usage:

orca volume group failover [OPTIONS] GROUP_ID

Options:

Name	Type	Description	Default
`--secondary-backend-id`	text	Target replication backend ID. Omit to use the configured default.	None
`--allow-attached-volume`	boolean	Permit failover even if the group has attached volumes (dangerous on async replication — data loss risk).	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume group list¶

List volume groups.

Usage:

orca volume group list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume group set¶

Update a volume group (OSC-parity alias for group update).

Usage:

orca volume group set [OPTIONS] GROUP_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--add-volume`	text	Volume ID to add to the group (repeatable).	`Sentinel.UNSET`
`--remove-volume`	text	Volume ID to remove from the group (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume group show¶

Show a volume group.

Usage:

orca volume group show [OPTIONS] GROUP_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume group snapshot¶

Group snapshots — atomic snapshots across a group of volumes.

Usage:

orca volume group snapshot [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

create: Create a snapshot of a volume group.
delete: Delete a volume group snapshot.
list: List volume group snapshots.
show: Show a volume group snapshot.

orca volume group snapshot create¶

Create a snapshot of a volume group.

Usage:

orca volume group snapshot create [OPTIONS] GROUP_ID

Options:

Name	Type	Description	Default
`--name`	text	Snapshot name.	None
`--description`	text	Snapshot description.	None
`--help`	boolean	Show this message and exit.	`False`

orca volume group snapshot delete¶

Delete a volume group snapshot.

Usage:

orca volume group snapshot delete [OPTIONS] GROUP_SNAPSHOT_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume group snapshot list¶

List volume group snapshots.

Usage:

orca volume group snapshot list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume group snapshot show¶

Show a volume group snapshot.

Usage:

orca volume group snapshot show [OPTIONS] GROUP_SNAPSHOT_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume group type¶

Group types.

Usage:

orca volume group type [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

create: Create a volume group type.
delete: Delete a volume group type.
list: List volume group types.
set: Update a volume group type.
show: Show a volume group type.
unset: Unset group spec properties on a group type.

orca volume group type create¶

Create a volume group type.

Usage:

orca volume group type create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--description`	text	Group type description.	None
`--public` / `--private`	boolean	Public or private group type.	`True`
`--help`	boolean	Show this message and exit.	`False`

orca volume group type delete¶

Delete a volume group type.

Usage:

orca volume group type delete [OPTIONS] GROUP_TYPE_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume group type list¶

List volume group types.

Usage:

orca volume group type list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume group type set¶

Update a volume group type.

Usage:

orca volume group type set [OPTIONS] GROUP_TYPE_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--public` / `--private`	boolean	Change visibility.	None
`--property`	text	Group spec key=value (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume group type show¶

Show a volume group type.

Usage:

orca volume group type show [OPTIONS] GROUP_TYPE_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume group type unset¶

Unset group spec properties on a group type.

Usage:

orca volume group type unset [OPTIONS] GROUP_TYPE_ID

Options:

Name	Type	Description	Default
`--property`	text	Group spec key to remove (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume group update¶

Update a volume group — rename or add/remove volumes.

Examples: orca volume group-update --name new-name orca volume group-update --add-volume orca volume group-update --remove-volume

Usage:

orca volume group update [OPTIONS] GROUP_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--add-volume`	text	Volume ID to add to the group (repeatable).	`Sentinel.UNSET`
`--remove-volume`	text	Volume ID to remove from the group (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume group-create¶

Create a volume group.

Example: orca volume group-create my-group \ --group-type \ --volume-type

Usage:

orca volume group-create [OPTIONS] [NAME]

Options:

Name	Type	Description	Default
`--group-type`	text	Group type ID.	`Sentinel.UNSET`
`--volume-type`	text	Volume type ID (repeatable).	`Sentinel.UNSET`
`--description`	text	Description.	None
`--availability-zone`	text	Availability zone.	None
`--help`	boolean	Show this message and exit.	`False`

orca volume group-delete¶

Delete a volume group.

Example: orca volume group-delete orca volume group-delete --delete-volumes

Usage:

orca volume group-delete [OPTIONS] GROUP_ID

Options:

Name	Type	Description	Default
`--delete-volumes`	boolean	Also delete all volumes in the group.	`False`
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume group-list¶

List volume groups.

Usage:

orca volume group-list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume group-show¶

Show a volume group.

Usage:

orca volume group-show [OPTIONS] GROUP_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume group-snapshot-create¶

Create a snapshot of a volume group.

Usage:

orca volume group-snapshot-create [OPTIONS] GROUP_ID

Options:

Name	Type	Description	Default
`--name`	text	Snapshot name.	None
`--description`	text	Snapshot description.	None
`--help`	boolean	Show this message and exit.	`False`

orca volume group-snapshot-delete¶

Delete a volume group snapshot.

Usage:

orca volume group-snapshot-delete [OPTIONS] GROUP_SNAPSHOT_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume group-snapshot-list¶

List volume group snapshots.

Usage:

orca volume group-snapshot-list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume group-snapshot-show¶

Show a volume group snapshot.

Usage:

orca volume group-snapshot-show [OPTIONS] GROUP_SNAPSHOT_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume group-type-create¶

Create a volume group type.

Usage:

orca volume group-type-create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--description`	text	Group type description.	None
`--public` / `--private`	boolean	Public or private group type.	`True`
`--help`	boolean	Show this message and exit.	`False`

orca volume group-type-delete¶

Delete a volume group type.

Usage:

orca volume group-type-delete [OPTIONS] GROUP_TYPE_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume group-type-list¶

List volume group types.

Usage:

orca volume group-type-list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume group-type-set¶

Update a volume group type.

Usage:

orca volume group-type-set [OPTIONS] GROUP_TYPE_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--public` / `--private`	boolean	Change visibility.	None
`--property`	text	Group spec key=value (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume group-type-show¶

Show a volume group type.

Usage:

orca volume group-type-show [OPTIONS] GROUP_TYPE_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume group-type-unset¶

Unset group spec properties on a group type.

Usage:

orca volume group-type-unset [OPTIONS] GROUP_TYPE_ID

Options:

Name	Type	Description	Default
`--property`	text	Group spec key to remove (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume group-update¶

Update a volume group — rename or add/remove volumes.

Examples: orca volume group-update --name new-name orca volume group-update --add-volume orca volume group-update --remove-volume

Usage:

orca volume group-update [OPTIONS] GROUP_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--add-volume`	text	Volume ID to add to the group (repeatable).	`Sentinel.UNSET`
`--remove-volume`	text	Volume ID to remove from the group (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume host¶

Inspect Cinder hosts (admin).

Usage:

orca volume host [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

list: List Cinder hosts.
set: Enable / disable / freeze a Cinder host (admin).

orca volume host list¶

List Cinder hosts.

Usage:

orca volume host list [OPTIONS]

Options:

Name	Type	Description	Default
`--zone`	text	Filter by availability zone.	None
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume host set¶

Enable / disable / freeze a Cinder host (admin).

OSC parity with openstack volume host set. Acts on the cinder-volume service hosted by HOST.

Examples: orca volume host set cinder@lvm#LVM --disable --disabled-reason "maintenance" orca volume host set cinder@lvm#LVM --enable orca volume host set cinder@lvm#LVM --freeze orca volume host set cinder@lvm#LVM --thaw

Usage:

orca volume host set [OPTIONS] HOST

Options:

Name	Type	Description	Default
`--enable`	text	Enable the host's volume service.	`Sentinel.UNSET`
`--disable`	text	Disable the host's volume service.	`Sentinel.UNSET`
`--disabled-reason`	text	Reason for disabling (sets disable-log-reason).	None
`--freeze`	text	Freeze the host (block new attaches, allow existing ones).	`Sentinel.UNSET`
`--thaw`	text	Thaw a previously frozen host.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume list¶

List volumes.

Usage:

orca volume list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume log-level¶

Inspect or change live log levels of Cinder services (admin).

Maps to OSC openstack block storage log level …. Requires Cinder micro-version >= 3.32.

Usage:

orca volume log-level [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

list: List current log levels per service / logger.
set: Change the runtime log level of a Cinder service.

orca volume log-level list¶

List current log levels per service / logger.

Usage:

orca volume log-level list [OPTIONS]

Options:

Name	Type	Description	Default
`--binary`	text	Filter by service binary (cinder-api, cinder-volume, …).	`Sentinel.UNSET`
`--server`	text	Filter by host.	`Sentinel.UNSET`
`--prefix`	text	Filter by logger prefix.	`Sentinel.UNSET`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume log-level set¶

Change the runtime log level of a Cinder service.

Usage:

orca volume log-level set [OPTIONS] {info|warning|error|debug}

Options:

Name	Type	Description	Default
`--binary`	text	Restrict to one service binary.	`Sentinel.UNSET`
`--server`	text	Restrict to one host.	`Sentinel.UNSET`
`--prefix`	text	Restrict to one logger prefix.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume manageable¶

Discover Cinder-manageable existing backend resources (admin).

Maps to OSC openstack block storage volume manageable list.

Usage:

orca volume manageable [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

list: List volumes on the backend that are not (yet) managed by Cinder.

orca volume manageable list¶

List volumes on the backend that are not (yet) managed by Cinder.

Usage:

orca volume manageable list [OPTIONS]

Options:

Name	Type	Description	Default
`--host`	text	Filter by Cinder host (required on most backends).	`Sentinel.UNSET`
`--cluster`	text	Filter by cluster name.	`Sentinel.UNSET`
`--detail`	boolean	Include extra backend fields.	`False`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume message¶

User-facing Cinder messages (failures, info).

Usage:

orca volume message [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

delete: Delete a Cinder error message.
list: List Cinder error messages.
show: Show a Cinder error message.

orca volume message delete¶

Delete a Cinder error message.

Usage:

orca volume message delete [OPTIONS] MESSAGE_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume message list¶

List Cinder error messages.

Usage:

orca volume message list [OPTIONS]

Options:

Name	Type	Description	Default
`--resource-id`	text	Filter by resource UUID.	None
`--resource-type`	choice (`VOLUME` \| `SNAPSHOT` \| `BACKUP` \| `GROUP`)	Filter by resource type.	None
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume message show¶

Show a Cinder error message.

Usage:

orca volume message show [OPTIONS] MESSAGE_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume message-delete¶

Delete a Cinder error message.

Usage:

orca volume message-delete [OPTIONS] MESSAGE_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume message-list¶

List Cinder error messages.

Usage:

orca volume message-list [OPTIONS]

Options:

Name	Type	Description	Default
`--resource-id`	text	Filter by resource UUID.	None
`--resource-type`	choice (`VOLUME` \| `SNAPSHOT` \| `BACKUP` \| `GROUP`)	Filter by resource type.	None
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume message-show¶

Show a Cinder error message.

Usage:

orca volume message-show [OPTIONS] MESSAGE_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume migrate¶

Migrate a volume to a different Cinder host/backend.

Example: orca volume migrate --host cinder@lvm2#LVM2

Usage:

orca volume migrate [OPTIONS] VOLUME_ID

Options:

Name	Type	Description	Default
`--host`	text	Destination host (e.g. cinder@lvm#LVM).	`Sentinel.UNSET`
`--force-host-copy`	boolean	Bypass the driver, force host-level copy.	`False`
`--lock-volume`	boolean	Lock the volume during migration.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume pool¶

Inspect Cinder scheduler backend pools (admin).

Usage:

orca volume pool [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

list: List Cinder scheduler backend pools.

orca volume pool list¶

List Cinder scheduler backend pools.

Usage:

orca volume pool list [OPTIONS]

Options:

Name	Type	Description	Default
`--detail`	boolean	Include detailed capabilities per pool.	`False`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume qos¶

QoS specifications.

Usage:

orca volume qos [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

associate: Associate a QoS spec with a volume type.
create: Create a volume QoS spec.
delete: Delete a volume QoS spec.
disassociate: Disassociate a QoS spec from a volume type.
list: List volume QoS specs.
set: Add or update keys on a volume QoS spec.
show: Show volume QoS spec details.
unset: Remove keys from a volume QoS spec.

orca volume qos associate¶

Associate a QoS spec with a volume type.

Usage:

orca volume qos associate [OPTIONS] QOS_ID TYPE_ID

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca volume qos create¶

Create a volume QoS spec.

Example: orca volume qos-create my-qos --consumer back-end \ --property total_iops_sec=1000

Usage:

orca volume qos create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--consumer`	choice (`front-end` \| `back-end` \| `both`)	Consumer of the QoS.	`both`
`--property`	text	QoS spec key=value (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume qos delete¶

Delete a volume QoS spec.

Usage:

orca volume qos delete [OPTIONS] QOS_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--force`	boolean	Delete even if associated with a volume type.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume qos disassociate¶

Disassociate a QoS spec from a volume type.

Usage:

orca volume qos disassociate [OPTIONS] QOS_ID TYPE_ID

Options:

Name	Type	Description	Default
`--all`	boolean	Disassociate from all volume types.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume qos list¶

List volume QoS specs.

Usage:

orca volume qos list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume qos set¶

Add or update keys on a volume QoS spec.

Usage:

orca volume qos set [OPTIONS] QOS_ID

Options:

Name	Type	Description	Default
`--property`	text	QoS spec key=value to add or update (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume qos show¶

Show volume QoS spec details.

Usage:

orca volume qos show [OPTIONS] QOS_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume qos unset¶

Remove keys from a volume QoS spec.

Example: orca volume qos unset --property total_iops_sec

Usage:

orca volume qos unset [OPTIONS] QOS_ID

Options:

Name	Type	Description	Default
`--property`	text	QoS spec key to remove (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume qos-associate¶

Associate a QoS spec with a volume type.

Usage:

orca volume qos-associate [OPTIONS] QOS_ID TYPE_ID

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca volume qos-create¶

Create a volume QoS spec.

Example: orca volume qos-create my-qos --consumer back-end \ --property total_iops_sec=1000

Usage:

orca volume qos-create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--consumer`	choice (`front-end` \| `back-end` \| `both`)	Consumer of the QoS.	`both`
`--property`	text	QoS spec key=value (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume qos-delete¶

Delete a volume QoS spec.

Usage:

orca volume qos-delete [OPTIONS] QOS_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--force`	boolean	Delete even if associated with a volume type.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume qos-disassociate¶

Disassociate a QoS spec from a volume type.

Usage:

orca volume qos-disassociate [OPTIONS] QOS_ID TYPE_ID

Options:

Name	Type	Description	Default
`--all`	boolean	Disassociate from all volume types.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume qos-list¶

List volume QoS specs.

Usage:

orca volume qos-list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume qos-set¶

Add or update keys on a volume QoS spec.

Usage:

orca volume qos-set [OPTIONS] QOS_ID

Options:

Name	Type	Description	Default
`--property`	text	QoS spec key=value to add or update (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume qos-show¶

Show volume QoS spec details.

Usage:

orca volume qos-show [OPTIONS] QOS_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume resource-filter¶

List/show server-side filters available for Cinder list APIs (admin).

Maps to OSC openstack block storage resource filter ….

Usage:

orca volume resource-filter [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

list: List all resource types that support server-side filters.
show: Show filters available for one resource type.

List all resource types that support server-side filters.

Usage:

orca volume resource-filter list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume resource-filter show¶

Show filters available for one resource type.

Usage:

orca volume resource-filter show [OPTIONS] RESOURCE

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume retype¶

Change volume type.

Usage:

orca volume retype [OPTIONS] VOLUME_ID

Options:

Name	Type	Description	Default
`--type`	text	New volume type.	`Sentinel.UNSET`
`--migration-policy`	choice (`never` \| `on-demand`)	Migration policy.	`never`
`--help`	boolean	Show this message and exit.	`False`

orca volume revert¶

Revert a volume to a previous snapshot (OSC-parity alias).

Equivalent to orca volume snapshot revert <volume-id> <snapshot-id>; exposed at the top level for parity with openstack volume revert.

Usage:

orca volume revert [OPTIONS] VOLUME_ID SNAPSHOT_ID

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca volume revert-to-snapshot¶

Revert a volume to a previous snapshot.

The volume must be in 'available' status and the snapshot must be the most recent one for this volume.

Example: orca volume snapshot revert

Usage:

orca volume revert-to-snapshot [OPTIONS] VOLUME_ID SNAPSHOT_ID

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca volume service¶

Cinder backend services (admin).

Usage:

orca volume service [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

list: List Cinder services.
set: Enable or disable a Cinder service.

orca volume service list¶

List Cinder services.

Usage:

orca volume service list [OPTIONS]

Options:

Name	Type	Description	Default
`--host`	text	Filter by host.	None
`--binary`	text	Filter by binary (e.g. cinder-volume).	None
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume service set¶

Enable or disable a Cinder service.

Usage:

orca volume service set [OPTIONS] HOST BINARY

Options:

Name	Type	Description	Default
`--enable`	text	Enable the service.	`Sentinel.UNSET`
`--disable`	text	Disable the service.	`Sentinel.UNSET`
`--disabled-reason`	text	Reason for disabling.	None
`--help`	boolean	Show this message and exit.	`False`

orca volume service-list¶

List Cinder services.

Usage:

orca volume service-list [OPTIONS]

Options:

Name	Type	Description	Default
`--host`	text	Filter by host.	None
`--binary`	text	Filter by binary (e.g. cinder-volume).	None
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume service-set¶

Enable or disable a Cinder service.

Usage:

orca volume service-set [OPTIONS] HOST BINARY

Options:

Name	Type	Description	Default
`--enable`	text	Enable the service.	`Sentinel.UNSET`
`--disable`	text	Disable the service.	`Sentinel.UNSET`
`--disabled-reason`	text	Reason for disabling.	None
`--help`	boolean	Show this message and exit.	`False`

orca volume set¶

Set volume properties, metadata, or flags.

Examples: orca volume set --name new-name orca volume set --property env=prod --property team=infra orca volume set --bootable orca volume set --read-only

Usage:

orca volume set [OPTIONS] VOLUME_ID

Options:

Name	Type	Description	Default
`--property`	text	Metadata key=value pair (repeatable).	`Sentinel.UNSET`
`--name`	text	New name.	None
`--description`	text	New description.	None
`--bootable` / `--no-bootable`	boolean	Mark volume as bootable or non-bootable.	None
`--read-only` / `--no-read-only`	boolean	Mark volume as read-only or read-write.	None
`--help`	boolean	Show this message and exit.	`False`

orca volume set-bootable¶

Set bootable flag (deprecated — use 'volume set --bootable').

Usage:

orca volume set-bootable [OPTIONS] VOLUME_ID

Options:

Name	Type	Description	Default
`--bootable` / `--no-bootable`	boolean	Mark volume as bootable or non-bootable.	`True`
`--help`	boolean	Show this message and exit.	`False`

orca volume set-readonly¶

Set read-only flag (deprecated — use 'volume set --read-only').

Usage:

orca volume set-readonly [OPTIONS] VOLUME_ID

Options:

Name	Type	Description	Default
`--readonly` / `--no-readonly`	boolean	Mark volume as read-only or read-write.	`True`
`--help`	boolean	Show this message and exit.	`False`

orca volume show¶

Show volume details.

Usage:

orca volume show [OPTIONS] VOLUME_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume snapshot¶

Manage volume snapshots.

Usage:

orca volume snapshot [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

create: Create a snapshot of a volume (accepts UUID or name).
delete: Delete a volume snapshot.
list: List volume snapshots.
manageable: Discover Cinder-manageable existing snapshots on the backend.
revert: Revert a volume to a previous snapshot.
set: Update a snapshot's name, description, or metadata.
show: Show snapshot details.
unset: Remove metadata keys from a snapshot.

orca volume snapshot create¶

Create a snapshot of a volume (accepts UUID or name).

Usage:

orca volume snapshot create [OPTIONS] VOLUME_ID_OR_NAME

Options:

Name	Type	Description	Default
`--name`	text	Snapshot name.	`Sentinel.UNSET`
`--description`	text	Snapshot description.	None
`--force`	boolean	Force snapshot of in-use volume.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume snapshot delete¶

Delete a volume snapshot.

Usage:

orca volume snapshot delete [OPTIONS] SNAPSHOT_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume snapshot list¶

List volume snapshots.

Usage:

orca volume snapshot list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume snapshot manageable¶

Discover Cinder-manageable existing snapshots on the backend.

Usage:

orca volume snapshot manageable [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

list: List snapshots on the backend that are not (yet) managed by Cinder.

orca volume snapshot manageable list¶

List snapshots on the backend that are not (yet) managed by Cinder.

Usage:

orca volume snapshot manageable list [OPTIONS]

Options:

Name	Type	Description	Default
`--host`	text	Filter by Cinder host.	`Sentinel.UNSET`
`--cluster`	text	Filter by cluster name.	`Sentinel.UNSET`
`--detail`	boolean	Include extra backend fields.	`False`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume snapshot revert¶

Revert a volume to a previous snapshot.

The volume must be in 'available' status and the snapshot must be the most recent one for this volume.

Example: orca volume snapshot revert

Usage:

orca volume snapshot revert [OPTIONS] VOLUME_ID SNAPSHOT_ID

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca volume snapshot set¶

Update a snapshot's name, description, or metadata.

Usage:

orca volume snapshot set [OPTIONS] SNAPSHOT_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--property`	text	Metadata key=value (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume snapshot show¶

Show snapshot details.

Usage:

orca volume snapshot show [OPTIONS] SNAPSHOT_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume snapshot unset¶

Remove metadata keys from a snapshot.

Example: orca volume snapshot unset --property obsolete --property draft

Usage:

orca volume snapshot unset [OPTIONS] SNAPSHOT_ID

Options:

Name	Type	Description	Default
`--property`	text	Metadata key to remove (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume snapshot-create¶

Create a snapshot of a volume (accepts UUID or name).

Usage:

orca volume snapshot-create [OPTIONS] VOLUME_ID_OR_NAME

Options:

Name	Type	Description	Default
`--name`	text	Snapshot name.	`Sentinel.UNSET`
`--description`	text	Snapshot description.	None
`--force`	boolean	Force snapshot of in-use volume.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume snapshot-delete¶

Delete a volume snapshot.

Usage:

orca volume snapshot-delete [OPTIONS] SNAPSHOT_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume snapshot-list¶

List volume snapshots.

Usage:

orca volume snapshot-list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume snapshot-set¶

Update a snapshot's name, description, or metadata.

Usage:

orca volume snapshot-set [OPTIONS] SNAPSHOT_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--property`	text	Metadata key=value (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume snapshot-show¶

Show snapshot details.

Usage:

orca volume snapshot-show [OPTIONS] SNAPSHOT_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume summary¶

Show aggregated volume count and total size for the project.

Usage:

orca volume summary [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume transfer¶

Volume transfers between projects.

Usage:

orca volume transfer [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

accept: Accept a volume transfer request.
create: Create a volume transfer request.
delete: Delete a volume transfer request.
list: List volume transfer requests.
request: OSC parity alias — same callbacks as volume transfer.
show: Show a volume transfer request.

orca volume transfer accept¶

Accept a volume transfer request.

Usage:

orca volume transfer accept [OPTIONS] TRANSFER_ID AUTH_KEY

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca volume transfer create¶

Create a volume transfer request.

Usage:

orca volume transfer create [OPTIONS] VOLUME_ID

Options:

Name	Type	Description	Default
`--name`	text	Transfer name.	None
`--help`	boolean	Show this message and exit.	`False`

orca volume transfer delete¶

Delete a volume transfer request.

Usage:

orca volume transfer delete [OPTIONS] TRANSFER_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume transfer list¶

List volume transfer requests.

Usage:

orca volume transfer list [OPTIONS]

Options:

Name	Type	Description	Default
`--all-projects`	boolean	List transfers from all projects (admin).	`False`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume transfer request¶

OSC parity alias — same callbacks as volume transfer.

Usage:

orca volume transfer request [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

accept: Accept a volume transfer request.
create: Create a volume transfer request.
delete: Delete a volume transfer request.
list: List volume transfer requests.
show: Show a volume transfer request.

orca volume transfer request accept¶

Accept a volume transfer request.

Usage:

orca volume transfer request accept [OPTIONS] TRANSFER_ID AUTH_KEY

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca volume transfer request create¶

Create a volume transfer request.

Usage:

orca volume transfer request create [OPTIONS] VOLUME_ID

Options:

Name	Type	Description	Default
`--name`	text	Transfer name.	None
`--help`	boolean	Show this message and exit.	`False`

orca volume transfer request delete¶

Delete a volume transfer request.

Usage:

orca volume transfer request delete [OPTIONS] TRANSFER_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume transfer request list¶

List volume transfer requests.

Usage:

orca volume transfer request list [OPTIONS]

Options:

Name	Type	Description	Default
`--all-projects`	boolean	List transfers from all projects (admin).	`False`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume transfer request show¶

Show a volume transfer request.

Usage:

orca volume transfer request show [OPTIONS] TRANSFER_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume transfer show¶

Show a volume transfer request.

Usage:

orca volume transfer show [OPTIONS] TRANSFER_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume transfer-accept¶

Accept a volume transfer request.

Usage:

orca volume transfer-accept [OPTIONS] TRANSFER_ID AUTH_KEY

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca volume transfer-create¶

Create a volume transfer request.

Usage:

orca volume transfer-create [OPTIONS] VOLUME_ID

Options:

Name	Type	Description	Default
`--name`	text	Transfer name.	None
`--help`	boolean	Show this message and exit.	`False`

orca volume transfer-delete¶

Delete a volume transfer request.

Usage:

orca volume transfer-delete [OPTIONS] TRANSFER_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume transfer-list¶

List volume transfer requests.

Usage:

orca volume transfer-list [OPTIONS]

Options:

Name	Type	Description	Default
`--all-projects`	boolean	List transfers from all projects (admin).	`False`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume transfer-show¶

Show a volume transfer request.

Usage:

orca volume transfer-show [OPTIONS] TRANSFER_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume tree¶

Display a volume / snapshot dependency tree.

Shows every volume with its snapshots, child volumes (clones), and server attachments — making it easy to debug chains and see what depends on what.

Examples: orca volume tree orca volume tree --volume-id

Usage:

orca volume tree [OPTIONS]

Options:

Name	Type	Description	Default
`--volume-id`	text	Show only this volume and its snapshots.	None
`--help`	boolean	Show this message and exit.	`False`

orca volume type¶

Volume types.

Usage:

orca volume type [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

access: Project-level access to a volume type.
create: Create a volume type.
delete: Delete a volume type.
list: List volume types.
set: Update a volume type.
show: Show volume type details.
unset: Remove extra-spec keys from a volume type.

orca volume type access¶

Project-level access to a volume type.

Usage:

orca volume type access [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

add: Grant a project access to a private volume type.
list: List projects that have access to a private volume type.
remove: Revoke a project's access to a private volume type.

orca volume type access add¶

Grant a project access to a private volume type.

Usage:

orca volume type access add [OPTIONS] TYPE_ID PROJECT_ID

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca volume type access list¶

List projects that have access to a private volume type.

Usage:

orca volume type access list [OPTIONS] TYPE_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume type access remove¶

Revoke a project's access to a private volume type.

Usage:

orca volume type access remove [OPTIONS] TYPE_ID PROJECT_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume type create¶

Create a volume type.

Usage:

orca volume type create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--description`	text	Description.	None
`--public` / `--private`	boolean	Make type public or private.	`True`
`--property`	text	Extra spec (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume type delete¶

Delete a volume type.

Usage:

orca volume type delete [OPTIONS] TYPE_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume type list¶

List volume types.

Usage:

orca volume type list [OPTIONS]

Options:

Name	Type	Description	Default
`--default`	boolean	Show the default type only.	`False`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume type set¶

Update a volume type.

Usage:

orca volume type set [OPTIONS] TYPE_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--property`	text	Extra spec to add or update (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume type show¶

Show volume type details.

Usage:

orca volume type show [OPTIONS] TYPE_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume type unset¶

Remove extra-spec keys from a volume type.

Example: orca volume type unset gold --property bandwidth_limit --property iops_limit

Usage:

orca volume type unset [OPTIONS] TYPE_ID

Options:

Name	Type	Description	Default
`--property`	text	Extra spec key to remove (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume type-access-add¶

Grant a project access to a private volume type.

Usage:

orca volume type-access-add [OPTIONS] TYPE_ID PROJECT_ID

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca volume type-access-list¶

List projects that have access to a private volume type.

Usage:

orca volume type-access-list [OPTIONS] TYPE_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume type-access-remove¶

Revoke a project's access to a private volume type.

Usage:

orca volume type-access-remove [OPTIONS] TYPE_ID PROJECT_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume type-create¶

Create a volume type.

Usage:

orca volume type-create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--description`	text	Description.	None
`--public` / `--private`	boolean	Make type public or private.	`True`
`--property`	text	Extra spec (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume type-delete¶

Delete a volume type.

Usage:

orca volume type-delete [OPTIONS] TYPE_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca volume type-list¶

List volume types.

Usage:

orca volume type-list [OPTIONS]

Options:

Name	Type	Description	Default
`--default`	boolean	Show the default type only.	`False`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume type-set¶

Update a volume type.

Usage:

orca volume type-set [OPTIONS] TYPE_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--property`	text	Extra spec to add or update (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume type-show¶

Show volume type details.

Usage:

orca volume type-show [OPTIONS] TYPE_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca volume unset¶

Unset volume metadata keys.

Usage:

orca volume unset [OPTIONS] VOLUME_ID

Options:

Name	Type	Description	Default
`--property`	text	Metadata key to remove (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca volume update¶

Update volume name or description.

Usage:

orca volume update [OPTIONS] VOLUME_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--help`	boolean	Show this message and exit.	`False`

orca volume upload-to-image¶

Materialize a volume's data as a downloadable Glance image.

Wraps Cinder's os-volume_upload_image action. The resulting image is a self-contained binary (unlike a server snapshot of a boot-from-volume instance, which is a 0-byte shell pointing at a Cinder snapshot) and can therefore be downloaded with orca image download.

Examples: orca volume upload-to-image my-image orca volume upload-to-image my-vol my-image --disk-format raw orca volume upload-to-image img --force # in-use volume orca volume upload-to-image img --property os_distro=ubuntu --wait

Usage:

orca volume upload-to-image [OPTIONS] VOLUME_ID_OR_NAME IMAGE_NAME

Options:

Name	Type	Description	Default
`--disk-format`	choice (`raw` \| `qcow2` \| `vmdk` \| `vdi` \| `vhd` \| `vhdx` \| `iso` \| `aki` \| `ari` \| `ami`)	Disk format.	`qcow2`
`--container-format`	choice (`bare` \| `ovf` \| `ova` \| `aki` \| `ari` \| `ami` \| `docker`)	Container format.	`bare`
`--visibility`	choice (`private` \| `shared` \| `community` \| `public`)	Image visibility. Only sent to Cinder when explicit (older microversions reject the field); otherwise Glance applies its own default.	None
`--protected` / `--no-protected`	boolean	Mark the resulting image as protected (deletion-locked). Only sent to Cinder when explicit; otherwise omitted from the action body for older-microversion compatibility.	None
`--force`	boolean	Required when uploading from an in-use volume.	`False`
`--property`	text	Custom Glance property to set on the resulting image. Repeatable. Applied via JSON-Patch after the upload action.	`Sentinel.UNSET`
`--wait`	boolean	Poll the resulting image until it reaches 'active' (or 'killed'/'deleted', in which case exit non-zero).	`False`
`--help`	boolean	Show this message and exit.	`False`