Docs

1 Manual structure

2 What is Zabbix

3 Zabbix features

4 Zabbix overview

5 What's new in Zabbix 7.2.0

6 What's new in Zabbix 7.2.1

7 What's new in Zabbix 7.2.2

8 What's new in Zabbix 7.2.3

9 What's new in Zabbix 7.2.4

10 What's new in Zabbix 7.2.5

11 What's new in Zabbix 7.2.6

12 What's new in Zabbix 7.2.7

13 What's new in Zabbix 7.2.8

14 What's new in Zabbix 7.2.9

15 What's new in Zabbix 7.2.10

16 What's new in Zabbix 7.2.11

17 What's new in Zabbix 7.2.12

18 What's new in Zabbix 7.2.13

19 What's new in Zabbix 7.2.14

20 What's new in Zabbix 7.2.15

3 Zabbix processes

1 High availability

2 Agent

4 Proxy

2 Setup from RHEL packages

3 Setup from Debian/Ubuntu packages

Setup from sources

7 Get

8 JS

1 Getting Zabbix

3 Installation from sources

1 Building Zabbix agent on Windows

2 Building Zabbix agent 2 on Windows

3 Building Zabbix agent on macOS

4 Installation from packages

1 Windows agent installation from MSI

2 macOS agent installation from PKG

3 Unstable releases

5 Installation from containers

6 Web interface installation

7 Upgrade procedure

1 Upgrade from sources

2 Upgrade from packages

1 Red Hat Enterprise Linux

2 Debian/Ubuntu

3 Upgrade from containers

1 Compilation issues

2 Escaping-related upgrade issues

9 Template changes

10 Upgrade notes for 7.2.0

11 Upgrade notes for 7.2.1

12 Upgrade notes for 7.2.2

13 Upgrade notes for 7.2.3

14 Upgrade notes for 7.2.4

15 Upgrade notes for 7.2.5

16 Upgrade notes for 7.2.6

17 Upgrade notes for 7.2.7

18 Upgrade notes for 7.2.8

19 Upgrade notes for 7.2.9

20 Upgrade notes for 7.2.10

21 Upgrade notes for 7.2.11

22 Upgrade notes for 7.2.12

23 Upgrade notes for 7.2.13

24 Upgrade notes for 7.2.14

25 Upgrade notes for 7.2.15

1 Login and configuring user

5 Receiving problem notification

6 Zabbix appliance

7 Configuration

1 Hosts and host groups

1 Configuring a host

2 Configuring a host group

2 Items

1 Creating an item

1 Item key format

2 Custom intervals

2 Item value preprocessing

1 Preprocessing testing

2 Preprocessing details

3 Preprocessing examples

4 JSONPath functionality

1 Escaping special characters from LLD macro values in JSONPath

5 JavaScript preprocessing

1 Additional JavaScript objects

2 Browser item JavaScript objects

6 CSV to JSON preprocessing

4 History and trends

5 User parameters

1 Extending Zabbix agents

6 Windows performance counters

8 Value mapping

9 Queue

12 Restricting agent checks

1 Configuring a trigger

2 Trigger expression

3 Trigger dependencies

4 Trigger severity

5 Customizing trigger severities

7 Predictive trigger functions

1 Trigger event generation

2 Other event sources

3 Manual closing of problems

5 Event correlation

1 Trigger-based event correlation

2 Global event correlation

7 Visualization

1 Simple graphs

2 Custom graphs

3 Ad-hoc graphs

4 Aggregation in graphs

1 Configuring a network map

2 Host group elements

3 Link indicators

8 Templates and template groups

1 Configuring a template

2 Configuring a template group

3 Linking/unlinking

9 Templates out of the box

1 Zabbix agent template operation

2 Zabbix agent 2 template operation

3 HTTP template operation

4 IPMI template operation

5 JMX template operation

6 ODBC template operation

7 Standardized templates for network devices

8 VMware template operation

10 Notifications upon events

1 Email

2 SMS

3 Custom alert scripts

1 Webhook script examples

1 Sending message

2 Remote commands

3 Additional operations

4 Using macros in messages

3 Recovery operations

4 Update operations

3 Receiving notification on unsupported items

1 Macro functions

3 User macros with context

4 Secret user macros

5 Low-level discovery macros

6 Expression macros

12 Users and user groups

1 Configuring a user

13 Storage of secrets

1 CyberArk configuration

2 HashiCorp configuration

14 Scheduled reports

1 Export to files

2 Streaming to external systems

8 Service monitoring

2 SLA

3 Setup example

