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.	None
`--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.	None
`--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-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-image¶

Request that images be cached on hosts in an aggregate.

Examples: orca aggregate cache-image orca aggregate cache-image

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 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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--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).	None
`--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.	None
`--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).	None
`--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.	_required
`--type`	choice (`gnocchi_resources_threshold` \| `gnocchi_aggregation_by_metrics_threshold` \| `gnocchi_aggregation_by_resources_threshold` \| `event` \| `composite` \| `loadbalancer_member_health` \| `threshold`)	Alarm type.	_required
`--rule`	text	Type-specific rule as a JSON string.	_required
`--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.	None
`--ok-action`	text	Webhook URL to call when entering ok state. Repeatable.	None
`--insufficient-data-action`	text	Webhook URL to call on insufficient data. Repeatable.	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.	None
`--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.	None
`--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.	None
`--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.	_required
`--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	None
`--ok-action`	text	N/A	None
`--insufficient-data-action`	text	N/A	None
`--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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--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 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
`--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.	None
`--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.	None
`--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-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.	None
`--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-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.	_required
`--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.	None
`--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.	None
`--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.	None
`--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.	None
`--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-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.	_required
`--action`	choice (`backup` \| `restore` \| `admin`)	Action type.	`backup`
`--path`	text	Path to back up or restore.	_required
`--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.	None
`--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.	None
`--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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--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.	None
`--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.	None
`--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.	None
`--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.

Usage:

orca catalog [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.	None
`--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).	None
`--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.	_required
`--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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--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.	_required
`--flavor-id`	text	Flavor ID for nodes.	_required
`--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.	None
`--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.	None
`--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.	_required
`--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.	None
`--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.	_required
`--external-network`	text	External network ID.	_required
`--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	None
`--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.	None
`--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.	None
`--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.	_required
`--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.	None
`--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 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`
`--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.	None
`--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).	_required
`--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.	None
`--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.	None
`--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).	_required
`--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.	_required
`--type`	text	Credential type (ec2, totp, cert, etc.).	_required
`--blob`	text	Credential data (JSON string or raw value).	_required
`--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.	None
`--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.	None
`--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
`--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.	None
`--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.	None
`--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.

Usage:

orca endpoint create [OPTIONS]

Options:

Name	Type	Description	Default
`--service`	text	Service ID.	_required
`--interface`	choice (`public` \| `internal` \| `admin`)	Endpoint interface.	_required
`--url`	text	Endpoint URL.	_required
`--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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--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.	None
`--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.

Usage:

orca endpoint-group create [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Endpoint group name.	_required
`--filter`	text	Filter criterion (e.g. service_id=xxx). Repeatable.	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.	None
`--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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--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	None
`--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.	None
`--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.	None
`--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.	None
`--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.	None
`--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 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.	_required
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	None
`--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.	None
`--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.	_required
`--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.	None
`--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).	None
`--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-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.	None
`--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.	_required
`--ram`	integer	RAM in MB.	_required
`--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.	None
`--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).	None
`--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.	None
`--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).	None
`--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.	_required
`--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.	_required
`--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.	None
`--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.	None
`--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.	None
`--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.	None
`--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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--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.	None
`--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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca hypervisor stats¶

Show aggregated hypervisor statistics.

Usage:

orca hypervisor stats [OPTIONS]

Options:

Name	Type	Description	Default
`--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.	None
`--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.	None
`--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.	None
`--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.	None
`--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	None
`--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.	None
`--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 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.	None
`--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

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

Usage:

orca image download [OPTIONS] IMAGE_ID

Options:

Name	Type	Description	Default
`--output`, `-o`	path	Output file path.	_required
`--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).	None
`--help`	boolean	Show this message and exit.	`False`

orca image list¶

List available images.

Usage:

orca image 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.	None
`--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.	None
`--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.	_required
`--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.	None
`--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`

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.

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.	None
`--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-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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--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-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.	None
`--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.	None
`--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).

