Skip to content

Latest commit

 

History

History
193 lines (178 loc) · 42.7 KB

File metadata and controls

193 lines (178 loc) · 42.7 KB

Ansible Role: trippsc2.zabbix.agent2

Version: 1.1.8

This role installs the Zabbix Agent 2 on a Linux or Windows system.

Requirements

Platform Versions
Debian
  • bullseye
  • bookworm
EL
  • 8
  • 9
Ubuntu
  • focal
  • jammy
  • noble
Windows
  • 2019
  • 2022

Dependencies

Collection
ansible.posix
ansible.windows
chocolatey.chocolatey
community.general
community.vmware
community.zabbix

Role Arguments

Option Description Type Required Choices Default
zbxagent_major_version

The major version of the Zabbix Agent 2 to install.

On Linux systems, this is required.

On Windows systems, this is ignored and the latest version is always installed. If this becomes an issue, the role will be ammended to allow for version selection.

str no
  • 7.2
  • 7.0
zbxagent_configure_logrotate

Whether to configure logrotate for the Zabbix Agent 2 log file.

On Windows, this is ignored.

If zbxagent_log_type is set to file, this is true by default. Otherwise, it is false.

If set to true, the zbxagent_log_size should be set to 0 to prevent conflicts.

bool no True
zbxagent_configure_firewall

Whether to configure the host firewall for use with Zabbix Agent 2.

bool no True
zbxagent_install_ember_plus_plugin

Whether to install the Ember+ plugin for the Zabbix Agent 2 on Linux systems.

On Windows, this is ignored.

bool no False
zbxagent_install_mongodb_plugin

Whether to install the MongoDB plugin for the Zabbix Agent 2.

bool no False
zbxagent_install_mssql_plugin

Whether to install the MSSQL plugin for the Zabbix Agent 2.

bool no False
zbxagent_install_pgsql_plugin

Whether to install the PostgreSQL plugin for the Zabbix Agent 2.

bool no False
zbxagent_user

The user as which the Zabbix Agent 2 service will run.

On Windows, this is ignored.

If not set to zabbix, the user must be created before running this role.

str no zabbix
zbxagent_group

The primary group of the user as which the Zabbix Agent 2 service will run.

On Windows, this is ignored.

If not set to zabbix, the group must be created before running this role.

str no zabbix
zbxagent_pid_file

The path to the PID file for the Zabbix Agent 2 service.

On Windows, this is ignored.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#pidfile

str no /run/zabbix/zabbix_agent2.pid
zbxagent_log_type

The type of logging to use for the Zabbix Agent 2.

The value system is only supported on Linux systems.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#logtype

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#logtype

str no
  • file
  • console
  • system
file
zbxagent_log_file

The path to the log file for the Zabbix Agent 2.

For Linux systems, this is /var/log/zabbix/zabbix_agent2.log by default.

For Windows systems, this is C:\ProgramData\Zabbix Agent 2\zabbix_agent2.log by default.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#logfile

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#logfile

path no
zbxagent_log_file_size

The maximum size of the log file in MB.

Valid values are between 0 and 1024.

If set to 0, the log file will not be rotated.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#logfilesize

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#logfilesize

int no 0
zbxagent_source_ip

The IP address to use as the source IP for active checks.

If not specified, the default behavior is to use the IP address of the default route.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#sourceip

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#sourceip

str no
zbxagent_servers

A list of Zabbix servers for which the agent will allow connections.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#server

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#server

list of 'str' yes
zbxagent_listen_port

The port on which the Zabbix Agent 2 will listen for connections.

Valid values are between 1024 and 32767.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#listenport

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#listenport

int no 10050
zbxagent_listen_ip

The IP address on which the Zabbix Agent 2 will listen for connections.

If not specified, the default behavior is to listen on all available IP addresses.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#listenip

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#listenip

str no
zbxagent_status_port

The port on which the Zabbix Agent 2 will host the HTTP status page.

If not specified, the default behavior is to not host the HTTP status page.

Valid values are between 1024 and 32767.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#statusport

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#statusport

int no
zbxagent_active_servers

A list of Zabbix servers to which the agent will send active check data.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#serveractive

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#serveractive

list of 'str' yes
zbxagent_hostname

The hostname of the Zabbix Agent 2.

If not specified, the default behavior is to use the hostname of the machine.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#hostname

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#hostname

str no
zbxagent_hostname_item

The item key to use for the hostname of the Zabbix Agent 2.

If not specified, the default behavior is to use the system.hostname item key.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#hostnameitem

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#hostnameitem

