NVML API Reference Guide :: GPU Deployment and Management Documentation

< Previous | Next >

NVML API Reference Guide (PDF) - vR590 (older) - Last updated December 04, 2025 - Send Feedback

5.33.3. vGPU Structs

[vGPU Enums, Constants, Structs]

Classes

struct nvmlActiveVgpuInstanceInfo_v1_t
struct nvmlGridLicensableFeature_t
struct nvmlGridLicensableFeatures_t
struct nvmlGridLicenseExpiry_t
struct nvmlVgpuCreatablePlacementInfo_v1_t
struct nvmlVgpuHeterogeneousMode_v1_t
struct nvmlVgpuInstanceUtilizationInfo_v1_t
struct nvmlVgpuInstanceUtilizationSample_t
struct nvmlVgpuInstancesUtilizationInfo_v1_t
struct nvmlVgpuLicenseExpiry_t
struct nvmlVgpuPlacementId_v1_t
struct nvmlVgpuPlacementList_v1_t
struct nvmlVgpuPlacementList_v2_t
struct nvmlVgpuProcessUtilizationInfo_v1_t
struct nvmlVgpuProcessUtilizationSample_t
struct nvmlVgpuProcessesUtilizationInfo_v1_t
struct nvmlVgpuRuntimeState_v1_t
struct nvmlVgpuSchedulerCapabilities_t
struct nvmlVgpuSchedulerGetState_t
struct nvmlVgpuSchedulerLogEntry_t
struct nvmlVgpuSchedulerLogInfo_v1_t
struct nvmlVgpuSchedulerLog_t
union nvmlVgpuSchedulerParams_t
union nvmlVgpuSchedulerSetParams_t
struct nvmlVgpuSchedulerSetState_t
struct nvmlVgpuSchedulerStateInfo_v1_t
struct nvmlVgpuSchedulerState_v1_t
struct nvmlVgpuTypeBar1Info_v1_t
struct nvmlVgpuTypeIdInfo_v1_t
struct nvmlVgpuTypeMaxInstance_v1_t

Defines

#define NVML_GRID_LICENSE_STATE_LICENSED 5: Licensed state.
#define NVML_GRID_LICENSE_STATE_UNINITIALIZED 1: Uninitialized state.
#define NVML_GRID_LICENSE_STATE_UNKNOWN 0: Unknown state.
#define NVML_GRID_LICENSE_STATE_UNLICENSED 4: Unlicensed state.
#define NVML_GRID_LICENSE_STATE_UNLICENSED_RESTRICTED 3: Unlicensed restricted state.
#define NVML_GRID_LICENSE_STATE_UNLICENSED_UNRESTRICTED 2: Unlicensed unrestricted state.
#define NVML_SCHEDULER_SW_MAX_LOG_ENTRIES 200: Maximum number of scheduler log entries.
#define NVML_SUPPORTED_VGPU_SCHEDULER_POLICY_COUNT 3: Number of supported vGPU scheduler policies.
#define NVML_VGPU_SCHEDULER_ARR_DEFAULT 0: Default Adaptive Round Robin mode.
#define NVML_VGPU_SCHEDULER_ARR_DISABLE 1: Disable Adaptive Round Robin mode.
#define NVML_VGPU_SCHEDULER_ARR_ENABLE 2: Enable Adaptive Round Robin mode.
#define NVML_VGPU_SCHEDULER_ENGINE_TYPE_GRAPHICS 1: Graphics engine.
#define NVML_VGPU_SCHEDULER_POLICY_BEST_EFFORT 1: Best effort scheduler policy.
#define NVML_VGPU_SCHEDULER_POLICY_EQUAL_SHARE 2: Equal share scheduler policy.
#define NVML_VGPU_SCHEDULER_POLICY_FIXED_SHARE 3: Fixed share scheduler policy.
#define NVML_VGPU_SCHEDULER_POLICY_UNKNOWN 0: Unknown scheduler policy.
#define nvmlActiveVgpuInstanceInfo_v1: Version macro for nvmlActiveVgpuInstanceInfo_v1_t.
#define nvmlVgpuCreatablePlacementInfo_v1: Version macro for nvmlVgpuCreatablePlacementInfo_v1_t.
#define nvmlVgpuHeterogeneousMode_v1: Version macro for nvmlVgpuHeterogeneousMode_v1_t.
#define nvmlVgpuInstancesUtilizationInfo_v1: Version macro for nvmlVgpuInstancesUtilizationInfo_v1_t.
#define nvmlVgpuPlacementId_v1: Version macro for nvmlVgpuPlacementId_v1_t.
#define nvmlVgpuPlacementList_v1: Version macro for nvmlVgpuPlacementList_v1_t.
#define nvmlVgpuPlacementList_v2: Version macro for nvmlVgpuPlacementList_v2_t.
#define nvmlVgpuProcessesUtilizationInfo_v1: Version macro for nvmlVgpuProcessesUtilizationInfo_v1_t.
#define nvmlVgpuRuntimeState_v1: Version macro for nvmlVgpuRuntimeState_v1_t.
#define nvmlVgpuSchedulerLogInfo_v1: Version macro for nvmlVgpuSchedulerLogInfo_v1_t.
#define nvmlVgpuSchedulerStateInfo_v1: Version macro for nvmlVgpuSchedulerStateInfo_v1_t.
#define nvmlVgpuSchedulerState_v1: Version macro for nvmlVgpuSchedulerState_v1_t.
#define nvmlVgpuTypeBar1Info_v1: Version macro for nvmlVgpuTypeBar1Info_v1_t.
#define nvmlVgpuTypeIdInfo_v1: Version macro for nvmlVgpuTypeIdInfo_v1_t.
#define nvmlVgpuTypeMaxInstance_v1: Version macro for nvmlVgpuTypeMaxInstance_v1_t.

Enumerations

enum nvmlDeviceGpuRecoveryAction_t

Defines

#define NVML_GRID_LICENSE_STATE_LICENSED 5
#define NVML_GRID_LICENSE_STATE_UNINITIALIZED 1
#define NVML_GRID_LICENSE_STATE_UNKNOWN 0: vGPU license state
#define NVML_GRID_LICENSE_STATE_UNLICENSED 4
#define NVML_GRID_LICENSE_STATE_UNLICENSED_RESTRICTED 3
#define NVML_GRID_LICENSE_STATE_UNLICENSED_UNRESTRICTED 2
#define NVML_SCHEDULER_SW_MAX_LOG_ENTRIES 200
#define NVML_SUPPORTED_VGPU_SCHEDULER_POLICY_COUNT 3
#define NVML_VGPU_SCHEDULER_ARR_DEFAULT 0
#define NVML_VGPU_SCHEDULER_ARR_DISABLE 1
#define NVML_VGPU_SCHEDULER_ARR_ENABLE 2
#define NVML_VGPU_SCHEDULER_ENGINE_TYPE_GRAPHICS 1: vGPU scheduler engine types
#define NVML_VGPU_SCHEDULER_POLICY_BEST_EFFORT 1
#define NVML_VGPU_SCHEDULER_POLICY_EQUAL_SHARE 2
#define NVML_VGPU_SCHEDULER_POLICY_FIXED_SHARE 3
#define NVML_VGPU_SCHEDULER_POLICY_UNKNOWN 0: vGPU scheduler policies
#define nvmlActiveVgpuInstanceInfo_v1: Value

NVML_STRUCT_VERSION(ActiveVgpuInstanceInfo, 1)
#define nvmlVgpuCreatablePlacementInfo_v1: Value

NVML_STRUCT_VERSION(VgpuCreatablePlacementInfo, 1)
#define nvmlVgpuHeterogeneousMode_v1: Value

NVML_STRUCT_VERSION(VgpuHeterogeneousMode, 1)
#define nvmlVgpuInstancesUtilizationInfo_v1: Value

NVML_STRUCT_VERSION(VgpuInstancesUtilizationInfo, 1)
#define nvmlVgpuPlacementId_v1: Value

NVML_STRUCT_VERSION(VgpuPlacementId, 1)
#define nvmlVgpuPlacementList_v1: Value

NVML_STRUCT_VERSION(VgpuPlacementList, 1)
#define nvmlVgpuPlacementList_v2: Value

NVML_STRUCT_VERSION(VgpuPlacementList, 2)
#define nvmlVgpuProcessesUtilizationInfo_v1: Value

NVML_STRUCT_VERSION(VgpuProcessesUtilizationInfo, 1)
#define nvmlVgpuRuntimeState_v1: Value

NVML_STRUCT_VERSION(VgpuRuntimeState, 1)
#define nvmlVgpuSchedulerLogInfo_v1: Value

NVML_STRUCT_VERSION(VgpuSchedulerLogInfo, 1)
#define nvmlVgpuSchedulerStateInfo_v1: Value

NVML_STRUCT_VERSION(VgpuSchedulerStateInfo, 1)
#define nvmlVgpuSchedulerState_v1: Value

NVML_STRUCT_VERSION(VgpuSchedulerState, 1)
#define nvmlVgpuTypeBar1Info_v1: Value

NVML_STRUCT_VERSION(VgpuTypeBar1Info, 1)
#define nvmlVgpuTypeIdInfo_v1: Value

NVML_STRUCT_VERSION(VgpuTypeIdInfo, 1)
#define nvmlVgpuTypeMaxInstance_v1: Value

NVML_STRUCT_VERSION(VgpuTypeMaxInstance, 1)

Enumerations

enum nvmlDeviceGpuRecoveryAction_t

Enum describing the GPU Recovery Action

Values

NVML_GPU_RECOVERY_ACTION_NONE = 0
NVML_GPU_RECOVERY_ACTION_GPU_RESET = 1
NVML_GPU_RECOVERY_ACTION_NODE_REBOOT = 2
NVML_GPU_RECOVERY_ACTION_DRAIN_P2P = 3
NVML_GPU_RECOVERY_ACTION_DRAIN_AND_RESET = 4

< Previous | Next >

NVML API Reference Guide (PDF) - vR590 (older) - Last updated December 04, 2025 - Send Feedback