1. Introduction

1 Manual structure

2 What is Zabbix

3 Zabbix features

4 Zabbix overview

5 What's new in Zabbix 5.2.0

6 What's new in Zabbix 5.2.1

7 What's new in Zabbix 5.2.2

8 What's new in Zabbix 5.2.3

9 What's new in Zabbix 5.2.4

10 What's new in Zabbix 5.2.5

11 What's new in Zabbix 5.2.6

15 What's new in Zabbix 5.2.7

3. Zabbix processes

1 Server

2 Agent

3 Agent 2

4 Proxy

1 Setup from sources

2 Setup from RHEL/CentOS packages

3 Setup from Debian/Ubuntu packages

6 Sender

7 Get

8 JS

4. Installation

1 Getting Zabbix

Best practices for secure Zabbix setup

3 Installation from sources

Building Zabbix agent 2 on Windows

Building Zabbix agent on macOS

Building Zabbix agent on Windows

4 Installation from packages

1 Red Hat Enterprise Linux/CentOS

2 Debian/Ubuntu/Raspbian

3 SUSE Linux Enterprise Server

4 Windows agent installation from MSI

6 Mac OS agent installation from PKG

5 Installation from containers

6 Web interface installation

Debian/Ubuntu frontend installation

7 Upgrade procedure

Upgrade from packages

1 Red Hat Enterprise Linux/CentOS

2 Debian/Ubuntu

Upgrade from sources

9 Template changes

10 Upgrade notes for 5.2.0

11 Upgrade notes for 5.2.1

12 Upgrade notes for 5.2.2

13 Upgrade notes for 5.2.3

14 Upgrade notes for 5.2.4

15 Upgrade notes for 5.2.5

16 Upgrade notes for 5.2.6

17 Upgrade notes for 5.2.7

1 Login and configuring user

2 New host

3 New item

5 Receiving problem notification

6. Zabbix appliance

7. Configuration

1 Hosts and host groups

1 Configuring a host

2 Inventory

3 Mass update

2 Items

1 Creating an item

1 Item key format

2 Custom intervals

2 Item value preprocessing

1 Usage examples

2 Preprocessing details

3 JSONPath functionality

Escaping special characters from LLD macro values in JSONPath

4 JavaScript preprocessing

Additional JavaScript objects

5 CSV to JSON preprocessing

3 Item types

1 Zabbix agent

Windows-specific item keys

Zabbix agent 2

2 SNMP agent

1 Dynamic indexes

2 Special OIDs

3 MIB files

3 SNMP traps

4 IPMI checks

5 Simple checks

1 VMware monitoring item keys

6 Log file monitoring

7 Calculated items

8 Internal checks

9 SSH checks

10 Telnet checks

11 External checks

12 Aggregate checks

13 Trapper items

14 JMX monitoring

15 ODBC monitoring

1 Recommended UnixODBC settings for MySQL

2 Recommended UnixODBC settings for PostgreSQL

3 Recommended UnixODBC settings for Oracle

4 Recommended UnixODBC settings for MSSQL

16 Dependent items

17 HTTP agent

18 Prometheus checks

19 Script items

4 History and trends

5 User parameters

1 Extending Zabbix agents

6 Loadable modules

7 Windows performance counters

8 Mass update

9 Value mapping

10 Applications

11 Queue

12 Value cache

13 Execute now

14 Plugins

15 Restricting agent checks

3 Triggers

1 Configuring a trigger

2 Trigger expression

3 Trigger dependencies

4 Trigger severity

5 Customizing trigger severities

6 Mass update

7 Predictive trigger functions

4 Events

1 Trigger event generation

2 Other event sources

3 Manual closing of problems

5 Event correlation

1 Trigger-based event correlation

Event tags

2 Global event correlation

6 Visualization

1 Graphs

1 Simple graphs

2 Custom graphs

3 Ad-hoc graphs

4 Aggregation in graphs

2 Network maps

1 Configuring a network map

2 Host group elements

3 Link indicators

3 Screens

1 Screen elements

4 Slide shows

5 Dashboards

6 Host dashboards

7 Templates

1 Configuring a template

2 Linking/unlinking

3 Nesting

4 Mass update

8 Templates out of the box

Standardized templates for network devices

HTTP template operation

IPMI template operation

JMX template operation

ODBC template operation

Zabbix agent 2 template operation

Zabbix agent template operation

9 Notifications upon events

1 Media types

1 E-mail

2 SMS

3 Custom alertscripts

4 Webhook

Webhook script examples

2 Actions

1 Conditions

2 Operations

1 Sending message

2 Remote commands

3 Additional operations

4 Using macros in messages

3 Recovery operations

4 Update operations

5 Escalations

3 Receiving notification on unsupported items

10 Macros

1 Macro functions

2 User macros

3 User macros with context

4 Low-level discovery macros

11 Users and user groups

