`orca block-storage`¶

Cinder admin verbs: cluster, log-level, resource-filter, manageable, cleanup.

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

orca block-storage¶

OSC parity: openstack block storage … admin verbs.

Usage:

orca block-storage [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

cleanup: Run a Cinder admin cleanup (POST /workers/cleanup).
cluster: Manage Cinder active/active clusters (admin).
log-level: Inspect or change live log levels of Cinder services (admin).
resource-filter: List/show server-side filters available for Cinder list APIs (admin).
snapshot: Snapshot-level admin verbs under block-storage.
volume: Volume-level admin verbs under block-storage.

orca block-storage cleanup¶

Run a Cinder admin cleanup (POST /workers/cleanup).

Parity with openstack block storage cleanup — clears abandoned operations from a failed node.

Usage:

orca block-storage cleanup [OPTIONS]

Options:

Name	Type	Description	Default
`--cluster`	text	Cluster on which to run the cleanup.	None
`--host`	text	Host on which to run the cleanup.	None
`--binary`	text	Service binary (e.g. cinder-volume).	None
`--is-up` / `--not-up`	boolean	Filter on service liveness.	None
`--disabled` / `--enabled`	boolean	Filter on the service disabled flag.	None
`--resource-id`	text	Restrict the cleanup to one resource.	None
`--resource-type`	text	Restrict the cleanup to one resource type (Volume, Snapshot, …).	None
`--service-id`	integer	Restrict the cleanup to a single Cinder service ID.	None
`--help`	boolean	Show this message and exit.	`False`

orca block-storage 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 block-storage 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 block-storage cluster list¶

List Cinder clusters.

Usage:

orca block-storage 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 block-storage cluster set¶

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

Usage:

orca block-storage 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 block-storage cluster show¶

Show one Cinder cluster.

Usage:

orca block-storage 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 block-storage 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 block-storage 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 block-storage log-level list¶

List current log levels per service / logger.

Usage:

orca block-storage 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 block-storage log-level set¶

Change the runtime log level of a Cinder service.

Usage:

orca block-storage 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 block-storage resource-filter¶

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

Maps to OSC openstack block storage resource filter ….

Usage:

orca block-storage 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 block-storage 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 block-storage resource-filter show¶

Show filters available for one resource type.

Usage:

orca block-storage 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 block-storage snapshot¶

Snapshot-level admin verbs under block-storage.

Usage:

orca block-storage snapshot [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

manageable: Discover Cinder-manageable existing snapshots on the backend.

orca block-storage snapshot manageable¶

Discover Cinder-manageable existing snapshots on the backend.

Usage:

orca block-storage 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 block-storage snapshot manageable list¶

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

Usage:

orca block-storage 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 block-storage volume¶

Volume-level admin verbs under block-storage.

Usage:

orca block-storage volume [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

manageable: Discover Cinder-manageable existing backend resources (admin).

orca block-storage volume manageable¶

Discover Cinder-manageable existing backend resources (admin).

Maps to OSC openstack block storage volume manageable list.

Usage:

orca block-storage 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 block-storage volume manageable list¶

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

Usage:

orca block-storage 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 block-storage¶