Examples: orca image update --name new-name orca image update --visibility shared

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
`--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 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.	None
`--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.	None
`--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.	_required
`--service-id`	text	Service ID.	_required
`--resource-name`	text	Resource name.	_required
`--resource-limit`	integer	Limit value.	_required
`--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.	None
`--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.	None
`--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.	None
`--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-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.	None
`--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.	None
`--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.	_required
`--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-create¶

Create a health monitor.

Usage:

orca loadbalancer healthmonitor-create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--pool-id`	text	Pool ID.	_required
`--type`	choice (`HTTP` \| `HTTPS` \| `PING` \| `TCP` \| `TLS-HELLO` \| `UDP-CONNECT`)	N/A	_required
`--delay`	integer	Probe interval (seconds).	_required
`--timeout`	integer	Probe timeout (seconds).	_required
`--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.	None
`--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.	None
`--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.	_required
`--action`	choice (`REDIRECT_TO_POOL` \| `REDIRECT_TO_URL` \| `REJECT` \| `REDIRECT_PREFIX`)	Policy action.	_required
`--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.	None
`--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.	None
`--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.	_required
`--compare-type`	choice (`CONTAINS` \| `ENDS_WITH` \| `EQUAL_TO` \| `REGEX` \| `STARTS_WITH`)	Comparison type.	_required
`--value`	text	Value to compare against.	_required
`--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.	None
`--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.	None
`--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.	None
`--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.	_required
`--protocol`	choice (`HTTP` \| `HTTPS` \| `TCP` \| `UDP` \| `TERMINATED_HTTPS`)	N/A	_required
`--port`	integer	Listen port.	_required
`--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.	None
`--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.	None
`--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.	_required
`--port`	integer	Member port.	_required
`--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.	None
`--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.	None
`--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	_required
`--algorithm`	choice (`ROUND_ROBIN` \| `LEAST_CONNECTIONS` \| `SOURCE_IP`)	Load balancing algorithm.	_required
`--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.	None
`--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.	None
`--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.	None
`--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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--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 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.	_required
`--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.	None
`--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.	_required
`--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-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.	_required
`--aggregation-method`	text	Aggregation method (repeatable).	None
`--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.	None
`--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.	None
`--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.	_required
`--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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca metric measures¶

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 [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.	None
`--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.	_required
`--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.	None
`--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.	None
`--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.	None
`--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.	None
`--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.	None
`--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.	None
`--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.	None
`--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-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.	None
`--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.	None
`--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.	None
`--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 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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--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.	_required
`--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.

Usage:

orca network port-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.	None
`--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.	None
`--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).	None
`--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 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.	_required
`--object`	text	ID of the object to share.	_required
`--action`	choice (`access_as_shared` \| `access_as_external`)	RBAC action.	_required
`--target-project`	text	Project ID to grant access to (use '*' for all projects).	_required
`--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.	None
`--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.	None
`--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).	_required
`--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.	_required
`--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).	_required
`--nexthop`	text	Next-hop IP address.	_required
`--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.	None
`--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.	_required
`--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.	_required
`--nexthop`	text	Next-hop IP address.	_required
`--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.	_required
`--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.	None
`--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-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.	_required
`--network-type`	choice (`flat` \| `geneve` \| `gre` \| `local` \| `vlan` \| `vxlan`)	Network type.	_required
`--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.	None
`--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.	None
`--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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--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.	_required
`--cidr`	text	CIDR (e.g. 10.0.0.0/24).	_required
`--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).	None
`--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.	None
`--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.	None
`--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).	None
`--enable-dhcp` / `--disable-dhcp`	boolean	Enable or disable DHCP.	None
`--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 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-set¶

Set account-level metadata.

Usage:

orca object account-set [OPTIONS]

Options:

Name	Type	Description	Default
`--property`	text	Metadata key=value pair (repeatable).	_required
`--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).	_required
`--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.	None
`--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).	_required
`--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.	None
`--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 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.	None
`--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).	_required
`--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.	None
`--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.	None
`--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).	_required
`--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 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-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.	_required
`--required`	text	Required trait. Repeatable.	None
`--forbidden`	text	Forbidden trait. Repeatable.	None
`--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.	None
`--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.	_required
`--resource`	text	Resource class and amount, e.g. VCPU=4. Repeatable.	_required
`--project-id`	text	Consumer project UUID.	_required
`--user-id`	text	Consumer user UUID.	_required
`--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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--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.	None
`--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-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.	None
`--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.	None
`--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.	None
`--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.	_required
`--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.	None
`--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.	None
`--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.	None
`--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.	None
`--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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--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.	None
`--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.	None
`--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.	None
`--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.	None
`--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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--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 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 from-clouds¶

Import a cloud from clouds.yaml as an orca profile.

Examples: orca profile from-clouds mycloud orca profile from-clouds mycloud --name production orca profile from-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 from-openrc admin-openrc.sh orca profile from-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 list¶

List all profiles.

Usage:

orca profile list [OPTIONS]

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 regions orca -P infomaniak profile regions

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 set-color red orca profile set-color blue production orca profile set-color 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 set-region dc3-a orca profile set-region dc4-a production orca profile set-region 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 to-clouds # active profile orca profile to-clouds production # specific profile orca profile to-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 to-openrc # active profile to stdout orca profile to-openrc production # specific profile orca profile to-openrc production -o prod-openrc.sh source <(orca profile to-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).	None
`--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).	None
`--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.	None
`--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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--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-create¶

