Inventory and Devices
The NetworkEntity section of the API lets you manage inventory and hardware objects in the NVLink fabric: switches, switch nodes, chassis, compute nodes, GPUs, ports, and domains.
GPU API Endpoints
The /v1/gpus endpoint supports the following query parameters. These parameters allow you to scope GPU queries according to a specific chassis, slot, tray, or host without retrieving the entire inventory.
| Parameter | Type | Description | Dependencies |
|---|---|---|---|
device-uid |
string | Display a GPU according to its unique device identifier | None |
chassis-serial-number |
string | Display GPUs by chassis serial number | None |
slot-id |
integer | Display GPUs by slot identifier | Requires chassis-serial-number |
tray-index |
integer | Display GPUs by tray index | Requires chassis-serial-number |
host-id |
string | Display GPUs by host identifier | Requires tray-index or slot-id |
domain |
array | Display GPUs by domain UUID(s) | None |
pagination |
object | Control result set size with offset and limit |
None |
GPU API Examples
Retrieve a specific GPU using its unique device identifier:
curl -X GET "https://<netq.domain>:443/api/nmx/v1/gpus?device-uid=GPU-12345678" \
-H "accept: application/json" \
-H "Authorization: Basic <auth-token>"
Retrieve all GPUs in a specific chassis:
curl -X GET "https://<netq.domain>:443/api/nmx/v1/gpus?chassis-serial-number=CH-SN-9876543" \
-H "accept: application/json" \
-H "Authorization: Basic <auth-token>"
Retrieve GPUs from a specific slot within a chassis:
curl -X GET "https://<netq.domain>:443/api/nmx/v1/gpus?chassis-serial-number=CH-SN-9876543&slot-id=3" \
-H "accept: application/json" \
-H "Authorization: Basic <auth-token>"
Retrieve GPUs from a specific tray and host combination:
curl -X GET "https://<netq.domain>:443/api/nmx/v1/gpus?chassis-serial-number=CH-SN-9876543&tray-index=1&host-id=compute-node-05" \
-H "accept: application/json" \
-H "Authorization: Basic <auth-token>"