NVML API Reference Guide :: GPU Deployment and Management Documentation

< Previous | Next >

NVML API Reference Guide (PDF) - vR560 (older) - Last updated August 7, 2024 - Send Feedback

6. Data Fields

Here is a list of all documented struct and union fields with links to the struct/union documentation for each field:

A

aggregateCor: nvmlEccSramErrorStatus_v1_t
aggregateUncBucketL2: nvmlEccSramErrorStatus_v1_t
aggregateUncBucketMcu: nvmlEccSramErrorStatus_v1_t
aggregateUncBucketOther: nvmlEccSramErrorStatus_v1_t
aggregateUncBucketPcie: nvmlEccSramErrorStatus_v1_t
aggregateUncBucketSm: nvmlEccSramErrorStatus_v1_t
aggregateUncParity: nvmlEccSramErrorStatus_v1_t
aggregateUncSecDed: nvmlEccSramErrorStatus_v1_t
arrMode: nvmlVgpuSchedulerLog_t; nvmlVgpuSchedulerGetState_t
averageFps: nvmlEncoderSessionInfo_t
averageFPS: nvmlFBCSessionInfo_t; nvmlFBCStats_t
averageLatency: nvmlFBCStats_t; nvmlFBCSessionInfo_t; nvmlEncoderSessionInfo_t
avgFactor: nvmlVgpuSchedulerParams_t; nvmlVgpuSchedulerSetParams_t

B

bar1Free: nvmlBAR1Memory_t
bar1Size: nvmlVgpuTypeBar1Info_v1_t
bar1Total: nvmlBAR1Memory_t
bar1Used: nvmlBAR1Memory_t
baseClass: nvmlPciInfoExt_v1_t
bGlobalStatus: nvmlClkMonStatus_t
branch: nvmlSystemDriverBranchInfo_v1_t
bridgeChipInfo: nvmlBridgeChipHierarchy_t
bridgeCount: nvmlBridgeChipHierarchy_t
bThresholdExceeded: nvmlEccSramErrorStatus_v1_t
bus: nvmlPciInfoExt_v1_t; nvmlPciInfo_t
busId: nvmlPciInfo_t; nvmlPciInfoExt_v1_t
busIdLegacy: nvmlPciInfo_t

C

capabilities: nvmlGpuInstanceProfileInfo_v3_t; nvmlComputeInstanceProfileInfo_v3_t
capMask: nvmlDeviceCapabilities_v1_t
cause: nvmlLedState_t
cliqueId: nvmlGpuFabricInfo_t; nvmlGpuFabricInfo_v2_t
clkApiDomain: nvmlClkMonFaultInfo_t
clkDomainFaultMask: nvmlClkMonFaultInfo_t
clkMonList: nvmlClkMonStatus_t
clkMonListSize: nvmlClkMonStatus_t
clusterUuid: nvmlGpuFabricInfo_t; nvmlGpuFabricInfo_v2_t
codecType: nvmlEncoderSessionInfo_t
color: nvmlLedState_t
compatibilityLimitCode: nvmlVgpuPgpuCompatibility_t
computeInstanceId: nvmlProcessInfo_t; nvmlProcessDetail_v1_t; nvmlEventData_t
copyEngineCount: nvmlGpuInstanceProfileInfo_v2_t; nvmlGpuInstanceProfileInfo_t; nvmlGpuInstanceProfileInfo_v3_t
count: nvmlVgpuPlacementList_v1_t; nvmlUnitFanSpeeds_t
cumulativePreemptionTime: nvmlVgpuSchedulerLogEntry_t
current: nvmlPSUInfo_t

D

day: nvmlVgpuLicenseExpiry_t; nvmlGridLicenseExpiry_t
decoderCount: nvmlGpuInstanceProfileInfo_v2_t; nvmlGpuInstanceProfileInfo_v3_t; nvmlGpuInstanceProfileInfo_t
decUtil: nvmlVgpuInstanceUtilizationSample_t; nvmlVgpuInstanceUtilizationInfo_v1_t; nvmlVgpuProcessUtilizationSample_t; nvmlVgpuProcessUtilizationInfo_v1_t; nvmlProcessUtilizationSample_t; nvmlProcessUtilizationInfo_v1_t
device: nvmlPciInfo_t; nvmlEventData_t; nvmlPciInfoExt_v1_t
deviceMemory: nvmlEccErrorCounts_t
displayOrdinal: nvmlFBCSessionInfo_t
domain: nvmlPciInfoExt_v1_t; nvmlPciInfo_t
dVal: nvmlValue_t

