Is this page helpful?

vGPU Enums#

Macros#

NVML_GRID_LICENSE_EXPIRY_INVALID: Invalid expiry or error fetching expiry.
NVML_GRID_LICENSE_EXPIRY_NOT_APPLICABLE: Expiry not applicable.
NVML_GRID_LICENSE_EXPIRY_NOT_AVAILABLE: Status codes for license expiry.
NVML_GRID_LICENSE_EXPIRY_PERMANENT: Permanent expiry.
NVML_GRID_LICENSE_EXPIRY_VALID: Valid expiry.

Enumerations#

nvmlDeviceVgpuCapability_t: Device vGPU queryable capabilities.
nvmlGpuVirtualizationMode_t
nvmlGridLicenseFeatureCode_t: vGPU software licensable features
nvmlHostVgpuMode_t: Host vGPU modes.
nvmlVgpuCapability_t: vGPU queryable capabilities
nvmlVgpuDriverCapability_t: vGPU driver queryable capabilities
nvmlVgpuGuestInfoState_t: vGPU GUEST info state
nvmlVgpuVmIdType_t

Macros#

NVML_GRID_LICENSE_EXPIRY_INVALID#: Invalid expiry or error fetching expiry.

NVML_GRID_LICENSE_EXPIRY_NOT_APPLICABLE#: Expiry not applicable.

NVML_GRID_LICENSE_EXPIRY_NOT_AVAILABLE#

Status codes for license expiry.

Expiry information not available

NVML_GRID_LICENSE_EXPIRY_PERMANENT#: Permanent expiry.

NVML_GRID_LICENSE_EXPIRY_VALID#: Valid expiry.

Enumerations#

enum nvmlDeviceVgpuCapability_t#

Device vGPU queryable capabilities.

Values:

enumerator NVML_DEVICE_VGPU_CAP_FRACTIONAL_MULTI_VGPU#: Query whether the fractional vGPU profiles on this GPU can be used in multi-vGPU configurations.

enumerator NVML_DEVICE_VGPU_CAP_HETEROGENEOUS_TIMESLICE_PROFILES#: Query whether the GPU support concurrent execution of timesliced vGPU profiles of differing types.

enumerator NVML_DEVICE_VGPU_CAP_HETEROGENEOUS_TIMESLICE_SIZES#: Query whether the GPU support concurrent execution of timesliced vGPU profiles of differing framebuffer sizes.

enumerator NVML_DEVICE_VGPU_CAP_READ_DEVICE_BUFFER_BW#: Query the GPU’s read_device_buffer expected bandwidth capacity in megabytes per second.

enumerator NVML_DEVICE_VGPU_CAP_WRITE_DEVICE_BUFFER_BW#: Query the GPU’s write_device_buffer expected bandwidth capacity in megabytes per second.

enumerator NVML_DEVICE_VGPU_CAP_DEVICE_STREAMING#: Query whether the vGPU profiles on the GPU supports migration data streaming.

enumerator NVML_DEVICE_VGPU_CAP_MINI_QUARTER_GPU#: Set/Get support for mini-quarter vGPU profiles.

enumerator NVML_DEVICE_VGPU_CAP_COMPUTE_MEDIA_ENGINE_GPU#: Set/Get support for compute media engine vGPU profiles.

enumerator NVML_DEVICE_VGPU_CAP_WARM_UPDATE#: Query whether the GPU supports FSR and warm update.

enumerator NVML_DEVICE_VGPU_CAP_HOMOGENEOUS_PLACEMENTS#: Query whether the GPU supports reporting of placements of timesliced vGPU profiles with identical framebuffer sizes.

enumerator NVML_DEVICE_VGPU_CAP_MIG_TIMESLICING_SUPPORTED#: Query whether the GPU supports timesliced vGPU on MIG.

enumerator NVML_DEVICE_VGPU_CAP_MIG_TIMESLICING_ENABLED#: Set/Get MIG timesliced mode reporting, without impacting the underlying functionality.

