NVML API Reference Guide (PDF) - vR331 (older) - Last updated March 14, 2014 - Send Feedback

## 1. NVML API Reference

The NVIDIA Management Library (NVML) is a C-based programmatic interface for monitoring and managing various states within NVIDIA Tesla™ GPUs. It is intended to be a platform for building 3rd party applications, and is also the underlying library for the NVIDIA-supported `nvidia-smi` tool. NVML is thread-safe so it is safe to make simultaneous NVML calls from multiple threads.

## API Documentation

Supported OS platforms:

- Windows: Windows Server 2008 R2 64-bit, Windows 7-8 64-bit
- Linux: 32-bit and 64-bit

Supported products:

- Full Support

  - NVIDIA Tesla Line:
    - S2050, C2050, C2070, C2075,
    - M2050, M2070, M2075, M2090,
    - X2070, X2090,
    - K10, K20, K20X, K20Xm, K20c, K20m, K20s, K40c, K40m, K40t, K40s, K40st
  - NVIDIA Quadro Line:
    - 410, 600, 2000, 4000, 5000, 6000, 7000, M2070-Q
    - K2000, K2000D, K4000, K5000, K6000
  - NVIDIA GRID Line:
    - K1, K2, K340, K520
  - NVIDIA GeForce Line: None

  Limited Support

  - NVIDIA Tesla Line: S1070, C1060, M1060 and all other previous generation Tesla-branded parts
  - NVIDIA Quadro Line: All other current and previous generation Quadro-branded parts
  - NVIDIA GeForce Line: All current and previous generation GeForce-branded parts

The NVML library can be found at:`%ProgramW6432%\"NVIDIA Corporation"\NVSMI\`on Windows, but will not be added to the path. To dynamically link to NVML, add this path to the PATH environmental variable. To dynamically load NVML, call LoadLibrary with this path.

On Linux the NVML library will be found on the standard library path. For 64-bit Linux, both the 32-bit and 64-bit NVML libraries will be installed.

The NVML API is divided into five categories:

- Support Methods:

  - Initialization and Cleanup

- Query Methods:

  - System Queries
  - Device Queries
  - Unit Queries

- Control Methods:

  - Unit Commands
  - Device Commands

- Event Handling Methods:

  - Event Handling Methods

- Error reporting Methods

  - Error Reporting

List of changes can be found in the Change Log.

NVML API Reference Guide (PDF) - vR331 (older) - Last updated March 14, 2014 - Send Feedback