Skip to content

orca trunk

Manage Neutron trunk ports.

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

orca trunk

Manage Neutron trunks (VLAN trunk ports).

Usage:

orca 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 trunk add-subport

Add a sub-port to a trunk.

Usage:

orca 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 trunk create

Create a trunk.

Usage:

orca 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 trunk delete

Delete a trunk.

Usage:

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

List trunks.

Usage:

orca 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 trunk remove-subport

Remove a sub-port from a trunk.

Usage:

orca 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 trunk set

Update a trunk.

Usage:

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

Show trunk details.

Usage:

orca 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 trunk subport

Manage sub-ports on a trunk.

Usage:

orca 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 trunk subport add

Add a sub-port to a trunk.

Usage:

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

List sub-ports on a trunk.

Usage:

orca 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 trunk subport remove

Remove a sub-port from a trunk.

Usage:

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

List sub-ports on a trunk.

Usage:

orca 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 trunk unset

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

Usage:

orca trunk unset [OPTIONS] TRUNK_ID

Options:

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