1 Configuring a user

2 Permissions

3 User groups

12 Storage of secrets

8. Service monitoring

9. Web monitoring

1 Web monitoring items

2 Real life scenario

10. Virtual machine monitoring

1 Virtual machine discovery key fields

11. Maintenance

12. Regular expressions

13. Problem acknowledgment

14. Configuration export/import

2 Templates

3 Hosts

5 Screens

1 Network discovery

1 Configuring a network discovery rule

2 Active agent autoregistration

3 Low-level discovery

1 Item prototypes

2 Trigger prototypes

3 Graph prototypes

4 Notes on low-level discovery

5 Discovery rules

1 Discovery of mounted filesystems

2 Discovery of network interfaces

3 Discovery of CPUs and CPU cores

4 Discovery of SNMP OIDs

5 Discovery of JMX objects

6 Discovery of IPMI sensors

7 Discovery of systemd services

8 Discovery of Windows services

9 Discovery of Windows performance counter instances

10 Discovery using WMI queries

11 Discovery using ODBC SQL queries

12 Discovery using Prometheus data

13 Discovery of block devices

14 Discovery of host interfaces in Zabbix

16. Distributed monitoring

1 Proxies

1 Using certificates

2 Using pre-shared keys

3 Troubleshooting

1 Connection type or permission problems

2 Certificate problems

3 PSK problems

18. Web interface

1 Menu

2 Frontend sections

1 Monitoring

1 Dashboard

1 Dashboard widgets

2 Problems

3 Hosts

1 Graphs

2 Web scenarios

4 Overview

5 Latest data

6 Screens

7 Maps

8 Discovery

9 Services

2 Inventory

1 Overview

2 Hosts

3 Reports

1 System information

2 Availability report

3 Triggers top 100

4 Audit

5 Action log

6 Notifications

4 Configuration

1 Host groups

2 Templates

3 Hosts

1 Applications

2 Items

3 Triggers

4 Graphs

5 Discovery rules

6 Web scenarios

4 Maintenance

5 Actions

6 Event correlation

7 Discovery

8 Services

5 Administration

1 General

2 Proxies

3 Authentication

4 User groups

5 User roles

6 Users

7 Media types

8 Scripts

9 Queue

1 Global notifications

2 Sound in browsers

4 Global search

5 Frontend maintenance mode

6 Page parameters

8 Creating your own theme

10 Cookies used by Zabbix

19. API

Method reference

Action

> Action object

action.create

action.delete

action.get

action.update

Alert

> Alert object

alert.get

API info

apiinfo.version

Application

> Application object

application.create

application.delete

application.get

application.massadd

application.update

Audit log

> Audit log object

auditlog.get

Authentication

> Authentication object

authentication.get

authentication.update

Autoregistration

> Autoregistration object

autoregistration.get

autoregistration.update

Configuration

configuration.export

configuration.import

Correlation

> Correlation object

correlation.create

correlation.delete

correlation.get

correlation.update

Dashboard

> Dashboard object

dashboard.create

dashboard.delete

dashboard.get

dashboard.update

Discovered host

> Discovered host object

dhost.get

Discovered service

> Discovered service object

dservice.get

Discovery check

> Discovery check object

dcheck.get

Discovery rule

> Discovery rule object

drule.create

drule.delete

drule.get

drule.update

Event

> Event object

event.acknowledge

event.get

Graph

> Graph object

graph.create

graph.delete

graph.get

graph.update

Graph item

> Graph item object

graphitem.get

Graph prototype

> Graph prototype object

graphprototype.create

graphprototype.delete

graphprototype.get

graphprototype.update

History

> History object

history.get

Host

> Host object

host.create

host.delete

host.get

host.massadd

host.massremove

host.massupdate

host.update

Host group

> Host group object

hostgroup.create

hostgroup.delete

hostgroup.get

hostgroup.massadd

hostgroup.massremove

hostgroup.massupdate

hostgroup.update

Host interface

> Host interface object

hostinterface.create

hostinterface.delete

hostinterface.get

hostinterface.massadd

hostinterface.massremove

hostinterface.replacehostinterfaces

hostinterface.update

Host prototype

> Host prototype object

hostprototype.create

hostprototype.delete

hostprototype.get

hostprototype.update

Housekeeping

> Housekeeping object

housekeeping.get

housekeeping.update

Icon map

> Icon map object

iconmap.create

iconmap.delete

iconmap.get

iconmap.update

Image

> Image object

image.create

image.delete

image.get

image.update

Item

> Item object

item.create

item.delete

item.get

item.update

Item prototype

> Item prototype object

itemprototype.create

itemprototype.delete

itemprototype.get

itemprototype.update

LLD rule

> LLD rule object

discoveryrule.copy

discoveryrule.create

discoveryrule.delete

discoveryrule.get

discoveryrule.update

Maintenance

> Maintenance object

