Unit Queries

This page describes that queries that NVML can perform against each unit. More...

Functions
nvmlReturn_t DECLDIR	nvmlUnitGetCount (unsigned int *unitCount)
	Retrieve the number of units in the system.
nvmlReturn_t DECLDIR	nvmlUnitGetHandleByIndex (unsigned int index, nvmlUnit_t *unit)
	Acquire the handle for a particular unit, based on its index.
nvmlReturn_t DECLDIR	nvmlUnitGetUnitInfo (nvmlUnit_t unit, nvmlUnitInfo_t *info)
	Retrieve the static information associated with a unit.
nvmlReturn_t DECLDIR	nvmlUnitGetLedState (nvmlUnit_t unit, nvmlLedState_t *state)
	Retrieve the LED state associated with this unit.
nvmlReturn_t DECLDIR	nvmlUnitGetPsuInfo (nvmlUnit_t unit, nvmlPSUInfo_t *psu)
	Retrieve the PSU stats for the unit.
nvmlReturn_t DECLDIR	nvmlUnitGetTemperature (nvmlUnit_t unit, unsigned int type, unsigned int *temp)
	Retrieve the temperature readings for the unit.
nvmlReturn_t DECLDIR	nvmlUnitGetFanSpeedInfo (nvmlUnit_t unit, nvmlUnitFanSpeeds_t *fanSpeeds)
	Retrieve the fan speed readings for the unit.
nvmlReturn_t DECLDIR	nvmlUnitGetDevices (nvmlUnit_t unit, unsigned int *deviceCount, nvmlDevice_t *devices)
	Retrieve the set of GPU devices that are attached to the specified unit.

---

Detailed Description

This page 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().

---

Function Documentation

nvmlReturn_t DECLDIR nvmlUnitGetCount

(

unsigned int *

unitCount

)

Retrieve the number of units in the system.

For S-class products only.

Parameters:

unitCount

Reference in which to return the number of units

Returns:

• NVML_SUCCESS if unitCount has been set
• NVML_ERROR_UNINITIALIZED if the library has not been successfully initialized
• NVML_ERROR_INVALID_ARGUMENT if unitCount is null
• NVML_ERROR_UNKNOWN on any unexpected error

nvmlReturn_t DECLDIR nvmlUnitGetDevices	(	nvmlUnit_t	unit,
		unsigned int *	deviceCount,
		nvmlDevice_t *	devices
	)

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

For S-class products only.

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

Parameters:

	unit	The identifer of the target unit
	deviceCount	Reference in which to provide the devies 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:

• NVML_SUCCESS if deviceCount and devices have been populated
• NVML_ERROR_UNINITIALIZED if the library has not been successfully initialized
• NVML_ERROR_INVALID_ARGUMENT if unit is invalid, either of deviceCount or devices is null or deviceCount indicates that the devices array is too small

nvmlReturn_t DECLDIR nvmlUnitGetFanSpeedInfo	(	nvmlUnit_t	unit,
		nvmlUnitFanSpeeds_t *	fanSpeeds
	)

Retrieve the fan speed readings for the unit.

For S-class products only.

See nvmlUnitFanSpeeds_t for details on available fan speed info.

Parameters:

	unit	The identifer of the target unit
	fanSpeeds	Reference in which to return the fan speed information

Returns:

• NVML_SUCCESS if fanSpeeds has been populated
• NVML_ERROR_UNINITIALIZED if the library has not been successfully initialized
• NVML_ERROR_INVALID_ARGUMENT if unit is invalid or fanSpeeds is null
• NVML_ERROR_NOT_SUPPORTED if this is not an S-class product
• NVML_ERROR_UNKNOWN on any unexpected error

nvmlReturn_t DECLDIR nvmlUnitGetHandleByIndex	(	unsigned int	index,
		nvmlUnit_t *	unit
	)

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

For S-class products only.

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 guarentees of consistency between reboots.

Parameters:

	index	The index of the target unit, >= 0 and < unitCount
	unit	Reference in which to return the unit handle

Returns:

• NVML_SUCCESS if unit has been set
• NVML_ERROR_UNINITIALIZED if the library has not been successfully initialized
• NVML_ERROR_INVALID_ARGUMENT if index is invalid or unit is null
• NVML_ERROR_UNKNOWN on any unexpected error

nvmlReturn_t DECLDIR nvmlUnitGetLedState	(	nvmlUnit_t	unit,
		nvmlLedState_t *	state
	)

Retrieve the LED state associated with this unit.

For S-class products only.

See nvmlLedState_t for details on allowed states.

Parameters:

	unit	The identifer of the target unit
	state	Reference in which to return the current LED state

Returns:

• NVML_SUCCESS if state has been set
• NVML_ERROR_UNINITIALIZED if the library has not been successfully initialized
• NVML_ERROR_INVALID_ARGUMENT if unit is invalid or state is null
• NVML_ERROR_NOT_SUPPORTED if this is not an S-class product
• NVML_ERROR_UNKNOWN on any unexpected error

See also:

nvmlUnitSetLedState()

nvmlReturn_t DECLDIR nvmlUnitGetPsuInfo	(	nvmlUnit_t	unit,
		nvmlPSUInfo_t *	psu
	)

Retrieve the PSU stats for the unit.

For S-class products only.

See nvmlPSUInfo_t for details on available PSU info.

Parameters:

	unit	The identifer of the target unit
	psu	Reference in which to return the PSU information

Returns:

• NVML_SUCCESS if psu has been populated
• NVML_ERROR_UNINITIALIZED if the library has not been successfully initialized
• NVML_ERROR_INVALID_ARGUMENT if unit is invalid or psu is null
• NVML_ERROR_NOT_SUPPORTED if this is not an S-class product
• NVML_ERROR_UNKNOWN on any unexpected error

nvmlReturn_t DECLDIR nvmlUnitGetTemperature	(	nvmlUnit_t	unit,
		unsigned int	type,
		unsigned int *	temp
	)

Retrieve the temperature readings for the unit.

For S-class products only.

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

Parameters:

	unit	The identifer of the target unit
	type	The type of reading to take
	temp	Reference in which to return the intake temperature

Returns:

• NVML_SUCCESS if temp has been populated
• NVML_ERROR_UNINITIALIZED if the library has not been successfully initialized
• NVML_ERROR_INVALID_ARGUMENT if unit or type is invalid or temp is null
• NVML_ERROR_NOT_SUPPORTED if this is not an S-class product
• NVML_ERROR_UNKNOWN on any unexpected error

nvmlReturn_t DECLDIR nvmlUnitGetUnitInfo	(	nvmlUnit_t	unit,
		nvmlUnitInfo_t *	info
	)

Retrieve the static information associated with a unit.

For S-class products only.

See nvmlUnitInfo_t for details on available unit info.

Parameters:

	unit	The identifer of the target unit
	info	Reference in which to return the unit information

Returns:

• NVML_SUCCESS if info has been populated
• NVML_ERROR_UNINITIALIZED if the library has not been successfully initialized
• NVML_ERROR_INVALID_ARGUMENT if unit is invalid or info is null