enumerator NVML_DEVICE_VGPU_CAP_COUNT#

enum nvmlGpuVirtualizationMode_t#

GPU virtualization mode types.

Values:

enumerator NVML_GPU_VIRTUALIZATION_MODE_NONE#: Represents Bare Metal GPU.

enumerator NVML_GPU_VIRTUALIZATION_MODE_PASSTHROUGH#: Device is associated with GPU-Passthorugh.

enumerator NVML_GPU_VIRTUALIZATION_MODE_VGPU#: Device is associated with vGPU inside virtual machine.

enumerator NVML_GPU_VIRTUALIZATION_MODE_HOST_VGPU#: Device is associated with VGX hypervisor in vGPU mode.

enumerator NVML_GPU_VIRTUALIZATION_MODE_HOST_VSGA#: Device is associated with VGX hypervisor in vSGA mode.

enum nvmlGridLicenseFeatureCode_t#

vGPU software licensable features

Values:

enumerator NVML_GRID_LICENSE_FEATURE_CODE_UNKNOWN#: Unknown.

enumerator NVML_GRID_LICENSE_FEATURE_CODE_VGPU#: Virtual GPU.

enumerator NVML_GRID_LICENSE_FEATURE_CODE_NVIDIA_RTX#: Nvidia RTX.

enumerator NVML_GRID_LICENSE_FEATURE_CODE_VWORKSTATION#: Deprecated, do not use.

enumerator NVML_GRID_LICENSE_FEATURE_CODE_GAMING#: Gaming.

enumerator NVML_GRID_LICENSE_FEATURE_CODE_COMPUTE#: Compute.

enumerator NVML_GRID_LICENSE_FEATURE_CODE_VGAMEDEV#: vGameDev

enum nvmlHostVgpuMode_t#

Host vGPU modes.

Values:

enumerator NVML_HOST_VGPU_MODE_NON_SRIOV#: Non SR-IOV mode.

enumerator NVML_HOST_VGPU_MODE_SRIOV#: SR-IOV mode.

enum nvmlVgpuCapability_t#

vGPU queryable capabilities

Values:

enumerator NVML_VGPU_CAP_NVLINK_P2P#: P2P over NVLink is supported.

enumerator NVML_VGPU_CAP_GPUDIRECT#: GPUDirect capability is supported.

enumerator NVML_VGPU_CAP_MULTI_VGPU_EXCLUSIVE#: vGPU profile cannot be mixed with other vGPU profiles in same VM

enumerator NVML_VGPU_CAP_EXCLUSIVE_TYPE#: vGPU profile cannot run on a GPU alongside other profiles of different type

enumerator NVML_VGPU_CAP_EXCLUSIVE_SIZE#: vGPU profile cannot run on a GPU alongside other profiles of different size

enumerator NVML_VGPU_CAP_COUNT#

enum nvmlVgpuDriverCapability_t#

vGPU driver queryable capabilities

Values:

enumerator NVML_VGPU_DRIVER_CAP_HETEROGENEOUS_MULTI_VGPU#: Supports mixing of different vGPU profiles within one guest VM.

enumerator NVML_VGPU_DRIVER_CAP_WARM_UPDATE#: Supports FSR and warm update of vGPU host driver without terminating the running guest VM.

enumerator NVML_VGPU_DRIVER_CAP_COUNT#

enum nvmlVgpuGuestInfoState_t#

vGPU GUEST info state

Values:

enumerator NVML_VGPU_INSTANCE_GUEST_INFO_STATE_UNINITIALIZED#: Guest-dependent fields uninitialized.

enumerator NVML_VGPU_INSTANCE_GUEST_INFO_STATE_INITIALIZED#: Guest-dependent fields initialized.

enum nvmlVgpuVmIdType_t#

Types of VM identifiers

Values:

enumerator NVML_VGPU_VM_ID_DOMAIN_ID#: VM ID represents DOMAIN ID.

enumerator NVML_VGPU_VM_ID_UUID#: VM ID represents UUID.