Docs

1 Installation and first steps

1 Web interface installation

2 Quickstart guides

Apache web server monitoring

Basic configuration

1 Login and configuring user

2 New host

3 New item

5 Receiving problem notification

Linux server monitoring

MySQL server monitoring

3 Installation: additional guides

Building Zabbix agent 2 on Windows

Building Zabbix agent on Windows

Building Zabbix agent on macOS

Installation from containers

Installation from sources

Notes on installation from packages

Windows agent installation from MSI

macOS agent installation from PKG

Upgrade from containers

Upgrade from packages

Red Hat Enterprise Linux

Upgrade from sources

5 Upgrade notes for Zabbix 8.0

Template changes

Upgrade notes for Zabbix 8.0.x

2 What's new in Zabbix 8.0

What's new in Zabbix 8.0.x

3 Zabbix appliance

4 Zabbix processes

1 Server

1 High availability

2 Agent

3 Agent 2

4 Proxy

2 Setup from RHEL packages

3 Setup from Debian/Ubuntu packages

Setup from sources

6 Sender

7 Get

8 JS

5 Configuration

1 Hosts and host groups

2 Configuring a host

3 Configuring a host group

2 Items

1 Creating an item

1 Item key format

2 Custom intervals

2 Item value preprocessing

1 Preprocessing testing

2 Preprocessing details

3 Preprocessing examples

4 JSONPath functionality

1 Escaping special characters from LLD macro values in JSONPath

5 JavaScript preprocessing

1 Additional JavaScript objects

2 Browser item JavaScript objects

6 CSV to JSON preprocessing

1 Zabbix agent 2

2 Windows Zabbix agent

1 Dynamic indexes

5 Simple checks

1 VMware monitoring item keys

6 Log file monitoring

7 Calculated items

1 Aggregate calculations

8 Internal checks

10 Telnet checks

11 External checks

12 Trapper items

13 JMX monitoring

14 ODBC monitoring

15 Dependent items

17 Prometheus checks

18 Script items

19 Browser items

4 History and trends

5 User parameters

1 Extending Zabbix agents

6 Windows performance counters

8 Value mapping

9 Queue

12 Restricting agent checks

3 Problem detection with triggers

1 Trigger examples

2 Configuring a trigger

3 Trigger expression

1 Aggregate functions

Foreach functions

2 Bitwise functions

3 Date and time functions

4 History functions

5 Trend functions

6 Mathematical functions

7 Operator functions

8 Predictive functions

Predictive trigger functions

9 String functions

4 Best practices for triggers

Trigger dependencies

Trigger severity

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

1 Configuring a network map

2 Host group elements

3 Link indicators

8 Templates and template groups

1 Configuring a template

2 Configuring a template group

3 Linking/unlinking

4 Nesting

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

8 VMware template operation

10 Notifications upon events

1 Email

1 Automated Gmail/Office365 media types

2 SMS

3 Custom alert scripts

4 Webhook

1 Webhook script examples

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

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

1 CyberArk configuration

2 HashiCorp configuration

14 Scheduled reports

1 Export to files

2 Streaming to external systems

6 Service monitoring

2 SLA

3 Setup example

7 Web monitoring

1 Web monitoring items

2 Real-life scenario

8 Virtual machine monitoring

1 VMware monitoring item keys

2 Virtual machine discovery key fields

3 JSON examples for VMware items

4 VMware monitoring setup example

10 Regular expressions

11 Problem acknowledgment

1 Problem suppression

12 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

5 Discovery prototypes

6 Notes on low-level discovery

7 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 SNMP OIDs (legacy)

6 Discovery of JMX objects

7 Discovery of IPMI sensors

8 Discovery of systemd services

9 Discovery of Windows services

10 Discovery of Windows performance counter instances

11 Discovery using WMI queries

12 Discovery using ODBC SQL queries

13 Discovery using Prometheus data

14 Discovery of block devices

15 Discovery of host interfaces in Zabbix

8 Custom LLD rules

14 Distributed monitoring

1 Proxies

1 Synchronization of monitoring configuration

2 Proxy load balancing and high availability

1 Using certificates

2 Using pre-shared keys

3 Troubleshooting

1 Connection type or permission problems

2 Certificate problems

16 Web interface

1 Menu

2 Frontend sections

1 Dashboard widgets

2 Dashboard widget parameters

2 Clock

3 Discovery status

4 Favorite graphs

5 Favorite maps

6 Gauge

7 Geomap

8 Graph

9 Graph (classic)

10 Graph prototype

12 Host availability

14 Host navigator

16 Item history

17 Item navigator

19 Map

20 Map navigation tree

22 Problem hosts

24 Problems by severity

25 Scatter plot

27 System information

30 Top triggers

31 Trigger overview

32 URL

33 Web monitoring

1 Problems

1 Cause and symptom problems

2 Hosts

1 Graphs

2 Host dashboards

3 Web scenarios

4 Maps

3 Services

1 Services

2 SLA

1 Overview

2 Hosts

5 Reports

1 System information

2 Scheduled reports

3 Availability report

4 Top 100 triggers

7 Notifications

6 Data collection

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

5 Web scenarios

6 Event correlation

7 Alerts

1 Actions

3 Scripts

8 Users

3 Users

5 Authentication

1 HTTP

2 LDAP

3 SAML

4 MFA

9 Administration

1 General

4 Proxies

6 Macros

7 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

12 Resetting password

13 Time period and host selectors

17 Best practices

1 Security best practices

1 Access control

1 Securing MySQL/MariaDB

2 Securing PostgreSQL/TimescaleDB

2 Configuration best practices

18 API

Appendix 1. Reference commentary

Appendix 2. Changes from 7.4 to 8.0

