CLI Reference¶

This page is auto-generated from the running CLI via mkdocs-click — it never goes stale. Every command, option, flag, and environment variable shown here is introspected directly from the orca binary at build time.

For tutorial-style content, see the curated command pages.

orca¶

orca — OpenStack Rich Command-line Alternative.

Usage:

orca [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--version`	boolean	Show the version and exit.	`False`
`--profile`, `-P`	text	Config profile to use (overrides active profile).	None
`--region`, `-R`	text	Region to use (overrides profile region_name).	None
`--debug`	boolean	Log HTTP requests, retries, and auth decisions to stderr.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca access-rule¶

Manage application credential access rules (Keystone).

Usage:

orca access-rule [OPTIONS] COMMAND [ARGS]...

Options:

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

orca access-rule delete¶

Delete an access rule.

Usage:

orca access-rule delete [OPTIONS] ACCESS_RULE_ID

Options:

Name	Type	Description	Default
`--user-id`	text	User ID (defaults to current user).	None
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca access-rule list¶

List access rules.

Usage:

orca access-rule list [OPTIONS]

Options:

Name	Type	Description	Default
`--user-id`	text	User ID (defaults to current user).	None
`--service`	text	Filter by service type (e.g. compute).	None
`--method`	text	Filter by HTTP method.	None
`--path`	text	Filter by API path.	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 access-rule show¶

Show an access rule.

Usage:

orca access-rule show [OPTIONS] ACCESS_RULE_ID

Options:

Name	Type	Description	Default
`--user-id`	text	User ID (defaults to current user).	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 acl¶

Barbican secret ACLs — OSC parity top-level.

Usage:

orca acl [OPTIONS] COMMAND [ARGS]...

Options:

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

orca acl delete¶

Delete the ACL on a secret (revert to project-wide access).

Usage:

orca acl delete [OPTIONS] SECRET_ID

Options:

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

orca acl get¶

Get the ACL for a secret.

Usage:

orca acl get [OPTIONS] SECRET_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 acl set¶

Set the ACL on a secret.

Usage:

orca acl set [OPTIONS] SECRET_ID

Options:

Name	Type	Description	Default
`--user`	text	User ID to grant read access to (repeatable).	`Sentinel.UNSET`
`--project-access` / `--no-project-access`	boolean	Allow all project users read access.	`True`
`--help`	boolean	Show this message and exit.	`False`

orca acl user¶

Per-user ACL operations on a secret.

Usage:

orca acl user [OPTIONS] COMMAND [ARGS]...

Options:

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

orca acl user add¶

Add users to a secret's read ACL.

Usage:

orca acl user add [OPTIONS] SECRET_ID

Options:

Name	Type	Description	Default
`--user`	text	User ID to grant read access (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca acl user remove¶

Remove users from a secret's read ACL.

Usage:

orca acl user remove [OPTIONS] SECRET_ID

Options:

Name	Type	Description	Default
`--user`	text	User ID to revoke read access from (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca address-group¶

Manage Neutron address groups (collections of CIDRs).

Used as the remote_address_group_id of security-group rules to reuse a curated list of CIDRs across multiple rules.

Usage:

orca address-group [OPTIONS] COMMAND [ARGS]...

Options:

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

orca address-group create¶

Create an address group.

Examples: orca address-group create office-network --address 10.0.0.0/24 --address 10.1.0.0/24

Usage:

orca address-group create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--description`	text	Free-text description.	None
`--address`	text	CIDR to include (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca address-group delete¶

Delete an address group.

Usage:

orca address-group delete [OPTIONS] AG_ID

Options:

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

orca address-group list¶

List address groups.

Usage:

orca address-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 address-group set¶

Update an address group's name / description / member CIDRs.

Usage:

orca address-group set [OPTIONS] AG_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--add-address`	text	CIDR to append (repeatable).	`Sentinel.UNSET`
`--remove-address`	text	CIDR to remove (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca address-group show¶

Show an address group's details.

Usage:

orca address-group show [OPTIONS] AG_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 address-group unset¶

Remove addresses from an address group.

Usage:

orca address-group unset [OPTIONS] AG_ID

Options:

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

orca address-scope¶

Manage Neutron address scopes.

An address scope groups subnet pools that share the same routing domain — useful in BGP-driven L3 deployments and overlapping-CIDR scenarios.

Usage:

orca address-scope [OPTIONS] COMMAND [ARGS]...

Options:

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

orca address-scope create¶

Create an address scope.

Usage:

orca address-scope create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--ip-version`	choice (`4` \| `6`)	IP version: 4 or 6.	`4`
`--shared` / `--unshared`	boolean	Visible to other projects.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca address-scope delete¶

Delete an address scope.

Usage:

orca address-scope delete [OPTIONS] AS_ID

Options:

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

orca address-scope list¶

List address scopes.

Usage:

orca address-scope 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 address-scope set¶

Update an address scope.

Usage:

orca address-scope set [OPTIONS] AS_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--shared` / `--unshared`	boolean	Switch visibility.	None
`--help`	boolean	Show this message and exit.	`False`

orca address-scope show¶

Show an address scope's details.

Usage:

orca address-scope show [OPTIONS] AS_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 aggregate¶

Manage host aggregates (Nova).

Usage:

orca aggregate [OPTIONS] COMMAND [ARGS]...

Options:

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

orca aggregate add¶

OSC parity verbs (aggregate add host …).

Usage:

orca aggregate add [OPTIONS] COMMAND [ARGS]...

Options:

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

orca aggregate add add¶

Add a host to an aggregate.

Usage:

orca aggregate add add [OPTIONS] AGGREGATE_ID HOST

Options:

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

orca aggregate add-host¶

Add a host to an aggregate.

Usage:

orca aggregate add-host [OPTIONS] AGGREGATE_ID HOST

Options:

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

orca aggregate cache¶

OSC parity verbs (aggregate cache image …).

Usage:

orca aggregate cache [OPTIONS] COMMAND [ARGS]...

Options:

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

orca aggregate cache cache¶

Request that images be cached on hosts in an aggregate.

Examples: orca aggregate image cache orca aggregate image cache

Usage:

orca aggregate cache cache [OPTIONS] AGGREGATE_ID IMAGE_IDS...

Options:

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

orca aggregate cache-image¶

Request that images be cached on hosts in an aggregate.

Examples: orca aggregate image cache orca aggregate image cache

Usage:

orca aggregate cache-image [OPTIONS] AGGREGATE_ID IMAGE_IDS...

Options:

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

orca aggregate create¶

Create a host aggregate.

Usage:

orca aggregate create [OPTIONS] NAME

Options:

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

orca aggregate delete¶

Delete a host aggregate.

Usage:

orca aggregate delete [OPTIONS] AGGREGATE_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca aggregate host¶

Manage hosts inside an aggregate.

Usage:

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

Options:

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

orca aggregate host add¶

Add a host to an aggregate.

Usage:

orca aggregate host add [OPTIONS] AGGREGATE_ID HOST

Options:

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

orca aggregate host remove¶

Remove a host from an aggregate.

Usage:

orca aggregate host remove [OPTIONS] AGGREGATE_ID HOST

Options:

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

orca aggregate image¶

Manage image caching on aggregates.

Usage:

orca aggregate image [OPTIONS] COMMAND [ARGS]...

Options:

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

orca aggregate image cache¶

Request that images be cached on hosts in an aggregate.

Examples: orca aggregate image cache orca aggregate image cache

Usage:

orca aggregate image cache [OPTIONS] AGGREGATE_ID IMAGE_IDS...

Options:

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

orca aggregate list¶

List host aggregates.

Usage:

orca aggregate 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 aggregate remove¶

OSC parity verbs (aggregate remove host …).

Usage:

orca aggregate remove [OPTIONS] COMMAND [ARGS]...

Options:

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

orca aggregate remove remove¶

Remove a host from an aggregate.

Usage:

orca aggregate remove remove [OPTIONS] AGGREGATE_ID HOST

Options:

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

orca aggregate remove-host¶

Remove a host from an aggregate.

Usage:

orca aggregate remove-host [OPTIONS] AGGREGATE_ID HOST

Options:

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

orca aggregate set¶

Update an aggregate's name, AZ, or metadata.

Usage:

orca aggregate set [OPTIONS] AGGREGATE_ID

Options:

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

orca aggregate show¶

Show aggregate details.

Usage:

orca aggregate show [OPTIONS] AGGREGATE_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 aggregate unset¶

Unset metadata properties on an aggregate.

Usage:

orca aggregate unset [OPTIONS] AGGREGATE_ID

Options:

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

orca alarm¶

Manage Aodh alarms.

Usage:

orca alarm [OPTIONS] COMMAND [ARGS]...

Options:

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

orca alarm capabilities¶

Show Aodh API capabilities.

Usage:

orca alarm capabilities [OPTIONS]

Options:

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

orca alarm create¶

Create an alarm.

Usage:

orca alarm create [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Alarm name.	`Sentinel.UNSET`
`--type`	choice (`gnocchi_resources_threshold` \| `gnocchi_aggregation_by_metrics_threshold` \| `gnocchi_aggregation_by_resources_threshold` \| `event` \| `composite` \| `loadbalancer_member_health` \| `threshold`)	Alarm type.	`Sentinel.UNSET`
`--rule`	text	Type-specific rule as a JSON string.	`Sentinel.UNSET`
`--description`	text	Alarm description.	``
`--severity`	choice (`low` \| `moderate` \| `critical`)	Alarm severity.	`low`
`--enabled` / `--disabled`	boolean	Enable or disable the alarm.	`True`
`--repeat-actions` / `--no-repeat-actions`	boolean	Re-trigger actions on each evaluation while in alarm state.	`False`
`--alarm-action`	text	Webhook URL to call when entering alarm state. Repeatable.	`Sentinel.UNSET`
`--ok-action`	text	Webhook URL to call when entering ok state. Repeatable.	`Sentinel.UNSET`
`--insufficient-data-action`	text	Webhook URL to call on insufficient data. Repeatable.	`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 alarm delete¶

Delete an alarm.

Usage:

orca alarm delete [OPTIONS] ALARM_ID

Options:

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

orca alarm history¶

Show the change history of an alarm.

Usage:

orca alarm history [OPTIONS] ALARM_ID

Options:

Name	Type	Description	Default
`--limit`	integer	Max number of history entries.	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 alarm list¶

List alarms.

Usage:

orca alarm list [OPTIONS]

Options:

Name	Type	Description	Default
`--type`	text	Filter by alarm type.	None
`--state`	choice (`ok` \| `alarm` \| `insufficient_data`)	Filter by state.	None
`--enabled` / `--disabled`	boolean	Filter by enabled status.	None
`--name`	text	Filter by alarm name.	None
`--limit`	integer	Max number of alarms to return.	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 alarm metrics¶

Show Aodh evaluator metrics (OSC alarm metrics).

Usage:

orca alarm metrics [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 alarm quota¶

Inspect or set Aodh per-project alarm quota.

Usage:

orca alarm quota [OPTIONS] COMMAND [ARGS]...

Options:

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

orca alarm quota set¶

Set alarm quota for a project.

Usage:

orca alarm quota set [OPTIONS] PROJECT_ID

Options:

Name	Type	Description	Default
`--alarms`	integer	Maximum number of alarms for the project.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca alarm quota show¶

Show the alarm quota for a project (OSC alarm quota show).

Usage:

orca alarm quota show [OPTIONS]

Options:

Name	Type	Description	Default
`--project`	text	Project to query (default: caller's project).	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 alarm quota-set¶

Set alarm quota for a project.

Usage:

orca alarm quota-set [OPTIONS] PROJECT_ID

Options:

Name	Type	Description	Default
`--alarms`	integer	Maximum number of alarms for the project.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca alarm set¶

Update an alarm.

Usage:

orca alarm set [OPTIONS] ALARM_ID

Options:

Name	Type	Description	Default
`--name`	text	New alarm name.	None
`--description`	text	New description.	None
`--severity`	choice (`low` \| `moderate` \| `critical`)	N/A	None
`--enabled` / `--disabled`	boolean	Enable or disable.	None
`--repeat-actions` / `--no-repeat-actions`	boolean	N/A	None
`--rule`	text	Updated type-specific rule as JSON.	None
`--alarm-action`	text	N/A	`Sentinel.UNSET`
`--ok-action`	text	N/A	`Sentinel.UNSET`
`--insufficient-data-action`	text	N/A	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca alarm set¶

Update an alarm.

Usage:

orca alarm set [OPTIONS] ALARM_ID

Options:

Name	Type	Description	Default
`--name`	text	New alarm name.	None
`--description`	text	New description.	None
`--severity`	choice (`low` \| `moderate` \| `critical`)	N/A	None
`--enabled` / `--disabled`	boolean	Enable or disable.	None
`--repeat-actions` / `--no-repeat-actions`	boolean	N/A	None
`--rule`	text	Updated type-specific rule as JSON.	None
`--alarm-action`	text	N/A	`Sentinel.UNSET`
`--ok-action`	text	N/A	`Sentinel.UNSET`
`--insufficient-data-action`	text	N/A	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca alarm show¶

Show an alarm.

Usage:

orca alarm show [OPTIONS] ALARM_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 alarm state¶

Inspect or override an alarm's evaluation state.

Usage:

orca alarm state [OPTIONS] COMMAND [ARGS]...

Options:

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

orca alarm state get¶

Get the current state of an alarm.

Usage:

orca alarm state get [OPTIONS] ALARM_ID

Options:

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

orca alarm state set¶

Set the state of an alarm.

Usage:

orca alarm state set [OPTIONS] ALARM_ID {ok|alarm|insufficient_data}

Options:

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

orca alarm state-get¶

Get the current state of an alarm.

Usage:

orca alarm state-get [OPTIONS] ALARM_ID

Options:

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

orca alarm state-set¶

Set the state of an alarm.

Usage:

orca alarm state-set [OPTIONS] ALARM_ID {ok|alarm|insufficient_data}

Options:

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

orca allocation¶

Placement allocations — OSC parity.

Usage:

orca allocation [OPTIONS] COMMAND [ARGS]...

Options:

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

orca allocation candidate¶

Placement allocation candidates.

Usage:

orca allocation candidate [OPTIONS] COMMAND [ARGS]...

Options:

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

orca allocation candidate candidate-list¶

List allocation candidates for the requested resources.

Usage:

orca allocation candidate candidate-list [OPTIONS]

Options:

Name	Type	Description	Default
`--resource`	text	Requested resource, e.g. VCPU=4. Repeatable.	`Sentinel.UNSET`
`--required`	text	Required trait. Repeatable.	`Sentinel.UNSET`
`--forbidden`	text	Forbidden trait. Repeatable.	`Sentinel.UNSET`
`--limit`	integer	Max number of candidates.	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 allocation delete¶

Delete all allocations for a consumer.

Usage:

orca allocation delete [OPTIONS] CONSUMER_UUID

Options:

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

orca allocation set¶

Set (replace) allocations for a consumer against a single resource provider.

Usage:

orca allocation set [OPTIONS] CONSUMER_UUID

Options:

Name	Type	Description	Default
`--resource-provider`	text	Resource provider UUID.	`Sentinel.UNSET`
`--resource`	text	Resource class and amount, e.g. VCPU=4. Repeatable.	`Sentinel.UNSET`
`--project-id`	text	Consumer project UUID.	`Sentinel.UNSET`
`--user-id`	text	Consumer user UUID.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca allocation show¶

Show allocations for a consumer.

Usage:

orca allocation show [OPTIONS] CONSUMER_UUID

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 allocation unset¶

Drop a single resource-class allocation for a consumer.

Reads the consumer's full allocations, strips rc_name from each provider entry (optionally only on --rp-uuid), then PUTs the remaining allocations back. Empty entries are dropped.

Usage:

orca allocation unset [OPTIONS] CONSUMER_UUID

Options:

Name	Type	Description	Default
`--resource-class`	text	Resource class to clear (e.g. VCPU, MEMORY_MB).	`Sentinel.UNSET`
`--rp-uuid`	text	Optional: limit to allocations on this resource provider (default: all providers).	None
`--help`	boolean	Show this message and exit.	`False`

orca application-credential¶

Manage application credentials (Keystone v3).

Usage:

orca application-credential [OPTIONS] COMMAND [ARGS]...

Options:

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

orca application-credential create¶

Create an application credential.

Usage:

orca application-credential create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--description`	text	N/A	None
`--secret`	text	Secret (auto-generated if omitted).	None
`--expires`	text	Expiry (ISO 8601, e.g. 2026-12-31T00:00:00).	None
`--unrestricted`	boolean	Allow creation of other credentials (dangerous).	`False`
`--user`	text	N/A	None
`--access-rules`	text	Access rules as a JSON array, e.g. '[{"path":"/v3/projects","method":"GET","service":"identity"}]'. Keystone only attaches access rules at create time.	None
`--save-profile`	text	Save the new credential as an orca profile of this name.	None
`--help`	boolean	Show this message and exit.	`False`

orca application-credential delete¶

Delete an application credential.

Usage:

orca application-credential delete [OPTIONS] CREDENTIAL_ID

Options:

Name	Type	Description	Default
`--user`	text	N/A	None
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca application-credential list¶

List application credentials.

Usage:

orca application-credential list [OPTIONS]

Options:

Name	Type	Description	Default
`--user`	text	User ID (default: current user).	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 application-credential show¶

Show application credential details.

Usage:

orca application-credential show [OPTIONS] CREDENTIAL_ID

Options:

Name	Type	Description	Default
`--user`	text	N/A	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 audit¶

Run a security audit on the project.

Checks for common misconfigurations: - Security groups with 0.0.0.0/0 on dangerous ports - Servers without SSH key pair - Servers with admin password set - Unencrypted volumes - Publicly exposed services

Examples: orca audit

Usage:

orca audit [OPTIONS]

Options:

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

orca auth¶

Keystone identity & access diagnostics.

Usage:

orca auth [OPTIONS] COMMAND [ARGS]...

Options:

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

orca auth check¶

Verify credentials are still valid (password check).

Tests authentication against Keystone without running any command. Use before long scripts to fail fast.

Examples: orca auth check # check active profile orca auth check --all # check every orca profile orca auth check --clouds # also check clouds.yaml entries

Usage:

orca auth check [OPTIONS]

Options:

Name	Type	Description	Default
`--all`, `-a`	boolean	Check all profiles, not just the active one.	`False`
`--clouds`	boolean	Also check clouds.yaml entries.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca auth token¶

Inspect or revoke the current token.

Usage:

orca auth token [OPTIONS] COMMAND [ARGS]...

Options:

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

orca auth token debug¶

Inspect the current token — roles, catalog, methods, expiration.

Shows everything Keystone returned in the token payload. Use --raw for the full JSON dump.

Examples: orca auth token debug orca auth token debug --raw

Usage:

orca auth token debug [OPTIONS]

Options:

Name	Type	Description	Default
`--raw`	boolean	Print the full token body as JSON.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca auth token revoke¶

Revoke a token.

Example: orca auth token revoke

Usage:

orca auth token revoke [OPTIONS] TOKEN

Options:

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

orca auth token-debug¶

Inspect the current token — roles, catalog, methods, expiration.

Shows everything Keystone returned in the token payload. Use --raw for the full JSON dump.

Examples: orca auth token debug orca auth token debug --raw

Usage:

orca auth token-debug [OPTIONS]

Options:

Name	Type	Description	Default
`--raw`	boolean	Print the full token body as JSON.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca auth token-revoke¶

Revoke a token.

Example: orca auth token revoke

Usage:

orca auth token-revoke [OPTIONS] TOKEN

Options:

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

orca auth whoami¶

Show current identity — user, project, roles, endpoints.

Fast summary of who you are and what you can do, without listing all resources.

Examples: orca auth whoami orca -P staging auth whoami

Usage:

orca auth whoami [OPTIONS]

Options:

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

orca availability-zone¶

Manage availability zones (Nova).

Usage:

orca availability-zone [OPTIONS] COMMAND [ARGS]...

Options:

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

orca availability-zone list¶

List availability zones.

Usage:

orca availability-zone list [OPTIONS]

Options:

Name	Type	Description	Default
`--long`	boolean	Show hosts and services.	`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 backup¶

Manage Freezer backups, jobs, sessions & clients.

For Cinder volume backups see orca volume backup-list etc.

Usage:

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

Options:

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

orca backup action¶

Manage backup actions.

Usage:

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

Options:

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

orca backup action create¶

Create a standalone backup action.

Examples: orca backup action create --path /var/data --container my-backups orca backup action create --action restore --path /var/data --container my-backups orca backup action create --path /var/lib/mysql --mode mysql --backup-name daily-mysql

Usage:

orca backup action create [OPTIONS]

Options:

Name	Type	Description	Default
`--action`	choice (`backup` \| `restore` \| `admin`)	N/A	`backup`
`--path`	text	Path to back up or restore.	`Sentinel.UNSET`
`--container`	text	Swift container name.	None
`--storage`	choice (`swift` \| `local` \| `ssh` \| `s3`)	N/A	`swift`
`--mode`	choice (`fs` \| `mysql` \| `mongo` \| `mssql` \| `cinder` \| `nova`)	N/A	`fs`
`--backup-name`	text	Name for the backup.	None
`--max-level`	integer	Max incremental backup level.	None
`--help`	boolean	Show this message and exit.	`False`

orca backup action delete¶

Delete a backup action.

Usage:

orca backup action delete [OPTIONS] ACTION_ID

Options:

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

orca backup action list¶

List backup actions.

Usage:

orca backup action list [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	integer	Max results.	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 backup action show¶

Show backup action details.

Usage:

orca backup action show [OPTIONS] ACTION_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 backup action-create¶

Create a standalone backup action.

Examples: orca backup action create --path /var/data --container my-backups orca backup action create --action restore --path /var/data --container my-backups orca backup action create --path /var/lib/mysql --mode mysql --backup-name daily-mysql

Usage:

orca backup action-create [OPTIONS]

Options:

Name	Type	Description	Default
`--action`	choice (`backup` \| `restore` \| `admin`)	N/A	`backup`
`--path`	text	Path to back up or restore.	`Sentinel.UNSET`
`--container`	text	Swift container name.	None
`--storage`	choice (`swift` \| `local` \| `ssh` \| `s3`)	N/A	`swift`
`--mode`	choice (`fs` \| `mysql` \| `mongo` \| `mssql` \| `cinder` \| `nova`)	N/A	`fs`
`--backup-name`	text	Name for the backup.	None
`--max-level`	integer	Max incremental backup level.	None
`--help`	boolean	Show this message and exit.	`False`

orca backup action-delete¶

Delete a backup action.

Usage:

orca backup action-delete [OPTIONS] ACTION_ID

Options:

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

orca backup action-list¶

List backup actions.

Usage:

orca backup action-list [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	integer	Max results.	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 backup action-show¶

Show backup action details.

Usage:

orca backup action-show [OPTIONS] ACTION_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 backup client¶

Manage backup clients (agents).

Usage:

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

Options:

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

orca backup client delete¶

Unregister a backup client.

Usage:

orca backup client delete [OPTIONS] CLIENT_ID

Options:

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

orca backup client list¶

List registered backup clients (agents).

Usage:

orca backup client list [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	integer	Max results.	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 backup client register¶

Register a new backup client.

Usage:

orca backup client register [OPTIONS] HOSTNAME

Options:

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

orca backup client show¶

Show backup client details.

Usage:

orca backup client show [OPTIONS] CLIENT_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 backup client-delete¶

Unregister a backup client.

Usage:

orca backup client-delete [OPTIONS] CLIENT_ID

Options:

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

orca backup client-list¶

List registered backup clients (agents).

Usage:

orca backup client-list [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	integer	Max results.	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 backup client-register¶

Register a new backup client.

Usage:

orca backup client-register [OPTIONS] HOSTNAME

Options:

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

orca backup client-show¶

Show backup client details.

Usage:

orca backup client-show [OPTIONS] CLIENT_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 backup delete¶

Delete a backup.

Usage:

orca backup delete [OPTIONS] BACKUP_ID

Options:

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

orca backup job¶

Manage backup jobs.

Usage:

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

Options:

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

orca backup job create¶

Create a backup job.

Examples: orca backup job create --client-id --path /var/data --container my-backups orca backup job create --client-id --path /var/lib/mysql --mode mysql --storage swift orca backup job create --client-id --action restore --path /var/data --container my-backups

Usage:

orca backup job create [OPTIONS]

Options:

Name	Type	Description	Default
`--description`	text	Job description.	``
`--client-id`	text	Freezer client ID.	`Sentinel.UNSET`
`--action`	choice (`backup` \| `restore` \| `admin`)	Action type.	`backup`
`--path`	text	Path to back up or restore.	`Sentinel.UNSET`
`--container`	text	Swift container name for storage.	None
`--storage`	choice (`swift` \| `local` \| `ssh` \| `s3`)	Storage backend.	`swift`
`--mode`	choice (`fs` \| `mysql` \| `mongo` \| `mssql` \| `cinder` \| `nova`)	Backup mode.	`fs`
`--schedule-interval`	text	Schedule interval (e.g. '24 hours', '7 days').	None
`--help`	boolean	Show this message and exit.	`False`

orca backup job delete¶

Delete a backup job.

Usage:

orca backup job delete [OPTIONS] JOB_ID

Options:

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

orca backup job list¶

List backup jobs.

Usage:

orca backup job list [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	integer	Max results.	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 backup job show¶

Show backup job details.

Usage:

orca backup job show [OPTIONS] JOB_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 backup job start¶

Start (trigger) a backup job.

Usage:

orca backup job start [OPTIONS] JOB_ID

Options:

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

orca backup job stop¶

Stop a running backup job.

Usage:

orca backup job stop [OPTIONS] JOB_ID

Options:

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

orca backup job-create¶

Create a backup job.

Examples: orca backup job create --client-id --path /var/data --container my-backups orca backup job create --client-id --path /var/lib/mysql --mode mysql --storage swift orca backup job create --client-id --action restore --path /var/data --container my-backups

Usage:

orca backup job-create [OPTIONS]

Options:

Name	Type	Description	Default
`--description`	text	Job description.	``
`--client-id`	text	Freezer client ID.	`Sentinel.UNSET`
`--action`	choice (`backup` \| `restore` \| `admin`)	Action type.	`backup`
`--path`	text	Path to back up or restore.	`Sentinel.UNSET`
`--container`	text	Swift container name for storage.	None
`--storage`	choice (`swift` \| `local` \| `ssh` \| `s3`)	Storage backend.	`swift`
`--mode`	choice (`fs` \| `mysql` \| `mongo` \| `mssql` \| `cinder` \| `nova`)	Backup mode.	`fs`
`--schedule-interval`	text	Schedule interval (e.g. '24 hours', '7 days').	None
`--help`	boolean	Show this message and exit.	`False`

orca backup job-delete¶

Delete a backup job.

Usage:

orca backup job-delete [OPTIONS] JOB_ID

Options:

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

orca backup job-list¶

List backup jobs.

Usage:

orca backup job-list [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	integer	Max results.	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 backup job-show¶

Show backup job details.

Usage:

orca backup job-show [OPTIONS] JOB_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 backup job-start¶

Start (trigger) a backup job.

Usage:

orca backup job-start [OPTIONS] JOB_ID

Options:

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

orca backup job-stop¶

Stop a running backup job.

Usage:

orca backup job-stop [OPTIONS] JOB_ID

Options:

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

orca backup list¶

List backups.

Usage:

orca backup list [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	integer	Max results.	None
`--offset`	integer	Offset for pagination.	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 backup session¶

Manage backup sessions.

Usage:

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

Options:

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

orca backup session add-job¶

Add a job to a session.

Usage:

orca backup session add-job [OPTIONS] SESSION_ID JOB_ID

Options:

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

orca backup session create¶

Create a backup session.

Usage:

orca backup session create [OPTIONS]

Options:

Name	Type	Description	Default
`--description`	text	Session description.	``
`--schedule-interval`	text	Schedule interval (e.g. '24 hours').	None
`--help`	boolean	Show this message and exit.	`False`

orca backup session delete¶

Delete a backup session.

Usage:

orca backup session delete [OPTIONS] SESSION_ID

Options:

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

orca backup session list¶

List backup sessions.

Usage:

orca backup session list [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	integer	Max results.	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 backup session remove-job¶

Remove a job from a session.

Usage:

orca backup session remove-job [OPTIONS] SESSION_ID JOB_ID

Options:

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

orca backup session show¶

Show backup session details.

Usage:

orca backup session show [OPTIONS] SESSION_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 backup session start¶

Start a backup session (triggers all its jobs).

Usage:

orca backup session start [OPTIONS] SESSION_ID

Options:

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

orca backup session-add-job¶

Add a job to a session.

Usage:

orca backup session-add-job [OPTIONS] SESSION_ID JOB_ID

Options:

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

orca backup session-create¶

Create a backup session.

Usage:

orca backup session-create [OPTIONS]

Options:

Name	Type	Description	Default
`--description`	text	Session description.	``
`--schedule-interval`	text	Schedule interval (e.g. '24 hours').	None
`--help`	boolean	Show this message and exit.	`False`

orca backup session-delete¶

Delete a backup session.

Usage:

orca backup session-delete [OPTIONS] SESSION_ID

Options:

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

orca backup session-list¶

List backup sessions.

Usage:

orca backup session-list [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	integer	Max results.	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 backup session-remove-job¶

Remove a job from a session.

Usage:

orca backup session-remove-job [OPTIONS] SESSION_ID JOB_ID

Options:

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

orca backup session-show¶

Show backup session details.

Usage:

orca backup session-show [OPTIONS] SESSION_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 backup session-start¶

Start a backup session (triggers all its jobs).

Usage:

orca backup session-start [OPTIONS] SESSION_ID

Options:

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

orca backup show¶

Show backup details.

Usage:

orca 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 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`

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`

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`

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`

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`

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`

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`

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`

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 ca¶

Barbican Certificate Authorities (admin).

Usage:

orca ca [OPTIONS] COMMAND [ARGS]...

Options:

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

orca ca get¶

Show a Certificate Authority by ID.

Usage:

orca ca get [OPTIONS] CA_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 ca list¶

List Certificate Authorities registered with Barbican.

Usage:

orca ca 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 catalog¶

List available service endpoints from the Keystone catalog.

Bare orca catalog keeps the historical behaviour (equivalent to orca catalog list); use orca catalog show <service> to drill into a specific service.

Usage:

orca catalog [OPTIONS] COMMAND [ARGS]...

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 catalog list¶

List all service endpoints from the Keystone catalog (OSC parity).

Usage:

orca catalog 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 catalog show¶

Show all endpoints for a service (by name or type).

Examples: orca catalog show compute orca catalog show nova orca catalog show identity

Usage:

orca catalog show [OPTIONS] SERVICE

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 cleanup¶

Find orphaned resources — unused IPs, detached volumes, broken stacks, etc.

Detects the following by default: floating-ip — not associated with any port volume — detached & available, or in error state snapshot — in error state; or older than --older-than days port — no device attached security-group — non-default, not used by any server server — in ERROR state router — no external gateway and no attached interfaces stack — in a failed/rollback state (requires Heat) loadbalancer — in ERROR state (requires Octavia)

By default only reports findings. Use --delete to clean up.

Examples: orca cleanup orca cleanup --older-than 30 orca cleanup --skip stack --skip loadbalancer orca cleanup --delete --yes orca cleanup --older-than 14 --delete --yes

Usage:

orca cleanup [OPTIONS]

Options:

Name	Type	Description	Default
`--delete`	boolean	Actually delete the detected orphaned resources.	`False`
`--older-than`	integer	Flag volumes and snapshots older than N days (implies age check).	None
`--skip`	choice (`floating-ip` \| `volume` \| `snapshot` \| `port` \| `security-group` \| `server` \| `router` \| `stack` \| `loadbalancer`)	Resource type to skip (repeatable).	`Sentinel.UNSET`
`--yes`, `-y`	boolean	Skip confirmation when deleting.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca cluster¶

Manage Kubernetes clusters & cluster templates (Magnum).

Usage:

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

Options:

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

orca cluster create¶

Create a Kubernetes cluster.

Examples: orca cluster create my-k8s --template --node-count 3 orca cluster create prod --template --master-count 3 --node-count 5 --keypair my-key

Usage:

orca cluster create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--template`	text	Cluster template UUID or name.	`Sentinel.UNSET`
`--node-count`	integer	Number of worker nodes.	`1`
`--master-count`	integer	Number of master nodes.	`1`
`--keypair`	text	SSH keypair name.	None
`--timeout`	integer	Creation timeout (minutes).	`60`
`--flavor`	text	Node flavor (overrides template).	None
`--master-flavor`	text	Master flavor (overrides template).	None
`--help`	boolean	Show this message and exit.	`False`

orca cluster delete¶

Delete a cluster.

Usage:

orca cluster delete [OPTIONS] CLUSTER_ID

Options:

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

orca cluster kubeconfig¶

Show the cluster API address and connection info.

Usage:

orca cluster kubeconfig [OPTIONS] CLUSTER_ID

Options:

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

orca cluster list¶

List clusters.

Usage:

orca cluster 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 cluster nodegroup¶

Manage node groups in a cluster.

Usage:

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

Options:

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

orca cluster nodegroup create¶

Create a node group in a cluster.

Usage:

orca cluster nodegroup create [OPTIONS] CLUSTER_ID

Options:

Name	Type	Description	Default
`--name`	text	Node group name.	`Sentinel.UNSET`
`--flavor-id`	text	Flavor ID for nodes.	`Sentinel.UNSET`
`--node-count`	integer	Initial number of nodes.	`1`
`--min-node-count`	integer	Minimum node count (for autoscaling).	None
`--max-node-count`	integer	Maximum node count (for autoscaling).	None
`--role`	text	Node group role (worker/infra).	`worker`
`--image-id`	text	Override image ID.	None
`--help`	boolean	Show this message and exit.	`False`

orca cluster nodegroup delete¶

Delete a node group.

Usage:

orca cluster nodegroup delete [OPTIONS] CLUSTER_ID NODEGROUP_ID

Options:

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

orca cluster nodegroup list¶

List node groups in a cluster.

Usage:

orca cluster nodegroup list [OPTIONS] CLUSTER_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 cluster nodegroup show¶

Show node group details.

Usage:

orca cluster nodegroup show [OPTIONS] CLUSTER_ID NODEGROUP_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 cluster nodegroup update¶

Update a node group (resize / autoscaling bounds).

Usage:

orca cluster nodegroup update [OPTIONS] CLUSTER_ID NODEGROUP_ID

Options:

Name	Type	Description	Default
`--node-count`	integer	New node count.	None
`--min-node-count`	integer	New minimum node count.	None
`--max-node-count`	integer	New maximum node count.	None
`--help`	boolean	Show this message and exit.	`False`

orca cluster nodegroup-create¶

Create a node group in a cluster.

Usage:

orca cluster nodegroup-create [OPTIONS] CLUSTER_ID

Options:

Name	Type	Description	Default
`--name`	text	Node group name.	`Sentinel.UNSET`
`--flavor-id`	text	Flavor ID for nodes.	`Sentinel.UNSET`
`--node-count`	integer	Initial number of nodes.	`1`
`--min-node-count`	integer	Minimum node count (for autoscaling).	None
`--max-node-count`	integer	Maximum node count (for autoscaling).	None
`--role`	text	Node group role (worker/infra).	`worker`
`--image-id`	text	Override image ID.	None
`--help`	boolean	Show this message and exit.	`False`

orca cluster nodegroup-delete¶

Delete a node group.

Usage:

orca cluster nodegroup-delete [OPTIONS] CLUSTER_ID NODEGROUP_ID

Options:

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

orca cluster nodegroup-list¶

List node groups in a cluster.

Usage:

orca cluster nodegroup-list [OPTIONS] CLUSTER_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 cluster nodegroup-show¶

Show node group details.

Usage:

orca cluster nodegroup-show [OPTIONS] CLUSTER_ID NODEGROUP_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 cluster nodegroup-update¶

Update a node group (resize / autoscaling bounds).

Usage:

orca cluster nodegroup-update [OPTIONS] CLUSTER_ID NODEGROUP_ID

Options:

Name	Type	Description	Default
`--node-count`	integer	New node count.	None
`--min-node-count`	integer	New minimum node count.	None
`--max-node-count`	integer	New maximum node count.	None
`--help`	boolean	Show this message and exit.	`False`

orca cluster resize¶

Resize a cluster (change worker node count).

Usage:

orca cluster resize [OPTIONS] CLUSTER_ID

Options:

Name	Type	Description	Default
`--node-count`	integer	New number of worker nodes.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca cluster show¶

Show cluster details.

Usage:

orca cluster show [OPTIONS] CLUSTER_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 cluster template¶

Manage cluster templates.

Usage:

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

Options:

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

orca cluster template create¶

Create a cluster template.

Usage:

orca cluster template create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--image`	text	Base image UUID or name.	`Sentinel.UNSET`
`--external-network`	text	External network ID.	`Sentinel.UNSET`
`--coe`	choice (`kubernetes` \| `swarm` \| `mesos`)	N/A	`kubernetes`
`--keypair`	text	SSH keypair name.	None
`--flavor`	text	Node flavor.	None
`--master-flavor`	text	Master flavor.	None
`--network-driver`	text	Network driver (flannel, calico, etc.).	None
`--docker-volume-size`	integer	Docker volume size in GB.	None
`--dns`	text	DNS nameserver.	`8.8.8.8`
`--master-lb` / `--no-master-lb`	boolean	N/A	`True`
`--floating-ip` / `--no-floating-ip`	boolean	N/A	`True`
`--label`	text	Key=value label (repeatable). E.g. --label boot_volume_size=20	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca cluster template delete¶

Delete a cluster template.

Usage:

orca cluster template delete [OPTIONS] TEMPLATE_ID

Options:

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

orca cluster template list¶

List cluster templates.

Usage:

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

Show cluster template details.

Usage:

orca cluster template show [OPTIONS] TEMPLATE_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 cluster template-create¶

Create a cluster template.

Usage:

orca cluster template-create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--image`	text	Base image UUID or name.	`Sentinel.UNSET`
`--external-network`	text	External network ID.	`Sentinel.UNSET`
`--coe`	choice (`kubernetes` \| `swarm` \| `mesos`)	N/A	`kubernetes`
`--keypair`	text	SSH keypair name.	None
`--flavor`	text	Node flavor.	None
`--master-flavor`	text	Master flavor.	None
`--network-driver`	text	Network driver (flannel, calico, etc.).	None
`--docker-volume-size`	integer	Docker volume size in GB.	None
`--dns`	text	DNS nameserver.	`8.8.8.8`
`--master-lb` / `--no-master-lb`	boolean	N/A	`True`
`--floating-ip` / `--no-floating-ip`	boolean	N/A	`True`
`--label`	text	Key=value label (repeatable). E.g. --label boot_volume_size=20	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca cluster template-delete¶

Delete a cluster template.

Usage:

orca cluster template-delete [OPTIONS] TEMPLATE_ID

Options:

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

orca cluster template-list¶

List cluster templates.

Usage:

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

Show cluster template details.

Usage:

orca cluster template-show [OPTIONS] TEMPLATE_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 cluster upgrade¶

Upgrade a cluster to a new template version.

Usage:

orca cluster upgrade [OPTIONS] CLUSTER_ID

Options:

Name	Type	Description	Default
`--template-id`	text	New cluster template ID to upgrade to.	`Sentinel.UNSET`
`--max-batch-size`	integer	Max number of nodes to upgrade simultaneously.	`1`
`--nodegroup`	text	Specific nodegroup to upgrade.	None
`--help`	boolean	Show this message and exit.	`False`

orca coe¶

Magnum Container Orchestration Engine — OSC parity top-level.

Usage:

orca coe [OPTIONS] COMMAND [ARGS]...

Options:

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

orca coe cluster¶

Manage Kubernetes clusters & cluster templates (Magnum).

Usage:

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

Options:

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

orca coe cluster create¶

Create a Kubernetes cluster.

Examples: orca cluster create my-k8s --template --node-count 3 orca cluster create prod --template --master-count 3 --node-count 5 --keypair my-key

Usage:

orca coe cluster create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--template`	text	Cluster template UUID or name.	`Sentinel.UNSET`
`--node-count`	integer	Number of worker nodes.	`1`
`--master-count`	integer	Number of master nodes.	`1`
`--keypair`	text	SSH keypair name.	None
`--timeout`	integer	Creation timeout (minutes).	`60`
`--flavor`	text	Node flavor (overrides template).	None
`--master-flavor`	text	Master flavor (overrides template).	None
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster delete¶

Delete a cluster.

Usage:

orca coe cluster delete [OPTIONS] CLUSTER_ID

Options:

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

orca coe cluster kubeconfig¶

Show the cluster API address and connection info.

Usage:

orca coe cluster kubeconfig [OPTIONS] CLUSTER_ID

Options:

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

orca coe cluster list¶

List clusters.

Usage:

orca coe cluster 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 coe cluster nodegroup¶

Manage node groups in a cluster.

Usage:

orca coe cluster nodegroup [OPTIONS] COMMAND [ARGS]...

Options:

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

orca coe cluster nodegroup create¶

Create a node group in a cluster.

Usage:

orca coe cluster nodegroup create [OPTIONS] CLUSTER_ID

Options:

Name	Type	Description	Default
`--name`	text	Node group name.	`Sentinel.UNSET`
`--flavor-id`	text	Flavor ID for nodes.	`Sentinel.UNSET`
`--node-count`	integer	Initial number of nodes.	`1`
`--min-node-count`	integer	Minimum node count (for autoscaling).	None
`--max-node-count`	integer	Maximum node count (for autoscaling).	None
`--role`	text	Node group role (worker/infra).	`worker`
`--image-id`	text	Override image ID.	None
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster nodegroup delete¶

Delete a node group.

Usage:

orca coe cluster nodegroup delete [OPTIONS] CLUSTER_ID NODEGROUP_ID

Options:

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

orca coe cluster nodegroup list¶

List node groups in a cluster.

Usage:

orca coe cluster nodegroup list [OPTIONS] CLUSTER_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 coe cluster nodegroup show¶

Show node group details.

Usage:

orca coe cluster nodegroup show [OPTIONS] CLUSTER_ID NODEGROUP_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 coe cluster nodegroup update¶

Update a node group (resize / autoscaling bounds).

Usage:

orca coe cluster nodegroup update [OPTIONS] CLUSTER_ID NODEGROUP_ID

Options:

Name	Type	Description	Default
`--node-count`	integer	New node count.	None
`--min-node-count`	integer	New minimum node count.	None
`--max-node-count`	integer	New maximum node count.	None
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster nodegroup-create¶

Create a node group in a cluster.

Usage:

orca coe cluster nodegroup-create [OPTIONS] CLUSTER_ID

Options:

Name	Type	Description	Default
`--name`	text	Node group name.	`Sentinel.UNSET`
`--flavor-id`	text	Flavor ID for nodes.	`Sentinel.UNSET`
`--node-count`	integer	Initial number of nodes.	`1`
`--min-node-count`	integer	Minimum node count (for autoscaling).	None
`--max-node-count`	integer	Maximum node count (for autoscaling).	None
`--role`	text	Node group role (worker/infra).	`worker`
`--image-id`	text	Override image ID.	None
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster nodegroup-delete¶

Delete a node group.

Usage:

orca coe cluster nodegroup-delete [OPTIONS] CLUSTER_ID NODEGROUP_ID

Options:

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

orca coe cluster nodegroup-list¶

List node groups in a cluster.

Usage:

orca coe cluster nodegroup-list [OPTIONS] CLUSTER_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 coe cluster nodegroup-show¶

Show node group details.

Usage:

orca coe cluster nodegroup-show [OPTIONS] CLUSTER_ID NODEGROUP_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 coe cluster nodegroup-update¶

Update a node group (resize / autoscaling bounds).

Usage:

orca coe cluster nodegroup-update [OPTIONS] CLUSTER_ID NODEGROUP_ID

Options:

Name	Type	Description	Default
`--node-count`	integer	New node count.	None
`--min-node-count`	integer	New minimum node count.	None
`--max-node-count`	integer	New maximum node count.	None
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster resize¶

Resize a cluster (change worker node count).

Usage:

orca coe cluster resize [OPTIONS] CLUSTER_ID

Options:

Name	Type	Description	Default
`--node-count`	integer	New number of worker nodes.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster show¶

Show cluster details.

Usage:

orca coe cluster show [OPTIONS] CLUSTER_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 coe cluster template¶

Manage cluster templates.

Usage:

orca coe cluster template [OPTIONS] COMMAND [ARGS]...

Options:

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

orca coe cluster template create¶

Create a cluster template.

Usage:

orca coe cluster template create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--image`	text	Base image UUID or name.	`Sentinel.UNSET`
`--external-network`	text	External network ID.	`Sentinel.UNSET`
`--coe`	choice (`kubernetes` \| `swarm` \| `mesos`)	N/A	`kubernetes`
`--keypair`	text	SSH keypair name.	None
`--flavor`	text	Node flavor.	None
`--master-flavor`	text	Master flavor.	None
`--network-driver`	text	Network driver (flannel, calico, etc.).	None
`--docker-volume-size`	integer	Docker volume size in GB.	None
`--dns`	text	DNS nameserver.	`8.8.8.8`
`--master-lb` / `--no-master-lb`	boolean	N/A	`True`
`--floating-ip` / `--no-floating-ip`	boolean	N/A	`True`
`--label`	text	Key=value label (repeatable). E.g. --label boot_volume_size=20	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster template delete¶

Delete a cluster template.

Usage:

orca coe cluster template delete [OPTIONS] TEMPLATE_ID

Options:

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

orca coe cluster template list¶

List cluster templates.

Usage:

orca coe cluster template 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 coe cluster template show¶

Show cluster template details.

Usage:

orca coe cluster template show [OPTIONS] TEMPLATE_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 coe cluster template-create¶

Create a cluster template.

Usage:

orca coe cluster template-create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--image`	text	Base image UUID or name.	`Sentinel.UNSET`
`--external-network`	text	External network ID.	`Sentinel.UNSET`
`--coe`	choice (`kubernetes` \| `swarm` \| `mesos`)	N/A	`kubernetes`
`--keypair`	text	SSH keypair name.	None
`--flavor`	text	Node flavor.	None
`--master-flavor`	text	Master flavor.	None
`--network-driver`	text	Network driver (flannel, calico, etc.).	None
`--docker-volume-size`	integer	Docker volume size in GB.	None
`--dns`	text	DNS nameserver.	`8.8.8.8`
`--master-lb` / `--no-master-lb`	boolean	N/A	`True`
`--floating-ip` / `--no-floating-ip`	boolean	N/A	`True`
`--label`	text	Key=value label (repeatable). E.g. --label boot_volume_size=20	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster template-delete¶

Delete a cluster template.

Usage:

orca coe cluster template-delete [OPTIONS] TEMPLATE_ID

Options:

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

orca coe cluster template-list¶

List cluster templates.

Usage:

orca coe cluster template-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 coe cluster template-show¶

Show cluster template details.

Usage:

orca coe cluster template-show [OPTIONS] TEMPLATE_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 coe cluster upgrade¶

Upgrade a cluster to a new template version.

Usage:

orca coe cluster upgrade [OPTIONS] CLUSTER_ID

Options:

Name	Type	Description	Default
`--template-id`	text	New cluster template ID to upgrade to.	`Sentinel.UNSET`
`--max-batch-size`	integer	Max number of nodes to upgrade simultaneously.	`1`
`--nodegroup`	text	Specific nodegroup to upgrade.	None
`--help`	boolean	Show this message and exit.	`False`

orca completion¶

Shell completion: print instructions or install automatically.

Examples: orca completion # auto-detect shell, print instructions orca completion bash # print instructions for bash (legacy) orca completion show zsh # same, explicit orca completion install # auto-detect shell, install orca completion install fish # install for fish

Usage:

orca completion [OPTIONS] COMMAND [ARGS]...

Options:

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

orca completion install¶

Install orca shell completion (auto-detects shell when omitted).

bash/zsh: appends an eval line to ~/.bashrc / ~/.zshrc (idempotent).
fish: writes ~/.config/fish/completions/orca.fish.

Usage:

orca completion install [OPTIONS] [[bash|zsh|fish]]

Options:

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

orca completion show¶

Print manual installation instructions for the given shell.

Usage:

orca completion show [OPTIONS] [[bash|zsh|fish]]

Options:

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

orca compute-service¶

Manage Nova compute services (nova-compute, nova-conductor, …).

Usage:

orca compute-service [OPTIONS] COMMAND [ARGS]...

Options:

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

orca compute-service delete¶

Force-delete a compute service record.

Use this to remove stale service entries after a host is decommissioned.

Usage:

orca compute-service delete [OPTIONS] SERVICE_ID

Options:

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

orca compute-service list¶

List compute services.

Usage:

orca compute-service list [OPTIONS]

Options:

Name	Type	Description	Default
`--host`	text	Filter by hostname.	None
`--binary`	text	Filter by binary (e.g. nova-compute).	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 compute-service set¶

Enable, disable, or force-down a compute service.

Examples: orca compute-service set 1 --disable --disabled-reason "maintenance" orca compute-service set 1 --enable orca compute-service set 1 --force-down

Usage:

orca compute-service set [OPTIONS] SERVICE_ID

Options:

Name	Type	Description	Default
`--enable` / `--disable`	boolean	Enable or disable the service.	None
`--disabled-reason`	text	Reason for disabling (used with --disable).	None
`--force-down` / `--no-force-down`	boolean	Force the service down (for evacuate scenarios).	None
`--help`	boolean	Show this message and exit.	`False`

orca console¶

Inspect server consoles (log, URL) — OSC-parity alias.

Equivalent to the primary orca server console … group.

Usage:

orca console [OPTIONS] COMMAND [ARGS]...

Options:

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

orca console log¶

Server boot log.

Usage:

orca console log [OPTIONS] COMMAND [ARGS]...

Options:

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

orca console log log¶

Show the server console output (boot log).

Examples: orca server console-log orca server console-log --lines 100 orca server console-log --lines 0 # all output

Usage:

orca console log log [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--lines`	integer	Number of lines to retrieve (0 = all).	`50`
`--help`	boolean	Show this message and exit.	`False`

orca console url¶

Server remote console URL.

Usage:

orca console url [OPTIONS] COMMAND [ARGS]...

Options:

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

orca console url url¶

Get a URL to access the server console (VNC/SPICE/serial).

Examples: orca server console-url orca server console-url --type spice-html5 orca server console-url --open

Usage:

orca console url url [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--type`	choice (`novnc` \| `xvpvnc` \| `spice-html5` \| `rdp-html5` \| `serial`)	Console type.	`novnc`
`--open`	boolean	Open the URL in the default system browser immediately.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca container¶

Manage object storage containers (Swift).

Usage:

orca container [OPTIONS] COMMAND [ARGS]...

Options:

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

orca container create¶

Create a container.

Usage:

orca container create [OPTIONS] CONTAINER

Options:

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

orca container delete¶

Delete a container.

Use --recursive to delete all objects in the container first.

Usage:

orca container delete [OPTIONS] CONTAINER

Options:

Name	Type	Description	Default
`--recursive`	boolean	Delete all objects before deleting the container.	`False`
`--yes`, `-y`	boolean	Skip confirmation prompt.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca container list¶

List containers.

Usage:

orca container 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 container save¶

Download all objects in a container to a local directory.

Usage:

orca container save [OPTIONS] CONTAINER

Options:

Name	Type	Description	Default
`--output-dir`	text	Local directory to save objects into.	`.`
`--help`	boolean	Show this message and exit.	`False`

orca container set¶

Set metadata on a container.

Usage:

orca container set [OPTIONS] CONTAINER

Options:

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

orca container show¶

Show container metadata.

Usage:

orca container show [OPTIONS] CONTAINER

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 container stats¶

Show account-level storage statistics.

Usage:

orca container stats [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 container unset¶

Remove metadata from a container.

Usage:

orca container unset [OPTIONS] CONTAINER

Options:

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

orca credential¶

Manage Keystone credentials.

Usage:

orca credential [OPTIONS] COMMAND [ARGS]...

Options:

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

orca credential create¶

Create a credential.

Usage:

orca credential create [OPTIONS]

Options:

Name	Type	Description	Default
`--user`	text	User ID who owns this credential.	`Sentinel.UNSET`
`--type`	text	Credential type (ec2, totp, cert, etc.).	`Sentinel.UNSET`
`--blob`	text	Credential data (JSON string or raw value).	`Sentinel.UNSET`
`--project`	text	Project ID (required for EC2 credentials).	None
`--help`	boolean	Show this message and exit.	`False`

orca credential delete¶

Delete a credential.

Usage:

orca credential delete [OPTIONS] CREDENTIAL_ID

Options:

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

orca credential list¶

List credentials.

Usage:

orca credential list [OPTIONS]

Options:

Name	Type	Description	Default
`--user`	text	Filter by user ID.	None
`--type`	text	Filter by type (ec2, totp, cert…).	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 credential set¶

Update a credential.

Usage:

orca credential set [OPTIONS] CREDENTIAL_ID

Options:

Name	Type	Description	Default
`--blob`	text	New credential data.	None
`--project`	text	New project ID.	None
`--help`	boolean	Show this message and exit.	`False`

orca credential show¶

Show credential details.

Usage:

orca credential show [OPTIONS] CREDENTIAL_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 doctor¶

Run a pre-deployment health check on your OpenStack environment.

Verifies authentication, quota headroom, default security group rules, and service availability. No destructive operations are performed unless --fix is specified.

Checks performed: ✓ Authentication & token validity ✓ Service reachability (Nova, Neutron, Cinder, Glance) ✓ Compute quota headroom (instances, cores, RAM) ✓ Volume quota headroom ✓ Network quota headroom (floating IPs, security groups) ✓ Default security group SSH/ICMP rules

Quota thresholds: Green < 70% — comfortable headroom Yellow 70–90% — monitor closely Red ≥ 90% — critical, next deploy may fail

Usage:

orca doctor [OPTIONS]

Options:

Name	Type	Description	Default
`--fix`	boolean	Attempt to fix auto-correctable issues.	`False`
`--cidr`	text	CIDR for auto-created security group rules (--fix). Defaults to interactive prompt when a TTY is detected, otherwise 0.0.0.0/0.	None
`--list-deprecated`	boolean	List every ADR-0008 deprecated alias in the CLI tree and exit (offline — no authentication required).	`False`
`--help`	boolean	Show this message and exit.	`False`

orca domain¶

Manage domains (Keystone v3).

Usage:

orca domain [OPTIONS] COMMAND [ARGS]...

Options:

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

orca domain create¶

Create a domain.

Usage:

orca domain create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--description`	text	N/A	None
`--enable` / `--disable`	boolean	N/A	`True`
`--help`	boolean	Show this message and exit.	`False`

orca domain delete¶

Delete a domain.

Usage:

orca domain delete [OPTIONS] DOMAIN_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca domain list¶

List domains.

Usage:

orca domain 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 domain set¶

Update a domain.

Usage:

orca domain set [OPTIONS] DOMAIN_ID

Options:

Name	Type	Description	Default
`--name`	text	N/A	None
`--description`	text	N/A	None
`--enable` / `--disable`	boolean	N/A	None
`--help`	boolean	Show this message and exit.	`False`

orca domain show¶

Show domain details.

Usage:

orca domain show [OPTIONS] DOMAIN_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 endpoint¶

Manage Keystone service endpoints.

Usage:

orca endpoint [OPTIONS] COMMAND [ARGS]...

Options:

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

orca endpoint create¶

Create an endpoint.

OSC-style positional form: endpoint create SERVICE INTERFACE URL. Legacy flag form: endpoint create --service ID --interface public --url .... Either works.

Usage:

orca endpoint create [OPTIONS] [SERVICE] [INTERFACE] [URL]

Options:

Name	Type	Description	Default
`--service`	text	Service ID (alternative to positional SERVICE).	None
`--interface`	choice (`public` \| `internal` \| `admin`)	Endpoint interface (alternative to positional INTERFACE).	None
`--url`	text	Endpoint URL (alternative to positional URL).	None
`--region`	text	Region ID.	None
`--enable` / `--disable`	boolean	Enable or disable the endpoint.	`True`
`--help`	boolean	Show this message and exit.	`False`

orca endpoint delete¶

Delete an endpoint.

Usage:

orca endpoint delete [OPTIONS] ENDPOINT_ID

Options:

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

orca endpoint list¶

List endpoints.

Usage:

orca endpoint list [OPTIONS]

Options:

Name	Type	Description	Default
`--service`	text	Filter by service ID or name.	None
`--interface`	choice (`public` \| `internal` \| `admin`)	Filter by interface type.	None
`--region`	text	Filter by region 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 endpoint project¶

Manage endpoint↔project filter (Keystone OS-EP-FILTER extension).

Usage:

orca endpoint project [OPTIONS] COMMAND [ARGS]...

Options:

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

orca endpoint project add¶

Restrict an endpoint to a project.

Usage:

orca endpoint project add [OPTIONS] ENDPOINT_ID PROJECT_ID

Options:

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

orca endpoint project list¶

List projects an endpoint is bound to.

Usage:

orca endpoint project list [OPTIONS] ENDPOINT_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 endpoint project remove¶

Drop an endpoint↔project binding.

Usage:

orca endpoint project remove [OPTIONS] ENDPOINT_ID PROJECT_ID

Options:

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

orca endpoint set¶

Update an endpoint.

Usage:

orca endpoint set [OPTIONS] ENDPOINT_ID

Options:

Name	Type	Description	Default
`--url`	text	New URL.	None
`--interface`	choice (`public` \| `internal` \| `admin`)	New interface type.	None
`--region`	text	New region ID.	None
`--enable` / `--disable`	boolean	Enable or disable.	None
`--help`	boolean	Show this message and exit.	`False`

orca endpoint show¶

Show endpoint details.

Usage:

orca endpoint show [OPTIONS] ENDPOINT_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 endpoint-group¶

Manage Keystone endpoint groups.

Usage:

orca endpoint-group [OPTIONS] COMMAND [ARGS]...

Options:

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

orca endpoint-group add-project¶

Associate a project with an endpoint group.

Usage:

orca endpoint-group add-project [OPTIONS] ENDPOINT_GROUP_ID PROJECT_ID

Options:

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

orca endpoint-group create¶

Create an endpoint group.

OSC-style: endpoint-group create my-eg --filter .... Legacy: endpoint-group create --name my-eg --filter ....

Usage:

orca endpoint-group create [OPTIONS] [NAME]

Options:

Name	Type	Description	Default
`--name`	text	Endpoint group name (alternative to positional NAME).	None
`--filter`	text	Filter criterion (e.g. service_id=xxx). Repeatable.	`Sentinel.UNSET`
`--description`	text	Description.	``
`--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 endpoint-group delete¶

Delete an endpoint group.

Usage:

orca endpoint-group delete [OPTIONS] ENDPOINT_GROUP_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca endpoint-group list¶

List endpoint groups.

Usage:

orca endpoint-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 endpoint-group project¶

Manage project membership of an endpoint group.

Usage:

orca endpoint-group project [OPTIONS] COMMAND [ARGS]...

Options:

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

orca endpoint-group project add¶

Associate a project with an endpoint group.

Usage:

orca endpoint-group project add [OPTIONS] ENDPOINT_GROUP_ID PROJECT_ID

Options:

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

orca endpoint-group project remove¶

Remove a project from an endpoint group.

Usage:

orca endpoint-group project remove [OPTIONS] ENDPOINT_GROUP_ID PROJECT_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca endpoint-group remove-project¶

Remove a project from an endpoint group.

Usage:

orca endpoint-group remove-project [OPTIONS] ENDPOINT_GROUP_ID PROJECT_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca endpoint-group set¶

Update an endpoint group.

Usage:

orca endpoint-group set [OPTIONS] ENDPOINT_GROUP_ID

Options:

Name	Type	Description	Default
`--name`	text	N/A	None
`--description`	text	N/A	None
`--filter`	text	N/A	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca endpoint-group show¶

Show an endpoint group.

Usage:

orca endpoint-group show [OPTIONS] ENDPOINT_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 event¶

Browse instance actions and events (Nova).

Usage:

orca event [OPTIONS] COMMAND [ARGS]...

Options:

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

orca event all¶

List recent instance actions across ALL servers.

Fetches all servers, then gathers their actions, merges, and sorts by start time (newest first).

Examples: orca event all orca event all --limit 20 orca event all --action create

Usage:

orca event all [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	integer	Max number of events to display.	`50`
`--action`	text	Filter by action type (e.g. create, delete).	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 event list¶

List instance actions for a server.

Examples: orca event list orca event list -f json

Usage:

orca event list [OPTIONS] SERVER_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 event show¶

Show details for a single instance action, including sub-events.

Examples: orca event show

Usage:

orca event show [OPTIONS] SERVER_ID REQUEST_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 event timeline¶

Show a chronological timeline of all actions for a server.

Renders a Rich Tree with each action as a branch and sub-events as leaves.

Examples: orca event timeline

Usage:

orca event timeline [OPTIONS] SERVER_ID

Options:

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

orca export¶

Export project infrastructure as YAML/JSON.

Usage:

orca export [OPTIONS]

Options:

Name	Type	Description	Default
`--output`, `-o`	text	Output file path (default: stdout).	None
`--resources`, `-r`	text	Comma-separated resource types to export (default: all).	None
`--format`, `-f`	choice (`yaml` \| `json`)	Output format.	`yaml`
`--help`	boolean	Show this message and exit.	`False`

orca extension¶

List or inspect API extensions enabled on this cloud.

Currently surfaces Neutron extensions (the most actively used). OSC's cross-service openstack extension list aggregates several services — orca focuses on Neutron because that's where the meaningful discoverability lives (port-forwarding, metering, segment-range, QoS rule types, RBAC scopes, …).

Usage:

orca extension [OPTIONS] COMMAND [ARGS]...

Options:

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

orca extension list¶

List enabled Neutron extensions.

Usage:

orca extension 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 extension show¶

Show details of a single Neutron extension by alias.

Usage:

orca extension show [OPTIONS] ALIAS

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 federation-protocol¶

Manage Keystone federation protocols.

Usage:

orca federation-protocol [OPTIONS] COMMAND [ARGS]...

Options:

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

orca federation-protocol create¶

Create a federation protocol.

Usage:

orca federation-protocol create [OPTIONS] IDP_ID PROTOCOL_ID

Options:

Name	Type	Description	Default
`--mapping-id`	text	Mapping ID to associate.	`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 federation-protocol delete¶

Delete a federation protocol.

Usage:

orca federation-protocol delete [OPTIONS] IDP_ID PROTOCOL_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca federation-protocol list¶

List federation protocols for an identity provider.

Usage:

orca federation-protocol list [OPTIONS] IDP_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 federation-protocol set¶

Update a federation protocol.

Usage:

orca federation-protocol set [OPTIONS] IDP_ID PROTOCOL_ID

Options:

Name	Type	Description	Default
`--mapping-id`	text	New mapping ID.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca federation-protocol show¶

Show a federation protocol.

Usage:

orca federation-protocol show [OPTIONS] IDP_ID PROTOCOL_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 find¶

Universal search across every OpenStack resource.

Matches the query (case-insensitive substring) against IDs, names, IPs, CIDRs, fingerprints, MAC addresses, and device references.

Examples: orca find 10.0.0.5 # who uses this IP? orca find web # anything matching 'web' orca find abc12345 # by partial UUID orca find 10.0.0.5 -t ports -t servers

Usage:

orca find [OPTIONS] QUERY

Options:

Name	Type	Description	Default
`--type`, `-t`	choice (`servers` \| `ports` \| `floatingips` \| `volumes` \| `networks` \| `subnets` \| `security_groups` \| `routers` \| `images` \| `keypairs`)	Restrict search to one or more resource types (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca flavor¶

Manage flavors.

Usage:

orca flavor [OPTIONS] COMMAND [ARGS]...

Options:

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

orca flavor access¶

Manage per-project access on private flavors.

Usage:

orca flavor access [OPTIONS] COMMAND [ARGS]...

Options:

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

orca flavor access add¶

Grant a project access to a private flavor.

Usage:

orca flavor access add [OPTIONS] FLAVOR_ID PROJECT_ID

Options:

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

orca flavor access list¶

List projects that have access to a private flavor.

Usage:

orca flavor access list [OPTIONS] FLAVOR_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 flavor access remove¶

Revoke a project's access to a private flavor.

Usage:

orca flavor access remove [OPTIONS] FLAVOR_ID PROJECT_ID

Options:

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

orca flavor access-add¶

Grant a project access to a private flavor.

Usage:

orca flavor access-add [OPTIONS] FLAVOR_ID PROJECT_ID

Options:

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

orca flavor access-list¶

List projects that have access to a private flavor.

Usage:

orca flavor access-list [OPTIONS] FLAVOR_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 flavor access-remove¶

Revoke a project's access to a private flavor.

Usage:

orca flavor access-remove [OPTIONS] FLAVOR_ID PROJECT_ID

Options:

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

orca flavor create¶

Create a flavor.

Usage:

orca flavor create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--vcpus`	integer	Number of vCPUs.	`Sentinel.UNSET`
`--ram`	integer	RAM in MB.	`Sentinel.UNSET`
`--disk`	integer	Root disk size in GB.	`0`
`--ephemeral`	integer	Ephemeral disk in GB.	`0`
`--swap`	integer	Swap disk in MB.	`0`
`--rxtx-factor`	float	RX/TX factor.	`1.0`
`--public` / `--private`	boolean	Make flavor public or private.	`True`
`--id`	text	Flavor ID (auto-generated if 'auto').	`auto`
`--help`	boolean	Show this message and exit.	`False`

orca flavor delete¶

Delete a flavor.

Usage:

orca flavor delete [OPTIONS] FLAVOR_ID

Options:

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

orca flavor list¶

List available flavors.

With no --limit the command auto-paginates through all flavors using the Nova marker cursor (useful on clouds exposing hundreds of flavors).

Usage:

orca flavor list [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	integer	Max flavors to return. Omit for all (auto-paginates).	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 flavor set¶

Set extra specs on a flavor.

Examples: orca flavor set --property hw:cpu_policy=dedicated orca flavor set --property hw:mem_page_size=large --property aggregate_instance_extra_specs:ssd=true

Usage:

orca flavor set [OPTIONS] FLAVOR_ID

Options:

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

orca flavor show¶

Show flavor details.

Usage:

orca flavor show [OPTIONS] FLAVOR_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 flavor unset¶

Unset extra specs from a flavor.

Usage:

orca flavor unset [OPTIONS] FLAVOR_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 floating-ip¶

Manage floating IPs.

Usage:

orca floating-ip [OPTIONS] COMMAND [ARGS]...

Options:

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

orca floating-ip associate¶

Associate a floating IP with a port.

Examples: orca floating-ip associate --port-id

Usage:

orca floating-ip associate [OPTIONS] FLOATING_IP_ID

Options:

Name	Type	Description	Default
`--port-id`	text	Port ID to associate with.	`Sentinel.UNSET`
`--fixed-ip`	text	Fixed IP on the port (if multiple).	None
`--help`	boolean	Show this message and exit.	`False`

orca floating-ip bulk-release¶

Bulk-release floating IPs to free up unused addresses.

By default releases all IPs with status DOWN. Use --unassociated to release all IPs not attached to any port. Combine both for maximum cleanup.

Examples: orca floating-ip bulk-release # release all DOWN orca floating-ip bulk-release --status ERROR # release all ERROR orca floating-ip bulk-release -u # release all unassociated orca floating-ip bulk-release -u -y # auto-confirm

Usage:

orca floating-ip bulk-release [OPTIONS]

Options:

Name	Type	Description	Default
`--status`, `-s`	text	Release floating IPs with this status (DOWN, ERROR, etc.).	`DOWN`
`--unassociated`, `-u`	boolean	Release all unassociated floating IPs (no port_id), regardless of status.	`False`
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca floating-ip create¶

Allocate a floating IP from an external network.

Usage:

orca floating-ip create [OPTIONS]

Options:

Name	Type	Description	Default
`--network`	text	External network ID.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca floating-ip delete¶

Release a floating IP.

Usage:

orca floating-ip delete [OPTIONS] FLOATING_IP_ID

Options:

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

orca floating-ip disassociate¶

Disassociate a floating IP from its port.

Usage:

orca floating-ip disassociate [OPTIONS] FLOATING_IP_ID

Options:

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

orca floating-ip list¶

List floating IPs.

Usage:

orca floating-ip 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 floating-ip pool¶

Inspect the pools (external networks) that floating IPs can come from.

Usage:

orca floating-ip pool [OPTIONS] COMMAND [ARGS]...

Options:

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

orca floating-ip pool list¶

List external networks usable as floating-IP pools.

Usage:

orca floating-ip pool 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 floating-ip port-forwarding¶

Manage port-forwarding rules attached to a floating IP.

Usage:

orca floating-ip port-forwarding [OPTIONS] COMMAND [ARGS]...

Options:

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

orca floating-ip port-forwarding create¶

Create a port-forwarding rule.

Example: orca floating-ip port-forwarding create \ --internal-port-id --internal-ip-address 10.0.0.5 \ --internal-port 22 --external-port 2222

Usage:

orca floating-ip port-forwarding create [OPTIONS] FIP_ID

Options:

Name	Type	Description	Default
`--internal-port-id`	text	Port to forward traffic to.	`Sentinel.UNSET`
`--internal-ip-address`	text	Fixed IP of the internal port to target.	`Sentinel.UNSET`
`--internal-port`	integer	Internal TCP/UDP port.	`Sentinel.UNSET`
`--external-port`	integer	External TCP/UDP port (on the floating IP).	`Sentinel.UNSET`
`--protocol`	choice (`tcp` \| `udp`)	N/A	`tcp`
`--description`	text	Free-text description.	None
`--help`	boolean	Show this message and exit.	`False`

orca floating-ip port-forwarding delete¶

Delete a port-forwarding rule.

Usage:

orca floating-ip port-forwarding delete [OPTIONS] FIP_ID PF_ID

Options:

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

orca floating-ip port-forwarding list¶

List port-forwarding rules on a floating IP.

Usage:

orca floating-ip port-forwarding list [OPTIONS] FIP_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 floating-ip port-forwarding set¶

Update a port-forwarding rule.

Usage:

orca floating-ip port-forwarding set [OPTIONS] FIP_ID PF_ID

Options:

Name	Type	Description	Default
`--internal-port-id`	text	N/A	None
`--internal-ip-address`	text	N/A	None
`--internal-port`	integer	N/A	None
`--external-port`	integer	N/A	None
`--protocol`	choice (`tcp` \| `udp`)	N/A	None
`--description`	text	N/A	None
`--help`	boolean	Show this message and exit.	`False`

orca floating-ip port-forwarding show¶

Show a port-forwarding rule.

Usage:

orca floating-ip port-forwarding show [OPTIONS] FIP_ID PF_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 floating-ip set¶

Set floating IP properties.

Examples: orca floating-ip set --port orca floating-ip set --description "my FIP" orca floating-ip set --qos-policy orca floating-ip set --no-qos-policy

Usage:

orca floating-ip set [OPTIONS] FLOATING_IP_ID

Options:

Name	Type	Description	Default
`--port`	text	Associate with port ID.	None
`--fixed-ip-address`	text	Fixed IP on the port (if multiple).	None
`--description`	text	Set description.	None
`--qos-policy`	text	Attach QoS policy ID.	None
`--no-qos-policy`	boolean	Remove attached QoS policy.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca floating-ip show¶

Show floating IP details.

Usage:

orca floating-ip show [OPTIONS] FLOATING_IP_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 floating-ip unset¶

Unset floating IP properties.

Examples: orca floating-ip unset --port orca floating-ip unset --qos-policy

Usage:

orca floating-ip unset [OPTIONS] FLOATING_IP_ID

Options:

Name	Type	Description	Default
`--port`	boolean	Disassociate port.	`False`
`--qos-policy`	boolean	Remove QoS policy.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca group¶

Manage groups (Keystone v3).

Usage:

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

Options:

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

orca group add-user¶

Add a user to a group.

Usage:

orca group add-user [OPTIONS] GROUP_ID USER_ID

Options:

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

orca group create¶

Create a group.

Usage:

orca group create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--description`	text	N/A	None
`--domain`	text	N/A	None
`--help`	boolean	Show this message and exit.	`False`

orca group delete¶

Delete a group.

Usage:

orca group delete [OPTIONS] GROUP_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca group list¶

List groups.

Usage:

orca group list [OPTIONS]

Options:

Name	Type	Description	Default
`--domain`	text	Filter by domain 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 group member¶

Inspect users belonging to a group.

Usage:

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

Options:

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

orca group member list¶

List users in a group.

Usage:

orca group member list [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 group member-list¶

List users in a group.

Usage:

orca group member-list [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 group remove-user¶

Remove a user from a group.

Usage:

orca group remove-user [OPTIONS] GROUP_ID USER_ID

Options:

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

orca group set¶

Update a group.

Usage:

orca group set [OPTIONS] GROUP_ID

Options:

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

orca group show¶

Show group details.

Usage:

orca 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 group user¶

Manage user membership of a group.

Usage:

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

Options:

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

orca group user add¶

Add a user to a group.

Usage:

orca group user add [OPTIONS] GROUP_ID USER_ID

Options:

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

orca group user remove¶

Remove a user from a group.

Usage:

orca group user remove [OPTIONS] GROUP_ID USER_ID

Options:

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

orca hypervisor¶

Manage hypervisors (Nova).

Usage:

orca hypervisor [OPTIONS] COMMAND [ARGS]...

Options:

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

orca hypervisor list¶

List hypervisors.

Usage:

orca hypervisor 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 hypervisor show¶

Show hypervisor details.

Usage:

orca hypervisor show [OPTIONS] HYPERVISOR_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 hypervisor stats¶

Aggregate hypervisor statistics across the cluster.

Usage:

orca hypervisor stats [OPTIONS] COMMAND [ARGS]...

Options:

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

orca hypervisor stats show¶

Show cluster-wide hypervisor stats (vCPUs, RAM, disk, running VMs).

Usage:

orca hypervisor stats show [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 hypervisor usage¶

Show fill rate per hypervisor, sorted by load.

Combines vCPU, RAM and disk usage into a per-host 'score' (the worst dimension) so the most-saturated hypervisors surface at the top.

Color thresholds: Green < 70% — comfortable headroom Yellow 70–90% — monitor closely Red ≥ 90% — critical

Usage:

orca hypervisor usage [OPTIONS]

Options:

Name	Type	Description	Default
`--sort-by`	choice (`cpu` \| `ram` \| `disk` \| `max` \| `vms`)	Metric to sort by. 'max' picks the worst of CPU/RAM/disk per host.	`max`
`--reverse`	boolean	Sort least-loaded first (default: most-loaded first).	`False`
`--threshold`	integer range (between `0` and `100`)	Only show hypervisors whose 'max' fill rate is ≥ this percentage.	`0`
`--top`	integer	Show only the top N hypervisors after sorting.	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 identity-provider¶

Manage Keystone identity providers (federation).

Usage:

orca identity-provider [OPTIONS] COMMAND [ARGS]...

Options:

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

orca identity-provider create¶

Create an identity provider.

Usage:

orca identity-provider create [OPTIONS] IDP_ID

Options:

Name	Type	Description	Default
`--remote-id`	text	Remote entity ID. Repeatable.	`Sentinel.UNSET`
`--description`	text	Description.	``
`--domain-id`	text	Domain to associate.	None
`--enable` / `--disable`	boolean	N/A	`True`
`--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 identity-provider delete¶

Delete an identity provider.

Usage:

orca identity-provider delete [OPTIONS] IDP_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca identity-provider list¶

List identity providers.

Usage:

orca identity-provider 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 identity-provider set¶

Update an identity provider.

Usage:

orca identity-provider set [OPTIONS] IDP_ID

Options:

Name	Type	Description	Default
`--description`	text	N/A	None
`--enable` / `--disable`	boolean	N/A	None
`--remote-id`	text	N/A	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca identity-provider show¶

Show an identity provider.

Usage:

orca identity-provider show [OPTIONS] IDP_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 image¶

Manage images.

Usage:

orca image [OPTIONS] COMMAND [ARGS]...

Options:

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

orca image add¶

OSC parity verbs (image add project …).

Usage:

orca image add [OPTIONS] COMMAND [ARGS]...

Options:

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

orca image add create¶

Share an image with a project (sets status to 'pending').

The project must then run 'orca image member-set --status accepted' to confirm acceptance.

Example: orca image member-create

Usage:

orca image add create [OPTIONS] IMAGE_ID PROJECT_ID

Options:

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

orca image cache¶

Manage the Glance image cache (admin).

Usage:

orca image cache [OPTIONS] COMMAND [ARGS]...

Options:

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

orca image cache clear¶

Clear the entire image cache (admin).

Usage:

orca image cache clear [OPTIONS]

Options:

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

orca image cache delete¶

Remove a specific image from the cache (admin).

Usage:

orca image cache delete [OPTIONS] IMAGE_ID

Options:

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

orca image cache list¶

List cached and queued images (admin).

Usage:

orca image cache 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 image cache queue¶

Queue an image for pre-caching (admin).

Usage:

orca image cache queue [OPTIONS] IMAGE_ID

Options:

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

orca image cache-clear¶

Clear the entire image cache (admin).

Usage:

orca image cache-clear [OPTIONS]

Options:

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

orca image cache-delete¶

Remove a specific image from the cache (admin).

Usage:

orca image cache-delete [OPTIONS] IMAGE_ID

Options:

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

orca image cache-list¶

List cached and queued images (admin).

Usage:

orca image cache-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 image cache-queue¶

Queue an image for pre-caching (admin).

Usage:

orca image cache-queue [OPTIONS] IMAGE_ID

Options:

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

orca image create¶

Create a new image (and optionally upload data).

Examples: orca image create my-image orca image create my-image --file ubuntu.qcow2 orca image create my-image --disk-format raw --file disk.img orca image create my-image --property os_distro=ubuntu \ --property os_version=24.04 \ --property hw_qemu_guest_agent=yes

Usage:

orca image create [OPTIONS] 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`
`--min-disk`	integer	Min disk (GB).	`0`
`--min-ram`	integer	Min RAM (MB).	`0`
`--visibility`	choice (`private` \| `shared` \| `community` \| `public`)	Visibility.	`private`
`--file`	path	Upload image data from file immediately.	None
`--property`	text	Custom image property to set on creation (e.g. os_distro=ubuntu). Repeatable. Values may contain '='; only the first '=' splits.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca image deactivate¶

Deactivate an image (make data unavailable).

Usage:

orca image deactivate [OPTIONS] IMAGE_ID

Options:

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

orca image delete¶

Delete an image.

Usage:

orca image delete [OPTIONS] IMAGE_ID

Options:

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

orca image download¶

Download image data to a local file.

Supports large files — streams to disk without loading into memory. Examples: orca image download -o /tmp/my-image.qcow2

Note: Snapshots taken with 'orca server image create' on a boot-from-volume instance return 0 bytes — they are Glance shells pointing at a Cinder snapshot. Use 'orca volume upload-to-image' to materialize the underlying volume as a real, downloadable image first.

Usage:

orca image download [OPTIONS] IMAGE_ID

Options:

Name	Type	Description	Default
`--output`, `-o`	path	Output file path.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca image download¶

Download image data to a local file.

Supports large files — streams to disk without loading into memory. Examples: orca image download -o /tmp/my-image.qcow2

Note: Snapshots taken with 'orca server image create' on a boot-from-volume instance return 0 bytes — they are Glance shells pointing at a Cinder snapshot. Use 'orca volume upload-to-image' to materialize the underlying volume as a real, downloadable image first.

Usage:

orca image download [OPTIONS] IMAGE_ID

Options:

Name	Type	Description	Default
`--output`, `-o`	path	Output file path.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca image import¶

Import image data using the Glance v2 import API.

Methods: web-download Pull image from a public URI (requires --uri) glance-direct Finalise an image whose binary was already staged copy-image Copy image data across stores (requires --store)

Examples: orca image import --method web-download --uri https://example.com/image.img orca image import --method glance-direct orca image import --method copy-image --store ceph1 --store ceph2

Usage:

orca image import [OPTIONS] IMAGE_ID

Options:

Name	Type	Description	Default
`--method`	choice (`web-download` \| `glance-direct` \| `copy-image`)	Import method.	`web-download`
`--uri`	text	Source URI (required for web-download).	None
`--store`	text	Target store(s) for copy-image (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca image info¶

Inspect Glance-advertised capabilities (stores, import methods).

Usage:

orca image info [OPTIONS] COMMAND [ARGS]...

Options:

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

orca image info import¶

List Glance image-import methods enabled on this cloud.

Equivalent to openstack image import info.

Usage:

orca image info import [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 image list¶

List available images.

Examples: orca image list orca image list --visibility public orca image list --visibility shared -f value -c ID -c Name

Usage:

orca image list [OPTIONS]

Options:

Name	Type	Description	Default
`--visibility`	choice (`public` \| `private` \| `shared` \| `community` \| `all`)	Filter by image visibility. Glance defaults to 'all' the caller can see.	`all`
`--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 image member¶

Manage Glance image members (sharing).

Usage:

orca image member [OPTIONS] COMMAND [ARGS]...

Options:

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

orca image member create¶

Share an image with a project (sets status to 'pending').

The project must then run 'orca image member-set --status accepted' to confirm acceptance.

Example: orca image member-create

Usage:

orca image member create [OPTIONS] IMAGE_ID PROJECT_ID

Options:

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

orca image member delete¶

Revoke a project's access to a shared image.

Usage:

orca image member delete [OPTIONS] IMAGE_ID PROJECT_ID

Options:

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

orca image member list¶

List all projects that have access to a shared image.

The image must have visibility=shared.

Usage:

orca image member list [OPTIONS] IMAGE_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 image member set¶

Accept, reject, or reset a shared image invitation.

Run this as the receiving project to accept or reject sharing.

Examples: orca image member-set --status accepted orca image member-set --status rejected

Usage:

orca image member set [OPTIONS] IMAGE_ID PROJECT_ID

Options:

Name	Type	Description	Default
`--status`	choice (`accepted` \| `rejected` \| `pending`)	New membership status.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca image member show¶

Show a specific project's membership status for a shared image.

Usage:

orca image member show [OPTIONS] IMAGE_ID PROJECT_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 image member show¶

Show a specific project's membership status for a shared image.

Usage:

orca image member show [OPTIONS] IMAGE_ID PROJECT_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 image member-create¶

Share an image with a project (sets status to 'pending').

The project must then run 'orca image member-set --status accepted' to confirm acceptance.

Example: orca image member-create

Usage:

orca image member-create [OPTIONS] IMAGE_ID PROJECT_ID

Options:

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

orca image member-delete¶

Revoke a project's access to a shared image.

Usage:

orca image member-delete [OPTIONS] IMAGE_ID PROJECT_ID

Options:

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

orca image member-list¶

List all projects that have access to a shared image.

The image must have visibility=shared.

Usage:

orca image member-list [OPTIONS] IMAGE_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 image member-set¶

Accept, reject, or reset a shared image invitation.

Run this as the receiving project to accept or reject sharing.

Examples: orca image member-set --status accepted orca image member-set --status rejected

Usage:

orca image member-set [OPTIONS] IMAGE_ID PROJECT_ID

Options:

Name	Type	Description	Default
`--status`	choice (`accepted` \| `rejected` \| `pending`)	New membership status.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca image member-show¶

Show a specific project's membership status for a shared image.

Usage:

orca image member-show [OPTIONS] IMAGE_ID PROJECT_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 image metadef¶

Manage Glance metadata definitions (namespaces, objects, properties).

Usage:

orca image metadef [OPTIONS] COMMAND [ARGS]...

Options:

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

orca image metadef namespace¶

Manage metadef namespaces.

Usage:

orca image metadef namespace [OPTIONS] COMMAND [ARGS]...

Options:

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

orca image metadef namespace create¶

Create a metadef namespace.

Usage:

orca image metadef namespace create [OPTIONS] NAMESPACE

Options:

Name	Type	Description	Default
`--display-name`	text	Human-readable name.	None
`--description`	text	Description.	None
`--visibility`	choice (`private` \| `public`)	N/A	`private`
`--protected`	boolean	Prevent deletion via API.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca image metadef namespace delete¶

Delete a metadef namespace (and all its objects/properties).

Usage:

orca image metadef namespace delete [OPTIONS] NAMESPACE

Options:

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

orca image metadef namespace list¶

List metadef namespaces.

Usage:

orca image metadef namespace 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 image metadef namespace set¶

Update a metadef namespace.

Usage:

orca image metadef namespace set [OPTIONS] NAMESPACE

Options:

Name	Type	Description	Default
`--display-name`	text	N/A	None
`--description`	text	N/A	None
`--visibility`	choice (`private` \| `public`)	N/A	None
`--protected` / `--no-protected`	boolean	N/A	None
`--help`	boolean	Show this message and exit.	`False`

orca image metadef namespace show¶

Show namespace details.

Usage:

orca image metadef namespace show [OPTIONS] NAMESPACE

Options:

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

orca image metadef object¶

Manage metadef objects within a namespace.

Usage:

orca image metadef object [OPTIONS] COMMAND [ARGS]...

Options:

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

orca image metadef object create¶

Create a metadef object (a grouping of related properties).

Usage:

orca image metadef object create [OPTIONS] NAMESPACE NAME

Options:

Name	Type	Description	Default
`--description`	text	N/A	None
`--required`	text	Required property name (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca image metadef object delete¶

Delete a metadef object.

Usage:

orca image metadef object delete [OPTIONS] NAMESPACE OBJECT_NAME

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca image metadef object list¶

List objects in a namespace.

Usage:

orca image metadef object list [OPTIONS] NAMESPACE

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 image metadef object property¶

Inspect a property nested inside a metadef object.

Usage:

orca image metadef object property [OPTIONS] COMMAND [ARGS]...

Options:

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

# orca image metadef object property show¶

Show one property nested inside a metadef object.

Equivalent to openstack image metadef object property show. Glance returns the property as a key inside the object's properties dict — we resolve it client-side.

Usage:

orca image metadef object property show [OPTIONS] NAMESPACE OBJECT_NAME
                                        PROPERTY_NAME

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 image metadef object show¶

Show a metadef object.

Usage:

orca image metadef object show [OPTIONS] NAMESPACE OBJECT_NAME

Options:

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

orca image metadef object update¶

Update a metadef object.

Usage:

orca image metadef object update [OPTIONS] NAMESPACE OBJECT_NAME

Options:

Name	Type	Description	Default
`--description`	text	N/A	None
`--required`	text	Replace required list (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca image metadef property¶

Manage metadef properties within a namespace.

Usage:

orca image metadef property [OPTIONS] COMMAND [ARGS]...

Options:

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

orca image metadef property create¶

Define a property schema in a namespace.

Usage:

orca image metadef property create [OPTIONS] NAMESPACE NAME

Options:

Name	Type	Description	Default
`--type`	choice (`string` \| `integer` \| `number` \| `boolean` \| `array`)	JSON Schema type.	`Sentinel.UNSET`
`--title`	text	N/A	None
`--description`	text	N/A	None
`--default`	text	N/A	None
`--help`	boolean	Show this message and exit.	`False`

orca image metadef property delete¶

Delete a metadef property.

Usage:

orca image metadef property delete [OPTIONS] NAMESPACE NAME

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca image metadef property list¶

List properties in a namespace.

Usage:

orca image metadef property list [OPTIONS] NAMESPACE

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 image metadef property set¶

Update a metadef property.

Usage:

orca image metadef property set [OPTIONS] NAMESPACE NAME

Options:

Name	Type	Description	Default
`--type`	choice (`string` \| `integer` \| `number` \| `boolean` \| `array`)	N/A	None
`--title`	text	N/A	None
`--description`	text	N/A	None
`--default`	text	N/A	None
`--help`	boolean	Show this message and exit.	`False`

orca image metadef property show¶

Show a metadef property's schema.

Usage:

orca image metadef property show [OPTIONS] NAMESPACE NAME

Options:

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

orca image metadef resource-type¶

Inspect Glance resource types and their namespace associations.

Usage:

orca image metadef resource-type [OPTIONS] COMMAND [ARGS]...

Options:

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

orca image metadef resource-type association-create¶

Associate a resource type with a namespace.

Usage:

orca image metadef resource-type association-create [OPTIONS] NAMESPACE
                                                    RESOURCE_TYPE

Options:

Name	Type	Description	Default
`--prefix`	text	Property prefix (e.g. 'hw_').	None
`--help`	boolean	Show this message and exit.	`False`

orca image metadef resource-type association-delete¶

Remove a resource type association from a namespace.

Usage:

orca image metadef resource-type association-delete [OPTIONS] NAMESPACE
                                                    RESOURCE_TYPE

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca image metadef resource-type association-list¶

List resource type associations on a namespace.

Usage:

orca image metadef resource-type association-list [OPTIONS] NAMESPACE

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 image metadef resource-type list¶

List all Glance resource types globally.

Usage:

orca image metadef resource-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 image reactivate¶

Reactivate a deactivated image.

Usage:

orca image reactivate [OPTIONS] IMAGE_ID

Options:

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

orca image remove¶

OSC parity verbs (image remove project …).

Usage:

orca image remove [OPTIONS] COMMAND [ARGS]...

Options:

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

orca image remove delete¶

Revoke a project's access to a shared image.

Usage:

orca image remove delete [OPTIONS] IMAGE_ID PROJECT_ID

Options:

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

Share an image with a project and immediately accept on their behalf (admin mode).

Combines member-create + member-set --status accepted in one step. Requires admin credentials or the ability to act on behalf of both projects.

Example: orca image share-and-accept --yes

Usage:

orca image share-and-accept [OPTIONS] IMAGE_ID PROJECT_ID

Options:

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

orca image show¶

Show image details, including custom properties and integrity hashes.

Custom properties (anything outside the Glance v2 standard schema, e.g. os_distro, os_version, hw_qemu_guest_agent) are surfaced separately: table → rendered as a "Properties" sub-table after the main table json → nested under a top-level "properties" key value → printed after the standard fields, one KEY VALUE per line

Usage:

orca image show [OPTIONS] IMAGE_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 image shrink¶

Convert a raw image to qcow2 with compression to save space.

Downloads the image, converts it locally via qemu-img convert, then uploads the compressed result as a new image. The original is deactivated (not deleted) so you can verify before removing it.

Requires qemu-img to be installed locally.

Examples: orca image shrink orca image shrink -y

Usage:

orca image shrink [OPTIONS] IMAGE_ID

Options:

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

orca image stage¶

Upload image data to the staging area (interruptible import).

Uploads binary data to /v2/images/{id}/stage without activating the image. After staging, run:

orca image import --method glance-direct

to complete the import. Requires Glance ≥ 16.0 (Queens) and API v2.6+.

Example: orca image stage /path/to/ubuntu.qcow2 orca image import --method glance-direct

Usage:

orca image stage [OPTIONS] IMAGE_ID FILE_PATH

Options:

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

orca image stores¶

Inspect Glance multi-store backends.

Usage:

orca image stores [OPTIONS] COMMAND [ARGS]...

Options:

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

orca image stores info¶

List available Glance storage backends (multi-store only).

Example: orca image stores-info orca image stores-info --detail

Usage:

orca image stores info [OPTIONS]

Options:

Name	Type	Description	Default
`--detail`	boolean	Show store properties (admin only, requires Glance ≥ 2.15).	`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 image stores info¶

List available Glance storage backends (multi-store only).

Example: orca image stores-info orca image stores-info --detail

Usage:

orca image stores info [OPTIONS]

Options:

Name	Type	Description	Default
`--detail`	boolean	Show store properties (admin only, requires Glance ≥ 2.15).	`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 image stores-info¶

List available Glance storage backends (multi-store only).

Example: orca image stores-info orca image stores-info --detail

Usage:

orca image stores-info [OPTIONS]

Options:

Name	Type	Description	Default
`--detail`	boolean	Show store properties (admin only, requires Glance ≥ 2.15).	`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 image tag¶

Manage tags on a Glance image.

Usage:

orca image tag [OPTIONS] COMMAND [ARGS]...

Options:

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

orca image tag add¶

Add a tag to an image.

Usage:

orca image tag add [OPTIONS] IMAGE_ID TAG

Options:

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

orca image tag delete¶

Remove a tag from an image.

Usage:

orca image tag delete [OPTIONS] IMAGE_ID TAG

Options:

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

orca image tag-add¶

Add a tag to an image.

Usage:

orca image tag-add [OPTIONS] IMAGE_ID TAG

Options:

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

orca image tag-delete¶

Remove a tag from an image.

Usage:

orca image tag-delete [OPTIONS] IMAGE_ID TAG

Options:

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

orca image task¶

Inspect Glance import / task queue.

Usage:

orca image task [OPTIONS] COMMAND [ARGS]...

Options:

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

orca image task list¶

List Glance async tasks.

Usage:

orca image task list [OPTIONS]

Options:

Name	Type	Description	Default
`--type`	choice (`import` \| `export` \| `clone`)	Filter by task type.	None
`--status`	choice (`pending` \| `processing` \| `success` \| `failure`)	Filter by task status.	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 image task show¶

Show details of a Glance async task.

Usage:

orca image task show [OPTIONS] TASK_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 image task-list¶

List Glance async tasks.

Usage:

orca image task-list [OPTIONS]

Options:

Name	Type	Description	Default
`--type`	choice (`import` \| `export` \| `clone`)	Filter by task type.	None
`--status`	choice (`pending` \| `processing` \| `success` \| `failure`)	Filter by task status.	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 image task-show¶

Show details of a Glance async task.

Usage:

orca image task-show [OPTIONS] TASK_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 image unused¶

Find images not used by any server instance.

Cross-references Glance images with Nova servers to identify images that no running or stopped instance references. By default snapshots are excluded from the scan.

Examples: orca image unused # dry-run orca image unused --delete # interactive delete orca image unused --delete -y # auto-confirm orca image unused --include-snapshots # include snapshot images

Usage:

orca image unused [OPTIONS]

Options:

Name	Type	Description	Default
`--delete`, `-d`	boolean	Actually delete unused images.	`False`
`--yes`, `-y`	boolean	Skip confirmation (with --delete).	`False`
`--include-snapshots`	boolean	Include snapshot images in the scan.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca image update¶

Update image properties (JSON-Patch).

Builds one atomic JSON-Patch document from all flags. --property emits add when the key is absent and replace when it already exists, so untouched properties survive. --remove-property is strict by default and turns idempotent under --ignore-missing.

Examples: orca image update --name new-name orca image update --visibility shared orca image update --property os_distro=ubuntu --property os_version=24.04 orca image update --remove-property hw_qemu_guest_agent orca image update --remove-property foo --ignore-missing

Usage:

orca image update [OPTIONS] IMAGE_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--min-disk`	integer	New min disk (GB).	None
`--min-ram`	integer	New min RAM (MB).	None
`--visibility`	choice (`private` \| `shared` \| `community` \| `public`)	New visibility.	None
`--property`	text	Set or replace a custom image property (KEY=VALUE). Repeatable. Untouched properties are preserved.	`Sentinel.UNSET`
`--remove-property`	text	Remove a custom image property by key. Repeatable. Errors if the key is absent (use --ignore-missing for idempotent runs).	`Sentinel.UNSET`
`--ignore-missing`	boolean	With --remove-property: silently skip keys that aren't on the image.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca image update¶

Update image properties (JSON-Patch).

Builds one atomic JSON-Patch document from all flags. --property emits add when the key is absent and replace when it already exists, so untouched properties survive. --remove-property is strict by default and turns idempotent under --ignore-missing.

Examples: orca image update --name new-name orca image update --visibility shared orca image update --property os_distro=ubuntu --property os_version=24.04 orca image update --remove-property hw_qemu_guest_agent orca image update --remove-property foo --ignore-missing

Usage:

orca image update [OPTIONS] IMAGE_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--min-disk`	integer	New min disk (GB).	None
`--min-ram`	integer	New min RAM (MB).	None
`--visibility`	choice (`private` \| `shared` \| `community` \| `public`)	New visibility.	None
`--property`	text	Set or replace a custom image property (KEY=VALUE). Repeatable. Untouched properties are preserved.	`Sentinel.UNSET`
`--remove-property`	text	Remove a custom image property by key. Repeatable. Errors if the key is absent (use --ignore-missing for idempotent runs).	`Sentinel.UNSET`
`--ignore-missing`	boolean	With --remove-property: silently skip keys that aren't on the image.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca image update¶

Update image properties (JSON-Patch).

Builds one atomic JSON-Patch document from all flags. --property emits add when the key is absent and replace when it already exists, so untouched properties survive. --remove-property is strict by default and turns idempotent under --ignore-missing.

Examples: orca image update --name new-name orca image update --visibility shared orca image update --property os_distro=ubuntu --property os_version=24.04 orca image update --remove-property hw_qemu_guest_agent orca image update --remove-property foo --ignore-missing

Usage:

orca image update [OPTIONS] IMAGE_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--min-disk`	integer	New min disk (GB).	None
`--min-ram`	integer	New min RAM (MB).	None
`--visibility`	choice (`private` \| `shared` \| `community` \| `public`)	New visibility.	None
`--property`	text	Set or replace a custom image property (KEY=VALUE). Repeatable. Untouched properties are preserved.	`Sentinel.UNSET`
`--remove-property`	text	Remove a custom image property by key. Repeatable. Errors if the key is absent (use --ignore-missing for idempotent runs).	`Sentinel.UNSET`
`--ignore-missing`	boolean	With --remove-property: silently skip keys that aren't on the image.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca image upload¶

Upload image data from a local file.

The image must already exist and be in 'queued' status. Supports large files — streams from disk without loading into memory. Examples: orca image upload /path/to/ubuntu.qcow2

Usage:

orca image upload [OPTIONS] IMAGE_ID FILE_PATH

Options:

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

orca ip¶

IP address utilities.

Usage:

orca ip [OPTIONS] COMMAND [ARGS]...

Options:

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

orca ip whois¶

Find which resource owns a given IP address.

Searches across floating IPs, ports, subnets, routers, servers and load-balancers to resolve who is using the address.

Examples: orca ip whois 10.0.0.15 orca ip whois 203.0.113.42

Usage:

orca ip whois [OPTIONS] ADDRESS

Options:

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

orca ip-availability¶

Inspect IP availability across networks (admin).

Reports allocated vs total addresses per subnet — useful for sizing planning before quota changes.

Usage:

orca ip-availability [OPTIONS] COMMAND [ARGS]...

Options:

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

orca ip-availability list¶

List IP availability across networks.

Usage:

orca ip-availability list [OPTIONS]

Options:

Name	Type	Description	Default
`--network-id`	text	Filter by network ID.	None
`--ip-version`	choice (`4` \| `6`)	Filter by IP version.	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 ip-availability show¶

Show IP availability for a network (with subnet breakdown).

Usage:

orca ip-availability show [OPTIONS] NETWORK_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 keypair¶

Manage SSH key pairs.

Usage:

orca keypair [OPTIONS] COMMAND [ARGS]...

Options:

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

orca keypair create¶

Generate a new key pair.

OpenStack generates both keys. The private key is returned ONCE and saved locally. The public key is stored server-side.

Usage:

orca keypair create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--save-to`	path	Path to save the private key. Default: ~/.ssh/.pem	None
`--help`	boolean	Show this message and exit.	`False`

orca keypair delete¶

Delete a key pair.

Usage:

orca keypair delete [OPTIONS] NAME

Options:

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

orca keypair generate¶

Generate a key pair locally and upload the public key.

The private key NEVER leaves your machine.

Examples: orca keypair generate my-key orca keypair generate my-key --type rsa --bits 4096

Usage:

orca keypair generate [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--type`	choice (`ed25519` \| `rsa` \| `ecdsa`)	Key algorithm.	`ed25519`
`--bits`	integer	Key size (RSA only, default 4096).	None
`--save-to`	path	Private key path. Default: ~/.ssh/orca-	None
`--help`	boolean	Show this message and exit.	`False`

orca keypair list¶

List key pairs.

Usage:

orca keypair 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 keypair show¶

Show key pair details (fingerprint & public key).

Usage:

orca keypair show [OPTIONS] NAME

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 keypair upload¶

Import an existing public key.

Examples: orca keypair upload my-key --public-key-file ~/.ssh/id_ed25519.pub orca keypair upload my-key --public-key "ssh-ed25519 AAAA..."

Usage:

orca keypair upload [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--public-key-file`	path	Path to public key file. Default: ~/.ssh/id_rsa.pub	None
`--public-key`	text	Public key content as string (e.g. 'ssh-rsa AAAA...').	None
`--help`	boolean	Show this message and exit.	`False`

orca limit¶

Manage Keystone project-level resource limits.

Usage:

orca limit [OPTIONS] COMMAND [ARGS]...

Options:

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

orca limit create¶

Create a project-level limit.

Usage:

orca limit create [OPTIONS]

Options:

Name	Type	Description	Default
`--project-id`	text	Project ID.	`Sentinel.UNSET`
`--service-id`	text	Service ID.	`Sentinel.UNSET`
`--resource-name`	text	Resource name.	`Sentinel.UNSET`
`--resource-limit`	integer	Limit value.	`Sentinel.UNSET`
`--region-id`	text	Region ID.	None
`--description`	text	Description.	``
`--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 limit delete¶

Delete a project-level limit.

Usage:

orca limit delete [OPTIONS] LIMIT_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca limit list¶

List limits.

Usage:

orca limit list [OPTIONS]

Options:

Name	Type	Description	Default
`--service-id`	text	Filter by service ID.	None
`--region-id`	text	Filter by region ID.	None
`--resource-name`	text	Filter by resource name.	None
`--project-id`	text	Filter by project 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 limit set¶

Update a project-level limit.

Usage:

orca limit set [OPTIONS] LIMIT_ID

Options:

Name	Type	Description	Default
`--resource-limit`	integer	New limit value.	None
`--description`	text	N/A	None
`--help`	boolean	Show this message and exit.	`False`

orca limit show¶

Show a limit.

Usage:

orca limit show [OPTIONS] LIMIT_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 limits¶

Show compute limits and quotas.

Usage:

orca limits [OPTIONS] COMMAND [ARGS]...

Options:

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

orca limits show¶

Show compute quotas and current usage for this project.

Usage:

orca limits show [OPTIONS]

Options:

Name	Type	Description	Default
`--project`	text	Show limits for a specific project (admin).	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer¶

Manage load balancers, listeners, pools & members (Octavia).

Usage:

orca loadbalancer [OPTIONS] COMMAND [ARGS]...

Options:

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

orca loadbalancer amphora¶

Manage Octavia amphorae (admin).

Usage:

orca loadbalancer amphora [OPTIONS] COMMAND [ARGS]...

Options:

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

orca loadbalancer amphora failover¶

Trigger a failover for an amphora (admin).

Usage:

orca loadbalancer amphora failover [OPTIONS] AMPHORA_ID

Options:

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

orca loadbalancer amphora list¶

List amphora (admin).

Usage:

orca loadbalancer amphora list [OPTIONS]

Options:

Name	Type	Description	Default
`--lb-id`	text	Filter by load balancer ID.	None
`--status`	text	Filter by amphora status.	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 loadbalancer amphora show¶

Show amphora details (admin).

Usage:

orca loadbalancer amphora show [OPTIONS] AMPHORA_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 loadbalancer amphora-failover¶

Trigger a failover for an amphora (admin).

Usage:

orca loadbalancer amphora-failover [OPTIONS] AMPHORA_ID

Options:

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

orca loadbalancer amphora-list¶

List amphora (admin).

Usage:

orca loadbalancer amphora-list [OPTIONS]

Options:

Name	Type	Description	Default
`--lb-id`	text	Filter by load balancer ID.	None
`--status`	text	Filter by amphora status.	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 loadbalancer amphora-show¶

Show amphora details (admin).

Usage:

orca loadbalancer amphora-show [OPTIONS] AMPHORA_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 loadbalancer create¶

Create a load balancer.

Examples: orca loadbalancer create my-lb --subnet-id

Usage:

orca loadbalancer create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--subnet-id`	text	VIP subnet ID.	`Sentinel.UNSET`
`--description`	text	Description.	``
`--provider`	text	Provider (e.g. amphora, ovn).	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer delete¶

Delete a load balancer.

Usage:

orca loadbalancer delete [OPTIONS] LB_ID

Options:

Name	Type	Description	Default
`--cascade`	boolean	Delete LB and all child resources.	`False`
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer healthmonitor¶

Manage Octavia health monitors.

Usage:

orca loadbalancer healthmonitor [OPTIONS] COMMAND [ARGS]...

Options:

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

orca loadbalancer healthmonitor create¶

Create a health monitor.

Usage:

orca loadbalancer healthmonitor create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--pool-id`	text	Pool ID.	`Sentinel.UNSET`
`--type`	choice (`HTTP` \| `HTTPS` \| `PING` \| `TCP` \| `TLS-HELLO` \| `UDP-CONNECT`)	N/A	`Sentinel.UNSET`
`--delay`	integer	Probe interval (seconds).	`Sentinel.UNSET`
`--timeout`	integer	Probe timeout (seconds).	`Sentinel.UNSET`
`--max-retries`	integer	Max retries (1-10).	`3`
`--url-path`	text	HTTP URL path to probe.	`/`
`--expected-codes`	text	Expected HTTP codes.	`200`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer healthmonitor delete¶

Delete a health monitor.

Usage:

orca loadbalancer healthmonitor delete [OPTIONS] HM_ID

Options:

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

orca loadbalancer healthmonitor list¶

List health monitors.

Usage:

orca loadbalancer healthmonitor 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 loadbalancer healthmonitor set¶

Update a health monitor.

Usage:

orca loadbalancer healthmonitor set [OPTIONS] HM_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--delay`	integer	Probe interval (seconds).	None
`--timeout`	integer	Probe timeout (seconds).	None
`--max-retries`	integer	Max retries.	None
`--url-path`	text	HTTP URL path to probe.	None
`--expected-codes`	text	Expected HTTP codes.	None
`--enable` / `--disable`	boolean	Enable or disable the health monitor.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer healthmonitor show¶

Show health monitor details.

Usage:

orca loadbalancer healthmonitor show [OPTIONS] HM_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 loadbalancer healthmonitor-create¶

Create a health monitor.

Usage:

orca loadbalancer healthmonitor-create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--pool-id`	text	Pool ID.	`Sentinel.UNSET`
`--type`	choice (`HTTP` \| `HTTPS` \| `PING` \| `TCP` \| `TLS-HELLO` \| `UDP-CONNECT`)	N/A	`Sentinel.UNSET`
`--delay`	integer	Probe interval (seconds).	`Sentinel.UNSET`
`--timeout`	integer	Probe timeout (seconds).	`Sentinel.UNSET`
`--max-retries`	integer	Max retries (1-10).	`3`
`--url-path`	text	HTTP URL path to probe.	`/`
`--expected-codes`	text	Expected HTTP codes.	`200`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer healthmonitor-delete¶

Delete a health monitor.

Usage:

orca loadbalancer healthmonitor-delete [OPTIONS] HM_ID

Options:

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

orca loadbalancer healthmonitor-list¶

List health monitors.

Usage:

orca loadbalancer healthmonitor-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 loadbalancer healthmonitor-set¶

Update a health monitor.

Usage:

orca loadbalancer healthmonitor-set [OPTIONS] HM_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--delay`	integer	Probe interval (seconds).	None
`--timeout`	integer	Probe timeout (seconds).	None
`--max-retries`	integer	Max retries.	None
`--url-path`	text	HTTP URL path to probe.	None
`--expected-codes`	text	Expected HTTP codes.	None
`--enable` / `--disable`	boolean	Enable or disable the health monitor.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer healthmonitor-show¶

Show health monitor details.

Usage:

orca loadbalancer healthmonitor-show [OPTIONS] HM_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 loadbalancer l7policy¶

Manage Octavia L7 policies (compound noun).

Usage:

orca loadbalancer l7policy [OPTIONS] COMMAND [ARGS]...

Options:

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

orca loadbalancer l7policy create¶

Create an L7 policy.

Examples: orca loadbalancer l7policy-create --listener-id --action REJECT orca loadbalancer l7policy-create --listener-id \ --action REDIRECT_TO_POOL --redirect-pool-id

Usage:

orca loadbalancer l7policy create [OPTIONS]

Options:

Name	Type	Description	Default
`--listener-id`	text	Listener to attach the policy to.	`Sentinel.UNSET`
`--action`	choice (`REDIRECT_TO_POOL` \| `REDIRECT_TO_URL` \| `REJECT` \| `REDIRECT_PREFIX`)	Policy action.	`Sentinel.UNSET`
`--name`	text	Policy name.	None
`--description`	text	Description.	None
`--position`	integer	Policy position (order).	None
`--redirect-pool-id`	text	Pool to redirect to (REDIRECT_TO_POOL).	None
`--redirect-url`	text	URL to redirect to (REDIRECT_TO_URL).	None
`--redirect-prefix`	text	URL prefix to redirect to (REDIRECT_PREFIX).	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7policy delete¶

Delete an L7 policy.

Usage:

orca loadbalancer l7policy delete [OPTIONS] L7POLICY_ID

Options:

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

orca loadbalancer l7policy list¶

List L7 policies.

Usage:

orca loadbalancer l7policy 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 loadbalancer l7policy set¶

Update an L7 policy.

Usage:

orca loadbalancer l7policy set [OPTIONS] L7POLICY_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--action`	choice (`REDIRECT_TO_POOL` \| `REDIRECT_TO_URL` \| `REJECT` \| `REDIRECT_PREFIX`)	New action.	None
`--position`	integer	New position.	None
`--redirect-pool-id`	text	New redirect pool ID.	None
`--redirect-url`	text	New redirect URL.	None
`--enable` / `--disable`	boolean	Enable or disable.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7policy show¶

Show L7 policy details.

Usage:

orca loadbalancer l7policy show [OPTIONS] L7POLICY_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 loadbalancer l7policy-create¶

Create an L7 policy.

Examples: orca loadbalancer l7policy-create --listener-id --action REJECT orca loadbalancer l7policy-create --listener-id \ --action REDIRECT_TO_POOL --redirect-pool-id

Usage:

orca loadbalancer l7policy-create [OPTIONS]

Options:

Name	Type	Description	Default
`--listener-id`	text	Listener to attach the policy to.	`Sentinel.UNSET`
`--action`	choice (`REDIRECT_TO_POOL` \| `REDIRECT_TO_URL` \| `REJECT` \| `REDIRECT_PREFIX`)	Policy action.	`Sentinel.UNSET`
`--name`	text	Policy name.	None
`--description`	text	Description.	None
`--position`	integer	Policy position (order).	None
`--redirect-pool-id`	text	Pool to redirect to (REDIRECT_TO_POOL).	None
`--redirect-url`	text	URL to redirect to (REDIRECT_TO_URL).	None
`--redirect-prefix`	text	URL prefix to redirect to (REDIRECT_PREFIX).	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7policy-delete¶

Delete an L7 policy.

Usage:

orca loadbalancer l7policy-delete [OPTIONS] L7POLICY_ID

Options:

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

orca loadbalancer l7policy-list¶

List L7 policies.

Usage:

orca loadbalancer l7policy-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 loadbalancer l7policy-set¶

Update an L7 policy.

Usage:

orca loadbalancer l7policy-set [OPTIONS] L7POLICY_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--action`	choice (`REDIRECT_TO_POOL` \| `REDIRECT_TO_URL` \| `REJECT` \| `REDIRECT_PREFIX`)	New action.	None
`--position`	integer	New position.	None
`--redirect-pool-id`	text	New redirect pool ID.	None
`--redirect-url`	text	New redirect URL.	None
`--enable` / `--disable`	boolean	Enable or disable.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7policy-show¶

Show L7 policy details.

Usage:

orca loadbalancer l7policy-show [OPTIONS] L7POLICY_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 loadbalancer l7rule¶

Manage Octavia L7 rules (compound noun).

Usage:

orca loadbalancer l7rule [OPTIONS] COMMAND [ARGS]...

Options:

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

orca loadbalancer l7rule create¶

Create an L7 rule.

Examples: orca loadbalancer l7rule-create \ --type PATH --compare-type STARTS_WITH --value /api

Usage:

orca loadbalancer l7rule create [OPTIONS] L7POLICY_ID

Options:

Name	Type	Description	Default
`--type`	choice (`COOKIE` \| `FILE_TYPE` \| `HEADER` \| `HOST_NAME` \| `PATH` \| `SSL_CONN_HAS_CERT` \| `SSL_VERIFY_RESULT` \| `SSL_DN_FIELD`)	Rule type.	`Sentinel.UNSET`
`--compare-type`	choice (`CONTAINS` \| `ENDS_WITH` \| `EQUAL_TO` \| `REGEX` \| `STARTS_WITH`)	Comparison type.	`Sentinel.UNSET`
`--value`	text	Value to compare against.	`Sentinel.UNSET`
`--key`	text	Key (for HEADER, COOKIE rules).	None
`--invert`	boolean	Invert the match result.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7rule delete¶

Delete an L7 rule.

Usage:

orca loadbalancer l7rule delete [OPTIONS] L7POLICY_ID L7RULE_ID

Options:

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

orca loadbalancer l7rule list¶

List L7 rules for a policy.

Usage:

orca loadbalancer l7rule list [OPTIONS] L7POLICY_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 loadbalancer l7rule set¶

Update an L7 rule.

Usage:

orca loadbalancer l7rule set [OPTIONS] L7POLICY_ID L7RULE_ID

Options:

Name	Type	Description	Default
`--type`	choice (`COOKIE` \| `FILE_TYPE` \| `HEADER` \| `HOST_NAME` \| `PATH` \| `SSL_CONN_HAS_CERT` \| `SSL_VERIFY_RESULT` \| `SSL_DN_FIELD`)	New rule type.	None
`--compare-type`	choice (`CONTAINS` \| `ENDS_WITH` \| `EQUAL_TO` \| `REGEX` \| `STARTS_WITH`)	New comparison type.	None
`--value`	text	New value.	None
`--key`	text	New key.	None
`--invert` / `--no-invert`	boolean	Invert match.	None
`--enable` / `--disable`	boolean	Enable or disable the rule.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7rule show¶

Show L7 rule details.

Usage:

orca loadbalancer l7rule show [OPTIONS] L7POLICY_ID L7RULE_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 loadbalancer l7rule-create¶

Create an L7 rule.

Examples: orca loadbalancer l7rule-create \ --type PATH --compare-type STARTS_WITH --value /api

Usage:

orca loadbalancer l7rule-create [OPTIONS] L7POLICY_ID

Options:

Name	Type	Description	Default
`--type`	choice (`COOKIE` \| `FILE_TYPE` \| `HEADER` \| `HOST_NAME` \| `PATH` \| `SSL_CONN_HAS_CERT` \| `SSL_VERIFY_RESULT` \| `SSL_DN_FIELD`)	Rule type.	`Sentinel.UNSET`
`--compare-type`	choice (`CONTAINS` \| `ENDS_WITH` \| `EQUAL_TO` \| `REGEX` \| `STARTS_WITH`)	Comparison type.	`Sentinel.UNSET`
`--value`	text	Value to compare against.	`Sentinel.UNSET`
`--key`	text	Key (for HEADER, COOKIE rules).	None
`--invert`	boolean	Invert the match result.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7rule-delete¶

Delete an L7 rule.

Usage:

orca loadbalancer l7rule-delete [OPTIONS] L7POLICY_ID L7RULE_ID

Options:

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

orca loadbalancer l7rule-list¶

List L7 rules for a policy.

Usage:

orca loadbalancer l7rule-list [OPTIONS] L7POLICY_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 loadbalancer l7rule-set¶

Update an L7 rule.

Usage:

orca loadbalancer l7rule-set [OPTIONS] L7POLICY_ID L7RULE_ID

Options:

Name	Type	Description	Default
`--type`	choice (`COOKIE` \| `FILE_TYPE` \| `HEADER` \| `HOST_NAME` \| `PATH` \| `SSL_CONN_HAS_CERT` \| `SSL_VERIFY_RESULT` \| `SSL_DN_FIELD`)	New rule type.	None
`--compare-type`	choice (`CONTAINS` \| `ENDS_WITH` \| `EQUAL_TO` \| `REGEX` \| `STARTS_WITH`)	New comparison type.	None
`--value`	text	New value.	None
`--key`	text	New key.	None
`--invert` / `--no-invert`	boolean	Invert match.	None
`--enable` / `--disable`	boolean	Enable or disable the rule.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7rule-show¶

Show L7 rule details.

Usage:

orca loadbalancer l7rule-show [OPTIONS] L7POLICY_ID L7RULE_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 loadbalancer list¶

List load balancers.

Usage:

orca loadbalancer 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 loadbalancer listener¶

Manage Octavia listeners.

Usage:

orca loadbalancer listener [OPTIONS] COMMAND [ARGS]...

Options:

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

orca loadbalancer listener create¶

Create a listener.

Usage:

orca loadbalancer listener create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--lb-id`	text	Load balancer ID.	`Sentinel.UNSET`
`--protocol`	choice (`HTTP` \| `HTTPS` \| `TCP` \| `UDP` \| `TERMINATED_HTTPS`)	N/A	`Sentinel.UNSET`
`--port`	integer	Listen port.	`Sentinel.UNSET`
`--default-pool-id`	text	Default pool ID.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer listener delete¶

Delete a listener.

Usage:

orca loadbalancer listener delete [OPTIONS] LISTENER_ID

Options:

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

orca loadbalancer listener list¶

List listeners.

Usage:

orca loadbalancer listener 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 loadbalancer listener set¶

Update a listener.

Usage:

orca loadbalancer listener set [OPTIONS] LISTENER_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--default-pool-id`	text	New default pool ID.	None
`--connection-limit`	integer	Max connections (-1 for unlimited).	None
`--enable` / `--disable`	boolean	Enable or disable the listener.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer listener show¶

Show listener details.

Usage:

orca loadbalancer listener show [OPTIONS] LISTENER_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 loadbalancer listener-create¶

Create a listener.

Usage:

orca loadbalancer listener-create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--lb-id`	text	Load balancer ID.	`Sentinel.UNSET`
`--protocol`	choice (`HTTP` \| `HTTPS` \| `TCP` \| `UDP` \| `TERMINATED_HTTPS`)	N/A	`Sentinel.UNSET`
`--port`	integer	Listen port.	`Sentinel.UNSET`
`--default-pool-id`	text	Default pool ID.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer listener-delete¶

Delete a listener.

Usage:

orca loadbalancer listener-delete [OPTIONS] LISTENER_ID

Options:

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

orca loadbalancer listener-list¶

List listeners.

Usage:

orca loadbalancer listener-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 loadbalancer listener-set¶

Update a listener.

Usage:

orca loadbalancer listener-set [OPTIONS] LISTENER_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--default-pool-id`	text	New default pool ID.	None
`--connection-limit`	integer	Max connections (-1 for unlimited).	None
`--enable` / `--disable`	boolean	Enable or disable the listener.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer listener-show¶

Show listener details.

Usage:

orca loadbalancer listener-show [OPTIONS] LISTENER_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 loadbalancer member¶

Manage Octavia pool members.

Usage:

orca loadbalancer member [OPTIONS] COMMAND [ARGS]...

Options:

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

orca loadbalancer member add¶

Add a member to a pool.

Usage:

orca loadbalancer member add [OPTIONS] POOL_ID

Options:

Name	Type	Description	Default
`--address`	text	Member IP address.	`Sentinel.UNSET`
`--port`	integer	Member port.	`Sentinel.UNSET`
`--subnet-id`	text	Member subnet ID.	None
`--weight`	integer	Weight (0-256).	`1`
`--name`	text	Member name.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer member list¶

List members in a pool.

Usage:

orca loadbalancer member list [OPTIONS] POOL_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 loadbalancer member remove¶

Remove a member from a pool.

Usage:

orca loadbalancer member remove [OPTIONS] POOL_ID MEMBER_ID

Options:

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

orca loadbalancer member set¶

Update a pool member.

Usage:

orca loadbalancer member set [OPTIONS] POOL_ID MEMBER_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--weight`	integer	New weight (0-256).	None
`--enable` / `--disable`	boolean	Enable or disable the member.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer member show¶

Show member details.

Usage:

orca loadbalancer member show [OPTIONS] POOL_ID MEMBER_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 loadbalancer member-add¶

Add a member to a pool.

Usage:

orca loadbalancer member-add [OPTIONS] POOL_ID

Options:

Name	Type	Description	Default
`--address`	text	Member IP address.	`Sentinel.UNSET`
`--port`	integer	Member port.	`Sentinel.UNSET`
`--subnet-id`	text	Member subnet ID.	None
`--weight`	integer	Weight (0-256).	`1`
`--name`	text	Member name.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer member-list¶

List members in a pool.

Usage:

orca loadbalancer member-list [OPTIONS] POOL_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 loadbalancer member-remove¶

Remove a member from a pool.

Usage:

orca loadbalancer member-remove [OPTIONS] POOL_ID MEMBER_ID

Options:

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

orca loadbalancer member-set¶

Update a pool member.

Usage:

orca loadbalancer member-set [OPTIONS] POOL_ID MEMBER_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--weight`	integer	New weight (0-256).	None
`--enable` / `--disable`	boolean	Enable or disable the member.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer member-show¶

Show member details.

Usage:

orca loadbalancer member-show [OPTIONS] POOL_ID MEMBER_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 loadbalancer pool¶

Manage Octavia pools.

Usage:

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

Options:

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

orca loadbalancer pool create¶

Create a pool.

Usage:

orca loadbalancer pool create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--listener-id`	text	Listener ID to attach to.	None
`--lb-id`	text	Load balancer ID (if no listener).	None
`--protocol`	choice (`HTTP` \| `HTTPS` \| `PROXY` \| `TCP` \| `UDP`)	N/A	`Sentinel.UNSET`
`--algorithm`	choice (`ROUND_ROBIN` \| `LEAST_CONNECTIONS` \| `SOURCE_IP`)	Load balancing algorithm.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer pool delete¶

Delete a pool.

Usage:

orca loadbalancer pool delete [OPTIONS] POOL_ID

Options:

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

orca loadbalancer pool list¶

List pools.

Usage:

orca loadbalancer pool 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 loadbalancer pool set¶

Update a pool.

Usage:

orca loadbalancer pool set [OPTIONS] POOL_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--algorithm`	choice (`ROUND_ROBIN` \| `LEAST_CONNECTIONS` \| `SOURCE_IP`)	New LB algorithm.	None
`--enable` / `--disable`	boolean	Enable or disable the pool.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer pool show¶

Show pool details.

Usage:

orca loadbalancer pool show [OPTIONS] POOL_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 loadbalancer pool-create¶

Create a pool.

Usage:

orca loadbalancer pool-create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--listener-id`	text	Listener ID to attach to.	None
`--lb-id`	text	Load balancer ID (if no listener).	None
`--protocol`	choice (`HTTP` \| `HTTPS` \| `PROXY` \| `TCP` \| `UDP`)	N/A	`Sentinel.UNSET`
`--algorithm`	choice (`ROUND_ROBIN` \| `LEAST_CONNECTIONS` \| `SOURCE_IP`)	Load balancing algorithm.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer pool-delete¶

Delete a pool.

Usage:

orca loadbalancer pool-delete [OPTIONS] POOL_ID

Options:

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

orca loadbalancer pool-list¶

List pools.

Usage:

orca loadbalancer pool-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 loadbalancer pool-set¶

Update a pool.

Usage:

orca loadbalancer pool-set [OPTIONS] POOL_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--algorithm`	choice (`ROUND_ROBIN` \| `LEAST_CONNECTIONS` \| `SOURCE_IP`)	New LB algorithm.	None
`--enable` / `--disable`	boolean	Enable or disable the pool.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer pool-show¶

Show pool details.

Usage:

orca loadbalancer pool-show [OPTIONS] POOL_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 loadbalancer set¶

Update a load balancer.

Usage:

orca loadbalancer set [OPTIONS] LB_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--enable` / `--disable`	boolean	Enable or disable the load balancer.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer show¶

Show load balancer details.

Usage:

orca loadbalancer show [OPTIONS] LB_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 loadbalancer stats¶

Inspect Octavia load-balancer stats.

Usage:

orca loadbalancer stats [OPTIONS] COMMAND [ARGS]...

Options:

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

orca loadbalancer stats show¶

Show load balancer statistics.

Usage:

orca loadbalancer stats show [OPTIONS] LB_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 loadbalancer stats-show¶

Show load balancer statistics.

Usage:

orca loadbalancer stats-show [OPTIONS] LB_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 loadbalancer status¶

Inspect Octavia load-balancer status.

Usage:

orca loadbalancer status [OPTIONS] COMMAND [ARGS]...

Options:

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

orca loadbalancer status show¶

Show load balancer operating status tree.

Usage:

orca loadbalancer status show [OPTIONS] LB_ID

Options:

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

orca loadbalancer status-show¶

Show load balancer operating status tree.

Usage:

orca loadbalancer status-show [OPTIONS] LB_ID

Options:

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

orca local-ip¶

Manage Neutron local IPs (Yoga+ — tenant-local virtual IPs).

A local IP is a virtual IP allocated within a single project that can be associated with multiple ports for an east-west floating-IP pattern (no SNAT, no L3 router).

Usage:

orca local-ip [OPTIONS] COMMAND [ARGS]...

Options:

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

orca local-ip association¶

Manage local-IP-to-port associations.

Usage:

orca local-ip association [OPTIONS] COMMAND [ARGS]...

Options:

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

orca local-ip association create¶

Associate a port with a local IP.

Usage:

orca local-ip association create [OPTIONS] LIP_ID

Options:

Name	Type	Description	Default
`--port-id`	text	Port to associate.	`Sentinel.UNSET`
`--fixed-ip`	text	Specific fixed IP of the port (autopicked otherwise).	None
`--help`	boolean	Show this message and exit.	`False`

orca local-ip association delete¶

Remove a port association from a local IP.

Usage:

orca local-ip association delete [OPTIONS] LIP_ID PORT_ID

Options:

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

orca local-ip association list¶

List port associations on a local IP.

Usage:

orca local-ip association list [OPTIONS] LIP_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 local-ip create¶

Create a local IP.

Usage:

orca local-ip create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--network-id`	text	Local network ID.	`Sentinel.UNSET`
`--local-port-id`	text	Port ID to anchor the local IP.	None
`--ip-address`	text	Specific IP within the network's CIDR (autopicked otherwise).	None
`--ip-mode`	choice (`translate` \| `passthrough`)	Translate (SNAT-like) or passthrough.	None
`--help`	boolean	Show this message and exit.	`False`

orca local-ip delete¶

Delete a local IP.

Usage:

orca local-ip delete [OPTIONS] LIP_ID

Options:

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

orca local-ip list¶

List local IPs.

Usage:

orca local-ip 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 local-ip set¶

Update a local IP.

Usage:

orca local-ip set [OPTIONS] LIP_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 local-ip show¶

Show a local IP.

Usage:

orca local-ip show [OPTIONS] LIP_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 mapping¶

Manage Keystone federation attribute mappings.

Usage:

orca mapping [OPTIONS] COMMAND [ARGS]...

Options:

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

orca mapping create¶

Create a mapping.

Usage:

orca mapping create [OPTIONS] MAPPING_ID

Options:

Name	Type	Description	Default
`--rules`	text	Mapping rules as a JSON string.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca mapping delete¶

Delete a mapping.

Usage:

orca mapping delete [OPTIONS] MAPPING_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca mapping list¶

List mappings.

Usage:

orca mapping 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 mapping set¶

Update a mapping.

Usage:

orca mapping set [OPTIONS] MAPPING_ID

Options:

Name	Type	Description	Default
`--rules`	text	New rules as JSON.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca mapping show¶

Show a mapping (prints JSON rules).

Usage:

orca mapping show [OPTIONS] MAPPING_ID

Options:

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

orca metric¶

Query metrics, measures & resources (Gnocchi).

Usage:

orca metric [OPTIONS] COMMAND [ARGS]...

Options:

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

orca metric archive-policy¶

Manage Gnocchi archive policies (compound noun).

Usage:

orca metric archive-policy [OPTIONS] COMMAND [ARGS]...

Options:

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

orca metric archive-policy create¶

Create an archive policy.

Example: orca metric archive-policy-create my-policy \ --definition 1m:1440 --definition 1h:720

Usage:

orca metric archive-policy create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--definition`	text	Granularity:points pair (repeatable). E.g. 1m:1440.	`Sentinel.UNSET`
`--aggregation-method`	text	Aggregation method (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca metric archive-policy delete¶

Delete an archive policy.

Usage:

orca metric archive-policy delete [OPTIONS] NAME

Options:

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

orca metric archive-policy list¶

List archive policies.

Usage:

orca metric archive-policy 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 metric archive-policy show¶

Show an archive policy.

Usage:

orca metric archive-policy show [OPTIONS] NAME

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 metric archive-policy-create¶

Create an archive policy.

Example: orca metric archive-policy-create my-policy \ --definition 1m:1440 --definition 1h:720

Usage:

orca metric archive-policy-create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--definition`	text	Granularity:points pair (repeatable). E.g. 1m:1440.	`Sentinel.UNSET`
`--aggregation-method`	text	Aggregation method (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca metric archive-policy-delete¶

Delete an archive policy.

Usage:

orca metric archive-policy-delete [OPTIONS] NAME

Options:

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

orca metric archive-policy-list¶

List archive policies.

Usage:

orca metric archive-policy-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 metric archive-policy-show¶

Show an archive policy.

Usage:

orca metric archive-policy-show [OPTIONS] NAME

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 metric create¶

Create a Gnocchi metric.

Usage:

orca metric create [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Metric name.	`Sentinel.UNSET`
`--archive-policy-name`	text	Archive policy to use (default: low).	None
`--resource-id`	text	Resource ID to attach the metric to.	None
`--help`	boolean	Show this message and exit.	`False`

orca metric delete¶

Delete a Gnocchi metric.

Usage:

orca metric delete [OPTIONS] METRIC_ID

Options:

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

orca metric list¶

List metrics.

Usage:

orca metric list [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	integer	Max results.	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 metric measures¶

Read or push measures (samples) on a Gnocchi metric.

Usage:

orca metric measures [OPTIONS] COMMAND [ARGS]...

Options:

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

orca metric measures add¶

Push measures to a metric.

Example: orca metric measures-add \ --measure 2026-01-01T00:00:00:42.5

Usage:

orca metric measures add [OPTIONS] METRIC_ID

Options:

Name	Type	Description	Default
`--measure`	text	Measure as timestamp:value (repeatable). Timestamp: ISO-8601.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca metric measures show¶

Get measures (datapoints) for a metric.

Examples: orca metric measures --start -1h orca metric measures --start 2026-04-01 --stop 2026-04-08 --granularity 3600

Usage:

orca metric measures show [OPTIONS] METRIC_ID

Options:

Name	Type	Description	Default
`--start`	text	Start timestamp (ISO 8601 or relative e.g. -1h).	None
`--stop`	text	Stop timestamp.	None
`--granularity`	text	Granularity in seconds.	None
`--aggregation`	text	Aggregation method.	`mean`
`--limit`	integer	Max measures to return.	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 metric measures-add¶

Push measures to a metric.

Example: orca metric measures-add \ --measure 2026-01-01T00:00:00:42.5

Usage:

orca metric measures-add [OPTIONS] METRIC_ID

Options:

Name	Type	Description	Default
`--measure`	text	Measure as timestamp:value (repeatable). Timestamp: ISO-8601.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca metric resource¶

Inspect Gnocchi resources.

Usage:

orca metric resource [OPTIONS] COMMAND [ARGS]...

Options:

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

orca metric resource list¶

List resources.

Usage:

orca metric resource list [OPTIONS]

Options:

Name	Type	Description	Default
`--type`	text	Resource type to list.	`generic`
`--limit`	integer	Max results. Gnocchi can return very large datasets without a limit.	`100`
`--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 metric resource show¶

Show resource details and its metrics.

Usage:

orca metric resource show [OPTIONS] RESOURCE_ID

Options:

Name	Type	Description	Default
`--type`	text	Resource type.	`generic`
`--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 metric resource-list¶

List resources.

Usage:

orca metric resource-list [OPTIONS]

Options:

Name	Type	Description	Default
`--type`	text	Resource type to list.	`generic`
`--limit`	integer	Max results. Gnocchi can return very large datasets without a limit.	`100`
`--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 metric resource-show¶

Show resource details and its metrics.

Usage:

orca metric resource-show [OPTIONS] RESOURCE_ID

Options:

Name	Type	Description	Default
`--type`	text	Resource type.	`generic`
`--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 metric resource-type¶

Inspect Gnocchi resource types (compound noun).

Usage:

orca metric resource-type [OPTIONS] COMMAND [ARGS]...

Options:

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

orca metric resource-type create¶

Create a Gnocchi resource type.

Usage:

orca metric resource-type create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--attribute`	text	Resource attribute key:type (repeatable). E.g. host:string.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca metric resource-type delete¶

Delete a Gnocchi resource type.

Usage:

orca metric resource-type delete [OPTIONS] RESOURCE_TYPE

Options:

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

orca metric resource-type list¶

List resource types.

Usage:

orca metric resource-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 metric resource-type show¶

Show a Gnocchi resource type.

Usage:

orca metric resource-type show [OPTIONS] RESOURCE_TYPE

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 metric resource-type-create¶

Create a Gnocchi resource type.

Usage:

orca metric resource-type-create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--attribute`	text	Resource attribute key:type (repeatable). E.g. host:string.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca metric resource-type-delete¶

Delete a Gnocchi resource type.

Usage:

orca metric resource-type-delete [OPTIONS] RESOURCE_TYPE

Options:

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

orca metric resource-type-list¶

List resource types.

Usage:

orca metric resource-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 metric resource-type-show¶

Show a Gnocchi resource type.

Usage:

orca metric resource-type-show [OPTIONS] RESOURCE_TYPE

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 metric show¶

Show metric details.

Usage:

orca metric show [OPTIONS] METRIC_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 metric status¶

Show Gnocchi processing status.

Usage:

orca metric status [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 network¶

Manage networks, subnets, ports & routers.

Usage:

orca network [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network agent¶

Manage Neutron agents (admin).

Usage:

orca network agent [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network agent add¶

Bind a network or router to an agent (admin scheduler).

Usage:

orca network agent add [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network agent add network¶

Bind a network to a DHCP agent.

Usage:

orca network agent add network [OPTIONS] AGENT_ID NETWORK_ID

Options:

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

orca network agent add router¶

Bind a router to an L3 agent.

Usage:

orca network agent add router [OPTIONS] AGENT_ID ROUTER_ID

Options:

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

orca network agent delete¶

Delete a Neutron agent record.

Usage:

orca network agent delete [OPTIONS] AGENT_ID

Options:

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

orca network agent list¶

List Neutron agents.

Usage:

orca network agent list [OPTIONS]

Options:

Name	Type	Description	Default
`--host`	text	Filter by host.	None
`--agent-type`	text	Filter by agent 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 network agent remove¶

Unbind a network or router from an agent (admin scheduler).

Usage:

orca network agent remove [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network agent remove network¶

Unbind a network from a DHCP agent.

Usage:

orca network agent remove network [OPTIONS] AGENT_ID NETWORK_ID

Options:

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

orca network agent remove router¶

Unbind a router from an L3 agent.

Usage:

orca network agent remove router [OPTIONS] AGENT_ID ROUTER_ID

Options:

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

orca network agent set¶

Update a Neutron agent.

Usage:

orca network agent set [OPTIONS] AGENT_ID

Options:

Name	Type	Description	Default
`--enable` / `--disable`	boolean	Enable or disable the agent.	None
`--description`	text	New description.	None
`--help`	boolean	Show this message and exit.	`False`

orca network agent show¶

Show a Neutron agent's details.

Usage:

orca network agent show [OPTIONS] AGENT_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 network agent-delete¶

Delete a Neutron agent record.

Usage:

orca network agent-delete [OPTIONS] AGENT_ID

Options:

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

orca network agent-list¶

List Neutron agents.

Usage:

orca network agent-list [OPTIONS]

Options:

Name	Type	Description	Default
`--host`	text	Filter by host.	None
`--agent-type`	text	Filter by agent 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 network agent-set¶

Update a Neutron agent.

Usage:

orca network agent-set [OPTIONS] AGENT_ID

Options:

Name	Type	Description	Default
`--enable` / `--disable`	boolean	Enable or disable the agent.	None
`--description`	text	New description.	None
`--help`	boolean	Show this message and exit.	`False`

orca network agent-show¶

Show a Neutron agent's details.

Usage:

orca network agent-show [OPTIONS] AGENT_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 network auto-allocated-topology¶

Manage the project's auto-allocated topology.

Usage:

orca network auto-allocated-topology [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network auto-allocated-topology delete¶

Delete the auto-allocated topology for a project.

Usage:

orca network auto-allocated-topology delete [OPTIONS]

Options:

Name	Type	Description	Default
`--project-id`	text	Project ID (default: current project).	None
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca network auto-allocated-topology show¶

Show or create the auto-allocated topology for a project.

Examples: orca network auto-allocated-topology-show orca network auto-allocated-topology-show --project-id orca network auto-allocated-topology-show --check-resources

Usage:

orca network auto-allocated-topology show [OPTIONS]

Options:

Name	Type	Description	Default
`--project-id`	text	Project ID (default: current project).	None
`--check-resources`	boolean	Validate resources without creating topology.	`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 network auto-allocated-topology show¶

Show or create the auto-allocated topology for a project.

Examples: orca network auto-allocated-topology-show orca network auto-allocated-topology-show --project-id orca network auto-allocated-topology-show --check-resources

Usage:

orca network auto-allocated-topology show [OPTIONS]

Options:

Name	Type	Description	Default
`--project-id`	text	Project ID (default: current project).	None
`--check-resources`	boolean	Validate resources without creating topology.	`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 network auto-allocated-topology-delete¶

Delete the auto-allocated topology for a project.

Usage:

orca network auto-allocated-topology-delete [OPTIONS]

Options:

Name	Type	Description	Default
`--project-id`	text	Project ID (default: current project).	None
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca network auto-allocated-topology-show¶

Show or create the auto-allocated topology for a project.

Examples: orca network auto-allocated-topology-show orca network auto-allocated-topology-show --project-id orca network auto-allocated-topology-show --check-resources

Usage:

orca network auto-allocated-topology-show [OPTIONS]

Options:

Name	Type	Description	Default
`--project-id`	text	Project ID (default: current project).	None
`--check-resources`	boolean	Validate resources without creating topology.	`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 network create¶

Create a network.

Usage:

orca network create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--admin-state` / `--no-admin-state`	boolean	Admin state up.	`True`
`--shared`	boolean	Shared across projects.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca network delete¶

Delete a network.

Usage:

orca network delete [OPTIONS] NETWORK_ID

Options:

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

orca network flavor¶

Manage Neutron service flavors (admin SDN).

Usage:

orca network flavor [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network flavor add¶

Attach sub-resources to a network flavor.

Usage:

orca network flavor add [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network flavor add profile¶

Attach a service profile to a flavor (OSC network flavor add profile).

Usage:

orca network flavor add profile [OPTIONS] FLAVOR_ID PROFILE_ID

Options:

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

orca network flavor create¶

Create a network flavor.

Usage:

orca network flavor create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--service-type`	text	Service type (FLAVORS, FIREWALL_V2, …).	`Sentinel.UNSET`
`--description`	text	N/A	None
`--enabled` / `--disabled`	boolean	N/A	`True`
`--help`	boolean	Show this message and exit.	`False`

orca network flavor delete¶

Delete a network flavor.

Usage:

orca network flavor delete [OPTIONS] FLAVOR_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca network flavor list¶

List network flavors.

Usage:

orca network flavor 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 network flavor remove¶

Detach sub-resources from a network flavor.

Usage:

orca network flavor remove [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network flavor remove profile¶

Detach a service profile from a flavor (OSC network flavor remove profile).

Usage:

orca network flavor remove profile [OPTIONS] FLAVOR_ID PROFILE_ID

Options:

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

orca network flavor set¶

Update a network flavor.

Usage:

orca network flavor set [OPTIONS] FLAVOR_ID

Options:

Name	Type	Description	Default
`--name`	text	N/A	None
`--description`	text	N/A	None
`--enabled` / `--disabled`	boolean	N/A	None
`--help`	boolean	Show this message and exit.	`False`

orca network flavor show¶

Show a network flavor.

Usage:

orca network flavor show [OPTIONS] FLAVOR_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 network flavor-profile¶

Manage Neutron service profiles attached to flavors (admin).

Usage:

orca network flavor-profile [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network flavor-profile create¶

Create a service profile.

Usage:

orca network flavor-profile create [OPTIONS]

Options:

Name	Type	Description	Default
`--driver`	text	Backend driver class.	None
`--description`	text	N/A	None
`--metainfo`	text	Free-text JSON the driver consumes.	None
`--enabled` / `--disabled`	boolean	N/A	`True`
`--help`	boolean	Show this message and exit.	`False`

orca network flavor-profile delete¶

Delete a service profile.

Usage:

orca network flavor-profile delete [OPTIONS] SP_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca network flavor-profile list¶

List service profiles.

Usage:

orca network flavor-profile 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 network flavor-profile set¶

Update a service profile.

Usage:

orca network flavor-profile set [OPTIONS] SP_ID

Options:

Name	Type	Description	Default
`--description`	text	N/A	None
`--enabled` / `--disabled`	boolean	N/A	None
`--metainfo`	text	N/A	None
`--help`	boolean	Show this message and exit.	`False`

orca network flavor-profile show¶

Show a service profile.

Usage:

orca network flavor-profile show [OPTIONS] SP_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 network l3-conntrack-helper¶

Manage L3 conntrack helper modules on a router (admin).

Usage:

orca network l3-conntrack-helper [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network l3-conntrack-helper create¶

Attach a conntrack helper to a router.

Usage:

orca network l3-conntrack-helper create [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--helper`	text	Helper module name (ftp, tftp, sip, h323, …).	`Sentinel.UNSET`
`--protocol`	choice (`tcp` \| `udp`)	N/A	`tcp`
`--port`	integer	Port the helper listens on.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca network l3-conntrack-helper delete¶

Detach a conntrack helper.

Usage:

orca network l3-conntrack-helper delete [OPTIONS] ROUTER_ID CH_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca network l3-conntrack-helper list¶

List conntrack helpers on a router.

Usage:

orca network l3-conntrack-helper list [OPTIONS] ROUTER_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 network l3-conntrack-helper set¶

Update a conntrack helper (port only — helper/protocol are immutable).

Usage:

orca network l3-conntrack-helper set [OPTIONS] ROUTER_ID CH_ID

Options:

Name	Type	Description	Default
`--port`	integer	N/A	None
`--help`	boolean	Show this message and exit.	`False`

orca network l3-conntrack-helper show¶

Show a conntrack helper.

Usage:

orca network l3-conntrack-helper show [OPTIONS] ROUTER_ID CH_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 network list¶

List networks.

Usage:

orca network 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 network meter¶

Manage Neutron metering labels (admin).

Usage:

orca network meter [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network meter create¶

Create a metering label.

Usage:

orca network meter create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--description`	text	N/A	None
`--shared` / `--unshared`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca network meter delete¶

Delete a metering label.

Usage:

orca network meter delete [OPTIONS] LABEL_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca network meter list¶

List metering labels.

Usage:

orca network meter 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 network meter show¶

Show a metering label.

Usage:

orca network meter show [OPTIONS] LABEL_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 network meter-rule¶

Manage Neutron metering label rules (admin).

Usage:

orca network meter-rule [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network meter-rule create¶

Create a metering rule.

Usage:

orca network meter-rule create [OPTIONS]

Options:

Name	Type	Description	Default
`--label-id`	text	Metering label to attach to.	`Sentinel.UNSET`
`--direction`	choice (`ingress` \| `egress`)	N/A	`ingress`
`--remote-ip-prefix`	text	CIDR to match (legacy alias of --source-ip-prefix).	None
`--source-ip-prefix`	text	N/A	None
`--destination-ip-prefix`	text	N/A	None
`--excluded`	boolean	Invert the match (exclude this CIDR from accounting).	`False`
`--help`	boolean	Show this message and exit.	`False`

orca network meter-rule delete¶

Delete a metering rule.

Usage:

orca network meter-rule delete [OPTIONS] RULE_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca network meter-rule list¶

List metering label rules.

Usage:

orca network meter-rule list [OPTIONS]

Options:

Name	Type	Description	Default
`--label-id`	text	Filter by metering label.	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 network meter-rule show¶

Show a metering rule.

Usage:

orca network meter-rule show [OPTIONS] RULE_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 network port¶

Manage Neutron ports.

Usage:

orca network port [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network port create¶

Create a port.

Usage:

orca network port create [OPTIONS]

Options:

Name	Type	Description	Default
`--network-id`	text	Network ID.	`Sentinel.UNSET`
`--name`	text	Port name.	None
`--fixed-ip`	text	Fixed IP address.	None
`--help`	boolean	Show this message and exit.	`False`

orca network port delete¶

Delete a port.

Usage:

orca network port delete [OPTIONS] PORT_ID

Options:

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

orca network port list¶

List ports.

Examples: orca network port list orca network port list --network-id orca network port list --subnet orca network port list --device-owner compute:nova

Usage:

orca network port list [OPTIONS]

Options:

Name	Type	Description	Default
`--network-id`	text	Filter by network ID.	None
`--subnet-id`, `--subnet`	text	Filter to ports that have a fixed IP in this subnet.	None
`--device-owner`	text	Filter by device owner (e.g. `compute:nova`, `network:router_interface`, `network:dhcp`).	None
`--device-id`	text	Filter by the attached resource ID (server, router, ...).	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 network port show¶

Show port details.

Usage:

orca network port show [OPTIONS] PORT_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 network port unset¶

Remove properties from a port.

Examples: orca network port-unset --security-group orca network port-unset --qos-policy orca network port-unset --description

Usage:

orca network port unset [OPTIONS] PORT_ID

Options:

Name	Type	Description	Default
`--security-group`	text	Security group ID to remove (repeatable).	`Sentinel.UNSET`
`--qos-policy`	boolean	Remove the QoS policy from the port.	`False`
`--description`	boolean	Clear the port description.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca network port update¶

Update a port.

Usage:

orca network port update [OPTIONS] PORT_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--admin-state` / `--no-admin-state`	boolean	Admin state.	None
`--help`	boolean	Show this message and exit.	`False`

orca network port update¶

Update a port.

Usage:

orca network port update [OPTIONS] PORT_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--admin-state` / `--no-admin-state`	boolean	Admin state.	None
`--help`	boolean	Show this message and exit.	`False`

orca network port-create¶

Create a port.

Usage:

orca network port-create [OPTIONS]

Options:

Name	Type	Description	Default
`--network-id`	text	Network ID.	`Sentinel.UNSET`
`--name`	text	Port name.	None
`--fixed-ip`	text	Fixed IP address.	None
`--help`	boolean	Show this message and exit.	`False`

orca network port-delete¶

Delete a port.

Usage:

orca network port-delete [OPTIONS] PORT_ID

Options:

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

orca network port-list¶

List ports.

Examples: orca network port list orca network port list --network-id orca network port list --subnet orca network port list --device-owner compute:nova

Usage:

orca network port-list [OPTIONS]

Options:

Name	Type	Description	Default
`--network-id`	text	Filter by network ID.	None
`--subnet-id`, `--subnet`	text	Filter to ports that have a fixed IP in this subnet.	None
`--device-owner`	text	Filter by device owner (e.g. `compute:nova`, `network:router_interface`, `network:dhcp`).	None
`--device-id`	text	Filter by the attached resource ID (server, router, ...).	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 network port-show¶

Show port details.

Usage:

orca network port-show [OPTIONS] PORT_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 network port-unset¶

Remove properties from a port.

Examples: orca network port-unset --security-group orca network port-unset --qos-policy orca network port-unset --description

Usage:

orca network port-unset [OPTIONS] PORT_ID

Options:

Name	Type	Description	Default
`--security-group`	text	Security group ID to remove (repeatable).	`Sentinel.UNSET`
`--qos-policy`	boolean	Remove the QoS policy from the port.	`False`
`--description`	boolean	Clear the port description.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca network port-update¶

Update a port.

Usage:

orca network port-update [OPTIONS] PORT_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--admin-state` / `--no-admin-state`	boolean	Admin state.	None
`--help`	boolean	Show this message and exit.	`False`

orca network qos¶

Manage Neutron QoS policies and rules.

Usage:

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

Options:

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

orca network qos policy¶

Manage QoS policies.

Usage:

orca network qos policy [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network qos policy create¶

Create a QoS policy.

Usage:

orca network qos policy create [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Policy name.	`Sentinel.UNSET`
`--shared`	boolean	Share with all projects.	`False`
`--default`	boolean	Set as default policy.	`False`
`--description`	text	Description.	None
`--help`	boolean	Show this message and exit.	`False`

orca network qos policy delete¶

Delete a QoS policy.

Usage:

orca network qos policy delete [OPTIONS] POLICY_ID

Options:

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

orca network qos policy list¶

List QoS policies.

Usage:

orca network qos policy list [OPTIONS]

Options:

Name	Type	Description	Default
`--shared`	boolean	Show only shared policies.	`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 network qos policy set¶

Update a QoS policy.

Usage:

orca network qos policy set [OPTIONS] POLICY_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--shared` / `--no-shared`	boolean	Share or un-share.	None
`--default` / `--no-default`	boolean	Set or unset as default.	None
`--help`	boolean	Show this message and exit.	`False`

orca network qos policy show¶

Show a QoS policy.

Usage:

orca network qos policy show [OPTIONS] POLICY_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 network qos policy-create¶

Create a QoS policy.

Usage:

orca network qos policy-create [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Policy name.	`Sentinel.UNSET`
`--shared`	boolean	Share with all projects.	`False`
`--default`	boolean	Set as default policy.	`False`
`--description`	text	Description.	None
`--help`	boolean	Show this message and exit.	`False`

orca network qos policy-delete¶

Delete a QoS policy.

Usage:

orca network qos policy-delete [OPTIONS] POLICY_ID

Options:

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

orca network qos policy-list¶

List QoS policies.

Usage:

orca network qos policy-list [OPTIONS]

Options:

Name	Type	Description	Default
`--shared`	boolean	Show only shared policies.	`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 network qos policy-set¶

Update a QoS policy.

Usage:

orca network qos policy-set [OPTIONS] POLICY_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--shared` / `--no-shared`	boolean	Share or un-share.	None
`--default` / `--no-default`	boolean	Set or unset as default.	None
`--help`	boolean	Show this message and exit.	`False`

orca network qos policy-show¶

Show a QoS policy.

Usage:

orca network qos policy-show [OPTIONS] POLICY_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 network qos rule¶

Manage QoS rules attached to a policy.

Usage:

orca network qos rule [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network qos rule create¶

Create a QoS rule.

Examples: orca qos rule-create --type bandwidth-limit --max-kbps 1000 orca qos rule-create --type dscp-marking --dscp-mark 14 orca qos rule-create --type minimum-bandwidth --min-kbps 500

Usage:

orca network qos rule create [OPTIONS] POLICY_ID

Options:

Name	Type	Description	Default
`--type`	choice (`bandwidth-limit` \| `dscp-marking` \| `minimum-bandwidth` \| `minimum-packet-rate`)	Rule type.	`bandwidth-limit`
`--max-kbps`	integer	Maximum bandwidth in kbps (bandwidth-limit).	None
`--max-burst-kbps`	integer	Maximum burst bandwidth in kbps (bandwidth-limit).	None
`--direction`	choice (`ingress` \| `egress`)	Traffic direction (bandwidth-limit, minimum-bandwidth).	`egress`
`--dscp-mark`	integer	DSCP mark value 0-56 (dscp-marking).	None
`--min-kbps`	integer	Minimum bandwidth in kbps (minimum-bandwidth).	None
`--help`	boolean	Show this message and exit.	`False`

orca network qos rule delete¶

Delete a QoS rule.

Usage:

orca network qos rule delete [OPTIONS] POLICY_ID RULE_ID

Options:

Name	Type	Description	Default
`--type`	choice (`bandwidth-limit` \| `dscp-marking` \| `minimum-bandwidth` \| `minimum-packet-rate`)	Rule type.	`bandwidth-limit`
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca network qos rule list¶

List QoS rules for a policy.

Usage:

orca network qos rule list [OPTIONS] POLICY_ID

Options:

Name	Type	Description	Default
`--type`	choice (`bandwidth-limit` \| `dscp-marking` \| `minimum-bandwidth` \| `minimum-packet-rate`)	Rule type.	`bandwidth-limit`
`--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 network qos rule set¶

Update an existing QoS rule.

Example: orca qos rule set --type bandwidth-limit --max-kbps 2000

Usage:

orca network qos rule set [OPTIONS] POLICY_ID RULE_ID

Options:

Name	Type	Description	Default
`--type`	choice (`bandwidth-limit` \| `dscp-marking` \| `minimum-bandwidth` \| `minimum-packet-rate`)	Rule type.	`bandwidth-limit`
`--max-kbps`	integer	New max bandwidth in kbps (bandwidth-limit).	None
`--max-burst-kbps`	integer	New max burst bandwidth in kbps (bandwidth-limit).	None
`--direction`	choice (`ingress` \| `egress`)	New traffic direction (bandwidth-limit, minimum-bandwidth).	None
`--dscp-mark`	integer	New DSCP mark value (dscp-marking).	None
`--min-kbps`	integer	New min bandwidth in kbps (minimum-bandwidth).	None
`--help`	boolean	Show this message and exit.	`False`

orca network qos rule show¶

Show details of a QoS rule.

Usage:

orca network qos rule show [OPTIONS] POLICY_ID RULE_ID

Options:

Name	Type	Description	Default
`--type`	choice (`bandwidth-limit` \| `dscp-marking` \| `minimum-bandwidth` \| `minimum-packet-rate`)	Rule type.	`bandwidth-limit`
`--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 network qos rule-create¶

Create a QoS rule.

Examples: orca qos rule-create --type bandwidth-limit --max-kbps 1000 orca qos rule-create --type dscp-marking --dscp-mark 14 orca qos rule-create --type minimum-bandwidth --min-kbps 500

Usage:

orca network qos rule-create [OPTIONS] POLICY_ID

Options:

Name	Type	Description	Default
`--type`	choice (`bandwidth-limit` \| `dscp-marking` \| `minimum-bandwidth` \| `minimum-packet-rate`)	Rule type.	`bandwidth-limit`
`--max-kbps`	integer	Maximum bandwidth in kbps (bandwidth-limit).	None
`--max-burst-kbps`	integer	Maximum burst bandwidth in kbps (bandwidth-limit).	None
`--direction`	choice (`ingress` \| `egress`)	Traffic direction (bandwidth-limit, minimum-bandwidth).	`egress`
`--dscp-mark`	integer	DSCP mark value 0-56 (dscp-marking).	None
`--min-kbps`	integer	Minimum bandwidth in kbps (minimum-bandwidth).	None
`--help`	boolean	Show this message and exit.	`False`

orca network qos rule-delete¶

Delete a QoS rule.

Usage:

orca network qos rule-delete [OPTIONS] POLICY_ID RULE_ID

Options:

Name	Type	Description	Default
`--type`	choice (`bandwidth-limit` \| `dscp-marking` \| `minimum-bandwidth` \| `minimum-packet-rate`)	Rule type.	`bandwidth-limit`
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca network qos rule-list¶

List QoS rules for a policy.

Usage:

orca network qos rule-list [OPTIONS] POLICY_ID

Options:

Name	Type	Description	Default
`--type`	choice (`bandwidth-limit` \| `dscp-marking` \| `minimum-bandwidth` \| `minimum-packet-rate`)	Rule type.	`bandwidth-limit`
`--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 network qos rule-type¶

Inspect QoS rule types Neutron knows how to enforce (read-only).

Usage:

orca network qos rule-type [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network qos rule-type list¶

List supported QoS rule types.

Usage:

orca network qos rule-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 network qos rule-type show¶

Show the directions a QoS rule type supports.

Usage:

orca network qos rule-type show [OPTIONS] RULE_TYPE

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 network rbac¶

Manage RBAC policies on networks/qos/subnetpools/etc.

Usage:

orca network rbac [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network rbac create¶

Create an RBAC policy to share a network resource.

Example — share a network with all projects: orca network rbac-create \ --object-type network \ --object \ --action access_as_shared \ --target-project '*'

Usage:

orca network rbac create [OPTIONS]

Options:

Name	Type	Description	Default
`--object-type`	choice (`network` \| `qos_policy` \| `security_group` \| `address_group` \| `address_scope` \| `subnetpool`)	Type of the shared object.	`Sentinel.UNSET`
`--object`	text	ID of the object to share.	`Sentinel.UNSET`
`--action`	choice (`access_as_shared` \| `access_as_external`)	RBAC action.	`Sentinel.UNSET`
`--target-project`	text	Project ID to grant access to (use '*' for all projects).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca network rbac delete¶

Delete an RBAC policy.

Usage:

orca network rbac delete [OPTIONS] RBAC_ID

Options:

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

orca network rbac list¶

List RBAC policies.

Usage:

orca network rbac list [OPTIONS]

Options:

Name	Type	Description	Default
`--object-type`	choice (`network` \| `qos_policy` \| `security_group` \| `address_group` \| `address_scope` \| `subnetpool`)	Filter by object 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 network rbac show¶

Show an RBAC policy.

Usage:

orca network rbac show [OPTIONS] RBAC_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 network rbac update¶

Update the target project of an RBAC policy.

Example: orca network rbac-update --target-project orca network rbac-update --target-project '*'

Usage:

orca network rbac update [OPTIONS] RBAC_ID

Options:

Name	Type	Description	Default
`--target-project`	text	New target project ID (use '*' for all projects).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca network rbac update¶

Update the target project of an RBAC policy.

Example: orca network rbac-update --target-project orca network rbac-update --target-project '*'

Usage:

orca network rbac update [OPTIONS] RBAC_ID

Options:

Name	Type	Description	Default
`--target-project`	text	New target project ID (use '*' for all projects).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca network rbac-create¶

Create an RBAC policy to share a network resource.

Example — share a network with all projects: orca network rbac-create \ --object-type network \ --object \ --action access_as_shared \ --target-project '*'

Usage:

orca network rbac-create [OPTIONS]

Options:

Name	Type	Description	Default
`--object-type`	choice (`network` \| `qos_policy` \| `security_group` \| `address_group` \| `address_scope` \| `subnetpool`)	Type of the shared object.	`Sentinel.UNSET`
`--object`	text	ID of the object to share.	`Sentinel.UNSET`
`--action`	choice (`access_as_shared` \| `access_as_external`)	RBAC action.	`Sentinel.UNSET`
`--target-project`	text	Project ID to grant access to (use '*' for all projects).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca network rbac-delete¶

Delete an RBAC policy.

Usage:

orca network rbac-delete [OPTIONS] RBAC_ID

Options:

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

orca network rbac-list¶

List RBAC policies.

Usage:

orca network rbac-list [OPTIONS]

Options:

Name	Type	Description	Default
`--object-type`	choice (`network` \| `qos_policy` \| `security_group` \| `address_group` \| `address_scope` \| `subnetpool`)	Filter by object 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 network rbac-show¶

Show an RBAC policy.

Usage:

orca network rbac-show [OPTIONS] RBAC_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 network rbac-update¶

Update the target project of an RBAC policy.

Example: orca network rbac-update --target-project orca network rbac-update --target-project '*'

Usage:

orca network rbac-update [OPTIONS] RBAC_ID

Options:

Name	Type	Description	Default
`--target-project`	text	New target project ID (use '*' for all projects).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca network router¶

Manage Neutron routers.

Usage:

orca network router [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network router add¶

Attach a sub-resource to a router (interface, route).

Usage:

orca network router add [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network router add gateway¶

Set an external gateway on a router (OSC router add gateway).

Usage:

orca network router add gateway [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--network`	text	External network ID to use as gateway.	`Sentinel.UNSET`
`--fixed-ip`	text	Fixed IP on the external network (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca network router add interface¶

Add a subnet interface to a router.

Usage:

orca network router add interface [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--subnet-id`	text	Subnet to attach.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca network router add port¶

Attach an existing port to a router (OSC router add port).

Usage:

orca network router add port [OPTIONS] ROUTER_ID PORT_ID

Options:

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

orca network router add route¶

Add a static route to a router (requires extraroute-atomic extension).

Example: orca network router-add-route --destination 10.1.0.0/24 --nexthop 192.168.1.1

Usage:

orca network router add route [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--destination`	text	Destination network (e.g. 10.1.0.0/24).	`Sentinel.UNSET`
`--nexthop`	text	Next-hop IP address.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca network router add subnet¶

Add a subnet to a router (OSC router add subnet).

Usage:

orca network router add subnet [OPTIONS] ROUTER_ID SUBNET_ID

Options:

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

orca network router create¶

Create a router.

Usage:

orca network router create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--external-network`	text	External network ID for gateway.	None
`--help`	boolean	Show this message and exit.	`False`

orca network router delete¶

Delete a router.

Usage:

orca network router delete [OPTIONS] ROUTER_ID

Options:

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

orca network router list¶

List routers.

Usage:

orca network router 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 network router ndp-proxy¶

Manage IPv6 NDP proxies on a router.

Usage:

orca network router ndp-proxy [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network router ndp-proxy create¶

Create an NDP proxy.

Usage:

orca network router ndp-proxy create [OPTIONS]

Options:

Name	Type	Description	Default
`--router-id`	text	N/A	`Sentinel.UNSET`
`--port-id`	text	N/A	`Sentinel.UNSET`
`--ip-address`	text	Specific IPv6 address (autopicked if omitted).	None
`--help`	boolean	Show this message and exit.	`False`

orca network router ndp-proxy delete¶

Delete an NDP proxy.

Usage:

orca network router ndp-proxy delete [OPTIONS] NDP_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca network router ndp-proxy list¶

List NDP proxies.

Usage:

orca network router ndp-proxy list [OPTIONS]

Options:

Name	Type	Description	Default
`--router-id`	text	Filter by router.	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 network router ndp-proxy set¶

Update an NDP proxy.

Usage:

orca network router ndp-proxy set [OPTIONS] NDP_ID

Options:

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

orca network router ndp-proxy show¶

Show an NDP proxy.

Usage:

orca network router ndp-proxy show [OPTIONS] NDP_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 network router remove¶

Detach a sub-resource from a router.

Usage:

orca network router remove [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network router remove gateway¶

Clear a router's external gateway (OSC router remove gateway).

Usage:

orca network router remove gateway [OPTIONS] ROUTER_ID

Options:

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

orca network router remove interface¶

Remove a subnet interface from a router.

Usage:

orca network router remove interface [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--subnet-id`	text	Subnet to detach.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca network router remove port¶

Detach a port from a router (OSC router remove port).

Usage:

orca network router remove port [OPTIONS] ROUTER_ID PORT_ID

Options:

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

orca network router remove route¶

Remove a static route from a router (requires extraroute-atomic extension).

Example: orca network router-remove-route --destination 10.1.0.0/24 --nexthop 192.168.1.1

Usage:

orca network router remove route [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--destination`	text	Destination network to remove.	`Sentinel.UNSET`
`--nexthop`	text	Next-hop IP address.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca network router remove subnet¶

Remove a subnet from a router (OSC router remove subnet).

Usage:

orca network router remove subnet [OPTIONS] ROUTER_ID SUBNET_ID

Options:

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

orca network router show¶

Show router details.

Usage:

orca network router show [OPTIONS] ROUTER_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 network router update¶

Update a router.

Usage:

orca network router update [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--external-network`	text	New external gateway network ID.	None
`--help`	boolean	Show this message and exit.	`False`

orca network router update¶

Update a router.

Usage:

orca network router update [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--external-network`	text	New external gateway network ID.	None
`--help`	boolean	Show this message and exit.	`False`

orca network router update¶

Update a router.

Usage:

orca network router update [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--external-network`	text	New external gateway network ID.	None
`--help`	boolean	Show this message and exit.	`False`

orca network router-add-interface¶

Add a subnet interface to a router.

Usage:

orca network router-add-interface [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--subnet-id`	text	Subnet to attach.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca network router-add-route¶

Add a static route to a router (requires extraroute-atomic extension).

Example: orca network router-add-route --destination 10.1.0.0/24 --nexthop 192.168.1.1

Usage:

orca network router-add-route [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--destination`	text	Destination network (e.g. 10.1.0.0/24).	`Sentinel.UNSET`
`--nexthop`	text	Next-hop IP address.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca network router-create¶

Create a router.

Usage:

orca network router-create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--external-network`	text	External network ID for gateway.	None
`--help`	boolean	Show this message and exit.	`False`

orca network router-delete¶

Delete a router.

Usage:

orca network router-delete [OPTIONS] ROUTER_ID

Options:

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

orca network router-list¶

List routers.

Usage:

orca network router-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 network router-remove-interface¶

Remove a subnet interface from a router.

Usage:

orca network router-remove-interface [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--subnet-id`	text	Subnet to detach.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca network router-remove-route¶

Remove a static route from a router (requires extraroute-atomic extension).

Example: orca network router-remove-route --destination 10.1.0.0/24 --nexthop 192.168.1.1

Usage:

orca network router-remove-route [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--destination`	text	Destination network to remove.	`Sentinel.UNSET`
`--nexthop`	text	Next-hop IP address.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca network router-set-gateway¶

Set (or replace) the external gateway on a router.

Examples: orca network router-set-gateway --external-network orca network router-set-gateway --external-network --enable-snat

Usage:

orca network router-set-gateway [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--external-network`	text	External network ID to use as gateway.	`Sentinel.UNSET`
`--enable-snat` / `--disable-snat`	boolean	Enable or disable SNAT on the gateway.	None
`--help`	boolean	Show this message and exit.	`False`

orca network router-show¶

Show router details.

Usage:

orca network router-show [OPTIONS] ROUTER_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 network router-unset-gateway¶

Remove the external gateway from a router.

Example: orca network router-unset-gateway

Usage:

orca network router-unset-gateway [OPTIONS] ROUTER_ID

Options:

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

orca network router-update¶

Update a router.

Usage:

orca network router-update [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--external-network`	text	New external gateway network ID.	None
`--help`	boolean	Show this message and exit.	`False`

orca network segment¶

Manage network segments.

Usage:

orca network segment [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network segment create¶

Create a network segment.

Usage:

orca network segment create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--network-id`	text	Network ID this segment belongs to.	`Sentinel.UNSET`
`--network-type`	choice (`flat` \| `geneve` \| `gre` \| `local` \| `vlan` \| `vxlan`)	Network type.	`Sentinel.UNSET`
`--physical-network`	text	Physical network name.	None
`--segment`	integer	Segmentation ID (VLAN ID or tunnel ID).	None
`--description`	text	Segment description.	None
`--help`	boolean	Show this message and exit.	`False`

orca network segment delete¶

Delete a network segment.

Usage:

orca network segment delete [OPTIONS] SEGMENT_ID

Options:

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

orca network segment list¶

List network segments.

Usage:

orca network segment list [OPTIONS]

Options:

Name	Type	Description	Default
`--network-id`	text	Filter by network 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 network segment set¶

Update a network segment.

Usage:

orca network segment set [OPTIONS] SEGMENT_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 network segment show¶

Show a network segment.

Usage:

orca network segment show [OPTIONS] SEGMENT_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 network segment-create¶

Create a network segment.

Usage:

orca network segment-create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--network-id`	text	Network ID this segment belongs to.	`Sentinel.UNSET`
`--network-type`	choice (`flat` \| `geneve` \| `gre` \| `local` \| `vlan` \| `vxlan`)	Network type.	`Sentinel.UNSET`
`--physical-network`	text	Physical network name.	None
`--segment`	integer	Segmentation ID (VLAN ID or tunnel ID).	None
`--description`	text	Segment description.	None
`--help`	boolean	Show this message and exit.	`False`

orca network segment-delete¶

Delete a network segment.

Usage:

orca network segment-delete [OPTIONS] SEGMENT_ID

Options:

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

orca network segment-list¶

List network segments.

Usage:

orca network segment-list [OPTIONS]

Options:

Name	Type	Description	Default
`--network-id`	text	Filter by network 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 network segment-range¶

Manage network segment ID ranges (admin).

Usage:

orca network segment-range [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network segment-range create¶

Create a segment range.

Usage:

orca network segment-range create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--network-type`	choice (`vlan` \| `vxlan` \| `gre` \| `geneve`)	Segment type.	`Sentinel.UNSET`
`--physical-network`	text	Physical network identifier (required for vlan).	None
`--minimum`	integer	Minimum segment ID.	`Sentinel.UNSET`
`--maximum`	integer	Maximum segment ID.	`Sentinel.UNSET`
`--shared` / `--unshared`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca network segment-range delete¶

Delete a segment range.

Usage:

orca network segment-range delete [OPTIONS] SR_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca network segment-range list¶

List network segment ranges.

Usage:

orca network segment-range 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 network segment-range set¶

Update a segment range.

Usage:

orca network segment-range set [OPTIONS] SR_ID

Options:

Name	Type	Description	Default
`--name`	text	N/A	None
`--minimum`	integer	N/A	None
`--maximum`	integer	N/A	None
`--help`	boolean	Show this message and exit.	`False`

orca network segment-range show¶

Show a segment range.

Usage:

orca network segment-range show [OPTIONS] SR_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 network segment-set¶

Update a network segment.

Usage:

orca network segment-set [OPTIONS] SEGMENT_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 network segment-show¶

Show a network segment.

Usage:

orca network segment-show [OPTIONS] SEGMENT_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 network service-provider¶

Inspect Neutron service providers (BGP-VPN, L3, …).

Usage:

orca network service-provider [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network service-provider list¶

List Neutron service providers.

Usage:

orca network service-provider 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 network show¶

Show network details.

Usage:

orca network show [OPTIONS] NETWORK_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 network subnet¶

Manage Neutron subnets.

Usage:

orca network subnet [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network subnet create¶

Create a subnet.

Usage:

orca network subnet create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--network-id`	text	Parent network ID.	`Sentinel.UNSET`
`--cidr`	text	CIDR (e.g. 10.0.0.0/24).	`Sentinel.UNSET`
`--ip-version`	choice (`4` \| `6`)	N/A	`4`
`--gateway`	text	Gateway IP. Auto if omitted.	None
`--dhcp` / `--no-dhcp`	boolean	Enable DHCP.	`True`
`--dns`	text	DNS nameserver (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca network subnet delete¶

Delete a subnet.

Usage:

orca network subnet delete [OPTIONS] SUBNET_ID

Options:

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

orca network subnet inspect¶

Full inspection of a subnet — fields + IP usage + attached ports + servers.

Cross-references three Neutron endpoints so you don't have to run subnet show + port list + ip-availability show by hand:

GET /subnets/{id} — the subnet fields
GET /network-ip-availabilities/{network_id} — IP usage per subnet
GET /ports?fixed_ips=subnet_id=<id> — who actually uses each IP

For each port, follow device_id when device_owner is compute:* to surface the server name (single Nova servers/{id} GET per attached VM).

Example: orca network subnet inspect

Usage:

orca network subnet inspect [OPTIONS] SUBNET_ID

Options:

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

orca network subnet list¶

List subnets.

Usage:

orca network subnet 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 network subnet show¶

Show subnet details.

Usage:

orca network subnet show [OPTIONS] SUBNET_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 network subnet update¶

Update a subnet.

Usage:

orca network subnet update [OPTIONS] SUBNET_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--dns-nameserver`	text	DNS nameserver IP (repeatable, replaces existing list).	`Sentinel.UNSET`
`--enable-dhcp` / `--disable-dhcp`	boolean	Enable or disable DHCP.	None
`--help`	boolean	Show this message and exit.	`False`

orca network subnet update¶

Update a subnet.

Usage:

orca network subnet update [OPTIONS] SUBNET_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--dns-nameserver`	text	DNS nameserver IP (repeatable, replaces existing list).	`Sentinel.UNSET`
`--enable-dhcp` / `--disable-dhcp`	boolean	Enable or disable DHCP.	None
`--help`	boolean	Show this message and exit.	`False`

orca network subnet update¶

Update a subnet.

Usage:

orca network subnet update [OPTIONS] SUBNET_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--dns-nameserver`	text	DNS nameserver IP (repeatable, replaces existing list).	`Sentinel.UNSET`
`--enable-dhcp` / `--disable-dhcp`	boolean	Enable or disable DHCP.	None
`--help`	boolean	Show this message and exit.	`False`

orca network subnet-create¶

Create a subnet.

Usage:

orca network subnet-create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--network-id`	text	Parent network ID.	`Sentinel.UNSET`
`--cidr`	text	CIDR (e.g. 10.0.0.0/24).	`Sentinel.UNSET`
`--ip-version`	choice (`4` \| `6`)	N/A	`4`
`--gateway`	text	Gateway IP. Auto if omitted.	None
`--dhcp` / `--no-dhcp`	boolean	Enable DHCP.	`True`
`--dns`	text	DNS nameserver (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca network subnet-delete¶

Delete a subnet.

Usage:

orca network subnet-delete [OPTIONS] SUBNET_ID

Options:

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

orca network subnet-list¶

List subnets.

Usage:

orca network subnet-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 network subnet-show¶

Show subnet details.

Usage:

orca network subnet-show [OPTIONS] SUBNET_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 network subnet-update¶

Update a subnet.

Usage:

orca network subnet-update [OPTIONS] SUBNET_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--dns-nameserver`	text	DNS nameserver IP (repeatable, replaces existing list).	`Sentinel.UNSET`
`--enable-dhcp` / `--disable-dhcp`	boolean	Enable or disable DHCP.	None
`--help`	boolean	Show this message and exit.	`False`

orca network subport¶

Sub-ports of a trunk (alias of orca trunk subport).

Usage:

orca network subport [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network subport list¶

List sub-ports on a trunk.

Usage:

orca network subport list [OPTIONS] TRUNK_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 network topology¶

Display the network topology as a tree.

Shows networks → subnets → connected ports with device info (servers, routers, DHCP, load-balancers).

Examples: orca network topology orca network topology --network-id

Usage:

orca network topology [OPTIONS]

Options:

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

orca network trace¶

Trace the full network path for a server instance.

Shows every hop: fixed IP → port → security groups → router → floating IP, with status and IDs at each step.

Examples: orca network trace orca network trace

Usage:

orca network trace [OPTIONS] SERVER_ID

Options:

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

orca network trunk¶

Manage Neutron trunks (VLAN trunk ports).

Usage:

orca network trunk [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network trunk add-subport¶

Add a sub-port to a trunk.

Usage:

orca network trunk add-subport [OPTIONS] TRUNK_ID

Options:

Name	Type	Description	Default
`--port`	text	Sub-port port ID.	`Sentinel.UNSET`
`--segmentation-type`	choice (`vlan` \| `inherit`)	Segmentation type.	`vlan`
`--segmentation-id`	integer	VLAN ID (1–4094).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca network trunk create¶

Create a trunk.

Usage:

orca network trunk create [OPTIONS]

Options:

Name	Type	Description	Default
`--port`	text	Parent port ID (the trunk port).	`Sentinel.UNSET`
`--name`	text	Trunk name.	None
`--description`	text	Description.	None
`--disable`	boolean	Create trunk in administratively down state.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca network trunk delete¶

Delete a trunk.

Usage:

orca network trunk delete [OPTIONS] TRUNK_ID

Options:

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

orca network trunk list¶

List trunks.

Usage:

orca network trunk 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 network trunk remove-subport¶

Remove a sub-port from a trunk.

Usage:

orca network trunk remove-subport [OPTIONS] TRUNK_ID

Options:

Name	Type	Description	Default
`--port`	text	Sub-port port ID to remove.	`Sentinel.UNSET`
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca network trunk set¶

Update a trunk.

Usage:

orca network trunk set [OPTIONS] TRUNK_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--enable` / `--disable`	boolean	Enable or disable the trunk.	None
`--help`	boolean	Show this message and exit.	`False`

orca network trunk show¶

Show trunk details.

Usage:

orca network trunk show [OPTIONS] TRUNK_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 network trunk subport¶

Manage sub-ports on a trunk.

Usage:

orca network trunk subport [OPTIONS] COMMAND [ARGS]...

Options:

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

orca network trunk subport add¶

Add a sub-port to a trunk.

Usage:

orca network trunk subport add [OPTIONS] TRUNK_ID

Options:

Name	Type	Description	Default
`--port`	text	Sub-port port ID.	`Sentinel.UNSET`
`--segmentation-type`	choice (`vlan` \| `inherit`)	Segmentation type.	`vlan`
`--segmentation-id`	integer	VLAN ID (1–4094).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca network trunk subport list¶

List sub-ports on a trunk.

Usage:

orca network trunk subport list [OPTIONS] TRUNK_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 network trunk subport remove¶

Remove a sub-port from a trunk.

Usage:

orca network trunk subport remove [OPTIONS] TRUNK_ID

Options:

Name	Type	Description	Default
`--port`	text	Sub-port port ID to remove.	`Sentinel.UNSET`
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca network trunk subport-list¶

List sub-ports on a trunk.

Usage:

orca network trunk subport-list [OPTIONS] TRUNK_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 network trunk unset¶

Clear optional fields on a trunk (description, …).

Usage:

orca network trunk unset [OPTIONS] TRUNK_ID

Options:

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

orca network update¶

Update a network.

Usage:

orca network update [OPTIONS] NETWORK_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--admin-state` / `--no-admin-state`	boolean	Admin state.	None
`--help`	boolean	Show this message and exit.	`False`

orca network update¶

Update a network.

Usage:

orca network update [OPTIONS] NETWORK_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--admin-state` / `--no-admin-state`	boolean	Admin state.	None
`--help`	boolean	Show this message and exit.	`False`

orca network update¶

Update a network.

Usage:

orca network update [OPTIONS] NETWORK_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--admin-state` / `--no-admin-state`	boolean	Admin state.	None
`--help`	boolean	Show this message and exit.	`False`

orca object¶

Manage object storage containers & objects (Swift).

Usage:

orca object [OPTIONS] COMMAND [ARGS]...

Options:

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

orca object account¶

Manage Swift account-level metadata.

Usage:

orca object account [OPTIONS] COMMAND [ARGS]...

Options:

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

orca object account set¶

Set account-level metadata.

Usage:

orca object account set [OPTIONS]

Options:

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

orca object account show¶

Show Swift account-level metadata and counters.

Equivalent to openstack object store account show.

Usage:

orca object account show [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 object account unset¶

Remove account-level metadata.

Usage:

orca object account unset [OPTIONS]

Options:

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

orca object account-set¶

Set account-level metadata.

Usage:

orca object account-set [OPTIONS]

Options:

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

orca object account-unset¶

Remove account-level metadata.

Usage:

orca object account-unset [OPTIONS]

Options:

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

orca object container¶

Manage Swift containers.

Usage:

orca object container [OPTIONS] COMMAND [ARGS]...

Options:

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

orca object container create¶

Create a container.

Usage:

orca object container create [OPTIONS] CONTAINER

Options:

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

orca object container delete¶

Delete a container.

Use --recursive to delete all objects in the container first.

Usage:

orca object container delete [OPTIONS] CONTAINER

Options:

Name	Type	Description	Default
`--recursive`	boolean	Delete all objects before deleting the container.	`False`
`--yes`, `-y`	boolean	Skip confirmation prompt.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca object container list¶

List containers.

Usage:

orca object container 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 object container save¶

Download all objects in a container to a local directory.

Usage:

orca object container save [OPTIONS] CONTAINER

Options:

Name	Type	Description	Default
`--output-dir`	text	Local directory to save objects into.	`.`
`--help`	boolean	Show this message and exit.	`False`

orca object container set¶

Set metadata on a container.

Usage:

orca object container set [OPTIONS] CONTAINER

Options:

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

orca object container show¶

Show container metadata.

Usage:

orca object container show [OPTIONS] CONTAINER

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 object container-create¶

Create a container.

Usage:

orca object container-create [OPTIONS] CONTAINER

Options:

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

orca object container-delete¶

Delete a container.

Use --recursive to delete all objects in the container first.

Usage:

orca object container-delete [OPTIONS] CONTAINER

Options:

Name	Type	Description	Default
`--recursive`	boolean	Delete all objects before deleting the container.	`False`
`--yes`, `-y`	boolean	Skip confirmation prompt.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca object container-list¶

List containers.

Usage:

orca object container-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 object container-save¶

Download all objects in a container to a local directory.

Usage:

orca object container-save [OPTIONS] CONTAINER

Options:

Name	Type	Description	Default
`--output-dir`	text	Local directory to save objects into.	`.`
`--help`	boolean	Show this message and exit.	`False`

orca object container-set¶

Set metadata on a container.

Usage:

orca object container-set [OPTIONS] CONTAINER

Options:

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

orca object container-show¶

Show container metadata.

Usage:

orca object container-show [OPTIONS] CONTAINER

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 object delete¶

Delete one or more objects from a container.

Usage:

orca object delete [OPTIONS] CONTAINER OBJECT...

Options:

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

orca object download¶

Download an object from a container.

Usage:

orca object download [OPTIONS] CONTAINER OBJECT

Options:

Name	Type	Description	Default
`--file`	text	Local filename to save to (defaults to object name).	None
`--help`	boolean	Show this message and exit.	`False`

orca object download¶

Download an object from a container.

Usage:

orca object download [OPTIONS] CONTAINER OBJECT

Options:

Name	Type	Description	Default
`--file`	text	Local filename to save to (defaults to object name).	None
`--help`	boolean	Show this message and exit.	`False`

orca object list¶

List objects in a container.

Usage:

orca object list [OPTIONS] CONTAINER

Options:

Name	Type	Description	Default
`--prefix`	text	Only list objects with this prefix.	None
`--delimiter`	text	Delimiter for pseudo-folder grouping.	None
`--long`	boolean	Show hash and content type.	`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 object set¶

Set metadata on an object.

Usage:

orca object set [OPTIONS] CONTAINER OBJECT

Options:

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

orca object show¶

Show object metadata.

Usage:

orca object show [OPTIONS] CONTAINER OBJECT

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 object stats¶

Show account-level storage statistics.

Usage:

orca object stats [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 object tree¶

Show containers and objects as a tree.

Without a container argument, shows all containers. With a container, shows the pseudo-folder structure of objects within it.

Usage:

orca object tree [OPTIONS] [CONTAINER]

Options:

Name	Type	Description	Default
`--delimiter`	text	Delimiter for pseudo-folder hierarchy.	`/`
`--help`	boolean	Show this message and exit.	`False`

orca object unset¶

Remove metadata from an object.

Usage:

orca object unset [OPTIONS] CONTAINER OBJECT

Options:

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

orca object upload¶

Upload file(s) to a container.

Files larger than 5 GB are automatically split into segments using Swift SLO (Static Large Object).

Usage:

orca object upload [OPTIONS] CONTAINER FILES...

Options:

Name	Type	Description	Default
`--name`	text	Override the object name (only valid for single file upload).	None
`--segment-size`	integer	Segment size in MB for large files (default: 4096 MB).	None
`--help`	boolean	Show this message and exit.	`False`

orca object upload¶

Upload file(s) to a container.

Files larger than 5 GB are automatically split into segments using Swift SLO (Static Large Object).

Usage:

orca object upload [OPTIONS] CONTAINER FILES...

Options:

Name	Type	Description	Default
`--name`	text	Override the object name (only valid for single file upload).	None
`--segment-size`	integer	Segment size in MB for large files (default: 4096 MB).	None
`--help`	boolean	Show this message and exit.	`False`

orca object-store¶

OSC parity: openstack object store … admin verbs.

Usage:

orca object-store [OPTIONS] COMMAND [ARGS]...

Options:

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

orca object-store account¶

Swift account-level metadata.

Usage:

orca object-store account [OPTIONS] COMMAND [ARGS]...

Options:

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

orca object-store account set¶

Set account-level metadata.

Usage:

orca object-store account set [OPTIONS]

Options:

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

orca object-store account show¶

Show Swift account-level metadata and counters.

Equivalent to openstack object store account show.

Usage:

orca object-store account show [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 object-store account unset¶

Remove account-level metadata.

Usage:

orca object-store account unset [OPTIONS]

Options:

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

orca orchestration¶

Heat orchestration — OSC parity top-level.

Usage:

orca orchestration [OPTIONS] COMMAND [ARGS]...

Options:

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

orca orchestration build¶

Heat build info.

Usage:

orca orchestration build [OPTIONS] COMMAND [ARGS]...

Options:

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

orca orchestration build info¶

Show Heat engine + API build info (GET /v1/build_info).

Usage:

orca orchestration build info [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 orchestration resource-type¶

Inspect Heat resource types (compound noun).

Usage:

orca orchestration resource-type [OPTIONS] COMMAND [ARGS]...

Options:

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

orca orchestration resource-type list¶

List available Heat resource types.

Usage:

orca orchestration resource-type list [OPTIONS]

Options:

Name	Type	Description	Default
`--filter`	text	Filter resource types by name substring.	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 orchestration resource-type show¶

Show the schema for a Heat resource type.

Usage:

orca orchestration resource-type show [OPTIONS] RESOURCE_TYPE

Options:

Name	Type	Description	Default
`--template-type`	choice (`cfn` \| `hot`)	Template format for the resource schema.	`hot`
`--help`	boolean	Show this message and exit.	`False`

orca orchestration service¶

Heat engine services.

Usage:

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

Options:

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

orca orchestration service list¶

List heat-engine workers (GET /v1/services).

Usage:

orca orchestration service 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 orchestration template¶

Heat template inspection (OSC parity).

Usage:

orca orchestration template [OPTIONS] COMMAND [ARGS]...

Options:

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

orca orchestration template function¶

Heat template functions per version.

Usage:

orca orchestration template function [OPTIONS] COMMAND [ARGS]...

Options:

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

orca orchestration template function list¶

List the intrinsic functions available in a template version.

Usage:

orca orchestration template function list [OPTIONS] VERSION

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 orchestration template validate¶

Validate a Heat template.

Examples: orca stack template-validate -t template.yaml orca stack template-validate -t template.yaml -e env.yaml

Usage:

orca orchestration template validate [OPTIONS]

Options:

Name	Type	Description	Default
`--template`, `-t`	text	Template file path or URL.	`Sentinel.UNSET`
`--environment`, `-e`	text	Environment file path.	None
`--parameter`	text	Parameter key=value (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca orchestration template version¶

Heat template versions.

Usage:

orca orchestration template version [OPTIONS] COMMAND [ARGS]...

Options:

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

orca orchestration template version list¶

List Heat template versions accepted by the engine.

Usage:

orca orchestration template version 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 overview¶

Show a project dashboard — servers, quotas, volumes, IPs at a glance.

Usage:

orca overview [OPTIONS]

Options:

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

orca placement¶

Manage Placement resources (resource providers, classes, traits, etc.).

Usage:

orca placement [OPTIONS] COMMAND [ARGS]...

Options:

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

orca placement allocation¶

Manage Placement allocations.

Usage:

orca placement allocation [OPTIONS] COMMAND [ARGS]...

Options:

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

orca placement allocation candidate¶

Placement allocation candidates.

Usage:

orca placement allocation candidate [OPTIONS] COMMAND [ARGS]...

Options:

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

orca placement allocation candidate candidate-list¶

List allocation candidates for the requested resources.

Usage:

orca placement allocation candidate candidate-list [OPTIONS]

Options:

Name	Type	Description	Default
`--resource`	text	Requested resource, e.g. VCPU=4. Repeatable.	`Sentinel.UNSET`
`--required`	text	Required trait. Repeatable.	`Sentinel.UNSET`
`--forbidden`	text	Forbidden trait. Repeatable.	`Sentinel.UNSET`
`--limit`	integer	Max number of candidates.	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 placement allocation candidate-list¶

List allocation candidates for the requested resources.

Usage:

orca placement allocation candidate-list [OPTIONS]

Options:

Name	Type	Description	Default
`--resource`	text	Requested resource, e.g. VCPU=4. Repeatable.	`Sentinel.UNSET`
`--required`	text	Required trait. Repeatable.	`Sentinel.UNSET`
`--forbidden`	text	Forbidden trait. Repeatable.	`Sentinel.UNSET`
`--limit`	integer	Max number of candidates.	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 placement allocation delete¶

Delete all allocations for a consumer.

Usage:

orca placement allocation delete [OPTIONS] CONSUMER_UUID

Options:

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

orca placement allocation set¶

Set (replace) allocations for a consumer against a single resource provider.

Usage:

orca placement allocation set [OPTIONS] CONSUMER_UUID

Options:

Name	Type	Description	Default
`--resource-provider`	text	Resource provider UUID.	`Sentinel.UNSET`
`--resource`	text	Resource class and amount, e.g. VCPU=4. Repeatable.	`Sentinel.UNSET`
`--project-id`	text	Consumer project UUID.	`Sentinel.UNSET`
`--user-id`	text	Consumer user UUID.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca placement allocation show¶

Show allocations for a consumer.

Usage:

orca placement allocation show [OPTIONS] CONSUMER_UUID

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 placement allocation unset¶

Drop a single resource-class allocation for a consumer.

Reads the consumer's full allocations, strips rc_name from each provider entry (optionally only on --rp-uuid), then PUTs the remaining allocations back. Empty entries are dropped.

Usage:

orca placement allocation unset [OPTIONS] CONSUMER_UUID

Options:

Name	Type	Description	Default
`--resource-class`	text	Resource class to clear (e.g. VCPU, MEMORY_MB).	`Sentinel.UNSET`
`--rp-uuid`	text	Optional: limit to allocations on this resource provider (default: all providers).	None
`--help`	boolean	Show this message and exit.	`False`

orca placement allocation-candidate-list¶

List allocation candidates for the requested resources.

Usage:

orca placement allocation-candidate-list [OPTIONS]

Options:

Name	Type	Description	Default
`--resource`	text	Requested resource, e.g. VCPU=4. Repeatable.	`Sentinel.UNSET`
`--required`	text	Required trait. Repeatable.	`Sentinel.UNSET`
`--forbidden`	text	Forbidden trait. Repeatable.	`Sentinel.UNSET`
`--limit`	integer	Max number of candidates.	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 placement allocation-delete¶

Delete all allocations for a consumer.

Usage:

orca placement allocation-delete [OPTIONS] CONSUMER_UUID

Options:

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

orca placement allocation-set¶

Set (replace) allocations for a consumer against a single resource provider.

Usage:

orca placement allocation-set [OPTIONS] CONSUMER_UUID

Options:

Name	Type	Description	Default
`--resource-provider`	text	Resource provider UUID.	`Sentinel.UNSET`
`--resource`	text	Resource class and amount, e.g. VCPU=4. Repeatable.	`Sentinel.UNSET`
`--project-id`	text	Consumer project UUID.	`Sentinel.UNSET`
`--user-id`	text	Consumer user UUID.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca placement allocation-show¶

Show allocations for a consumer.

Usage:

orca placement allocation-show [OPTIONS] CONSUMER_UUID

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 placement resource-class¶

Manage Placement resource classes (compound noun).

Usage:

orca placement resource-class [OPTIONS] COMMAND [ARGS]...

Options:

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

orca placement resource-class create¶

Create a custom resource class (must start with CUSTOM_).

Usage:

orca placement resource-class create [OPTIONS] NAME

Options:

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

orca placement resource-class delete¶

Delete a custom resource class.

Usage:

orca placement resource-class delete [OPTIONS] NAME

Options:

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

orca placement resource-class list¶

List resource classes.

Usage:

orca placement resource-class 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 placement resource-class set¶

Rename a custom resource class (OSC parity).

Usage:

orca placement resource-class set [OPTIONS] CURRENT_NAME

Options:

Name	Type	Description	Default
`--name`	text	New resource class name (must start with CUSTOM_).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca placement resource-class show¶

Show a resource class.

Usage:

orca placement resource-class show [OPTIONS] NAME

Options:

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

orca placement resource-class-create¶

Create a custom resource class (must start with CUSTOM_).

Usage:

orca placement resource-class-create [OPTIONS] NAME

Options:

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

orca placement resource-class-delete¶

Delete a custom resource class.

Usage:

orca placement resource-class-delete [OPTIONS] NAME

Options:

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

orca placement resource-class-list¶

List resource classes.

Usage:

orca placement resource-class-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 placement resource-class-show¶

Show a resource class.

Usage:

orca placement resource-class-show [OPTIONS] NAME

Options:

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

orca placement resource-provider¶

Manage Placement resource providers (compound noun).

Usage:

orca placement resource-provider [OPTIONS] COMMAND [ARGS]...

Options:

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

orca placement resource-provider aggregate¶

Aggregate associations of a resource provider (OSC parity).

Usage:

orca placement resource-provider aggregate [OPTIONS] COMMAND [ARGS]...

Options:

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

orca placement resource-provider aggregate aggregate-delete¶

Remove all aggregate associations from a resource provider.

Usage:

orca placement resource-provider aggregate aggregate-delete 
    [OPTIONS] UUID

Options:

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

orca placement resource-provider aggregate aggregate-list¶

List aggregates associated with a resource provider.

Usage:

orca placement resource-provider aggregate aggregate-list [OPTIONS] UUID

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 placement resource-provider aggregate aggregate-set¶

Set (replace) aggregates on a resource provider.

Usage:

orca placement resource-provider aggregate aggregate-set [OPTIONS] UUID
                                                         AGGREGATES...

Options:

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

orca placement resource-provider aggregate-delete¶

Remove all aggregate associations from a resource provider.

Usage:

orca placement resource-provider aggregate-delete [OPTIONS] UUID

Options:

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

orca placement resource-provider aggregate-list¶

List aggregates associated with a resource provider.

Usage:

orca placement resource-provider aggregate-list [OPTIONS] UUID

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 placement resource-provider aggregate-set¶

Set (replace) aggregates on a resource provider.

Usage:

orca placement resource-provider aggregate-set [OPTIONS] UUID AGGREGATES...

Options:

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

orca placement resource-provider allocation¶

Allocations against a resource provider (OSC parity).

Usage:

orca placement resource-provider allocation [OPTIONS] COMMAND [ARGS]...

Options:

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

orca placement resource-provider allocation delete¶

Delete all allocations for a consumer.

Usage:

orca placement resource-provider allocation delete [OPTIONS] CONSUMER_UUID

Options:

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

orca placement resource-provider allocation set¶

Set (replace) allocations for a consumer against a single resource provider.

Usage:

orca placement resource-provider allocation set [OPTIONS] CONSUMER_UUID

Options:

Name	Type	Description	Default
`--resource-provider`	text	Resource provider UUID.	`Sentinel.UNSET`
`--resource`	text	Resource class and amount, e.g. VCPU=4. Repeatable.	`Sentinel.UNSET`
`--project-id`	text	Consumer project UUID.	`Sentinel.UNSET`
`--user-id`	text	Consumer user UUID.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca placement resource-provider allocation show¶

Show allocations for a consumer.

Usage:

orca placement resource-provider allocation show [OPTIONS] CONSUMER_UUID

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 placement resource-provider allocation unset¶

Drop a single resource-class allocation for a consumer.

Reads the consumer's full allocations, strips rc_name from each provider entry (optionally only on --rp-uuid), then PUTs the remaining allocations back. Empty entries are dropped.

Usage:

orca placement resource-provider allocation unset [OPTIONS] CONSUMER_UUID

Options:

Name	Type	Description	Default
`--resource-class`	text	Resource class to clear (e.g. VCPU, MEMORY_MB).	`Sentinel.UNSET`
`--rp-uuid`	text	Optional: limit to allocations on this resource provider (default: all providers).	None
`--help`	boolean	Show this message and exit.	`False`

orca placement resource-provider create¶

Create a resource provider.

Usage:

orca placement resource-provider create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--uuid`	text	Explicit UUID for the new provider.	None
`--parent-uuid`	text	UUID of the parent provider.	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 placement resource-provider delete¶

Delete a resource provider.

Usage:

orca placement resource-provider delete [OPTIONS] UUID

Options:

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

orca placement resource-provider inventory¶

Inventories of a resource provider (OSC parity).

Usage:

orca placement resource-provider inventory [OPTIONS] COMMAND [ARGS]...

Options:

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

orca placement resource-provider inventory class¶

Per-resource-class inventory verbs (OSC parity).

Usage:

orca placement resource-provider inventory class [OPTIONS] COMMAND [ARGS]...

Options:

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

# orca placement resource-provider inventory class inventory-set¶

Create or update a single inventory for a resource provider.

Usage:

orca placement resource-provider inventory class inventory-set 
    [OPTIONS] UUID RESOURCE_CLASS

Options:

Name	Type	Description	Default
`--total`	integer	Total inventory units.	`Sentinel.UNSET`
`--reserved`	integer	N/A	`0`
`--min-unit`	integer	N/A	`1`
`--max-unit`	integer	N/A	None
`--step-size`	integer	N/A	`1`
`--allocation-ratio`	float	N/A	`1.0`
`--help`	boolean	Show this message and exit.	`False`

orca placement resource-provider inventory inventory-delete¶

Delete an inventory for a resource provider.

Usage:

orca placement resource-provider inventory inventory-delete 
    [OPTIONS] UUID RESOURCE_CLASS

Options:

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

orca placement resource-provider inventory inventory-delete-all¶

Delete all inventories for a resource provider.

Usage:

orca placement resource-provider inventory inventory-delete-all 
    [OPTIONS] UUID

Options:

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

orca placement resource-provider inventory inventory-list¶

List inventories for a resource provider.

Usage:

orca placement resource-provider inventory inventory-list [OPTIONS] UUID

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 placement resource-provider inventory inventory-set¶

Create or update a single inventory for a resource provider.

Usage:

orca placement resource-provider inventory inventory-set [OPTIONS] UUID
                                                         RESOURCE_CLASS

Options:

Name	Type	Description	Default
`--total`	integer	Total inventory units.	`Sentinel.UNSET`
`--reserved`	integer	N/A	`0`
`--min-unit`	integer	N/A	`1`
`--max-unit`	integer	N/A	None
`--step-size`	integer	N/A	`1`
`--allocation-ratio`	float	N/A	`1.0`
`--help`	boolean	Show this message and exit.	`False`

orca placement resource-provider inventory inventory-show¶

Show a single inventory for a resource provider.

Usage:

orca placement resource-provider inventory inventory-show [OPTIONS] UUID
                                                          RESOURCE_CLASS

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 placement resource-provider inventory-delete¶

Delete an inventory for a resource provider.

Usage:

orca placement resource-provider inventory-delete [OPTIONS] UUID
                                                  RESOURCE_CLASS

Options:

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

orca placement resource-provider inventory-delete-all¶

Delete all inventories for a resource provider.

Usage:

orca placement resource-provider inventory-delete-all [OPTIONS] UUID

Options:

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

orca placement resource-provider inventory-list¶

List inventories for a resource provider.

Usage:

orca placement resource-provider inventory-list [OPTIONS] UUID

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 placement resource-provider inventory-set¶

Create or update a single inventory for a resource provider.

Usage:

orca placement resource-provider inventory-set [OPTIONS] UUID RESOURCE_CLASS

Options:

Name	Type	Description	Default
`--total`	integer	Total inventory units.	`Sentinel.UNSET`
`--reserved`	integer	N/A	`0`
`--min-unit`	integer	N/A	`1`
`--max-unit`	integer	N/A	None
`--step-size`	integer	N/A	`1`
`--allocation-ratio`	float	N/A	`1.0`
`--help`	boolean	Show this message and exit.	`False`

orca placement resource-provider inventory-show¶

Show a single inventory for a resource provider.

Usage:

orca placement resource-provider inventory-show [OPTIONS] UUID RESOURCE_CLASS

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 placement resource-provider list¶

List resource providers.

Usage:

orca placement resource-provider list [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Filter by name.	None
`--uuid`	text	Filter by UUID.	None
`--in-tree`	text	Limit to providers in this tree.	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 placement resource-provider set¶

Update a resource provider.

Usage:

orca placement resource-provider set [OPTIONS] UUID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--parent-uuid`	text	New parent provider UUID.	None
`--help`	boolean	Show this message and exit.	`False`

orca placement resource-provider show¶

Show a resource provider.

Usage:

orca placement resource-provider show [OPTIONS] UUID

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 placement resource-provider trait¶

Traits associated with a resource provider (OSC parity).

Usage:

orca placement resource-provider trait [OPTIONS] COMMAND [ARGS]...

Options:

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

orca placement resource-provider trait trait-delete¶

Remove all traits from a resource provider.

Usage:

orca placement resource-provider trait trait-delete [OPTIONS] UUID

Options:

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

orca placement resource-provider trait trait-list¶

List traits associated with a resource provider.

Usage:

orca placement resource-provider trait trait-list [OPTIONS] UUID

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 placement resource-provider trait trait-set¶

Set (replace) traits on a resource provider.

Usage:

orca placement resource-provider trait trait-set [OPTIONS] UUID TRAITS...

Options:

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

orca placement resource-provider trait-delete¶

Remove all traits from a resource provider.

Usage:

orca placement resource-provider trait-delete [OPTIONS] UUID

Options:

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

orca placement resource-provider trait-list¶

List traits associated with a resource provider.

Usage:

orca placement resource-provider trait-list [OPTIONS] UUID

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 placement resource-provider trait-set¶

Set (replace) traits on a resource provider.

Usage:

orca placement resource-provider trait-set [OPTIONS] UUID TRAITS...

Options:

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

orca placement resource-provider usage¶

Per-resource-provider usage (OSC parity).

Usage:

orca placement resource-provider usage [OPTIONS] COMMAND [ARGS]...

Options:

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

orca placement resource-provider usage usage¶

Show usages for a resource provider.

Usage:

orca placement resource-provider usage usage [OPTIONS] UUID

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 placement resource-provider-aggregate-delete¶

Remove all aggregate associations from a resource provider.

Usage:

orca placement resource-provider-aggregate-delete [OPTIONS] UUID

Options:

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

orca placement resource-provider-aggregate-list¶

List aggregates associated with a resource provider.

Usage:

orca placement resource-provider-aggregate-list [OPTIONS] UUID

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 placement resource-provider-aggregate-set¶

Set (replace) aggregates on a resource provider.

Usage:

orca placement resource-provider-aggregate-set [OPTIONS] UUID AGGREGATES...

Options:

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

orca placement resource-provider-create¶

Create a resource provider.

Usage:

orca placement resource-provider-create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--uuid`	text	Explicit UUID for the new provider.	None
`--parent-uuid`	text	UUID of the parent provider.	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 placement resource-provider-delete¶

Delete a resource provider.

Usage:

orca placement resource-provider-delete [OPTIONS] UUID

Options:

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

orca placement resource-provider-inventory-delete¶

Delete an inventory for a resource provider.

Usage:

orca placement resource-provider-inventory-delete [OPTIONS] UUID
                                                  RESOURCE_CLASS

Options:

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

orca placement resource-provider-inventory-delete-all¶

Delete all inventories for a resource provider.

Usage:

orca placement resource-provider-inventory-delete-all [OPTIONS] UUID

Options:

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

orca placement resource-provider-inventory-list¶

List inventories for a resource provider.

Usage:

orca placement resource-provider-inventory-list [OPTIONS] UUID

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 placement resource-provider-inventory-set¶

Create or update a single inventory for a resource provider.

Usage:

orca placement resource-provider-inventory-set [OPTIONS] UUID RESOURCE_CLASS

Options:

Name	Type	Description	Default
`--total`	integer	Total inventory units.	`Sentinel.UNSET`
`--reserved`	integer	N/A	`0`
`--min-unit`	integer	N/A	`1`
`--max-unit`	integer	N/A	None
`--step-size`	integer	N/A	`1`
`--allocation-ratio`	float	N/A	`1.0`
`--help`	boolean	Show this message and exit.	`False`

orca placement resource-provider-inventory-show¶

Show a single inventory for a resource provider.

Usage:

orca placement resource-provider-inventory-show [OPTIONS] UUID RESOURCE_CLASS

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 placement resource-provider-list¶

List resource providers.

Usage:

orca placement resource-provider-list [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Filter by name.	None
`--uuid`	text	Filter by UUID.	None
`--in-tree`	text	Limit to providers in this tree.	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 placement resource-provider-set¶

Update a resource provider.

Usage:

orca placement resource-provider-set [OPTIONS] UUID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--parent-uuid`	text	New parent provider UUID.	None
`--help`	boolean	Show this message and exit.	`False`

orca placement resource-provider-show¶

Show a resource provider.

Usage:

orca placement resource-provider-show [OPTIONS] UUID

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 placement resource-provider-trait-delete¶

Remove all traits from a resource provider.

Usage:

orca placement resource-provider-trait-delete [OPTIONS] UUID

Options:

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

orca placement resource-provider-trait-list¶

List traits associated with a resource provider.

Usage:

orca placement resource-provider-trait-list [OPTIONS] UUID

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 placement resource-provider-trait-set¶

Set (replace) traits on a resource provider.

Usage:

orca placement resource-provider-trait-set [OPTIONS] UUID TRAITS...

Options:

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

orca placement resource-provider-usage¶

Show usages for a resource provider.

Usage:

orca placement resource-provider-usage [OPTIONS] UUID

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 placement trait¶

Manage Placement traits.

Usage:

orca placement trait [OPTIONS] COMMAND [ARGS]...

Options:

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

orca placement trait create¶

Create a custom trait (must start with CUSTOM_).

Usage:

orca placement trait create [OPTIONS] NAME

Options:

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

orca placement trait delete¶

Delete a custom trait.

Usage:

orca placement trait delete [OPTIONS] NAME

Options:

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

orca placement trait list¶

List traits.

Usage:

orca placement trait list [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Filter traits by name prefix.	None
`--associated`	boolean	Only traits associated with a resource provider.	`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 placement trait show¶

Show a trait (existence check — Placement traits have no body).

Equivalent to openstack trait show. Raises OrcaCLIError if the trait does not exist.

Usage:

orca placement trait show [OPTIONS] NAME

Options:

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

orca placement trait-create¶

Create a custom trait (must start with CUSTOM_).

Usage:

orca placement trait-create [OPTIONS] NAME

Options:

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

orca placement trait-delete¶

Delete a custom trait.

Usage:

orca placement trait-delete [OPTIONS] NAME

Options:

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

orca placement trait-list¶

List traits.

Usage:

orca placement trait-list [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Filter traits by name prefix.	None
`--associated`	boolean	Only traits associated with a resource provider.	`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 placement usage¶

Inspect Placement usage.

Usage:

orca placement usage [OPTIONS] COMMAND [ARGS]...

Options:

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

orca placement usage list¶

Show aggregated usages by project/user.

Usage:

orca placement usage list [OPTIONS]

Options:

Name	Type	Description	Default
`--project-id`	text	Filter by project UUID.	None
`--user-id`	text	Filter by user UUID.	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 placement usage list¶

Show aggregated usages by project/user.

Usage:

orca placement usage list [OPTIONS]

Options:

Name	Type	Description	Default
`--project-id`	text	Filter by project UUID.	None
`--user-id`	text	Filter by user UUID.	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 placement usage-list¶

Show aggregated usages by project/user.

Usage:

orca placement usage-list [OPTIONS]

Options:

Name	Type	Description	Default
`--project-id`	text	Filter by project UUID.	None
`--user-id`	text	Filter by user UUID.	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 policy¶

Manage Keystone policies.

Usage:

orca policy [OPTIONS] COMMAND [ARGS]...

Options:

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

orca policy create¶

Create a policy.

Usage:

orca policy create [OPTIONS] BLOB

Options:

Name	Type	Description	Default
`--type`	text	MIME type of the policy blob.	`application/json`
`--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 policy delete¶

Delete a policy.

Usage:

orca policy delete [OPTIONS] POLICY_ID

Options:

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

orca policy list¶

List policies.

Usage:

orca policy list [OPTIONS]

Options:

Name	Type	Description	Default
`--type`	text	Filter by policy 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 policy set¶

Update a policy.

Usage:

orca policy set [OPTIONS] POLICY_ID

Options:

Name	Type	Description	Default
`--blob`	text	New policy blob.	None
`--type`	text	New MIME type.	None
`--help`	boolean	Show this message and exit.	`False`

orca policy show¶

Show a policy.

Usage:

orca policy show [OPTIONS] POLICY_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 port¶

Manage Neutron ports (alias of orca network port).

Usage:

orca port [OPTIONS] COMMAND [ARGS]...

Options:

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

orca port create¶

Create a port.

Usage:

orca port create [OPTIONS]

Options:

Name	Type	Description	Default
`--network-id`	text	Network ID.	`Sentinel.UNSET`
`--name`	text	Port name.	None
`--fixed-ip`	text	Fixed IP address.	None
`--help`	boolean	Show this message and exit.	`False`

orca port delete¶

Delete a port.

Usage:

orca port delete [OPTIONS] PORT_ID

Options:

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

orca port list¶

List ports.

Examples: orca network port list orca network port list --network-id orca network port list --subnet orca network port list --device-owner compute:nova

Usage:

orca port list [OPTIONS]

Options:

Name	Type	Description	Default
`--network-id`	text	Filter by network ID.	None
`--subnet-id`, `--subnet`	text	Filter to ports that have a fixed IP in this subnet.	None
`--device-owner`	text	Filter by device owner (e.g. `compute:nova`, `network:router_interface`, `network:dhcp`).	None
`--device-id`	text	Filter by the attached resource ID (server, router, ...).	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 port show¶

Show port details.

Usage:

orca port show [OPTIONS] PORT_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 port unset¶

Remove properties from a port.

Examples: orca network port-unset --security-group orca network port-unset --qos-policy orca network port-unset --description

Usage:

orca port unset [OPTIONS] PORT_ID

Options:

Name	Type	Description	Default
`--security-group`	text	Security group ID to remove (repeatable).	`Sentinel.UNSET`
`--qos-policy`	boolean	Remove the QoS policy from the port.	`False`
`--description`	boolean	Clear the port description.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca port update¶

Update a port.

Usage:

orca port update [OPTIONS] PORT_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--admin-state` / `--no-admin-state`	boolean	Admin state.	None
`--help`	boolean	Show this message and exit.	`False`

orca port update¶

Update a port.

Usage:

orca port update [OPTIONS] PORT_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--admin-state` / `--no-admin-state`	boolean	Admin state.	None
`--help`	boolean	Show this message and exit.	`False`

orca profile¶

Manage configuration profiles (multi-account).

Usage:

orca profile [OPTIONS] COMMAND [ARGS]...

Options:

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

orca profile add¶

Add a new profile interactively.

Examples: orca profile add production orca profile add staging --copy-from production --color yellow

Usage:

orca profile add [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--copy-from`	text	Copy settings from an existing profile.	None
`--color`	text	Profile color (e.g. red, green, blue, cyan, magenta, yellow).	None
`--help`	boolean	Show this message and exit.	`False`

orca profile color¶

Manage profile color.

Usage:

orca profile color [OPTIONS] COMMAND [ARGS]...

Options:

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

orca profile color set¶

Set a color for a profile. Use 'none' to remove.

Available colors: red, green, blue, yellow, magenta, cyan, white, bright_red, bright_green, bright_blue, bright_yellow, bright_magenta, bright_cyan, orange3, purple, pink1

Examples: orca profile color set red orca profile color set blue production orca profile color set none staging

Usage:

orca profile color set [OPTIONS] COLOR [NAME]

Options:

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

orca profile edit¶

Edit an existing profile interactively.

Usage:

orca profile edit [OPTIONS] [NAME]

Options:

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

orca profile export¶

Export profiles to external formats.

Usage:

orca profile export [OPTIONS] COMMAND [ARGS]...

Options:

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

orca profile export clouds¶

Export a profile as a clouds.yaml entry.

Examples: orca profile export clouds # active profile orca profile export clouds production # specific profile orca profile export clouds production -o clouds.yaml

Usage:

orca profile export clouds [OPTIONS] [NAME]

Options:

Name	Type	Description	Default
`--output`, `-o`	text	Write to file instead of stdout.	None
`--cloud-name`	text	Cloud name in clouds.yaml (default: profile name).	None
`--help`	boolean	Show this message and exit.	`False`

orca profile export openrc¶

Export a profile as an OpenRC shell script.

Examples: orca profile export openrc # active profile to stdout orca profile export openrc production # specific profile orca profile export openrc production -o prod-openrc.sh source <(orca profile export openrc) # source directly

Usage:

orca profile export openrc [OPTIONS] [NAME]

Options:

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

orca profile from-clouds¶

Import a cloud from clouds.yaml as an orca profile.

Examples: orca profile import clouds mycloud orca profile import clouds mycloud --name production orca profile import clouds mycloud -f /path/to/clouds.yaml

Usage:

orca profile from-clouds [OPTIONS] CLOUD_NAME

Options:

Name	Type	Description	Default
`--name`, `-n`	text	Profile name (default: cloud name).	None
`--file`, `-f`	text	Path to clouds.yaml (default: auto-detect).	None
`--help`	boolean	Show this message and exit.	`False`

orca profile from-openrc¶

Import an OpenRC file as an orca profile.

Examples: orca profile import openrc admin-openrc.sh orca profile import openrc admin-openrc.sh --name production

Usage:

orca profile from-openrc [OPTIONS] FILE

Options:

Name	Type	Description	Default
`--name`, `-n`	text	Profile name (default: filename without extension).	None
`--help`	boolean	Show this message and exit.	`False`

orca profile import¶

Import profiles from external sources.

Usage:

orca profile import [OPTIONS] COMMAND [ARGS]...

Options:

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

orca profile import clouds¶

Import a cloud from clouds.yaml as an orca profile.

Examples: orca profile import clouds mycloud orca profile import clouds mycloud --name production orca profile import clouds mycloud -f /path/to/clouds.yaml

Usage:

orca profile import clouds [OPTIONS] CLOUD_NAME

Options:

Name	Type	Description	Default
`--name`, `-n`	text	Profile name (default: cloud name).	None
`--file`, `-f`	text	Path to clouds.yaml (default: auto-detect).	None
`--help`	boolean	Show this message and exit.	`False`

orca profile import openrc¶

Import an OpenRC file as an orca profile.

Examples: orca profile import openrc admin-openrc.sh orca profile import openrc admin-openrc.sh --name production

Usage:

orca profile import openrc [OPTIONS] FILE

Options:

Name	Type	Description	Default
`--name`, `-n`	text	Profile name (default: filename without extension).	None
`--help`	boolean	Show this message and exit.	`False`

orca profile list¶

List all profiles.

Usage:

orca profile list [OPTIONS]

Options:

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

orca profile region¶

Manage profile region.

Usage:

orca profile region [OPTIONS] COMMAND [ARGS]...

Options:

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

orca profile region list¶

List available regions from the Keystone service catalog.

Authenticates with the current profile and inspects the catalog to show which regions are available.

Examples: orca profile region list orca -P infomaniak profile region list

Usage:

orca profile region list [OPTIONS]

Options:

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

orca profile region set¶

Set the default region for a profile.

Use 'none' to clear the region (use the first available).

Examples: orca profile region set dc3-a orca profile region set dc4-a production orca profile region set none # clear region

Usage:

orca profile region set [OPTIONS] REGION [NAME]

Options:

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

orca profile regions¶

List available regions from the Keystone service catalog.

Authenticates with the current profile and inspects the catalog to show which regions are available.

Examples: orca profile region list orca -P infomaniak profile region list

Usage:

orca profile regions [OPTIONS]

Options:

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

orca profile remove¶

Remove a profile.

Usage:

orca profile remove [OPTIONS] NAME

Options:

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

orca profile rename¶

Rename a profile.

Usage:

orca profile rename [OPTIONS] OLD_NAME NEW_NAME

Options:

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

orca profile set-color¶

Set a color for a profile. Use 'none' to remove.

Available colors: red, green, blue, yellow, magenta, cyan, white, bright_red, bright_green, bright_blue, bright_yellow, bright_magenta, bright_cyan, orange3, purple, pink1

Examples: orca profile color set red orca profile color set blue production orca profile color set none staging

Usage:

orca profile set-color [OPTIONS] COLOR [NAME]

Options:

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

orca profile set-region¶

Set the default region for a profile.

Use 'none' to clear the region (use the first available).

Examples: orca profile region set dc3-a orca profile region set dc4-a production orca profile region set none # clear region

Usage:

orca profile set-region [OPTIONS] REGION [NAME]

Options:

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

orca profile show¶

Show profile details. Defaults to active profile.

Usage:

orca profile show [OPTIONS] [NAME]

Options:

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

orca profile switch¶

Switch the active profile.

Without a NAME argument, shows an interactive numbered menu.

Examples: orca profile switch # interactive menu orca profile switch production orca profile switch staging

Usage:

orca profile switch [OPTIONS] [NAME]

Options:

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

orca profile to-clouds¶

Export a profile as a clouds.yaml entry.

Examples: orca profile export clouds # active profile orca profile export clouds production # specific profile orca profile export clouds production -o clouds.yaml

Usage:

orca profile to-clouds [OPTIONS] [NAME]

Options:

Name	Type	Description	Default
`--output`, `-o`	text	Write to file instead of stdout.	None
`--cloud-name`	text	Cloud name in clouds.yaml (default: profile name).	None
`--help`	boolean	Show this message and exit.	`False`

orca profile to-openrc¶

Export a profile as an OpenRC shell script.

Examples: orca profile export openrc # active profile to stdout orca profile export openrc production # specific profile orca profile export openrc production -o prod-openrc.sh source <(orca profile export openrc) # source directly

Usage:

orca profile to-openrc [OPTIONS] [NAME]

Options:

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

orca project¶

Manage projects (Keystone v3).

Usage:

orca project [OPTIONS] COMMAND [ARGS]...

Options:

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

orca project cleanup¶

Delete ALL resources in a project in dependency order.

Requires admin credentials when targeting a project other than the one used for authentication.

Deletion order (respects dependencies): stacks → load-balancers → servers → floating-ips → dns-zones → routers (interfaces detached first) → networks → security-groups → backups → volumes → snapshots → images → secrets → swift containers (objects deleted first)

Examples: orca project cleanup --dry-run orca project cleanup --project my-test-tenant --yes orca project cleanup --created-before 2024-01-01T00:00:00 --skip image orca project cleanup --skip stack --skip secret --yes

Usage:

orca project cleanup [OPTIONS]

Options:

Name	Type	Description	Default
`--project`	text	Project name or ID to clean up (default: current auth project).	None
`--dry-run`	boolean	List resources that would be deleted without deleting them.	`False`
`--yes`, `-y`	boolean	Skip confirmation prompt.	`False`
`--created-before`	text	Only delete resources created before this datetime (UTC).	None
`--skip`	choice (`stack` \| `loadbalancer` \| `server` \| `floating-ip` \| `dns-zone` \| `router` \| `network` \| `security-group` \| `backup` \| `volume` \| `snapshot` \| `image` \| `secret` \| `container`)	Resource type to skip (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca project create¶

Create a project.

Usage:

orca project create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--domain`	text	Domain ID.	None
`--description`	text	Description.	None
`--enable` / `--disable`	boolean	N/A	`True`
`--tag`	text	Tag (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca project delete¶

Delete a project.

Usage:

orca project delete [OPTIONS] PROJECT_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca project list¶

List projects.

Usage:

orca project list [OPTIONS]

Options:

Name	Type	Description	Default
`--domain`	text	Filter by domain ID.	None
`--user`	text	Filter by user ID.	None
`--enabled` / `--disabled`	boolean	Filter by enabled state.	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 project set¶

Update a project.

Usage:

orca project set [OPTIONS] PROJECT_ID

Options:

Name	Type	Description	Default
`--name`	text	N/A	None
`--description`	text	N/A	None
`--enable` / `--disable`	boolean	N/A	None
`--help`	boolean	Show this message and exit.	`False`

orca project show¶

Show project details.

Usage:

orca project show [OPTIONS] PROJECT_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 ptr¶

Floating-IP reverse-DNS (PTR) records.

Usage:

orca ptr [OPTIONS] COMMAND [ARGS]...

Options:

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

orca ptr record¶

Per-floating-IP PTR records.

Usage:

orca ptr record [OPTIONS] COMMAND [ARGS]...

Options:

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

orca ptr record list¶

List PTR records on all floating-IPs visible to the caller.

Usage:

orca ptr record 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 ptr record set¶

Set or update a PTR record on a floating-IP.

Usage:

orca ptr record set [OPTIONS] REGION:FIP_UUID

Options:

Name	Type	Description	Default
`--ptrdname`	text	Reverse DNS name.	`Sentinel.UNSET`
`--description`	text	N/A	None
`--ttl`	integer	TTL in seconds.	None
`--help`	boolean	Show this message and exit.	`False`

orca ptr record show¶

Show the PTR record of a floating-IP.

REGION:FIP_UUID — same format Designate accepts on /v2/reverse/floatingips/{region}:{uuid}.

Usage:

orca ptr record show [OPTIONS] REGION:FIP_UUID

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 ptr record unset¶

Clear the PTR record of a floating-IP.

Usage:

orca ptr record unset [OPTIONS] REGION:FIP_UUID

Options:

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

orca qos¶

Manage Neutron QoS policies and rules.

Usage:

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

Options:

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

orca qos policy¶

Manage QoS policies.

Usage:

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

Options:

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

orca qos policy create¶

Create a QoS policy.

Usage:

orca qos policy create [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Policy name.	`Sentinel.UNSET`
`--shared`	boolean	Share with all projects.	`False`
`--default`	boolean	Set as default policy.	`False`
`--description`	text	Description.	None
`--help`	boolean	Show this message and exit.	`False`

orca qos policy delete¶

Delete a QoS policy.

Usage:

orca qos policy delete [OPTIONS] POLICY_ID

Options:

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

orca qos policy list¶

List QoS policies.

Usage:

orca qos policy list [OPTIONS]

Options:

Name	Type	Description	Default
`--shared`	boolean	Show only shared policies.	`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 qos policy set¶

Update a QoS policy.

Usage:

orca qos policy set [OPTIONS] POLICY_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--shared` / `--no-shared`	boolean	Share or un-share.	None
`--default` / `--no-default`	boolean	Set or unset as default.	None
`--help`	boolean	Show this message and exit.	`False`

orca qos policy show¶

Show a QoS policy.

Usage:

orca qos policy show [OPTIONS] POLICY_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 qos policy-create¶

Create a QoS policy.

Usage:

orca qos policy-create [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Policy name.	`Sentinel.UNSET`
`--shared`	boolean	Share with all projects.	`False`
`--default`	boolean	Set as default policy.	`False`
`--description`	text	Description.	None
`--help`	boolean	Show this message and exit.	`False`

orca qos policy-delete¶

Delete a QoS policy.

Usage:

orca qos policy-delete [OPTIONS] POLICY_ID

Options:

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

orca qos policy-list¶

List QoS policies.

Usage:

orca qos policy-list [OPTIONS]

Options:

Name	Type	Description	Default
`--shared`	boolean	Show only shared policies.	`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 qos policy-set¶

Update a QoS policy.

Usage:

orca qos policy-set [OPTIONS] POLICY_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--shared` / `--no-shared`	boolean	Share or un-share.	None
`--default` / `--no-default`	boolean	Set or unset as default.	None
`--help`	boolean	Show this message and exit.	`False`

orca qos policy-show¶

Show a QoS policy.

Usage:

orca qos policy-show [OPTIONS] POLICY_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 qos rule¶

Manage QoS rules attached to a policy.

Usage:

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

Options:

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

orca qos rule create¶

Create a QoS rule.

Examples: orca qos rule-create --type bandwidth-limit --max-kbps 1000 orca qos rule-create --type dscp-marking --dscp-mark 14 orca qos rule-create --type minimum-bandwidth --min-kbps 500

Usage:

orca qos rule create [OPTIONS] POLICY_ID

Options:

Name	Type	Description	Default
`--type`	choice (`bandwidth-limit` \| `dscp-marking` \| `minimum-bandwidth` \| `minimum-packet-rate`)	Rule type.	`bandwidth-limit`
`--max-kbps`	integer	Maximum bandwidth in kbps (bandwidth-limit).	None
`--max-burst-kbps`	integer	Maximum burst bandwidth in kbps (bandwidth-limit).	None
`--direction`	choice (`ingress` \| `egress`)	Traffic direction (bandwidth-limit, minimum-bandwidth).	`egress`
`--dscp-mark`	integer	DSCP mark value 0-56 (dscp-marking).	None
`--min-kbps`	integer	Minimum bandwidth in kbps (minimum-bandwidth).	None
`--help`	boolean	Show this message and exit.	`False`

orca qos rule delete¶

Delete a QoS rule.

Usage:

orca qos rule delete [OPTIONS] POLICY_ID RULE_ID

Options:

Name	Type	Description	Default
`--type`	choice (`bandwidth-limit` \| `dscp-marking` \| `minimum-bandwidth` \| `minimum-packet-rate`)	Rule type.	`bandwidth-limit`
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca qos rule list¶

List QoS rules for a policy.

Usage:

orca qos rule list [OPTIONS] POLICY_ID

Options:

Name	Type	Description	Default
`--type`	choice (`bandwidth-limit` \| `dscp-marking` \| `minimum-bandwidth` \| `minimum-packet-rate`)	Rule type.	`bandwidth-limit`
`--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 qos rule set¶

Update an existing QoS rule.

Example: orca qos rule set --type bandwidth-limit --max-kbps 2000

Usage:

orca qos rule set [OPTIONS] POLICY_ID RULE_ID

Options:

Name	Type	Description	Default
`--type`	choice (`bandwidth-limit` \| `dscp-marking` \| `minimum-bandwidth` \| `minimum-packet-rate`)	Rule type.	`bandwidth-limit`
`--max-kbps`	integer	New max bandwidth in kbps (bandwidth-limit).	None
`--max-burst-kbps`	integer	New max burst bandwidth in kbps (bandwidth-limit).	None
`--direction`	choice (`ingress` \| `egress`)	New traffic direction (bandwidth-limit, minimum-bandwidth).	None
`--dscp-mark`	integer	New DSCP mark value (dscp-marking).	None
`--min-kbps`	integer	New min bandwidth in kbps (minimum-bandwidth).	None
`--help`	boolean	Show this message and exit.	`False`

orca qos rule show¶

Show details of a QoS rule.

Usage:

orca qos rule show [OPTIONS] POLICY_ID RULE_ID

Options:

Name	Type	Description	Default
`--type`	choice (`bandwidth-limit` \| `dscp-marking` \| `minimum-bandwidth` \| `minimum-packet-rate`)	Rule type.	`bandwidth-limit`
`--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 qos rule-create¶

Create a QoS rule.

Examples: orca qos rule-create --type bandwidth-limit --max-kbps 1000 orca qos rule-create --type dscp-marking --dscp-mark 14 orca qos rule-create --type minimum-bandwidth --min-kbps 500

Usage:

orca qos rule-create [OPTIONS] POLICY_ID

Options:

Name	Type	Description	Default
`--type`	choice (`bandwidth-limit` \| `dscp-marking` \| `minimum-bandwidth` \| `minimum-packet-rate`)	Rule type.	`bandwidth-limit`
`--max-kbps`	integer	Maximum bandwidth in kbps (bandwidth-limit).	None
`--max-burst-kbps`	integer	Maximum burst bandwidth in kbps (bandwidth-limit).	None
`--direction`	choice (`ingress` \| `egress`)	Traffic direction (bandwidth-limit, minimum-bandwidth).	`egress`
`--dscp-mark`	integer	DSCP mark value 0-56 (dscp-marking).	None
`--min-kbps`	integer	Minimum bandwidth in kbps (minimum-bandwidth).	None
`--help`	boolean	Show this message and exit.	`False`

orca qos rule-delete¶

Delete a QoS rule.

Usage:

orca qos rule-delete [OPTIONS] POLICY_ID RULE_ID

Options:

Name	Type	Description	Default
`--type`	choice (`bandwidth-limit` \| `dscp-marking` \| `minimum-bandwidth` \| `minimum-packet-rate`)	Rule type.	`bandwidth-limit`
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca qos rule-list¶

List QoS rules for a policy.

Usage:

orca qos rule-list [OPTIONS] POLICY_ID

Options:

Name	Type	Description	Default
`--type`	choice (`bandwidth-limit` \| `dscp-marking` \| `minimum-bandwidth` \| `minimum-packet-rate`)	Rule type.	`bandwidth-limit`
`--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 qos rule-type¶

Inspect QoS rule types Neutron knows how to enforce (read-only).

Usage:

orca qos rule-type [OPTIONS] COMMAND [ARGS]...

Options:

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

orca qos rule-type list¶

List supported QoS rule types.

Usage:

orca qos rule-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 qos rule-type show¶

Show the directions a QoS rule type supports.

Usage:

orca qos rule-type show [OPTIONS] RULE_TYPE

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 quota¶

Inspect project quotas across Nova, Neutron and Cinder.

With no sub-command, runs quota show for backward compatibility.

Usage:

orca quota [OPTIONS] COMMAND [ARGS]...

Options:

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

orca quota default¶

Show the cloud-wide default quotas (Nova + Cinder + Neutron).

Parity with openstack quota show --default — Nova and Cinder each expose a /os-quota-sets/<project>/defaults endpoint that returns the same values regardless of the project; Neutron uses /quotas/default.

Usage:

orca quota default [OPTIONS]

Options:

Name	Type	Description	Default
`--project`	text	Project ID (only used to look up defaults; Nova/Cinder return the same answer for any project).	`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 quota delete¶

Reset project quotas to the cloud defaults (admin).

Parity with openstack quota delete. With --service all (default) issues DELETE on Nova, Cinder and Neutron quota-sets for the project.

Usage:

orca quota delete [OPTIONS]

Options:

Name	Type	Description	Default
`--project`	text	Project ID (default: current project).	`Sentinel.UNSET`
`--service`	choice (`all` \| `compute` \| `volume` \| `network`)	Which service's quota to reset.	`all`
`--yes`	boolean	Skip the confirmation prompt.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca quota list¶

List projects with non-default quotas (admin).

Parity with openstack quota list — restricted to Neutron because Nova and Cinder do not expose a cross-project list endpoint.

Usage:

orca quota list [OPTIONS]

Options:

Name	Type	Description	Default
`--service`	choice (`network`)	Only Neutron exposes a list-all endpoint; Compute and Volume require a per-project fan-out (use `orca quota show --project <id>` instead).	`network`
`--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 quota set¶

Set quotas on Nova / Cinder / Neutron (admin).

Pass any combination of resource flags — only services with at least one flag receive a PUT. Use -1 for unlimited (Compute / Volume) or the explicit Neutron sentinel.

Examples: orca quota set --instances 50 --cores 100 orca quota set --project --volumes 20 --gigabytes 1000 orca quota set --networks 200 --routers 50

Usage:

orca quota set [OPTIONS]

Options:

Name	Type	Description	Default
`--project`	text	Project ID (default: current project).	`Sentinel.UNSET`
`--instances`	integer	Compute: max instances.	`Sentinel.UNSET`
`--cores`	integer	Compute: max vCPUs.	`Sentinel.UNSET`
`--ram`	integer	Compute: max RAM (MB).	`Sentinel.UNSET`
`--key-pairs`	integer	Compute: max key pairs.	`Sentinel.UNSET`
`--server-groups`	integer	Compute: max server groups.	`Sentinel.UNSET`
`--server-group-members`	integer	Compute: max members per server group.	`Sentinel.UNSET`
`--metadata-items`	integer	Compute: max metadata items per server.	`Sentinel.UNSET`
`--volumes`	integer	Volume: max volumes.	`Sentinel.UNSET`
`--snapshots`	integer	Volume: max snapshots.	`Sentinel.UNSET`
`--backups`	integer	Volume: max backups.	`Sentinel.UNSET`
`--gigabytes`	integer	Volume: total volume storage (GB).	`Sentinel.UNSET`
`--backup-gigabytes`	integer	Volume: total backup storage (GB).	`Sentinel.UNSET`
`--per-volume-gigabytes`	integer	Volume: max size per volume (GB).	`Sentinel.UNSET`
`--networks`	integer	Network: max networks.	`Sentinel.UNSET`
`--subnets`	integer	Network: max subnets.	`Sentinel.UNSET`
`--ports`	integer	Network: max ports.	`Sentinel.UNSET`
`--routers`	integer	Network: max routers.	`Sentinel.UNSET`
`--floating-ips`	integer	Network: max floating IPs.	`Sentinel.UNSET`
`--security-groups`	integer	Network: max security groups.	`Sentinel.UNSET`
`--security-group-rules`	integer	Network: max security-group rules.	`Sentinel.UNSET`
`--subnetpools`	integer	Network: max subnet pools.	`Sentinel.UNSET`
`--rbac-policies`	integer	Network: max RBAC policies.	`Sentinel.UNSET`
`--force`	boolean	Compute only: bypass the over-limit check on resources in use.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca quota show¶

Show project quotas — Nova, Neutron and Cinder usage vs limits.

Usage:

orca quota show [OPTIONS]

Options:

Name	Type	Description	Default
`--project`	text	Project ID (default: current project).	`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 rating¶

Manage CloudKitty rating.

Usage:

orca rating [OPTIONS] COMMAND [ARGS]...

Options:

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

orca rating dataframes¶

Show raw rated dataframes (historical cost records).

Falls back to v1 storage if the v2 endpoint is not exposed.

Usage:

orca rating dataframes [OPTIONS]

Options:

Name	Type	Description	Default
`--begin`	text	N/A	None
`--end`	text	N/A	None
`--limit`	integer	Max dataframes to return.	None
`--help`	boolean	Show this message and exit.	`False`

orca rating hashmap¶

Configure the HashMap rating module. Admin only.

Usage:

orca rating hashmap [OPTIONS] COMMAND [ARGS]...

Options:

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

orca rating hashmap field-create¶

Create a HashMap field under a service.

Usage:

orca rating hashmap field-create [OPTIONS] SERVICE_ID NAME

Options:

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

orca rating hashmap field-delete¶

Delete a HashMap field.

Usage:

orca rating hashmap field-delete [OPTIONS] FIELD_ID

Options:

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

orca rating hashmap field-list¶

List HashMap fields (metadata keys a service is rated on).

Usage:

orca rating hashmap field-list [OPTIONS]

Options:

Name	Type	Description	Default
`--service-id`	text	Filter fields by service ID.	`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 rating hashmap group-create¶

Create a HashMap group.

Usage:

orca rating hashmap group-create [OPTIONS] NAME

Options:

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

orca rating hashmap group-delete¶

Delete a HashMap group.

Usage:

orca rating hashmap group-delete [OPTIONS] GROUP_ID

Options:

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

orca rating hashmap group-list¶

List HashMap groups (shared metadata across mappings).

Usage:

orca rating hashmap 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 rating hashmap mapping-create¶

Create a HashMap mapping.

Examples: # Flat 0.05/hour for flavor m1.small: orca rating hashmap mapping-create --field-id --value m1.small --cost 0.05

# Service-level 0.10 multiplier: orca rating hashmap mapping-create --service-id --cost 1.10 --type rate

Usage:

orca rating hashmap mapping-create [OPTIONS]

Options:

Name	Type	Description	Default
`--field-id`	text	Field ID the mapping applies to. Required unless --service-id is given.	None
`--service-id`	text	Service ID for a service-level mapping (no field).	None
`--value`	text	Field value to match. Omit for service-level mappings.	None
`--cost`	text	Price (e.g. 0.05).	`Sentinel.UNSET`
`--type`	choice (`flat` \| `rate`)	flat = price per unit, rate = multiplier.	`flat`
`--group-id`	text	Group ID (HashMap group).	None
`--help`	boolean	Show this message and exit.	`False`

orca rating hashmap mapping-delete¶

Delete a HashMap mapping.

Usage:

orca rating hashmap mapping-delete [OPTIONS] MAPPING_ID

Options:

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

orca rating hashmap mapping-list¶

List HashMap mappings (value → price).

Usage:

orca rating hashmap mapping-list [OPTIONS]

Options:

Name	Type	Description	Default
`--service-id`	text	N/A	None
`--field-id`	text	N/A	None
`--group-id`	text	N/A	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 rating hashmap service-create¶

Create a HashMap service (one per rated metric).

Usage:

orca rating hashmap service-create [OPTIONS] NAME

Options:

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

orca rating hashmap service-delete¶

Delete a HashMap service.

Usage:

orca rating hashmap service-delete [OPTIONS] SERVICE_ID

Options:

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

orca rating hashmap service-list¶

List HashMap services (one per rated metric).

Usage:

orca rating hashmap service-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 rating hashmap threshold-create¶

Create a HashMap threshold.

Usage:

orca rating hashmap threshold-create [OPTIONS]

Options:

Name	Type	Description	Default
`--field-id`	text	N/A	None
`--service-id`	text	N/A	None
`--level`	text	Quantity level at which this tier starts.	`Sentinel.UNSET`
`--cost`	text	N/A	`Sentinel.UNSET`
`--type`	choice (`flat` \| `rate`)	N/A	`flat`
`--group-id`	text	N/A	None
`--help`	boolean	Show this message and exit.	`False`

orca rating hashmap threshold-delete¶

Delete a HashMap threshold.

Usage:

orca rating hashmap threshold-delete [OPTIONS] THRESHOLD_ID

Options:

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

orca rating hashmap threshold-list¶

List HashMap thresholds.

Usage:

orca rating hashmap threshold-list [OPTIONS]

Options:

Name	Type	Description	Default
`--service-id`	text	N/A	None
`--field-id`	text	N/A	None
`--group-id`	text	N/A	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 rating info¶

Show CloudKitty configuration (collector, metrics, fetcher).

Usage:

orca rating info [OPTIONS]

Options:

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

orca rating metric¶

Inspect CloudKitty metrics.

Usage:

orca rating metric [OPTIONS] COMMAND [ARGS]...

Options:

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

orca rating metric list¶

List metrics that CloudKitty is configured to rate.

Usage:

orca rating metric 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 rating metric show¶

Show collection details for a rated metric.

Usage:

orca rating metric show [OPTIONS] METRIC_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 rating metric-list¶

List metrics that CloudKitty is configured to rate.

Usage:

orca rating metric-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 rating metric-show¶

Show collection details for a rated metric.

Usage:

orca rating metric-show [OPTIONS] METRIC_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 rating module¶

Manage CloudKitty rating modules.

Usage:

orca rating module [OPTIONS] COMMAND [ARGS]...

Options:

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

orca rating module disable¶

Disable a rating module. Admin only.

Usage:

orca rating module disable [OPTIONS] MODULE_ID

Options:

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

orca rating module enable¶

Enable a rating module. Admin only.

Usage:

orca rating module enable [OPTIONS] MODULE_ID

Options:

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

orca rating module list¶

List rating modules (hashmap, pyscripts, noop, …). Admin only.

Usage:

orca rating module 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 rating module set-priority¶

Set module priority (higher runs first). Admin only.

Usage:

orca rating module set-priority [OPTIONS] MODULE_ID PRIORITY

Options:

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

orca rating module show¶

Show a rating module. Admin only.

Usage:

orca rating module show [OPTIONS] MODULE_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 rating module-disable¶

Disable a rating module. Admin only.

Usage:

orca rating module-disable [OPTIONS] MODULE_ID

Options:

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

orca rating module-enable¶

Enable a rating module. Admin only.

Usage:

orca rating module-enable [OPTIONS] MODULE_ID

Options:

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

orca rating module-list¶

List rating modules (hashmap, pyscripts, noop, …). Admin only.

Usage:

orca rating module-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 rating module-set-priority¶

Set module priority (higher runs first). Admin only.

Usage:

orca rating module-set-priority [OPTIONS] MODULE_ID PRIORITY

Options:

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

orca rating module-show¶

Show a rating module. Admin only.

Usage:

orca rating module-show [OPTIONS] MODULE_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 rating quote¶

Get a price estimate for a set of resources (pre-deployment).

Sends a quote request to CloudKitty's rating engine. The payload format mirrors a rated dataframe: each --resource is one line item (service + metadata + volume).

Example: orca rating quote --resource '{"service":"instance","desc":{"flavor_id":"2"},"volume":"1"}'

Usage:

orca rating quote [OPTIONS]

Options:

Name	Type	Description	Default
`--resource`	text	Resource JSON, e.g. '{"service":"instance","desc":{"flavor":"m1.small"},"volume":"1"}' (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca rating summary¶

Show rating summary (total cost per resource type / project / …).

Examples: orca rating summary orca rating summary --groupby type orca rating summary --begin 2026-01-01T00:00:00 --end 2026-02-01T00:00:00 --groupby project_id

Usage:

orca rating summary [OPTIONS]

Options:

Name	Type	Description	Default
`--begin`	text	Start of the rating window. Defaults to start of current month.	None
`--end`	text	End of the rating window. Defaults to now.	None
`--groupby`	text	Group results by field (repeatable). Common: type, project_id, user_id.	`Sentinel.UNSET`
`--filters`	text	Filter results (repeatable).	`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 recordset¶

Manage DNS recordsets (Designate).

Usage:

orca recordset [OPTIONS] COMMAND [ARGS]...

Options:

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

orca recordset create¶

Create a recordset in a zone.

Examples: orca recordset create example.com. www.example.com. --type A --record 1.2.3.4 orca recordset create example.com. example.com. --type MX --record "10 mail.example.com." orca recordset create example.com. example.com. --type A --record 1.2.3.4 --record 5.6.7.8

Usage:

orca recordset create [OPTIONS] ZONE NAME

Options:

Name	Type	Description	Default
`--type`	text	Record type (A, AAAA, CNAME, MX, TXT, …).	`Sentinel.UNSET`
`--record`	text	Record value (repeatable for multiple values).	`Sentinel.UNSET`
`--ttl`	integer	TTL in seconds.	None
`--description`	text	Recordset description.	None
`--help`	boolean	Show this message and exit.	`False`

orca recordset delete¶

Delete a recordset.

ZONE and RECORDSET can be IDs or names.

Usage:

orca recordset delete [OPTIONS] ZONE RECORDSET_ID

Options:

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

orca recordset list¶

List recordsets in a zone.

ZONE can be a zone ID or name.

Usage:

orca recordset list [OPTIONS] ZONE

Options:

Name	Type	Description	Default
`--type`	text	Filter by record type (A, AAAA, CNAME, MX, …).	None
`--name`	text	Filter by record name.	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 recordset set¶

Update a recordset in a zone.

ZONE and RECORDSET can be IDs or names. The --record option replaces all existing record values.

Usage:

orca recordset set [OPTIONS] ZONE RECORDSET_ID

Options:

Name	Type	Description	Default
`--record`	text	Record value (repeatable — replaces all existing values).	`Sentinel.UNSET`
`--ttl`	integer	TTL in seconds.	None
`--description`	text	Recordset description.	None
`--help`	boolean	Show this message and exit.	`False`

orca recordset show¶

Show recordset details.

ZONE and RECORDSET can be IDs or names.

Usage:

orca recordset show [OPTIONS] ZONE RECORDSET_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 region¶

Manage Keystone regions.

Usage:

orca region [OPTIONS] COMMAND [ARGS]...

Options:

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

orca region create¶

Create a region.

The ID is the region name (e.g. RegionOne, dc3-a).

Usage:

orca region create [OPTIONS] ID

Options:

Name	Type	Description	Default
`--description`	text	Region description.	None
`--parent`	text	Parent region ID.	None
`--help`	boolean	Show this message and exit.	`False`

orca region delete¶

Delete a region.

Usage:

orca region delete [OPTIONS] REGION_ID

Options:

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

orca region list¶

List regions.

Usage:

orca region list [OPTIONS]

Options:

Name	Type	Description	Default
`--parent`	text	Filter by parent region 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 region set¶

Update a region's description.

Usage:

orca region set [OPTIONS] REGION_ID

Options:

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

orca region show¶

Show region details.

Usage:

orca region show [OPTIONS] REGION_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 registered-limit¶

Manage Keystone registered limits (defaults per service/resource).

Usage:

orca registered-limit [OPTIONS] COMMAND [ARGS]...

Options:

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

orca registered-limit create¶

Create a registered limit.

Usage:

orca registered-limit create [OPTIONS]

Options:

Name	Type	Description	Default
`--service-id`	text	Service ID.	`Sentinel.UNSET`
`--resource-name`	text	Resource name (e.g. server).	`Sentinel.UNSET`
`--default-limit`	integer	Default limit value.	`Sentinel.UNSET`
`--region-id`	text	Region ID.	None
`--description`	text	Description.	``
`--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 registered-limit delete¶

Delete a registered limit.

Usage:

orca registered-limit delete [OPTIONS] REGISTERED_LIMIT_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca registered-limit list¶

List registered limits.

Usage:

orca registered-limit list [OPTIONS]

Options:

Name	Type	Description	Default
`--service-id`	text	Filter by service ID.	None
`--region-id`	text	Filter by region ID.	None
`--resource-name`	text	Filter by resource name.	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 registered-limit set¶

Update a registered limit.

Usage:

orca registered-limit set [OPTIONS] REGISTERED_LIMIT_ID

Options:

Name	Type	Description	Default
`--service-id`	text	N/A	None
`--resource-name`	text	N/A	None
`--default-limit`	integer	N/A	None
`--region-id`	text	N/A	None
`--description`	text	N/A	None
`--help`	boolean	Show this message and exit.	`False`

orca registered-limit show¶

Show a registered limit.

Usage:

orca registered-limit show [OPTIONS] REGISTERED_LIMIT_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 resource¶

Placement resources (class / provider / usage) — OSC parity.

Usage:

orca resource [OPTIONS] COMMAND [ARGS]...

Options:

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

orca resource resource-class¶

Manage Placement resource classes (compound noun).

Usage:

orca resource resource-class [OPTIONS] COMMAND [ARGS]...

Options:

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

orca resource resource-class create¶

Create a custom resource class (must start with CUSTOM_).

Usage:

orca resource resource-class create [OPTIONS] NAME

Options:

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

orca resource resource-class delete¶

Delete a custom resource class.

Usage:

orca resource resource-class delete [OPTIONS] NAME

Options:

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

orca resource resource-class list¶

List resource classes.

Usage:

orca resource resource-class 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 resource resource-class set¶

Rename a custom resource class (OSC parity).

Usage:

orca resource resource-class set [OPTIONS] CURRENT_NAME

Options:

Name	Type	Description	Default
`--name`	text	New resource class name (must start with CUSTOM_).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca resource resource-class show¶

Show a resource class.

Usage:

orca resource resource-class show [OPTIONS] NAME

Options:

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

orca resource resource-provider¶

Manage Placement resource providers (compound noun).

Usage:

orca resource resource-provider [OPTIONS] COMMAND [ARGS]...

Options:

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

orca resource resource-provider aggregate¶

Aggregate associations of a resource provider (OSC parity).

Usage:

orca resource resource-provider aggregate [OPTIONS] COMMAND [ARGS]...

Options:

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

orca resource resource-provider aggregate aggregate-delete¶

Remove all aggregate associations from a resource provider.

Usage:

orca resource resource-provider aggregate aggregate-delete 
    [OPTIONS] UUID

Options:

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

orca resource resource-provider aggregate aggregate-list¶

List aggregates associated with a resource provider.

Usage:

orca resource resource-provider aggregate aggregate-list [OPTIONS] UUID

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 resource resource-provider aggregate aggregate-set¶

Set (replace) aggregates on a resource provider.

Usage:

orca resource resource-provider aggregate aggregate-set [OPTIONS] UUID
                                                        AGGREGATES...

Options:

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

orca resource resource-provider aggregate-delete¶

Remove all aggregate associations from a resource provider.

Usage:

orca resource resource-provider aggregate-delete [OPTIONS] UUID

Options:

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

orca resource resource-provider aggregate-list¶

List aggregates associated with a resource provider.

Usage:

orca resource resource-provider aggregate-list [OPTIONS] UUID

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 resource resource-provider aggregate-set¶

Set (replace) aggregates on a resource provider.

Usage:

orca resource resource-provider aggregate-set [OPTIONS] UUID AGGREGATES...

Options:

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

orca resource resource-provider allocation¶

Allocations against a resource provider (OSC parity).

Usage:

orca resource resource-provider allocation [OPTIONS] COMMAND [ARGS]...

Options:

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

orca resource resource-provider allocation delete¶

Delete all allocations for a consumer.

Usage:

orca resource resource-provider allocation delete [OPTIONS] CONSUMER_UUID

Options:

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

orca resource resource-provider allocation set¶

Set (replace) allocations for a consumer against a single resource provider.

Usage:

orca resource resource-provider allocation set [OPTIONS] CONSUMER_UUID

Options:

Name	Type	Description	Default
`--resource-provider`	text	Resource provider UUID.	`Sentinel.UNSET`
`--resource`	text	Resource class and amount, e.g. VCPU=4. Repeatable.	`Sentinel.UNSET`
`--project-id`	text	Consumer project UUID.	`Sentinel.UNSET`
`--user-id`	text	Consumer user UUID.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca resource resource-provider allocation show¶

Show allocations for a consumer.

Usage:

orca resource resource-provider allocation show [OPTIONS] CONSUMER_UUID

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 resource resource-provider allocation unset¶

Drop a single resource-class allocation for a consumer.

Reads the consumer's full allocations, strips rc_name from each provider entry (optionally only on --rp-uuid), then PUTs the remaining allocations back. Empty entries are dropped.

Usage:

orca resource resource-provider allocation unset [OPTIONS] CONSUMER_UUID

Options:

Name	Type	Description	Default
`--resource-class`	text	Resource class to clear (e.g. VCPU, MEMORY_MB).	`Sentinel.UNSET`
`--rp-uuid`	text	Optional: limit to allocations on this resource provider (default: all providers).	None
`--help`	boolean	Show this message and exit.	`False`

orca resource resource-provider create¶

Create a resource provider.

Usage:

orca resource resource-provider create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--uuid`	text	Explicit UUID for the new provider.	None
`--parent-uuid`	text	UUID of the parent provider.	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 resource resource-provider delete¶

Delete a resource provider.

Usage:

orca resource resource-provider delete [OPTIONS] UUID

Options:

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

orca resource resource-provider inventory¶

Inventories of a resource provider (OSC parity).

Usage:

orca resource resource-provider inventory [OPTIONS] COMMAND [ARGS]...

Options:

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

orca resource resource-provider inventory class¶

Per-resource-class inventory verbs (OSC parity).

Usage:

orca resource resource-provider inventory class [OPTIONS] COMMAND [ARGS]...

Options:

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

# orca resource resource-provider inventory class inventory-set¶

Create or update a single inventory for a resource provider.

Usage:

orca resource resource-provider inventory class inventory-set 
    [OPTIONS] UUID RESOURCE_CLASS

Options:

Name	Type	Description	Default
`--total`	integer	Total inventory units.	`Sentinel.UNSET`
`--reserved`	integer	N/A	`0`
`--min-unit`	integer	N/A	`1`
`--max-unit`	integer	N/A	None
`--step-size`	integer	N/A	`1`
`--allocation-ratio`	float	N/A	`1.0`
`--help`	boolean	Show this message and exit.	`False`

orca resource resource-provider inventory inventory-delete¶

Delete an inventory for a resource provider.

Usage:

orca resource resource-provider inventory inventory-delete 
    [OPTIONS] UUID RESOURCE_CLASS

Options:

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

orca resource resource-provider inventory inventory-delete-all¶

Delete all inventories for a resource provider.

Usage:

orca resource resource-provider inventory inventory-delete-all 
    [OPTIONS] UUID

Options:

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

orca resource resource-provider inventory inventory-list¶

List inventories for a resource provider.

Usage:

orca resource resource-provider inventory inventory-list [OPTIONS] UUID

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 resource resource-provider inventory inventory-set¶

Create or update a single inventory for a resource provider.

Usage:

orca resource resource-provider inventory inventory-set [OPTIONS] UUID
                                                        RESOURCE_CLASS

Options:

Name	Type	Description	Default
`--total`	integer	Total inventory units.	`Sentinel.UNSET`
`--reserved`	integer	N/A	`0`
`--min-unit`	integer	N/A	`1`
`--max-unit`	integer	N/A	None
`--step-size`	integer	N/A	`1`
`--allocation-ratio`	float	N/A	`1.0`
`--help`	boolean	Show this message and exit.	`False`

orca resource resource-provider inventory inventory-show¶

Show a single inventory for a resource provider.

Usage:

orca resource resource-provider inventory inventory-show [OPTIONS] UUID
                                                         RESOURCE_CLASS

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 resource resource-provider inventory-delete¶

Delete an inventory for a resource provider.

Usage:

orca resource resource-provider inventory-delete [OPTIONS] UUID RESOURCE_CLASS

Options:

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

orca resource resource-provider inventory-delete-all¶

Delete all inventories for a resource provider.

Usage:

orca resource resource-provider inventory-delete-all [OPTIONS] UUID

Options:

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

orca resource resource-provider inventory-list¶

List inventories for a resource provider.

Usage:

orca resource resource-provider inventory-list [OPTIONS] UUID

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 resource resource-provider inventory-set¶

Create or update a single inventory for a resource provider.

Usage:

orca resource resource-provider inventory-set [OPTIONS] UUID RESOURCE_CLASS

Options:

Name	Type	Description	Default
`--total`	integer	Total inventory units.	`Sentinel.UNSET`
`--reserved`	integer	N/A	`0`
`--min-unit`	integer	N/A	`1`
`--max-unit`	integer	N/A	None
`--step-size`	integer	N/A	`1`
`--allocation-ratio`	float	N/A	`1.0`
`--help`	boolean	Show this message and exit.	`False`

orca resource resource-provider inventory-show¶

Show a single inventory for a resource provider.

Usage:

orca resource resource-provider inventory-show [OPTIONS] UUID RESOURCE_CLASS

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 resource resource-provider list¶

List resource providers.

Usage:

orca resource resource-provider list [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Filter by name.	None
`--uuid`	text	Filter by UUID.	None
`--in-tree`	text	Limit to providers in this tree.	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 resource resource-provider set¶

Update a resource provider.

Usage:

orca resource resource-provider set [OPTIONS] UUID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--parent-uuid`	text	New parent provider UUID.	None
`--help`	boolean	Show this message and exit.	`False`

orca resource resource-provider show¶

Show a resource provider.

Usage:

orca resource resource-provider show [OPTIONS] UUID

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 resource resource-provider trait¶

Traits associated with a resource provider (OSC parity).

Usage:

orca resource resource-provider trait [OPTIONS] COMMAND [ARGS]...

Options:

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

orca resource resource-provider trait trait-delete¶

Remove all traits from a resource provider.

Usage:

orca resource resource-provider trait trait-delete [OPTIONS] UUID

Options:

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

orca resource resource-provider trait trait-list¶

List traits associated with a resource provider.

Usage:

orca resource resource-provider trait trait-list [OPTIONS] UUID

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 resource resource-provider trait trait-set¶

Set (replace) traits on a resource provider.

Usage:

orca resource resource-provider trait trait-set [OPTIONS] UUID TRAITS...

Options:

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

orca resource resource-provider trait-delete¶

Remove all traits from a resource provider.

Usage:

orca resource resource-provider trait-delete [OPTIONS] UUID

Options:

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

orca resource resource-provider trait-list¶

List traits associated with a resource provider.

Usage:

orca resource resource-provider trait-list [OPTIONS] UUID

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 resource resource-provider trait-set¶

Set (replace) traits on a resource provider.

Usage:

orca resource resource-provider trait-set [OPTIONS] UUID TRAITS...

Options:

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

orca resource resource-provider usage¶

Per-resource-provider usage (OSC parity).

Usage:

orca resource resource-provider usage [OPTIONS] COMMAND [ARGS]...

Options:

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

orca resource resource-provider usage usage¶

Show usages for a resource provider.

Usage:

orca resource resource-provider usage usage [OPTIONS] UUID

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 resource usage¶

Inspect Placement usage.

Usage:

orca resource usage [OPTIONS] COMMAND [ARGS]...

Options:

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

orca resource usage list¶

Show aggregated usages by project/user.

Usage:

orca resource usage list [OPTIONS]

Options:

Name	Type	Description	Default
`--project-id`	text	Filter by project UUID.	None
`--user-id`	text	Filter by user UUID.	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 resource usage list¶

Show aggregated usages by project/user.

Usage:

orca resource usage list [OPTIONS]

Options:

Name	Type	Description	Default
`--project-id`	text	Filter by project UUID.	None
`--user-id`	text	Filter by user UUID.	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 role¶

Manage roles and assignments (Keystone v3).

Usage:

orca role [OPTIONS] COMMAND [ARGS]...

Options:

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

orca role add¶

Grant a role to a user or group on a project or domain.

Examples: orca role add --user --project orca role add --group --domain

Usage:

orca role add [OPTIONS] ROLE_ID

Options:

Name	Type	Description	Default
`--user`	text	User ID.	None
`--group`	text	Group ID.	None
`--project`	text	Project ID.	None
`--domain`	text	Domain ID.	None
`--help`	boolean	Show this message and exit.	`False`

orca role assignment¶

Inspect role assignments (user/group on project/domain).

Usage:

orca role assignment [OPTIONS] COMMAND [ARGS]...

Options:

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

orca role assignment list¶

List role assignments.

Usage:

orca role assignment list [OPTIONS]

Options:

Name	Type	Description	Default
`--user`	text	N/A	None
`--group`	text	N/A	None
`--project`	text	N/A	None
`--domain`	text	N/A	None
`--role`	text	N/A	None
`--effective`	boolean	Include inherited/effective assignments.	`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 role assignment-list¶

List role assignments.

Usage:

orca role assignment-list [OPTIONS]

Options:

Name	Type	Description	Default
`--user`	text	N/A	None
`--group`	text	N/A	None
`--project`	text	N/A	None
`--domain`	text	N/A	None
`--role`	text	N/A	None
`--effective`	boolean	Include inherited/effective assignments.	`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 role create¶

Create a role.

Usage:

orca role create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--description`	text	N/A	None
`--domain`	text	N/A	None
`--help`	boolean	Show this message and exit.	`False`

orca role delete¶

Delete a role.

Usage:

orca role delete [OPTIONS] ROLE_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca role implied¶

Manage role inference (one role implies another).

Usage:

orca role implied [OPTIONS] COMMAND [ARGS]...

Options:

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

orca role implied create¶

Create an implied role (prior implies implied).

Usage:

orca role implied create [OPTIONS] PRIOR_ROLE_ID IMPLIED_ROLE_ID

Options:

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

orca role implied delete¶

Delete an implied role relationship.

Usage:

orca role implied delete [OPTIONS] PRIOR_ROLE_ID IMPLIED_ROLE_ID

Options:

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

orca role implied list¶

List all implied role relationships.

Usage:

orca role implied 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 role implied-create¶

Create an implied role (prior implies implied).

Usage:

orca role implied-create [OPTIONS] PRIOR_ROLE_ID IMPLIED_ROLE_ID

Options:

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

orca role implied-delete¶

Delete an implied role relationship.

Usage:

orca role implied-delete [OPTIONS] PRIOR_ROLE_ID IMPLIED_ROLE_ID

Options:

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

orca role implied-list¶

List all implied role relationships.

Usage:

orca role implied-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 role list¶

List roles.

Usage:

orca role list [OPTIONS]

Options:

Name	Type	Description	Default
`--domain`	text	Filter by domain 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 role remove¶

Revoke a role from a user or group.

Usage:

orca role remove [OPTIONS] ROLE_ID

Options:

Name	Type	Description	Default
`--user`	text	User ID.	None
`--group`	text	Group ID.	None
`--project`	text	Project ID.	None
`--domain`	text	Domain ID.	None
`--help`	boolean	Show this message and exit.	`False`

orca role set¶

Set role properties (rename or update description).

Examples: orca role set --name new-name orca role set --description "My role"

Usage:

orca role set [OPTIONS] ROLE_ID

Options:

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

orca role show¶

Show role details.

Usage:

orca role show [OPTIONS] ROLE_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 router¶

Manage Neutron routers (alias of orca network router).

Usage:

orca router [OPTIONS] COMMAND [ARGS]...

Options:

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

orca router add¶

Attach a sub-resource to a router (interface, route).

Usage:

orca router add [OPTIONS] COMMAND [ARGS]...

Options:

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

orca router add gateway¶

Set an external gateway on a router (OSC router add gateway).

Usage:

orca router add gateway [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--network`	text	External network ID to use as gateway.	`Sentinel.UNSET`
`--fixed-ip`	text	Fixed IP on the external network (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca router add interface¶

Add a subnet interface to a router.

Usage:

orca router add interface [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--subnet-id`	text	Subnet to attach.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca router add port¶

Attach an existing port to a router (OSC router add port).

Usage:

orca router add port [OPTIONS] ROUTER_ID PORT_ID

Options:

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

orca router add route¶

Add a static route to a router (requires extraroute-atomic extension).

Example: orca network router-add-route --destination 10.1.0.0/24 --nexthop 192.168.1.1

Usage:

orca router add route [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--destination`	text	Destination network (e.g. 10.1.0.0/24).	`Sentinel.UNSET`
`--nexthop`	text	Next-hop IP address.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca router add subnet¶

Add a subnet to a router (OSC router add subnet).

Usage:

orca router add subnet [OPTIONS] ROUTER_ID SUBNET_ID

Options:

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

orca router create¶

Create a router.

Usage:

orca router create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--external-network`	text	External network ID for gateway.	None
`--help`	boolean	Show this message and exit.	`False`

orca router delete¶

Delete a router.

Usage:

orca router delete [OPTIONS] ROUTER_ID

Options:

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

orca router list¶

List routers.

Usage:

orca router 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 router ndp-proxy¶

Manage IPv6 NDP proxies on a router.

Usage:

orca router ndp-proxy [OPTIONS] COMMAND [ARGS]...

Options:

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

orca router ndp-proxy create¶

Create an NDP proxy.

Usage:

orca router ndp-proxy create [OPTIONS]

Options:

Name	Type	Description	Default
`--router-id`	text	N/A	`Sentinel.UNSET`
`--port-id`	text	N/A	`Sentinel.UNSET`
`--ip-address`	text	Specific IPv6 address (autopicked if omitted).	None
`--help`	boolean	Show this message and exit.	`False`

orca router ndp-proxy delete¶

Delete an NDP proxy.

Usage:

orca router ndp-proxy delete [OPTIONS] NDP_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca router ndp-proxy list¶

List NDP proxies.

Usage:

orca router ndp-proxy list [OPTIONS]

Options:

Name	Type	Description	Default
`--router-id`	text	Filter by router.	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 router ndp-proxy set¶

Update an NDP proxy.

Usage:

orca router ndp-proxy set [OPTIONS] NDP_ID

Options:

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

orca router ndp-proxy show¶

Show an NDP proxy.

Usage:

orca router ndp-proxy show [OPTIONS] NDP_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 router remove¶

Detach a sub-resource from a router.

Usage:

orca router remove [OPTIONS] COMMAND [ARGS]...

Options:

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

orca router remove gateway¶

Clear a router's external gateway (OSC router remove gateway).

Usage:

orca router remove gateway [OPTIONS] ROUTER_ID

Options:

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

orca router remove interface¶

Remove a subnet interface from a router.

Usage:

orca router remove interface [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--subnet-id`	text	Subnet to detach.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca router remove port¶

Detach a port from a router (OSC router remove port).

Usage:

orca router remove port [OPTIONS] ROUTER_ID PORT_ID

Options:

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

orca router remove route¶

Remove a static route from a router (requires extraroute-atomic extension).

Example: orca network router-remove-route --destination 10.1.0.0/24 --nexthop 192.168.1.1

Usage:

orca router remove route [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--destination`	text	Destination network to remove.	`Sentinel.UNSET`
`--nexthop`	text	Next-hop IP address.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca router remove subnet¶

Remove a subnet from a router (OSC router remove subnet).

Usage:

orca router remove subnet [OPTIONS] ROUTER_ID SUBNET_ID

Options:

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

orca router show¶

Show router details.

Usage:

orca router show [OPTIONS] ROUTER_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 router update¶

Update a router.

Usage:

orca router update [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--external-network`	text	New external gateway network ID.	None
`--help`	boolean	Show this message and exit.	`False`

orca router update¶

Update a router.

Usage:

orca router update [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--external-network`	text	New external gateway network ID.	None
`--help`	boolean	Show this message and exit.	`False`

orca router update¶

Update a router.

Usage:

orca router update [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--external-network`	text	New external gateway network ID.	None
`--help`	boolean	Show this message and exit.	`False`

orca secret¶

Manage secrets & containers (Barbican key-manager).

Usage:

orca secret [OPTIONS] COMMAND [ARGS]...

Options:

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

orca secret acl¶

Manage per-secret ACLs (read access).

Usage:

orca secret acl [OPTIONS] COMMAND [ARGS]...

Options:

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

orca secret acl delete¶

Delete the ACL on a secret (revert to project-wide access).

Usage:

orca secret acl delete [OPTIONS] SECRET_ID

Options:

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

orca secret acl get¶

Get the ACL for a secret.

Usage:

orca secret acl get [OPTIONS] SECRET_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 secret acl set¶

Set the ACL on a secret.

Usage:

orca secret acl set [OPTIONS] SECRET_ID

Options:

Name	Type	Description	Default
`--user`	text	User ID to grant read access to (repeatable).	`Sentinel.UNSET`
`--project-access` / `--no-project-access`	boolean	Allow all project users read access.	`True`
`--help`	boolean	Show this message and exit.	`False`

orca secret acl set¶

Set the ACL on a secret.

Usage:

orca secret acl set [OPTIONS] SECRET_ID

Options:

Name	Type	Description	Default
`--user`	text	User ID to grant read access to (repeatable).	`Sentinel.UNSET`
`--project-access` / `--no-project-access`	boolean	Allow all project users read access.	`True`
`--help`	boolean	Show this message and exit.	`False`

orca secret acl user¶

Per-user ACL operations on a secret.

Usage:

orca secret acl user [OPTIONS] COMMAND [ARGS]...

Options:

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

orca secret acl user add¶

Add users to a secret's read ACL.

Usage:

orca secret acl user add [OPTIONS] SECRET_ID

Options:

Name	Type	Description	Default
`--user`	text	User ID to grant read access (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca secret acl user remove¶

Remove users from a secret's read ACL.

Usage:

orca secret acl user remove [OPTIONS] SECRET_ID

Options:

Name	Type	Description	Default
`--user`	text	User ID to revoke read access from (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca secret acl-delete¶

Delete the ACL on a secret (revert to project-wide access).

Usage:

orca secret acl-delete [OPTIONS] SECRET_ID

Options:

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

orca secret acl-get¶

Get the ACL for a secret.

Usage:

orca secret acl-get [OPTIONS] SECRET_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 secret acl-set¶

Set the ACL on a secret.

Usage:

orca secret acl-set [OPTIONS] SECRET_ID

Options:

Name	Type	Description	Default
`--user`	text	User ID to grant read access to (repeatable).	`Sentinel.UNSET`
`--project-access` / `--no-project-access`	boolean	Allow all project users read access.	`True`
`--help`	boolean	Show this message and exit.	`False`

orca secret consumer¶

Manage consumers registered on Barbican containers.

Usage:

orca secret consumer [OPTIONS] COMMAND [ARGS]...

Options:

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

orca secret consumer create¶

Register a consumer on a container.

Usage:

orca secret consumer create [OPTIONS] CONTAINER_ID

Options:

Name	Type	Description	Default
`--name`	text	Consumer name (free-form).	`Sentinel.UNSET`
`--url`	text	Consumer URL (e.g. the resource that uses the secret).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca secret consumer delete¶

Remove a consumer from a container.

Usage:

orca secret consumer delete [OPTIONS] CONTAINER_ID

Options:

Name	Type	Description	Default
`--name`	text	Consumer name to remove.	`Sentinel.UNSET`
`--url`	text	Consumer URL to remove.	`Sentinel.UNSET`
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca secret consumer list¶

List consumers registered on a container.

Usage:

orca secret consumer list [OPTIONS] CONTAINER_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 secret container¶

Manage Barbican secret containers.

Usage:

orca secret container [OPTIONS] COMMAND [ARGS]...

Options:

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

orca secret container container-create¶

Create a secret container.

Example: orca secret container-create --name my-cert --type certificate \ --secret certificate= \ --secret private_key=

Usage:

orca secret container container-create [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Container name.	None
`--type`	choice (`generic` \| `rsa` \| `certificate`)	Container type.	`generic`
`--secret`	text	Secret reference (repeatable): name=.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca secret container container-delete¶

Delete a secret container.

Usage:

orca secret container container-delete [OPTIONS] CONTAINER_ID

Options:

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

orca secret container container-list¶

List secret containers.

Usage:

orca secret container container-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 secret container container-show¶

Show secret container details.

Usage:

orca secret container container-show [OPTIONS] CONTAINER_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 secret container container-show¶

Show secret container details.

Usage:

orca secret container container-show [OPTIONS] CONTAINER_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 secret container-create¶

Create a secret container.

Example: orca secret container-create --name my-cert --type certificate \ --secret certificate= \ --secret private_key=

Usage:

orca secret container-create [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Container name.	None
`--type`	choice (`generic` \| `rsa` \| `certificate`)	Container type.	`generic`
`--secret`	text	Secret reference (repeatable): name=.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca secret container-delete¶

Delete a secret container.

Usage:

orca secret container-delete [OPTIONS] CONTAINER_ID

Options:

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

orca secret container-list¶

List secret containers.

Usage:

orca secret container-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 secret container-show¶

Show secret container details.

Usage:

orca secret container-show [OPTIONS] CONTAINER_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 secret create¶

Create a secret.

Examples: orca secret create my-password --payload "s3cret" --secret-type passphrase orca secret create my-key --algorithm AES --bit-length 256 --secret-type symmetric

Usage:

orca secret create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--payload`	text	Secret payload (inline).	None
`--payload-content-type`	text	MIME type of payload.	`text/plain`
`--secret-type`	choice (`symmetric` \| `public` \| `private` \| `passphrase` \| `certificate` \| `opaque`)	N/A	`opaque`
`--algorithm`	text	Algorithm (e.g. AES, RSA).	None
`--bit-length`	integer	Bit length.	None
`--expiration`	text	Expiration datetime (ISO 8601).	None
`--help`	boolean	Show this message and exit.	`False`

orca secret delete¶

Delete a secret.

Usage:

orca secret delete [OPTIONS] SECRET_ID

Options:

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

orca secret get-payload¶

Retrieve secret payload.

Usage:

orca secret get-payload [OPTIONS] SECRET_ID

Options:

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

orca secret list¶

List secrets.

Usage:

orca secret list [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	integer	Max results.	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 secret order¶

Manage Barbican key/certificate orders.

Usage:

orca secret order [OPTIONS] COMMAND [ARGS]...

Options:

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

orca secret order order-create¶

Create a secret order (async key/certificate generation).

Examples: orca secret order-create --type key --algorithm aes --bit-length 256 orca secret order-create --type asymmetric --algorithm rsa --bit-length 2048

Usage:

orca secret order order-create [OPTIONS]

Options:

Name	Type	Description	Default
`--type`	choice (`key` \| `asymmetric` \| `certificate`)	Order type.	`Sentinel.UNSET`
`--name`	text	Secret name for the resulting secret.	None
`--algorithm`	text	Key algorithm (e.g. aes, rsa).	None
`--bit-length`	integer	Key bit length.	None
`--mode`	text	Encryption mode (e.g. cbc).	None
`--help`	boolean	Show this message and exit.	`False`

orca secret order order-delete¶

Delete a secret order.

Usage:

orca secret order order-delete [OPTIONS] ORDER_ID

Options:

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

orca secret order order-list¶

List secret orders.

Usage:

orca secret order order-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 secret order order-show¶

Show an order's details.

Usage:

orca secret order order-show [OPTIONS] ORDER_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 secret order order-show¶

Show an order's details.

Usage:

orca secret order order-show [OPTIONS] ORDER_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 secret order-create¶

Create a secret order (async key/certificate generation).

Examples: orca secret order-create --type key --algorithm aes --bit-length 256 orca secret order-create --type asymmetric --algorithm rsa --bit-length 2048

Usage:

orca secret order-create [OPTIONS]

Options:

Name	Type	Description	Default
`--type`	choice (`key` \| `asymmetric` \| `certificate`)	Order type.	`Sentinel.UNSET`
`--name`	text	Secret name for the resulting secret.	None
`--algorithm`	text	Key algorithm (e.g. aes, rsa).	None
`--bit-length`	integer	Key bit length.	None
`--mode`	text	Encryption mode (e.g. cbc).	None
`--help`	boolean	Show this message and exit.	`False`

orca secret order-delete¶

Delete a secret order.

Usage:

orca secret order-delete [OPTIONS] ORDER_ID

Options:

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

orca secret order-list¶

List secret orders.

Usage:

orca secret order-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 secret order-show¶

Show an order's details.

Usage:

orca secret order-show [OPTIONS] ORDER_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 secret show¶

Show secret metadata.

Usage:

orca secret show [OPTIONS] SECRET_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 secret show¶

Show secret metadata.

Usage:

orca secret show [OPTIONS] SECRET_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 secret store¶

Upload payload data to an existing metadata-only secret.

Usage:

orca secret store [OPTIONS] SECRET_ID

Options:

Name	Type	Description	Default
`--payload`	text	Inline payload (use --payload-file for binary).	`Sentinel.UNSET`
`--payload-file`	file	File containing the payload (binary safe).	`Sentinel.UNSET`
`--content-type`	text	Payload MIME type.	`application/octet-stream`
`--content-encoding`	text	Payload encoding (e.g. base64 for binary inside text).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca secret store¶

Upload payload data to an existing metadata-only secret.

Usage:

orca secret store [OPTIONS] SECRET_ID

Options:

Name	Type	Description	Default
`--payload`	text	Inline payload (use --payload-file for binary).	`Sentinel.UNSET`
`--payload-file`	file	File containing the payload (binary safe).	`Sentinel.UNSET`
`--content-type`	text	Payload MIME type.	`application/octet-stream`
`--content-encoding`	text	Payload encoding (e.g. base64 for binary inside text).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca security-group¶

Manage security groups.

Usage:

orca security-group [OPTIONS] COMMAND [ARGS]...

Options:

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

orca security-group cleanup¶

Find security groups not attached to any port.

Lists orphaned SGs that are likely leftovers from tests or deleted instances. Use --delete to remove them.

The 'default' security group is always skipped.

Examples: orca security-group cleanup # dry run orca security-group cleanup --delete # interactive delete orca security-group cleanup --delete -y # auto-delete all

Usage:

orca security-group cleanup [OPTIONS]

Options:

Name	Type	Description	Default
`--delete`, `-d`	boolean	Actually delete the unused security groups.	`False`
`--yes`, `-y`	boolean	Skip confirmation (with --delete).	`False`
`--help`	boolean	Show this message and exit.	`False`

orca security-group clone¶

Clone a security group (copy all rules to a new group).

Examples: orca security-group clone my-new-sg orca security-group clone prod-sg --description "Production rules"

Usage:

orca security-group clone [OPTIONS] SOURCE_ID NEW_NAME

Options:

Name	Type	Description	Default
`--description`	text	Description for the new group.	None
`--help`	boolean	Show this message and exit.	`False`

orca security-group create¶

Create a security group.

Usage:

orca security-group create [OPTIONS] NAME

Options:

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

orca security-group delete¶

Delete a security group.

Usage:

orca security-group delete [OPTIONS] GROUP_ID

Options:

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

orca security-group list¶

List security groups.

Usage:

orca security-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 security-group rule¶

Manage security group rules.

Usage:

orca security-group rule [OPTIONS] COMMAND [ARGS]...

Options:

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

orca security-group rule add¶

Add a rule to a security group.

Examples: orca security-group rule-add --direction ingress --protocol tcp --port-min 22 orca security-group rule-add --direction ingress --protocol tcp --port-min 80 --port-max 443 --remote-ip 0.0.0.0/0

Usage:

orca security-group rule add [OPTIONS] GROUP_ID

Options:

Name	Type	Description	Default
`--direction`	choice (`ingress` \| `egress`)	N/A	`Sentinel.UNSET`
`--protocol`	text	Protocol (tcp, udp, icmp, or number).	None
`--port-min`	integer	Min port (or single port).	None
`--port-max`	integer	Max port. Defaults to port-min.	None
`--remote-ip`	text	Remote IP prefix (CIDR).	None
`--remote-group`	text	Remote security group ID.	None
`--ethertype`	choice (`IPv4` \| `IPv6`)	N/A	`IPv4`
`--help`	boolean	Show this message and exit.	`False`

orca security-group rule add¶

Add a rule to a security group.

Examples: orca security-group rule-add --direction ingress --protocol tcp --port-min 22 orca security-group rule-add --direction ingress --protocol tcp --port-min 80 --port-max 443 --remote-ip 0.0.0.0/0

Usage:

orca security-group rule add [OPTIONS] GROUP_ID

Options:

Name	Type	Description	Default
`--direction`	choice (`ingress` \| `egress`)	N/A	`Sentinel.UNSET`
`--protocol`	text	Protocol (tcp, udp, icmp, or number).	None
`--port-min`	integer	Min port (or single port).	None
`--port-max`	integer	Max port. Defaults to port-min.	None
`--remote-ip`	text	Remote IP prefix (CIDR).	None
`--remote-group`	text	Remote security group ID.	None
`--ethertype`	choice (`IPv4` \| `IPv6`)	N/A	`IPv4`
`--help`	boolean	Show this message and exit.	`False`

orca security-group rule delete¶

Delete a security group rule.

Usage:

orca security-group rule delete [OPTIONS] RULE_ID

Options:

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

orca security-group rule list¶

List security group rules (across all groups, or filtered).

Examples: orca security-group rule list orca security-group rule list --group-id orca security-group rule list --direction ingress --protocol tcp

Usage:

orca security-group rule list [OPTIONS]

Options:

Name	Type	Description	Default
`--group-id`	text	Filter rules to a single security group.	None
`--direction`	choice (`ingress` \| `egress`)	Filter by direction.	None
`--protocol`	text	Filter by protocol.	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 security-group rule show¶

Show a security group rule's details.

Usage:

orca security-group rule show [OPTIONS] RULE_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 security-group rule-add¶

Add a rule to a security group.

Examples: orca security-group rule-add --direction ingress --protocol tcp --port-min 22 orca security-group rule-add --direction ingress --protocol tcp --port-min 80 --port-max 443 --remote-ip 0.0.0.0/0

Usage:

orca security-group rule-add [OPTIONS] GROUP_ID

Options:

Name	Type	Description	Default
`--direction`	choice (`ingress` \| `egress`)	N/A	`Sentinel.UNSET`
`--protocol`	text	Protocol (tcp, udp, icmp, or number).	None
`--port-min`	integer	Min port (or single port).	None
`--port-max`	integer	Max port. Defaults to port-min.	None
`--remote-ip`	text	Remote IP prefix (CIDR).	None
`--remote-group`	text	Remote security group ID.	None
`--ethertype`	choice (`IPv4` \| `IPv6`)	N/A	`IPv4`
`--help`	boolean	Show this message and exit.	`False`

orca security-group rule-delete¶

Delete a security group rule.

Usage:

orca security-group rule-delete [OPTIONS] RULE_ID

Options:

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

orca security-group show¶

Show security group details and rules.

Usage:

orca security-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 security-group update¶

Update a security group.

Usage:

orca security-group update [OPTIONS] GROUP_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 security-group update¶

Update a security group.

Usage:

orca security-group update [OPTIONS] GROUP_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 security-group update¶

Update a security group.

Usage:

orca security-group update [OPTIONS] GROUP_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 server¶

Manage compute servers.

Usage:

orca server [OPTIONS] COMMAND [ARGS]...

Options:

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

orca server add¶

Attach a sub-resource to a server (volume, port, network, ...).

Usage:

orca server add [OPTIONS] COMMAND [ARGS]...

Options:

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

orca server add fixed-ip¶

Add a fixed IP from a network to a server.

Example: orca server add-fixed-ip

Usage:

orca server add fixed-ip [OPTIONS] SERVER_ID NETWORK_ID

Options:

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

orca server add floating-ip¶

Associate a floating IP with a server (OSC parity).

IP_ADDRESS may be either the floating IP itself (e.g. 172.24.4.10) or its ID.

Examples: orca server add floating-ip 172.24.4.10 orca server add floating-ip 172.24.4.10 --fixed-ip-address 10.0.0.5

Usage:

orca server add floating-ip [OPTIONS] SERVER_ID IP_ADDRESS

Options:

Name	Type	Description	Default
`--fixed-ip-address`	text	Bind the FIP to a specific fixed IP of the server (otherwise the first port is chosen).	None
`--help`	boolean	Show this message and exit.	`False`

orca server add network¶

Attach a network to a server (creates a new port automatically).

Examples: orca server add network orca server add network --fixed-ip 10.0.0.5

Usage:

orca server add network [OPTIONS] SERVER_ID NETWORK_ID

Options:

Name	Type	Description	Default
`--fixed-ip`	text	Pin the new port to a specific fixed IP on the network.	None
`--help`	boolean	Show this message and exit.	`False`

orca server add port¶

Attach an existing Neutron port to a server.

Example: orca server add-port

Usage:

orca server add port [OPTIONS] SERVER_ID PORT_ID

Options:

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

orca server add security-group¶

Add a security group to a running server.

Usage:

orca server add security-group [OPTIONS] SERVER_ID SECURITY_GROUP

Options:

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

orca server add volume¶

Attach a volume to a server.

Examples: orca server attach-volume orca server attach-volume --device /dev/vdc

Usage:

orca server add volume [OPTIONS] SERVER_ID VOLUME_ID

Options:

Name	Type	Description	Default
`--device`	text	Device name (e.g. /dev/vdb). Auto-assigned if omitted.	None
`--help`	boolean	Show this message and exit.	`False`

orca server add-fixed-ip¶

Add a fixed IP from a network to a server.

Example: orca server add-fixed-ip

Usage:

orca server add-fixed-ip [OPTIONS] SERVER_ID NETWORK_ID

Options:

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

orca server add-network¶

Attach a network to a server (creates a new port automatically).

Examples: orca server add network orca server add network --fixed-ip 10.0.0.5

Usage:

orca server add-network [OPTIONS] SERVER_ID NETWORK_ID

Options:

Name	Type	Description	Default
`--fixed-ip`	text	Pin the new port to a specific fixed IP on the network.	None
`--help`	boolean	Show this message and exit.	`False`

orca server add-port¶

Attach an existing Neutron port to a server.

Example: orca server add-port

Usage:

orca server add-port [OPTIONS] SERVER_ID PORT_ID

Options:

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

orca server add-security-group¶

Add a security group to a running server.

Usage:

orca server add-security-group [OPTIONS] SERVER_ID SECURITY_GROUP

Options:

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

orca server attach-interface¶

Attach a network interface to a server (deprecated façade).

Use one of these instead, depending on what you have: orca server add port orca server add network [--fixed-ip ]

Usage:

orca server attach-interface [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--port-id`	text	Existing port ID to attach.	None
`--net-id`	text	Network ID (creates a new port automatically).	None
`--fixed-ip`	text	Fixed IP for the new port (requires --net-id).	None
`--help`	boolean	Show this message and exit.	`False`

orca server attach-volume¶

Attach a volume to a server.

Examples: orca server attach-volume orca server attach-volume --device /dev/vdc

Usage:

orca server attach-volume [OPTIONS] SERVER_ID VOLUME_ID

Options:

Name	Type	Description	Default
`--device`	text	Device name (e.g. /dev/vdb). Auto-assigned if omitted.	None
`--help`	boolean	Show this message and exit.	`False`

orca server backup¶

Create a Nova-managed backup image with rotation.

Unlike orca server snapshot / server image create (one-shot snapshot), this triggers Nova's createBackup action which tags the produced image with the backup type and keeps only the rotation most recent images of that type.

Examples: orca server backup --name nightly --rotation 7 orca server backup --name weekly --type weekly --rotation 4

Usage:

orca server backup [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--name`	text	Backup image name.	`Sentinel.UNSET`
`--type`	text	Backup type tag (e.g. `daily`, `weekly`). Nova rotates backups per type independently.	`daily`
`--rotation`	integer	Keep at most this many backups of the same type — Nova deletes the oldest beyond it.	`7`
`--property`	text	Image metadata (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca server backup_group¶

OSC-style server backup sub-group (Nova createBackup).

Usage:

orca server backup_group [OPTIONS] COMMAND [ARGS]...

Options:

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

orca server bulk¶

Perform an action on multiple servers at once.

Examples: orca server bulk stop --name "dev-" orca server bulk delete --status ERROR --yes orca server bulk reboot --name "web-" --status ACTIVE

Usage:

orca server bulk [OPTIONS] {start|stop|reboot|delete}

Options:

Name	Type	Description	Default
`--name`	text	Filter by name (supports wildcards: dev-*).	None
`--status`	text	Filter by status (e.g. ERROR, SHUTOFF).	None
`--all`	boolean	Select all servers (use with caution).	`False`
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server clone¶

Clone a server — recreate one with the same config.

Copies flavor, network, security groups, key pair, and image from the source server into a new one. The clone's boot mode follows the same policy as orca server create: boot-from-image by default, fallback to boot-from-volume only when the flavor has disk == 0. Override with --boot-from-image / --boot-from-volume.

Examples: orca server clone --name web-02 orca server clone --name web-02 --boot-from-volume --disk-size 50

Usage:

orca server clone [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--name`	text	Name for the cloned server.	`Sentinel.UNSET`
`--disk-size`	integer	Boot volume size in GB (BFV only). Default: same as source.	None
`--boot-from-image`	boolean	Force boot from the image on the compute's local disk (requires flavor disk > 0).	`False`
`--boot-from-volume`	boolean	Force boot from a Cinder volume created from the image.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server confirm-resize¶

Confirm a pending resize.

Usage:

orca server confirm-resize [OPTIONS] SERVER_ID

Options:

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

orca server console¶

Inspect the server console (log, URL).

Usage:

orca server console [OPTIONS] COMMAND [ARGS]...

Options:

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

orca server console log¶

Show the server console output (boot log).

Examples: orca server console-log orca server console-log --lines 100 orca server console-log --lines 0 # all output

Usage:

orca server console log [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--lines`	integer	Number of lines to retrieve (0 = all).	`50`
`--help`	boolean	Show this message and exit.	`False`

orca server console url¶

Get a URL to access the server console (VNC/SPICE/serial).

Examples: orca server console-url orca server console-url --type spice-html5 orca server console-url --open

Usage:

orca server console url [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--type`	choice (`novnc` \| `xvpvnc` \| `spice-html5` \| `rdp-html5` \| `serial`)	Console type.	`novnc`
`--open`	boolean	Open the URL in the default system browser immediately.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server console-log¶

Show the server console output (boot log).

Examples: orca server console-log orca server console-log --lines 100 orca server console-log --lines 0 # all output

Usage:

orca server console-log [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--lines`	integer	Number of lines to retrieve (0 = all).	`50`
`--help`	boolean	Show this message and exit.	`False`

orca server console-url¶

Get a URL to access the server console (VNC/SPICE/serial).

Examples: orca server console-url orca server console-url --type spice-html5 orca server console-url --open

Usage:

orca server console-url [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--type`	choice (`novnc` \| `xvpvnc` \| `spice-html5` \| `rdp-html5` \| `serial`)	Console type.	`novnc`
`--open`	boolean	Open the URL in the default system browser immediately.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server create¶

Create a new server.

By default the server boots from the image directly on the compute's local disk (flavor disk field). Flavors declared with disk=0 fall back to boot-from-volume automatically since Nova cannot boot them otherwise. Use --boot-from-image or --boot-from-volume to override the auto-detection.

Non-interactive example: orca server create \ --name my-vm \ --flavor \ --image \ --disk-size 30 \ --network \ --key-name my-key \ --wait

Interactive wizard: orca server create -i

Usage:

orca server create [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Server name.	None
`--flavor`	text	Flavor ID (see 'orca flavor list').	None
`--image`	text	Image ID (see 'orca image list').	None
`--disk-size`	integer	Boot volume size in GB.	`20`
`--network`	text	Network ID (see 'orca network list').	None
`--key-name`	text	SSH key pair name (see 'orca keypair list').	None
`--security-group`	text	Security group name (repeatable).	`Sentinel.UNSET`
`--boot-from-image`	boolean	Force boot from the image on the compute's local disk (requires flavor disk > 0).	`False`
`--boot-from-volume`	boolean	Force boot from a Cinder volume created from the image.	`False`
`--wait`	boolean	Wait until the server reaches ACTIVE status.	`False`
`--interactive`, `-i`	boolean	Step-by-step wizard — browse images, flavors, and networks interactively.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server create-image¶

Create a snapshot image from a server.

See also: For boot-from-volume instances, the resulting image is a 0-byte shell that points at a Cinder snapshot — not a downloadable image. To obtain a self-contained, transportable image, use: orca volume snapshot create --force orca volume create --snapshot-id ... orca volume upload-to-image ...

Usage:

orca server create-image [OPTIONS] SERVER_ID IMAGE_NAME

Options:

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

orca server delete¶

Delete a server.

Usage:

orca server delete [OPTIONS] SERVER_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 server is fully deleted.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server detach-interface¶

Detach a network interface (port) from a server.

Usage:

orca server detach-interface [OPTIONS] SERVER_ID PORT_ID

Options:

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

orca server detach-volume¶

Detach a volume from a server.

Usage:

orca server detach-volume [OPTIONS] SERVER_ID VOLUME_ID

Options:

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

orca server diff¶

Compare two servers side by side.

Highlights differences in flavor, image, network, security groups, status, and other configuration.

Examples: orca server diff

Usage:

orca server diff [OPTIONS] SERVER_A SERVER_B

Options:

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

orca server dump¶

Manage crash dumps for a server.

Usage:

orca server dump [OPTIONS] COMMAND [ARGS]...

Options:

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

orca server dump create¶

Trigger a crash dump on a server (requires Nova microversion ≥ 2.17).

Sends an NMI to the server which causes the guest OS to generate a crash dump. The server must be ACTIVE.

Usage:

orca server dump create [OPTIONS] SERVER_ID

Options:

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

orca server dump-create¶

Trigger a crash dump on a server (requires Nova microversion ≥ 2.17).

Sends an NMI to the server which causes the guest OS to generate a crash dump. The server must be ACTIVE.

Usage:

orca server dump-create [OPTIONS] SERVER_ID

Options:

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

orca server evacuate¶

Evacuate a server from a failed host to another.

Examples: orca server evacuate orca server evacuate --host compute02 orca server evacuate --on-shared-storage

Usage:

orca server evacuate [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--host`	text	Target host (admin only, optional).	None
`--on-shared-storage` / `--no-shared-storage`	boolean	Whether server disks are on shared storage.	`False`
`--password`	text	Admin password for the evacuated server.	None
`--help`	boolean	Show this message and exit.	`False`

orca server event¶

Browse Nova instance actions for a server (alias of orca event).

Usage:

orca server event [OPTIONS] COMMAND [ARGS]...

Options:

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

orca server event list¶

List instance actions for a server.

Examples: orca event list orca event list -f json

Usage:

orca server event list [OPTIONS] SERVER_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 server event show¶

Show details for a single instance action, including sub-events.

Examples: orca event show

Usage:

orca server event show [OPTIONS] SERVER_ID REQUEST_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 server image¶

Image-level operations on a server (snapshot, ...).

Usage:

orca server image [OPTIONS] COMMAND [ARGS]...

Options:

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

orca server image create¶

Create a snapshot image from a server.

See also: For boot-from-volume instances, the resulting image is a 0-byte shell that points at a Cinder snapshot — not a downloadable image. To obtain a self-contained, transportable image, use: orca volume snapshot create --force orca volume create --snapshot-id ... orca volume upload-to-image ...

Usage:

orca server image create [OPTIONS] SERVER_ID IMAGE_NAME

Options:

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

orca server interface¶

Network interfaces attached to a server.

Usage:

orca server interface [OPTIONS] COMMAND [ARGS]...

Options:

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

orca server interface list¶

List network interfaces attached to a server.

Usage:

orca server interface list [OPTIONS] SERVER_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 server list¶

List servers.

Usage:

orca server list [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	integer	Max number of servers to return.	`50`
`--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 server list-interfaces¶

List network interfaces attached to a server.

Usage:

orca server list-interfaces [OPTIONS] SERVER_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 server list-volumes¶

List volumes attached to a server.

Usage:

orca server list-volumes [OPTIONS] SERVER_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 server live-migrate¶

Live-migrate a server (deprecated — use 'server migrate --live').

Usage:

orca server live-migrate [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--host`	text	Target host (admin only, optional).	None
`--block-migration` / `--no-block-migration`	boolean	Copy disk over the network (no shared storage needed).	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server lock¶

Lock a server (prevent actions by non-admin).

Usage:

orca server lock [OPTIONS] SERVER_ID

Options:

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

orca server metadata¶

Read or modify server metadata.

Usage:

orca server metadata [OPTIONS] COMMAND [ARGS]...

Options:

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

orca server metadata list¶

Show all metadata key/value pairs for a server.

Usage:

orca server metadata list [OPTIONS] SERVER_ID

Options:

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

orca server metadata-list¶

Show all metadata key/value pairs for a server.

Usage:

orca server metadata-list [OPTIONS] SERVER_ID

Options:

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

orca server migrate¶

Migrate a server to another host (cold by default).

Examples: orca server migrate # cold migration orca server migrate --host compute02 # cold, target host orca server migrate --live # live migration orca server migrate --live --block-migration

Usage:

orca server migrate [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--host`	text	Target host (admin only, optional).	None
`--live`	boolean	Live-migrate (no downtime) instead of cold migration.	`False`
`--block-migration` / `--no-block-migration`	boolean	Live mode only: copy disk over the network (slower but no shared storage needed).	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server migration¶

Inspect or control server migrations.

Usage:

orca server migration [OPTIONS] COMMAND [ARGS]...

Options:

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

orca server migration abort¶

Abort an in-progress live migration.

Usage:

orca server migration abort [OPTIONS] SERVER_ID MIGRATION_ID

Options:

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

orca server migration confirm-resize¶

Confirm a pending resize.

Usage:

orca server migration confirm-resize [OPTIONS] SERVER_ID

Options:

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

orca server migration force-complete¶

Force an in-progress live migration to complete.

Usage:

orca server migration force-complete [OPTIONS] SERVER_ID MIGRATION_ID

Options:

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

orca server migration list¶

List migrations for a server.

Usage:

orca server migration list [OPTIONS] SERVER_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 server migration revert-resize¶

Revert a pending resize (restore original flavor).

Usage:

orca server migration revert-resize [OPTIONS] SERVER_ID

Options:

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

orca server migration show¶

Show details of a specific migration.

Usage:

orca server migration show [OPTIONS] SERVER_ID MIGRATION_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 server migration-abort¶

Abort an in-progress live migration.

Usage:

orca server migration-abort [OPTIONS] SERVER_ID MIGRATION_ID

Options:

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

orca server migration-force-complete¶

Force an in-progress live migration to complete.

Usage:

orca server migration-force-complete [OPTIONS] SERVER_ID MIGRATION_ID

Options:

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

orca server migration-list¶

List migrations for a server.

Usage:

orca server migration-list [OPTIONS] SERVER_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 server migration-show¶

Show details of a specific migration.

Usage:

orca server migration-show [OPTIONS] SERVER_ID MIGRATION_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 server password¶

Retrieve and decrypt the server admin password.

The password is encrypted with your SSH public key at boot and stored in the server metadata. This command fetches it and decrypts it locally with your private key (RSA only).

Examples: orca server password orca server password --key ~/.ssh/orca-my-key orca server password --raw

Usage:

orca server password [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--key`	path	Path to the RSA private key used to decrypt. Tries ~/.ssh/orca-* if omitted.	None
`--raw`	boolean	Print the encrypted password without decrypting.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server pause¶

Pause a server (freeze in memory).

Usage:

orca server pause [OPTIONS] SERVER_ID

Options:

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

orca server port-forward¶

Create an SSH tunnel (port forward) to a server.

PORT_MAPPING format: LOCAL_PORT:REMOTE_HOST:REMOTE_PORT

Examples: orca server port-forward 8080:localhost:80 # local forward orca server port-forward 3306:db-server:3306 # forward to internal host orca server port-forward 9090:localhost:9090 -R # reverse tunnel orca server port-forward 5432:localhost:5432 -b # background

Usage:

orca server port-forward [OPTIONS] SERVER_ID PORT_MAPPING

Options:

Name	Type	Description	Default
`--user`, `-u`	text	SSH user. Default: 'root'.	None
`--key`, `-i`	path	Private key path.	None
`--ssh-port`, `-p`	integer	SSH port on the server.	`22`
`--reverse`, `-R`	boolean	Reverse tunnel (remote → local).	`False`
`--background`, `-b`	boolean	Run tunnel in background (-f -N).	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server reboot¶

Reboot a server.

Usage:

orca server reboot [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--hard`	boolean	Perform a hard reboot.	`False`
`--wait`	boolean	Wait until the server reaches ACTIVE status.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server rebuild¶

Rebuild a server with a new image (reinstall).

Usage:

orca server rebuild [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--image`	text	New image ID.	`Sentinel.UNSET`
`--name`	text	New server name (optional).	None
`--password`	text	New admin password (optional).	None
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server remove¶

Detach a sub-resource from a server.

Usage:

orca server remove [OPTIONS] COMMAND [ARGS]...

Options:

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

orca server remove fixed-ip¶

Remove a specific fixed IP from a server.

Example: orca server remove-fixed-ip 10.0.0.5

Usage:

orca server remove fixed-ip [OPTIONS] SERVER_ID IP_ADDRESS

Options:

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

orca server remove floating-ip¶

Disassociate a floating IP from a server (OSC parity).

Example: orca server remove floating-ip 172.24.4.10

Usage:

orca server remove floating-ip [OPTIONS] SERVER_ID IP_ADDRESS

Options:

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

orca server remove interface¶

Detach a network interface (port) from a server.

Usage:

orca server remove interface [OPTIONS] SERVER_ID PORT_ID

Options:

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

orca server remove network¶

Detach all interfaces on a specific network from a server.

Looks up interfaces by network ID and removes each one.

Example: orca server remove-network

Usage:

orca server remove network [OPTIONS] SERVER_ID NETWORK_ID

Options:

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

orca server remove port¶

Detach a Neutron port from a server.

Example: orca server remove-port

Usage:

orca server remove port [OPTIONS] SERVER_ID PORT_ID

Options:

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

orca server remove security-group¶

Remove a security group from a running server.

Usage:

orca server remove security-group [OPTIONS] SERVER_ID SECURITY_GROUP

Options:

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

orca server remove volume¶

Detach a volume from a server.

Usage:

orca server remove volume [OPTIONS] SERVER_ID VOLUME_ID

Options:

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

orca server remove-fixed-ip¶

Remove a specific fixed IP from a server.

Example: orca server remove-fixed-ip 10.0.0.5

Usage:

orca server remove-fixed-ip [OPTIONS] SERVER_ID IP_ADDRESS

Options:

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

orca server remove-network¶

Detach all interfaces on a specific network from a server.

Looks up interfaces by network ID and removes each one.

Example: orca server remove-network

Usage:

orca server remove-network [OPTIONS] SERVER_ID NETWORK_ID

Options:

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

orca server remove-port¶

Detach a Neutron port from a server.

Example: orca server remove-port

Usage:

orca server remove-port [OPTIONS] SERVER_ID PORT_ID

Options:

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

orca server remove-security-group¶

Remove a security group from a running server.

Usage:

orca server remove-security-group [OPTIONS] SERVER_ID SECURITY_GROUP

Options:

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

orca server rename¶

Rename a server.

Usage:

orca server rename [OPTIONS] SERVER_ID NEW_NAME

Options:

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

orca server rescue¶

Put a server in rescue mode.

Usage:

orca server rescue [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--image`	text	Rescue image ID (optional).	None
`--password`	text	Admin password for rescue mode.	None
`--help`	boolean	Show this message and exit.	`False`

orca server resize¶

Resize a server to a new flavor.

OSC's server resize confirm/revert form is exposed under orca server migration confirm/revert (same Nova action) — Click does not support a group with both a positional argument and sub-commands.

Usage:

orca server resize [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--flavor`	text	Target flavor ID.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca server restore¶

Restore a soft-deleted server.

Only valid when Nova is configured with soft-delete (reclaim_instance_interval > 0) and the server status is SOFT_DELETED.

Usage:

orca server restore [OPTIONS] SERVER_ID

Options:

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

orca server resume¶

Resume a suspended server.

Usage:

orca server resume [OPTIONS] SERVER_ID

Options:

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

orca server revert-resize¶

Revert a pending resize (restore original flavor).

Usage:

orca server revert-resize [OPTIONS] SERVER_ID

Options:

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

orca server server-group¶

Manage server groups (Nova).

Usage:

orca server server-group [OPTIONS] COMMAND [ARGS]...

Options:

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

orca server server-group create¶

Create a server group.

Policies: anti-affinity — servers on different hosts (hard) affinity — servers on same host (hard) soft-anti-affinity — prefer different hosts soft-affinity — prefer same host

Usage:

orca server server-group create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--policy`	choice (`anti-affinity` \| `affinity` \| `soft-anti-affinity` \| `soft-affinity`)	Scheduling policy.	`anti-affinity`
`--help`	boolean	Show this message and exit.	`False`

orca server server-group delete¶

Delete a server group.

Usage:

orca server server-group delete [OPTIONS] GROUP_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server server-group list¶

List server groups.

Usage:

orca server server-group list [OPTIONS]

Options:

Name	Type	Description	Default
`--all`	boolean	List server groups for 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 server server-group show¶

Show server group details.

Usage:

orca server server-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 server set¶

Set server properties, metadata, tags, or admin password.

Examples: orca server set --name new-name orca server set --property env=prod --property team=infra orca server set --tag web --tag frontend orca server set --admin-password s3cr3t

Usage:

orca server set [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--name`	text	New display name.	None
`--property`	text	Metadata key=value (repeatable).	`Sentinel.UNSET`
`--tag`	text	Tag to set (repeatable, replaces all existing tags).	`Sentinel.UNSET`
`--admin-password`	text	New admin/root password (injected via Nova).	None
`--help`	boolean	Show this message and exit.	`False`

orca server shelve¶

Shelve a server (snapshot + shut down, frees resources).

Usage:

orca server shelve [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--wait`	boolean	Wait until the server reaches SHELVED_OFFLOADED status.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server show¶

Show server details.

Usage:

orca server show [OPTIONS] SERVER_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 server snapshot¶

Snapshot a server AND all its attached volumes.

Creates a server image snapshot plus a Cinder snapshot for each attached volume — all in one command.

Examples: orca server snapshot orca server snapshot --name "before-upgrade"

Usage:

orca server snapshot [OPTIONS] SERVER_ID

Options:

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

orca server ssh¶

SSH into a server by name or ID.

Auto-resolves the IP (floating > fixed), the SSH user (from image os_distro metadata), and the private key (matched from the attached keypair name in ~/.ssh/).

Examples: orca server ssh web-1 # auto-detect everything orca server ssh web-1 ls /var/log # run a remote command orca server ssh web-1 -u root -i ~/.ssh/k # override user / key orca server ssh web-1 --fixed # use fixed IP orca server ssh web-1 --dry-run # print command, don't exec

Usage:

orca server ssh [OPTIONS] SERVER_ID [REMOTE_ARGS]...

Options:

Name	Type	Description	Default
`--user`, `-u`	text	SSH user. Default: auto-detected from image os_distro.	None
`--key`, `-i`	path	Private key path. Default: matched from keypair name in ~/.ssh.	None
`--port`, `-p`	integer	SSH port.	`22`
`--fixed`	boolean	Use the fixed IP instead of the floating IP.	`False`
`--dry-run`	boolean	Print the ssh command without executing it.	`False`
`--extra`	text	Extra SSH options (e.g. '-o StrictHostKeyChecking=no').	None
`--help`	boolean	Show this message and exit.	`False`

orca server start¶

Start (resume) a stopped server.

Usage:

orca server start [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--wait`	boolean	Wait until the server reaches ACTIVE status.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server stop¶

Stop (shut down) a server.

Usage:

orca server stop [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--wait`	boolean	Wait until the server reaches SHUTOFF status.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server suspend¶

Suspend a server (save to disk).

Usage:

orca server suspend [OPTIONS] SERVER_ID

Options:

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

orca server tag¶

Read or modify server tags.

Usage:

orca server tag [OPTIONS] COMMAND [ARGS]...

Options:

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

List tags on a server.

Usage:

orca server tag list [OPTIONS] SERVER_ID

Options:

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

List tags on a server.

Usage:

orca server tag-list [OPTIONS] SERVER_ID

Options:

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

orca server unlock¶

Unlock a locked server.

Usage:

orca server unlock [OPTIONS] SERVER_ID

Options:

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

orca server unpause¶

Unpause a paused server.

Usage:

orca server unpause [OPTIONS] SERVER_ID

Options:

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

orca server unrescue¶

Exit rescue mode.

Usage:

orca server unrescue [OPTIONS] SERVER_ID

Options:

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

orca server unset¶

Remove metadata keys or tags from a server.

Examples: orca server unset --property env --property team orca server unset --tag web --tag frontend

Usage:

orca server unset [OPTIONS] SERVER_ID

Options:

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

orca server unshelve¶

Unshelve (restore) a shelved server.

Usage:

orca server unshelve [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--wait`	boolean	Wait until the server reaches ACTIVE status.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server volume¶

Volumes attached to a server.

Usage:

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

Options:

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

orca server volume list¶

List volumes attached to a server.

Usage:

orca server volume list [OPTIONS] SERVER_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 server volume set¶

Update a volume attachment (flip delete-on-termination).

Examples: orca server volume set --delete-on-termination orca server volume set --preserve-on-termination

Usage:

orca server volume set [OPTIONS] SERVER_ID VOLUME_ID

Options:

Name	Type	Description	Default
`--delete-on-termination` / `--preserve-on-termination`	boolean	Whether deleting the server should also delete this volume attachment. Requires Nova microversion 2.85 (Yoga+).	None
`--help`	boolean	Show this message and exit.	`False`

orca server volume set¶

Update a volume attachment (flip delete-on-termination).

Examples: orca server volume set --delete-on-termination orca server volume set --preserve-on-termination

Usage:

orca server volume set [OPTIONS] SERVER_ID VOLUME_ID

Options:

Name	Type	Description	Default
`--delete-on-termination` / `--preserve-on-termination`	boolean	Whether deleting the server should also delete this volume attachment. Requires Nova microversion 2.85 (Yoga+).	None
`--help`	boolean	Show this message and exit.	`False`

orca server wait¶

Wait for a server to reach a target status.

Polls the server status until it matches the target or the timeout is reached. Useful in scripts and automation.

Examples: orca server wait --status ACTIVE orca server wait --status SHUTOFF --timeout 120

Usage:

orca server wait [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--status`	text	Target status to wait for.	`ACTIVE`
`--timeout`	integer	Timeout in seconds.	`300`
`--interval`	integer	Poll interval in seconds.	`5`
`--help`	boolean	Show this message and exit.	`False`

orca server-group¶

Manage server groups (Nova).

Usage:

orca server-group [OPTIONS] COMMAND [ARGS]...

Options:

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

orca server-group create¶

Create a server group.

Policies: anti-affinity — servers on different hosts (hard) affinity — servers on same host (hard) soft-anti-affinity — prefer different hosts soft-affinity — prefer same host

Usage:

orca server-group create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--policy`	choice (`anti-affinity` \| `affinity` \| `soft-anti-affinity` \| `soft-affinity`)	Scheduling policy.	`anti-affinity`
`--help`	boolean	Show this message and exit.	`False`

orca server-group delete¶

Delete a server group.

Usage:

orca server-group delete [OPTIONS] GROUP_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server-group list¶

List server groups.

Usage:

orca server-group list [OPTIONS]

Options:

Name	Type	Description	Default
`--all`	boolean	List server groups for 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 server-group show¶

Show server group details.

Usage:

orca server-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 service¶

Manage Keystone services (service catalog).

Usage:

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

Options:

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

orca service create¶

Create a Keystone service.

Accepts the service name as either a positional argument (orca service create my-svc --type ...) — matching the user / project / domain / role / group CRUDs — or via the legacy --name flag.

Usage:

orca service create [OPTIONS] [NAME]

Options:

Name	Type	Description	Default
`--name`	text	Service name (alternative to the positional argument).	None
`--type`	text	Service type (e.g. identity, compute).	`Sentinel.UNSET`
`--description`	text	Service description.	None
`--enable` / `--disable`	boolean	Enable or disable the service.	`True`
`--help`	boolean	Show this message and exit.	`False`

orca service delete¶

Delete a Keystone service.

Usage:

orca service delete [OPTIONS] SERVICE_ID

Options:

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

orca service list¶

List Keystone services.

Usage:

orca service list [OPTIONS]

Options:

Name	Type	Description	Default
`--type`	text	Filter by service 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 service set¶

Update a Keystone service.

Usage:

orca service set [OPTIONS] SERVICE_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--type`	text	New type.	None
`--description`	text	New description.	None
`--enable` / `--disable`	boolean	Enable or disable.	None
`--help`	boolean	Show this message and exit.	`False`

orca service show¶

Show service details.

Usage:

orca service show [OPTIONS] SERVICE_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 service-provider¶

Manage Keystone service providers (federation).

Usage:

orca service-provider [OPTIONS] COMMAND [ARGS]...

Options:

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

orca service-provider create¶

Create a service provider.

Usage:

orca service-provider create [OPTIONS] SP_ID

Options:

Name	Type	Description	Default
`--auth-url`	text	Remote Keystone auth URL.	`Sentinel.UNSET`
`--sp-url`	text	Service provider SAML2 endpoint.	`Sentinel.UNSET`
`--description`	text	N/A	``
`--enable` / `--disable`	boolean	N/A	`True`
`--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 service-provider delete¶

Delete a service provider.

Usage:

orca service-provider delete [OPTIONS] SP_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca service-provider list¶

List service providers.

Usage:

orca service-provider 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 service-provider set¶

Update a service provider.

Usage:

orca service-provider set [OPTIONS] SP_ID

Options:

Name	Type	Description	Default
`--auth-url`	text	N/A	None
`--sp-url`	text	N/A	None
`--description`	text	N/A	None
`--enable` / `--disable`	boolean	N/A	None
`--help`	boolean	Show this message and exit.	`False`

orca service-provider show¶

Show a service provider.

Usage:

orca service-provider show [OPTIONS] SP_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 setup¶

Interactive assistant to configure your OpenStack credentials.

Creates or edits a profile. Use --profile to target a specific profile.

Examples: orca setup # edit the active profile orca setup --profile staging # create/edit 'staging' profile

Usage:

orca setup [OPTIONS]

Options:

Name	Type	Description	Default
`--profile`, `-p`	text	Profile name to create/edit. Default: active profile.	None
`--help`	boolean	Show this message and exit.	`False`

Manage Manila shared file systems (shares, access rules, snapshots).

Manila is a multi-tenant NFS/CIFS/CephFS-as-a-service. Use orca share create to allocate a share, orca share access allow to expose it to a client IP, then mount the export location.

Usage:

orca share [OPTIONS] COMMAND [ARGS]...

Options:

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

Manage share access rules (NFS IP allow, CIFS user, CephFS x509).

Usage:

orca share access [OPTIONS] COMMAND [ARGS]...

Options:

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

Grant access to a share.

Examples: orca share access allow --access-type ip --access-to 10.0.0.0/24 orca share access allow --access-type ip --access-to 1.2.3.4 --access-level ro orca share access allow --access-type cephx --access-to client.foo

Usage:

orca share access allow [OPTIONS] SHARE_ID

Options:

Name	Type	Description	Default
`--access-type`	choice (`ip` \| `user` \| `cert` \| `cephx`)	ip (NFS)	user (CIFS)
`--access-to`	text	The principal: IP/CIDR for ip, username for user, CN for cert, client name for cephx.	`Sentinel.UNSET`
`--access-level`	choice (`rw` \| `ro`)	N/A	`rw`
`--help`	boolean	Show this message and exit.	`False`

Revoke an access rule from a share.

Usage:

orca share access deny [OPTIONS] SHARE_ID ACCESS_ID

Options:

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

List access rules attached to a share.

Usage:

orca share access list [OPTIONS] SHARE_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`

Create a share.

Examples: orca share create my-nfs --size 50 orca share create scratch --size 100 --protocol CEPHFS --availability-zone az1 orca share create from-snap --size 10 --snapshot-id

Usage:

orca share create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--size`	integer	Share size in GB.	`Sentinel.UNSET`
`--protocol`	choice (`NFS` \| `CIFS` \| `GLUSTERFS` \| `HDFS` \| `CEPHFS` \| `MAPRFS`)	Share protocol.	`NFS`
`--description`	text	Free-text description.	None
`--share-type`	text	Share type name or ID (omit for the operator default).	None
`--share-network`	text	Share network ID for multi-tenant deployments.	None
`--snapshot-id`	text	Create from an existing snapshot.	None
`--availability-zone`	text	Target AZ.	None
`--public` / `--private`	boolean	Share visibility (default: private).	`False`
`--help`	boolean	Show this message and exit.	`False`

Delete a share.

Usage:

orca share delete [OPTIONS] SHARE_ID

Options:

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

Extend a share (grow only).

Usage:

orca share extend [OPTIONS] SHARE_ID

Options:

Name	Type	Description	Default
`--size`	integer	New total size in GB.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

List shares.

Usage:

orca share 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`

Update a share's name / description / visibility.

Usage:

orca share set [OPTIONS] SHARE_ID

Options:

Name	Type	Description	Default
`--name`	text	New display name.	None
`--description`	text	New description.	None
`--public` / `--private`	boolean	Switch visibility.	None
`--help`	boolean	Show this message and exit.	`False`

Show share details + export locations.

Usage:

orca share show [OPTIONS] SHARE_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`

Shrink a share (only allowed if the backend supports it).

Usage:

orca share shrink [OPTIONS] SHARE_ID

Options:

Name	Type	Description	Default
`--size`	integer	New total size in GB.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

Manage share snapshots.

Usage:

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

Options:

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

Snapshot a share.

Usage:

orca share snapshot create [OPTIONS] SHARE_ID

Options:

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

Delete a snapshot.

Usage:

orca share snapshot delete [OPTIONS] SNAPSHOT_ID

Options:

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

List share snapshots.

Usage:

orca share 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`

Show snapshot details.

Usage:

orca share 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`

Inspect share types (admin defines, users select).

Usage:

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

Options:

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

List share types defined by the operator.

Usage:

orca share 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`

Show a share type.

Usage:

orca share 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 software¶

Heat software configs and deployments.

Usage:

orca software [OPTIONS] COMMAND [ARGS]...

Options:

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

orca software config¶

Heat software configurations.

Usage:

orca software config [OPTIONS] COMMAND [ARGS]...

Options:

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

orca software config create¶

Create a Heat software config.

Usage:

orca software config create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--group`	text	Config group (e.g. script, ansible, puppet).	`script`
`--config`	text	Raw config payload (inline text).	None
`--config-file`	path	Read the config payload from this file.	None
`--definition-file`	path	YAML/JSON file with `inputs` / `outputs` definitions.	None
`--help`	boolean	Show this message and exit.	`False`

orca software config delete¶

Delete a software config.

Usage:

orca software config delete [OPTIONS] CONFIG_ID

Options:

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

orca software config list¶

List software configs.

Usage:

orca software config list [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	integer	Server-side pagination limit.	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 software config show¶

Show a software config.

Usage:

orca software config show [OPTIONS] CONFIG_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 software deployment¶

Heat software deployments.

Usage:

orca software deployment [OPTIONS] COMMAND [ARGS]...

Options:

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

orca software deployment create¶

Create a software deployment.

Usage:

orca software deployment create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--server`	text	Server (Nova UUID) running this deployment.	`Sentinel.UNSET`
`--config`	text	Software config to deploy.	`Sentinel.UNSET`
`--action`	choice (`CREATE` \| `UPDATE` \| `DELETE` \| `SUSPEND` \| `RESUME`)	Action to record on the deployment.	`CREATE`
`--help`	boolean	Show this message and exit.	`False`

orca software deployment delete¶

Delete a software deployment.

Usage:

orca software deployment delete [OPTIONS] DEPLOYMENT_ID

Options:

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

orca software deployment list¶

List software deployments (optionally filtered by server).

Usage:

orca software deployment list [OPTIONS]

Options:

Name	Type	Description	Default
`--server`	text	Filter by server (Nova UUID).	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 software deployment metadata¶

Per-server deployment metadata.

Usage:

orca software deployment metadata [OPTIONS] COMMAND [ARGS]...

Options:

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

orca software deployment metadata show¶

Show the aggregated deployment metadata for a server.

Heat exposes GET /v1/software_deployments/metadata/{server_id} which returns the list of metadata snippets all deployments on that server have produced.

Usage:

orca software deployment metadata show [OPTIONS] SERVER_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 software deployment output¶

Software deployment output access.

Usage:

orca software deployment output [OPTIONS] COMMAND [ARGS]...

Options:

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

orca software deployment output show¶

Show a software deployment's output values.

Without OUTPUT_NAME, lists every output the deployment recorded. With OUTPUT_NAME, only that key (or 404 if absent).

Usage:

orca software deployment output show [OPTIONS] DEPLOYMENT_ID [OUTPUT_NAME]

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 software deployment show¶

Show a software deployment.

Usage:

orca software deployment show [OPTIONS] DEPLOYMENT_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 stack¶

Manage Heat stacks (orchestration).

Usage:

orca stack [OPTIONS] COMMAND [ARGS]...

Options:

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

orca stack abandon¶

Abandon a stack (delete without destroying resources).

Exports the stack's resource data, then removes the stack record from Heat without actually deleting the underlying OpenStack resources.

Usage:

orca stack abandon [OPTIONS] STACK_NAME_OR_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--output-file`	text	Save abandoned stack data to a JSON file.	None
`--help`	boolean	Show this message and exit.	`False`

orca stack adopt¶

Adopt existing resources into a new stack.

Usage:

orca stack adopt [OPTIONS] NAME

Options:

Name	Type	Description	Default
`-t`, `--template`	file	Template file (yaml/json).	`Sentinel.UNSET`
`--adopt-file`	file	JSON file with the adopt_stack_data payload (existing resources to adopt).	`Sentinel.UNSET`
`--parameter`	text	Parameter key=value (repeatable).	`Sentinel.UNSET`
`--timeout`	integer	Timeout in minutes.	None
`--help`	boolean	Show this message and exit.	`False`

orca stack cancel¶

Cancel an in-progress stack update.

Usage:

orca stack cancel [OPTIONS] STACK_NAME_OR_ID

Options:

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

orca stack check¶

Check a stack (verify resource states).

Usage:

orca stack check [OPTIONS] STACK_NAME_OR_ID

Options:

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

orca stack create¶

Create a stack.

Examples: orca stack create my-stack -t template.yaml orca stack create my-stack -t template.yaml -e env.yaml --parameter key1=val1 orca stack create my-stack -t template.yaml --timeout 30 --wait

Usage:

orca stack create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--template`, `-t`	text	Template file path or URL.	`Sentinel.UNSET`
`--environment`, `-e`	text	Environment file path.	None
`--parameter`	text	Parameter key=value (repeatable).	`Sentinel.UNSET`
`--timeout`	integer	Timeout in minutes.	None
`--wait`	boolean	Wait for stack to reach terminal state.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca stack delete¶

Delete a stack.

Usage:

orca stack delete [OPTIONS] STACK_NAME_OR_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--wait`	boolean	Wait for stack deletion to complete.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca stack diff¶

Compare a local template with a deployed stack's template.

Fetches the currently deployed template from Heat and diffs it against the local file so you can review changes before running orca stack update.

Examples: orca stack diff my-stack -t template.yaml orca stack diff my-stack -t updated-template.yaml

Usage:

orca stack diff [OPTIONS] STACK_NAME_OR_ID

Options:

Name	Type	Description	Default
`--template`, `-t`	path	Local template file to compare against.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca stack environment¶

Inspect a stack's resolved environment.

Usage:

orca stack environment [OPTIONS] COMMAND [ARGS]...

Options:

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

orca stack environment show¶

Show the resolved environment of a stack.

Usage:

orca stack environment show [OPTIONS] STACK_NAME_OR_ID

Options:

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

orca stack event¶

Inspect stack events.

Usage:

orca stack event [OPTIONS] COMMAND [ARGS]...

Options:

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

orca stack event list¶

List stack events.

Usage:

orca stack event list [OPTIONS] STACK_NAME_OR_ID

Options:

Name	Type	Description	Default
`--resource`	text	Filter by resource name.	None
`--limit`	integer	Limit number of events.	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 stack event show¶

Show event details.

Usage:

orca stack event show [OPTIONS] STACK_NAME_OR_ID RESOURCE_NAME EVENT_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 stack event-list¶

List stack events.

Usage:

orca stack event-list [OPTIONS] STACK_NAME_OR_ID

Options:

Name	Type	Description	Default
`--resource`	text	Filter by resource name.	None
`--limit`	integer	Limit number of events.	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 stack event-show¶

Show event details.

Usage:

orca stack event-show [OPTIONS] STACK_NAME_OR_ID RESOURCE_NAME EVENT_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 stack export¶

Export the full serialised state of a stack.

Heat GET /v1/stacks/{name}/{id}/export returns the same body as abandon would, without actually removing the stack. Useful as a backup or for stack adopt later.

Usage:

orca stack export [OPTIONS] STACK_NAME

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 stack failures¶

Inspect failed events on a stack.

Usage:

orca stack failures [OPTIONS] COMMAND [ARGS]...

Options:

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

orca stack failures list¶

List events on a stack whose resource_status is FAILED.

Usage:

orca stack failures list [OPTIONS] STACK_NAME_OR_ID

Options:

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

orca stack file¶

Inspect files referenced by a stack template.

Usage:

orca stack file [OPTIONS] COMMAND [ARGS]...

Options:

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

orca stack file list¶

List local files referenced by a stack template.

Usage:

orca stack file list [OPTIONS] STACK_NAME_OR_ID

Options:

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

orca stack hook¶

Manage pre-create / pre-update hooks on stack resources.

Usage:

orca stack hook [OPTIONS] COMMAND [ARGS]...

Options:

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

orca stack hook clear¶

Clear a hook so the paused resource can proceed.

Usage:

orca stack hook clear [OPTIONS] STACK_NAME RESOURCE_NAME

Options:

Name	Type	Description	Default
`--hook`	choice (`pre-create` \| `pre-update` \| `pre-delete`)	Hook to clear on the resource.	`pre-create`
`--help`	boolean	Show this message and exit.	`False`

orca stack hook poll¶

List resources whose hooks are still pending on a stack.

Usage:

orca stack hook poll [OPTIONS] STACK_NAME

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 stack list¶

List stacks.

Usage:

orca stack 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 stack output¶

Inspect stack outputs.

Usage:

orca stack output [OPTIONS] COMMAND [ARGS]...

Options:

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

orca stack output list¶

List stack outputs.

Usage:

orca stack output list [OPTIONS] STACK_NAME_OR_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 stack output show¶

Show a specific stack output value.

Usage:

orca stack output show [OPTIONS] STACK_NAME_OR_ID KEY

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 stack output-list¶

List stack outputs.

Usage:

orca stack output-list [OPTIONS] STACK_NAME_OR_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 stack output-show¶

Show a specific stack output value.

Usage:

orca stack output-show [OPTIONS] STACK_NAME_OR_ID KEY

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 stack resource¶

Per-resource actions and inspection on a stack.

Usage:

orca stack resource [OPTIONS] COMMAND [ARGS]...

Options:

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

orca stack resource list¶

List resources in a stack.

Usage:

orca stack resource list [OPTIONS] STACK_NAME_OR_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 stack resource mark-unhealthy¶

Mark a stack resource as unhealthy (forces re-create on update).

Usage:

orca stack resource mark-unhealthy [OPTIONS] STACK_NAME_OR_ID RESOURCE_NAME

Options:

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

orca stack resource metadata¶

Show the metadata of a stack resource.

Usage:

orca stack resource metadata [OPTIONS] STACK_NAME_OR_ID RESOURCE_NAME

Options:

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

orca stack resource show¶

Show resource details.

Usage:

orca stack resource show [OPTIONS] STACK_NAME_OR_ID RESOURCE_NAME

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 stack resource signal¶

Send a signal to a stack resource (e.g. WaitCondition).

Usage:

orca stack resource signal [OPTIONS] STACK_NAME_OR_ID RESOURCE_NAME

Options:

Name	Type	Description	Default
`--data`	text	JSON body to send as the signal payload.	None
`--help`	boolean	Show this message and exit.	`False`

orca stack resource-list¶

List resources in a stack.

Usage:

orca stack resource-list [OPTIONS] STACK_NAME_OR_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 stack resource-show¶

Show resource details.

Usage:

orca stack resource-show [OPTIONS] STACK_NAME_OR_ID RESOURCE_NAME

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 stack resource-type¶

Inspect Heat resource types (compound noun).

Usage:

orca stack resource-type [OPTIONS] COMMAND [ARGS]...

Options:

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

orca stack resource-type list¶

List available Heat resource types.

Usage:

orca stack resource-type list [OPTIONS]

Options:

Name	Type	Description	Default
`--filter`	text	Filter resource types by name substring.	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 stack resource-type show¶

Show the schema for a Heat resource type.

Usage:

orca stack resource-type show [OPTIONS] RESOURCE_TYPE

Options:

Name	Type	Description	Default
`--template-type`	choice (`cfn` \| `hot`)	Template format for the resource schema.	`hot`
`--help`	boolean	Show this message and exit.	`False`

orca stack resource-type-list¶

List available Heat resource types.

Usage:

orca stack resource-type-list [OPTIONS]

Options:

Name	Type	Description	Default
`--filter`	text	Filter resource types by name substring.	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 stack resource-type-show¶

Show the schema for a Heat resource type.

Usage:

orca stack resource-type-show [OPTIONS] RESOURCE_TYPE

Options:

Name	Type	Description	Default
`--template-type`	choice (`cfn` \| `hot`)	Template format for the resource schema.	`hot`
`--help`	boolean	Show this message and exit.	`False`

orca stack resume¶

Resume a suspended stack.

Usage:

orca stack resume [OPTIONS] STACK_NAME_OR_ID

Options:

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

orca stack show¶

Show stack details.

Usage:

orca stack show [OPTIONS] STACK_NAME_OR_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 stack snapshot¶

Manage stack snapshots (Heat snapshot/restore).

Usage:

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

Options:

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

orca stack snapshot create¶

Take a snapshot of a stack's current state.

Usage:

orca stack snapshot create [OPTIONS] STACK_NAME_OR_ID

Options:

Name	Type	Description	Default
`--name`	text	Snapshot name (auto if omitted).	None
`--help`	boolean	Show this message and exit.	`False`

orca stack snapshot delete¶

Delete a stack snapshot.

Usage:

orca stack snapshot delete [OPTIONS] STACK_NAME_OR_ID SNAPSHOT_ID

Options:

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

orca stack snapshot list¶

List snapshots of a stack.

Usage:

orca stack snapshot list [OPTIONS] STACK_NAME_OR_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 stack snapshot restore¶

Restore a stack to a previous snapshot.

Usage:

orca stack snapshot restore [OPTIONS] STACK_NAME_OR_ID SNAPSHOT_ID

Options:

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

orca stack snapshot show¶

Show a stack snapshot.

Usage:

orca stack snapshot show [OPTIONS] STACK_NAME_OR_ID 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 stack suspend¶

Suspend a stack.

Usage:

orca stack suspend [OPTIONS] STACK_NAME_OR_ID

Options:

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

orca stack template¶

Inspect or validate Heat templates.

Usage:

orca stack template [OPTIONS] COMMAND [ARGS]...

Options:

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

orca stack template show¶

Show the stack template (YAML output).

Usage:

orca stack template show [OPTIONS] STACK_NAME_OR_ID

Options:

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

orca stack template validate¶

Validate a Heat template.

Examples: orca stack template-validate -t template.yaml orca stack template-validate -t template.yaml -e env.yaml

Usage:

orca stack template validate [OPTIONS]

Options:

Name	Type	Description	Default
`--template`, `-t`	text	Template file path or URL.	`Sentinel.UNSET`
`--environment`, `-e`	text	Environment file path.	None
`--parameter`	text	Parameter key=value (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca stack template-show¶

Show the stack template (YAML output).

Usage:

orca stack template-show [OPTIONS] STACK_NAME_OR_ID

Options:

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

orca stack template-validate¶

Validate a Heat template.

Examples: orca stack template-validate -t template.yaml orca stack template-validate -t template.yaml -e env.yaml

Usage:

orca stack template-validate [OPTIONS]

Options:

Name	Type	Description	Default
`--template`, `-t`	text	Template file path or URL.	`Sentinel.UNSET`
`--environment`, `-e`	text	Environment file path.	None
`--parameter`	text	Parameter key=value (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca stack topology¶

Show stack resource topology as a tree.

Usage:

orca stack topology [OPTIONS] STACK_NAME_OR_ID

Options:

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

orca stack update¶

Update a stack.

Examples: orca stack update my-stack -t template.yaml orca stack update my-stack -t template.yaml -e env.yaml --parameter key1=val1 --wait

Usage:

orca stack update [OPTIONS] STACK_NAME_OR_ID

Options:

Name	Type	Description	Default
`--template`, `-t`	text	Template file path or URL.	`Sentinel.UNSET`
`--environment`, `-e`	text	Environment file path.	None
`--parameter`	text	Parameter key=value (repeatable).	`Sentinel.UNSET`
`--timeout`	integer	Timeout in minutes.	None
`--wait`	boolean	Wait for stack to reach terminal state.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca subnet¶

Manage Neutron subnets (alias of orca network subnet).

Usage:

orca subnet [OPTIONS] COMMAND [ARGS]...

Options:

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

orca subnet create¶

Create a subnet.

Usage:

orca subnet create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--network-id`	text	Parent network ID.	`Sentinel.UNSET`
`--cidr`	text	CIDR (e.g. 10.0.0.0/24).	`Sentinel.UNSET`
`--ip-version`	choice (`4` \| `6`)	N/A	`4`
`--gateway`	text	Gateway IP. Auto if omitted.	None
`--dhcp` / `--no-dhcp`	boolean	Enable DHCP.	`True`
`--dns`	text	DNS nameserver (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca subnet delete¶

Delete a subnet.

Usage:

orca subnet delete [OPTIONS] SUBNET_ID

Options:

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

orca subnet inspect¶

Full inspection of a subnet — fields + IP usage + attached ports + servers.

Cross-references three Neutron endpoints so you don't have to run subnet show + port list + ip-availability show by hand:

GET /subnets/{id} — the subnet fields
GET /network-ip-availabilities/{network_id} — IP usage per subnet
GET /ports?fixed_ips=subnet_id=<id> — who actually uses each IP

For each port, follow device_id when device_owner is compute:* to surface the server name (single Nova servers/{id} GET per attached VM).

Example: orca network subnet inspect

Usage:

orca subnet inspect [OPTIONS] SUBNET_ID

Options:

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

orca subnet list¶

List subnets.

Usage:

orca subnet 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 subnet show¶

Show subnet details.

Usage:

orca subnet show [OPTIONS] SUBNET_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 subnet update¶

Update a subnet.

Usage:

orca subnet update [OPTIONS] SUBNET_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--dns-nameserver`	text	DNS nameserver IP (repeatable, replaces existing list).	`Sentinel.UNSET`
`--enable-dhcp` / `--disable-dhcp`	boolean	Enable or disable DHCP.	None
`--help`	boolean	Show this message and exit.	`False`

orca subnet update¶

Update a subnet.

Usage:

orca subnet update [OPTIONS] SUBNET_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--dns-nameserver`	text	DNS nameserver IP (repeatable, replaces existing list).	`Sentinel.UNSET`
`--enable-dhcp` / `--disable-dhcp`	boolean	Enable or disable DHCP.	None
`--help`	boolean	Show this message and exit.	`False`

orca subnet update¶

Update a subnet.

Usage:

orca subnet update [OPTIONS] SUBNET_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--dns-nameserver`	text	DNS nameserver IP (repeatable, replaces existing list).	`Sentinel.UNSET`
`--enable-dhcp` / `--disable-dhcp`	boolean	Enable or disable DHCP.	None
`--help`	boolean	Show this message and exit.	`False`

orca subnet-pool¶

Manage Neutron subnet pools for automatic IP allocation.

Usage:

orca subnet-pool [OPTIONS] COMMAND [ARGS]...

Options:

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

orca subnet-pool create¶

Create a subnet pool.

Example: orca subnet-pool create \ --name my-pool \ --pool-prefix 10.0.0.0/8 \ --default-prefix-length 24

Usage:

orca subnet-pool create [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Pool name.	`Sentinel.UNSET`
`--pool-prefix`	text	CIDR prefix for the pool (repeatable).	`Sentinel.UNSET`
`--default-prefix-length`	integer	Default prefix length for subnets from this pool.	None
`--min-prefix-length`	integer	Minimum prefix length.	None
`--max-prefix-length`	integer	Maximum prefix length.	None
`--shared`	boolean	Make the pool shared.	`False`
`--default`	boolean	Set as the default pool.	`False`
`--description`	text	Description.	None
`--help`	boolean	Show this message and exit.	`False`

orca subnet-pool delete¶

Delete a subnet pool.

Usage:

orca subnet-pool delete [OPTIONS] POOL_ID

Options:

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

orca subnet-pool list¶

List subnet pools.

Usage:

orca subnet-pool list [OPTIONS]

Options:

Name	Type	Description	Default
`--shared`	boolean	Show only shared pools.	`False`
`--default`	boolean	Show only the default 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 subnet-pool set¶

Update a subnet pool.

Usage:

orca subnet-pool set [OPTIONS] POOL_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--default-prefix-length`	integer	New default prefix length.	None
`--pool-prefix`	text	Add a prefix to the pool (repeatable).	`Sentinel.UNSET`
`--default` / `--no-default`	boolean	Set or unset as the default pool.	None
`--help`	boolean	Show this message and exit.	`False`

orca subnet-pool show¶

Show subnet pool details.

Usage:

orca subnet-pool show [OPTIONS] POOL_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 subnet-pool unset¶

Remove address prefixes from a subnet pool.

Neutron has no atomic "remove prefix" endpoint — we fetch the current list, subtract, and PUT the result back. Other concurrent writes lose; race-tolerant patterns should rebuild the pool.

Example: orca subnet-pool unset --prefix 10.0.0.0/16

Usage:

orca subnet-pool unset [OPTIONS] POOL_ID

Options:

Name	Type	Description	Default
`--prefix`	text	CIDR prefix to drop from the pool (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca tld¶

Manage Designate Top-Level Domains (admin).

Usage:

orca tld [OPTIONS] COMMAND [ARGS]...

Options:

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

orca tld create¶

Create a TLD (admin).

Usage:

orca tld create [OPTIONS] NAME

Options:

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

orca tld delete¶

Delete a TLD (admin).

Usage:

orca tld delete [OPTIONS] TLD_ID

Options:

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

orca tld list¶

List allowed TLDs (admin).

Usage:

orca tld 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 tld set¶

Update a Designate TLD.

Usage:

orca tld set [OPTIONS] TLD_ID

Options:

Name	Type	Description	Default
`--name`	text	New TLD name (e.g. `com`).	None
`--description`	text	Update the description.	None
`--help`	boolean	Show this message and exit.	`False`

orca tld show¶

Show a Designate TLD.

Usage:

orca tld show [OPTIONS] TLD_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 token¶

Manage Keystone tokens.

Usage:

orca token [OPTIONS] COMMAND [ARGS]...

Options:

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

orca token issue¶

Issue a token for the current credentials (show token details).

Usage:

orca token issue [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 token revoke¶

Revoke a token.

Usage:

orca token revoke [OPTIONS] TOKEN_ID

Options:

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

orca trait¶

Placement traits — OSC parity.

Usage:

orca trait [OPTIONS] COMMAND [ARGS]...

Options:

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

orca trait create¶

Create a custom trait (must start with CUSTOM_).

Usage:

orca trait create [OPTIONS] NAME

Options:

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

orca trait delete¶

Delete a custom trait.

Usage:

orca trait delete [OPTIONS] NAME

Options:

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

orca trait list¶

List traits.

Usage:

orca trait list [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Filter traits by name prefix.	None
`--associated`	boolean	Only traits associated with a resource provider.	`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 trait show¶

Show a trait (existence check — Placement traits have no body).

Equivalent to openstack trait show. Raises OrcaCLIError if the trait does not exist.

Usage:

orca trait show [OPTIONS] NAME

Options:

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

orca trunk¶

Manage Neutron trunks (VLAN trunk ports).

Usage:

orca trunk [OPTIONS] COMMAND [ARGS]...

Options:

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

orca trunk add-subport¶

Add a sub-port to a trunk.

Usage:

orca trunk add-subport [OPTIONS] TRUNK_ID

Options:

Name	Type	Description	Default
`--port`	text	Sub-port port ID.	`Sentinel.UNSET`
`--segmentation-type`	choice (`vlan` \| `inherit`)	Segmentation type.	`vlan`
`--segmentation-id`	integer	VLAN ID (1–4094).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca trunk create¶

Create a trunk.

Usage:

orca trunk create [OPTIONS]

Options:

Name	Type	Description	Default
`--port`	text	Parent port ID (the trunk port).	`Sentinel.UNSET`
`--name`	text	Trunk name.	None
`--description`	text	Description.	None
`--disable`	boolean	Create trunk in administratively down state.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca trunk delete¶

Delete a trunk.

Usage:

orca trunk delete [OPTIONS] TRUNK_ID

Options:

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

orca trunk list¶

List trunks.

Usage:

orca trunk 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 trunk remove-subport¶

Remove a sub-port from a trunk.

Usage:

orca trunk remove-subport [OPTIONS] TRUNK_ID

Options:

Name	Type	Description	Default
`--port`	text	Sub-port port ID to remove.	`Sentinel.UNSET`
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca trunk set¶

Update a trunk.

Usage:

orca trunk set [OPTIONS] TRUNK_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--enable` / `--disable`	boolean	Enable or disable the trunk.	None
`--help`	boolean	Show this message and exit.	`False`

orca trunk show¶

Show trunk details.

Usage:

orca trunk show [OPTIONS] TRUNK_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 trunk subport¶

Manage sub-ports on a trunk.

Usage:

orca trunk subport [OPTIONS] COMMAND [ARGS]...

Options:

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

orca trunk subport add¶

Add a sub-port to a trunk.

Usage:

orca trunk subport add [OPTIONS] TRUNK_ID

Options:

Name	Type	Description	Default
`--port`	text	Sub-port port ID.	`Sentinel.UNSET`
`--segmentation-type`	choice (`vlan` \| `inherit`)	Segmentation type.	`vlan`
`--segmentation-id`	integer	VLAN ID (1–4094).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca trunk subport list¶

List sub-ports on a trunk.

Usage:

orca trunk subport list [OPTIONS] TRUNK_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 trunk subport remove¶

Remove a sub-port from a trunk.

Usage:

orca trunk subport remove [OPTIONS] TRUNK_ID

Options:

Name	Type	Description	Default
`--port`	text	Sub-port port ID to remove.	`Sentinel.UNSET`
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca trunk subport-list¶

List sub-ports on a trunk.

Usage:

orca trunk subport-list [OPTIONS] TRUNK_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 trunk unset¶

Clear optional fields on a trunk (description, …).

Usage:

orca trunk unset [OPTIONS] TRUNK_ID

Options:

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

orca trust¶

Manage Keystone trusts (token delegation).

Usage:

orca trust [OPTIONS] COMMAND [ARGS]...

Options:

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

orca trust create¶

Create a trust (delegation from trustor to trustee).

Example: orca trust create \ --trustor \ --trustee \ --project \ --role member \ --impersonate

Usage:

orca trust create [OPTIONS]

Options:

Name	Type	Description	Default
`--trustor`	text	Trustor user ID (delegating identity).	`Sentinel.UNSET`
`--trustee`	text	Trustee user ID (receiving delegation).	`Sentinel.UNSET`
`--project`	text	Project ID for the trust scope.	None
`--role`	text	Role name to delegate (repeatable).	`Sentinel.UNSET`
`--impersonate` / `--no-impersonate`	boolean	Allow trustee to impersonate trustor.	`False`
`--expires-at`	text	Expiry datetime in ISO 8601 (e.g. 2026-12-31T23:59:59Z).	None
`--uses`	integer	Maximum number of times the trust can be used.	None
`--help`	boolean	Show this message and exit.	`False`

orca trust delete¶

Delete a trust.

Usage:

orca trust delete [OPTIONS] TRUST_ID

Options:

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

orca trust list¶

List trusts.

Usage:

orca trust list [OPTIONS]

Options:

Name	Type	Description	Default
`--trustor`	text	Filter by trustor user ID.	None
`--trustee`	text	Filter by trustee user 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 trust show¶

Show trust details.

Usage:

orca trust show [OPTIONS] TRUST_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 tsigkey¶

Manage Designate TSIG keys (admin).

Usage:

orca tsigkey [OPTIONS] COMMAND [ARGS]...

Options:

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

orca tsigkey create¶

Create a TSIG key.

Usage:

orca tsigkey create [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	TSIG key name.	`Sentinel.UNSET`
`--algorithm`	choice (`hmac-md5` \| `hmac-sha1` \| `hmac-sha224` \| `hmac-sha256` \| `hmac-sha384` \| `hmac-sha512`)	N/A	`Sentinel.UNSET`
`--secret`	text	Base64 shared secret.	`Sentinel.UNSET`
`--scope`	choice (`POOL` \| `ZONE`)	Scope of the key.	`POOL`
`--resource-id`	text	UUID of the pool (scope=POOL) or zone (scope=ZONE).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca tsigkey delete¶

Delete a TSIG key.

Usage:

orca tsigkey delete [OPTIONS] TSIGKEY_ID

Options:

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

orca tsigkey list¶

List TSIG keys.

Usage:

orca tsigkey 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 tsigkey set¶

Update a TSIG key.

Usage:

orca tsigkey set [OPTIONS] TSIGKEY_ID

Options:

Name	Type	Description	Default
`--name`	text	N/A	None
`--algorithm`	choice (`hmac-md5` \| `hmac-sha1` \| `hmac-sha224` \| `hmac-sha256` \| `hmac-sha384` \| `hmac-sha512`)	N/A	None
`--secret`	text	N/A	None
`--scope`	choice (`POOL` \| `ZONE`)	N/A	None
`--resource-id`	text	N/A	None
`--help`	boolean	Show this message and exit.	`False`

orca tsigkey show¶

Show a TSIG key.

Usage:

orca tsigkey show [OPTIONS] TSIGKEY_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 usage¶

Inspect Nova tenant usage.

With no sub-command, runs usage show for the current project (backward-compatible). OSC parity: usage show and usage list.

Usage:

orca usage [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--start`	text	Start date (YYYY-MM-DD). Default: 30 days ago.	None
`--end`	text	End date (YYYY-MM-DD). Default: today.	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 usage list¶

List per-project resource usage across the whole cloud (admin).

Parity with openstack usage list — hits Nova /os-simple-tenant-usage without a tenant filter, which returns one row per project active during the window.

Usage:

orca usage list [OPTIONS]

Options:

Name	Type	Description	Default
`--start`	text	Start date (YYYY-MM-DD). Default: 30 days ago.	None
`--end`	text	End date (YYYY-MM-DD). Default: today.	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 usage show¶

Show CPU/RAM/disk hours and per-server breakdown for one project.

Examples: orca usage show orca usage show --start 2026-04-01 --end 2026-04-14 orca usage show --project

Usage:

orca usage show [OPTIONS]

Options:

Name	Type	Description	Default
`--project`	text	Project ID (default: current project).	`Sentinel.UNSET`
`--start`	text	Start date (YYYY-MM-DD). Default: 30 days ago.	None
`--end`	text	End date (YYYY-MM-DD). Default: today.	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 user¶

Manage users (Keystone v3).

Usage:

orca user [OPTIONS] COMMAND [ARGS]...

Options:

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

orca user create¶

Create a user.

Usage:

orca user create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--password`	text	User password.	`Sentinel.UNSET`
`--email`	text	Email address.	None
`--description`	text	Description.	None
`--domain`	text	Domain ID.	None
`--project`	text	Default project ID.	None
`--enable` / `--disable`	boolean	Enable or disable the user.	`True`
`--help`	boolean	Show this message and exit.	`False`

orca user delete¶

Delete a user.

Usage:

orca user delete [OPTIONS] USER_ID

Options:

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

orca user list¶

List users.

Usage:

orca user list [OPTIONS]

Options:

Name	Type	Description	Default
`--domain`	text	Filter by domain name or ID.	None
`--project`	text	Filter by project ID.	None
`--enabled` / `--disabled`	boolean	Filter by enabled state.	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 user password¶

Manage a user's password (admin).

Usage:

orca user password [OPTIONS] COMMAND [ARGS]...

Options:

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

orca user password set¶

Set a user's password (admin).

Usage:

orca user password set [OPTIONS] USER_ID

Options:

Name	Type	Description	Default
`--password`	text	New password.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca user set¶

Update a user.

Usage:

orca user set [OPTIONS] USER_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--email`	text	New email.	None
`--description`	text	New description.	None
`--password`	text	New password.	None
`--enable` / `--disable`	boolean	Enable or disable.	None
`--help`	boolean	Show this message and exit.	`False`

orca user set-password¶

Set a user's password (admin).

Usage:

orca user set-password [OPTIONS] USER_ID

Options:

Name	Type	Description	Default
`--password`	text	New password.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca user show¶

Show user details.

Usage:

orca user show [OPTIONS] USER_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 versions¶

List API versions advertised by Keystone.

Usage:

orca versions [OPTIONS] COMMAND [ARGS]...

Options:

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

orca versions show¶

List Keystone API versions and their state (stable / deprecated).

Usage:

orca versions show [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¶

Manage block storage volumes & snapshots.

Usage:

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

Options:

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

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`

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`

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`

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`

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`

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`

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`

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`

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`

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`

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`

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`

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`

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`

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`

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`

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`

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`

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`

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`

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`

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`

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`

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`

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`

orca watch¶

Live dashboard — auto-refreshing project overview.

Usage:

orca watch [OPTIONS]

Options:

Name	Type	Description	Default
`--interval`, `-i`	integer range (`1` and above)	Refresh interval in seconds.	`10`
`--help`	boolean	Show this message and exit.	`False`

orca zone¶

Manage DNS zones (Designate).

Usage:

orca zone [OPTIONS] COMMAND [ARGS]...

Options:

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

orca zone abandon¶

Drop a zone from Designate without notifying the backend (admin).

Usage:

orca zone abandon [OPTIONS] ZONE_ID

Options:

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

orca zone axfr¶

Trigger an AXFR transfer on a secondary zone.

Usage:

orca zone axfr [OPTIONS] ZONE_ID

Options:

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

orca zone blacklist¶

Manage DNS zone blacklists (admin).

Usage:

orca zone blacklist [OPTIONS] COMMAND [ARGS]...

Options:

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

orca zone blacklist create¶

Add a blacklist rule (regex pattern matched against zone names).

Usage:

orca zone blacklist create [OPTIONS] PATTERN

Options:

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

orca zone blacklist delete¶

Delete a blacklist rule.

Usage:

orca zone blacklist delete [OPTIONS] BLACKLIST_ID

Options:

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

orca zone blacklist list¶

List blacklist rules.

Usage:

orca zone blacklist 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 zone blacklist set¶

Update a blacklist rule.

Usage:

orca zone blacklist set [OPTIONS] BLACKLIST_ID

Options:

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

orca zone blacklist show¶

Show a blacklist rule.

Usage:

orca zone blacklist show [OPTIONS] BLACKLIST_ID

Options:

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

orca zone create¶

Create a DNS zone.

NAME must be a fully-qualified domain name ending with a dot, e.g.: orca zone create example.com. --email admin@example.com

Usage:

orca zone create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--email`	text	Zone administrator email.	`Sentinel.UNSET`
`--ttl`	integer	Default TTL in seconds.	None
`--description`	text	Zone description.	None
`--type`	choice (`PRIMARY` \| `SECONDARY`)	Zone type.	`PRIMARY`
`--masters`	text	Master servers (for SECONDARY zones, repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca zone delete¶

Delete a DNS zone.

ZONE can be a zone ID or name.

Usage:

orca zone delete [OPTIONS] ZONE

Options:

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

orca zone export¶

Manage zone export tasks (BIND-format).

Usage:

orca zone export [OPTIONS] COMMAND [ARGS]...

Options:

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

orca zone export create¶

Trigger a zone export and stream the resulting BIND file.

Examples: orca zone export create example.com. orca zone export create example.com. --file example.com.zone

Usage:

orca zone export create [OPTIONS] ZONE

Options:

Name	Type	Description	Default
`--file`	path	Write zone file to this path (default: stdout).	None
`--help`	boolean	Show this message and exit.	`False`

orca zone export delete¶

Delete a recorded export task.

Usage:

orca zone export delete [OPTIONS] EXPORT_ID

Options:

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

orca zone export list¶

List recorded zone export tasks (OSC parity).

Usage:

orca zone export 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 zone export show¶

Show a zone export task.

Usage:

orca zone export show [OPTIONS] EXPORT_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 zone export showfile¶

Fetch the BIND content produced by a completed zone export.

Usage:

orca zone export showfile [OPTIONS] EXPORT_ID

Options:

Name	Type	Description	Default
`--file`	path	Write the BIND file to this path (default: stdout).	None
`--help`	boolean	Show this message and exit.	`False`

orca zone import¶

Manage zone import tasks (BIND-format).

Usage:

orca zone import [OPTIONS] COMMAND [ARGS]...

Options:

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

orca zone import create¶

Import a zone from a BIND-format zone file.

Example: orca zone import create --file example.com.zone

Usage:

orca zone import create [OPTIONS]

Options:

Name	Type	Description	Default
`--file`	path	BIND-format zone file to import.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca zone import delete¶

Delete a recorded import task.

Usage:

orca zone import delete [OPTIONS] IMPORT_ID

Options:

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

orca zone import list¶

List recorded zone import tasks (OSC parity).

Usage:

orca zone import 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 zone import show¶

Show a zone import task.

Usage:

orca zone import show [OPTIONS] IMPORT_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 zone list¶

List DNS zones.

Usage:

orca zone 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 zone move¶

Move a zone to a different project (admin, OSC zone move).

Usage:

orca zone move [OPTIONS] ZONE_ID_OR_NAME

Options:

Name	Type	Description	Default
`--project`	text	Destination project ID for the zone.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca zone reverse-lookup¶

Find PTR records for an IP address.

Queries Designate reverse DNS for floating IPs and searches for matching in-addr.arpa / ip6.arpa zones.

Examples: orca zone reverse-lookup 192.0.2.1

Usage:

orca zone reverse-lookup [OPTIONS] IP

Options:

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

orca zone set¶

Update a DNS zone.

ZONE can be a zone ID or name.

Usage:

orca zone set [OPTIONS] ZONE

Options:

Name	Type	Description	Default
`--email`	text	Zone administrator email.	None
`--ttl`	integer	Default TTL in seconds.	None
`--description`	text	Zone description.	None
`--help`	boolean	Show this message and exit.	`False`

Share a zone with other projects.

Usage:

orca zone share [OPTIONS] COMMAND [ARGS]...

Options:

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

Share a zone with a target project.

Usage:

orca zone share create [OPTIONS] ZONE_ID

Options:

Name	Type	Description	Default
`--target-project`	text	Project ID to share the zone with.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

Revoke a zone share.

Usage:

orca zone share delete [OPTIONS] ZONE_ID SHARE_ID

Options:

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

List share grants on a zone.

Usage:

orca zone share list [OPTIONS] ZONE_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`

Show a single zone share.

Usage:

orca zone share show [OPTIONS] ZONE_ID SHARE_ID

Options:

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

orca zone show¶

Show DNS zone details.

ZONE can be a zone ID or name.

Usage:

orca zone show [OPTIONS] ZONE

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 zone tld¶

Manage allowed TLDs (admin).

Usage:

orca zone tld [OPTIONS] COMMAND [ARGS]...

Options:

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

orca zone tld create¶

Create a TLD (admin).

Usage:

orca zone tld create [OPTIONS] NAME

Options:

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

orca zone tld delete¶

Delete a TLD (admin).

Usage:

orca zone tld delete [OPTIONS] TLD_ID

Options:

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

orca zone tld list¶

List allowed TLDs (admin).

Usage:

orca zone tld 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 zone tld set¶

Update a Designate TLD.

Usage:

orca zone tld set [OPTIONS] TLD_ID

Options:

Name	Type	Description	Default
`--name`	text	New TLD name (e.g. `com`).	None
`--description`	text	Update the description.	None
`--help`	boolean	Show this message and exit.	`False`

orca zone tld show¶

Show a Designate TLD.

Usage:

orca zone tld show [OPTIONS] TLD_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 zone tld-create¶

Create a TLD (admin).

Usage:

orca zone tld-create [OPTIONS] NAME

Options:

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

orca zone tld-delete¶

Delete a TLD (admin).

Usage:

orca zone tld-delete [OPTIONS] TLD_ID

Options:

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

orca zone tld-list¶

List allowed TLDs (admin).

Usage:

orca zone tld-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 zone transfer¶

Manage zone transfer requests and accepts.

Usage:

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

Options:

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

orca zone transfer accept¶

Manage zone transfer accepts (OSC parity).

Usage:

orca zone transfer accept [OPTIONS] COMMAND [ARGS]...

Options:

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

orca zone transfer accept list¶

List all zone-transfer accepts visible to the caller.

Usage:

orca zone transfer accept 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 zone transfer accept request¶

Submit an accept for a pending zone-transfer request.

Usage:

orca zone transfer accept request [OPTIONS] TRANSFER_ID KEY

Options:

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

orca zone transfer accept show¶

Show a zone-transfer accept by ID.

Usage:

orca zone transfer accept show [OPTIONS] ACCEPT_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 zone transfer request¶

Manage zone transfer requests (sender side).

Usage:

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

Options:

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

orca zone transfer request create¶

Create a zone transfer request.

Usage:

orca zone transfer request create [OPTIONS] ZONE_ID

Options:

Name	Type	Description	Default
`--target-project-id`	text	Restrict transfer to a specific project ID.	None
`--description`	text	Description.	None
`--help`	boolean	Show this message and exit.	`False`

orca zone transfer request delete¶

Delete a zone transfer request.

Usage:

orca zone 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 zone transfer request list¶

List zone transfer requests.

Usage:

orca zone transfer request 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 zone transfer request set¶

Update a zone-transfer request (OSC zone transfer request set).

Usage:

orca zone transfer request set [OPTIONS] TRANSFER_ID

Options:

Name	Type	Description	Default
`--description`	text	N/A	None
`--target-project`	text	Restrict the request to this target project.	None
`--help`	boolean	Show this message and exit.	`False`

orca zone transfer request show¶

Show a zone transfer request.

Usage:

orca zone 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 zone transfer-accept¶

Manage zone transfer accepts (OSC parity).

Usage:

orca zone transfer-accept [OPTIONS]

Options:

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

orca zone transfer-request-create¶

Create a zone transfer request.

Usage:

orca zone transfer-request-create [OPTIONS] ZONE_ID

Options:

Name	Type	Description	Default
`--target-project-id`	text	Restrict transfer to a specific project ID.	None
`--description`	text	Description.	None
`--help`	boolean	Show this message and exit.	`False`

orca zone transfer-request-delete¶

Delete a zone transfer request.

Usage:

orca zone 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 zone transfer-request-list¶

List zone transfer requests.

Usage:

orca zone transfer-request-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 zone transfer-request-show¶

Show a zone transfer request.

Usage:

orca zone 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 zone tree¶

Show a zone as a Rich tree grouped by record type.

Displays SOA at the top, then NS, then A/AAAA/CNAME/MX/TXT and other types — each colour-coded for quick scanning.

ZONE can be a zone ID or name.

Usage:

orca zone tree [OPTIONS] ZONE

Options:

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