dcgmi fieldgroup#

NAME#

dcgmi-fieldgroup - create and manage groups of DCGM field IDs

SYNOPSIS#

dcgmi fieldgroup (--list | -l) [--json] [--host <address>]
dcgmi fieldgroup (--create | -c) <name> --fieldids <field-id-list>
                 [--host <address>]
dcgmi fieldgroup --info --fieldgroup <field-group-id>
                 [--json] [--host <address>]
dcgmi fieldgroup --delete --fieldgroup <field-group-id>
                 [--host <address>]

DESCRIPTION#

dcgmi fieldgroup manages persistent collections of DCGM field IDs. A field group can be passed to dcgmi dmon and used through the DCGM APIs so that the same telemetry set does not need to be repeated for every operation.

The host engine validates every field ID when the group is created.

OPTIONS#

-l, --list: List all field groups.
-c <name>, --create <name>: Create a field group with the specified name. Names must be unique in the host engine, and --fieldids is required.
-f <field-id-list>, --fieldids <field-id-list>: Set 1 through 128 comma-separated numeric field IDs in a new field group.
-i, --info: Display the name and field IDs in the group selected by --fieldgroup.
-d, --delete: Delete the group selected by --fieldgroup.
-g <field-group-id>, --fieldgroup <field-group-id>: Select a field group by its numeric ID.
-j, --json: Use JSON for --list or --info output. In DCGM 4.6, --info emits one JSON document. --list first prints a plain-text count and then emits one JSON document per field group; it is not a single JSON document. See JSON output.
--host <address>: Connect to the specified host engine.
-h, --help: Print generated usage information and exit.

FIELD IDS AND LIFETIME#

Use dcgmi dmon --list to enumerate the field IDs, long names, and short column names known to the local dcgmi. That list is a metadata catalogue, not a guarantee that every field is supported by every entity on the current hardware. The complete static catalogue is Field Identifiers; Field Scope identifies entity scope, and Field Types identifies value types. An unsupported or unavailable monitored value is printed as N/A by dcgmi dmon.

The host engine assigns each new field group a numeric ID. Discover IDs with dcgmi fieldgroup --list. A field group remains after the creating client disconnects, but is an object in the running host engine and is not restored after that process exits. A host engine can hold at most 64 field groups, including groups used internally by DCGM. Internal field groups can be inspected but cannot be deleted.

EXAMPLES#

Create a group for fields 50, 51, and 52:

$ dcgmi fieldgroup --create temperatures --fieldids 50,51,52

List field groups and inspect group 5:

$ dcgmi fieldgroup --list

$ dcgmi fieldgroup --info --fieldgroup 5

Monitor all GPUs with field group 5:

$ dcgmi dmon --field-group-id 5