`orca server`¶

Manage Nova compute instances.

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

orca server¶

Manage compute servers.

Usage:

orca server [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

add: Attach a sub-resource to a server (volume, port, network, ...).
add-fixed-ip: [deprecated, use 'server add fixed-ip' instead]
add-network: [deprecated, use 'server add network' instead]
add-port: [deprecated, use 'server add port' instead]
add-security-group: [deprecated, use 'server add security-group' instead]
attach-interface: Attach a network interface to a server (deprecated façade).
attach-volume: [deprecated, use 'server add volume' instead]
backup: Create a Nova-managed backup image with rotation.
backup_group: OSC-style server backup sub-group (Nova createBackup).
bulk: Perform an action on multiple servers at once.
clone: Clone a server — recreate one with the same config.
confirm-resize: Confirm a pending resize.
console: Inspect the server console (log, URL).
console-log: [deprecated, use 'server console log' instead]
console-url: [deprecated, use 'server console url' instead]
create: Create a new server.
create-image: [deprecated, use 'server image create' instead]
delete: Delete a server.
detach-interface: [deprecated, use 'server remove interface' instead]
detach-volume: [deprecated, use 'server remove volume' instead]
diff: Compare two servers side by side.
dump: Manage crash dumps for a server.
dump-create: [deprecated, use 'server dump create' instead]
evacuate: Evacuate a server from a failed host to another.
event: Browse Nova instance actions for a server (alias of orca event).
image: Image-level operations on a server (snapshot, ...).
interface: Network interfaces attached to a server.
list: List servers.
list-interfaces: [deprecated, use 'server interface list' instead]
list-volumes: [deprecated, use 'server volume list' instead]
live-migrate: Live-migrate a server (deprecated — use 'server migrate --live').
lock: Lock a server (prevent actions by non-admin).
metadata: Read or modify server metadata.
metadata-list: [deprecated, use 'server metadata list' instead]
migrate: Migrate a server to another host (cold by default).
migration: Inspect or control server migrations.
migration-abort: [deprecated, use 'server migration abort' instead]
migration-force-complete: [deprecated, use 'server migration force-complete' instead]
migration-list: [deprecated, use 'server migration list' instead]
migration-show: [deprecated, use 'server migration show' instead]
password: Retrieve and decrypt the server admin password.
pause: Pause a server (freeze in memory).
port-forward: Create an SSH tunnel (port forward) to a server.
reboot: Reboot a server.
rebuild: Rebuild a server with a new image (reinstall).
remove: Detach a sub-resource from a server.
remove-fixed-ip: [deprecated, use 'server remove fixed-ip' instead]
remove-network: [deprecated, use 'server remove network' instead]
remove-port: [deprecated, use 'server remove port' instead]
remove-security-group: [deprecated, use 'server remove security-group' instead]
rename: Rename a server.
rescue: Put a server in rescue mode.
resize: Resize a server to a new flavor.
restore: Restore a soft-deleted server.
resume: Resume a suspended server.
revert-resize: Revert a pending resize (restore original flavor).
server-group: Manage server groups (Nova).
set: Set server properties, metadata, tags, or admin password.
shelve: Shelve a server (snapshot + shut down, frees resources).
show: Show server details.
snapshot: Snapshot a server AND all its attached volumes.
ssh: SSH into a server by name or ID.
start: Start (resume) a stopped server.
stop: Stop (shut down) a server.
suspend: Suspend a server (save to disk).
tag: Read or modify server tags.
tag-list: [deprecated, use 'server tag list' instead]
unlock: Unlock a locked server.
unpause: Unpause a paused server.
unrescue: Exit rescue mode.
unset: Remove metadata keys or tags from a server.
unshelve: Unshelve (restore) a shelved server.
volume: Volumes attached to a server.
wait: Wait for a server to reach a target status.

orca server add¶

Attach a sub-resource to a server (volume, port, network, ...).

Usage:

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

Options:

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

Subcommands

fixed-ip: Add a fixed IP from a network to a server.
floating-ip: Associate a floating IP with a server (OSC parity).
network: Attach a network to a server (creates a new port automatically).
port: Attach an existing Neutron port to a server.
security-group: Add a security group to a running server.
volume: Attach a volume to a server.

orca server add fixed-ip¶

Add a fixed IP from a network to a server.

Example: orca server add-fixed-ip

Usage:

orca server add fixed-ip [OPTIONS] SERVER_ID NETWORK_ID

Options:

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

orca server add floating-ip¶

Associate a floating IP with a server (OSC parity).

IP_ADDRESS may be either the floating IP itself (e.g. 172.24.4.10) or its ID.

Examples: orca server add floating-ip 172.24.4.10 orca server add floating-ip 172.24.4.10 --fixed-ip-address 10.0.0.5

Usage:

orca server add floating-ip [OPTIONS] SERVER_ID IP_ADDRESS

Options:

Name	Type	Description	Default
`--fixed-ip-address`	text	Bind the FIP to a specific fixed IP of the server (otherwise the first port is chosen).	None
`--help`	boolean	Show this message and exit.	`False`

orca server add network¶

Attach a network to a server (creates a new port automatically).

Examples: orca server add network orca server add network --fixed-ip 10.0.0.5

Usage:

orca server add network [OPTIONS] SERVER_ID NETWORK_ID

Options:

Name	Type	Description	Default
`--fixed-ip`	text	Pin the new port to a specific fixed IP on the network.	None
`--help`	boolean	Show this message and exit.	`False`

orca server add port¶

Attach an existing Neutron port to a server.

Example: orca server add-port

Usage:

orca server add port [OPTIONS] SERVER_ID PORT_ID

Options:

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

orca server add security-group¶

Add a security group to a running server.

Usage:

orca server add security-group [OPTIONS] SERVER_ID SECURITY_GROUP

Options:

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

orca server add volume¶

Attach a volume to a server.

Examples: orca server attach-volume orca server attach-volume --device /dev/vdc

Usage:

orca server add volume [OPTIONS] SERVER_ID VOLUME_ID

Options:

Name	Type	Description	Default
`--device`	text	Device name (e.g. /dev/vdb). Auto-assigned if omitted.	None
`--help`	boolean	Show this message and exit.	`False`

orca server add-fixed-ip¶

Add a fixed IP from a network to a server.

Example: orca server add-fixed-ip

Usage:

orca server add-fixed-ip [OPTIONS] SERVER_ID NETWORK_ID

Options:

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

orca server add-network¶

Attach a network to a server (creates a new port automatically).

Examples: orca server add network orca server add network --fixed-ip 10.0.0.5

Usage:

orca server add-network [OPTIONS] SERVER_ID NETWORK_ID

Options:

Name	Type	Description	Default
`--fixed-ip`	text	Pin the new port to a specific fixed IP on the network.	None
`--help`	boolean	Show this message and exit.	`False`

orca server add-port¶

Attach an existing Neutron port to a server.

Example: orca server add-port

Usage:

orca server add-port [OPTIONS] SERVER_ID PORT_ID

Options:

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

orca server add-security-group¶

Add a security group to a running server.

Usage:

orca server add-security-group [OPTIONS] SERVER_ID SECURITY_GROUP

Options:

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

orca server attach-interface¶

Attach a network interface to a server (deprecated façade).

Use one of these instead, depending on what you have: orca server add port orca server add network [--fixed-ip ]

Usage:

orca server attach-interface [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--port-id`	text	Existing port ID to attach.	None
`--net-id`	text	Network ID (creates a new port automatically).	None
`--fixed-ip`	text	Fixed IP for the new port (requires --net-id).	None
`--help`	boolean	Show this message and exit.	`False`

orca server attach-volume¶

Attach a volume to a server.

Examples: orca server attach-volume orca server attach-volume --device /dev/vdc

Usage:

orca server attach-volume [OPTIONS] SERVER_ID VOLUME_ID

Options:

Name	Type	Description	Default
`--device`	text	Device name (e.g. /dev/vdb). Auto-assigned if omitted.	None
`--help`	boolean	Show this message and exit.	`False`

orca server backup¶

Create a Nova-managed backup image with rotation.

Unlike orca server snapshot / server image create (one-shot snapshot), this triggers Nova's createBackup action which tags the produced image with the backup type and keeps only the rotation most recent images of that type.

Examples: orca server backup --name nightly --rotation 7 orca server backup --name weekly --type weekly --rotation 4

Usage:

orca server backup [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--name`	text	Backup image name.	`Sentinel.UNSET`
`--type`	text	Backup type tag (e.g. `daily`, `weekly`). Nova rotates backups per type independently.	`daily`
`--rotation`	integer	Keep at most this many backups of the same type — Nova deletes the oldest beyond it.	`7`
`--property`	text	Image metadata (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca server backup_group¶

OSC-style server backup sub-group (Nova createBackup).

Usage:

orca server backup_group [OPTIONS] COMMAND [ARGS]...

Options:

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

orca server bulk¶

Perform an action on multiple servers at once.

Examples: orca server bulk stop --name "dev-" orca server bulk delete --status ERROR --yes orca server bulk reboot --name "web-" --status ACTIVE

Usage:

orca server bulk [OPTIONS] {start|stop|reboot|delete}

Options:

Name	Type	Description	Default
`--name`	text	Filter by name (supports wildcards: dev-*).	None
`--status`	text	Filter by status (e.g. ERROR, SHUTOFF).	None
`--all`	boolean	Select all servers (use with caution).	`False`
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server clone¶

Clone a server — recreate one with the same config.

Copies flavor, network, security groups, key pair, and image from the source server into a new one. The clone's boot mode follows the same policy as orca server create: boot-from-image by default, fallback to boot-from-volume only when the flavor has disk == 0. Override with --boot-from-image / --boot-from-volume.

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

Usage:

orca server clone [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--name`	text	Name for the cloned server.	`Sentinel.UNSET`
`--disk-size`	integer	Boot volume size in GB (BFV only). Default: same as source.	None
`--boot-from-image`	boolean	Force boot from the image on the compute's local disk (requires flavor disk > 0).	`False`
`--boot-from-volume`	boolean	Force boot from a Cinder volume created from the image.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server confirm-resize¶

Confirm a pending resize.

Usage:

orca server confirm-resize [OPTIONS] SERVER_ID

Options:

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

orca server console¶

Inspect the server console (log, URL).

Usage:

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

Options:

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

Subcommands

log: Show the server console output (boot log).
url: Get a URL to access the server console (VNC/SPICE/serial).

orca server console log¶

Show the server console output (boot log).

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

Usage:

orca server console log [OPTIONS] SERVER_ID

Options:

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

orca server console url¶

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

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

Usage:

orca server console url [OPTIONS] SERVER_ID

Options:

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

orca server console-log¶

Show the server console output (boot log).

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

Usage:

orca server console-log [OPTIONS] SERVER_ID

Options:

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

orca server console-url¶

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

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

Usage:

orca server console-url [OPTIONS] SERVER_ID

Options:

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

orca server create¶

Create a new server.

By default the server boots from the image directly on the compute's local disk (flavor disk field). Flavors declared with disk=0 fall back to boot-from-volume automatically since Nova cannot boot them otherwise. Use --boot-from-image or --boot-from-volume to override the auto-detection.

Non-interactive example: orca server create \ --name my-vm \ --flavor \ --image \ --disk-size 30 \ --network \ --key-name my-key \ --wait

Interactive wizard: orca server create -i

Usage:

orca server create [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Server name.	None
`--flavor`	text	Flavor ID (see 'orca flavor list').	None
`--image`	text	Image ID (see 'orca image list').	None
`--disk-size`	integer	Boot volume size in GB.	`20`
`--network`	text	Network ID (see 'orca network list').	None
`--key-name`	text	SSH key pair name (see 'orca keypair list').	None
`--security-group`	text	Security group name (repeatable).	`Sentinel.UNSET`
`--boot-from-image`	boolean	Force boot from the image on the compute's local disk (requires flavor disk > 0).	`False`
`--boot-from-volume`	boolean	Force boot from a Cinder volume created from the image.	`False`
`--wait`	boolean	Wait until the server reaches ACTIVE status.	`False`
`--interactive`, `-i`	boolean	Step-by-step wizard — browse images, flavors, and networks interactively.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server create-image¶

Create a snapshot image from a server.

See also: For boot-from-volume instances, the resulting image is a 0-byte shell that points at a Cinder snapshot — not a downloadable image. To obtain a self-contained, transportable image, use: orca volume snapshot create --force orca volume create --snapshot-id ... orca volume upload-to-image ...

Usage:

orca server create-image [OPTIONS] SERVER_ID IMAGE_NAME

Options:

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

orca server delete¶

Delete a server.

Usage:

orca server delete [OPTIONS] SERVER_ID

Options:

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

orca server detach-interface¶

Detach a network interface (port) from a server.

Usage:

orca server detach-interface [OPTIONS] SERVER_ID PORT_ID

Options:

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

orca server detach-volume¶

Detach a volume from a server.

Usage:

orca server detach-volume [OPTIONS] SERVER_ID VOLUME_ID

Options:

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

orca server diff¶

Compare two servers side by side.

Highlights differences in flavor, image, network, security groups, status, and other configuration.

Examples: orca server diff

Usage:

orca server diff [OPTIONS] SERVER_A SERVER_B

Options:

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

orca server dump¶

Manage crash dumps for a server.

Usage:

orca server dump [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

create: Trigger a crash dump on a server (requires Nova microversion ≥ 2.17).

orca server dump create¶

Trigger a crash dump on a server (requires Nova microversion ≥ 2.17).

Sends an NMI to the server which causes the guest OS to generate a crash dump. The server must be ACTIVE.

Usage:

orca server dump create [OPTIONS] SERVER_ID

Options:

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

orca server dump-create¶

Trigger a crash dump on a server (requires Nova microversion ≥ 2.17).

Sends an NMI to the server which causes the guest OS to generate a crash dump. The server must be ACTIVE.

Usage:

orca server dump-create [OPTIONS] SERVER_ID

Options:

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

orca server evacuate¶

Evacuate a server from a failed host to another.

Examples: orca server evacuate orca server evacuate --host compute02 orca server evacuate --on-shared-storage

Usage:

orca server evacuate [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--host`	text	Target host (admin only, optional).	None
`--on-shared-storage` / `--no-shared-storage`	boolean	Whether server disks are on shared storage.	`False`
`--password`	text	Admin password for the evacuated server.	None
`--help`	boolean	Show this message and exit.	`False`

orca server event¶

Browse Nova instance actions for a server (alias of orca event).

Usage:

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

Options:

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

Subcommands

list: List instance actions for a server.
show: Show details for a single instance action, including sub-events.

orca server event list¶

List instance actions for a server.

Examples: orca event list orca event list -f json

Usage:

orca server event list [OPTIONS] SERVER_ID

Options:

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

orca server event show¶

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

Examples: orca event show

Usage:

orca server event show [OPTIONS] SERVER_ID REQUEST_ID

Options:

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

orca server image¶

Image-level operations on a server (snapshot, ...).

Usage:

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

Options:

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

Subcommands

create: Create a snapshot image from a server.

orca server image create¶

Create a snapshot image from a server.

See also: For boot-from-volume instances, the resulting image is a 0-byte shell that points at a Cinder snapshot — not a downloadable image. To obtain a self-contained, transportable image, use: orca volume snapshot create --force orca volume create --snapshot-id ... orca volume upload-to-image ...

Usage:

orca server image create [OPTIONS] SERVER_ID IMAGE_NAME

Options:

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

orca server interface¶

Network interfaces attached to a server.

Usage:

orca server interface [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

list: List network interfaces attached to a server.

orca server interface list¶

List network interfaces attached to a server.

Usage:

orca server interface list [OPTIONS] SERVER_ID

Options:

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

orca server list¶

List servers.

Usage:

orca server list [OPTIONS]

Options:

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

orca server list-interfaces¶

List network interfaces attached to a server.

Usage:

orca server list-interfaces [OPTIONS] SERVER_ID

Options:

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

orca server list-volumes¶

List volumes attached to a server.

Usage:

orca server list-volumes [OPTIONS] SERVER_ID

Options:

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

orca server live-migrate¶

Live-migrate a server (deprecated — use 'server migrate --live').

Usage:

orca server live-migrate [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--host`	text	Target host (admin only, optional).	None
`--block-migration` / `--no-block-migration`	boolean	Copy disk over the network (no shared storage needed).	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server lock¶

Lock a server (prevent actions by non-admin).

Usage:

orca server lock [OPTIONS] SERVER_ID

Options:

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

orca server metadata¶

Read or modify server metadata.

Usage:

orca server metadata [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

list: Show all metadata key/value pairs for a server.

orca server metadata list¶

Show all metadata key/value pairs for a server.

Usage:

orca server metadata list [OPTIONS] SERVER_ID

Options:

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

orca server metadata-list¶

Show all metadata key/value pairs for a server.

Usage:

orca server metadata-list [OPTIONS] SERVER_ID

Options:

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

orca server migrate¶

Migrate a server to another host (cold by default).

Examples: orca server migrate # cold migration orca server migrate --host compute02 # cold, target host orca server migrate --live # live migration orca server migrate --live --block-migration

Usage:

orca server migrate [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--host`	text	Target host (admin only, optional).	None
`--live`	boolean	Live-migrate (no downtime) instead of cold migration.	`False`
`--block-migration` / `--no-block-migration`	boolean	Live mode only: copy disk over the network (slower but no shared storage needed).	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server migration¶

Inspect or control server migrations.

Usage:

orca server migration [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

abort: Abort an in-progress live migration.
confirm-resize: Confirm a pending resize.
force-complete: Force an in-progress live migration to complete.
list: List migrations for a server.
revert-resize: Revert a pending resize (restore original flavor).
show: Show details of a specific migration.

orca server migration abort¶

Abort an in-progress live migration.

Usage:

orca server migration abort [OPTIONS] SERVER_ID MIGRATION_ID

Options:

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

orca server migration confirm-resize¶

Confirm a pending resize.

Usage:

orca server migration confirm-resize [OPTIONS] SERVER_ID

Options:

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

orca server migration force-complete¶

Force an in-progress live migration to complete.

Usage:

orca server migration force-complete [OPTIONS] SERVER_ID MIGRATION_ID

Options:

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

orca server migration list¶

List migrations for a server.

Usage:

orca server migration list [OPTIONS] SERVER_ID

Options:

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

orca server migration revert-resize¶

Revert a pending resize (restore original flavor).

Usage:

orca server migration revert-resize [OPTIONS] SERVER_ID

Options:

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

orca server migration show¶

Show details of a specific migration.

Usage:

orca server migration show [OPTIONS] SERVER_ID MIGRATION_ID

Options:

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

orca server migration-abort¶

Abort an in-progress live migration.

Usage:

orca server migration-abort [OPTIONS] SERVER_ID MIGRATION_ID

Options:

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

orca server migration-force-complete¶

Force an in-progress live migration to complete.

Usage:

orca server migration-force-complete [OPTIONS] SERVER_ID MIGRATION_ID

Options:

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

orca server migration-list¶

List migrations for a server.

Usage:

orca server migration-list [OPTIONS] SERVER_ID

Options:

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

orca server migration-show¶

Show details of a specific migration.

Usage:

orca server migration-show [OPTIONS] SERVER_ID MIGRATION_ID

Options:

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

orca server password¶

Retrieve and decrypt the server admin password.

The password is encrypted with your SSH public key at boot and stored in the server metadata. This command fetches it and decrypts it locally with your private key (RSA only).

Examples: orca server password orca server password --key ~/.ssh/orca-my-key orca server password --raw

Usage:

orca server password [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--key`	path	Path to the RSA private key used to decrypt. Tries ~/.ssh/orca-* if omitted.	None
`--raw`	boolean	Print the encrypted password without decrypting.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server pause¶

Pause a server (freeze in memory).

Usage:

orca server pause [OPTIONS] SERVER_ID

Options:

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

orca server port-forward¶

Create an SSH tunnel (port forward) to a server.

PORT_MAPPING format: LOCAL_PORT:REMOTE_HOST:REMOTE_PORT

Examples: orca server port-forward 8080:localhost:80 # local forward orca server port-forward 3306:db-server:3306 # forward to internal host orca server port-forward 9090:localhost:9090 -R # reverse tunnel orca server port-forward 5432:localhost:5432 -b # background

Usage:

orca server port-forward [OPTIONS] SERVER_ID PORT_MAPPING

Options:

Name	Type	Description	Default
`--user`, `-u`	text	SSH user. Default: 'root'.	None
`--key`, `-i`	path	Private key path.	None
`--ssh-port`, `-p`	integer	SSH port on the server.	`22`
`--reverse`, `-R`	boolean	Reverse tunnel (remote → local).	`False`
`--background`, `-b`	boolean	Run tunnel in background (-f -N).	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server reboot¶

Reboot a server.

Usage:

orca server reboot [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--hard`	boolean	Perform a hard reboot.	`False`
`--wait`	boolean	Wait until the server reaches ACTIVE status.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server rebuild¶

Rebuild a server with a new image (reinstall).

Usage:

orca server rebuild [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--image`	text	New image ID.	`Sentinel.UNSET`
`--name`	text	New server name (optional).	None
`--password`	text	New admin password (optional).	None
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server remove¶

Detach a sub-resource from a server.

Usage:

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

Options:

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

Subcommands

fixed-ip: Remove a specific fixed IP from a server.
floating-ip: Disassociate a floating IP from a server (OSC parity).
interface: Detach a network interface (port) from a server.
network: Detach all interfaces on a specific network from a server.
port: Detach a Neutron port from a server.
security-group: Remove a security group from a running server.
volume: Detach a volume from a server.

orca server remove fixed-ip¶

Remove a specific fixed IP from a server.

Example: orca server remove-fixed-ip 10.0.0.5

Usage:

orca server remove fixed-ip [OPTIONS] SERVER_ID IP_ADDRESS

Options:

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

orca server remove floating-ip¶

Disassociate a floating IP from a server (OSC parity).

Example: orca server remove floating-ip 172.24.4.10

Usage:

orca server remove floating-ip [OPTIONS] SERVER_ID IP_ADDRESS

Options:

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

orca server remove interface¶

Detach a network interface (port) from a server.

Usage:

orca server remove interface [OPTIONS] SERVER_ID PORT_ID

Options:

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

orca server remove network¶

Detach all interfaces on a specific network from a server.

Looks up interfaces by network ID and removes each one.

Example: orca server remove-network

Usage:

orca server remove network [OPTIONS] SERVER_ID NETWORK_ID

Options:

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

orca server remove port¶

Detach a Neutron port from a server.

Example: orca server remove-port

Usage:

orca server remove port [OPTIONS] SERVER_ID PORT_ID

Options:

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

orca server remove security-group¶

Remove a security group from a running server.

Usage:

orca server remove security-group [OPTIONS] SERVER_ID SECURITY_GROUP

Options:

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

orca server remove volume¶

Detach a volume from a server.

Usage:

orca server remove volume [OPTIONS] SERVER_ID VOLUME_ID

Options:

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

orca server remove-fixed-ip¶

Remove a specific fixed IP from a server.

Example: orca server remove-fixed-ip 10.0.0.5

Usage:

orca server remove-fixed-ip [OPTIONS] SERVER_ID IP_ADDRESS

Options:

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

orca server remove-network¶

Detach all interfaces on a specific network from a server.

Looks up interfaces by network ID and removes each one.

Example: orca server remove-network

Usage:

orca server remove-network [OPTIONS] SERVER_ID NETWORK_ID

Options:

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

orca server remove-port¶

Detach a Neutron port from a server.

Example: orca server remove-port

Usage:

orca server remove-port [OPTIONS] SERVER_ID PORT_ID

Options:

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

orca server remove-security-group¶

Remove a security group from a running server.

Usage:

orca server remove-security-group [OPTIONS] SERVER_ID SECURITY_GROUP

Options:

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

orca server rename¶

Rename a server.

Usage:

orca server rename [OPTIONS] SERVER_ID NEW_NAME

Options:

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

orca server rescue¶

Put a server in rescue mode.

Usage:

orca server rescue [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--image`	text	Rescue image ID (optional).	None
`--password`	text	Admin password for rescue mode.	None
`--help`	boolean	Show this message and exit.	`False`

orca server resize¶

Resize a server to a new flavor.

OSC's server resize confirm/revert form is exposed under orca server migration confirm/revert (same Nova action) — Click does not support a group with both a positional argument and sub-commands.

Usage:

orca server resize [OPTIONS] SERVER_ID

Options:

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

orca server restore¶

Restore a soft-deleted server.

Only valid when Nova is configured with soft-delete (reclaim_instance_interval > 0) and the server status is SOFT_DELETED.

Usage:

orca server restore [OPTIONS] SERVER_ID

Options:

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

orca server resume¶

Resume a suspended server.

Usage:

orca server resume [OPTIONS] SERVER_ID

Options:

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

orca server revert-resize¶

Revert a pending resize (restore original flavor).

Usage:

orca server revert-resize [OPTIONS] SERVER_ID

Options:

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

orca server server-group¶

Manage server groups (Nova).

Usage:

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

Options:

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

Subcommands

create: Create a server group.
delete: Delete a server group.
list: List server groups.
show: Show server group details.

orca server server-group create¶

Create a server group.

Policies: anti-affinity — servers on different hosts (hard) affinity — servers on same host (hard) soft-anti-affinity — prefer different hosts soft-affinity — prefer same host

Usage:

orca server server-group create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--policy`	choice (`anti-affinity` \| `affinity` \| `soft-anti-affinity` \| `soft-affinity`)	Scheduling policy.	`anti-affinity`
`--help`	boolean	Show this message and exit.	`False`

orca server server-group delete¶

Delete a server group.

Usage:

orca server server-group delete [OPTIONS] GROUP_ID

Options:

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

orca server server-group list¶

List server groups.

Usage:

orca server server-group list [OPTIONS]

Options:

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

orca server server-group show¶

Show server group details.

Usage:

orca server server-group show [OPTIONS] GROUP_ID

Options:

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

orca server set¶

Set server properties, metadata, tags, or admin password.

Examples: orca server set --name new-name orca server set --property env=prod --property team=infra orca server set --tag web --tag frontend orca server set --admin-password s3cr3t

Usage:

orca server set [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--name`	text	New display name.	None
`--property`	text	Metadata key=value (repeatable).	`Sentinel.UNSET`
`--tag`	text	Tag to set (repeatable, replaces all existing tags).	`Sentinel.UNSET`
`--admin-password`	text	New admin/root password (injected via Nova).	None
`--help`	boolean	Show this message and exit.	`False`

orca server shelve¶

Shelve a server (snapshot + shut down, frees resources).

Usage:

orca server shelve [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--wait`	boolean	Wait until the server reaches SHELVED_OFFLOADED status.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server show¶

Show server details.

Usage:

orca server show [OPTIONS] SERVER_ID

Options:

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

orca server snapshot¶

Snapshot a server AND all its attached volumes.

Creates a server image snapshot plus a Cinder snapshot for each attached volume — all in one command.

Examples: orca server snapshot orca server snapshot --name "before-upgrade"

Usage:

orca server snapshot [OPTIONS] SERVER_ID

Options:

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

orca server ssh¶

SSH into a server by name or ID.

Auto-resolves the IP (floating > fixed), the SSH user (from image os_distro metadata), and the private key (matched from the attached keypair name in ~/.ssh/).

Examples: orca server ssh web-1 # auto-detect everything orca server ssh web-1 ls /var/log # run a remote command orca server ssh web-1 -u root -i ~/.ssh/k # override user / key orca server ssh web-1 --fixed # use fixed IP orca server ssh web-1 --dry-run # print command, don't exec

Usage:

orca server ssh [OPTIONS] SERVER_ID [REMOTE_ARGS]...

Options:

Name	Type	Description	Default
`--user`, `-u`	text	SSH user. Default: auto-detected from image os_distro.	None
`--key`, `-i`	path	Private key path. Default: matched from keypair name in ~/.ssh.	None
`--port`, `-p`	integer	SSH port.	`22`
`--fixed`	boolean	Use the fixed IP instead of the floating IP.	`False`
`--dry-run`	boolean	Print the ssh command without executing it.	`False`
`--extra`	text	Extra SSH options (e.g. '-o StrictHostKeyChecking=no').	None
`--help`	boolean	Show this message and exit.	`False`

orca server start¶

Start (resume) a stopped server.

Usage:

orca server start [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--wait`	boolean	Wait until the server reaches ACTIVE status.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server stop¶

Stop (shut down) a server.

Usage:

orca server stop [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--wait`	boolean	Wait until the server reaches SHUTOFF status.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server suspend¶

Suspend a server (save to disk).

Usage:

orca server suspend [OPTIONS] SERVER_ID

Options:

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

orca server tag¶

Read or modify server tags.

Usage:

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

Options:

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

Subcommands

list: List tags on a server.

List tags on a server.

Usage:

orca server tag list [OPTIONS] SERVER_ID

Options:

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

List tags on a server.

Usage:

orca server tag-list [OPTIONS] SERVER_ID

Options:

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

orca server unlock¶

Unlock a locked server.

Usage:

orca server unlock [OPTIONS] SERVER_ID

Options:

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

orca server unpause¶

Unpause a paused server.

Usage:

orca server unpause [OPTIONS] SERVER_ID

Options:

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

orca server unrescue¶

Exit rescue mode.

Usage:

orca server unrescue [OPTIONS] SERVER_ID

Options:

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

orca server unset¶

Remove metadata keys or tags from a server.

Examples: orca server unset --property env --property team orca server unset --tag web --tag frontend

Usage:

orca server unset [OPTIONS] SERVER_ID

Options:

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

orca server unshelve¶

Unshelve (restore) a shelved server.

Usage:

orca server unshelve [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--wait`	boolean	Wait until the server reaches ACTIVE status.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca server volume¶

Volumes attached to a server.

Usage:

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

Options:

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

Subcommands

list: List volumes attached to a server.
set: Update a volume attachment (flip delete-on-termination).
set: Update a volume attachment (flip delete-on-termination).

orca server volume list¶

List volumes attached to a server.

Usage:

orca server volume list [OPTIONS] SERVER_ID

Options:

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

orca server volume set¶

Update a volume attachment (flip delete-on-termination).

Examples: orca server volume set --delete-on-termination orca server volume set --preserve-on-termination

Usage:

orca server volume set [OPTIONS] SERVER_ID VOLUME_ID

Options:

Name	Type	Description	Default
`--delete-on-termination` / `--preserve-on-termination`	boolean	Whether deleting the server should also delete this volume attachment. Requires Nova microversion 2.85 (Yoga+).	None
`--help`	boolean	Show this message and exit.	`False`

orca server volume set¶

Update a volume attachment (flip delete-on-termination).

Examples: orca server volume set --delete-on-termination orca server volume set --preserve-on-termination

Usage:

orca server volume set [OPTIONS] SERVER_ID VOLUME_ID

Options:

Name	Type	Description	Default
`--delete-on-termination` / `--preserve-on-termination`	boolean	Whether deleting the server should also delete this volume attachment. Requires Nova microversion 2.85 (Yoga+).	None
`--help`	boolean	Show this message and exit.	`False`

orca server wait¶

Wait for a server to reach a target status.

Polls the server status until it matches the target or the timeout is reached. Useful in scripts and automation.

Examples: orca server wait --status ACTIVE orca server wait --status SHUTOFF --timeout 120

Usage:

orca server wait [OPTIONS] SERVER_ID

Options:

Name	Type	Description	Default
`--status`	text	Target status to wait for.	`ACTIVE`
`--timeout`	integer	Timeout in seconds.	`300`
`--interval`	integer	Poll interval in seconds.	`5`
`--help`	boolean	Show this message and exit.	`False`