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 the parameter to see the full details.

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:

127.0.0.1,192.168.1.0/24,::1,2001:db8::/32,zabbix.example.com

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

IgnoreURLCertErrors

Specifies TLS certificate validation error handling when accessing the frontend URL:
0 - do not ignore certificate errors;
1 - ignore certificate errors.

Default: 0
Range: 0-1

Include

Specify a directory or individual files to be included in the configuration file.
During Zabbix installation, this parameter is set to /usr/local/etc, unless you change this during compile time.

General rules for the Include parameter:

• The path can be relative to the zabbix_web_service.conf file location.
• You can specify multiple Include parameters in one configuration file.
• Zabbix processes the Include parameter as soon as it reads it, so consider placing it at the end of the configuration file.

Rules for included files:

• Each file must be readable.
• Each file must have correct syntax. Otherwise, the component will not start.

Rules for including directories or file patterns:

• Do not assume any order of inclusion (e.g., files are not included in alphabetical order).
• Do not define the same parameter in more than one included file (e.g., to override a general setting with a specific one), since you cannot predict which value will be used.
• Watch out for backup copies that some text editors create automatically (e.g., editing include/my_specific.conf may create include/my_specific.conf.BAK), since both files will be included.

To include only relevant files from a directory, use the wildcard (*) for pattern matching.

Example:

Include=/absolute/path/to/config/files/*.conf

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:

/tmp/zabbix_web_service.log

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.