Documentation
Supported
7.0
(current)
6.4
6.0
5.0
In development
7.2
(devel)
Unsupported
6.2
5.4
5.2
4.4
4.2
4.0
3.4
3.2
3.0
2.4
2.2
2.0
1.8
General
info
guidelines
English
日本語
Português
Русский
中文
Nederlands
Polski
Français
Español
Українська
Italiano
עִברִית (beta)
Magyar
Català
Zabbix Manual
1 Introduction
1 Manual structure
2 What is Zabbix
3 Zabbix features
4 Zabbix overview
5 What's new in Zabbix 6.0.0
6 What's new in Zabbix 6.0.1
7 What's new in Zabbix 6.0.2
8 What's new in Zabbix 6.0.3
9 What's new in Zabbix 6.0.4
10 What's new in Zabbix 6.0.5
11 What's new in Zabbix 6.0.6
12 What's new in Zabbix 6.0.7
13 What's new in Zabbix 6.0.8
14 What's new in Zabbix 6.0.9
15 What's new in Zabbix 6.0.10
16 What's new in Zabbix 6.0.11
17 What's new in Zabbix 6.0.12
18 What's new in Zabbix 6.0.13
19 What's new in Zabbix 6.0.14
20 What's new in Zabbix 6.0.15
21 What's new in Zabbix 6.0.16
22 What's new in Zabbix 6.0.17
23 What's new in Zabbix 6.0.18
24 What's new in Zabbix 6.0.19
25 What's new in Zabbix 6.0.20
26 What's new in Zabbix 6.0.21
27 What's new in Zabbix 6.0.22
28 What's new in Zabbix 6.0.23
29 What's new in Zabbix 6.0.24
30 What's new in Zabbix 6.0.25
31 What's new in Zabbix 6.0.26
32 What's new in Zabbix 6.0.27
33 What's new in Zabbix 6.0.28
34 What's new in Zabbix 6.0.29
35 What's new in Zabbix 6.0.30
36 What's new in Zabbix 6.0.31
37 What's new in Zabbix 6.0.32
38 What's new in Zabbix 6.0.33
39 What's new in Zabbix 6.0.34
40 What's new in Zabbix 6.0.35
41 What's new in Zabbix 6.0.36
2 Definitions
3 Zabbix processes
1 Server
1 High availability
2 Agent
3 Agent 2
4 Proxy
5 Java gateway
1 Setup from sources
2 Setup from RHEL packages
3 Setup from Debian/Ubuntu packages
6 Sender
7 Get
8 JS
9 Web service
4 Installation
1 Getting Zabbix
2 Requirements
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
1 Debian/Ubuntu frontend installation
7 Upgrade procedure
1 Upgrade from sources
2 Upgrade from packages
1 Red Hat Enterprise Linux
2 Debian/Ubuntu
8 Known issues
1 Compilation issues
9 Template changes
10 Upgrade notes for 6.0.0
11 Upgrade notes for 6.0.1
12 Upgrade notes for 6.0.2
13 Upgrade notes for 6.0.3
14 Upgrade notes for 6.0.4
15 Upgrade notes for 6.0.5
16 Upgrade notes for 6.0.6
17 Upgrade notes for 6.0.7
18 Upgrade notes for 6.0.8
19 Upgrade notes for 6.0.9
20 Upgrade notes for 6.0.10
21 Upgrade notes for 6.0.11
22 Upgrade notes for 6.0.12
23 Upgrade notes for 6.0.13
24 Upgrade notes for 6.0.14
25 Upgrade notes for 6.0.15
26 Upgrade notes for 6.0.16
27 Upgrade notes for 6.0.17
28 Upgrade notes for 6.0.18
29 Upgrade notes for 6.0.19
30 Upgrade notes for 6.0.20
31 Upgrade notes for 6.0.21
32 Upgrade notes for 6.0.22
33 Upgrade notes for 6.0.23
34 Upgrade notes for 6.0.24
35 Upgrade notes for 6.0.25
36 Upgrade notes for 6.0.26
37 Upgrade notes for 6.0.27
38 Upgrade notes for 6.0.28
39 Upgrade notes for 6.0.29
40 Upgrade notes for 6.0.30
41 Upgrade notes for 6.0.31
42 Upgrade notes for 6.0.32
43 Upgrade notes for 6.0.33
44 Upgrade notes for 6.0.34
45 Upgrade notes for 6.0.35
46 Upgrade notes for 6.0.36
5 Quickstart
1 Login and configuring user
2 New host
3 New item
4 New trigger
5 Receiving problem notification
6 New template
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 Item keys specific to agent 2
2 Windows-specific item keys
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 Loadable modules
7 Windows performance counters
8 Mass update
9 Value mapping
10 Queue
11 Value cache
12 Execute now
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
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
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 E-mail
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 Low-level discovery macros
5 Expression macros
12 Users and user groups
1 Configuring a user
2 Permissions
3 User groups
13 Storage of secrets
14 Scheduled reports
8 Service monitoring
1 Service tree
2 Service actions
3 SLA
4 Setup example
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
1 Host groups
2 Templates
3 Hosts
4 Network maps
5 Media types
15 Discovery
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
6 Custom LLD rules
16 Distributed monitoring
1 Proxies
17 Encryption
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
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 Problems
3 Hosts
1 Graphs
2 Web scenarios
4 Latest data
5 Maps
6 Discovery
2 Services
1 Services
2 Service actions
3 SLA
4 SLA report
3 Inventory
1 Overview
2 Hosts
4 Reports
1 System information
2 Scheduled reports
3 Availability report
4 Triggers top 100
5 Audit
6 Action log
7 Notifications
5 Configuration
1 Host groups
2 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
3 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
4 Maintenance
5 Actions
6 Event correlation
7 Discovery
6 Administration
1 General
2 Proxies
3 Authentication
4 User groups
5 User roles
6 Users
7 Media types
8 Scripts
9 Queue
3 User settings
1 Global notifications
2 Sound in browsers
4 Global search
5 Frontend maintenance mode
6 Page parameters
7 Definitions
8 Creating your own theme
9 Debug mode
10 Cookies used by Zabbix
11 Time zones
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
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.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
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.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
Token
> Token object
token.create
token.delete
token.generate
token.get
token.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.unblock
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.4 to 6.0
Zabbix API changes in 6.0
20 Modules
21 Appendixes
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 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 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 Ember+ plugin
4 Memcached plugin
5 Modbus plugin
6 MongoDB plugin
7 MQTT plugin
8 MSSQL plugin
9 MySQL plugin
10 Oracle plugin
11 PostgreSQL plugin
12 Redis plugin
13 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 Real-time export protocol
4 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 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
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
7 Unit symbols
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
Zabbix manpages
zabbix_agent2
zabbix_agentd
zabbix_get
zabbix_js
zabbix_proxy
zabbix_sender
zabbix_server
zabbix_web_service
Back to top