Skip to navigation

Break out ports on a node

View as MarkdownOpen in Claude

Changes the split of several of a node’s physical ports in one request. Each entry in interfaces names a port by the id of any interface it carries, with the split to apply; read the choices from GET /api/v3/simulations/nodes/{id}/breakout-options/.

Each port’s interfaces are replaced by the ones the platform defines for the new split, so their names and ids change, and links and services on them are removed. The request applies in full or not at all, and the response lists the interfaces created.

Requires: the simulation INACTIVE, and a node that has breakout options.

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

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
nodestringRequiredformat: "uuid"

The node the interfaces are stored on; this is required. A switch, or a host node — a host carries the lanes of its network PCI children (e.g. a DPU), and each interface is broken out against the port map of the entity that owns it.

interfaceslist of objectsRequired

The ports to break out, one entry per physical port. Every interface must be a data plane interface of node.

Response

idstringRead-onlyformat: "uuid"
createddatetimeRead-only
modifieddatetimeRead-only
nodestringRead-onlyformat: "uuid"
namestring<=15 characters

The interface name, such as eth1; unique on the node, at most 15 characters.

connectionstring or nullRead-onlyformat: "uuid"
A "link" between two interfaces.
splitstring or nullRead-only

Breakout factor of the interface: the split bucket of the platform port map the interface belongs to (e.g. 1x for un-split). The valid values are the split options its platform declares, so this mirrors that platform rather than a fixed vocabulary. None means the interface is not governed by a platform port map.

devicestring or nullRead-onlyformat: "uuid"

UUID of the device (e.g. a NIC or a DPU) this interface belongs to. The device is plugged into the node this interface is on. Can be omitted if attached to a Node directly.

interface_typeenumOptional
  • DATA_PLANE_INTF - Data Plane Interface
  • PCIE_INTF - PCIe Interface between emulated nodes
  • OOB_INTF - Out of Band Management Interface
Allowed values:
mac_addressstringOptional
The MAC address of the interface. If excluded, one will be provided
outboundbooleanOptional
Whether the interface is outbound.
labelsobjectOptional

Labels which can be specified on the interface. Fields not specified in the payload schema will be completely ignored. If updating, the data provided will completely replace existing labels: attempting to PATCH specific labels will delete the other labels.

Errors

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error