Unit Commands

This page describes NVML operations that change the state of the unit. More...


Functions

nvmlReturn_t DECLDIR nvmlUnitSetLedState (nvmlUnit_t unit, nvmlLedColor_t color)
 Set the LED state for the unit.


Detailed Description

This page describes NVML operations that change the state of the unit.

For S-class products. Each of these requires root/admin access. Non-admin users will see an NVML_ERROR_NO_PERMISSION error code when invoking any of these methods.


Function Documentation

nvmlReturn_t DECLDIR nvmlUnitSetLedState ( nvmlUnit_t  unit,
nvmlLedColor_t  color 
)

Set the LED state for the unit.

The LED can be either green (0) or amber (1).

For S-class products. Requires root/admin permissions.

This operation takes effect immediately.

Current S-Class products don't provide unique LEDs for each unit. As such, both front and back LEDs will be toggled in unision regardless of which unit is specified with this command.

See nvmlLedColor_t for available colors.

Parameters:
unit The identifer of the target unit
color The target LED color
Returns:
See also:
nvmlUnitGetLedState()


Generated on Tue Mar 15 21:18:02 2011