DCGM Library API Reference Guide :: GPU Deployment and Management Documentation

< Previous | Next >

DCGM Library API Reference Guide (PDF) - Last updated April 16, 2019 -

4. Data Fields

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

A

action: dcgmPolicy_v1
activeTimeUsec: dcgmDevicePidAccountingStats_v1
activeVgpuInstanceCount: dcgmVgpuDeviceAttributes_v6
activeVgpuInstanceIds: dcgmVgpuDeviceAttributes_v6
addressIsUnixSocket: dcgmConnectV2Params_v2
aggregateInfo: dcgmIntrospectFullFieldsExecTime_v1; dcgmIntrospectFullMemory_v1
average: dcgmStatSummaryInt64_t; dcgmStatSummaryInt32_t; dcgmStatSummaryFp64_t
averageFps: dcgmDeviceVgpuEncSessions_v1; dcgmDeviceEncStats_v1
averageLatency: dcgmDeviceVgpuEncSessions_v1; dcgmDeviceEncStats_v1

B

bar1Total: dcgmDeviceMemoryUsage_v1
blacklist: dcgmDiagResponse_v3
blob: dcgmFieldValue_v2; dcgmFieldValue_v1
boardLimitViolationTime: dcgmPidSingleInfo_t; dcgmGpuUsageInfo_t
brandName: dcgmDeviceIdentifiers_v1
bytesUsed: dcgmIntrospectMemory_v1

C

clockSet: dcgmDeviceSupportedClockSets_v1
clockSets: dcgmDeviceAttributes_v1
codecType: dcgmDeviceVgpuEncSessions_v1
computeMode: dcgmConfig_v1; dcgmVgpuConfig_v1
computePidInfo: dcgmGpuUsageInfo_t
condition: dcgmPolicyCallbackResponse_v1; dcgmPolicy_v1
count: dcgmGroupInfo_v1; dcgmGroupInfo_v2; dcgmDeviceSupportedClockSets_v1
counter: dcgmPolicyConditionNvlink_t; dcgmPolicyConditionPci_t
cpuAffinityMask: dcgmDeviceTopology_v1
creatableVgpuTypeCount: dcgmVgpuDeviceAttributes_v6
creatableVgpuTypeIds: dcgmVgpuDeviceAttributes_v6
cudaMainLibrary: dcgmDiagResponse_v3
cudaRuntimeLibrary: dcgmDiagResponse_v3
curPowerLimit: dcgmDevicePowerLimits_v1

D

dbe: dcgmPolicyCallbackResponse_v1
dbepages: dcgmPolicyConditionMpr_t
dbl: dcgmFieldValue_v2; dcgmFieldValue_v1
decUtil: dcgmDeviceVgpuUtilInfo_v1; dcgmVgpuDeviceAttributes_v6; dcgmDeviceVgpuProcessUtilInfo_v1
defaultPowerLimit: dcgmDevicePowerLimits_v1
deviceId: dcgmDeviceVgpuTypeInfo_v1
deviceName: dcgmDeviceIdentifiers_v1
driverVersion: dcgmDeviceIdentifiers_v1

E

eccDoubleBit: dcgmPidSingleInfo_t; dcgmGpuUsageInfo_t
eccMode: dcgmVgpuConfig_v1; dcgmConfig_v1
eccSingleBit: dcgmPidSingleInfo_t; dcgmGpuUsageInfo_t
encUtil: dcgmDeviceVgpuProcessUtilInfo_v1; dcgmVgpuDeviceAttributes_v6; dcgmDeviceVgpuUtilInfo_v1
endTime: dcgmPidSingleInfo_t; dcgmGpuUsageInfo_t
energyConsumed: dcgmPidSingleInfo_t; dcgmGpuUsageInfo_t
enforcedPowerLimit: dcgmDevicePowerLimits_v1
entityCount: dcgmHealthResponse_v2
entityGroupId: dcgmGroupEntityPair_t; dcgmFieldValue_v2; dcgmHealthResponse_v2
entityId: dcgmHealthResponse_v2; dcgmFieldValue_v2; dcgmGroupEntityPair_t
entityList: dcgmGroupInfo_v2
environment: dcgmDiagResponse_v3
errnum: dcgmPolicyConditionXID_t
errorString: dcgmHealthResponse_v1; dcgmHealthResponse_v2