E

enableARRMode: nvmlVgpuSchedulerSetState_t
encoderCount: nvmlGpuInstanceProfileInfo_t; nvmlGpuInstanceProfileInfo_v3_t; nvmlGpuInstanceProfileInfo_v2_t
encUtil: nvmlVgpuInstanceUtilizationInfo_v1_t; nvmlVgpuProcessUtilizationInfo_v1_t; nvmlVgpuProcessUtilizationSample_t; nvmlProcessUtilizationSample_t; nvmlVgpuInstanceUtilizationSample_t; nvmlProcessUtilizationInfo_v1_t
engineId: nvmlVgpuSchedulerLog_t
entriesCount: nvmlVgpuSchedulerLog_t
eventData: nvmlEventData_t
eventType: nvmlEventData_t

F

fans: nvmlUnitFanSpeeds_t
featureCode: nvmlGridLicensableFeature_t
featureEnabled: nvmlGridLicensableFeature_t
featureState: nvmlGridLicensableFeature_t
fieldId: nvmlFieldValue_t
firmwareVersion: nvmlUnitInfo_t
free: nvmlMemory_t; nvmlMemory_v2_t
frequency: nvmlVgpuSchedulerSetParams_t
fwVersion: nvmlBridgeChipInfo_t

G

gpu: nvmlUtilization_t
gpuInstanceId: nvmlProcessInfo_t; nvmlEventData_t; nvmlProcessDetail_v1_t
gpuUtilization: nvmlAccountingStats_t
gridLicensableFeatures: nvmlGridLicensableFeatures_t
guestDriverVersion: nvmlVgpuMetadata_t
guestInfoState: nvmlVgpuMetadata_t
guestVgpuVersion: nvmlVgpuMetadata_t

H

healthMask: nvmlGpuFabricInfo_v2_t
hMaxResolution: nvmlFBCSessionInfo_t
hostDriverVersion: nvmlVgpuPgpuMetadata_t; nvmlVgpuMetadata_t
hostSupportedVgpuRange: nvmlVgpuPgpuMetadata_t
hour: nvmlVgpuLicenseExpiry_t; nvmlGridLicenseExpiry_t
hResolution: nvmlFBCSessionInfo_t; nvmlEncoderSessionInfo_t

I

id: nvmlUnitInfo_t; nvmlGpuInstanceProfileInfo_t; nvmlGpuInstanceProfileInfo_v3_t; nvmlComputeInstanceProfileInfo_t; nvmlGpuInstanceProfileInfo_v2_t; nvmlComputeInstanceProfileInfo_v2_t; nvmlComputeInstanceProfileInfo_v3_t
instanceCount: nvmlGpuInstanceProfileInfo_t; nvmlGpuInstanceProfileInfo_v2_t; nvmlGpuInstanceProfileInfo_v3_t; nvmlComputeInstanceProfileInfo_t; nvmlComputeInstanceProfileInfo_v2_t; nvmlComputeInstanceProfileInfo_v3_t
isArrModeSupported: nvmlVgpuSchedulerCapabilities_t
isGridLicenseSupported: nvmlGridLicensableFeatures_t
isP2pSupported: nvmlGpuInstanceProfileInfo_t; nvmlGpuInstanceProfileInfo_v2_t
isRunning: nvmlAccountingStats_t
isSupportedDevice: nvmlGpmSupport_t

J

jpegCount: nvmlGpuInstanceProfileInfo_t; nvmlGpuInstanceProfileInfo_v2_t; nvmlGpuInstanceProfileInfo_v3_t
jpgUtil: nvmlProcessUtilizationInfo_v1_t; nvmlVgpuInstanceUtilizationInfo_v1_t; nvmlVgpuProcessUtilizationInfo_v1_t

L

