Table of Contents
9 Zabbix web service
Overview
The Zabbix web service is a process that is used for communication with external web services.
The parameters supported by the Zabbix web service configuration file (zabbix_web_service.conf) are listed in this section.
The parameters are listed without additional information. Click on the parameter to see the full details.
| Parameter | Description |
|---|---|
| AllowedIP | A list of comma delimited IP addresses, optionally in CIDR notation, or DNS names of Zabbix servers and Zabbix proxies. |
| DebugLevel | The debug level. |
| ListenPort | The agent will listen on this port for connections from the server. |
| LogFile | The name of the log file. |
| LogFileSize | The maximum size of the log file. |
| LogType | The type of the log output. |
| Timeout | The maximum time (in seconds) spent formatting the PDF report of a dashboard. |
| TLSAccept | What incoming connections to accept. |
| TLSCAFile | The full pathname of a file containing the top-level CA(s) certificates for peer certificate verification, used for encrypted communications between Zabbix components. |
| TLSCertFile | The full pathname of a file containing the service certificate or certificate chain, used for encrypted communications between Zabbix components. |
| TLSKeyFile | The full pathname of a file containing the service private key, used for encrypted communications between Zabbix components. |
All parameters are non-mandatory unless explicitly stated that the parameter is mandatory.
Note that:
- The default values reflect process defaults, not the values in the shipped configuration files;
- Values support environment variables;
- Zabbix supports configuration files only in UTF-8 encoding without BOM;
- Comments starting with "#" are only supported at the beginning of the line.
Parameter details
AllowedIP
A 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:
Mandatory: yes
DebugLevel
Specify the 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).
Default: 3
Range: 0-5
ListenPort
The service will listen on this port for connections from the server.
Default: 10053
Range: 1024-32767
LogFile
The name of the log file.
Example:
Mandatory: Yes, if LogType is set to file; otherwise no
LogFileSize
The maximum size of a 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.
Default: 1
Range: 0-1024
LogType
The type of the log output:
file - write log to the file specified by LogFile parameter;
system - write log to syslog;
console - write log to standard output.
Default: file
Timeout
The maximum time (in seconds) spent formatting the PDF report of a dashboard.
Default: 10
Range: 1-30
TLSAccept
What incoming connections to accept:
unencrypted - accept connections without encryption (default)
cert - accept connections with TLS and a certificate
Default: unencrypted
TLSCAFile
The full pathname of the file containing the top-level CA(s) certificates for peer certificate verification, used for encrypted communications between Zabbix components.
TLSCertFile
The full pathname of the file containing the service certificate or certificate chain, used for encrypted communications with Zabbix components.
TLSKeyFile
The full pathname of the file containing the service private key, used for encrypted communications between Zabbix components.