F

fbFree: dcgmDeviceMemoryUsage_v1
fbTotal: dcgmDeviceMemoryUsage_v1; dcgmDeviceVgpuTypeInfo_v1
fbUsage: dcgmVgpuInstanceAttributes_v1
fbUsed: dcgmDeviceMemoryUsage_v1
fieldGroupId: dcgmFieldGroupInfo_v1; dcgmIntrospectContext_v1
fieldGroupName: dcgmFieldGroupInfo_v1
fieldId: dcgmFieldValue_v1; dcgmErrorInfo_t; dcgmPolicyConditionNvlink_t; dcgmFieldValue_v2
fieldIds: dcgmFieldGroupInfo_v1
fieldType: dcgmFieldValue_v1; dcgmFieldValue_v2
frameRateLimit: dcgmDeviceVgpuTypeInfo_v1; dcgmVgpuInstanceAttributes_v1

G

globalInfo: dcgmIntrospectFullFieldsExecTime_v1; dcgmIntrospectFullMemory_v1
gpuCount: dcgmDiagResponse_v3; dcgmHealthResponse_v1
gpuId: dcgmPolicyViolationNotify_t; dcgmHealthResponse_v1; dcgmErrorInfo_t; dcgmPidSingleInfo_t; dcgmGpuUsageInfo_t; dcgmConfig_v1; dcgmDiagResponsePerGpu_t; dcgmDeviceTopology_v1; dcgmVgpuConfig_v1
gpuIdList: dcgmGroupInfo_v1
gpuIdsForGpuInfo: dcgmIntrospectFullMemory_v1; dcgmIntrospectFullFieldsExecTime_v1
gpuInfo: dcgmIntrospectFullFieldsExecTime_v1; dcgmIntrospectFullMemory_v1
gpuInfoCount: dcgmIntrospectFullMemory_v1; dcgmIntrospectFullFieldsExecTime_v1
gpus: dcgmPidInfo_v1; dcgmJobInfo_v2
gpuUtil: dcgmVgpuDeviceAttributes_v6
gpuUtilization: dcgmDevicePidAccountingStats_v1
graphicsPidInfo: dcgmGpuUsageInfo_t
graphicsProcesses: dcgmDiagResponse_v3
groupCpuAffinityMask: dcgmGroupTopology_v1
groupName: dcgmGroupInfo_v1; dcgmGroupInfo_v2

H

hasGlobalInfo: dcgmIntrospectFullFieldsExecTime_v1; dcgmIntrospectFullMemory_v1
health: dcgmHealthResponse_v2; dcgmGpuUsageInfo_t; dcgmPidSingleInfo_t; dcgmHealthResponse_v1
hResolution: dcgmDeviceVgpuEncSessions_v1
hwDiagnosticReturn: dcgmDiagResponsePerGpu_t

I

i64: dcgmFieldValue_v1; dcgmFieldValue_v2
identifiers: dcgmDeviceAttributes_v1
incidentCount: dcgmHealthResponse_v1; dcgmHealthResponse_v2
inforom: dcgmDiagResponse_v3
inforomImageVersion: dcgmDeviceIdentifiers_v1
introspectLvl: dcgmIntrospectContext_v1
isolation: dcgmPolicy_v1

K

kernel: dcgmIntrospectCpuUtil_v1

L

licenseStatus: dcgmVgpuInstanceAttributes_v1
localNvLinkIds: dcgmDeviceTopology_v1
location: dcgmPolicyConditionDbe_t
lowUtilizationTime: dcgmPidSingleInfo_t; dcgmGpuUsageInfo_t

