Inventory and Devices
The NetworkEntity section of the API lets you manage inventory and hardware objects in the NVLink fabric, including switches, 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 |
|---|---|---|---|
deviceUID | string | Display a GPU according to its unique device identifier | None |
chassisSerialNumber | string | Display GPUs by chassis serial number | None |
slotID | integer | Display GPUs by slot identifier | Requires chassisSerialNumber |
trayIndex | integer | Display GPUs by tray index | Requires chassisSerialNumber |
hostID | string | Display GPUs by host identifier | Requires trayIndex or slotID |
domain | array | Display GPUs by domain UUID(s) | None |
GPU API Examples
Retrieve a specific GPU using its unique device identifier:
curl -X GET "https://<ip_address>/nmx/v1/gpus?deviceUID=12345678" \
-H "accept: application/json" \
-H "Authorization: Basic <auth-token>"
Retrieve all GPUs in a specific chassis:
curl -X GET "https://<ip_address>/nmx/v1/gpus?chassisSerialNumber=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://<ip_address>/nmx/v1/gpus?chassisSerialNumber=CH-SN-9876543&slotID=3" \
-H "accept: application/json" \
-H "Authorization: Basic <auth-token>"
Retrieve GPUs from a specific tray and host combination:
curl -X GET "https://<ip_address>/nmx/v1/gpus?chassisSerialNumber=CH-SN-9876543&trayIndex=1&hostID=1" \
-H "accept: application/json" \
-H "Authorization: Basic <auth-token>"