Networking Minerva User Guide
Networking Minerva User Guide
Breadcrumbs

Query GPU Inventory

This page covers GPU queries with the /nmx/v1/gpus endpoint of the NVIDIA Minerva NVLink API. For the other inventory endpoints, such as switches, chassis, compute nodes, ports, and domains, see the API reference linked from NVIDIA Minerva NVLink API User Guide.

GPU Query Parameters

The /nmx/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, in decimal or in hexadecimal with a 0x prefix

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

integer

Display GPUs by host identifier

Requires trayIndex or slotID

systemUID

integer

Display GPUs by system unique identifier

None

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=1657324662872342529" \
  -H "accept: application/json" \
  -H "X-API-Key: <api-key>"
Example response 
[
  {
    "ID": "6828a1c3af653727786b6201",
    "DeviceUID": 1657324662872342529,
    "DeviceID": 0,
    "SystemUID": 1234567890,
    "VendorID": 4318,
    "DevicePcieID": 8961,
    "ALIDList": [
      1
    ],
    "Health": "HEALTHY",
    "DomainUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "LocationInfo": {
      "ChassisID": 1,
      "ChassisSerialNumber": "CH-SN-9876543",
      "SlotID": 3,
      "TrayIndex": 1,
      "HostID": 1
    }
  }
]

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 "X-API-Key: <api-key>"
Example response 
[
  {
    "ID": "6828a1c3af653727786b6201",
    "DeviceUID": 1657324662872342529,
    "LocationInfo": {
      "ChassisID": 1,
      "ChassisSerialNumber": "CH-SN-9876543",
      "SlotID": 3,
      "TrayIndex": 1,
      "HostID": 1
    },
    ...
  },
  {
    "ID": "6828a1c3af653727786b6202",
    "DeviceUID": 1657324662872342530,
    "LocationInfo": {
      "ChassisID": 1,
      "ChassisSerialNumber": "CH-SN-9876543",
      "SlotID": 4,
      "TrayIndex": 1,
      "HostID": 1
    },
    ...
  }
]

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 "X-API-Key: <api-key>"
Example response 
[
  {
    "ID": "6828a1c3af653727786b6201",
    "DeviceUID": 1657324662872342529,
    "DeviceID": 0,
    "SystemUID": 1234567890,
    "VendorID": 4318,
    "DevicePcieID": 8961,
    "ALIDList": [
      1
    ],
    "Health": "HEALTHY",
    "DomainUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "LocationInfo": {
      "ChassisID": 1,
      "ChassisSerialNumber": "CH-SN-9876543",
      "SlotID": 3,
      "TrayIndex": 1,
      "HostID": 1
    }
  }
]

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 "X-API-Key: <api-key>"
Example response 
[
  {
    "ID": "6828a1c3af653727786b6201",
    "DeviceUID": 1657324662872342529,
    "LocationInfo": {
      "ChassisID": 1,
      "ChassisSerialNumber": "CH-SN-9876543",
      "SlotID": 3,
      "TrayIndex": 1,
      "HostID": 1
    },
    ...
  },
  {
    "ID": "6828a1c3af653727786b6202",
    "DeviceUID": 1657324662872342530,
    "LocationInfo": {
      "ChassisID": 1,
      "ChassisSerialNumber": "CH-SN-9876543",
      "SlotID": 4,
      "TrayIndex": 1,
      "HostID": 1
    },
    ...
  }
]

Last updated: