Documentation

1. Introduction

1 Manual structure

2 What is Zabbix

3 Zabbix features

4 Zabbix overview

5 What's new in Zabbix 3.0.0

6 What's new in Zabbix 3.0.1

7 What's new in Zabbix 3.0.2

8 What's new in Zabbix 3.0.3

9 What's new in Zabbix 3.0.4

10 What's new in Zabbix 3.0.5

11 What's new in Zabbix 3.0.6

12 What's new in Zabbix 3.0.7

13 What's new in Zabbix 3.0.8

14 What's new in Zabbix 3.0.9

15 What's new in Zabbix 3.0.10

16 What's new in Zabbix 3.0.11

17 What's new in Zabbix 3.0.12

18 What's new in Zabbix 3.0.13

19 What's new in Zabbix 3.0.14

20 What's new in Zabbix 3.0.15

21 What's new in Zabbix 3.0.16

22 What's new in Zabbix 3.0.17

23 What's new in Zabbix 3.0.18

24 What's new in Zabbix 3.0.19

25 What's new in Zabbix 3.0.20

26 What's new in Zabbix 3.0.21

27 What's new in Zabbix 3.0.22

28 What's new in Zabbix 3.0.23

29 What's new in Zabbix 3.0.24

30 What's new in Zabbix 3.0.25

31 What's new in Zabbix 3.0.26

32 What's new in Zabbix 3.0.27

33 What's new in Zabbix 3.0.28

34 What's new in Zabbix 3.0.29

35 What's new in Zabbix 3.0.30

36 What's new in Zabbix 3.0.31

37 What's new in Zabbix 3.0.32

2. Zabbix concepts

1 Zabbix definitions

2 Server

3 Agent

4 Proxy

6 Sender

7 Get

3. Installation

1 Getting Zabbix

Best practices for secure Zabbix setup

3 Installation from sources

Building Windows agent binaries with/without TLS

4 Installation from packages

1 Repository installation

2 Server installation with MySQL database

3 Server installation with PostgreSQL database

4 Agent installation

5 Proxy installation

1 Red Hat Enterprise Linux/CentOS

2 Debian/Ubuntu

5 Installation from containers

6 Upgrade procedure using sources

7 Upgrade procedure using packages

1 Red Hat Enterprise Linux/CentOS

2 Debian/Ubuntu

9 Template changes

10 Upgrade notes for 3.0.0

11 Upgrade notes for 3.0.1

12 Upgrade notes for 3.0.2

13 Upgrade notes for 3.0.3

14 Upgrade notes for 3.0.4

15 Upgrade notes for 3.0.5

16 Upgrade notes for 3.0.6

17 Upgrade notes for 3.0.7

18 Upgrade notes for 3.0.8

19 Upgrade notes for 3.0.9

20 Upgrade notes for 3.0.10

21 Upgrade notes for 3.0.11

22 Upgrade notes for 3.0.12

23 Upgrade notes for 3.0.13

24 Upgrade notes for 3.0.14

25 Upgrade notes for 3.0.15

26 Upgrade notes for 3.0.16

27 Upgrade notes for 3.0.17

28 Upgrade notes for 3.0.18

29 Upgrade notes for 3.0.19

30 Upgrade notes for 3.0.20

31 Upgrade notes for 3.0.21

32 Upgrade notes for 3.0.22

33 Upgrade notes for 3.0.23

34 Upgrade notes for 3.0.24

35 Upgrade notes for 3.0.25

36 Upgrade notes for 3.0.26

37 Upgrade notes for 3.0.27

38 Upgrade notes for 3.0.28

40 Upgrade notes for 3.0.30

41 Upgrade notes for 3.0.31

42 Upgrade notes for 3.0.32

1 Login and configuring user

2 New host

3 New item

5 Receiving problem notification

5. Zabbix appliance

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

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

3 Triggers

1 Configuring a trigger

2 Trigger expression

3 Trigger dependencies

4 Trigger severity

5 Customising trigger severities

6 Unit symbols

7 Mass update

8 Predictive trigger functions

4 Events

1 Event sources

5 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

6 Templates

1 Configuring a template

2 Linking/unlinking

3 Nesting

7 Notifications upon events

1 Media types

1 E-mail

2 SMS

3 Jabber

4 Ez Texting

5 Custom alertscripts

2 Actions

1 Operations

1 Sending message

2 Remote commands

3 Additional operations

4 Using macros in messages

2 Conditions

3 Escalations

3 Receiving notification on unsupported items

8 Macros

User macros

9 Users and user groups

1 Configuring a user

2 Permissions

3 User groups

8. Web monitoring

1 Web monitoring items

2 Real life scenario

9. Virtual machine monitoring

Virtual machine discovery key fields

10. Maintenance

11. Regular expressions

12. Event acknowledgement

13. Configuration export/import

Groups

Hosts

1 Network discovery

Configuring a network discovery rule