l1Cache: nvmlEccErrorCounts_t
l2Cache: nvmlEccErrorCounts_t
lastSeenTimeStamp: nvmlVgpuInstancesUtilizationInfo_v1_t; nvmlVgpuProcessesUtilizationInfo_v1_t; nvmlProcessesUtilizationInfo_v1_t
latencyUsec: nvmlFieldValue_t
licensableFeaturesCount: nvmlGridLicensableFeatures_t
licenseExpiry: nvmlGridLicensableFeature_t
licenseInfo: nvmlGridLicensableFeature_t

M

maxAvgFactorForARR: nvmlVgpuSchedulerCapabilities_t
maxFrequencyForARR: nvmlVgpuSchedulerCapabilities_t
maxMemoryUsage: nvmlAccountingStats_t
maxTimeslice: nvmlVgpuSchedulerCapabilities_t
maxVersion: nvmlVgpuVersion_t
memory: nvmlUtilization_t
memorySizeMB: nvmlGpuInstanceProfileInfo_v2_t; nvmlGpuInstanceProfileInfo_v3_t; nvmlGpuInstanceProfileInfo_t
memoryUtilization: nvmlAccountingStats_t
memUtil: nvmlVgpuProcessUtilizationInfo_v1_t; nvmlProcessUtilizationSample_t; nvmlProcessUtilizationInfo_v1_t; nvmlVgpuInstanceUtilizationSample_t; nvmlVgpuInstanceUtilizationInfo_v1_t; nvmlVgpuProcessUtilizationSample_t
metricId: nvmlGpmMetric_t
metricInfo: nvmlGpmMetric_t
metrics: nvmlGpmMetricsGet_t
min: nvmlVgpuLicenseExpiry_t; nvmlGridLicenseExpiry_t
minAvgFactorForARR: nvmlVgpuSchedulerCapabilities_t
minFrequencyForARR: nvmlVgpuSchedulerCapabilities_t
minTimeslice: nvmlVgpuSchedulerCapabilities_t
minVersion: nvmlVgpuVersion_t
mode: nvmlVgpuHeterogeneousMode_v1_t; nvmlProcessDetailList_v1_t
month: nvmlGridLicenseExpiry_t; nvmlVgpuLicenseExpiry_t
multiprocessorCount: nvmlGpuInstanceProfileInfo_v3_t; nvmlGpuInstanceProfileInfo_v2_t; nvmlComputeInstanceProfileInfo_v3_t; nvmlGpuInstanceProfileInfo_t; nvmlComputeInstanceProfileInfo_v2_t; nvmlComputeInstanceProfileInfo_t

N

name: nvmlUnitInfo_t; nvmlGpuInstanceProfileInfo_v2_t; nvmlComputeInstanceProfileInfo_v2_t; nvmlComputeInstanceProfileInfo_v3_t; nvmlGpuInstanceProfileInfo_v3_t
numMetrics: nvmlGpmMetricsGet_t
numProcArrayEntries: nvmlProcessDetailList_v1_t
nvmlReturn: nvmlFieldValue_t; nvmlGpmMetric_t

O

ofaCount: nvmlGpuInstanceProfileInfo_t; nvmlGpuInstanceProfileInfo_v2_t; nvmlGpuInstanceProfileInfo_v3_t
ofaUtil: nvmlProcessUtilizationInfo_v1_t; nvmlVgpuInstanceUtilizationInfo_v1_t; nvmlVgpuProcessUtilizationInfo_v1_t
opaqueData: nvmlVgpuMetadata_t; nvmlVgpuPgpuMetadata_t
opaqueDataSize: nvmlVgpuMetadata_t; nvmlVgpuPgpuMetadata_t

P

pciDeviceId: nvmlPciInfoExt_v1_t; nvmlPciInfo_t
pciInfo: nvmlExcludedDeviceInfo_t
pciSubSystemId: nvmlPciInfoExt_v1_t; nvmlPciInfo_t
pgpuVirtualizationCaps: nvmlVgpuPgpuMetadata_t
pid: nvmlProcessInfo_t; nvmlProcessDetail_v1_t; nvmlProcessUtilizationSample_t; nvmlProcessUtilizationInfo_v1_t; nvmlVgpuProcessUtilizationSample_t; nvmlVgpuProcessUtilizationInfo_v1_t; nvmlProcessInfo_v1_t; nvmlEncoderSessionInfo_t; nvmlFBCSessionInfo_t
placementId: nvmlVgpuPlacementId_v1_t
placementIds: nvmlVgpuPlacementList_v1_t
placementSize: nvmlVgpuPlacementList_v1_t
power: nvmlPSUInfo_t
powerScope: nvmlPowerValue_v2_t
powerValueMw: nvmlPowerValue_v2_t
procArray: nvmlProcessDetailList_v1_t
processName: nvmlVgpuProcessUtilizationSample_t; nvmlVgpuProcessUtilizationInfo_v1_t
processSamplesCount: nvmlProcessesUtilizationInfo_v1_t
procUtilArray: nvmlProcessesUtilizationInfo_v1_t
productName: nvmlGridLicensableFeature_t