str no
zbxagent_host_metadata

The metadata to associate with the Zabbix Agent 2 host.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#hostmetadata

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#hostmetadata

str no
zbxagent_host_metadata_item

The item key to use for the metadata of the Zabbix Agent 2 host.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#hostmetadataitem

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#hostmetadataitem

str no
zbxagent_host_interface

The host interface to use during autoregistration.

If not specified, the default behavior is to use the IP address of the default route.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#hostinterface

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#hostinterface

str no
zbxagent_host_interface_item

The item key to use for the host interface during autoregistration.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#hostinterfaceitem

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#hostinterfaceitem

str no
zbxagent_refresh_active_checks

The interval at which the Zabbix Agent 2 will refresh active checks in seconds.

Valid values are between 1 and 86400.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#refreshactivechecks

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#refreshactivechecks

int no 5
zbxagent_buffer_send

The number of values to buffer before sending to the Zabbix server.

Valid values are between 1 and 3600.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#buffersend

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#buffersend

int no 5
zbxagent_buffer_size

The number of values to buffer before flushing to the server or proxy.

This is ignored if zbxagent_enable_persistent_buffer is true.

Valid values are between 2 and 65535.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#buffersize

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#buffersize

int no 1000
zbxagent_enable_persistent_buffer

Whether to enable the persistent buffer for the Zabbix Agent 2.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#enablepersistentbuffer

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#enablepersistentbuffer

bool no False
zbxagent_persistent_buffer_period

The period at which the persistent buffer will be flushed to the server or proxy.

Valid values are in the duration formats Xs, Xm, Xh, or Xd.

Valid values are between 1m and 365d.

If zbxagent_enable_persistent_buffer is false, this is ignored. Otherwise, it is required.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#persistentbufferperiod

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#persistentbufferperiod

str no 1h
zbxagent_persistent_buffer_file

The path to the persistent buffer SQLite file.

If zbxagent_enable_persistent_buffer is false, this is ignored. Otherwise, it is required.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#persistentbufferfile

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#persistentbufferfile

path no
zbxagent_heartbeat_frequency

The interval at which the Zabbix Agent 2 will send heartbeat messages in seconds.

If set to 0, the heartbeat messages will not be sent.

Valid values are between 0 and 3600.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#heartbeatfrequency

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#heartbeatfrequency

int no 60
zbxagent_aliases

A dictionary of aliases for items, triggers, and graphs.

The key is the alias name and the value is the item key, trigger expression, or graph name. (e.g. Alias=key:value)

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#aliases

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#aliases

dict no
zbxagent_timeout

The timeout for active checks in seconds.

Valid values are between 1 and 30.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#timeout

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#timeout

int no 3
zbxagent_include_files

A list of configuration files to include in the Zabbix Agent 2 configuration.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#include

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#include

list of 'path' no []
zbxagent_include_directories

A list of directories to include in the Zabbix Agent 2 configuration.

This will include the directory and all .conf files within it.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#include

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#include

list of 'path' no []
zbxagent_plugin_timeout

The timeout for plugin execution in seconds.

If not specified, the zbxagent_timeout value will be used.

Valid values are between 1 and 30.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#plugintimeout

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#plugintimeout

int no
zbxagent_plugin_socket

The path to the control socket for plugin execution.

On Windows, this is ignored.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#pluginsocket

path no
zbxagent_unsafe_user_parameters

Whether to allow parameters without sanitization.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#unsafeuserparameters

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#unsafeuserparameters

bool no False
zbxagent_user_parameters

A dictionary of user parameters.

The key is the user parameter name and the value is the command to execute. (e.g. UserParameter=,)

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#userparameters

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#userparameter

dict no
zbxagent_user_parameter_dir

The working directory when executing scripts for user parameters.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#userparameterdir

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#userparameterdir

path no
zbxagent_control_socket

The path to the control socket for the Zabbix Agent 2.

On Windows, this is ignored.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#controlsocket

path no /tmp/agent.sock
zbxagent_tls_connect

The type of connection to use for connections to the Zabbix server for active checks.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#tlsconnect

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#tlsconnect

str no
  • unencrypted
  • psk
  • cert
unencrypted
zbxagent_tls_accept

The type of connection to accept for connections from the Zabbix server.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#tlsaccept

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#tlsaccept

str no
  • unencrypted
  • psk
  • cert
unencrypted
zbxagent_tls_ca_file

The path to the top level CA certificate file for validating TLS certificates.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#tlscafile

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#tlscafile

