Documentation

Sidebar

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
2. Definitions
1 High availability
2 Agent
3 Agent 2
4 Proxy
1 Setup from sources
2 Setup from RHEL/CentOS packages
3 Setup from Debian/Ubuntu packages
6 Sender
7 Get
8 JS
9 Web service
1 Getting Zabbix
Best practices for secure Zabbix setup
Building Zabbix agent 2 on Windows
Building Zabbix agent on macOS
Building Zabbix agent on Windows
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 Web interface installation
1 Red Hat Enterprise Linux/CentOS
2 Debian/Ubuntu
Upgrade from sources
8 Known issues
9 Template changes
10 Upgrade notes for 6.2.0
11 Upgrade notes for 6.2.1
1 Login and configuring user
2 New host
3 New item
4 New trigger
5 Receiving problem notification
6 New template
6. Zabbix appliance
1 Configuring a host
2 Inventory
3 Mass update
1 Item key format
2 Custom intervals
1 Usage examples
2 Preprocessing details
Escaping special characters from LLD macro values in JSONPath
Additional JavaScript objects
5 CSV to JSON preprocessing
Windows Zabbix agent
Zabbix agent 2
1 Dynamic indexes
2 Special OIDs
3 MIB files
3 SNMP traps
4 IPMI checks
VMware monitoring item keys
6 Log file monitoring
Aggregate calculations
8 Internal checks
9 SSH checks
10 Telnet checks
11 External checks
12 Trapper items
13 JMX 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
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 Configuring a trigger
2 Trigger expression
3 Trigger dependencies
4 Trigger severity
5 Customizing trigger severities
6 Mass update
7 Predictive trigger functions
1 Trigger event generation
2 Other event sources
3 Manual closing of problems
1 Trigger-based event correlation
2 Global event correlation
6 Tagging
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 Dashboards
4 Host dashboards
1 Configuring a template
2 Linking/unlinking
3 Nesting
4 Mass update
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
1 E-mail
2 SMS
3 Custom alertscripts
Webhook script examples
1 Conditions
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
1 Macro functions
2 Secret user macros
2 User macros
3 User macros with context
4 Low-level discovery macros
6 Expression macros
1 Configuring a user
2 Permissions
3 User groups
CyberArk configuration
HashiCorp configuration
14 Scheduled reports
1 Service tree
2 Service actions
3 SLA
4 Setup example
1 Web monitoring items
2 Real life scenario
VMware monitoring item keys
Virtual machine discovery key fields
JSON examples for VMware items
11. Maintenance
12. Regular expressions
1. Problem suppression
1 Template groups
2 Host groups
3 Templates
4 Hosts
5 Network maps
6 Media types
1 Configuring a network discovery rule
2 Active agent autoregistration
1 Item prototypes
2 Trigger prototypes
3 Graph prototypes
4 Host prototypes
5 Notes on 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 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
1 Proxies
1 Using certificates
2 Using pre-shared keys
1 Connection type or permission problems
2 Certificate problems
3 PSK problems
1 Menu
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
1 Graphs
2 Web scenarios
4 Latest data
5 Maps
6 Discovery
1 Services
2 Service actions
3 SLA
4 SLA report
1 Overview
2 Hosts
1 System information
2 Scheduled reports
3 Availability report
4 Triggers top 100
5 Audit
6 Action log
7 Notifications
1 Template groups
2 Host groups
1 Items
2 Triggers
3 Graphs
1 Item prototypes
2 Trigger prototypes
3 Graph prototypes
4 Host prototypes
5 Web scenarios
1 Items
2 Triggers
3 Graphs
1 Item prototypes
2 Trigger prototypes
3 Graph prototypes
4 Host prototypes
5 Web scenarios
5 Maintenance
6 Actions
7 Event correlation
8 Discovery
1 General
2 Proxies
3 Authentication
4 User groups
5 User roles
6 Users
7 Media types
8 Scripts
9 Queue
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 Rebranding
> Action object
action.create
action.delete
action.get
action.update
> Alert object
alert.get
apiinfo.version
> Audit log object
auditlog.get
> Authentication object
authentication.get
authentication.update
> Autoregistration object
autoregistration.get
autoregistration.update
configuration.export
configuration.import
configuration.importcompare
> Correlation object
correlation.create
correlation.delete
correlation.get
correlation.update
> Dashboard object
dashboard.create
dashboard.delete
dashboard.get
dashboard.update
> Discovered host object
dhost.get
> Discovered service object
dservice.get
> Discovery check object
dcheck.get
> Discovery rule object
drule.create
drule.delete
drule.get
drule.update
> Event object
event.acknowledge
event.get
> Graph object
graph.create
graph.delete
graph.get
graph.update
> Graph item object
graphitem.get
> Graph prototype object
graphprototype.create
graphprototype.delete
graphprototype.get
graphprototype.update
> High availability node object
hanode.get
> History object
history.clear
history.get
> Host object
host.create
host.delete
host.get
host.massadd
host.massremove
host.massupdate
host.update
> Host group object
hostgroup.create
hostgroup.delete
hostgroup.get
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 object
iconmap.create
iconmap.delete
iconmap.get
iconmap.update
> Image object
image.create
image.delete
image.get
image.update
> Item object
item.create
item.delete
item.get
item.update
> Item prototype object
itemprototype.create
itemprototype.delete
itemprototype.get
itemprototype.update
> LLD rule object
discoveryrule.copy
discoveryrule.create
discoveryrule.delete
discoveryrule.get
discoveryrule.update
> Maintenance object
maintenance.create
maintenance.delete
maintenance.get
maintenance.update
> Map object
map.create
map.delete
map.get
map.update
> Media type object
mediatype.create
mediatype.delete
mediatype.get
mediatype.update
> Problem object
problem.get
> Proxy object
proxy.create
proxy.delete
proxy.get
proxy.update
> Regular expression object
regexp.create
regexp.delete
regexp.get
regexp.update
> Report object
report.create
report.delete
report.get
report.update
> Role object
role.create
role.delete
role.get
role.update
> Script object
script.create
script.delete
script.execute
script.get
script.getscriptsbyhosts
script.update
> Service object
service.create
service.delete
service.get
service.update
> Settings object
settings.get
settings.update
> SLA object
sla.create
sla.delete
sla.get
sla.getsli
sla.update
> Task object
task.create
task.get
> Template object
template.create
template.delete
template.get
template.massadd
template.massremove
template.massupdate
template.update
> 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 object
token.create
token.delete
token.generate
token.get
token.update
> Trend object
trend.get
> Trigger object
trigger.create
trigger.delete
trigger.get
trigger.update
> Trigger prototype object
triggerprototype.create
triggerprototype.delete
triggerprototype.get
triggerprototype.update
> User object
user.checkAuthentication
user.create
user.delete
user.get
user.login
user.logout
user.unblock
user.update
> User directory object
userdirectory.create
userdirectory.delete
userdirectory.get
userdirectory.test
userdirectory.update
> User group object
usergroup.create
usergroup.delete
usergroup.get
usergroup.update
> User macro object
usermacro.create
usermacro.createglobal
usermacro.delete
usermacro.deleteglobal
usermacro.get
usermacro.update
usermacro.updateglobal
> Value map object
valuemap.create
valuemap.delete
valuemap.get
valuemap.update
> Web scenario object
httptest.create
httptest.delete
httptest.get
httptest.update
Appendix 1. Reference commentary
Appendix 2. Changes from 6.0 to 6.2
Zabbix API changes in 6.2
20. Modules
1 Frequently asked questions / Troubleshooting
1 Database creation
2 Repairing Zabbix database character set and collation
3 Database upgrade to primary keys
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
1 Zabbix server
2 Zabbix proxy
3 Zabbix agent (UNIX)
4 Zabbix agent 2 (UNIX)
5 Zabbix agent (Windows)
6 Zabbix agent 2 (Windows)
1 Ceph plugin
2 Docker plugin
3 Memcached plugin
4 Modbus plugin
5 MongoDB plugin
6 MQTT plugin
7 MySQL plugin
8 Oracle plugin
9 PostgreSQL plugin
10 Redis plugin
11 Smart plugin
8 Zabbix Java gateway
9 Zabbix web service
10 Inclusion
1 Server-proxy data exchange protocol
2 Zabbix agent protocol
3 Zabbix agent 2 protocol
4 Zabbix sender protocol
5 Header
6 Real-time export protocol
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
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
1 Supported macros
2 User macros supported by location
8 Unit symbols
9 Time period syntax
10 Command execution
13 Version compatibility
14 Database error handling
15 Zabbix sender dynamic link library for Windows
17 Service monitoring upgrade
18 Other issues
19 Agent vs agent 2 comparison
zabbix_agent2
zabbix_agentd
zabbix_get
zabbix_js
zabbix_proxy
zabbix_sender
zabbix_server
zabbix_web_service
Zabbix Summit 2022
Register for Zabbix Summit 2022

Table of Contents

User macro

Host macro is deprecated and will be removed in upcoming versions.

This class is designed to work with host and global macros.

Object references:

Available methods:

© 2001-2022 by Zabbix SIA. All rights reserved.
Except where otherwise noted, Zabbix Documentation is licensed under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International
Trademark Policy