1.1.2. Auxilary information about DCGM engine.
[Administrative]
Describes APIs to get generic information about the DCGM Engine.
Functions
- dcgmReturn_t dcgmHostengineIsHealthy ( dcgmHandle_t pDcgmHandle, dcgmHostengineHealth_t* heHealth )
- dcgmReturn_t dcgmHostengineSetLoggingSeverity ( dcgmHandle_t pDcgmHandle, dcgmSettingsSetLoggingSeverity_t* logging )
- dcgmReturn_t dcgmHostengineVersionInfo ( dcgmHandle_t pDcgmHandle, dcgmVersionInfo_t* pVersionInfo )
- dcgmReturn_t dcgmVersionInfo ( dcgmVersionInfo_t* pVersionInfo )
Functions
- dcgmReturn_t dcgmHostengineIsHealthy ( dcgmHandle_t pDcgmHandle, dcgmHostengineHealth_t* heHealth )
-
Parameters
- pDcgmHandle
- - the handle to DCGM
- heHealth
- - struct describing the health of the hostengine. if heHealth.hostengineHealth is 0, then the hostengine is healthy. Non-zero indicates not healthy with error codes determining the cause.
Description
This function is used to return whether or not the host engine considers itself healthy
- dcgmReturn_t dcgmHostengineSetLoggingSeverity ( dcgmHandle_t pDcgmHandle, dcgmSettingsSetLoggingSeverity_t* logging )
-
Parameters
- pDcgmHandle
- IN: DCGM Handle
- logging
- IN: dcgmSettingsSetLoggingSeverity_t struct containing the target logger and severity
Returns
- DCGM_ST_OK Severity successfuly set
- DCGM_ST_BADPARAM Bad logger/severity string
- DCGM_ST_VER_MISMATCH if the expected and provided versions of dcgmSettingsSetLoggingSeverity_t do not match
Description
This method is used to set the logging severity on HostEngine for the specified logger
- dcgmReturn_t dcgmHostengineVersionInfo ( dcgmHandle_t pDcgmHandle, dcgmVersionInfo_t* pVersionInfo )
-
Parameters
- pDcgmHandle
- IN: DCGM Handle that came from dcgmConnect
- pVersionInfo
- OUT: Build environment information
Returns
- DCGM_ST_OK if build information is sucessfully obtained
- DCGM_ST_BADPARAM if pVersionInfo is null
- DCGM_ST_VER_MISMATCH if the expected and provided versions of dcgmVersionInfo_t do not match
Description
This method is used to return information about the build environment of the hostengine.
- dcgmReturn_t dcgmVersionInfo ( dcgmVersionInfo_t* pVersionInfo )
-
Parameters
- pVersionInfo
- OUT: Build environment information
Returns
- DCGM_ST_OK if build information is sucessfully obtained
- DCGM_ST_BADPARAM if pVersionInfo is null
- DCGM_ST_VER_MISMATCH if the expected and provided versions of dcgmVersionInfo_t do not match
Description
This method is used to return information about the build environment where DCGM was built.