M

maxGpuMemoryUsed: dcgmPidSingleInfo_t; dcgmGpuUsageInfo_t
maxInstances: dcgmDeviceVgpuTypeInfo_v1
maxMemoryUsage: dcgmDevicePidAccountingStats_v1
maxPowerLimit: dcgmDevicePowerLimits_v1
maxResolutionX: dcgmDeviceVgpuTypeInfo_v1
maxResolutionY: dcgmDeviceVgpuTypeInfo_v1
maxValue: dcgmStatSummaryInt64_t; dcgmStatSummaryInt32_t; dcgmStatSummaryFp64_t
meanUpdateFreqUsec: dcgmIntrospectFieldsExecTime_v1
memClock: dcgmClockSet_v1
memCopyUtil: dcgmVgpuDeviceAttributes_v6
memoryClock: dcgmPidSingleInfo_t; dcgmGpuUsageInfo_t
memoryUsage: dcgmDeviceAttributes_v1
memoryUsed: dcgmRunningProcess_v1
memoryUtilization: dcgmPidSingleInfo_t; dcgmDevicePidAccountingStats_v1; dcgmGpuUsageInfo_t
memUtil: dcgmDeviceVgpuUtilInfo_v1; dcgmDeviceVgpuProcessUtilInfo_v1
minPowerLimit: dcgmDevicePowerLimits_v1
minValue: dcgmStatSummaryInt32_t; dcgmStatSummaryFp64_t; dcgmStatSummaryInt64_t
mode: dcgmPolicy_v1
mpr: dcgmPolicyCallbackResponse_v1

N

numaOptimalFlag: dcgmGroupTopology_v1
numComputePids: dcgmGpuUsageInfo_t
numDisplayHeads: dcgmDeviceVgpuTypeInfo_v1
numerrors: dcgmPolicyConditionDbe_t
numFieldIds: dcgmFieldGroupInfo_v1
numGpus: dcgmDeviceTopology_v1; dcgmPidInfo_v1; dcgmJobInfo_v2
numGraphicsPids: dcgmGpuUsageInfo_t
numOtherComputePids: dcgmPidSingleInfo_t
numOtherGraphicsPids: dcgmPidSingleInfo_t
numXidCriticalErrors: dcgmGpuUsageInfo_t; dcgmPidSingleInfo_t
nvlink: dcgmPolicyCallbackResponse_v1
nvmlLibrary: dcgmDiagResponse_v3

O

otherComputePids: dcgmPidSingleInfo_t
otherGraphicsPids: dcgmPidSingleInfo_t
overallHealth: dcgmPidSingleInfo_t; dcgmHealthResponse_v2; dcgmHealthResponse_v1; dcgmGpuUsageInfo_t

P

pageRetirement: dcgmDiagResponse_v3
parms: dcgmPolicy_v1
path: dcgmDeviceTopology_v1
pci: dcgmPolicyCallbackResponse_v1
pciBusId: dcgmDeviceIdentifiers_v1
pciDeviceId: dcgmDeviceIdentifiers_v1
pcieReplays: dcgmGpuUsageInfo_t; dcgmPidSingleInfo_t
pcieRxBandwidth: dcgmPidSingleInfo_t; dcgmGpuUsageInfo_t
pcieTxBandwidth: dcgmPidSingleInfo_t; dcgmGpuUsageInfo_t
pciSubSystemId: dcgmDeviceIdentifiers_v1
perfState: dcgmConfig_v1; dcgmVgpuConfig_v1
perGpuResponses: dcgmDiagResponse_v3
permissions: dcgmDiagResponse_v3
persistAfterDisconnect: dcgmConnectV2Params_v1; dcgmConnectV2Params_v2
persistenceMode: dcgmDiagResponse_v3
pid: dcgmDevicePidAccountingStats_v1; dcgmDeviceVgpuEncSessions_v1; dcgmRunningProcess_v1; dcgmPidInfo_v1; dcgmDeviceVgpuProcessUtilInfo_v1
power: dcgmPolicyCallbackResponse_v1
powerLimit: dcgmConfig_v1; dcgmVgpuConfig_v1
powerLimits: dcgmDeviceAttributes_v1
powerUsage: dcgmGpuUsageInfo_t
powerViolation: dcgmPolicyConditionPower_t
powerViolationTime: dcgmPidSingleInfo_t; dcgmGpuUsageInfo_t
processName: dcgmDeviceVgpuProcessUtilInfo_v1
processUtilization: dcgmPidSingleInfo_t

