Table of Contents
2 Zabbix proxy
The default values reflect daemon defaults, not the values in the shipped configuration files.
The parameters supported in a Zabbix proxy configuration file:
| Parameter | Mandatory | Range | Default | Description |
|---|---|---|---|---|
| AllowRoot | no | 0 | Allow the proxy to run as 'root'. If disabled and the proxy is started by 'root', the proxy will try to switch to the 'zabbix' user instead. Has no effect if started under a regular user. 0 - do not allow 1 - allow This parameter is supported since Zabbix 2.2.0. |
|
| CacheSize | no | 128K-8G | 8M | Size of configuration cache, in bytes. Shared memory size, for storing host and item data. Upper limit used to be 2GB before Zabbix 2.2.3. |
| ConfigFrequency | no | 1-604800 | 3600 | How often proxy retrieves configuration data from Zabbix server in seconds. Active proxy parameter. Ignored for passive proxies (see ProxyMode parameter). |
| DBHost | no | localhost | Database host name. In case of MySQL localhost or empty string results in using a socket. In case of PostgreSQL only empty string results in attempt to use socket. |
|
| DBName | yes | Database name. For SQLite3 path to database file must be provided. DBUser and DBPassword are ignored. Warning: Do not attempt to use the same database Zabbix server is using. |
||
| DBPassword | no | Database password. Ignored for SQLite. Comment this line if no password is used. |
||
| DBSchema | no | Schema name. Used for IBM DB2 and PostgreSQL. | ||
| DBSocket | no | 3306 | Path to MySQL socket. Database port when not using local socket. Ignored for SQLite. |
|
| DBUser | Database user. Ignored for SQLite. | |||
| DataSenderFrequency | no | 1-3600 | 1 | Proxy will send collected data to the server every N seconds. Active proxy parameter. Ignored for passive proxies (see ProxyMode parameter). |
| DebugLevel | no | 0-5 | 3 | 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) |
| ExternalScripts | no | /usr/local/share/zabbix/externalscripts | Location of external scripts (depends on compile-time installation variable datadir). | |
| Fping6Location | no | /usr/sbin/fping6 | Location of fping6. Make sure that fping6 binary has root ownership and SUID flag set. Make empty ("Fping6Location=") if your fping utility is capable to process IPv6 addresses. |
|
| FpingLocation | no | /usr/sbin/fping | Location of fping. Make sure that fping binary has root ownership and SUID flag set! |
|
| HeartbeatFrequency | no | 0-3600 | 60 | Frequency of heartbeat messages in seconds. Used for monitoring availability of proxy on server side. 0 - heartbeat messages disabled. Active proxy parameter. Ignored for passive proxies (see ProxyMode parameter). |
| HistoryCacheSize | no | 128K-2G | 16M | Size of history cache, in bytes. Shared memory size for storing history data. |
| HistoryIndexCacheSize | no | 128K-2G | 4M | Size of history index cache, in bytes. Shared memory size for indexing history data stored in history cache. The index cache size needs roughly 100 bytes to cache one item. This parameter is supported since Zabbix 3.0.0. |
| Hostname | no | Set by HostnameItem | Unique, case sensitive Proxy name. Make sure the proxy name is known to the server! Allowed characters: alphanumeric, '.', ' ', '_' and '-'. Maximum length: 64 |
|
| HostnameItem | no | system.hostname | Item used for setting Hostname if it is undefined (this will be run on the proxy similarly as on an agent). Does not support UserParameters, performance counters or aliases, but does support system.run[]. Ignored if Hostname is set. This parameter is supported since Zabbix 1.8.6. |
|
| HousekeepingFrequency | no | 0-24 | 1 | How often Zabbix will perform housekeeping procedure (in hours). Housekeeping is removing outdated information from the database. Note: To prevent housekeeper from being overloaded (for example, when configuration parameters ProxyLocalBuffer or ProxyOfflineBuffer are greatly reduced), no more than 4 times HousekeepingFrequency hours of outdated information are deleted in one housekeeping cycle. Thus, if HousekeepingFrequency is 1, no more than 4 hours of outdated information (starting from the oldest entry) will be deleted per cycle. Note: To lower load on proxy startup housekeeping is postponed for 30 minutes after proxy start. Thus, if HousekeepingFrequency is 1, the very first housekeeping procedure after proxy start will run after 30 minutes, and will repeat every hour thereafter. This postponing behavior is in place since Zabbix 2.4.0. Since Zabbix 3.0.0 it is possible to disable automatic housekeeping by setting HousekeepingFrequency to 0. In this case the housekeeping procedure can only be started by housekeeper_execute runtime control option and the period of outdated information deleted in one housekeeping cycle is 4 times the period since the last housekeeping cycle, but not less than 4 hours and not greater than 4 days. |
| Include | no | You may include individual files or all files in a directory in the configuration file. To only include relevant files in the specified directory, the asterisk wildcard character is supported for pattern matching. For example: /absolute/path/to/config/files/*.conf. Pattern matching is supported since Zabbix 2.4.0.See special notes about limitations. |
||
| JavaGateway | no | IP address (or hostname) of Zabbix Java gateway. Only required if Java pollers are started. This parameter is supported since Zabbix 2.0.0. |
||
| JavaGatewayPort | no | 1024-32767 | 10052 | Port that Zabbix Java gateway listens on. This parameter is supported since Zabbix 2.0.0. |
| ListenIP | no | 0.0.0.0 | List of comma delimited IP addresses that the trapper should listen on. Trapper will listen on all network interfaces if this parameter is missing. Multiple IP addresses are supported since Zabbix 1.8.3. |
|
| ListenPort | no | 1024-32767 | 10051 | Listen port for trapper. |
| LoadModule | no | Module to load at proxy startup. Modules are used to extend functionality of the proxy. Format: LoadModule=<module.so> The modules must be located in directory specified by LoadModulePath. It is allowed to include multiple LoadModule parameters. |
||
| LoadModulePath | no | Full path to location of proxy modules. Default depends on compilation options. |
||
| LogFile | yes, if LogType is set to file, otherwise no |
Name of log file. | ||
| LogFileSize | no | 0-1024 | 1 | Maximum size of log file in MB. 0 - disable automatic log rotation. Note: If the log file size limit is reached and file rotation fails, for whatever reason, the existing log file is truncated and started anew. |
| LogType | no | file | Log output type: file - write log to file specified by LogFile parameter, system - write log to syslog, console - write log to standard output. This parameter is supported since Zabbix 3.0.0. |
|
| LogSlowQueries | no | 0-3600000 | 0 | How long a database query may take before being logged (in milliseconds). 0 - don't log slow queries. This option becomes enabled starting with DebugLevel=3. This parameter is supported since Zabbix 1.8.2. |
| PidFile | no | /tmp/zabbix_proxy.pid | Name of PID file. | |
| ProxyLocalBuffer | no | 0-720 | 0 | Proxy will keep data locally for N hours, even if the data have already been synced with the server. This parameter may be used if local data will be used by third party applications. |
| ProxyMode | no | 0-1 | 0 | Proxy operating mode. 0 - proxy in the active mode 1 - proxy in the passive mode This parameter is supported since Zabbix 1.8.3. Note that (sensitive) proxy configuration data may become available to parties having access to the Zabbix server trapper port when using an active proxy. This is possible because anyone may pretend to be an active proxy and request configuration data; authentication does not take place. |
| ProxyOfflineBuffer | no | 1-720 | 1 | Proxy will keep data for N hours in case of no connectivity with Zabbix server. Older data will be lost. |
| ServerPort | no | 1024-32767 | 10051 | Port of Zabbix trapper on Zabbix server. Active proxy parameter. Ignored for passive proxies (see ProxyMode parameter). |
| Server | yes | IP address (or hostname) of Zabbix server. Active proxy will get configuration data from the server. Active proxy parameter. Ignored for passive proxies (see ProxyMode parameter). |
||
| SNMPTrapperFile | no | /tmp/zabbix_traps.tmp | Temporary file used for passing data from SNMP trap daemon to the proxy. Must be the same as in zabbix_trap_receiver.pl or SNMPTT configuration file. This parameter is supported since Zabbix 2.0.0. |
|
| SourceIP | no | Source IP address for outgoing connections. | ||
| SSHKeyLocation | no | Location of public and private keys for SSH checks and actions | ||
| SSLCertLocation | no | Location of SSL client certificate files for client authentication. This parameter is used in web monitoring only and is supported since Zabbix 2.4.0. |
||
| SSLKeyLocation | no | Location of SSL private key files for client authentication. This parameter is used in web monitoring only and is supported since Zabbix 2.4.0. |
||
| SSLCALocation | no | Location of certificate authority (CA) files for SSL server certificate verification. Note that the value of this parameter will be set as libcurl option CURLOPT_CAPATH. For libcurl versions before 7.42.0, this only has effect if libcurl was compiled to use OpenSSL. For more information see cURL web page. This parameter is used in web monitoring since Zabbix 2.4.0 and in SMTP authentication since Zabbix 3.0.0. |
||
| StartDBSyncers | no | 1-100 | 4 | Number of pre-forked instances of DB Syncers. The upper limit used to be 64 before version 1.8.5. This parameter is supported since Zabbix 1.8.3. |
| StartDiscoverers | no | 0-250 | 1 | Number of pre-forked instances of discoverers. The upper limit used to be 255 before version 1.8.5. |
| StartHTTPPollers | no | 0-1000 | 1 | Number of pre-forked instances of HTTP pollers. |
| StartIPMIPollers | no | 0-1000 | 0 | Number of pre-forked instances of IPMI pollers. The upper limit used to be 255 before version 1.8.5. |
| StartJavaPollers | no | 0-1000 | 0 | Number of pre-forked instances of Java pollers. This parameter is supported since Zabbix 2.0.0. |
| StartPingers | no | 0-1000 | 1 | Number of pre-forked instances of ICMP pingers. The upper limit used to be 255 before version 1.8.5. |
| StartPollersUnreachable | no | 0-1000 | 1 | Number of pre-forked instances of pollers for unreachable hosts (including IPMI and Java). Since Zabbix 2.4.0, at least one poller for unreachable hosts must be running if regular, IPMI or Java pollers are started. The upper limit used to be 255 before version 1.8.5. This option is missing in version 1.8.3. |
| StartPollers | no | 0-1000 | 5 | Number of pre-forked instances of pollers. The upper limit used to be 255 before version 1.8.5. |
| StartSNMPTrapper | no | 0-1 | 0 | If set to 1, SNMP trapper process will be started. This parameter is supported since Zabbix 2.0.0. |
| StartTrappers | no | 0-1000 | 5 | Number of pre-forked instances of trappers. Trappers accept incoming connections from Zabbix sender and active agents. The upper limit used to be 255 before version 1.8.5. |
| StartVMwareCollectors | no | 0-250 | 0 | Number of pre-forked vmware collector instances. This parameter is supported since Zabbix 2.2.0. |
| Timeout | no | 1-30 | 3 | Specifies how long we wait for agent, SNMP device or external check (in seconds). |
| TLSAccept | yes for passive proxy, if TLS certificate or PSK parameters are defined (even for unencrypted connection), otherwise no | What incoming connections to accept from Zabbix server. Used for a passive proxy, ignored on an active proxy. Multiple values can be specified, separated by comma: unencrypted - accept connections without encryption (default) psk - accept connections with TLS and a pre-shared key (PSK) cert - accept connections with TLS and a certificate This parameter is supported since Zabbix 3.0.0. |
||
| TLSCAFile | no | Full pathname of a file containing the top-level CA(s) certificates for peer certificate verification, used for encrypted communications between Zabbix components. This parameter is supported since Zabbix 3.0.0. |
||
| TLSCertFile | no | Full pathname of a file containing the proxy certificate or certificate chain, used for encrypted communications between Zabbix components. This parameter is supported since Zabbix 3.0.0. |
||
| TLSConnect | yes for active proxy, if TLS certificate or PSK parameters are defined (even for unencrypted connection), otherwise no | How the proxy should connect to Zabbix server. Used for an active proxy, ignored on a passive proxy. Only one value can be specified: unencrypted - connect without encryption (default) psk - connect using TLS and a pre-shared key (PSK) cert - connect using TLS and a certificate This parameter is supported since Zabbix 3.0.0. |
||
| TLSCRLFile | no | Full pathname of a file containing revoked certificates.This parameter is used for encrypted communications between Zabbix components. This parameter is supported since Zabbix 3.0.0. |
||
| TLSKeyFile | no | Full pathname of a file containing the proxy private key, used for encrypted communications between Zabbix components. This parameter is supported since Zabbix 3.0.0. |
||
| TLSPSKFile | no | Full pathname of a file containing the proxy pre-shared key. used for encrypted communications with Zabbix server. This parameter is supported since Zabbix 3.0.0. |
||
| TLSPSKIdentity | no | Pre-shared key identity string, used for encrypted communications with Zabbix server. This parameter is supported since Zabbix 3.0.0. |
||
| TLSServerCertIssuer | no | Allowed server certificate issuer. This parameter is supported since Zabbix 3.0.0. |
||
| TLSServerCertSubject | no | Allowed server certificate subject. This parameter is supported since Zabbix 3.0.0. |
||
| TmpDir | no | /tmp | Temporary directory. | |
| TrapperTimeout | no | 1-300 | 300 | Specifies how many seconds trapper may spend processing new data. |
| User | no | zabbix | Drop privileges to a specific, existing user on the system. Only has effect if run as 'root' and AllowRoot is disabled. This parameter is supported since Zabbix 2.4.0. |
|
| UnavailableDelay | no | 1-3600 | 60 | How often host is checked for availability during the unavailability period, in seconds. |
| UnreachableDelay | no | 1-3600 | 15 | How often host is checked for availability during the unreachability period, in seconds. |
| UnreachablePeriod | no | 1-3600 | 45 | After how many seconds of unreachability treat a host as unavailable. |
| VMwareCacheSize | no | 256K-2G | 8M | Shared memory size for storing VMware data. A VMware internal check zabbix[vmware,buffer,...] can be used to monitor the VMware cache usage (see Internal checks). Note that shared memory is not allocated if there are no vmware collector instances configured to start. This parameter is supported since Zabbix 2.2.0. |
| VMwareFrequency | no | 10-86400 | 60 | Delay in seconds between data gathering from a single VMware service. This delay should be set to the least update interval of any VMware monitoring item. This parameter is supported since Zabbix 2.2.0. |
| VMwarePerfFrequency | no | 10-86400 | 60 | Delay in seconds between performance counter statistics retrieval from a single VMware service. This delay should be set to the least update interval of any VMware monitoring item that uses VMware performance counters. This parameter is supported since Zabbix 2.2.9, 2.4.4 |
| VMwareTimeout | no | 1-300 | 10 | The maximum number of seconds vmware collector will wait for a response from VMware service (vCenter or ESX hypervisor). This parameter is supported since Zabbix 2.2.9, 2.4.4 |
Zabbix supports configuration files only in UTF-8 encoding without BOM.
Comments starting with "#" are only supported in the beginning of the line.