��Ĳ�

Documentation

��Ĳ� Manual

1 Manual structure

2 What is ��Ĳ�

3 ��Ĳ� features

4 ��Ĳ� overview

5 What's new in ��Ĳ� 7.4.0

3 ��Ĳ� processes

1 Server

1 High availability

2 Agent

3 Agent 2

4 Proxy

1 Setup from sources

2 Setup from RHEL packages

3 Setup from Debian/Ubuntu packages

6 Sender

7 Get

8 JS

1 Getting ��Ĳ�

1 PostgreSQL plugin dependencies

2 MongoDB plugin dependencies

3 Installation from sources

1 Building ��Ĳ� agent on Windows

2 Building ��Ĳ� agent 2 on Windows

3 Building ��Ĳ� agent on macOS

4 Installation from packages

1 Red Hat Enterprise Linux and derivatives

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

7 Upgrade procedure

1 Upgrade from sources

2 Upgrade from packages

1 Red Hat Enterprise Linux

2 Debian/Ubuntu

3 Upgrade from containers

1 Compilation issues

2 Escaping-related upgrade issues

9 Template changes

10 Upgrade notes for 7.4.0

1 Login and configuring user

2 New host

3 New item

5 Receiving problem notification

6 ��Ĳ� appliance

7 Configuration

1 Hosts and host groups

1 Configuring a host

2 Configuring a host group

3 Inventory

4 Mass update

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

3 Item types

1 ��Ĳ� agent

1 ��Ĳ� agent 2

2 Windows ��Ĳ� agent

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

15 Dependent items

16 HTTP agent

17 Prometheus checks

18 Script items

19 Browser items

4 History and trends

5 User parameters

1 Extending ��Ĳ� agents

6 Windows performance counters

7 Mass update

8 Value mapping

9 Queue

10 Value cache

11 Execute now

12 Restricting agent checks

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

8 Templates and template groups

1 Configuring a template

2 Configuring a template group

3 Linking/unlinking

4 Nesting

5 Mass update

9 Templates out of the box

1 ��Ĳ� agent template operation

2 ��Ĳ� 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 Media types

1 Email

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 Secret user macros

5 Low-level discovery macros

6 Expression macros

12 Users and user groups

1 Configuring a user

2 Permissions

3 User groups

13 Storage of secrets

1 CyberArk configuration

2 HashiCorp configuration

14 Scheduled reports

1 Export to files

2 Streaming to external systems

3 SNMP gateway

8 Service monitoring

2 SLA

3 Setup example

9 Web monitoring

1 Web monitoring items

2 Real-life scenario

10 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

12 Regular expressions

13 Problem acknowledgment

1 Problem suppression

14 Configuration export/import

1 Template groups

3 Templates

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 Notes on low-level discovery

6 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 ��Ĳ�

7 Custom LLD rules

16 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

3 PSK problems

18 Web interface

1 Menu

1 Event menu

2 Host menu

3 Item menu

2 Frontend sections

1 Dashboards

1 Dashboard widgets

1 Action log

2 Clock

3 Discovery status

4 Favorite graphs

5 Favorite maps

6 Gauge

7 Geomap

8 Graph

9 Graph (classic)

10 Graph prototype

11 Honeycomb

12 Host availability

13 Host card

14 Host navigator

15 Item history

16 Item navigator

17 Item value

18 Map

19 Map navigation tree

20 Pie chart

21 Problem hosts

22 Problems

23 Problems by severity

24 SLA report

25 System information

26 Top hosts

27 Top items

28 Top triggers

29 Trigger overview

30 URL

31 Web monitoring

2 Monitoring

1 Problems

1 Cause and symptom problems

2 Hosts

1 Graphs

2 Host dashboards

3 Web scenarios

3 Latest data

4 Maps

5 Discovery

3 Services

1 Services

2 SLA

3 SLA report

4 Inventory

1 Overview

2 Hosts

5 Reports

1 System information

2 Scheduled reports

3 Availability report

4 Top 100 triggers

5 Audit log

6 Action log

7 Notifications

6 Data collection

1 Template groups

2 Host groups

3 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

4 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

5 Maintenance

6 Event correlation

7 Discovery

7 Alerts

1 Actions

2 Media types

3 Scripts

8 Users

1 User groups

2 User roles

3 Users

4 API tokens

5 Authentication

1 HTTP

2 LDAP

3 SAML

4 MFA

9 Administration

1 General

2 Audit log

3 Housekeeping

4 Proxies

5 Proxy groups

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

12 Resetting password

13 Time period selector

19 Best practices

1 Security best practices

1 Access control

1 Securing MySQL/MariaDB

2 Securing PostgreSQL/TimescaleDB