R

recentUpdateUsec: dcgmIntrospectFieldsExecTime_v1
reliabilityViolationTime: dcgmPidSingleInfo_t; dcgmGpuUsageInfo_t
response: dcgmPolicy_v1
results: dcgmDiagResponsePerGpu_t

S

sbepages: dcgmPolicyConditionMpr_t
serial: dcgmDeviceIdentifiers_v1
sessionCount: dcgmDeviceEncStats_v1
sessionId: dcgmDeviceVgpuEncSessions_v1
shutdownTemp: dcgmDeviceThermals_v1
slowdownTemp: dcgmDeviceThermals_v1
slowestPath: dcgmGroupTopology_v1
smClock: dcgmClockSet_v1; dcgmPidSingleInfo_t; dcgmGpuUsageInfo_t
smUtil: dcgmDeviceVgpuUtilInfo_v1; dcgmDeviceVgpuProcessUtilInfo_v1
smUtilization: dcgmPidSingleInfo_t; dcgmGpuUsageInfo_t
startTime: dcgmGpuUsageInfo_t; dcgmPidSingleInfo_t
startTimestamp: dcgmDevicePidAccountingStats_v1
status: dcgmErrorInfo_t; dcgmFieldValue_v1; dcgmFieldValue_v2
str: dcgmFieldValue_v1; dcgmFieldValue_v2
subsystemId: dcgmDeviceVgpuTypeInfo_v1
summary: dcgmJobInfo_v2; dcgmPidInfo_v1
supportedVgpuTypeCount: dcgmVgpuDeviceAttributes_v6
supportedVgpuTypeInfo: dcgmVgpuDeviceAttributes_v6
syncBoost: dcgmConfigPerfStateSettings_t
syncBoostTime: dcgmGpuUsageInfo_t; dcgmPidSingleInfo_t
system: dcgmHealthResponse_v1; dcgmHealthResponse_v2; dcgmGpuUsageInfo_t; dcgmPidSingleInfo_t
systemError: dcgmDiagResponse_v3

T

targetClocks: dcgmConfigPerfStateSettings_t
thermal: dcgmPolicyCallbackResponse_v1
thermalSettings: dcgmDeviceAttributes_v1
thermalViolation: dcgmPolicyConditionThermal_t
thermalViolationTime: dcgmPidSingleInfo_t; dcgmGpuUsageInfo_t
timeoutMs: dcgmConnectV2Params_v2
timestamp: dcgmPolicyConditionDbe_t; dcgmPolicyConditionPci_t; dcgmPolicyConditionMpr_t; dcgmPolicyConditionThermal_t; dcgmPolicyConditionPower_t; dcgmPolicyConditionNvlink_t; dcgmPolicyConditionXID_t
total: dcgmIntrospectCpuUtil_v1
totalEverUpdateUsec: dcgmIntrospectFieldsExecTime_v1
ts: dcgmFieldValue_v2; dcgmFieldValue_v1
type: dcgmConfigPowerLimit_t

U