R

referenceTime: nvmlViolationTime_t
registerFile: nvmlEccErrorCounts_t
reserved: nvmlAccountingStats_t; nvmlVgpuPgpuMetadata_t; nvmlVgpuMetadata_t; nvmlMemory_v2_t
revision: nvmlVgpuPgpuMetadata_t; nvmlVgpuMetadata_t

S

sample1: nvmlGpmMetricsGet_t
sample2: nvmlGpmMetricsGet_t
sampleValType: nvmlVgpuInstancesUtilizationInfo_v1_t
sampleValue: nvmlSample_t
schedulerPolicy: nvmlVgpuSchedulerLog_t; nvmlVgpuSchedulerGetState_t; nvmlVgpuSchedulerSetState_t
scopeId: nvmlFieldValue_t
sec: nvmlVgpuLicenseExpiry_t; nvmlGridLicenseExpiry_t
serial: nvmlUnitInfo_t
sessionFlags: nvmlFBCSessionInfo_t
sessionId: nvmlEncoderSessionInfo_t; nvmlFBCSessionInfo_t
sessionsCount: nvmlFBCStats_t
sessionType: nvmlFBCSessionInfo_t
sharedCopyEngineCount: nvmlComputeInstanceProfileInfo_t; nvmlComputeInstanceProfileInfo_v2_t; nvmlComputeInstanceProfileInfo_v3_t
sharedDecoderCount: nvmlComputeInstanceProfileInfo_t; nvmlComputeInstanceProfileInfo_v2_t; nvmlComputeInstanceProfileInfo_v3_t
sharedEncoderCount: nvmlComputeInstanceProfileInfo_t; nvmlComputeInstanceProfileInfo_v2_t; nvmlComputeInstanceProfileInfo_v3_t
sharedJpegCount: nvmlComputeInstanceProfileInfo_t; nvmlComputeInstanceProfileInfo_v2_t; nvmlComputeInstanceProfileInfo_v3_t
sharedOfaCount: nvmlComputeInstanceProfileInfo_t; nvmlComputeInstanceProfileInfo_v2_t; nvmlComputeInstanceProfileInfo_v3_t
siVal: nvmlValue_t
size: nvmlGpuInstancePlacement_t
sliceCount: nvmlComputeInstanceProfileInfo_v3_t; nvmlGpuInstanceProfileInfo_t; nvmlGpuInstanceProfileInfo_v3_t; nvmlComputeInstanceProfileInfo_t; nvmlComputeInstanceProfileInfo_v2_t; nvmlGpuInstanceProfileInfo_v2_t
sllVal: nvmlValue_t
smUtil: nvmlVgpuInstanceUtilizationInfo_v1_t; nvmlVgpuInstanceUtilizationSample_t; nvmlProcessUtilizationInfo_v1_t; nvmlProcessUtilizationSample_t; nvmlVgpuProcessUtilizationSample_t; nvmlVgpuProcessUtilizationInfo_v1_t
speed: nvmlUnitFanInfo_t
start: nvmlGpuInstancePlacement_t
startTime: nvmlAccountingStats_t
state: nvmlPSUInfo_t; nvmlGpuFabricInfo_v2_t; nvmlGpuFabricInfo_t; nvmlUnitFanInfo_t
status: nvmlGpuFabricInfo_t; nvmlGridLicenseExpiry_t; nvmlGpuFabricInfo_v2_t; nvmlVgpuLicenseExpiry_t
subClass: nvmlPciInfoExt_v1_t
supportedSchedulers: nvmlVgpuSchedulerCapabilities_t
swRunlistId: nvmlVgpuSchedulerLogEntry_t

T

