1 Manual structure

2 What is Zabbix

3 Zabbix features

4 Zabbix overview

5 What's new in Zabbix 6.4.0

6 What's new in Zabbix 6.4.1

7 What's new in Zabbix 6.4.2

8 What's new in Zabbix 6.4.3

9 What's new in Zabbix 6.4.4

10 What's new in Zabbix 6.4.5

11 What's new in Zabbix 6.4.6

12 What's new in Zabbix 6.4.7

13 What's new in Zabbix 6.4.8

14 What's new in Zabbix 6.4.9

15 What's new in Zabbix 6.4.10

16 What's new in Zabbix 6.4.11

17 What's new in Zabbix 6.4.12

18 What's new in Zabbix 6.4.13

19 What's new in Zabbix 6.4.14

20 What's new in Zabbix 6.4.15

21 What's new in Zabbix 6.4.16

22 What's new in Zabbix 6.4.17

23 What's new in Zabbix 6.4.18

24 What's new in Zabbix 6.4.19

25 What's new in Zabbix 6.4.20

3 Zabbix processes

1 Server

1 High availability

2 Agent

3 Agent 2

4 Proxy

1 Setup from sources

2 Setup from RHEL packages

3 Setup from Debian/Ubuntu packages

6 Sender

7 Get

8 JS

1 Getting Zabbix

1 Plugins

1 PostgreSQL plugin dependencies

2 MongoDB plugin dependencies

2 Best practices for secure Zabbix setup

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 Red Hat Enterprise Linux

2 Debian/Ubuntu/Raspbian

3 SUSE Linux Enterprise Server

4 Windows agent installation from MSI

5 Mac OS agent installation from PKG

6 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

9 Template changes

10 Upgrade notes for 6.4.0

11 Upgrade notes for 6.4.1

12 Upgrade notes for 6.4.2

13 Upgrade notes for 6.4.3

14 Upgrade notes for 6.4.4

15 Upgrade notes for 6.4.5

16 Upgrade notes for 6.4.6

17 Upgrade notes for 6.4.7

18 Upgrade notes for 6.4.8

19 Upgrade notes for 6.4.9

20 Upgrade notes for 6.4.10

21 Upgrade notes for 6.4.11

22 Upgrade notes for 6.4.12

23 Upgrade notes for 6.4.13

24 Upgrade notes for 6.4.14

25 Upgrade notes for 6.4.15

26 Upgrade notes for 6.4.16

27 Upgrade notes for 6.4.17

28 Upgrade notes for 6.4.18

29 Upgrade notes for 6.4.19

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

1 Escaping special characters from LLD macro values in JSONPath

4 JavaScript preprocessing

1 Additional JavaScript objects

5 CSV to JSON preprocessing

3 Item types

1 Zabbix agent

1 Zabbix agent 2

2 Windows Zabbix agent

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

1 Aggregate calculations

8 Internal checks

9 SSH checks

10 Telnet checks

11 External checks

12 Trapper items

13 JMX monitoring

14 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

15 Dependent items

16 HTTP agent

17 Prometheus checks

18 Script items

4 History and trends

5 User parameters

1 Extending Zabbix agents

6 Windows performance counters

7 Mass update

8 Value mapping

9 Queue

10 Value cache

11 Execute now

12 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

2 Global event correlation

6 Tagging

7 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 Dashboards

4 Host dashboards

8 Templates and template groups

1 Configuring a template

2 Linking/unlinking

3 Nesting

4 Mass update

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

10 Notifications upon events

1 Media types

1 Email

2 SMS

3 Custom alert scripts

4 Webhook

1 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

11 Macros

1 Macro functions

2 User macros

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

2 Permissions

3 User groups

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

3 Templates

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

16 Distributed monitoring

1 Proxies

1 Synchronization of monitoring configuration

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

1 Event menu

2 Host menu

3 Item menu

2 Frontend sections

1 Dashboards

1 Dashboard widgets

1 Action log

2 Clock

3 Data overview

4 Discovery status

5 Favorite graphs

6 Favorite maps

7 Geomap

8 Graph

9 Graph (classic)

10 Graph prototype

11 Host availability

12 Item value

13 Map

14 Map navigation tree

15 Plain text

16 Problem hosts

17 Problems

18 Problems by severity

19 SLA report

20 System information

21 Top hosts

22 Trigger overview

23 URL

24 Web monitoring

2 Monitoring

1 Problems

1 Cause and symptom problems

2 Hosts

1 Graphs

2 Web scenarios

3 Latest data

4 Maps

5 Discovery

3 Services

1 Services

2 SLA

3 SLA report

4 Inventory

1 Overview

2 Hosts

5 Reports

1 System information

2 Scheduled reports

3 Availability report

4 Triggers top 100

5 Audit log

6 Action log

7 Notifications

6 Data collection

1 Template groups

2 Host groups

3 Templates

1 Items

2 Triggers

3 Graphs

4 Discovery rules

1 Item prototypes

2 Trigger prototypes

3 Graph prototypes

4 Host prototypes

5 Web scenarios

4 Hosts

1 Items

2 Triggers

3 Graphs

4 Discovery rules

1 Item prototypes

2 Trigger prototypes

3 Graph prototypes

4 Host prototypes