unused: dcgmFieldValue_v2
unusedActiveVgpuInstanceCount: dcgmDeviceAttributes_v1
unusedcreatableVgpuTypeCount: dcgmDeviceVgpuIds_v1
unusedcreatableVgpuTypeIds: dcgmDeviceVgpuIds_v1
unusedSupportedVgpuTypeCount: dcgmDeviceVgpuIds_v1
unusedSupportedVgpuTypeIds: dcgmDeviceVgpuIds_v1
unusedVgpuIds: dcgmDeviceAttributes_v1
unusedVgpuInstanceIds: dcgmDeviceAttributes_v1
user: dcgmIntrospectCpuUtil_v1
uuid: dcgmDeviceIdentifiers_v1

V

val: dcgmConfigPowerLimit_t
validation: dcgmPolicy_v1
value: dcgmFieldValue_v2; dcgmFieldValue_v1
vbios: dcgmDeviceIdentifiers_v1
version: dcgmGroupInfo_v1; dcgmDeviceIdentifiers_v1; dcgmFieldValue_v2; dcgmHealthResponse_v1; dcgmDeviceMemoryUsage_v1; dcgmHealthResponse_v2; dcgmPidInfo_v1; dcgmGroupInfo_v2; dcgmDeviceVgpuUtilInfo_v1; dcgmJobInfo_v2; dcgmRunningProcess_v1; dcgmDeviceEncStats_v1; dcgmDiagResponse_v3; dcgmIntrospectCpuUtil_v1; dcgmIntrospectFullMemory_v1; dcgmIntrospectMemory_v1; dcgmIntrospectFullFieldsExecTime_v1; dcgmIntrospectFieldsExecTime_v1; dcgmIntrospectContext_v1; dcgmDeviceTopology_v1; dcgmFieldGroupInfo_v1; dcgmDeviceVgpuEncSessions_v1; dcgmGroupTopology_v1; dcgmDeviceVgpuProcessUtilInfo_v1; dcgmClockSet_v1; dcgmDeviceVgpuIds_v1; dcgmDeviceVgpuTypeInfo_v1; dcgmConnectV2Params_v1; dcgmFieldValue_v1; dcgmPolicyCallbackResponse_v1; dcgmPolicy_v1; dcgmVgpuConfig_v1; dcgmConfig_v1; dcgmVgpuInstanceAttributes_v1; dcgmDeviceSupportedClockSets_v1; dcgmDeviceAttributes_v1; dcgmVgpuDeviceAttributes_v6; dcgmDevicePidAccountingStats_v1; dcgmConnectV2Params_v2; dcgmDeviceThermals_v1; dcgmDevicePowerLimits_v1
vgpuDriverVersion: dcgmVgpuInstanceAttributes_v1
vgpuId: dcgmDeviceVgpuEncSessions_v1; dcgmDeviceVgpuProcessUtilInfo_v1; dcgmDeviceVgpuUtilInfo_v1
vgpuProcessSamplesCount: dcgmDeviceVgpuProcessUtilInfo_v1
vgpuTypeClass: dcgmDeviceVgpuTypeInfo_v1
vgpuTypeId: dcgmVgpuInstanceAttributes_v1
vgpuTypeInfo: dcgmDeviceVgpuTypeInfo_v1
vgpuTypeLicense: dcgmDeviceVgpuTypeInfo_v1
vgpuTypeName: dcgmDeviceVgpuTypeInfo_v1
vgpuUtilInfo: dcgmVgpuDeviceAttributes_v6
vgpuUuid: dcgmVgpuInstanceAttributes_v1
violationOccurred: dcgmPolicyViolationNotify_t
virtualizationMode: dcgmDeviceIdentifiers_v1
vmId: dcgmVgpuInstanceAttributes_v1
vmName: dcgmVgpuInstanceAttributes_v1
vResolution: dcgmDeviceVgpuEncSessions_v1

X

xid: dcgmPolicyCallbackResponse_v1
xidCriticalErrorsTs: dcgmGpuUsageInfo_t; dcgmPidSingleInfo_t