Docs

1. Introduction

1 Manual structure

2 What is Zabbix

3 Zabbix features

4 Zabbix overview

5 What's new in Zabbix 4.4.0

6 What's new in Zabbix 4.4.1

7 What's new in Zabbix 4.4.2

8 What's new in Zabbix 4.4.3

9 What's new in Zabbix 4.4.4

10 What's new in Zabbix 4.4.5

11 What's new in Zabbix 4.4.6

12 What's new in Zabbix 4.4.7

13 What's new in Zabbix 4.4.8

14 What's new in Zabbix 4.4.9

15 What's new in Zabbix 4.4.10

16 What's new in Zabbix 4.4.11

3. Zabbix processes

- Setup from sources

2 Setup from RHEL/CentOS packages

3 Setup from Debian/Ubuntu packages

6 Sender

7 Get

8 JS

2 Agent

agent.md

3 Agent 2

agent2.md

Writing plugins

4 Proxy

proxy.md

1 Server

server.md

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

5 Installation from containers

6 Upgrade procedure

Upgrade from packages

1 Red Hat Enterprise Linux/CentOS

2 Debian/Ubuntu

Upgrade from sources

8 Template changes

9 Upgrade notes for 4.4.0

10 Upgrade notes for 4.4.1

11 Upgrade notes for 4.4.2

12 Upgrade notes for 4.4.3

13 Upgrade notes for 4.4.4

14 Upgrade notes for 4.4.5

15 Upgrade notes for 4.4.6

16 Upgrade notes for 4.4.7

17 Upgrade notes for 4.4.8

18 Upgrade notes for 4.4.9

19 Upgrade notes for 4.4.10

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

3 Preprocessing usage examples

Windows-specific item keys

Redis plugin metrics

1 Dynamic indexes

5 Simple checks

1 VMware monitoring item keys

6 Log file monitoring

7 Calculated items

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

18 Prometheus checks

3 History and trends

4 User parameters

1 Extending Zabbix agents

5 Loadable modules

6 Windows performance counters

8 Value mapping

10 Queue

3 Triggers

1 Configuring a trigger

2 Trigger expression

3 Trigger dependencies

4 Trigger severity

5 Customising trigger severities

7 Predictive trigger functions

5 Event correlation

1 Trigger-based event correlation

Event tags

2 Global event correlation

6 Visualisation

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

3 Screens

1 Screen elements

1 Configuring a template

2 Linking/unlinking

3 Nesting

8 Templates out of the box

2 Template operation

Requirements for MySQL by ODBC template

Requirements for MySQL by Zabbix agent template

Requirements for PostgreSQL template

1 Standardized templates for network devices

network_devices.md

9 Notifications upon events

4 Webhook

Notifications to Opsgenie

Notifications to Pushover app

1 E-mail

email.md

3 Custom alertscripts

script.md

2 SMS

sms.md

2 Actions

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

10 Macros

1 Macro functions

3 Low-level discovery macros

11 Users and user groups

1 Configuring a user

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 acknowledgement

14. Configuration export/import

3 Hosts

5 Screens

1 Network discovery

1 Configuring a network discovery rule

2 Active agent autoregistration

3 Low-level discovery

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

7 Discovery of Windows services

8 Discovery using WMI queries

9 Discovery using ODBC SQL queries

10 Discovery using Prometheus data

11 Discovery of block devices

12 Discovery of host interfaces in Zabbix

Notes on low-level discovery

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

1 Dashboard widgets

2 Problems

3 Overview

4 Web

6 Graphs

7 Screens

8 Maps

1 Overview

2 Hosts

3 Reports

1 System information

2 Availability report

3 Triggers top 100

4 Audit

6 Notifications

4 Configuration

3 Hosts

2 Items

3 Triggers

4 Graphs

5 Discovery rules

6 Web scenarios

5 Actions

6 Event correlation

8 Services

5 Administration

1 General

2 Proxies

3 Authentication

5 Users

7 Scripts

8 Queue

1 Global notifications

2 Sound in browsers

3 Global search

4 Frontend maintenance mode

5 Page parameters

7 Creating your own theme

9 Cookies used by Zabbix

19. API

Appendix 1. Reference commentary

Appendix 2. Changes from 4.2 to 4.4

Method reference

API info

apiinfo.version

Action

action.get

Alert

alert.get

Application object

application.create

application.delete

application.get

application.massadd

application.update

Auto registration

Autoregistration object

autoregistration.get

autoregistration.update

configuration.export

configuration.import

Correlation object

correlation.create

correlation.delete

correlation.get

correlation.update

Dashboard

Dashboard object

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

History

Host

host.get

host.massremove

host.massupdate

Host group

Host group object

hostgroup.create

hostgroup.delete

hostgroup.massadd

hostgroup.massremove

hostgroup.massupdate

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

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

Screen

screen.get

Screen item object

screenitem.create

screenitem.delete

screenitem.update

screenitem.updatebyposition

Script

script.get

script.getscriptsbyhosts

Service

service.adddependencies

service.addtimes

service.deletedependencies

service.deletetimes

Task

Template

Template object

template.create

template.delete

template.massadd

template.massremove

template.massupdate

template.update

Template screen

Template screen object

templatescreen.copy

templatescreen.create

templatescreen.delete

templatescreen.get

templatescreen.update

Template screen item

Template screen item object

templatescreenitem.get

Trend

trend.get

Trigger

trigger.adddependencies

trigger.deletedependencies

Trigger prototype

Trigger prototype object

triggerprototype.create

triggerprototype.delete

triggerprototype.get

triggerprototype.update

User

user.checkAuthentication

user.get

user.login

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 4.4

1 Frequently asked questions / Troubleshooting

1 Database creation

2 Repairing Zabbix database character set and collation

3 Migration to TimescaleDB

4 Elasticsearch setup

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

6 Distribution-specific notes on setting up Nginx for Zabbix

7 Running agent as root

8 Zabbix agent on Microsoft Windows

3 Daemon configuration

1 Zabbix server

3 Zabbix agent (UNIX)

4 Zabbix agent 2 (UNIX)

5 Zabbix agent (Windows)

6 Zabbix Java gateway

6 Zabbix agent 2 (Windows)

7 Special notes on "Include" parameter

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

6 Preprocessing

1 Preprocessing details

2 JSONPath functionality

Escaping special characters from LLD macro values in JSONPath

3 Javascript preprocessing

Additional Javascript objects

4 CSV to JSON preprocessing

7 Triggers

1 Supported trigger functions

8 Macros

1 Supported macros

2 User macros supported by location

10 Setting time periods

11 Command execution

12 Recipes for monitoring

13 Performance tuning

14 Version compatibility

15 Database error handling

16 Zabbix sender dynamic link library for Windows

17 Issues with SELinux

18 Other issues

Zabbix manpages

zabbix_get

zabbix_js

On this page

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

What’s next?