Documentation
Supported
7.2
(current)
7.0
6.4
6.0
5.0
In development
7.4
(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
Русский
中文
Français
Türkçe
This is the documentation page for an unsupported version of Zabbix.
Is this not what you were looking for? Switch to the
current version
or choose one from the drop-down menu.
Zabbix Manual
1. Introduction
1 Manual structure
2 What is Zabbix
3 Zabbix features
4 Zabbix overview
5 What's new in Zabbix 4.2.0
6 What's new in Zabbix 4.2.1
7 What's new in Zabbix 4.2.2
8 What's new in Zabbix 4.2.3
9 What's new in Zabbix 4.2.4
10 What's new in Zabbix 4.2.5
11 What's new in Zabbix 4.2.6
12 What's new in Zabbix 4.2.7
13 What's new in Zabbix 4.2.8
2. Definitions
3. Zabbix processes
1 Server
2 Agent
3 Proxy
4 Java gateway
1 Setup from sources
2 Setup from RHEL/CentOS packages
3 Setup from Debian/Ubuntu packages
5 Sender
6 Get
4. Installation
1 Getting Zabbix
2 Requirements
Best practices for secure Zabbix setup
3 Installation from sources
Building Zabbix agent on macOS
Building Zabbix agent on Windows
4 Installation from packages
1 Red Hat Enterprise Linux/CentOS
2 Debian/Ubuntu/Raspbian
3 Windows agent installation from MSI
4 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
7 Known issues
8 Template changes
9 Upgrade notes for 4.2.0
10 Upgrade notes for 4.2.1
11 Upgrade notes for 4.2.2
12 Upgrade notes for 4.2.3
13 Upgrade notes for 4.2.4
14 Upgrade notes for 4.2.5
15 Upgrade notes for 4.2.6
16 Upgrade notes for 4.2.7
17 Upgrade notes for 4.2.8
18 Upgrade notes for 4.2.9
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 types
1 Zabbix agent
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
8 Internal checks
9 SSH 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
17 HTTP agent
18 Prometheus checks
3 History and trends
4 User parameters
1 Extending Zabbix agents
5 Loadable modules
6 Windows performance counters
7 Mass update
8 Value mapping
9 Applications
10 Queue
11 Value cache
12 Check now
3 Triggers
1 Configuring a trigger
2 Trigger expression
3 Trigger dependencies
4 Trigger severity
5 Customising 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
Event tags
2 Global event correlation
6 Visualisation
1 Graphs
1 Simple graphs
2 Custom graphs
3 Ad-hoc graphs
2 Network maps
1 Configuring a network map
2 Host group elements
3 Link indicators
3 Screens
1 Screen elements
4 Slide shows
5 Host screens
7 Templates
1 Configuring a template
2 Linking/unlinking
3 Nesting
4 Mass update
8 Templates out of the box
1 Standardized templates for network devices
9 Notifications upon events
1 Media types
1 E-mail
2 SMS
3 Jabber
4 Ez Texting
5 Custom alertscripts
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
10 Macros
1 Macro functions
2 User macros
3 Low-level discovery macros
11 Users and user groups
1 Configuring a user
2 Permissions
3 User groups
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
1 Host groups
2 Templates
3 Hosts
4 Network maps
5 Screens
15. Discovery
1 Network discovery
1 Configuring a network discovery rule
2 Active agent auto-registration
3 Low-level discovery
1 Discovery of network interfaces
2 Discovery of CPUs and CPU cores
3 Discovery of SNMP OIDs
4 Discovery of JMX objects
5 Discovery using ODBC SQL queries
6 Discovery of Windows services
7 Discovery using Prometheus data
8 Discovery of host interfaces in Zabbix
Notes on low-level discovery
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 Frontend sections
1 Monitoring
1 Dashboard
1 Dashboard widgets
2 Problems
3 Overview
4 Web
5 Latest data
6 Graphs
7 Screens
8 Maps
9 Discovery
10 Services
2 Inventory
1 Overview
2 Hosts
3 Reports
1 System information
2 Availability report
3 Triggers top 100
4 Audit
5 Action log
6 Notifications
4 Configuration
1 Host groups
2 Templates
3 Hosts
1 Applications
2 Items
3 Triggers
4 Graphs
5 Discovery rules
6 Web scenarios
4 Maintenance
5 Actions
6 Event correlation
7 Discovery
8 Services
5 Administration
1 General
2 Proxies
3 Authentication
4 User groups
5 Users
6 Media types
7 Scripts
8 Queue
2 User profile
1 Global notifications
2 Sound in browsers
3 Global search
4 Frontend maintenance mode
5 Page parameters
6 Definitions
7 Creating your own theme
8 Debug mode
19. API
Method reference
Action
> Action object
action.create
action.delete
action.get
action.update
Alert
> Alert object
alert.get
API info
apiinfo.version
Application
> Application object
application.create
application.delete
application.get
application.massadd
application.update
Configuration
configuration.export
configuration.import
Correlation
> Correlation object
correlation.create
correlation.delete
correlation.get
correlation.update
Dashboard
> Dashboard object
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
History
> History object
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
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
Screen
> Screen object
screen.create
screen.delete
screen.get
screen.update
Screen item
> Screen item object
screenitem.create
screenitem.delete
screenitem.get
screenitem.update
screenitem.updatebyposition
Script
> Script object
script.create
script.delete
script.execute
script.get
script.getscriptsbyhosts
script.update
Service
> Service object
service.adddependencies
service.addtimes
service.create
service.delete
service.deletedependencies
service.deletetimes
service.get
service.getsla
service.update
Task
task.create
Template
> Template object
template.create
template.delete
template.get
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 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.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 4.0 to 4.2
Zabbix API changes in 4.2
20. Appendixes
1 Frequently asked questions / Troubleshooting
2 Installation
1 Database creation
2 Zabbix agent on Microsoft Windows
3 Elasticsearch setup
4 Migration to TimescaleDB
5 Real-time export of events, values, trends
3 Daemon configuration
1 Zabbix server
2 Zabbix proxy
3 Zabbix agent (UNIX)
4 Zabbix agent (Windows)
5 Zabbix Java gateway
6 Special notes on "Include" parameter
4 Protocols
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 Item value preprocessing details
13 Supported JSONPath functionality
14 Preprocessing by Javascript details
15 Unreachable/unavailable host settings
16 Remote monitoring of Zabbix stats
6 Triggers
1 Supported trigger functions
7 Macros
1 Supported macros
2 User macros supported by location
8 Unit symbols
9 Setting time periods
10 Command execution
11 Recipes for monitoring
12 Performance tuning
13 Version compatibility
14 Database error handling
15 Zabbix sender dynamic link library for Windows
16 Issues with SELinux
17 Other issues
Zabbix manpages
zabbix_agentd
zabbix_get
zabbix_proxy
zabbix_sender
zabbix_server
Table of Contents
11 Upgrade notes for 4.2.2
Frontend
11 Upgrade notes for 4.2.2
Frontend
In this version only,
write
permissions to the
assets
directory are required for the web server user. (See also
known issues
.)
The
styles
folder has been moved to the
assets
directory, which is important if creating a
custom theme
.
Media types in the
Action log
dashboard
widget
/screen
element
are now sorted by media type ID instead of media type name.
Back to top
Copy
✔ Copied
Suggest an improvement
<%= selection %>
<%= context %>
We appreciate your feedback! Our documentation writers will review your report and consider making suggested changes. Please note that we cannot respond. If you would like to follow up on the progress or participate in the discussion, please consider creating a documentation bug report at
https://support.zabbix.com/
Report
Close
To toggle search highlight, press
Ctrl+Alt+H
Have an improvement suggestion for this page? Select the text that could be improved and press
Ctrl+Enter
to send it to the editors.
To toggle search highlight, press
Command+Alt+H
Have an improvement suggestion for this page? Select the text that could be improved and press
Command+Enter
to send it to the editors.
Suggest an example
We greatly appreciate your contribution! Our documentation writers will review the example and consider incorporating it into the page. Please note that while we cannot provide a direct response, your input is highly valuable to us in improving our documentation.
Send
Close