Skip to content

orca network

Manage Neutron networks, subnets, ports and routers.

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

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

Subcommands

  • agent: Manage Neutron agents (admin).
  • agent-delete: [deprecated, use 'network agent delete' instead]
  • agent-list: [deprecated, use 'network agent list' instead]
  • agent-set: [deprecated, use 'network agent set' instead]
  • agent-show: [deprecated, use 'network agent show' instead]
  • auto-allocated-topology: Manage the project's auto-allocated topology.
  • auto-allocated-topology-delete: [deprecated, use 'network auto-allocated-topology delete' instead]
  • auto-allocated-topology-show: [deprecated, use 'network auto-allocated-topology show' instead]
  • create: Create a network.
  • delete: Delete a network.
  • flavor: Manage Neutron service flavors (admin SDN).
  • flavor-profile: Manage Neutron service profiles attached to flavors (admin).
  • l3-conntrack-helper: Manage L3 conntrack helper modules on a router (admin).
  • list: List networks.
  • meter: Manage Neutron metering labels (admin).
  • meter-rule: Manage Neutron metering label rules (admin).
  • port: Manage Neutron ports.
  • port-create: [deprecated, use 'network port create' instead]
  • port-delete: [deprecated, use 'network port delete' instead]
  • port-list: [deprecated, use 'network port list' instead]
  • port-show: [deprecated, use 'network port show' instead]
  • port-unset: [deprecated, use 'network port unset' instead]
  • port-update: [deprecated, use 'network port update' instead]
  • qos: Manage Neutron QoS policies and rules.
  • rbac: Manage RBAC policies on networks/qos/subnetpools/etc.
  • rbac-create: [deprecated, use 'network rbac create' instead]
  • rbac-delete: [deprecated, use 'network rbac delete' instead]
  • rbac-list: [deprecated, use 'network rbac list' instead]
  • rbac-show: [deprecated, use 'network rbac show' instead]
  • rbac-update: [deprecated, use 'network rbac update' instead]
  • router: Manage Neutron routers.
  • router-add-interface: [deprecated, use 'network router add interface' instead]
  • router-add-route: [deprecated, use 'network router add route' instead]
  • router-create: [deprecated, use 'network router create' instead]
  • router-delete: [deprecated, use 'network router delete' instead]
  • router-list: [deprecated, use 'network router list' instead]
  • router-remove-interface: [deprecated, use 'network router remove interface' instead]
  • router-remove-route: [deprecated, use 'network router remove route' instead]
  • router-set-gateway: [deprecated, use 'network router set gateway' instead]
  • router-show: [deprecated, use 'network router show' instead]
  • router-unset-gateway: [deprecated, use 'network router unset gateway' instead]
  • router-update: [deprecated, use 'network router update' instead]
  • segment: Manage network segments.
  • segment-create: [deprecated, use 'network segment create' instead]
  • segment-delete: [deprecated, use 'network segment delete' instead]
  • segment-list: [deprecated, use 'network segment list' instead]
  • segment-range: Manage network segment ID ranges (admin).
  • segment-set: [deprecated, use 'network segment set' instead]
  • segment-show: [deprecated, use 'network segment show' instead]
  • service-provider: Inspect Neutron service providers (BGP-VPN, L3, …).
  • show: Show network details.
  • subnet: Manage Neutron subnets.
  • subnet-create: [deprecated, use 'network subnet create' instead]
  • subnet-delete: [deprecated, use 'network subnet delete' instead]
  • subnet-list: [deprecated, use 'network subnet list' instead]
  • subnet-show: [deprecated, use 'network subnet show' instead]
  • subnet-update: [deprecated, use 'network subnet update' instead]
  • subport: Sub-ports of a trunk (alias of orca trunk subport).
  • topology: Display the network topology as a tree.
  • trace: Trace the full network path for a server instance.
  • trunk: Manage Neutron trunks (VLAN trunk ports).
  • update: Update a network.
  • update: Update a network.
  • update: Update a network.

orca network agent

Manage Neutron agents (admin).

Usage:

orca network agent [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • add: Bind a network or router to an agent (admin scheduler).
  • delete: Delete a Neutron agent record.
  • list: List Neutron agents.
  • remove: Unbind a network or router from an agent (admin scheduler).
  • set: Update a Neutron agent.
  • show: Show a Neutron agent's details.
orca network agent add

Bind a network or router to an agent (admin scheduler).

Usage:

orca network agent add [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • network: Bind a network to a DHCP agent.
  • router: Bind a router to an L3 agent.
orca network agent add network

Bind a network to a DHCP agent.

Usage:

orca network agent add network [OPTIONS] AGENT_ID NETWORK_ID

Options:

Name Type Description Default
--help boolean Show this message and exit. False
orca network agent add router

Bind a router to an L3 agent.

Usage:

orca network agent add router [OPTIONS] AGENT_ID ROUTER_ID

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. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--help boolean Show this message and exit. False
orca network agent remove

Unbind a network or router from an agent (admin scheduler).

Usage:

orca network agent remove [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • network: Unbind a network from a DHCP agent.
  • router: Unbind a router from an L3 agent.
orca network agent remove network

Unbind a network from a DHCP agent.

Usage:

orca network agent remove network [OPTIONS] AGENT_ID NETWORK_ID

Options:

Name Type Description Default
--help boolean Show this message and exit. False
orca network agent remove router

Unbind a router from an L3 agent.

Usage:

orca network agent remove router [OPTIONS] AGENT_ID ROUTER_ID

Options:

Name Type Description Default
--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. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--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. Sentinel.UNSET
--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. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--help boolean Show this message and exit. False

orca network auto-allocated-topology

Manage the project's auto-allocated topology.

Usage:

orca network auto-allocated-topology [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • delete: Delete the auto-allocated topology for a project.
  • show: Show or create the auto-allocated topology for a project.
  • show: Show or create the auto-allocated topology for a project.
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. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--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. Sentinel.UNSET
--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. Sentinel.UNSET
--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 flavor

Manage Neutron service flavors (admin SDN).

Usage:

orca network flavor [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • add: Attach sub-resources to a network flavor.
  • create: Create a network flavor.
  • delete: Delete a network flavor.
  • list: List network flavors.
  • remove: Detach sub-resources from a network flavor.
  • set: Update a network flavor.
  • show: Show a network flavor.
orca network flavor add

Attach sub-resources to a network flavor.

Usage:

orca network flavor add [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • profile: Attach a service profile to a flavor (OSC network flavor add profile).
orca network flavor add profile

Attach a service profile to a flavor (OSC network flavor add profile).

Usage:

orca network flavor add profile [OPTIONS] FLAVOR_ID PROFILE_ID

Options:

Name Type Description Default
--help boolean Show this message and exit. False
orca network flavor create

Create a network flavor.

Usage:

orca network flavor create [OPTIONS] NAME

Options:

Name Type Description Default
--service-type text Service type (FLAVORS, FIREWALL_V2, …). Sentinel.UNSET
--description text N/A None
--enabled / --disabled boolean N/A True
--help boolean Show this message and exit. False
orca network flavor delete

Delete a network flavor.

Usage:

orca network flavor delete [OPTIONS] FLAVOR_ID

Options:

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

List network flavors.

Usage:

orca network flavor 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 network flavor remove

Detach sub-resources from a network flavor.

Usage:

orca network flavor remove [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • profile: Detach a service profile from a flavor (OSC network flavor remove profile).
orca network flavor remove profile

Detach a service profile from a flavor (OSC network flavor remove profile).

Usage:

orca network flavor remove profile [OPTIONS] FLAVOR_ID PROFILE_ID

Options:

Name Type Description Default
--help boolean Show this message and exit. False
orca network flavor set

Update a network flavor.

Usage:

orca network flavor set [OPTIONS] FLAVOR_ID

Options:

Name Type Description Default
--name text N/A None
--description text N/A None
--enabled / --disabled boolean N/A None
--help boolean Show this message and exit. False
orca network flavor show

Show a network flavor.

Usage:

orca network 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. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--help boolean Show this message and exit. False

orca network flavor-profile

Manage Neutron service profiles attached to flavors (admin).

Usage:

orca network flavor-profile [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • create: Create a service profile.
  • delete: Delete a service profile.
  • list: List service profiles.
  • set: Update a service profile.
  • show: Show a service profile.
orca network flavor-profile create

Create a service profile.

Usage:

orca network flavor-profile create [OPTIONS]

Options:

Name Type Description Default
--driver text Backend driver class. None
--description text N/A None
--metainfo text Free-text JSON the driver consumes. None
--enabled / --disabled boolean N/A True
--help boolean Show this message and exit. False
orca network flavor-profile delete

Delete a service profile.

Usage:

orca network flavor-profile delete [OPTIONS] SP_ID

Options:

Name Type Description Default
--yes, -y boolean N/A False
--help boolean Show this message and exit. False
orca network flavor-profile list

List service profiles.

Usage:

orca network flavor-profile 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 network flavor-profile set

Update a service profile.

Usage:

orca network flavor-profile set [OPTIONS] SP_ID

Options:

Name Type Description Default
--description text N/A None
--enabled / --disabled boolean N/A None
--metainfo text N/A None
--help boolean Show this message and exit. False
orca network flavor-profile show

Show a service profile.

Usage:

orca network flavor-profile 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. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--help boolean Show this message and exit. False

orca network l3-conntrack-helper

Manage L3 conntrack helper modules on a router (admin).

Usage:

orca network l3-conntrack-helper [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • create: Attach a conntrack helper to a router.
  • delete: Detach a conntrack helper.
  • list: List conntrack helpers on a router.
  • set: Update a conntrack helper (port only — helper/protocol are immutable).
  • show: Show a conntrack helper.
orca network l3-conntrack-helper create

Attach a conntrack helper to a router.

Usage:

orca network l3-conntrack-helper create [OPTIONS] ROUTER_ID

Options:

Name Type Description Default
--helper text Helper module name (ftp, tftp, sip, h323, …). Sentinel.UNSET
--protocol choice (tcp | udp) N/A tcp
--port integer Port the helper listens on. Sentinel.UNSET
--help boolean Show this message and exit. False
orca network l3-conntrack-helper delete

Detach a conntrack helper.

Usage:

orca network l3-conntrack-helper delete [OPTIONS] ROUTER_ID CH_ID

Options:

Name Type Description Default
--yes, -y boolean N/A False
--help boolean Show this message and exit. False
orca network l3-conntrack-helper list

List conntrack helpers on a router.

Usage:

orca network l3-conntrack-helper list [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 network l3-conntrack-helper set

Update a conntrack helper (port only — helper/protocol are immutable).

Usage:

orca network l3-conntrack-helper set [OPTIONS] ROUTER_ID CH_ID

Options:

Name Type Description Default
--port integer N/A None
--help boolean Show this message and exit. False
orca network l3-conntrack-helper show

Show a conntrack helper.

Usage:

orca network l3-conntrack-helper show [OPTIONS] ROUTER_ID CH_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 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. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--help boolean Show this message and exit. False

orca network meter

Manage Neutron metering labels (admin).

Usage:

orca network meter [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • create: Create a metering label.
  • delete: Delete a metering label.
  • list: List metering labels.
  • show: Show a metering label.
orca network meter create

Create a metering label.

Usage:

orca network meter create [OPTIONS] NAME

Options:

Name Type Description Default
--description text N/A None
--shared / --unshared boolean N/A False
--help boolean Show this message and exit. False
orca network meter delete

Delete a metering label.

Usage:

orca network meter delete [OPTIONS] LABEL_ID

Options:

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

List metering labels.

Usage:

orca network meter 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 network meter show

Show a metering label.

Usage:

orca network meter show [OPTIONS] LABEL_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 network meter-rule

Manage Neutron metering label rules (admin).

Usage:

orca network meter-rule [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • create: Create a metering rule.
  • delete: Delete a metering rule.
  • list: List metering label rules.
  • show: Show a metering rule.
orca network meter-rule create

Create a metering rule.

Usage:

orca network meter-rule create [OPTIONS]

Options:

Name Type Description Default
--label-id text Metering label to attach to. Sentinel.UNSET
--direction choice (ingress | egress) N/A ingress
--remote-ip-prefix text CIDR to match (legacy alias of --source-ip-prefix). None
--source-ip-prefix text N/A None
--destination-ip-prefix text N/A None
--excluded boolean Invert the match (exclude this CIDR from accounting). False
--help boolean Show this message and exit. False
orca network meter-rule delete

Delete a metering rule.

Usage:

orca network meter-rule delete [OPTIONS] RULE_ID

Options:

Name Type Description Default
--yes, -y boolean N/A False
--help boolean Show this message and exit. False
orca network meter-rule list

List metering label rules.

Usage:

orca network meter-rule list [OPTIONS]

Options:

Name Type Description Default
--label-id text Filter by metering label. 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 network meter-rule show

Show a metering rule.

Usage:

orca network meter-rule show [OPTIONS] RULE_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 network port

Manage Neutron ports.

Usage:

orca network port [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

orca network port create

Create a port.

Usage:

orca network port create [OPTIONS]

Options:

Name Type Description Default
--network-id text Network ID. Sentinel.UNSET
--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.

Examples: orca network port list orca network port list --network-id orca network port list --subnet orca network port list --device-owner compute:nova

Usage:

orca network port list [OPTIONS]

Options:

Name Type Description Default
--network-id text Filter by network ID. None
--subnet-id, --subnet text Filter to ports that have a fixed IP in this subnet. None
--device-owner text Filter by device owner (e.g. compute:nova, network:router_interface, network:dhcp). None
--device-id text Filter by the attached resource ID (server, 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 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. Sentinel.UNSET
--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). Sentinel.UNSET
--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 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 port-create

Create a port.

Usage:

orca network port-create [OPTIONS]

Options:

Name Type Description Default
--network-id text Network ID. Sentinel.UNSET
--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.

Examples: orca network port list orca network port list --network-id orca network port list --subnet orca network port list --device-owner compute:nova

Usage:

orca network port-list [OPTIONS]

Options:

Name Type Description Default
--network-id text Filter by network ID. None
--subnet-id, --subnet text Filter to ports that have a fixed IP in this subnet. None
--device-owner text Filter by device owner (e.g. compute:nova, network:router_interface, network:dhcp). None
--device-id text Filter by the attached resource ID (server, 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 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. Sentinel.UNSET
--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). Sentinel.UNSET
--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 qos

Manage Neutron QoS policies and rules.

Usage:

orca network qos [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • policy: Manage QoS policies.
  • policy-create: [deprecated, use 'qos policy create' instead]
  • policy-delete: [deprecated, use 'qos policy delete' instead]
  • policy-list: [deprecated, use 'qos policy list' instead]
  • policy-set: [deprecated, use 'qos policy set' instead]
  • policy-show: [deprecated, use 'qos policy show' instead]
  • rule: Manage QoS rules attached to a policy.
  • rule-create: [deprecated, use 'qos rule create' instead]
  • rule-delete: [deprecated, use 'qos rule delete' instead]
  • rule-list: [deprecated, use 'qos rule list' instead]
  • rule-type: Inspect QoS rule types Neutron knows how to enforce (read-only).
orca network qos policy

Manage QoS policies.

Usage:

orca network qos policy [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • create: Create a QoS policy.
  • delete: Delete a QoS policy.
  • list: List QoS policies.
  • set: Update a QoS policy.
  • show: Show a QoS policy.
orca network qos policy create

Create a QoS policy.

Usage:

orca network qos policy create [OPTIONS]

Options:

Name Type Description Default
--name text Policy name. Sentinel.UNSET
--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 network qos policy delete

Delete a QoS policy.

Usage:

orca network 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 network qos policy list

List QoS policies.

Usage:

orca network 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. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--help boolean Show this message and exit. False
orca network qos policy set

Update a QoS policy.

Usage:

orca network 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 network qos policy show

Show a QoS policy.

Usage:

orca network 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. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--help boolean Show this message and exit. False
orca network qos policy-create

Create a QoS policy.

Usage:

orca network qos policy-create [OPTIONS]

Options:

Name Type Description Default
--name text Policy name. Sentinel.UNSET
--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 network qos policy-delete

Delete a QoS policy.

Usage:

orca network 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 network qos policy-list

List QoS policies.

Usage:

orca network 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. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--help boolean Show this message and exit. False
orca network qos policy-set

Update a QoS policy.

Usage:

orca network 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 network qos policy-show

Show a QoS policy.

Usage:

orca network 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. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--help boolean Show this message and exit. False
orca network qos rule

Manage QoS rules attached to a policy.

Usage:

orca network qos rule [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • create: Create a QoS rule.
  • delete: Delete a QoS rule.
  • list: List QoS rules for a policy.
  • set: Update an existing QoS rule.
  • show: Show details of a QoS rule.
orca network 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 network 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 network qos rule delete

Delete a QoS rule.

Usage:

orca network 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 network qos rule list

List QoS rules for a policy.

Usage:

orca network 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. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--help boolean Show this message and exit. False
orca network qos rule set

Update an existing QoS rule.

Example: orca qos rule set --type bandwidth-limit --max-kbps 2000

Usage:

orca network qos rule set [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
--max-kbps integer New max bandwidth in kbps (bandwidth-limit). None
--max-burst-kbps integer New max burst bandwidth in kbps (bandwidth-limit). None
--direction choice (ingress | egress) New traffic direction (bandwidth-limit, minimum-bandwidth). None
--dscp-mark integer New DSCP mark value (dscp-marking). None
--min-kbps integer New min bandwidth in kbps (minimum-bandwidth). None
--help boolean Show this message and exit. False
orca network qos rule show

Show details of a QoS rule.

Usage:

orca network qos rule show [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
--noindent boolean Disable JSON indentation. False
--max-width integer Maximum table 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 network 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 network 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 network qos rule-delete

Delete a QoS rule.

Usage:

orca network 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 network qos rule-list

List QoS rules for a policy.

Usage:

orca network 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. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--help boolean Show this message and exit. False
orca network qos rule-type

Inspect QoS rule types Neutron knows how to enforce (read-only).

Usage:

orca network qos rule-type [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • list: List supported QoS rule types.
  • show: Show the directions a QoS rule type supports.
orca network qos rule-type list

List supported QoS rule types.

Usage:

orca network qos rule-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. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--help boolean Show this message and exit. False
orca network qos rule-type show

Show the directions a QoS rule type supports.

Usage:

orca network qos rule-type show [OPTIONS] RULE_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. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--help boolean Show this message and exit. False

orca network rbac

Manage RBAC policies on networks/qos/subnetpools/etc.

Usage:

orca network rbac [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • create: Create an RBAC policy to share a network resource.
  • delete: Delete an RBAC policy.
  • list: List RBAC policies.
  • show: Show an RBAC policy.
  • update: Update the target project of an RBAC policy.
  • update: Update the target project of an RBAC policy.
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. Sentinel.UNSET
--object text ID of the object to share. Sentinel.UNSET
--action choice (access_as_shared | access_as_external) RBAC action. Sentinel.UNSET
--target-project text Project ID to grant access to (use '*' for all projects). Sentinel.UNSET
--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. Sentinel.UNSET
--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. Sentinel.UNSET
--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). Sentinel.UNSET
--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). Sentinel.UNSET
--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. Sentinel.UNSET
--object text ID of the object to share. Sentinel.UNSET
--action choice (access_as_shared | access_as_external) RBAC action. Sentinel.UNSET
--target-project text Project ID to grant access to (use '*' for all projects). Sentinel.UNSET
--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. Sentinel.UNSET
--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. Sentinel.UNSET
--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). Sentinel.UNSET
--help boolean Show this message and exit. False

orca network router

Manage Neutron routers.

Usage:

orca network 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 network router add

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

Usage:

orca network 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 network router add gateway

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

Usage:

orca network 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 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. Sentinel.UNSET
--help boolean Show this message and exit. False
orca network router add port

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

Usage:

orca network router add port [OPTIONS] ROUTER_ID PORT_ID

Options:

Name Type Description Default
--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). Sentinel.UNSET
--nexthop text Next-hop IP address. Sentinel.UNSET
--help boolean Show this message and exit. False
orca network router add subnet

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

Usage:

orca network router add subnet [OPTIONS] ROUTER_ID SUBNET_ID

Options:

Name Type Description Default
--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. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--help boolean Show this message and exit. False
orca network router ndp-proxy

Manage IPv6 NDP proxies on a router.

Usage:

orca network 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 network router ndp-proxy create

Create an NDP proxy.

Usage:

orca network 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 network router ndp-proxy delete

Delete an NDP proxy.

Usage:

orca network 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 network router ndp-proxy list

List NDP proxies.

Usage:

orca network 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 network router ndp-proxy set

Update an NDP proxy.

Usage:

orca network 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 network router ndp-proxy show

Show an NDP proxy.

Usage:

orca network 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 network router remove

Detach a sub-resource from a router.

Usage:

orca network 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 network router remove gateway

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

Usage:

orca network router remove gateway [OPTIONS] ROUTER_ID

Options:

Name Type Description Default
--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. Sentinel.UNSET
--help boolean Show this message and exit. False
orca network router remove port

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

Usage:

orca network router remove port [OPTIONS] ROUTER_ID PORT_ID

Options:

Name Type Description Default
--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. Sentinel.UNSET
--nexthop text Next-hop IP address. Sentinel.UNSET
--help boolean Show this message and exit. False
orca network router remove subnet

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

Usage:

orca network router remove subnet [OPTIONS] ROUTER_ID SUBNET_ID

Options:

Name Type Description Default
--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. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--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 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 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 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. Sentinel.UNSET
--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). Sentinel.UNSET
--nexthop text Next-hop IP address. Sentinel.UNSET
--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. Sentinel.UNSET
--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. Sentinel.UNSET
--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. Sentinel.UNSET
--nexthop text Next-hop IP address. Sentinel.UNSET
--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. Sentinel.UNSET
--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. Sentinel.UNSET
--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

Manage network segments.

Usage:

orca network segment [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • create: Create a network segment.
  • delete: Delete a network segment.
  • list: List network segments.
  • set: Update a network segment.
  • show: Show a network segment.
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. Sentinel.UNSET
--network-type choice (flat | geneve | gre | local | vlan | vxlan) Network type. Sentinel.UNSET
--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. Sentinel.UNSET
--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. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--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. Sentinel.UNSET
--network-type choice (flat | geneve | gre | local | vlan | vxlan) Network type. Sentinel.UNSET
--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. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--help boolean Show this message and exit. False

orca network segment-range

Manage network segment ID ranges (admin).

Usage:

orca network segment-range [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • create: Create a segment range.
  • delete: Delete a segment range.
  • list: List network segment ranges.
  • set: Update a segment range.
  • show: Show a segment range.
orca network segment-range create

Create a segment range.

Usage:

orca network segment-range create [OPTIONS] NAME

Options:

Name Type Description Default
--network-type choice (vlan | vxlan | gre | geneve) Segment type. Sentinel.UNSET
--physical-network text Physical network identifier (required for vlan). None
--minimum integer Minimum segment ID. Sentinel.UNSET
--maximum integer Maximum segment ID. Sentinel.UNSET
--shared / --unshared boolean N/A False
--help boolean Show this message and exit. False
orca network segment-range delete

Delete a segment range.

Usage:

orca network segment-range delete [OPTIONS] SR_ID

Options:

Name Type Description Default
--yes, -y boolean N/A False
--help boolean Show this message and exit. False
orca network segment-range list

List network segment ranges.

Usage:

orca network segment-range 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 network segment-range set

Update a segment range.

Usage:

orca network segment-range set [OPTIONS] SR_ID

Options:

Name Type Description Default
--name text N/A None
--minimum integer N/A None
--maximum integer N/A None
--help boolean Show this message and exit. False
orca network segment-range show

Show a segment range.

Usage:

orca network segment-range show [OPTIONS] SR_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 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. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--help boolean Show this message and exit. False

orca network service-provider

Inspect Neutron service providers (BGP-VPN, L3, …).

Usage:

orca network service-provider [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • list: List Neutron service providers.
orca network service-provider list

List Neutron service providers.

Usage:

orca network 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. Sentinel.UNSET
--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. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--help boolean Show this message and exit. False

orca network subnet

Manage Neutron subnets.

Usage:

orca network subnet [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • create: Create a subnet.
  • delete: Delete a subnet.
  • inspect: Full inspection of a subnet — fields + IP usage + attached ports + servers.
  • list: List subnets.
  • show: Show subnet details.
  • update: Update a subnet.
  • update: Update a subnet.
  • update: Update a subnet.
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. Sentinel.UNSET
--cidr text CIDR (e.g. 10.0.0.0/24). Sentinel.UNSET
--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). Sentinel.UNSET
--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 inspect

Full inspection of a subnet — fields + IP usage + attached ports + servers.

Cross-references three Neutron endpoints so you don't have to run subnet show + port list + ip-availability show by hand:

  1. GET /subnets/{id} — the subnet fields
  2. GET /network-ip-availabilities/{network_id} — IP usage per subnet
  3. GET /ports?fixed_ips=subnet_id=<id> — who actually uses each IP

For each port, follow device_id when device_owner is compute:* to surface the server name (single Nova servers/{id} GET per attached VM).

Example: orca network subnet inspect

Usage:

orca network subnet inspect [OPTIONS] SUBNET_ID

Options:

Name Type Description Default
--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. Sentinel.UNSET
--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. Sentinel.UNSET
--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). Sentinel.UNSET
--enable-dhcp / --disable-dhcp boolean Enable or disable DHCP. None
--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). Sentinel.UNSET
--enable-dhcp / --disable-dhcp boolean Enable or disable DHCP. None
--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). Sentinel.UNSET
--enable-dhcp / --disable-dhcp boolean Enable or disable DHCP. None
--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. Sentinel.UNSET
--cidr text CIDR (e.g. 10.0.0.0/24). Sentinel.UNSET
--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). Sentinel.UNSET
--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. Sentinel.UNSET
--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. Sentinel.UNSET
--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). Sentinel.UNSET
--enable-dhcp / --disable-dhcp boolean Enable or disable DHCP. None
--help boolean Show this message and exit. False

orca network subport

Sub-ports of a trunk (alias of orca trunk subport).

Usage:

orca network subport [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • list: List sub-ports on a trunk.
orca network subport list

List sub-ports on a trunk.

Usage:

orca network 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. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--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 trunk

Manage Neutron trunks (VLAN trunk ports).

Usage:

orca network trunk [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • add-subport: [deprecated, use 'trunk subport add' instead]
  • create: Create a trunk.
  • delete: Delete a trunk.
  • list: List trunks.
  • remove-subport: [deprecated, use 'trunk subport remove' instead]
  • set: Update a trunk.
  • show: Show trunk details.
  • subport: Manage sub-ports on a trunk.
  • subport-list: [deprecated, use 'trunk subport list' instead]
  • unset: Clear optional fields on a trunk (description, …).
orca network trunk add-subport

Add a sub-port to a trunk.

Usage:

orca network trunk add-subport [OPTIONS] TRUNK_ID

Options:

Name Type Description Default
--port text Sub-port port ID. Sentinel.UNSET
--segmentation-type choice (vlan | inherit) Segmentation type. vlan
--segmentation-id integer VLAN ID (1–4094). Sentinel.UNSET
--help boolean Show this message and exit. False
orca network trunk create

Create a trunk.

Usage:

orca network trunk create [OPTIONS]

Options:

Name Type Description Default
--port text Parent port ID (the trunk port). Sentinel.UNSET
--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 network trunk delete

Delete a trunk.

Usage:

orca network 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 network trunk list

List trunks.

Usage:

orca network 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. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--help boolean Show this message and exit. False
orca network trunk remove-subport

Remove a sub-port from a trunk.

Usage:

orca network trunk remove-subport [OPTIONS] TRUNK_ID

Options:

Name Type Description Default
--port text Sub-port port ID to remove. Sentinel.UNSET
--yes, -y boolean Skip confirmation. False
--help boolean Show this message and exit. False
orca network trunk set

Update a trunk.

Usage:

orca network 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 network trunk show

Show trunk details.

Usage:

orca network 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. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--help boolean Show this message and exit. False
orca network trunk subport

Manage sub-ports on a trunk.

Usage:

orca network trunk subport [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • add: Add a sub-port to a trunk.
  • list: List sub-ports on a trunk.
  • remove: Remove a sub-port from a trunk.
orca network trunk subport add

Add a sub-port to a trunk.

Usage:

orca network trunk subport add [OPTIONS] TRUNK_ID

Options:

Name Type Description Default
--port text Sub-port port ID. Sentinel.UNSET
--segmentation-type choice (vlan | inherit) Segmentation type. vlan
--segmentation-id integer VLAN ID (1–4094). Sentinel.UNSET
--help boolean Show this message and exit. False
orca network trunk subport list

List sub-ports on a trunk.

Usage:

orca network 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. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--help boolean Show this message and exit. False
orca network trunk subport remove

Remove a sub-port from a trunk.

Usage:

orca network trunk subport remove [OPTIONS] TRUNK_ID

Options:

Name Type Description Default
--port text Sub-port port ID to remove. Sentinel.UNSET
--yes, -y boolean Skip confirmation. False
--help boolean Show this message and exit. False
orca network trunk subport-list

List sub-ports on a trunk.

Usage:

orca network 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. Sentinel.UNSET
--format, -f choice (table | json | value) Output format. table
--help boolean Show this message and exit. False
orca network trunk unset

Clear optional fields on a trunk (description, …).

Usage:

orca network trunk unset [OPTIONS] TRUNK_ID

Options:

Name Type Description Default
--description boolean Clear the description. False
--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 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 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