List interfaces

GET

https://api.dsx-air.nvidia.com/api/v3/simulations/nodes/interfaces/

List interfaces that belong to simulations you have read access to. Results are paginated.

Required scope: air:simulation_read (roles: air_org_admin, air_user)

Alternative: role air_trainee also grants access.

AuthorizationBearer

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

has_linkbooleanOptional

Filter by whether the interface has a connected link (in either direction).

interface_typeenumOptional

* `DATA_PLANE_INTF` - Data Plane Interface * `PCIE_INTF` - PCIe Interface between emulated nodes * `OOB_INTF` - Out of Band Management Interface

Allowed values:

is_takenbooleanOptional

Filter by whether the interface is taken (connected or outbound).

limitintegerOptional

Number of results to return per page.

mac_addressstringOptional

namestringOptional

nodestringOptionalformat: "uuid"

offsetintegerOptional

The initial index from which to return the results.

orderingenumOptional

Order objects by field. Prefix with - for descending order.

outboundbooleanOptional

searchstringOptional

Search by name.

simulationstringOptionalformat: "uuid"

countinteger

resultslist of objects

nextstring or nullOptionalformat: "uri"

previousstring or nullOptionalformat: "uri"

400

Bad Request Error

403

Forbidden Error

500

Internal Server Error