targetTimeSlice: nvmlVgpuSchedulerLogEntry_t
time: nvmlAccountingStats_t
timeRun: nvmlVgpuSchedulerLogEntry_t
timeRunTotal: nvmlVgpuSchedulerLogEntry_t
timeslice: nvmlVgpuSchedulerParams_t; nvmlVgpuSchedulerSetParams_t
timeStamp: nvmlVgpuInstanceUtilizationInfo_v1_t; nvmlVgpuProcessUtilizationInfo_v1_t; nvmlProcessUtilizationInfo_v1_t
timestamp: nvmlFieldValue_t
timeStamp: nvmlSample_t; nvmlProcessUtilizationSample_t
timestamp: nvmlVgpuSchedulerLogEntry_t
timeStamp: nvmlVgpuInstanceUtilizationSample_t; nvmlVgpuProcessUtilizationSample_t
total: nvmlMemory_t; nvmlMemory_v2_t
type: nvmlBridgeChipInfo_t

U

uiVal: nvmlValue_t
ullVal: nvmlValue_t
ulVal: nvmlValue_t
used: nvmlMemory_t; nvmlMemory_v2_t
usedGpuCcProtectedMemory: nvmlProcessDetail_v1_t
usedGpuMemory: nvmlProcessInfo_t; nvmlProcessDetail_v1_t; nvmlProcessInfo_v1_t
usVal: nvmlValue_t
uuid: nvmlExcludedDeviceInfo_t

V

value: nvmlFieldValue_t; nvmlGpmMetric_t
valueType: nvmlFieldValue_t
version: nvmlPciInfoExt_v1_t; nvmlProcessesUtilizationInfo_v1_t; nvmlGpuFabricInfo_v2_t; nvmlPowerValue_v2_t; nvmlEccSramErrorStatus_v1_t; nvmlSystemDriverBranchInfo_v1_t; nvmlVgpuMetadata_t; nvmlMemory_v2_t; nvmlVgpuHeterogeneousMode_v1_t; nvmlVgpuPgpuMetadata_t; nvmlGpuInstanceProfileInfo_v2_t; nvmlVgpuPlacementId_v1_t; nvmlGpuInstanceProfileInfo_v3_t; nvmlComputeInstanceProfileInfo_v2_t; nvmlProcessDetailList_v1_t; nvmlVgpuPlacementList_v1_t; nvmlComputeInstanceProfileInfo_v3_t; nvmlGpmMetricsGet_t; nvmlVgpuTypeBar1Info_v1_t; nvmlGpmSupport_t; nvmlDeviceCapabilities_v1_t; nvmlClockOffset_v1_t; nvmlVgpuInstancesUtilizationInfo_v1_t; nvmlVgpuProcessesUtilizationInfo_v1_t
vgpuInstance: nvmlEncoderSessionInfo_t; nvmlFBCSessionInfo_t; nvmlVgpuInstanceUtilizationInfo_v1_t; nvmlVgpuProcessUtilizationSample_t; nvmlVgpuInstanceUtilizationSample_t; nvmlVgpuProcessUtilizationInfo_v1_t
vgpuInstanceCount: nvmlVgpuInstancesUtilizationInfo_v1_t
vgpuProcessCount: nvmlVgpuProcessesUtilizationInfo_v1_t
vgpuProcUtilArray: nvmlVgpuProcessesUtilizationInfo_v1_t
vgpuUtilArray: nvmlVgpuInstancesUtilizationInfo_v1_t
vgpuVirtualizationCaps: nvmlVgpuMetadata_t
vgpuVmCompatibility: nvmlVgpuPgpuCompatibility_t
violationTime: nvmlViolationTime_t
vMaxResolution: nvmlFBCSessionInfo_t
volatileCor: nvmlEccSramErrorStatus_v1_t
volatileUncParity: nvmlEccSramErrorStatus_v1_t
volatileUncSecDed: nvmlEccSramErrorStatus_v1_t
voltage: nvmlPSUInfo_t
vResolution: nvmlEncoderSessionInfo_t; nvmlFBCSessionInfo_t

Y

year: nvmlVgpuLicenseExpiry_t; nvmlGridLicenseExpiry_t

< Previous | Next >

NVML API Reference Guide (PDF) - vR560 (older) - Last updated August 7, 2024 - Send Feedback