NVML API Reference Guide (PDF) - v535 (older) - Last updated January 31, 2024 - Send Feedback

4.16. Unit Commands

This chapter 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.

Functions

nvmlReturn_t nvmlUnitSetLedState ( nvmlUnit_t unit, nvmlLedColor_t color )

Functions

nvmlReturn_t nvmlUnitSetLedState ( nvmlUnit_t unit, nvmlLedColor_t color )
Parameters
unit
The identifier of the target unit
color
The target LED color
Returns

Description

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 unison regardless of which unit is specified with this command.

See nvmlLedColor_t for available colors.

See also:

nvmlUnitGetLedState()


NVML API Reference Guide (PDF) - v535 (older) - Last updated January 31, 2024 - Send Feedback