NVML API Reference Guide (PDF) - vR470 (older) - Last updated July 29, 2021 - Send Feedback

2.28.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 nvmlGpuVirtualizationMode_t
enum nvmlGridLicenseFeatureCode_t
enum nvmlHostVgpuMode_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 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 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) - vR470 (older) - Last updated July 29, 2021 - Send Feedback