9 Web monitoring

1 Web monitoring items

2 Real-life scenario

10 Virtual machine monitoring

1 VMware monitoring item keys

2 Virtual machine discovery key fields

3 JSON examples for VMware items

4 VMware monitoring setup example

12 Regular expressions

13 Problem acknowledgment

1 Problem suppression

14 Configuration export/import

1 Template groups

4 Hosts

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 Host prototypes

5 Notes on low-level discovery

6 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 SNMP OIDs (legacy)

6 Discovery of JMX objects

7 Discovery of IPMI sensors

8 Discovery of systemd services

9 Discovery of Windows services

10 Discovery of Windows performance counter instances

11 Discovery using WMI queries

12 Discovery using ODBC SQL queries

13 Discovery using Prometheus data

14 Discovery of block devices

15 Discovery of host interfaces in Zabbix

7 Custom LLD rules

16 Distributed monitoring

1 Synchronization of monitoring configuration

2 Proxy load balancing and high availability

1 Using certificates

2 Using pre-shared keys

3 Troubleshooting

1 Connection type or permission problems

2 Certificate problems

18 Web interface

1 Menu

2 Frontend sections

1 Dashboard widgets

2 Clock

3 Discovery status

4 Favorite graphs

5 Favorite maps

6 Gauge

8 Graph

9 Graph (classic)

10 Graph prototype

12 Host availability

14 Host navigator

15 Item history

16 Item navigator

18 Map

19 Map navigation tree

21 Problem hosts

23 Problems by severity

25 System information

28 Top triggers

29 Trigger overview

30 URL

31 Web monitoring

1 Cause and symptom problems

2 Hosts

2 Host dashboards

3 Web scenarios

4 Maps

2 SLA

2 Hosts

1 System information

2 Scheduled reports

3 Availability report

4 Top 100 triggers

7 Notifications

6 Data collection

8 Users

3 Users

5 Authentication

1 HTTP

2 LDAP

3 SAML

4 MFA

9 Administration

7 Queue

3 User settings

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

12 Resetting password

13 Time period selector

19 Best practices

1 Security best practices

1 Access control

1 Securing MySQL/MariaDB

2 Securing PostgreSQL/TimescaleDB

2 Configuration best practices

20 API

Appendix 1. Reference commentary

Appendix 2. Changes from 7.0 to 7.2

Appendix 3. Changes in 7.2

Method reference

apiinfo.version

Action

Alert

Audit log object

Authentication object

authentication.get

authentication.update

Autoregistration

Autoregistration object

autoregistration.get

autoregistration.update

configuration.export

configuration.import

configuration.importcompare

Connector object

connector.create

connector.delete

connector.update

Correlation object

correlation.create

correlation.delete

correlation.get

correlation.update

Dashboard object

dashboard.create

dashboard.delete

dashboard.update

Dashboard widget fields

2 Clock

3 Discovery status

4 Favorite graphs

5 Favorite maps

6 Gauge

8 Graph

9 Graph (classic)

10 Graph prototype

12 Host availability

14 Host navigator

15 Item history

16 Item navigator

18 Map

19 Map navigation tree

21 Problem hosts

23 Problems by severity

25 System information

28 Top triggers

29 Trigger overview

30 URL

31 Web monitoring

Discovered host

Discovered host object

Discovered service

Discovered service object

Discovery check

Discovery check object

Discovery rule object

Event

event.acknowledge

Graph

Graph item object

Graph prototype

Graph prototype object

graphprototype.create

graphprototype.delete

graphprototype.get

graphprototype.update

High availability node

High availability node object

History

Host

host.massremove

host.massupdate

Host group object

hostgroup.create

hostgroup.delete

hostgroup.massadd

hostgroup.massremove

hostgroup.massupdate

hostgroup.propagate

hostgroup.update

Host interface object

hostinterface.create

hostinterface.delete

hostinterface.get

hostinterface.massadd

hostinterface.massremove

hostinterface.replacehostinterfaces

hostinterface.update

Host prototype object

hostprototype.create

hostprototype.delete

hostprototype.get

hostprototype.update

Housekeeping object

housekeeping.get

housekeeping.update

Icon map object

Image

Item

Item prototype object

itemprototype.create

itemprototype.delete

itemprototype.get

itemprototype.update

LLD rule object

discoveryrule.create

discoveryrule.delete

discoveryrule.get

discoveryrule.update

MFA

mfa.get

Maintenance object

maintenance.create

maintenance.delete

maintenance.get

maintenance.update

Map

map.get

Media type object

mediatype.create

