mahendrapaipuri.ansible.nvidia_dcgm_exporter role – nVIDIA DCGM Exporter

Note

This role is part of the mahendrapaipuri.ansible collection (version 0.4.2).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it use: ansible-galaxy collection install mahendrapaipuri.ansible.

To use it in a playbook, specify: mahendrapaipuri.ansible.nvidia_dcgm_exporter.

Entry point main – nVIDIA DCGM Exporter

Synopsis

Parameters

Parameter

Comments

nvidia_dcgm_exporter_basic_auth_users

dictionary

Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt.

nvidia_dcgm_exporter_binary_install_dir

string

Advanced

Directory to install nvidia_dcgm_exporter binary

Default: "/usr/local/bin"

nvidia_dcgm_exporter_binary_local_dir

string

Enables the use of local packages instead of those distributed on github.

The parameter may be set to a directory where the nvidia_dcgm_exporter binary is stored on the host where ansible is run.

This overrides the nvidia_dcgm_exporter_version parameter

nvidia_dcgm_exporter_cli_args

list / elements=string

Advanced

Additional CLI arguments that will be passed to nVIDIA DCGM exporter

nvidia_dcgm_exporter_create_system_user_group

string

Advanced

Create system user and group for nVIDIA DCGM exporter

Default: true

nvidia_dcgm_exporter_git_url

string

URL of the dcgm exporter git repository

Default: "https://github.com/NVIDIA/dcgm-exporter.git"

nvidia_dcgm_exporter_http_server_config

dictionary

Config for HTTP/2 support.

Keys and values are the same as in Prometheus docs.

nvidia_dcgm_exporter_metrics_config_file

string

Path to CSV file that containe list of collectors for dcgm exporter.

An example file can be found at dcgm-exporter repo

Default: "counters.csv"

nvidia_dcgm_exporter_skip_install

boolean

DCGM exporter installation tasks gets skipped when set to true.

Choices:

  • false ← (default)

  • true

nvidia_dcgm_exporter_system_group

string

Advanced

System group for nVIDIA DCGM exporter

Default: "dcgm-exp"

nvidia_dcgm_exporter_system_user

string

Advanced

nVIDIA DCGM exporter user

Default: "dcgm-exp"

nvidia_dcgm_exporter_tls_server_config

dictionary

Configuration for TLS authentication.

Keys and values are the same as in Prometheus docs.

nvidia_dcgm_exporter_version

string

nVIDIA DCGM exporter package version. Also accepts latest as parameter.

Default: "3.3.9-3.6.1"

nvidia_dcgm_exporter_web_listen_address

string

Address on which dcgm exporter will listen

Default: "0.0.0.0:9400"

Authors

  • Mahendra Paipuri