Appendix 3. Changes in 8.0

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

Connector

Connector object

connector.create

connector.delete

connector.update

Correlation object

correlation.create

correlation.delete

correlation.get

correlation.update

Dashboard

Dashboard object

dashboard.create

dashboard.delete

dashboard.update

Dashboard widget fields

2 Clock

3 Discovery status

4 Favorite graphs

5 Favorite maps

6 Gauge

7 Geomap

8 Graph

9 Graph (classic)

10 Graph prototype

12 Host availability

14 Host navigator

16 Item history

17 Item navigator

19 Map

20 Map navigation tree

22 Problem hosts

24 Problems by severity

25 Scatter plot

27 System information

30 Top triggers

31 Trigger overview

32 URL

33 Web monitoring

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 group

Host group object

hostgroup.create

hostgroup.delete

hostgroup.massadd

hostgroup.massremove

hostgroup.propagate

hostgroup.update

Host interface object

hostinterface.create

hostinterface.delete

hostinterface.get

hostinterface.massadd

hostinterface.massremove

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

discoveryrule.delete

discoveryrule.get

discoveryrule.update

LLD rule prototype

LLD rule prototype object

discoveryruleprototype.create

discoveryruleprototype.delete

discoveryruleprototype.get

discoveryruleprototype.update

MFA

MFA object

mfa.create

mfa.delete

mfa.get

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

Module

module.get

Problem

Proxy

proxy.get

Proxy group object

proxygroup.create

proxygroup.delete

proxygroup.update

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

script.getscriptsbyhosts

Service

Settings

Settings object

settings.update

Task

task.get

Template

Template object

template.create

template.delete

template.massadd

template.massremove

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

1 Loadable modules

2 Plugins

3 Frontend modules

1 Installation and setup

1 Database creation

2 Repairing Zabbix database character set and collation

3 Database upgrade to primary keys

4 Preparing auditlog table for partitioning

5 Secure connection to the database

1 MySQL encryption configuration

2 PostgreSQL encryption configuration

6 Secure connection to the frontend

7 TimescaleDB setup

8 Elasticsearch setup

9 Distribution-specific notes on setting up Nginx for Zabbix

10 Running agent as root

11 Zabbix agent on Microsoft Windows

12 SAML setup with Microsoft Entra ID

13 SAML setup with Okta

14 SAML setup with OneLogin

15 Setting up scheduled reports

16 Additional frontend languages

2 Process configuration

1 Zabbix server

3 Zabbix agent (UNIX)

4 Zabbix agent 2 (UNIX)

5 Zabbix agent (Windows)

6 Zabbix agent 2 (Windows)

7 Zabbix agent 2 plugins

2 Docker plugin

3 Ember+ plugin

4 Memcached plugin

5 Modbus plugin

6 MongoDB plugin

10 NVIDIA GPU plugin

11 Oracle plugin

12 PostgreSQL plugin

13 Redis plugin

14 SMART plugin

8 Zabbix Java gateway

9 Zabbix web service

10 Environment variables

1 Server-proxy data exchange protocol

2 Zabbix agent/agent2 protocol

4 Zabbix agent 2 plugin protocol

5 Zabbix sender protocol

6 Header

7 Newline-delimited JSON export protocol

4 Items

1 vm.memory.size parameters

2 Passive and active agent checks

3 Minimum permission level for Windows agent items

4 Encoding of returned values

5 Large file support

6 Sensor

7 Notes on memtype parameter in proc.mem items

8 Notes on selecting processes in proc.mem and proc.num items

9 Implementation details of net.tcp.service and net.udp.service checks

10 proc.get parameters

11 Unreachable/unavailable host interface settings

12 Remote monitoring of Zabbix stats

13 Configuring Kerberos with Zabbix

14 modbus.get parameters

15 Creating custom performance counter names for VMware

16 Return values for system.sw.packages.get

17 Return values for net.dns.get

18 Notes on system.cpu.util items on Windows

19 Large JSON value support

5 Supported functions

6 Macros

1 Macros supported by location

2 User macros supported by location

8 Time period syntax

9 Command execution

10 Version compatibility

12 Zabbix sender dynamic link library for Windows

13 Service monitoring upgrade

14 Other issues

15 Agent vs agent 2 comparison

16 Escaping examples

21 Quick reference guides

1 Monitor Linux with Zabbix agent

2 Monitor Windows with Zabbix agent

3 Monitor Apache via HTTP

4 Monitor MySQL with Zabbix agent 2

5 Monitor VMware with Zabbix

6 Monitor network traffic with Zabbix

7 Monitor network traffic using active checks

8 Monitor websites with Browser items

9 Monitor website certificates with Zabbix agent 2 (passive)

10 Monitor a network switch or router with Zabbix

11 Monitor Windows event log using active checks

1 Deploy Zabbix in the cloud

2 Node configuration

4 Key differences of Zabbix Cloud

Developer center

Modules

Module file structure

Actions

Views

Assets

Register a new module

Widgets

Tutorials

Create a module (tutorial)

Create a widget (tutorial)

Examples

Plugins

Examples

Create a plugin (tutorial)

Plugin interfaces

Python library for Zabbix

Quickstart guide

Collect data from Zabbix agent

Send data to Zabbix server or proxy

Changes to extension development

Zabbix manpages

zabbix_get

zabbix_js

zabbix_web_service

Copyright notice

User manual
18 API
Method reference
Template dashboard

On this page

Template dashboard

Template dashboard

This class is designed to work with template dashboards.

Object references:

Available methods:

templatedashboard.create - create new template dashboards
templatedashboard.delete - delete template dashboards
templatedashboard.get - retrieve template dashboards
templatedashboard.update - update template dashboards

What’s next?

Template dashboard object