prometheus.prometheus.pve_exporter role – Prometheus Proxmox VE Exporter

Note

This role is part of the prometheus.prometheus collection (version 0.27.3).

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 prometheus.prometheus.

To use it in a playbook, specify: prometheus.prometheus.pve_exporter.

Entry point main – Prometheus Proxmox VE Exporter

Synopsis

Parameters

Parameter

Comments

pve_exporter_auth_pass

string

Authentication PVE user password if using user/password auth

pve_exporter_auth_token_name

string

Authentication PVE user token name if using token auth

Default: "your-token-id"

pve_exporter_auth_token_value

string

Authentication PVE user token value from `pveum user token add …`

pve_exporter_auth_user

string

Authentication PVE user name if using user/password auth

Default: "prometheus@pve"

pve_exporter_auth_verify_ssl

boolean

Validate proxmox certificate or not

Choices:

  • false

  • true ← (default)

pve_exporter_basic_auth_users

dictionary

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

pve_exporter_config_dir

string

Path to directory with pve_exporter configuration

Default: "/etc/pve_exporter"

pve_exporter_config_template

string

Configuration template for pve_exporter

Default: "pve_exporter.yml.j2"

pve_exporter_disabled_collectors

list / elements=string

List of disabled collectors.

By default pve_exporter disables collectors listed here.

pve_exporter_enabled_collectors

list / elements=string

List of dicts defining additionally enabled collectors and their configuration.

It adds collectors to those enabled by default.

Default: ["systemd", {"textfile": {"directory": "{{ pve_exporter_textfile_dir }}"}}]

pve_exporter_home

string

Home of pve_exporter user and base file locations

Default: "/var/lib/pve_exporter"

pve_exporter_http_server_config

dictionary

Config for HTTP/2 support.

Keys and values are the same as in pve_exporter docs.

pve_exporter_no_log

boolean

Advanced

Display/Log ansible tasks containing secrets

Choices:

  • false

  • true ← (default)

pve_exporter_set_credential

boolean

Advanced

Create pve_exporter user in proxmox

Choices:

  • false ← (default)

  • true

pve_exporter_system_group

string

Advanced

System group for pve exporter

Default: "pve-exp"

pve_exporter_system_user

string

Advanced

Proxmox VE Exporter user

Default: "pve-exp"

pve_exporter_textfile_dir

string

Directory used by the Textfile Collector.

To get permissions to write metrics in this directory, users must be in pve-exp system group.

Note: More information in TROUBLESHOOTING.md guide.

Default: "/var/lib/pve_exporter"

pve_exporter_tls_server_config

dictionary

Configuration for TLS authentication.

Keys and values are the same as in pve_exporter docs.

pve_exporter_version

string

Proxmox VE Exporter package version. Also accepts latest as parameter.

Default: "1.0.0"

pve_exporter_virtualenv

string

Python virtualenv filepath for pve_exporter

Default: "/var/lib/pve_exporter/venv"

pve_exporter_web_listen_address

string

Address on which pve exporter will listen

Default: "0.0.0.0:15353"

Authors

  • Prometheus Community