{{ ansible_managed | comment }} # This is a configuration file for Zabbix agent 2 (Unix) # To get more information about Zabbix, visit http://www.zabbix.com ############ GENERAL PARAMETERS ################# ### Option: PidFile # Name of PID file. # # Mandatory: no # Default: # PidFile=/tmp/zabbix_agent2.pid {% if agent_param_pidfile is defined and agent_param_pidfile %} PidFile={{ agent_param_pidfile }} {% endif %} ### Option: LogType # Specifies where log messages are written to: # system - syslog # file - file specified with LogFile parameter # console - standard output # # Mandatory: no # Default: # LogType=file {% if agent_param_logtype is defined and agent_param_logtype %} LogType={{ agent_param_logtype }} {% endif %} ### Option: LogFile # Log file name for LogType 'file' parameter. # # Mandatory: yes, if LogType is set to file, otherwise no # Default: # LogFile=/tmp/zabbix_agent2.log {% if agent_param_logfile is defined and agent_param_logfile %} LogFile={{ agent_param_logfile }} {% endif %} ### Option: LogFileSize # Maximum size of log file in MB. # 0 - disable automatic log rotation. # # Mandatory: no # Range: 0-1024 # Default: # LogFileSize=1 {% if agent_param_logfilesize is defined and (agent_param_logfilesize or agent_param_logfilesize is number) %} LogFileSize={{ agent_param_logfilesize }} {% endif %} ### Option: DebugLevel # Specifies debug level: # 0 - basic information about starting and stopping of Zabbix processes # 1 - critical information # 2 - error information # 3 - warnings # 4 - for debugging (produces lots of information) # 5 - extended debugging (produces even more information) # # Mandatory: no # Range: 0-5 # Default: # DebugLevel=3 {% if agent_param_debuglevel is defined and (agent_param_debuglevel or agent_param_debuglevel is number) %} DebugLevel={{ agent_param_debuglevel }} {% endif %} ### Option: SourceIP # Source IP address for outgoing connections. # # Mandatory: no # Default: # SourceIP= {% if agent_param_sourceip is defined and agent_param_sourceip %} SourceIP={{ agent_param_sourceip }} {% endif %} ##### Passive checks related ### Option: Server # List of comma delimited IP addresses, optionally in CIDR notation, or DNS names of Zabbix servers and Zabbix proxies. # Incoming connections will be accepted only from the hosts listed here. # If IPv6 support is enabled then '127.0.0.1', '::127.0.0.1', '::ffff:127.0.0.1' are treated equally # and '::/0' will allow any IPv4 or IPv6 address. # '0.0.0.0/0' can be used to allow any IPv4 address. # Example: Server=127.0.0.1,192.168.1.0/24,::1,2001:db8::/32,zabbix.example.com # # Mandatory: yes, if StartAgents is not explicitly set to 0 # Default: # Server= {% if agent_param_server is defined and agent_param_server is iterable and agent_param_server is not string and agent_param_server is not mapping %} Server={{ agent_param_server | join(',') }} {% elif agent_param_server is defined and agent_param_server and agent_param_server is string %} Server={{ agent_param_server }} {% endif %} ### Option: ListenPort # Agent will listen on this port for connections from the server. # # Mandatory: no # Range: 1024-32767 # Default: # ListenPort=10050 {% if agent_param_listenport is defined and (agent_param_listenport or agent_param_listenport is number) %} ListenPort={{ agent_param_listenport }} {% endif %} ### Option: ListenIP # List of comma delimited IP addresses that the agent should listen on. # First IP address is sent to Zabbix server if connecting to it to retrieve list of active checks. # # Mandatory: no # Default: # ListenIP=0.0.0.0 {% if agent_param_listenip is defined and agent_param_listenip is iterable and agent_param_listenip is not string and agent_param_listenip is not mapping %} ListenIP={{ agent_param_listenip | join(',') }} {% elif agent_param_listenip is defined and agent_param_listenip and agent_param_listenip is string %} ListenIP={{ agent_param_listenip }} {% endif %} ### Option: StatusPort # Agent will listen on this port for HTTP status requests. # # Mandatory: no # Range: 1024-32767 # Default: # StatusPort= {% if agent_param_statusport is defined and (agent_param_statusport or agent_param_statusport is number) %} StatusPort={{ agent_param_statusport }} {% endif %} ##### Active checks related ### Option: ServerActive # Zabbix server/proxy address or cluster configuration to get active checks from. # Server/proxy address is IP address or DNS name and optional port separated by colon. # Cluster configuration is one or more server addresses separated by semicolon. # Multiple Zabbix servers/clusters and Zabbix proxies can be specified, separated by comma. # More than one Zabbix proxy should not be specified from each Zabbix server/cluster. # If Zabbix proxy is specified then Zabbix server/cluster for that proxy should not be specified. # Multiple comma-delimited addresses can be provided to use several independent Zabbix servers in parallel. Spaces are allowed. # If port is not specified, default port is used. # IPv6 addresses must be enclosed in square brackets if port for that host is specified. # If port is not specified, square brackets for IPv6 addresses are optional. # If this parameter is not specified, active checks are disabled. # Example for Zabbix proxy: # ServerActive=127.0.0.1:10051 # Example for multiple servers: # ServerActive=127.0.0.1:20051,zabbix.domain,[::1]:30051,::1,[12fc::1] # Example for high availability: # ServerActive=zabbix.cluster.node1;zabbix.cluster.node2:20051;zabbix.cluster.node3 # Example for high availability with two clusters and one server: # ServerActive=zabbix.cluster.node1;zabbix.cluster.node2:20051,zabbix.cluster2.node1;zabbix.cluster2.node2,zabbix.domain # # Mandatory: no # Default: # ServerActive= {% if agent_param_serveractive is defined and agent_param_serveractive is iterable and agent_param_serveractive is not string and agent_param_serveractive is not mapping %} ServerActive={{ agent_param_serveractive | join(',') }} {% elif agent_param_serveractive is defined and agent_param_serveractive and agent_param_serveractive is string %} ServerActive={{ agent_param_serveractive }} {% endif %} ### Option: Hostname # List of comma delimited unique, case sensitive hostnames. # Required for active checks and must match hostnames as configured on the server. # Value is acquired from HostnameItem if undefined. # # Mandatory: no # Default: # Hostname= {% if agent_param_hostname is defined and agent_param_hostname %} Hostname={{ agent_param_hostname }} {% endif %} ### Option: HostnameItem # Item used for generating Hostname if it is undefined. Ignored if Hostname is defined. # Does not support UserParameters or aliases. # # Mandatory: no # Default: # HostnameItem=system.hostname {% if agent_param_hostnameitem is defined and agent_param_hostnameitem %} HostnameItem={{ agent_param_hostnameitem }} {% endif %} ### Option: HostMetadata # Optional parameter that defines host metadata. # Host metadata is used at host auto-registration process. # An agent will issue an error and not start if the value is over limit of 2034 bytes. # If not defined, value will be acquired from HostMetadataItem. # # Mandatory: no # Range: 0-2034 bytes # Default: # HostMetadata= {% if agent_param_hostmetadata is defined and agent_param_hostmetadata is iterable and agent_param_hostmetadata is not string and agent_param_hostmetadata is not mapping %} HostMetadata={{ agent_param_hostmetadata | join(',') }} {% elif agent_param_hostmetadata is defined and agent_param_hostmetadata and agent_param_hostmetadata is string %} HostMetadata={{ agent_param_hostmetadata }} {% elif (agent_param_hostmetadata is not defined or not agent_param_hostmetadata) and group_names %} HostMetadata={{ group_names | join(';') }} {% endif %} ### Option: HostMetadataItem # Optional parameter that defines an item used for getting host metadata. # Host metadata is used at host auto-registration process. # During an auto-registration request an agent will log a warning message if # the value returned by specified item is over limit of 65535 characters. # This option is only used when HostMetadata is not defined. # # Mandatory: no # Default: # HostMetadataItem= {% if agent_param_hostmetadataitem is defined and agent_param_hostmetadataitem %} HostMetadataItem={{ agent_param_hostmetadataitem }} {% endif %} ### Option: HostInterface # Optional parameter that defines host interface. # Host interface is used at host auto-registration process. # An agent will issue an error and not start if the value is over limit of 255 characters. # If not defined, value will be acquired from HostInterfaceItem. # # Mandatory: no # Range: 0-255 characters # Default: # HostInterface= {% if agent_param_hostinterface is defined and (agent_param_hostinterface or agent_param_hostinterface is number) %} HostInterface={{ agent_param_hostinterface }} {% endif %} ### Option: HostInterfaceItem # Optional parameter that defines an item used for getting host interface. # Host interface is used at host auto-registration process. # During an auto-registration request an agent will log a warning message if # the value returned by specified item is over limit of 255 characters. # This option is only used when HostInterface is not defined. # # Mandatory: no # Default: # HostInterfaceItem= {% if agent_param_hostinterfaceitem is defined and agent_param_hostinterfaceitem %} HostInterfaceItem={{ agent_param_hostinterfaceitem }} {% endif %} ### Option: RefreshActiveChecks # How often list of active checks is refreshed, in seconds. # # Mandatory: no # Range: 1-86400 # Default: # RefreshActiveChecks=5 {% if agent_param_refreshactivechecks is defined and (agent_param_refreshactivechecks or agent_param_refreshactivechecks is number) %} RefreshActiveChecks={{ agent_param_refreshactivechecks }} {% endif %} ### Option: BufferSend # Do not keep data longer than N seconds in buffer. # # Mandatory: no # Range: 1-3600 # Default: # BufferSend=5 {% if agent_param_buffersend is defined and (agent_param_buffersend or agent_param_buffersend is number) %} BufferSend={{ agent_param_buffersend }} {% endif %} ### Option: BufferSize # Maximum number of values in a memory buffer. The agent will send # all collected data to Zabbix Server or Proxy if the buffer is full. # Option is not valid if EnablePersistentBuffer=1 # # Mandatory: no # Range: 2-65535 # Default: # BufferSize=100 {% if agent_param_buffersize is defined and (agent_param_buffersize or agent_param_buffersize is number) %} BufferSize={{ agent_param_buffersize }} {% endif %} ### Option: EnablePersistentBuffer # Enable usage of local persistent storage for active items. # 0 - disabled, in-memory buffer is used (default); 1 - use persistent buffer # Mandatory: no # Range: 0-1 # Default: # EnablePersistentBuffer=0 {% if agent_param_enablepersistentbuffer is defined and (agent_param_enablepersistentbuffer or agent_param_enablepersistentbuffer is number) %} EnablePersistentBuffer={{ agent_param_enablepersistentbuffer }} {% endif %} ### Option: PersistentBufferPeriod # Zabbix Agent2 will keep data for this time period in case of no # connectivity with Zabbix server or proxy. Older data will be lost. Log data will be preserved. # Option is valid if EnablePersistentBuffer=1 # # Mandatory: no # Range: 1m-365d # Default: # PersistentBufferPeriod=1h {% if agent_param_persistentbufferperiod is defined and (agent_param_persistentbufferperiod or agent_param_persistentbufferperiod is number) %} PersistentBufferPeriod={{ agent_param_persistentbufferperiod }} {% endif %} ### Option: PersistentBufferFile # Full filename. Zabbix Agent2 will keep SQLite database in this file. # Option is valid if EnablePersistentBuffer=1 # # Mandatory: no # Default: # PersistentBufferFile= {% if agent_param_persistentbufferfile is defined and agent_param_persistentbufferfile %} PersistentBufferFile={{ agent_param_persistentbufferfile }} {% endif %} ### Option: HeartbeatFrequency # Frequency of heartbeat messages in seconds. # Used for monitoring availability of active checks. # 0 - heartbeat messages disabled. # # Mandatory: no # Range: 0-3600 # Default: 60 # HeartbeatFrequency= {% if agent_param_heartbeatfrequency is defined and (agent_param_heartbeatfrequency or agent_param_heartbeatfrequency is number) %} HeartbeatFrequency={{ agent_param_heartbeatfrequency }} {% endif %} ############ ADVANCED PARAMETERS ################# ### Option: Alias # Sets an alias for an item key. It can be used to substitute long and complex item key with a smaller and simpler one. # Multiple Alias parameters may be present. Multiple parameters with the same Alias key are not allowed. # Different Alias keys may reference the same item key. # For example, to retrieve the ID of user 'zabbix': # Alias=zabbix.userid:vfs.file.regexp[/etc/passwd,^zabbix:.:([0-9]+),,,,\1] # Now shorthand key zabbix.userid may be used to retrieve data. # Aliases can be used in HostMetadataItem but not in HostnameItem parameters. # # Mandatory: no # Range: # Default: ### Option: Timeout # Spend no more than Timeout seconds on processing # # Mandatory: no # Range: 1-30 # Default: # Timeout=3 {% if agent_param_timeout is defined and (agent_param_timeout or agent_param_timeout is number) %} Timeout={{ agent_param_timeout }} {% endif %} ### Option: Include # You may include individual files or all files in a directory in the configuration file. # Installing Zabbix will create include directory in /usr/local/etc, unless modified during the compile time. # # Mandatory: no # Default: # Include= {% if agent_param_include is defined and agent_param_include is iterable and agent_param_include is not string and agent_param_include is not mapping %} {% for unit in agent_param_include %} Include={{ unit }} {% endfor %} {% elif agent_param_include is defined and agent_param_include and agent_param_include is string %} Include={{ agent_param_include }} {% endif %} # Include=/usr/local/etc/zabbix_agent2.userparams.conf # Include=/usr/local/etc/zabbix_agent2.conf.d/ # Include=/usr/local/etc/zabbix_agent2.conf.d/*.conf ### Option:PluginTimeout # Timeout for connections with external plugins. # # Mandatory: no # Range: 1-30 # Default: # PluginTimeout= {% if agent_param_plugintimeout is defined and (agent_param_plugintimeout or agent_param_plugintimeout is number) %} PluginTimeout={{ agent_param_plugintimeout }} {% endif %} ### Option:PluginSocket # Path to unix socket for external plugin communications. # # Mandatory: no # Default:/tmp/agent.plugin.sock # PluginSocket= {% if agent_param_pluginsocket is defined and agent_param_pluginsocket %} PluginSocket={{ agent_param_pluginsocket }} {% endif %} ####### USER-DEFINED MONITORED PARAMETERS ####### ### Option: UnsafeUserParameters # Allow all characters to be passed in arguments to user-defined parameters. # The following characters are not allowed: # \ ' " ` * ? [ ] { } ~ $ ! & ; ( ) < > | # @ # Additionally, newline characters are not allowed. # 0 - do not allow # 1 - allow # # Mandatory: no # Range: 0-1 # Default: # UnsafeUserParameters=0 {% if agent_param_unsafeuserparameters is defined and (agent_param_unsafeuserparameters or agent_param_unsafeuserparameters is number) %} UnsafeUserParameters={{ agent_param_unsafeuserparameters }} {% endif %} ### Option: UserParameter # User-defined parameter to monitor. There can be several user-defined parameters. # Format: UserParameter=, # See 'zabbix_agentd' directory for examples. # # Mandatory: no # Default: # UserParameter= ### Option: UserParameterDir # Directory to execute UserParameter commands from. Only one entry is allowed. # When executing UserParameter commands the agent will change the working directory to the one # specified in the UserParameterDir option. # This way UserParameter commands can be specified using the relative ./ prefix. # # Mandatory: no # Default: # UserParameterDir= {% if agent_param_userparameterdir is defined and agent_param_userparameterdir %} UserParameterDir={{ agent_param_userparameterdir }} {% endif %} ### Option: ControlSocket # The control socket, used to send runtime commands with '-R' option. # # Mandatory: no # Default: # ControlSocket= {% if agent_param_controlsocket is defined and agent_param_controlsocket %} ControlSocket={{ agent_param_controlsocket }} {% endif %} ####### TLS-RELATED PARAMETERS ####### ### Option: TLSConnect # How the agent should connect to server or proxy. Used for active checks. # Only one value can be specified: # unencrypted - connect without encryption # psk - connect using TLS and a pre-shared key # cert - connect using TLS and a certificate # # Mandatory: yes, if TLS certificate or PSK parameters are defined (even for 'unencrypted' connection) # Default: # TLSConnect=unencrypted {% if agent_param_tlsconnect is defined and agent_param_tlsconnect %} TLSConnect={{ agent_param_tlsconnect }} {% endif %} ### Option: TLSAccept # What incoming connections to accept. # Multiple values can be specified, separated by comma: # unencrypted - accept connections without encryption # psk - accept connections secured with TLS and a pre-shared key # cert - accept connections secured with TLS and a certificate # # Mandatory: yes, if TLS certificate or PSK parameters are defined (even for 'unencrypted' connection) # Default: # TLSAccept=unencrypted {% if agent_param_tlsaccept is defined and agent_param_tlsaccept is iterable and agent_param_tlsaccept is not string and agent_param_tlsaccept is not mapping %} TLSAccept={{ agent_param_tlsaccept | join(',') }} {% elif agent_param_tlsaccept is defined and agent_param_tlsaccept and agent_param_tlsaccept is string %} TLSAccept={{ agent_param_tlsaccept }} {% endif %} ### Option: TLSCAFile # Full pathname of a file containing the top-level CA(s) certificates for # peer certificate verification. # # Mandatory: no # Default: # TLSCAFile= {% if agent_param_tlscafile is defined and agent_param_tlscafile and (agent_param_tlsaccept is defined and (agent_param_tlsaccept == "cert" or "cert" in agent_param_tlsaccept) or agent_param_tlsconnect == "cert") %} TLSCAFile={{ agent_param_tlscafile }} {% endif %} ### Option: TLSCRLFile # Full pathname of a file containing revoked certificates. # # Mandatory: no # Default: # TLSCRLFile= {% if agent_param_tlscrlfile is defined and agent_param_tlscrlfile and (agent_param_tlsaccept is defined and (agent_param_tlsaccept == "cert" or "cert" in agent_param_tlsaccept) or agent_param_tlsconnect == "cert") %} TLSCRLFile={{ agent_param_tlscrlfile }} {% endif %} ### Option: TLSServerCertIssuer # Allowed server certificate issuer. # # Mandatory: no # Default: # TLSServerCertIssuer= {% if agent_param_tlsservercertissuer is defined and agent_param_tlsservercertissuer and (agent_param_tlsaccept is defined and (agent_param_tlsaccept == "cert" or "cert" in agent_param_tlsaccept) or agent_param_tlsconnect == "cert") %} TLSServerCertIssuer={{ agent_param_tlsservercertissuer }} {% endif %} ### Option: TLSServerCertSubject # Allowed server certificate subject. # # Mandatory: no # Default: # TLSServerCertSubject= {% if agent_param_tlsservercertsubject is defined and agent_param_tlsservercertsubject and (agent_param_tlsaccept is defined and (agent_param_tlsaccept == "cert" or "cert" in agent_param_tlsaccept) or agent_param_tlsconnect == "cert") %} TLSServerCertSubject={{ agent_param_tlsservercertsubject }} {% endif %} ### Option: TLSCertFile # Full pathname of a file containing the agent certificate or certificate chain. # # Mandatory: no # Default: # TLSCertFile= {% if agent_param_tlscertfile is defined and agent_param_tlscertfile and (agent_param_tlsaccept is defined and (agent_param_tlsaccept == "cert" or "cert" in agent_param_tlsaccept) or agent_param_tlsconnect == "cert") %} TLSCertFile={{ agent_param_tlscertfile }} {% endif %} ### Option: TLSKeyFile # Full pathname of a file containing the agent private key. # # Mandatory: no # Default: # TLSKeyFile= {% if agent_param_tlskeyfile is defined and agent_param_tlskeyfile %} TLSKeyFile={{ agent_param_tlskeyfile }} {% endif %} ### Option: TLSPSKIdentity # Unique, case sensitive string used to identify the pre-shared key. # # Mandatory: no # Default: # TLSPSKIdentity= {% if agent_param_tlspskidentity is defined and agent_param_tlspskidentity and (agent_param_tlsaccept is defined and (agent_param_tlsaccept == "psk" or "psk" in agent_param_tlsaccept) or agent_param_tlsconnect == "psk") %} TLSPSKIdentity={{ agent_param_tlspskidentity }} {% endif %} ### Option: TLSPSKFile # Full pathname of a file containing the pre-shared key. # # Mandatory: no # Default: # TLSPSKFile= {% if agent_param_tlspskfile is defined and agent_param_tlspskfile and (agent_param_tlsaccept is defined and (agent_param_tlsaccept == "psk" or "psk" in agent_param_tlsaccept) or agent_param_tlsconnect == "psk") %} TLSPSKFile={{ agent_param_tlspskfile }} {% endif %} ####### PLUGIN-SPECIFIC PARAMETERS ####### ### Option: Plugins # A plugin can have one or more plugin specific configuration parameters in format: # Plugins..= # Plugins..= # # Mandatory: no # Range: # Default: ### Option: Plugins.Log.MaxLinesPerSecond # Maximum number of new lines the agent will send per second to Zabbix Server # or Proxy processing 'log' and 'logrt' active checks. # The provided value will be overridden by the parameter 'maxlines', # provided in 'log' or 'logrt' item keys. # # Mandatory: no # Range: 1-1000 # Default: # Plugins.Log.MaxLinesPerSecond=20 {% if agent_param_plugins_log_maxlinespersecond is defined and (agent_param_plugins_log_maxlinespersecond or agent_param_plugins_log_maxlinespersecond is number) %} Plugins.Log.MaxLinesPerSecond={{ agent_param_plugins_log_maxlinespersecond }} {% endif %} ### Option: AllowKey # Allow execution of item keys matching pattern. # Multiple keys matching rules may be defined in combination with DenyKey. # Key pattern is wildcard expression, which support "*" character to match any number of any characters in certain position. It might be used in both key name and key arguments. # Parameters are processed one by one according their appearance order. # If no AllowKey or DenyKey rules defined, all keys are allowed. # # Mandatory: no {% if agent_param_allowkey is defined and agent_param_allowkey is iterable and agent_param_allowkey is not string and agent_param_allowkey is not mapping %} {% for unit in agent_param_allowkey %} AllowKey={{ unit }} {% endfor %} {% elif agent_param_allowkey is defined and agent_param_allowkey and agent_param_allowkey is string %} AllowKey={{ agent_param_allowkey }} {% endif %} ### Option: DenyKey # Deny execution of items keys matching pattern. # Multiple keys matching rules may be defined in combination with AllowKey. # Key pattern is wildcard expression, which support "*" character to match any number of any characters in certain position. It might be used in both key name and key arguments. # Parameters are processed one by one according their appearance order. # If no AllowKey or DenyKey rules defined, all keys are allowed. # Unless another system.run[*] rule is specified DenyKey=system.run[*] is added by default. # # Mandatory: no # Default: # DenyKey=system.run[*] {% if agent_param_denykey is defined and agent_param_denykey is iterable and agent_param_denykey is not string and agent_param_denykey is not mapping %} {% for unit in agent_param_denykey %} DenyKey={{ unit }} {% endfor %} {% elif agent_param_denykey is defined and agent_param_denykey and agent_param_denykey is string %} DenyKey={{ agent_param_denykey }} {% endif %} ### Option: Plugins.SystemRun.LogRemoteCommands # Enable logging of executed shell commands as warnings. # 0 - disabled # 1 - enabled # # Mandatory: no # Default: # Plugins.SystemRun.LogRemoteCommands=0 {% if agent_param_plugins_systemrun_logremotecommands is defined and (agent_param_plugins_systemrun_logremotecommands or agent_param_plugins_systemrun_logremotecommands is number) %} Plugins.SystemRun.LogRemoteCommands={{ agent_param_plugins_systemrun_logremotecommands }} {% endif %} ### Option: ForceActiveChecksOnStart # Perform active checks immediately after restart for first received configuration. # Also available as per plugin configuration, example: Plugins.Uptime.System.ForceActiveChecksOnStart=1 # # Mandatory: no # Range: 0-1 # Default: # ForceActiveChecksOnStart=0 {% if agent_param_forceactivechecksonstart is defined and (agent_param_forceactivechecksonstart or agent_param_forceactivechecksonstart is number) %} ForceActiveChecksOnStart={{ agent_param_forceactivechecksonstart }} {% endif %} # Include configuration files for plugins {% if agent_param_includeplugins is defined and agent_param_includeplugins is iterable and agent_param_includeplugins is not string and agent_param_includeplugins is not mapping %} {% for unit in agent_param_includeplugins %} Include={{ unit }} {% endfor %} {% elif agent_param_includeplugins is defined and agent_param_includeplugins and agent_param_includeplugins is string %} Include={{ agent_param_includeplugins }} {% endif %}