2 Cryptography

3 Web server

2 Configuration best practices

20 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

Connector

Connector object

connector.create

connector.delete

connector.get

connector.update

Correlation

Correlation object

correlation.create

correlation.delete

correlation.get

correlation.update

Dashboard

Dashboard object

dashboard.create

dashboard.delete

dashboard.get

dashboard.update

Dashboard widget fields

1 Action log

2 Clock

3 Discovery status

4 Favorite graphs

5 Favorite maps

6 Gauge

7 Geomap

8 Graph

9 Graph (classic)

10 Graph prototype

11 Honeycomb

12 Host availability

13 Host card

14 Host navigator

15 Item history

16 Item navigator

17 Item value

18 Map

19 Map navigation tree

20 Pie chart

21 Problem hosts

22 Problems

23 Problems by severity

24 SLA report

25 System information

26 Top hosts

27 Top items

28 Top triggers

29 Trigger overview

30 URL

31 Web monitoring

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

history.push

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

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

MFA

MFA object

mfa.create

mfa.delete

mfa.get

mfa.update

Module

Module object

module.create

module.delete

module.get

module.update

Problem

Problem object

problem.get

Proxy

Proxy object

proxy.create

proxy.delete

proxy.get

proxy.update

Proxy group

Proxy group object

proxygroup.create

proxygroup.delete

proxygroup.get

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

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

Template group

Template group object

templategroup.create

templategroup.delete

templategroup.get

templategroup.massadd

templategroup.massremove

templategroup.massupdate

templategroup.propagate

templategroup.update

Token

Token object

token.create

token.delete

token.generate

token.get

token.update

Trend

Trend object

trend.get

Trigger

Trigger object

trigger.create

trigger.delete

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

user.resettotp

user.unblock

user.update

User directory

User directory object

userdirectory.create

userdirectory.delete

userdirectory.get

userdirectory.test

userdirectory.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 7.2 to 7.4

1 Loadable modules

2 Plugins

1 Building loadable plugins

3 Frontend modules

1 Installation and setup

1 Database creation

2 Repairing ��Ĳ� 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 TimescaleDB setup

7 Elasticsearch setup

8 Distribution-specific notes on setting up Nginx for ��Ĳ�

9 Running agent as root

10 ��Ĳ� agent on Microsoft Windows

11 SAML setup with Microsoft Entra ID

12 SAML setup with Okta

13 SAML setup with OneLogin

14 Setting up scheduled reports

15 Additional frontend languages

2 Process configuration

1 ��Ĳ� server

2 ��Ĳ� proxy

3 ��Ĳ� agent (UNIX)

4 ��Ĳ� agent 2 (UNIX)

5 ��Ĳ� agent (Windows)

6 ��Ĳ� agent 2 (Windows)

7 ��Ĳ� 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 NVIDIA GPU plugin

11 Oracle plugin

12 PostgreSQL plugin

13 Redis plugin

14 SMART plugin

8 ��Ĳ� Java gateway

9 ��Ĳ� web service

10 Environment variables

11 Inclusion

3 Protocols

1 Server-proxy data exchange protocol

2 ��Ĳ� agent/agent2 protocol

4 ��Ĳ� agent 2 plugin protocol

5 ��Ĳ� 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 ��Ĳ� stats

13 Configuring Kerberos with ��Ĳ�

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

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

9 String 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 ��Ĳ� sender dynamic link library for Windows

13 Python library for ��Ĳ� API

14 Service monitoring upgrade

15 Other issues

16 Agent vs agent 2 comparison

17 Escaping examples

23 Quick reference guides

1 Monitor Linux with ��Ĳ� agent

2 Monitor Windows with ��Ĳ� agent

3 Monitor Apache via HTTP

4 Monitor MySQL with ��Ĳ� agent 2

5 Monitor VMware with ��Ĳ�

6 Monitor network traffic with ��Ĳ�

7 Monitor network traffic using active checks

8 Monitor websites with Browser items

9 Monitor website certificates with ��Ĳ� agent 2 (passive)

10 Monitor a network switch or router with ��Ĳ�

Developer Center

Modules

Module file structure

manifest.json

Actions

Views

Assets

Register a new module

Widgets

Configuration

Presentation

Tutorials

Create a module (tutorial)

Create a widget (tutorial)

Examples

Plugins

Examples

Create a plugin (tutorial)

Plugin interfaces

Changes to extension development

��Ĳ� manpages

zabbix_web_service

Table of Contents

Media type

Media type

This class is designed to work with media types.

Object references:

Available methods:

mediatype.create - create new media types
mediatype.delete - delete media types
mediatype.get - retrieve media types
mediatype.update - update media types