Docs

1. Introduction

1 Manual structure

2 What is Zabbix

3 Zabbix features

4 Zabbix overview

5 What's new in Zabbix 6.2.0

6 What's new in Zabbix 6.2.1

7 What's new in Zabbix 6.2.2

8 What's new in Zabbix 6.2.3

9 What's new in Zabbix 6.2.4

10 What's new in Zabbix 6.2.5

11 What's new in Zabbix 6.2.6

12 What's new in Zabbix 6.2.7

13 What's new in Zabbix 6.2.8

14 What's new in Zabbix 6.2.9

3. Zabbix processes

1 Server

1 High availability

2 Agent

3 Agent 2

4 Proxy

- 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

Plugins

1 PostgreSQL plugin dependencies

2 MongoDB plugin dependencies

3 Installation from sources

Building Zabbix agent 2 on Windows

Building Zabbix agent on Windows

Building Zabbix agent on macOS

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

5 Mac OS agent installation from PKG

6 Unstable releases

5 Installation from containers

6 Web interface 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 6.2.0

11 Upgrade notes for 6.2.1

12 Upgrade notes for 6.2.2

13 Upgrade notes for 6.2.3

14 Upgrade notes for 6.2.4

15 Upgrade notes for 6.2.5

16 Upgrade notes for 6.2.6

17 Upgrade notes for 6.2.7

18 Upgrade notes for 6.2.8

19 Upgrade notes for 6.2.9

1 Login and configuring user

2 New host

3 New item

5 Receiving problem notification

6. Zabbix appliance

7. Configuration

1 Trigger event generation

2 Other event sources

3 Manual closing of problems

1 Hosts and host groups

1 Configuring a host

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

Windows Zabbix agent

1 Dynamic indexes

5 Simple checks

VMware monitoring item keys

6 Log file monitoring

7 Calculated items

Aggregate calculations

8 Internal 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

17 Prometheus checks

18 Script items

4 History and trends

5 User parameters

1 Extending Zabbix agents

6 Loadable modules

7 Windows performance counters

9 Value mapping

10 Queue

13 Restricting agent checks

14 Plugins

1 Building loadable plugins

3 Triggers

1 Configuring a trigger

2 Trigger expression

3 Trigger dependencies

4 Trigger severity

5 Customizing trigger severities

7 Predictive trigger functions

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

1 Configuring a network map

2 Host group elements

3 Link indicators

4 Host dashboards

8 Templates and template groups

1 Configuring a template

2 Linking/unlinking

3 Nesting

9 Templates out of the box

HTTP template operation

IPMI template operation

JMX template operation

ODBC template operation

Standardized templates for network devices

Zabbix agent 2 template operation

Zabbix agent template operation

10 Notifications upon events

11 Macros

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

CyberArk configuration

HashiCorp configuration

14 Scheduled reports

8. Service monitoring

2 Service actions

3 SLA

4 Setup example

9. Web monitoring

1 Web monitoring items

2 Real-life scenario

10. Virtual machine monitoring

VMware monitoring item keys

Virtual machine discovery key fields

JSON examples for VMware items

11. Maintenance

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

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

5 Notes on low-level discovery

notes.md

16. Distributed monitoring

1 Proxies

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

Dashboard widgets

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

13 Map

14 Map navigation tree

16 Problem hosts

18 Problems by severity

20 System information

22 Trigger overview

23 URL

24 Web monitoring

3 Hosts

1 Graphs

2 Web scenarios

5 Maps

2 Problems

2 Services

1 Services

2 Service actions

3 SLA

1 Overview

2 Hosts

4 Reports

1 System information

2 Scheduled reports

3 Availability report

4 Triggers top 100

5 Audit

7 Notifications

5 Configuration

1 Template groups

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

6 Actions

7 Event correlation

6 Administration

1 General

2 Proxies

3 Authentication

6 Users

8 Scripts

9 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

19. API

Appendix 1. Reference commentary

Appendix 2. Changes from 6.0 to 6.2

Method reference

API info

apiinfo.version

Action

action.get

Alert

alert.get

Audit log

Audit log object

Authentication object

authentication.get

authentication.update

Autoregistration

Autoregistration object

autoregistration.get

autoregistration.update

configuration.export

configuration.import

configuration.importcompare

Correlation object

correlation.create

correlation.delete

correlation.get

correlation.update

Dashboard

Dashboard object

Dashboard widget fields

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

13 Map

14 Map navigation tree

16 Problem hosts

18 Problems by severity

20 System information

22 Trigger overview

23 URL

24 Web monitoring

dashboard.create

dashboard.delete

dashboard.update

Discovered host

Discovered host object

dhost.get

Discovered service

Discovered service object

Discovery check

Discovery check object

dcheck.get

Discovery rule object

drule.get

Event

event.acknowledge

event.get

Graph

graph.get

Graph item

Graph item object

Graph prototype

Graph prototype object

graphprototype.create

graphprototype.delete

graphprototype.get

graphprototype.update

High availability node

High availability node object

hanode.get

History

Host

host.get

host.massremove

host.massupdate

Host group

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

Icon map object

Image

image.get

Item

item.get

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

Problem

Proxy

proxy.get

Regular expression

Regular expression object

regexp.get

Report

report.get

Role

role.get

SLA

SLA object

sla.create

sla.delete

sla.get

sla.getsli

sla.update

Script

script.get

script.getscriptsbyhosts

Service

Settings

Settings object

settings.update

Task

task.get

Template

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

token.get

Trend

trend.get

Trigger

Trigger prototype

Trigger prototype object

triggerprototype.create

triggerprototype.delete

triggerprototype.get

triggerprototype.update

User

user.checkAuthentication

user.get

user.login

User directory object

userdirectory.create

userdirectory.delete

userdirectory.get

userdirectory.test

userdirectory.update

User group

User group object

usergroup.create

usergroup.delete

usergroup.update

User macro

User macro object

usermacro.create

usermacro.createglobal

usermacro.delete

usermacro.deleteglobal

usermacro.update

usermacro.updateglobal

Value map

Value map object

valuemap.create

valuemap.delete

valuemap.update

Web scenario object

httptest.create

httptest.delete

httptest.update

Zabbix API changes in 6.2

1 Frequently asked questions / Troubleshooting

2 Installation and setup

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 Real-time export of events, item values, trends

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 Okta

12 Oracle database setup

13 Setting up scheduled reports

14 Additional frontend languages

2 Repairing Zabbix database character set and collation

db_charset_coll.md

1 Database creation

3 Process configuration

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 Real-time export protocol

5 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

6 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

7 Macros

1 Supported macros

2 User macros supported by location

9 Time period syntax

10 Command execution

11 Version compatibility

12 Database error handling

13 Zabbix sender dynamic link library for Windows

14 Service monitoring upgrade

15 Other issues

16 Agent vs agent 2 comparison

Zabbix manpages

zabbix_get

zabbix_js

zabbix_web_service

On this page

Autoregistration

Autoregistration

This class is designed to work with autoregistration.

Object references:\

Autoregistration

Available methods:\

autoregistration.get - retrieve autoregistration
autoregistration.update - update autoregistration

What’s next?

Autoregistration object