mediatype.delete

mediatype.update

Module

Problem

Proxy

Proxy group object

proxygroup.create

proxygroup.delete

proxygroup.update

Regular expression

Regular expression object

Report

Role

SLA

sla.get

Script

script.getscriptsbyevents

script.getscriptsbyhosts

Service

Settings object

settings.update

Task

Template object

template.create

template.delete

template.massadd

template.massremove

template.massupdate

template.update

Template dashboard

Template dashboard object

templatedashboard.create

templatedashboard.delete

templatedashboard.get

templatedashboard.update

Template group object

templategroup.create

templategroup.delete

templategroup.get

templategroup.massadd

templategroup.massremove

templategroup.massupdate

templategroup.propagate

templategroup.update

Token

Trend

Trigger

Trigger prototype

Trigger prototype object

triggerprototype.create

triggerprototype.delete

triggerprototype.get

triggerprototype.update

User

user.checkAuthentication

User directory object

userdirectory.create

userdirectory.delete

userdirectory.get

userdirectory.test

userdirectory.update

User group object

usergroup.create

usergroup.delete

usergroup.update

User macro object

usermacro.create

usermacro.createglobal

usermacro.delete

usermacro.deleteglobal

usermacro.update

usermacro.updateglobal

Value map object

valuemap.create

valuemap.delete

valuemap.update

Web scenario object

httptest.create

httptest.delete

httptest.update

1 Loadable modules

3 Frontend modules

1 Installation and setup

1 Database creation

2 Repairing Zabbix database character set and collation

3 Database upgrade to primary keys

4 Preparing auditlog table for partitioning

5 Secure connection to the database

1 MySQL encryption configuration

2 PostgreSQL encryption configuration

6 TimescaleDB setup

7 Elasticsearch setup

8 Distribution-specific notes on setting up Nginx for Zabbix

9 Running agent as root

10 Zabbix agent on Microsoft Windows

11 SAML setup with Microsoft Entra ID

12 SAML setup with Okta

13 SAML setup with OneLogin

14 Setting up scheduled reports

15 Additional frontend languages

2 Process configuration

1 Server-proxy data exchange protocol

2 Zabbix agent/agent2 protocol

4 Zabbix agent 2 plugin protocol

5 Zabbix sender protocol

7 Newline-delimited JSON export protocol

4 Items

1 vm.memory.size parameters

2 Passive and active agent checks

3 Minimum permission level for Windows agent items

4 Encoding of returned values

5 Large file support

7 Notes on memtype parameter in proc.mem items

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

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

10 proc.get parameters

11 Unreachable/unavailable host interface settings

12 Remote monitoring of Zabbix stats

13 Configuring Kerberos with Zabbix

14 modbus.get parameters

15 Creating custom performance counter names for VMware

16 Return values for system.sw.packages.get

17 Return values for net.dns.get

18 Notes on system.cpu.util items on Windows

5 Supported functions

1 Aggregate functions

1 Foreach functions

2 Bitwise functions

3 Date and time functions

4 History functions

5 Trend functions

6 Mathematical functions

7 Operator functions

8 Predictive functions

9 String functions

1 Supported macros

2 User macros supported by location

8 Time period syntax

9 Command execution

10 Version compatibility

12 Zabbix sender dynamic link library for Windows

13 Python library for Zabbix API

14 Service monitoring upgrade

15 Other issues

16 Agent vs agent 2 comparison

17 Escaping examples

23 Quick reference guides

1 Monitor Linux with Zabbix agent

2 Monitor Windows with Zabbix agent

3 Monitor Apache via HTTP

4 Monitor MySQL with Zabbix agent 2

5 Monitor VMware with Zabbix

6 Monitor network traffic with Zabbix

7 Monitor network traffic using active checks

8 Monitor websites with Browser items

9 Monitor website certificates with Zabbix agent 2 (passive)

10 Monitor a network switch or router with Zabbix

11 Monitor Windows event log using active checks

Deploy Zabbix in the cloud

Node configuration

Key differences of Zabbix Cloud

Developer Center

Modules

Module file structure

Actions

Views

Assets

Register a new module

Widgets

Create a module (tutorial)

Create a widget (tutorial)

Plugins

Create a plugin (tutorial)

Plugin interfaces

Changes to extension development

Zabbix manpages

zabbix_web_service

On this page

6 Macros
- Overview

6 Macros

Overview

This section allows to define system-wide user macros as name-value pairs. Note that macro values can be kept as plain text, secret text or Vault secret. Adding a description is also supported.

What’s next?