1.12. Modules

This chapter describes the methods that query and configure DCGM modules.

Functions

dcgmReturn_t dcgmModuleBlacklist ( dcgmHandle_t pDcgmHandle, dcgmModuleId_t moduleId )
dcgmReturn_t dcgmModuleGetStatuses ( dcgmHandle_t pDcgmHandle, dcgmModuleGetStatuses_t* moduleStatuses )

Functions

dcgmReturn_t dcgmModuleBlacklist ( dcgmHandle_t pDcgmHandle, dcgmModuleId_t moduleId )
Parameters
pDcgmHandle
IN: DCGM Handle
moduleId
IN: ID of the module to blacklist. Use dcgmModuleGetStatuses to get a list of valid module IDs.
Returns

Description

Set a module to be blacklisted. This module will be prevented from being loaded if it hasn't been loaded already. Modules are lazy-loaded as they are used by DCGM APIs, so it's important to call this API soon after the host engine has been started. You can also pass --blacklist-modules to the nv-hostengine binary to make sure modules get blacklisted immediately after the host engine starts up.

dcgmReturn_t dcgmModuleGetStatuses ( dcgmHandle_t pDcgmHandle, dcgmModuleGetStatuses_t* moduleStatuses )
Parameters
pDcgmHandle
IN: DCGM Handle
moduleStatuses
OUT: Module statuses. .version should be set to dcgmModuleStatuses_version upon calling.
Returns

Description

Get the status of all of the DCGM modules.