dcgmi modules#

NAME#

dcgmi-modules - list and denylist DCGM host-engine modules

SYNOPSIS#

dcgmi modules --list [--json] [--host <address>]
dcgmi modules --denylist <module> [--json] [--host <address>]

DESCRIPTION#

dcgmi modules reports the state of each host-engine module or prevents a module that has not yet loaded from loading. Modules are loaded lazily when an API first needs them.

A module that is already loaded cannot be denylisted. To guarantee that a module is unavailable, configure the denylist when nv-hostengine starts. The core module is always loaded and cannot be denylisted.

OPTIONS#

-l, --list

List module IDs, names, and states.

--denylist <module>

Add one module to the host engine’s denylist. <module> can be a numeric ID or a case-insensitive name from the following table.

DCGM modules#
ID	Name	Purpose
0	`Core`	Core DCGM services; always loaded
1	`NvSwitch`	NVSwitch management
2	`VGPU`	Virtual GPU management
3	`Introspection`	Host-engine resource introspection
4	`Health`	Background health monitoring
5	`Policy`	Policy management
6	`Config`	GPU configuration
7	`Diag`	Active diagnostics
8	`Profiling`	Profiling metrics
9	`SysMon`	System monitoring
10	`MnDiag`	Multi-node diagnostics

-j, --json

Use JSON output. See JSON output.

--host <address>

Connect to the specified host engine.

-h, --help

Print generated usage information and exit.

MODULE STATES#

States emitted by `--list`#
State	Meaning
`Not loaded`	The lazy-loaded module has not yet been used and is eligible for `--denylist`
`Denylisted`	This host engine will refuse to load the module
`Failed to load`	A load was attempted and failed; inspect host-engine logs for the cause
`Loaded`	The module is resident and available
`Unloaded`	The module was unloaded during shutdown
`Paused`	The loaded module is temporarily paused and will return to `Loaded` when resumed
`Reloadable`	The module is loaded and supports being reloaded

A normal first listing can contain both Loaded and Not loaded states; the latter does not indicate a load failure. Running a command that uses a module can cause it to transition to Loaded.

DENYLIST LIFETIME#

modules --denylist affects the running host-engine process and is not written to a persistent configuration file. It succeeds only while the module is Not loaded. Startup denylisting is documented with nv-hostengine --denylist-modules in nv-hostengine.

EXAMPLES#

List module states:

$ dcgmi modules --list

Denylist the profiling module before it is loaded:

$ dcgmi modules --denylist Profiling