NVML API Reference Guide (PDF) - vR550 (older) - Last updated March 12, 2024 - Send Feedback

4.30.1. vGPU Enums

[VirtualGPU]

Defines

#define NVML_GRID_LICENSE_EXPIRY_INVALID 1
Invalid expiry or error fetching expiry.
#define NVML_GRID_LICENSE_EXPIRY_NOT_APPLICABLE 3
Expiry not applicable.
#define NVML_GRID_LICENSE_EXPIRY_NOT_AVAILABLE 0
Expiry information not available.
#define NVML_GRID_LICENSE_EXPIRY_PERMANENT 4
Permanent expiry.
#define NVML_GRID_LICENSE_EXPIRY_VALID 2
Valid expiry.

Enumerations

enum nvmlDeviceVgpuCapability_t
enum nvmlGpuVirtualizationMode_t
enum nvmlGridLicenseFeatureCode_t
enum nvmlHostVgpuMode_t
enum nvmlVgpuCapability_t
enum nvmlVgpuDriverCapability_t
enum nvmlVgpuGuestInfoState_t
enum nvmlVgpuVmIdType_t

Defines

#define NVML_GRID_LICENSE_EXPIRY_INVALID 1

#define NVML_GRID_LICENSE_EXPIRY_NOT_APPLICABLE 3

#define NVML_GRID_LICENSE_EXPIRY_NOT_AVAILABLE 0

Status codes for license expiry

#define NVML_GRID_LICENSE_EXPIRY_PERMANENT 4

#define NVML_GRID_LICENSE_EXPIRY_VALID 2

Enumerations

enum nvmlDeviceVgpuCapability_t

Device vGPU queryable capabilities

Values
NVML_DEVICE_VGPU_CAP_FRACTIONAL_MULTI_VGPU = 0
Query if the fractional vGPU profiles on this GPU can be used in multi-vGPU configurations.
NVML_DEVICE_VGPU_CAP_HETEROGENEOUS_TIMESLICE_PROFILES = 1
Query if the GPU support concurrent execution of timesliced vGPU profiles of differing types.
NVML_DEVICE_VGPU_CAP_HETEROGENEOUS_TIMESLICE_SIZES = 2
Query if the GPU support concurrent execution of timesliced vGPU profiles of differing framebuffer sizes.
NVML_DEVICE_VGPU_CAP_READ_DEVICE_BUFFER_BW = 3
Query the GPU's read_device_buffer expected bandwidth capacity in megabytes per second.
NVML_DEVICE_VGPU_CAP_WRITE_DEVICE_BUFFER_BW = 4
Query the GPU's write_device_buffer expected bandwidth capacity in megabytes per second.
NVML_DEVICE_VGPU_CAP_DEVICE_STREAMING = 5
Query if vGPU profiles on the GPU supports migration data streaming.
NVML_DEVICE_VGPU_CAP_MINI_QUARTER_GPU = 6
Set/Get support for mini-quarter vGPU profiles.
NVML_DEVICE_VGPU_CAP_COMPUTE_MEDIA_ENGINE_GPU = 7
Set/Get support for compute media engine vGPU profiles.
NVML_DEVICE_VGPU_CAP_COUNT
enum nvmlGpuVirtualizationMode_t

GPU virtualization mode types.

Values
NVML_GPU_VIRTUALIZATION_MODE_NONE = 0
Represents Bare Metal GPU.
NVML_GPU_VIRTUALIZATION_MODE_PASSTHROUGH = 1
Device is associated with GPU-Passthorugh.
NVML_GPU_VIRTUALIZATION_MODE_VGPU = 2
Device is associated with vGPU inside virtual machine.
NVML_GPU_VIRTUALIZATION_MODE_HOST_VGPU = 3
Device is associated with VGX hypervisor in vGPU mode.
NVML_GPU_VIRTUALIZATION_MODE_HOST_VSGA = 4
Device is associated with VGX hypervisor in vSGA mode.
enum nvmlGridLicenseFeatureCode_t

vGPU software licensable features

Values
NVML_GRID_LICENSE_FEATURE_CODE_UNKNOWN = 0
Unknown.
NVML_GRID_LICENSE_FEATURE_CODE_VGPU = 1
Virtual GPU.
NVML_GRID_LICENSE_FEATURE_CODE_NVIDIA_RTX = 2
Nvidia RTX.
NVML_GRID_LICENSE_FEATURE_CODE_VWORKSTATION = NVML_GRID_LICENSE_FEATURE_CODE_NVIDIA_RTX
Deprecated, do not use.
NVML_GRID_LICENSE_FEATURE_CODE_GAMING = 3
Gaming.
NVML_GRID_LICENSE_FEATURE_CODE_COMPUTE = 4
Compute.
enum nvmlHostVgpuMode_t

Host vGPU modes

Values
NVML_HOST_VGPU_MODE_NON_SRIOV = 0
Non SR-IOV mode.
NVML_HOST_VGPU_MODE_SRIOV = 1
SR-IOV mode.
enum nvmlVgpuCapability_t

vGPU queryable capabilities

Values
NVML_VGPU_CAP_NVLINK_P2P = 0
P2P over NVLink is supported.
NVML_VGPU_CAP_GPUDIRECT = 1
GPUDirect capability is supported.
NVML_VGPU_CAP_MULTI_VGPU_EXCLUSIVE = 2
vGPU profile cannot be mixed with other vGPU profiles in same VM
NVML_VGPU_CAP_EXCLUSIVE_TYPE = 3
vGPU profile cannot run on a GPU alongside other profiles of different type
NVML_VGPU_CAP_EXCLUSIVE_SIZE = 4
vGPU profile cannot run on a GPU alongside other profiles of different size
NVML_VGPU_CAP_COUNT
enum nvmlVgpuDriverCapability_t

vGPU driver queryable capabilities

Values
NVML_VGPU_DRIVER_CAP_HETEROGENEOUS_MULTI_VGPU = 0
Supports mixing of different vGPU profiles within one guest VM.
NVML_VGPU_DRIVER_CAP_COUNT
enum nvmlVgpuGuestInfoState_t

vGPU GUEST info state

Values
NVML_VGPU_INSTANCE_GUEST_INFO_STATE_UNINITIALIZED = 0
Guest-dependent fields uninitialized.
NVML_VGPU_INSTANCE_GUEST_INFO_STATE_INITIALIZED = 1
Guest-dependent fields initialized.
enum nvmlVgpuVmIdType_t

Types of VM identifiers

Values
NVML_VGPU_VM_ID_DOMAIN_ID = 0
VM ID represents DOMAIN ID.
NVML_VGPU_VM_ID_UUID = 1
VM ID represents UUID.

NVML API Reference Guide (PDF) - vR550 (older) - Last updated March 12, 2024 - Send Feedback