Create a device
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
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
The id of the emulated parent node to attach the device to.
The device emulation type to create (e.g. NIC_ETHERNET). Resolved against the parent node’s simulator image.
The number of ports to emulate; must be one of the model’s supported counts. Defaults to the model’s default port count.
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.
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).
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-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
The emulation type of this device (e.g. NIC_ETHERNET).
The hardware model this device emulates (e.g. connectx7).
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.
The port type this device emulates (e.g. ethernet). null when neither the request nor the model’s default set one.
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.
The id of the emulated node this device is plugged into.
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.
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.