5 Web scenarios

5 Maintenance

6 Event correlation

7 Discovery

7 Alerts

1 Actions

2 Media types

3 Scripts

8 Users

1 User groups

2 User roles

3 Users

4 API tokens

5 Authentication

1 HTTP

2 LDAP

3 SAML

9 Administration

1 General

2 Audit log

3 Housekeeping

4 Proxies

5 Macros

6 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

19 API

Method reference

Action

> Action object

action.create

action.delete

action.get

action.update

Alert

> Alert object

alert.get

API info

apiinfo.version

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

configuration.importcompare

Connector

> Connector object

connector.create

connector.delete

connector.get

connector.update

Correlation

> Correlation object

correlation.create

correlation.delete

correlation.get

correlation.update

Dashboard

> Dashboard object

Dashboard widget fields

1 Action log

2 Clock

3 Data overview

4 Discovery status

5 Favorite graphs

6 Favorite maps

7 Geomap

8 Graph

9 Graph (classic)

10 Graph prototype

11 Host availability

12 Item value

13 Map

14 Map navigation tree

15 Plain text

16 Problem hosts

17 Problems

18 Problems by severity

19 SLA report

20 System information

21 Top hosts

22 Trigger overview

23 URL

24 Web monitoring

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

High availability node

> High availability node object

hanode.get

History

> History object

history.clear

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.propagate

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

Module

> Module object

module.create

module.delete

module.get

module.update

Problem

> Problem object

problem.get

Proxy

> Proxy object

proxy.create

proxy.delete

proxy.get

proxy.update

Regular expression

> Regular expression object

regexp.create

regexp.delete

regexp.get

regexp.update

Report

> Report object

report.create

report.delete

report.get

report.update

Role

> Role object

role.create

role.delete

role.get

role.update

Script

> Script object

script.create

script.delete

script.execute

script.get

script.getscriptsbyevents

script.getscriptsbyhosts

script.update

Service

> Service object

service.create

service.delete

service.get

service.update

Settings

> Settings object

settings.get

settings.update

SLA

> SLA object

sla.create

sla.delete

sla.get

sla.getsli

sla.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

Template group

> Template group object

templategroup.create

templategroup.delete

templategroup.get

templategroup.massadd

templategroup.massremove

templategroup.massupdate

templategroup.propagate

templategroup.update

Token

> Token object

token.create

token.delete

token.generate

token.get

token.update

Trend

> Trend object

trend.get

Trigger

> Trigger object

trigger.create

trigger.delete

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.provision

user.unblock

user.update

User directory

> User directory object

userdirectory.create

userdirectory.delete

userdirectory.get

userdirectory.test

userdirectory.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 6.2 to 6.4

Zabbix API changes in 6.4

1 Loadable modules

2 Plugins

1 Building loadable plugins

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 Secure connection to the database

1 MySQL encryption configuration

2 PostgreSQL encryption configuration

5 TimescaleDB setup

6 Elasticsearch setup

7 Distribution-specific notes on setting up Nginx for Zabbix

8 Running agent as root

9 Zabbix agent on Microsoft Windows

10 SAML setup with Microsoft Entra ID

11 SAML setup with Okta

12 SAML setup with OneLogin

13 Oracle database setup

14 Setting up scheduled reports

15 Upgrading to numeric values of extended range

16 Additional frontend languages

2 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 agent 2 plugins

1 Ceph plugin

2 Docker plugin

3 Memcached plugin

4 Modbus plugin

5 MongoDB plugin

6 MQTT plugin

7 MSSQL plugin

8 MySQL plugin

9 Oracle plugin

10 PostgreSQL plugin

11 Redis plugin

12 Smart plugin

8 Zabbix Java gateway

9 Zabbix web service

10 Inclusion

3 Protocols

1 Server-proxy data exchange protocol

2 Zabbix agent protocol

3 Zabbix agent 2 protocol

4 Zabbix agent 2 plugin protocol

5 Zabbix sender protocol

6 Header

7 Newline-delimited JSON export protocol

4 Items

1 vm.memory.size parameters

2 Passive and active agent checks

3 Trapper items

4 Minimum permission level for Windows agent items

5 Encoding of returned values

6 Large file support

7 Sensor

8 Notes on memtype parameter in proc.mem items

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

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

11 proc.get parameters

12 Unreachable/unavailable host interface settings

13 Remote monitoring of Zabbix stats

14 Configuring Kerberos with Zabbix

15 modbus.get parameters

16 Creating custom performance counter names for VMware

17 Return values

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 Prediction functions

9 String functions

6 Macros

1 Supported macros

2 User macros supported by location

8 Time period syntax

9 Command execution

10 Version compatibility

11 Database error handling

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

22 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

Developer Center

Modules

Module file structure

manifest.json

Actions

Views

Assets

Register a new module

Widgets

Configuration

Presentation

Tutorials

Create a module (tutorial)

Create a widget (tutorial)

Examples

Plugins

Examples

Create a plugin (tutorial)

Plugin interfaces

Zabbix manpages

zabbix_web_service

Table of Contents

Map

Map

This class is designed to work with maps.

Object references:

Available methods:

map.create - create new maps
map.delete - delete maps
map.get - retrieve maps
map.update - update maps