Air APIAPI ReferenceInterfaces

Create an interface

View as Markdown

Create a new interface in a simulation. This operation is not permitted if the simulation is not in an updatable state.

Required scope: air:simulation_edit (roles: air_org_admin, 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"
namestringRequired1-15 characters
interface_typeenumOptional
  • DATA_PLANE_INTF - Data Plane Interface
  • PCIE_INTF - PCIe Interface between emulated nodes
  • OOB_INTF - Out of Band Management Interface
mac_addressstringOptional>=1 character
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.

splitstring or nullOptional1-8 characters

The breakout factor of the physical port this interface belongs to (‘1’ = un-split, e.g. ‘2’, ‘4’, ‘8’). Only meaningful for nodes managed by a platform port map, where the name/split pair must match the port map; when unset, the interface is validated and created at the platform’s default split.

Response

idstringRead-onlyformat: "uuid"
createddatetimeRead-only
modifieddatetimeRead-only
nodestringformat: "uuid"
namestring<=15 characters
connectionstring or nullRead-onlyformat: "uuid"
A "link" between two interfaces.
interface_typeenumOptional
  • DATA_PLANE_INTF - Data Plane Interface
  • PCIE_INTF - PCIe Interface between emulated nodes
  • OOB_INTF - Out of Band Management Interface
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.

splitstring or nullOptional1-8 characters

The breakout factor of the physical port this interface belongs to (‘1’ = un-split, e.g. ‘2’, ‘4’, ‘8’). Only meaningful for nodes managed by a platform port map, where the name/split pair must match the port map; when unset, the interface is validated and created at the platform’s default split.

Errors

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error