`orca floating-ip`¶

Allocate and associate floating IPs.

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

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`

Subcommands

associate: Associate a floating IP with a port.
bulk-release: Bulk-release floating IPs to free up unused addresses.
create: Allocate a floating IP from an external network.
delete: Release a floating IP.
disassociate: Disassociate a floating IP from its port.
list: List floating IPs.
pool: Inspect the pools (external networks) that floating IPs can come from.
port-forwarding: Manage port-forwarding rules attached to a floating IP.
set: Set floating IP properties.
show: Show floating IP details.
unset: Unset floating IP properties.

orca floating-ip associate¶

Associate a floating IP with a port.

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

Usage:

orca floating-ip associate [OPTIONS] FLOATING_IP_ID

Options:

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

orca floating-ip bulk-release¶

Bulk-release floating IPs to free up unused addresses.

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

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

Usage:

orca floating-ip bulk-release [OPTIONS]

Options:

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

orca floating-ip create¶

Allocate a floating IP from an external network.

Usage:

orca floating-ip create [OPTIONS]

Options:

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

orca floating-ip delete¶

Release a floating IP.

Usage:

orca floating-ip delete [OPTIONS] FLOATING_IP_ID

Options:

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

orca floating-ip disassociate¶

Disassociate a floating IP from its port.

Usage:

orca floating-ip disassociate [OPTIONS] FLOATING_IP_ID

Options:

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

orca floating-ip list¶

List floating IPs.

Usage:

orca floating-ip list [OPTIONS]

Options:

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

orca floating-ip pool¶

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

Usage:

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

Options:

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

Subcommands

list: List external networks usable as floating-IP pools.

orca floating-ip pool list¶

List external networks usable as floating-IP pools.

Usage:

orca floating-ip pool list [OPTIONS]

Options:

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

orca floating-ip port-forwarding¶

Manage port-forwarding rules attached to a floating IP.

Usage:

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

Options:

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

Subcommands

create: Create a port-forwarding rule.
delete: Delete a port-forwarding rule.
list: List port-forwarding rules on a floating IP.
set: Update a port-forwarding rule.
show: Show a port-forwarding rule.

orca floating-ip port-forwarding create¶

Create a port-forwarding rule.

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

Usage:

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

Options:

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

orca floating-ip port-forwarding delete¶

Delete a port-forwarding rule.

Usage:

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

Options:

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

orca floating-ip port-forwarding list¶

List port-forwarding rules on a floating IP.

Usage:

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

Options:

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

orca floating-ip port-forwarding set¶

Update a port-forwarding rule.

Usage:

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

Options:

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

orca floating-ip port-forwarding show¶

Show a port-forwarding rule.

Usage:

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

Options:

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

orca floating-ip set¶

Set floating IP properties.

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

Usage:

orca floating-ip set [OPTIONS] FLOATING_IP_ID

Options:

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

orca floating-ip show¶

Show floating IP details.

Usage:

orca floating-ip show [OPTIONS] FLOATING_IP_ID

Options:

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

orca floating-ip unset¶

Unset floating IP properties.

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

Usage:

orca floating-ip unset [OPTIONS] FLOATING_IP_ID

Options:

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