path no
zbxagent_tls_crl_file

The path to the certificate revocation list file for validating TLS certificates.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#tlscrlfile

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#tlscrlfile

path no
zbxagent_tls_server_cert_issuer

The issuer of the certificate used to validate the Zabbix server.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#tlsservercertissuer

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#tlsservercertissuer

str no
zbxagent_tls_server_cert_subject

The subject of the certificate used to validate the Zabbix server.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#tlsservercertsubject

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#tlsservercertsubject

str no
zbxagent_tls_cert_file

The path to the server certificate file or server certificate chain file for the Zabbix Agent 2.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#tlscertfile

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#tlscertfile

path no
zbxagent_tls_key_file

The path to the server private key file for the Zabbix Agent 2.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#tlskeyfile

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#tlskeyfile

path no
zbxagent_tls_psk_identity

The PSK identity string for the Zabbix Agent 2.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#tlspskidentity

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#tlspskidentity

str no
zbxagent_tls_psk_file

The path to the PSK file for the Zabbix Agent 2.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#tlspskfile

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#tlspskfile

path no
zbxagent_log_max_lines_per_second

The maximum number of log lines per second to send to the Zabbix server/proxy for monitoring.

Valid values are between 1 and 1000.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#logmaxlinespersecond

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#logmaxlinespersecond

int no 20
zbxagent_systemrun_log_remote_commands

Whether to log remote commands in the systemrun log.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#systemrunlogremotecommands

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#systemrunlogremotecommands

bool no False
zbxagent_plugin_parameters

A dictionary of parameters for plugins.

The key is the plugin name and the value is a dictionary of parameters.

See individual plugin documentation for valid parameters.

dict no
zbxagent_ember_plus_default_uri

The default URI for the Ember+ plugin.

This is ignored on Windows systems or if zbxagent_install_ember_plus_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/ember_plus_plugin

str no
zbxagent_ember_plus_keepalive

The interval at which the Ember+ plugin will send keepalive messages in seconds.

Valid values are between 60 and 900.

This is ignored on Windows systems or if zbxagent_install_ember_plus_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/ember_plus_plugin

int no
zbxagent_ember_plus_sessions

A list of Ember+ sessions to configure.

This is ignored on Windows systems or if zbxagent_install_ember_plus_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/ember_plus_plugin

list of dicts of 'zbxagent_ember_plus_sessions' options no []
zbxagent_ember_plus_system_path

The path to the Ember+ system file.

This is ignored on Windows systems or if zbxagent_install_ember_plus_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/ember_plus_plugin

path no
zbxagent_ember_plus_timeout

The timeout for Ember+ plugin requests in seconds.

Valid values are between 1 and 30.

This is ignored on Windows systems or if zbxagent_install_ember_plus_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/ember_plus_plugin

int no
zbxagent_mongodb_default_password

The default password for the MongoDB plugin.

This is ignored if zbxagent_install_mongodb_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mongodb_plugin

str no
zbxagent_mongodb_default_uri

The default URI for the MongoDB plugin.

This is ignored if zbxagent_install_mongodb_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mongodb_plugin

str no
zbxagent_mongodb_default_user

The default user for the MongoDB plugin.

This is ignored if zbxagent_install_mongodb_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mongodb_plugin

str no
zbxagent_mongodb_keepalive

The interval at which the MongoDB plugin will send keepalive messages in seconds.

Valid values are between 60 and 900.

This is ignored if zbxagent_install_mongodb_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mongodb_plugin

int no
zbxagent_mongodb_sessions

A list of MongoDB sessions to configure.

This is ignored if zbxagent_install_mongodb_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mongodb_plugin

list of dicts of 'zbxagent_mongodb_sessions' options no []
zbxagent_mongodb_system_path

The path to the MongoDB system file.

This is ignored if zbxagent_install_mongodb_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mongodb_plugin

path no
zbxagent_mongodb_timeout

The timeout for MongoDB plugin requests in seconds.

Valid values are between 1 and 30.

This is ignored if zbxagent_install_mongodb_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mongodb_plugin

int no
zbxagent_mssql_custom_queries_dir

The path to the directory containing custom queries for the MSSQL plugin.

This is ignored if zbxagent_install_mssql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mssql_plugin

path no
zbxagent_mssql_default_ca_cert_path

The path to the default CA certificate file for the MSSQL plugin.

This is ignored if zbxagent_install_mssql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mssql_plugin

path no
zbxagent_mssql_default_database

