NVML API Reference Guide (PDF) - vR352 (older) - Last updated May 7, 2015 - Send Feedback

4.9. Unit Queries

This chapter describes that queries that NVML can perform against each unit. For S-class systems only. In each case the device is identified with an nvmlUnit_t handle. This handle is obtained by calling nvmlUnitGetHandleByIndex().

Functions

nvmlReturn_t nvmlSystemGetHicVersion ( unsigned int* hwbcCount, nvmlHwbcEntry_t* hwbcEntries )
nvmlReturn_t nvmlUnitGetCount ( unsigned int* unitCount )
nvmlReturn_t nvmlUnitGetDevices ( nvmlUnit_t unit, unsigned int* deviceCount, nvmlDevice_t* devices )
nvmlReturn_t nvmlUnitGetFanSpeedInfo ( nvmlUnit_t unit, nvmlUnitFanSpeeds_t* fanSpeeds )
nvmlReturn_t nvmlUnitGetHandleByIndex ( unsigned int  index, nvmlUnit_t* unit )
nvmlReturn_t nvmlUnitGetLedState ( nvmlUnit_t unit, nvmlLedState_t* state )
nvmlReturn_t nvmlUnitGetPsuInfo ( nvmlUnit_t unit, nvmlPSUInfo_t* psu )
nvmlReturn_t nvmlUnitGetTemperature ( nvmlUnit_t unit, unsigned int  type, unsigned int* temp )
nvmlReturn_t nvmlUnitGetUnitInfo ( nvmlUnit_t unit, nvmlUnitInfo_t* info )

Functions

nvmlReturn_t nvmlSystemGetHicVersion ( unsigned int* hwbcCount, nvmlHwbcEntry_t* hwbcEntries )
Parameters
hwbcCount
Size of hwbcEntries array
hwbcEntries
Array holding information about hwbc
Returns

Description

Retrieves the IDs and firmware versions for any Host Interface Cards (HICs) in the system.

For S-class products.

The hwbcCount argument is expected to be set to the size of the input hwbcEntries array. The HIC must be connected to an S-class system for it to be reported by this function.

nvmlReturn_t nvmlUnitGetCount ( unsigned int* unitCount )
Parameters
unitCount
Reference in which to return the number of units
Returns

Description

Retrieves the number of units in the system.

For S-class products.

nvmlReturn_t nvmlUnitGetDevices ( nvmlUnit_t unit, unsigned int* deviceCount, nvmlDevice_t* devices )
Parameters
unit
The identifier of the target unit
deviceCount
Reference in which to provide the devices array size, and to return the number of attached GPU devices
devices
Reference in which to return the references to the attached GPU devices
Returns

Description

Retrieves the set of GPU devices that are attached to the specified unit.

For S-class products.

The deviceCount argument is expected to be set to the size of the input devices array.

nvmlReturn_t nvmlUnitGetFanSpeedInfo ( nvmlUnit_t unit, nvmlUnitFanSpeeds_t* fanSpeeds )
Parameters
unit
The identifier of the target unit
fanSpeeds
Reference in which to return the fan speed information
Returns

Description

Retrieves the fan speed readings for the unit.

For S-class products.

See nvmlUnitFanSpeeds_t for details on available fan speed info.

nvmlReturn_t nvmlUnitGetHandleByIndex ( unsigned int  index, nvmlUnit_t* unit )
Parameters
index
The index of the target unit, >= 0 and < unitCount
unit
Reference in which to return the unit handle
Returns

Description

Acquire the handle for a particular unit, based on its index.

For S-class products.

Valid indices are derived from the unitCount returned by nvmlUnitGetCount(). For example, if unitCount is 2 the valid indices are 0 and 1, corresponding to UNIT 0 and UNIT 1.

The order in which NVML enumerates units has no guarantees of consistency between reboots.

nvmlReturn_t nvmlUnitGetLedState ( nvmlUnit_t unit, nvmlLedState_t* state )
Parameters
unit
The identifier of the target unit
state
Reference in which to return the current LED state
Returns

Description

Retrieves the LED state associated with this unit.

For S-class products.

See nvmlLedState_t for details on allowed states.

See also:

nvmlUnitSetLedState()

nvmlReturn_t nvmlUnitGetPsuInfo ( nvmlUnit_t unit, nvmlPSUInfo_t* psu )
Parameters
unit
The identifier of the target unit
psu
Reference in which to return the PSU information
Returns

Description

Retrieves the PSU stats for the unit.

For S-class products.

See nvmlPSUInfo_t for details on available PSU info.

nvmlReturn_t nvmlUnitGetTemperature ( nvmlUnit_t unit, unsigned int  type, unsigned int* temp )
Parameters
unit
The identifier of the target unit
type
The type of reading to take
temp
Reference in which to return the intake temperature
Returns

Description

Retrieves the temperature readings for the unit, in degrees C.

For S-class products.

Depending on the product, readings may be available for intake (type=0), exhaust (type=1) and board (type=2).

nvmlReturn_t nvmlUnitGetUnitInfo ( nvmlUnit_t unit, nvmlUnitInfo_t* info )
Parameters
unit
The identifier of the target unit
info
Reference in which to return the unit information
Returns

Description

Retrieves the static information associated with a unit.

For S-class products.

See nvmlUnitInfo_t for details on available unit info.


NVML API Reference Guide (PDF) - vR352 (older) - Last updated May 7, 2015 - Send Feedback