`orca router`¶

Manage Neutron routers (OSC-parity top-level alias of network router).

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

orca router¶

Manage Neutron routers (alias of orca network router).

Usage:

orca router [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

add: Attach a sub-resource to a router (interface, route).
create: Create a router.
delete: Delete a router.
list: List routers.
ndp-proxy: Manage IPv6 NDP proxies on a router.
remove: Detach a sub-resource from a router.
show: Show router details.
update: Update a router.
update: Update a router.
update: Update a router.

orca router add¶

Attach a sub-resource to a router (interface, route).

Usage:

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

Options:

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

Subcommands

gateway: Set an external gateway on a router (OSC router add gateway).
interface: Add a subnet interface to a router.
port: Attach an existing port to a router (OSC router add port).
route: Add a static route to a router (requires extraroute-atomic extension).
subnet: Add a subnet to a router (OSC router add subnet).

orca router add gateway¶

Set an external gateway on a router (OSC router add gateway).

Usage:

orca router add gateway [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--network`	text	External network ID to use as gateway.	`Sentinel.UNSET`
`--fixed-ip`	text	Fixed IP on the external network (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca router add interface¶

Add a subnet interface to a router.

Usage:

orca router add interface [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--subnet-id`	text	Subnet to attach.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca router add port¶

Attach an existing port to a router (OSC router add port).

Usage:

orca router add port [OPTIONS] ROUTER_ID PORT_ID

Options:

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

orca router add route¶

Add a static route to a router (requires extraroute-atomic extension).

Example: orca network router-add-route --destination 10.1.0.0/24 --nexthop 192.168.1.1

Usage:

orca router add route [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--destination`	text	Destination network (e.g. 10.1.0.0/24).	`Sentinel.UNSET`
`--nexthop`	text	Next-hop IP address.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca router add subnet¶

Add a subnet to a router (OSC router add subnet).

Usage:

orca router add subnet [OPTIONS] ROUTER_ID SUBNET_ID

Options:

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

orca router create¶

Create a router.

Usage:

orca router create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--external-network`	text	External network ID for gateway.	None
`--help`	boolean	Show this message and exit.	`False`

orca router delete¶

Delete a router.

Usage:

orca router delete [OPTIONS] ROUTER_ID

Options:

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

orca router list¶

List routers.

Usage:

orca router list [OPTIONS]

Options:

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

orca router ndp-proxy¶

Manage IPv6 NDP proxies on a router.

Usage:

orca router ndp-proxy [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

create: Create an NDP proxy.
delete: Delete an NDP proxy.
list: List NDP proxies.
set: Update an NDP proxy.
show: Show an NDP proxy.

orca router ndp-proxy create¶

Create an NDP proxy.

Usage:

orca router ndp-proxy create [OPTIONS]

Options:

Name	Type	Description	Default
`--router-id`	text	N/A	`Sentinel.UNSET`
`--port-id`	text	N/A	`Sentinel.UNSET`
`--ip-address`	text	Specific IPv6 address (autopicked if omitted).	None
`--help`	boolean	Show this message and exit.	`False`

orca router ndp-proxy delete¶

Delete an NDP proxy.

Usage:

orca router ndp-proxy delete [OPTIONS] NDP_ID

Options:

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

orca router ndp-proxy list¶

List NDP proxies.

Usage:

orca router ndp-proxy list [OPTIONS]

Options:

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

orca router ndp-proxy set¶

Update an NDP proxy.

Usage:

orca router ndp-proxy set [OPTIONS] NDP_ID

Options:

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

orca router ndp-proxy show¶

Show an NDP proxy.

Usage:

orca router ndp-proxy show [OPTIONS] NDP_ID

Options:

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

orca router remove¶

Detach a sub-resource from a router.

Usage:

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

Options:

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

Subcommands

gateway: Clear a router's external gateway (OSC router remove gateway).
interface: Remove a subnet interface from a router.
port: Detach a port from a router (OSC router remove port).
route: Remove a static route from a router (requires extraroute-atomic extension).
subnet: Remove a subnet from a router (OSC router remove subnet).

orca router remove gateway¶

Clear a router's external gateway (OSC router remove gateway).

Usage:

orca router remove gateway [OPTIONS] ROUTER_ID

Options:

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

orca router remove interface¶

Remove a subnet interface from a router.

Usage:

orca router remove interface [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--subnet-id`	text	Subnet to detach.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca router remove port¶

Detach a port from a router (OSC router remove port).

Usage:

orca router remove port [OPTIONS] ROUTER_ID PORT_ID

Options:

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

orca router remove route¶

Remove a static route from a router (requires extraroute-atomic extension).

Example: orca network router-remove-route --destination 10.1.0.0/24 --nexthop 192.168.1.1

Usage:

orca router remove route [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--destination`	text	Destination network to remove.	`Sentinel.UNSET`
`--nexthop`	text	Next-hop IP address.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca router remove subnet¶

Remove a subnet from a router (OSC router remove subnet).

Usage:

orca router remove subnet [OPTIONS] ROUTER_ID SUBNET_ID

Options:

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

orca router show¶

Show router details.

Usage:

orca router show [OPTIONS] ROUTER_ID

Options:

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

orca router update¶

Update a router.

Usage:

orca router update [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--external-network`	text	New external gateway network ID.	None
`--help`	boolean	Show this message and exit.	`False`

orca router update¶

Update a router.

Usage:

orca router update [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--external-network`	text	New external gateway network ID.	None
`--help`	boolean	Show this message and exit.	`False`

orca router update¶

Update a router.

Usage:

orca router update [OPTIONS] ROUTER_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--external-network`	text	New external gateway network ID.	None
`--help`	boolean	Show this message and exit.	`False`