The default database for the MSSQL plugin.

This is ignored if zbxagent_install_mssql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mssql_plugin

str no
zbxagent_mssql_default_encrypt

The default encryption setting for the MSSQL plugin.

This is ignored if zbxagent_install_mssql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mssql_plugin

str no
  • true
  • false
  • strict
  • disable
zbxagent_mssql_default_host_name_in_certificate

Whether to use the host name in the certificate for the MSSQL plugin.

This is ignored if zbxagent_install_mssql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mssql_plugin

bool no
zbxagent_mssql_default_password

The default password for the MSSQL plugin.

This is ignored if zbxagent_install_mssql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mssql_plugin

str no
zbxagent_mssql_default_tls_min_version

The default TLS minimum version for the MSSQL plugin.

This is ignored if zbxagent_install_mssql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mssql_plugin

str no
  • 1.0
  • 1.1
  • 1.2
  • 1.3
zbxagent_mssql_default_trust_server_certificate

Whether to trust the server certificate for the MSSQL plugin without verifying it.

This is ignored if zbxagent_install_mssql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mssql_plugin

bool no
zbxagent_mssql_default_uri

The default URI for the MSSQL plugin.

This is ignored if zbxagent_install_mssql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mssql_plugin

str no
zbxagent_mssql_default_user

The default user for the MSSQL plugin.

This is ignored if zbxagent_install_mssql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mssql_plugin

str no
zbxagent_mssql_keepalive

The interval at which the MSSQL plugin will send keepalive messages in seconds.

Valid values are between 60 and 900.

This is ignored if zbxagent_install_mssql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mssql_plugin

int no
zbxagent_mssql_sessions

A list of MSSQL sessions to configure.

This is ignored if zbxagent_install_mssql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mssql_plugin

list of dicts of 'zbxagent_mssql_sessions' options no []
zbxagent_mssql_system_path

The path to the MSSQL system file.

This is ignored if zbxagent_install_mssql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mssql_plugin

path no
zbxagent_mssql_timeout

The timeout for MSSQL plugin requests in seconds.

Valid values are between 1 and 30.

This is ignored if zbxagent_install_mssql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mssql_plugin

int no
zbxagent_pgsql_call_timeout

The timeout for PostgreSQL plugin requests.

Valid values are between 1 and 30.

This is ignored if zbxagent_install_pgsql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/pgsql_plugin

int no
zbxagent_pgsql_custom_queries_dir

The path to the directory containing custom queries for the PostgreSQL plugin.

This is ignored if zbxagent_install_pgsql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/pgsql_plugin

path no
zbxagent_pgsql_default_cache_mode

The default cache mode for the PostgreSQL plugin.

This is ignored if zbxagent_install_pgsql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/pgsql_plugin

str no
  • prepare
  • describe
zbxagent_pgsql_default_database

The default database for the PostgreSQL plugin.

This is ignored if zbxagent_install_pgsql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/pgsql_plugin

str no
zbxagent_pgsql_default_password

The default password for the PostgreSQL plugin.

This is ignored if zbxagent_install_pgsql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/pgsql_plugin

str no
zbxagent_pgsql_default_tls_ca_file

The default CA certificate file for the PostgreSQL plugin.

This is ignored if zbxagent_install_pgsql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/pgsql_plugin

path no
zbxagent_pgsql_default_tls_cert_file

The default certificate file for the PostgreSQL plugin.

This is ignored if zbxagent_install_pgsql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/pgsql_plugin

path no
zbxagent_pgsql_default_tls_connect

The default TLS connection setting for the PostgreSQL plugin.

This is ignored if zbxagent_install_pgsql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/pgsql_plugin

str no
  • required
  • verify_ca
  • verify_full
zbxagent_pgsql_default_tls_key_file

The default key file for the PostgreSQL plugin.

This is ignored if zbxagent_install_pgsql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/pgsql_plugin

path no
zbxagent_pgsql_default_uri

The default URI for the PostgreSQL plugin.

This is ignored if zbxagent_install_pgsql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/pgsql_plugin

str no
zbxagent_pgsql_default_user

The default user for the PostgreSQL plugin.

This is ignored if zbxagent_install_pgsql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/pgsql_plugin

str no
zbxagent_pgsql_keepalive

The interval at which the PostgreSQL plugin will send keepalive messages in seconds.

Valid values are between 60 and 900.

This is ignored if zbxagent_install_pgsql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/pgsql_plugin

int no
zbxagent_pgsql_sessions

A list of PostgreSQL sessions to configure.