2 Active agent auto-registration

3 Low-level discovery

Notes on low-level discovery

15. Distributed monitoring

1 Proxies

1 Using certificates

2 Using pre-shared keys

3 Troubleshooting

1 Connection type or permission problems

2 Certificate problems

3 PSK problems

17. Web interface

1 Frontend sections

1 Monitoring

1 Dashboard

2 Overview

3 Web

4 Latest data

5 Triggers

6 Events

7 Graphs

8 Screens

9 Maps

10 Discovery

11 IT services

2 Inventory

1 Overview

2 Hosts

3 Reports

1 Status of Zabbix

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 Discovery

7 IT services

5 Administration

1 General

2 Proxies

3 Authentication

4 User groups

5 Users

6 Media types

7 Scripts

8 Queue

1 Global notifications

2 Sound in browsers

3 Global search

4 Frontend maintenance mode

5 Page parameters

7 Creating your own theme

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

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

drule.iswritable

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

host.iswritable

host.massadd

host.massremove

host.massupdate

host.update

Host group

> Host group object

hostgroup.create

hostgroup.delete

hostgroup.get

hostgroup.isreadable

hostgroup.iswritable

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

hostprototype.iswritable

hostprototype.update

Icon map

> Icon map object

iconmap.create

iconmap.delete

iconmap.get

iconmap.isreadable

iconmap.iswritable

iconmap.update

Image

> Image object

image.create

image.delete

image.get

image.update

Item

> Item object

item.create

item.delete

item.get

item.isreadable

item.iswritable

item.update

Item prototype

> Item prototype object

itemprototype.create

itemprototype.delete

itemprototype.get

itemprototype.isreadable

itemprototype.iswritable

itemprototype.update

IT service

> IT Service object

service.adddependencies

service.addtimes

service.create

service.delete

service.deletedependencies

service.deletetimes

service.get

service.getsla

service.isreadable

service.iswritable

service.update

LLD rule

> LLD rule object

discoveryrule.copy

discoveryrule.create

discoveryrule.delete

discoveryrule.get

discoveryrule.isreadable

discoveryrule.iswritable

discoveryrule.update

Maintenance

> Maintenance object

maintenance.create

maintenance.delete

maintenance.get

maintenance.update

Map

> Map object

map.create

map.delete

map.get

map.isreadable

map.iswritable

map.update

Media

> Media object

usermedia.get

Media type

> Media type object

mediatype.create

mediatype.delete

mediatype.get

mediatype.update

Proxy

> Proxy object

proxy.create

proxy.delete

proxy.get

proxy.isreadable

proxy.iswritable

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

screenitem.iswritable

screenitem.update

screenitem.updatebyposition

Script

> Script object

script.create

script.delete

script.execute

script.get

script.getscriptsbyhosts

script.update

Template

> Template object

template.create

template.delete

template.get

template.isreadable

template.iswritable

template.massadd

template.massremove

template.massupdate

template.update

Template screen

> Template screen object

templatescreen.copy

templatescreen.create

templatescreen.delete

templatescreen.get

templatescreen.isreadable

templatescreen.iswritable

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

trigger.iswritable

trigger.update

Trigger prototype

> Trigger prototype object

triggerprototype.create

triggerprototype.delete

triggerprototype.get

triggerprototype.update

User

> User object

user.addmedia

user.checkAuthentication

user.create

user.delete

user.deletemedia

user.get

user.isreadable

user.iswritable

user.login

user.logout

user.update

user.updatemedia

user.updateprofile

User group

> User group object

usergroup.create

usergroup.delete

usergroup.get

usergroup.isreadable

usergroup.iswritable

usergroup.massadd

usergroup.massupdate

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

httptest.iswritable

httptest.update

Appendix 1. Reference commentary

Appendix 2. Changes from 2.4 to 3.0

Zabbix API changes in 3.0

1 Frequently asked questions / Troubleshooting

1 Database creation scripts

2 Zabbix agent on Microsoft Windows

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 Zabbix sender protocol

2 Zabbix agent protocol

3 Header and data length

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 Unreachable/unavailable host settings

6 Triggers

1 Supported trigger functions

7 Macros

1 Supported macros

8 Setting time periods

9 Command execution

10 Recipes for monitoring

11 Performance tuning

12 Version compatibility

13 Database error handling

14 Zabbix sender dynamic link library for Windows

15 Other issues

Zabbix manpages

Table of Contents

LLD rule

LLD rule

This class is designed to work with low level discovery rules.

Object references:

LLD rule

Available methods:

discoveryrule.copy - copying LLD rules
discoveryrule.create - creating new LLD rules
discoveryrule.delete - deleting LLD rules
discoveryrule.get - retrieving LLD rules
discoveryrule.isreadable - checking if LLD rules are readable
discoveryrule.iswritable - checking if LLD rules are writable
discoveryrule.update - updating LLD rules