Create a QoS policy.

Usage:

orca qos policy-create [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Policy name.	_required
`--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.	None
`--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.	None
`--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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca quota¶

Show project quotas — Nova, Neutron and Cinder usage vs limits.

Usage:

orca quota [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.	None
`--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.	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.	None
`--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.	None
`--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).	_required
`--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.	None
`--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.	None
`--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.	_required
`--cost`	text	N/A	_required
`--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.	None
`--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-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.	None
`--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.	None
`--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.	None
`--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.	None
`--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).	_required
`--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.	None
`--filters`	text	Filter results (repeatable).	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.	None
`--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, …).	_required
`--record`	text	Record value (repeatable for multiple values).	_required
`--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.	None
`--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).	None
`--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.	None
`--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.	None
`--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.	None
`--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.	_required
`--resource-name`	text	Resource name (e.g. server).	_required
`--default-limit`	integer	Default limit value.	_required
`--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.	None
`--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.	None
`--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.	None
`--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-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.	None
`--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-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	N/A	`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.	None
`--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.	None
`--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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--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-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.	None
`--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).	None
`--project-access` / `--no-project-access`	boolean	Allow all project users read access.	`True`
`--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=.	None
`--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.	None
`--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.	None
`--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.	None
`--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.	_required
`--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.	None
`--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.	None
`--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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--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.	None
`--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	_required
`--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.	None
`--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 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-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).

Example: orca server add-network

Usage:

orca server add-network [OPTIONS] SERVER_ID NETWORK_ID

Options:

Name	Type	Description	Default
`--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 (port) to a server.

Examples: orca server attach-interface --port-id orca server attach-interface --net-id

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 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 boot volume size from the source server into a new one.

Examples: orca server clone --name web-02 orca server clone --name web-02 --disk-size 50

Usage:

orca server clone [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--name`	text	Name for the cloned server.	_required
`--disk-size`	integer	Boot volume size in GB. Default: same as source.	None
`--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-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 (boot from volume).

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).	None
`--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.

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-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 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.	None
`--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.	None
`--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.	None
`--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 without downtime.

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	Use block migration (copies disk, slower but 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-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¶

Cold-migrate a server to another host.

Usage:

orca server migrate [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--host`	text	Target host (admin only, optional).	None
`--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.	None
`--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.	None
`--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.	_required
`--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-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.

Usage:

orca server resize [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--flavor`	text	Target flavor ID.	_required
`--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 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).	None
`--tag`	text	Tag to set (repeatable, replaces all existing tags).	None
`--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.	None
`--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`

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).	None
`--tag`	text	Tag to remove (repeatable).	None
`--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 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.	None
`--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.	None
`--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.

Usage:

orca service create [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Service name.	_required
`--type`	text	Service type (e.g. identity, compute).	_required
`--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.	None
`--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.	None
`--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.	_required
`--sp-url`	text	Service provider SAML2 endpoint.	_required
`--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.	None
`--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.	None
`--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.	None
`--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`

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 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.	_required
`--environment`, `-e`	text	Environment file path.	None
`--parameter`	text	Parameter key=value (repeatable).	None
`--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.	_required
`--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.	None
`--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.	None
`--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.	None
`--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.	None
`--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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--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.	None
`--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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--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.	None
`--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.	None
`--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-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.	_required
`--environment`, `-e`	text	Environment file path.	None
`--parameter`	text	Parameter key=value (repeatable).	None
`--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.	_required
`--environment`, `-e`	text	Environment file path.	None
`--parameter`	text	Parameter key=value (repeatable).	None
`--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-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.	_required
`--pool-prefix`	text	CIDR prefix for the pool (repeatable).	_required
`--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.	None
`--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).	None
`--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.	None
`--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.	None
`--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 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.	_required
`--segmentation-type`	choice (`vlan` \| `inherit`)	Segmentation type.	`vlan`
`--segmentation-id`	integer	VLAN ID (1–4094).	_required
`--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).	_required
`--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.	None
`--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.	_required
`--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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--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).	_required
`--trustee`	text	Trustee user ID (receiving delegation).	_required
`--project`	text	Project ID for the trust scope.	None
`--role`	text	Role name to delegate (repeatable).	None
`--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.	None
`--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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca usage¶

Show project resource usage over a period.

Displays per-server CPU hours, RAM hours, disk usage, and uptime from the Nova simple-tenant-usage API.

Examples: orca usage orca usage --start 2026-04-01 --end 2026-04-14

Usage:

orca usage [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.	None
`--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.	None
`--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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--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.	None
`--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.	None
`--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-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.	None
`--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.	None
`--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.	_required
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	None
`--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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--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.	None
`--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.	None
`--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).	_required
`--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.	_required
`--volume-type`	text	Volume type ID (repeatable).	_required
`--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.	None
`--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.	None
`--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.	None
`--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.	None
`--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.	None
`--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).	None
`--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.	None
`--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).	None
`--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).	None
`--remove-volume`	text	Volume ID to remove from the group (repeatable).	None
`--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.	None
`--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.	None
`--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.	None
`--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).	_required
`--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 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).	None
`--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.	None
`--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).	None
`--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.	None
`--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.	_required
`--migration-policy`	choice (`never` \| `on-demand`)	Migration policy.	`never`
`--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 revert-to-snapshot

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-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.	None
`--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.	`False`
`--disable`	text	Disable the service.	`False`
`--disabled-reason`	text	Reason for disabling.	None
`--help`	boolean	Show this message and exit.	`False`

orca volume set¶

Set volume properties or metadata.

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

Usage:

orca volume set [OPTIONS] VOLUME_ID

Options:

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

orca volume set-bootable¶

Set or unset bootable flag on a volume.

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 or unset read-only flag on a volume.

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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--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.	_required
`--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.	None
`--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).	None
`--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.	None
`--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.	None
`--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.	None
`--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.	None
`--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-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.	None
`--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).	None
`--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.	None
`--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).	None
`--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.	None
`--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).	None
`--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 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 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.	_required
`--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).	None
`--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¶

Export a zone as a BIND-format zone file.

Examples: orca zone export example.com. orca zone export example.com. --file example.com.zone

Usage:

orca zone export [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 import¶

Import a zone from a BIND-format zone file.

Examples: orca zone import --file example.com.zone

Usage:

orca zone import [OPTIONS]

Options:

Name	Type	Description	Default
`--file`	path	BIND-format zone file to import.	_required
`--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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--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`

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.	None
`--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.	None
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca zone transfer-accept¶

Accept a zone transfer request.

Usage:

orca zone transfer-accept [OPTIONS] TRANSFER_ID KEY

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.	None
`--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.	None
`--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`