Command Reference¶

orca organises commands by OpenStack service. Every command supports --help for inline documentation, and every page in this section is generated directly from the live CLI by mkdocs-click — they always reflect the version installed.

orca --help                  # list all command groups
orca server --help           # list all sub-commands of `server`
orca server image create --help  # detailed help for one command

For a single-page exhaustive reference, see the CLI Reference.

Compute (Nova)¶

Group	What it manages
`server`	Compute instances — full lifecycle (create, snapshot, migrate, console, attach/detach, …)
`flavor`	Flavors and their access rules
`keypair`	SSH key pairs
`aggregate`	Host aggregates
`hypervisor`	Hypervisor inventory
`availability-zone`	Availability zones
`compute-service`	Nova back-end services
`server-group`	Anti-affinity / affinity groups
`event`	Instance event history
`usage`	Tenant usage statistics

Image (Glance)¶

Group	What it manages
`image`	Images, members, tasks, cache, stores

Block Storage (Cinder, Freezer)¶

Group	What it manages
`volume`	Volumes, snapshots, backups, attachments, types, QoS, transfers, groups. Includes `volume upload-to-image` for cross-cloud BFV migration.
`backup`	Trilio Freezer scheduled backups

Object Storage (Swift)¶

Group	What it manages
`container`	Containers
`object`	Objects

Network (Neutron)¶

Group	What it manages
`network`	Networks, subnets, ports, routers (with nested `router add/remove/set/unset`)
`floating-ip`	Allocation and association
`security-group`	Security groups and rules
`qos`	QoS policies and rules
`subnet-pool`	Subnet pools
`trunk`	Trunk ports and sub-ports

Load Balancer (Octavia)¶

Group	What it manages
`loadbalancer`	LBs, listeners, pools, members, health monitors, L7 policies, amphora

DNS (Designate)¶

Group	What it manages
`zone`	Zones and zone transfers
`recordset`	Records inside a zone

Orchestration & Clusters¶

Group	What it manages
`stack`	Heat stacks, resources, templates
`cluster`	Magnum clusters and templates

Telemetry & Rating¶

Group	What it manages
`metric`	Gnocchi metrics, measures, resource types
`alarm`	Aodh alarms and history
`rating`	CloudKitty rating modules

Placement & Secrets¶

Group	What it manages
`placement`	Resource providers, traits, inventories, allocations
`secret`	Barbican secrets and containers

Identity (Keystone)¶

Group	What it manages
`user`, `project`, `domain`, `role`, `group`	Core RBAC
`policy`	Service policies
`credential`, `application-credential`, `access-rule`	Credentials and scoped tokens
`trust`, `token`, `auth`	Trust delegation, token introspection
`endpoint`, `endpoint-group`, `region`, `service`	Service catalog
`limit`, `registered-limit`	Project / system limits

Federation¶

Group	What it manages
`identity-provider`, `federation-protocol`, `mapping`, `service-provider`	Federated identity

Utilities¶

Group	What it manages
`ip`	Address WHOIS / introspection (orca-exclusive)
`limits`, `quota`	Quota inspection
`catalog`	Service catalog dump
`completion`	Shell completion install / print

Orca-exclusive¶

Command	Description
`overview`	Single-screen project dashboard
`watch`	Live auto-refreshing dashboard
`doctor`	Configuration / connectivity health check
`audit`	Cross-resource security audit
`cleanup`	Detect / delete dangling resources
`export`	Snapshot infrastructure to YAML/JSON
`find`	Locate a resource by partial ID or name
`profile`	Multi-account profile management
`setup`	Interactive credential wizard

Common Patterns¶

Confirmation prompts¶

Destructive commands ask for confirmation. Skip with -y / --yes:

orca server delete <id> -y
orca loadbalancer delete <id> --cascade -y

Output format¶

All list / show commands accept --format, --column, --fit-width, --max-width, --noindent:

orca server list --format json
orca server list --column id --column name
orca volume show <id> -f value -c id -c size

Errors¶

Every error surfaced to the user lands on the central red Error: … formatter from version 2.2.0 onward — there is no "Unexpected error: …" path on operational failures. Use --debug to log HTTP requests and retry decisions to stderr.