This is ignored if zbxagent_install_pgsql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/pgsql_plugin

list of dicts of 'zbxagent_pgsql_sessions' options no []
zbxagent_pgsql_system_path

The path to the PostgreSQL system file.

This is ignored if zbxagent_install_pgsql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/pgsql_plugin

path no
zbxagent_pgsql_timeout

The timeout for PostgreSQL plugin requests in seconds.

Valid values are between 1 and 30.

This is ignored if zbxagent_install_pgsql_plugin is false.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/pgsql_plugin

int no
zbxagent_allow_keys

A list of keys to allow for passive checks.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#allowkey

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#allowkey

list of 'str' no []
zbxagent_deny_keys

A list of keys to deny for passive checks.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#denykey

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#denykey

list of 'str' no []
zbxagent_force_active_checks_on_start

Whether to force active checks on start.

Linux reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2#forceactivechecksonstart

Windows reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_win#forceactivechecksonstart

bool no False
zbxagent_logrotate_period

The period at which to rotate the log file.

On Windows, this is ignored.

str no
  • daily
  • weekly
  • monthly
daily
zbxagent_logrotate_retention

The number of rotated log files to retain.

On Windows, this is ignored.

int no 14
zbxagent_logrotate_mode

The mode of the rotated log files.

On Windows, this is ignored.

str no 0640
zbxagent_local_scripts

A list of local scripts to be used by the Zabbix Agent 2.

list of dicts of 'zbxagent_local_scripts' options no []
zbxagent_firewall_type

The type of host firewall to configure for use with Zabbix Agent 2.

On Windows, this is ignored.

str no
  • firewalld
  • ufw

Options for zbxagent_ember_plus_sessions

Option Description Type Required Choices Default
name

The name of the session.

str yes
uri

The URI for the session.

str yes

Options for zbxagent_mongodb_sessions

Option Description Type Required Choices Default
name

The name of the session.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mongodb_plugin

str yes
tls_ca_file

The path to the CA certificate file for the session.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mongodb_plugin

path no
tls_cert_file

The path to the certificate file for the session.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mongodb_plugin

path no
tls_connect

Whether to use and verify TLS for the session.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mongodb_plugin

str no
  • required
  • verify_ca
  • verify_full
tls_key_file

The path to the key file for the session.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mongodb_plugin

path no
uri

The URI for the session.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mongodb_plugin

str no
user

The user for the session.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mongodb_plugin

str no

Options for zbxagent_mssql_sessions

Option Description Type Required Choices Default
name

The name of the session.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mssql_plugin

str yes
ca_cert_path

The path to the CA certificate file for the session.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mssql_plugin

path no
database

The default database for the session.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mssql_plugin

str no
encrypt

The encryption setting for the session.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mssql_plugin

str no
  • true
  • false
  • strict
  • disable
host_name_in_certificate

Whether to use the host name in the certificate for the session.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mssql_plugin

bool no
password

The password for the session.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mssql_plugin

str no
tls_min_version

The TLS minimum version for the session.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mssql_plugin

str no
  • 1.0
  • 1.1
  • 1.2
  • 1.3
trust_server_certificate

Whether to trust the server certificate for the session without verifying it.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mssql_plugin

bool no
uri

The URI for the session.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mssql_plugin

str no
user

The user for the session.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/mssql_plugin

str no

Options for zbxagent_pgsql_sessions

Option Description Type Required Choices Default
name

The name of the session.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/pgsql_plugin

str yes
cache_mode

The cache mode for the session.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/pgsql_plugin

str no
  • prepare
  • describe
database

The default database for the session.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/pgsql_plugin

str no
password

The password for the session.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/pgsql_plugin

str no
tls_ca_file

The CA certificate file for the session.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/pgsql_plugin

path no
tls_cert_file

The certificate file for the session.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/pgsql_plugin

path no
tls_connect

The TLS connection setting for the session.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/pgsql_plugin

str no
  • required
  • verify_ca
  • verify_full
tls_key_file

The key file for the session.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/pgsql_plugin

path no
uri

The URI for the session.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/pgsql_plugin

str no
user

The user for the session.

Reference: https://www.zabbix.com/documentation/current/en/manual/appendix/config/zabbix_agent2_plugins/pgsql_plugin

str no

Options for zbxagent_local_scripts

Option Description Type Required Choices Default
src

The path to the script on the control node.

path yes
dest

The destination path for the script on the target node.

path yes

License

MIT

Author and Project Information

Jim Tarpley