maintenance.create

maintenance.delete

maintenance.get

maintenance.update

Map

> Map object

map.create

map.delete

map.get

map.update

Media type

> Media type object

mediatype.create

mediatype.delete

mediatype.get

mediatype.update

Problem

> Problem object

problem.get

Proxy

> Proxy object

proxy.create

proxy.delete

proxy.get

proxy.update

Role

> Role object

role.create

role.delete

role.get

role.update

Screen

> Screen object

screen.create

screen.delete

screen.get

screen.update

Screen item

> Screen item object

screenitem.create

screenitem.delete

screenitem.get

screenitem.update

screenitem.updatebyposition

Script

> Script object

script.create

script.delete

script.execute

script.get

script.getscriptsbyhosts

script.update

Service

> Service object

service.adddependencies

service.addtimes

service.create

service.delete

service.deletedependencies

service.deletetimes

service.get

service.getsla

service.update

Settings

> Settings object

settings.get

settings.getglobal

settings.update

Task

> Task object

task.create

task.get

Template

> Template object

template.create

template.delete

template.get

template.massadd

template.massremove

template.massupdate

template.update

Template dashboard

> Template dashboard object

templatedashboard.create

templatedashboard.delete

templatedashboard.get

templatedashboard.update

Trend

> Trend object

trend.get

Trigger

> Trigger object

trigger.adddependencies

trigger.create

trigger.delete

trigger.deletedependencies

trigger.get

trigger.update

Trigger prototype

> Trigger prototype object

triggerprototype.create

triggerprototype.delete

triggerprototype.get

triggerprototype.update

User

> User object

user.checkAuthentication

user.create

user.delete

user.get

user.login

user.logout

user.update

User group

> User group object

usergroup.create

usergroup.delete

usergroup.get

usergroup.update

User macro

> User macro object

usermacro.create

usermacro.createglobal

usermacro.delete

usermacro.deleteglobal

usermacro.get

usermacro.update

usermacro.updateglobal

Value map

> Value map object

valuemap.create

valuemap.delete

valuemap.get

valuemap.update

Web scenario

> Web scenario object

httptest.create

httptest.delete

httptest.get

httptest.update

Appendix 1. Reference commentary

Appendix 2. Changes from 5.0 to 5.2

Zabbix API changes in 5.2

1 Frequently asked questions / Troubleshooting

2 Installation and setup

1 Database creation

2 Repairing Zabbix database character set and collation

3 Secure connection to the database

1 MySQL encryption configuration

2 PostgreSQL encryption configuration

4 TimescaleDB setup

5 Elasticsearch setup

6 Real-time export of events, item values, trends

7 Distribution-specific notes on setting up Nginx for Zabbix

8 Running agent as root

9 Zabbix agent on Microsoft Windows

10 Zabbix agent 2 on Microsoft Windows

11 SAML setup with Okta

12 Additional frontend languages

3 Process configuration

1 Zabbix server

2 Zabbix proxy

3 Zabbix agent (UNIX)

4 Zabbix agent 2 (UNIX)

5 Zabbix agent (Windows)

6 Zabbix agent 2 (Windows)

7 Zabbix Java gateway

8 Inclusion

4 Protocols

1 Server-proxy data exchange protocol

2 Zabbix agent protocol

3 Zabbix sender protocol

4 Header

5 Real-time export protocol

5 Items

1 Items supported by platform

2 vm.memory.size parameters

3 Passive and active agent checks

4 Trapper items

5 Minimum permission level for Windows agent items

6 Encoding of returned values

7 Large file support

8 Sensor

9 Notes on memtype parameter in proc.mem items

10 Notes on selecting processes in proc.mem and proc.num items

11 Implementation details of net.tcp.service and net.udp.service checks

12 Unreachable/unavailable host settings

13 Remote monitoring of Zabbix stats

14 Configuring Kerberos with Zabbix

15 modbus.get parameters

6 Triggers

1 Supported trigger functions

7 Macros

1 Supported macros

2 User macros supported by location

9 Time period syntax

10 Command execution

11 Recipes for monitoring

12 Performance tuning

13 Version compatibility

14 Database error handling

15 Zabbix sender dynamic link library for Windows

16 Issues with SELinux

17 Other issues

18 Agent vs agent 2 comparison

Zabbix manpages

Table of Contents

6 What's new in Zabbix 5.2.1
- New templates

6 What's new in Zabbix 5.2.1

New templates

The following templates are now available for out-of-the-box monitoring:

Apache Cassandra by JMX - see setup instructions for JMX templates.
Apache Kafka by JMX - see setup instructions for JMX templates.

You can get these templates:

In Configuration → Templates in new installations;
If you are upgrading from previous versions, you can download new templates from Zabbix Git repository or find them in the templates directory of the downloaded latest Zabbix version. Then, while in Configuration → Templates you can import them manually into Zabbix.