Skip to navigation

Create a device

View as MarkdownOpen in Claude

Create a device (e.g. a NIC) under an emulated parent node. The device is emulated by the same simulator image as its parent.

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.
namestringRequired1-254 characters
Name of this device. Must be unique across all devices on the same parent node. This name is delivered to the simulator to indicate a unique name and which interfaces are connected to it.
parentstringRequiredformat: "uuid"

The id of the emulated parent node to attach the device to.

emulation_typestringRequired>=1 character

The device emulation type to create (e.g. NIC_ETHERNET). Resolved against the parent node’s simulator image.

modelstringOptional>=1 character
The hardware model to emulate. Defaults to the manifest default and is immutable after creation.
number_of_portsintegerOptional>=1

The number of ports to emulate; must be one of the model’s supported counts. Defaults to the model’s default port count.

port_typestringOptional>=1 character
The port type to emulate. Defaults to the model's default port type.
default_splitstringOptional1-8 characters

Override the platform’s default port split for the interfaces built at create. Only for a device which boots an operating system of its own: the port mappings come from that image’s OS Image manifest. Ports with a custom default split keep it, and ports that do not support this split keep the platform’s default_split.

pci_configobjectOptional
The PCI slot this device occupies on its parent node.
vm_configobjectOptional

The node this device runs, for an emulation type which boots an operating system of its own (e.g. a DPU). Required for those, and rejected for emulated hardware which boots no OS (e.g. a NIC).

simulator_imagestringOptionalformat: "uuid"

The id of a specific simulator image to emulate this device with, instead of the newest compatible one. Create-only, and only for a device which boots an operating system of its own - one which does not is emulated by its parent’s simulator image.

simulator_configmap from strings to anyOptional

Simulator-engine configuration for the device (e.g. flags declared by the engine manifest). Keys the resolved manifest’s schema does not declare are rejected, as are service-derived keys (model, number_of_ports, port_type, pci_address, pci_index) - set those via their own fields.

Response

idstringRead-onlyformat: "uuid"
createddatetimeRead-only
modifieddatetimeRead-only
namestring<=254 characters
Name of this device. Must be unique across all devices on the same parent node. This name is delivered to the simulator to indicate a unique name and which interfaces are connected to it.
emulation_typestringRead-only

The emulation type of this device (e.g. NIC_ETHERNET).

modelstringRead-only

The hardware model this device emulates (e.g. connectx7).

number_of_portsinteger or nullRead-only

The number of ports this device emulates. Resolved at create, so it can differ from what was requested. null when the platform declares no port count.

port_typestring or nullRead-only

The port type this device emulates (e.g. ethernet). null when neither the request nor the model’s default set one.

default_splitstring or nullRead-only

The port split override this device was created with. null for a device with no OS of its own, and when it uses the platform’s own default split.

parentstringRead-onlyformat: "uuid"

The id of the emulated node this device is plugged into.

pci_configobject
The PCI slot this device occupies on its parent node.
vm_configobject
The node this device runs. Empty for emulated hardware which boots no operating system of its own.
simulator_configmap from strings to anyRead-only

Simulator-engine configuration for this device. The service-derived keys (model, number_of_ports, port_type, pci_address, pci_index) are excluded - they surface as their own fields.

has_osbooleanRead-only

Whether this device boots an operating system of its own (e.g. a DPU), rather than being emulated hardware with no OS to run (e.g. a NIC). Tells which children accept instructions, resets and console access.

Errors

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error