Skip to navigation

Get a node's breakout options

View as MarkdownOpen in Claude

Lists the node’s physical ports, how each is split now, and the splits it can change to. Keys are display labels, not identifiers; each value lists the interfaces the port carries, any of whose ids POST /api/v3/simulations/nodes/interfaces/bulk-breakout/ accepts to change that port’s split.

Ports with a single split option are left out unless include_single_option_ports is true; interfaces narrows the result to the ports carrying those interfaces. Both apply together.

Caveat: only a node whose image has an OS image manifest pinning platform information for the node’s model has breakout options. Any other node answers 400 (Node <name> does not have breakout options.), including switches added from a system node that lists split options.

Required scope: Simulation Read (roles: Air Org Administrator, Air User)

Alternative: the Air Trainee role also grants access.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequiredformat: "uuid"
A UUID string identifying this node.

Query parameters

include_single_option_portsbooleanOptionalDefaults to false

Also return ports with a single entry in split_options, whose split cannot be changed.

interfacesstringOptional

Comma-separated interface IDs. When given, only the ports carrying at least one of these interfaces are returned, each with all of its interfaces.

Response

The node’s ports, keyed by display name

splitstring
split_optionslist of strings
interfaceslist of objects

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error