1 Item keys specific to agent 2

Zabbix agent 2 supports all item keys supported for Zabbix agent on Unix and Windows. This page provides details on the additional item keys, which you can use with Zabbix agent 2 only, grouped by the plugin they belong to.

See also: Built-in plugins

Parameters without angle brackets are mandatory. Parameters marked with angle brackets < > are optional.

Ceph

Key
Description Return value Parameters Comments
ceph.df.details[connString,<user>,<apikey>]
Cluster’s data usage and distribution among pools. JSON object connString - URI or session name.
user, password - Ceph login credentials.
ceph.osd.stats[connString,<user>,<apikey>]
Aggregated and per OSD statistics. JSON object connString - URI or session name.
user, password - Ceph login credentials.
ceph.osd.discovery[connString,<user>,<apikey>]
List of discovered OSDs. Used for low-level discovery. JSON object connString - URI or session name.
user, password - Ceph login credentials.
ceph.osd.dump[connString,<user>,<apikey>]
Usage thresholds and statuses of OSDs. JSON object connString - URI or session name.
user, password - Ceph login credentials.
ceph.ping[connString,<user>,<apikey>]
Tests whether a connection to Ceph can be established. 0 - connection is broken (if there is any error presented including AUTH and configuration issues)

1 - connection is successful.
connString - URI or session name.
user, password - Ceph login credentials.
ceph.pool.discovery[connString,<user>,<apikey>]
List of discovered pools. Used for low-level discovery. JSON object connString - URI or session name.
user, password - Ceph login credentials.
ceph.status[connString,<user>,<apikey>]
Overall cluster's status. JSON object connString - URI or session name.
user, password - Ceph login credentials.

Docker

Key
Description Return value Parameters Comments
docker.container_info[<ID>,<info>]
Low-level information about a container. An output of the ContainerInspect API call serialized as JSON ID - ID or name of the container.
info - the amount of information returned. Supported values: short (default) or full.
The Agent2 user ('zabbix') must be added to the 'docker' group for sufficient privileges. Otherwise the check will fail.
docker.container_stats[<ID>]
Container resource usage statistics. An output of the ContainerStats API call and CPU usage percentage serialized as JSON ID - ID or name of the container. The Agent2 user ('zabbix') must be added to the 'docker' group for sufficient privileges. Otherwise the check will fail.
docker.containers
A list of containers. An output of the ContainerList API call serialized as JSON - The Agent2 user ('zabbix') must be added to the 'docker' group for sufficient privileges. Otherwise the check will fail.
docker.containers.discovery[<options>]
A list of containers. Used for low-level discovery. JSON object options - specifies whether all or only running containers should be discovered. Supported values:
true - return all containers;
false - return only running containers (default).
The Agent2 user ('zabbix') must be added to the 'docker' group for sufficient privileges. Otherwise the check will fail.
docker.data_usage
Information about current data usage. An output of the SystemDataUsage API call serialized as JSON - The Agent2 user ('zabbix') must be added to the 'docker' group for sufficient privileges. Otherwise the check will fail.
docker.images
A list of images. An output of the ImageList API call serialized as JSON - The Agent2 user ('zabbix') must be added to the 'docker' group for sufficient privileges. Otherwise the check will fail.
docker.images.discovery
A list of images. Used for low-level discovery. JSON object - The Agent2 user ('zabbix') must be added to the 'docker' group for sufficient privileges. Otherwise the check will fail.
docker.info
System information. An output of the SystemInfo API call serialized as JSON - The Agent2 user ('zabbix') must be added to the 'docker' group for sufficient privileges. Otherwise the check will fail.
docker.ping
Test if a Docker daemon is alive or not. 1 - connection is alive

0 - connection is broken
- The Agent2 user ('zabbix') must be added to the 'docker' group for sufficient privileges. Otherwise the check will fail.

Memcached

Key
Description Return value Parameters Comments
memcached.ping[connString,<user>,<password>]
Test if a connection is alive or not. 1 - connection is alive

0 - connection is broken (if there is any error presented including AUTH and configuration issues)
connString - URI or session name.
memcached.stats[connString,<user>,<password>,<type>]
Gets the output of the STATS command. JSON - output is serialized as JSON connString - URI or session name.
user, password - Memcached login credentials.
type - stat type to be returned: items, sizes, slabs or settings (empty by default, returns general statistics).

MongoDB

Key
Description Return value Parameters Comments
mongodb.collection.stats[connString,<user>,<password>,<database>,collection]
Returns a variety of storage statistics for a given collection. JSON object connString - URI or session name.
user, password - MongoDB login credentials.
database - database name (default: admin).
collection — collection name.
mongodb.collections.discovery[connString,<user>,<password>]
Returns a list of discovered collections. Used for low-level discovery. JSON object connString - URI or session name.
user, password - MongoDB login credentials.
mongodb.collections.usage[connString,<user>,<password>]
Returns usage statistics for collections. JSON object connString - URI or session name.
user, password - MongoDB login credentials.
mongodb.connpool.stats[connString,<user>,<password>]
Returns information regarding the open outgoing connections from the current database instance to other members of the sharded cluster or replica set. JSON object connString - URI or session name.
user, password - MongoDB login credentials.
mongodb.db.stats[connString,<user>,<password>,<database>]
Returns statistics reflecting a given database system state. JSON object connString - URI or session name.
user, password - MongoDB login credentials.
database - database name (default: admin).
mongodb.db.discovery[connString,<user>,<password>]
Returns a list of discovered databases. Used for low-level discovery. JSON object connString - URI or session name.
user, password - MongoDB login credentials.
mongodb.jumbo_chunks.count[connString,<user>,<password>]
Returns count of jumbo chunks. JSON object connString - URI or session name.
user, password - MongoDB login credentials.
mongodb.oplog.stats[connString,<user>,<password>]
Returns a status of the replica set, using data polled from the oplog. JSON object connString - URI or session name.
user, password - MongoDB login credentials.
mongodb.ping[connString,<user>,<password>]
Tests if a connection is alive or not. 1 - connection is alive

0 - connection is broken (if there is any error presented including AUTH and configuration issues).
connString - URI or session name.
user, password - MongoDB login credentials.
mongodb.rs.config[connString,<user>,<password>]
Returns a current configuration of the replica set. JSON object connString - URI or session name.
user, password - MongoDB login credentials.
mongodb.rs.status[connString,<user>,<password>]
Returns a replica set status from the point of view of the member where the method is run. JSON object connString - URI or session name.
user, password - MongoDB login credentials.
mongodb.server.status[connString,<user>,<password>]
Returns database state. JSON object connString - URI or session name.
user, password - MongoDB login credentials.
mongodb.sh.discovery[connString,<user>,<password>]
Returns a list of discovered shards present in the cluster. JSON object connString - URI or session name.
user, password - MongoDB login credentials.
mongodb.version[connString,<user>,<password>]
Returns the database server version. String connString - URI or session name.
user, password - MongoDB login credentials.

MQTT

Key
Description Return value Parameters Comments
mqtt.get[<broker_url>,topic,<username>,<password>]
Subscribes to a specific topic or topics (with wildcards) of the provided broker and waits for publications. Depending on topic content.

If wildcards are used, returns topic content as JSON.
broker_url - MQTT broker URL (if empty, localhost with port 1883 is used).
topic - MQTT topic (mandatory). Wildcards (+,#) are supported.
username,password - authentication credentials (if required)
The item must be configured as an active check ('Zabbix agent (active)' item type).

TLS encryption certificates can be used by saving them into a default location (e.g. /etc/ssl/certs/ directory for Ubuntu). For TLS, use the tls:// scheme.

MSSQL

Key
Description Return value Parameters Comments
mssql.availability.group.get[URI,<user>,<password>]
Returns availability groups. JSON object URI - MSSQL server URI (the only supported schema is sqlserver://). Embedded credentials will be ignored;
user, password - username, password to send to protected MSSQL server.
Supported since Zabbix 6.0.27. For more information see the MSSQL plugin readme.
mssql.custom.query[URI,<user>,<password>,queryName,<args...>]
Returns the result of a custom query. JSON object URI - MSSQL server URI (the only supported schema is sqlserver://). Embedded credentials will be ignored;
user, password - username, password to send to protected MSSQL server;
queryName - name of a custom query configured in Plugins.MSSQL.CustomQueriesDir without the .sql extension;
args - one or several comma-separated arguments to pass to a query.
Supported since Zabbix 6.0.27. For more information see the MSSQL plugin readme.
mssql.db.get
Returns all available MSSQL databases. JSON object Supported since Zabbix 6.0.27. For more information see the MSSQL plugin readme.
mssql.job.status.get
Returns the status of jobs. JSON object Supported since Zabbix 6.0.27. For more information see the MSSQL plugin readme.
mssql.last.backup.get
Returns the last backup time for all databases. JSON object Supported since Zabbix 6.0.27. For more information see the MSSQL plugin readme.
mssql.local.db.get
Returns databases that are participating in an Always On availability group and replica (primary or secondary) and are located on the server that the connection was established to. JSON object Supported since Zabbix 6.0.27. For more information see the MSSQL plugin readme.
mssql.mirroring.get
Returns mirroring info. JSON object Supported since Zabbix 6.0.27. For more information see the MSSQL plugin readme.
mssql.nonlocal.db.get
Returns databases that are participating in an Always On availability group and replica (primary or secondary) located on other servers (the database is not local to the SQL Server instance that the connection was established to). JSON object Supported since Zabbix 6.0.27. For more information see the MSSQL plugin readme.
mssql.perfcounter.get
Returns the performance counters. JSON object Supported since Zabbix 6.0.27. For more information see the MSSQL plugin readme.
mssql.ping
Ping the database. Test if connection is correctly configured. 1 - alive,
0 - not alive
Supported since Zabbix 6.0.27. For more information see the MSSQL plugin readme.
mssql.quorum.get
Returns the quorum info. JSON object Supported since Zabbix 6.0.27. For more information see the MSSQL plugin readme.
mssql.quorum.members.get
Returns the quorum members. JSON object Supported since Zabbix 6.0.27. For more information see the MSSQL plugin readme.
mssql.replica.get
Returns the replicas. JSON object Supported since Zabbix 6.0.27. For more information see the MSSQL plugin readme.
mssql.version
Returns the MSSQL version. String Supported since Zabbix 6.0.27. For more information see the MSSQL plugin readme.

MySQL

Key
Description Return value Parameters Comments
mysql.custom.query[connString,<username>,<password>,queryName,<args...>]
Returns the result of a custom query. JSON object connString - URI or session name.
username, password - MySQL login credentials.
queryName - name of a custom query, must match SQL file name without an extension.
args - one or several comma-separated arguments to pass to a query.
Supported since Zabbix 6.0.21.
mysql.db.discovery[connString,<username>,<password>]
List of MySQL databases. Used for low-level discovery. Result of the "show databases" SQL query in LLD JSON format. connString - URI or session name.
username, password - MySQL login credentials.
mysql.db.size[connString,<username>,<password>,dbName]
Database size in bytes. Result of the "select coalesce(sum(data_length + index_length),0) as size from information_schema.tables where table_schema=?" SQL query for specific database in bytes. connString - URI or session name.
username, password - MySQL login credentials.
dbName - Database name.
mysql.get_status_variables[connString,<username>,<password>]
Values of global status variables. Result of the "show global status" SQL query in JSON format. connString - URI or session name.
username, password - MySQL login credentials.
mysql.ping[connString,<username>,<password>]
Test if a connection is alive or not. 1 - connection is alive

0 - connection is broken (if there is any error presented including AUTH and configuration issues).
connString - URI or session name.
username, password - MySQL login credentials.
mysql.replication.discovery[connString,<username>,<password>]
List of MySQL replications. Used for low-level discovery. Result of the "show slave status" SQL query in LLD JSON format. connString - URI or session name.
username, password - MySQL login credentials.
mysql.replication.get_slave_status[connString,<username>,<password>,<masterHost>]
Replication status. Result of the "show slave status" SQL query in JSON format. connString - URI or session name.
username, password - MySQL login credentials.
masterHost - Replication master host name. If none found, an error is returned. If this parameter is not specified, all hosts are returned.
Note that before Zabbix 6.0.23, the "masterHost" parameter is ignored and always the first master host is returned.
mysql.version[connString,<username>,<password>]
MySQL version. String with MySQL instance version. connString - URI or session name.
username, password - MySQL login credentials.

Oracle

Key
Description Return value Parameters Comments
oracle.diskgroups.stats[connString,<user>,<password>,<service>,<diskgroup>]
Automatic Storage Management (ASM) disk groups statistics. JSON object connString - URI or session name.
user, password - Oracle login credentials.
service - Oracle service name.
diskgroup - name of the ASM disk group to query.
user parameter allows to append one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (login option is case-insensitive; must not contain a trailing space).
oracle.diskgroups.discovery[connString,<user>,<password>,<service>]
List of ASM disk groups. Used for low-level discovery. JSON object connString - URI or session name.
user, password - Oracle login credentials.
service - Oracle service name.
user parameter allows to append one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (login option is case-insensitive; must not contain a trailing space).
oracle.archive.info[connString,<user>,<password>,<service>,<destination>]
Archive logs statistics. JSON object connString - URI or session name.
user, password - Oracle login credentials.
service - Oracle service name.
destination - name of the destination to query.
user parameter allows to append one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (login option is case-insensitive; must not contain a trailing space).
oracle.cdb.info[connString,<user>,<password>,<service>,<database>]
Container Databases (CDBs) information. JSON object connString - URI or session name.
user, password - Oracle login credentials.
service - Oracle service name.
database - name of the database to query.
user parameter allows to append one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (login option is case-insensitive; must not contain a trailing space).
oracle.custom.query[connString,<user>,<password>,<service>,queryName,<args...>]
Result of a custom query. JSON object connString - URI or session name.
user, password - Oracle login credentials.
service - Oracle service name.
queryName — name of a custom query, must match SQL file name without an extension.
args - one or several comma-separated arguments to pass to a query.
user parameter allows to append one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (login option is case-insensitive; must not contain a trailing space).
oracle.datafiles.stats[connString,<user>,<password>,<service>]
Data files statistics. JSON object connString - URI or session name.
user, password - Oracle login credentials.
service - Oracle service name.
user parameter allows to append one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (login option is case-insensitive; must not contain a trailing space).
oracle.db.discovery[connString,<user>,<password>,<service>]
List of databases. Used for low-level discovery. JSON object connString - URI or session name.
user, password - Oracle login credentials.
service - Oracle service name.
user parameter allows to append one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (login option is case-insensitive; must not contain a trailing space).
oracle.fra.stats[connString,<user>,<password>,<service>]
Fast Recovery Area (FRA) statistics. JSON object connString - URI or session name.
user, password - Oracle login credentials.
service - Oracle service name.
user parameter allows to append one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (login option is case-insensitive; must not contain a trailing space).
oracle.instance.info[connString,<user>,<password>,<service>]
Instance statistics. JSON object connString - URI or session name.
user, password - Oracle login credentials.
service - Oracle service name.
user parameter allows to append one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (login option is case-insensitive; must not contain a trailing space).
oracle.pdb.info[connString,<user>,<password>,<service>,<database>]
Pluggable Databases (PDBs) information. JSON object connString - URI or session name.
user, password - Oracle login credentials.
service - Oracle service name.
database - name of the database to query.
user parameter allows to append one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (login option is case-insensitive; must not contain a trailing space).
oracle.pdb.discovery[connString,<user>,<password>,<service>]
List of PDBs. Used for low-level discovery. JSON object connString - URI or session name.
user, password - Oracle login credentials.
service - Oracle service name.
user parameter allows to append one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (login option is case-insensitive; must not contain a trailing space).
oracle.pga.stats[connString,<user>,<password>,<service>]
Program Global Area (PGA) statistics. JSON object connString - URI or session name.
user, password - Oracle login credentials.
service - Oracle service name.
user parameter allows to append one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (login option is case-insensitive; must not contain a trailing space).
oracle.ping[connString,<user>,<password>,<service>]
Tests whether a connection to Oracle can be established. 0 - connection is broken (if there is any error presented including AUTH and configuration issues)
1 - connection is successful.
connString - URI or session name.
user, password - Oracle login credentials.
service - Oracle service name.
user parameter allows to append one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (login option is case-insensitive; must not contain a trailing space).
oracle.proc.stats[connString,<user>,<password>,<service>]
Processes statistics. JSON object connString - URI or session name.
user, password - Oracle login credentials.
service - Oracle service name.
user parameter allows to append one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (login option is case-insensitive; must not contain a trailing space).
oracle.redolog.info[connString,<user>,<password>,<service>]
Log file information from the control file. JSON object connString - URI or session name.
user, password - Oracle login credentials.
service - Oracle service name.
user parameter allows to append one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (login option is case-insensitive; must not contain a trailing space).
oracle.sga.stats[connString,<user>,<password>,<service>]
System Global Area (SGA) statistics. JSON object connString - URI or session name.
user, password - Oracle login credentials.
service - Oracle service name.
user parameter allows to append one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (login option is case-insensitive; must not contain a trailing space).
oracle.sessions.stats[connString,<user>,<password>,<service>,<lockMaxTime>]
Sessions statistics. JSON object connString - URI or session name.
user, password - Oracle login credentials.
service - Oracle service name.
lockMaxTime - maximum session lock duration in seconds to count the session as a prolongedly locked. Default: 600 seconds.
user parameter allows to append one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (login option is case-insensitive; must not contain a trailing space).
oracle.sys.metrics[connString,<user>,<password>,<service>,<duration>]
A set of system metric values. JSON object connString - URI or session name.
user, password - Oracle login credentials.
service - Oracle service name.
duration - capturing interval (in seconds) of system metric values. Possible values: 60 — long duration (default), 15 — short duration.
user parameter allows to append one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (login option is case-insensitive; must not contain a trailing space).
oracle.sys.params[connString,<user>,<password>,<service>]
A set of system parameter values. JSON object connString - URI or session name.
user, password - Oracle login credentials.
service - Oracle service name.
user parameter allows to append one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (login option is case-insensitive; must not contain a trailing space).
oracle.ts.stats[connString,<user>,<password>,<service>,<tablespace>,<type>]
Tablespaces statistics. JSON object connString - URI or session name.
user, password - Oracle login credentials.
service - Oracle service name.
tablespace - name of the tablespace to query. Default (if left empty and type is set):
- "TEMP" (if type is set to "TEMPORARY");
- "USERS" (if type is set to "PERMANENT").
type - type of the tablespace to query. Default (if tablespace is set): "PERMANENT".
user parameter allows to append one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (login option is case-insensitive; must not contain a trailing space).
oracle.ts.discovery[connString,<user>,<password>,<service>]
List of tablespaces. Used for low-level discovery. JSON object connString - URI or session name.
user, password - Oracle login credentials.
service - Oracle service name.
user parameter allows to append one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (login option is case-insensitive; must not contain a trailing space).
oracle.user.info[connString,<user>,<password>,<service>,<username>]
List of tablespaces. Used for low-level discovery. JSON object connString - URI or session name.
user, password - Oracle login credentials.
service - Oracle service name.
username - a username, for which the information is needed. Lowercase usernames are not supported. Default: current user.
user parameter allows to append one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (login option is case-insensitive; must not contain a trailing space).
oracle.version[connString,<user>,<password>,<service>]
Returns the database server version. String connString - URI or session name.
user, password - Oracle login credentials.
service - Oracle service name.

PostgreSQL

Key
Description Return value Parameters Comments
pgsql.autovacuum.count[uri,<username>,<password>,<dbName>]
The number of autovacuum workers. Integer uri - URI or session name.
username, password - PostgreSQL credentials.
dbName - Database name.
pgsql.archive[uri,<username>,<password>,<dbName>]
Information about archived files. JSON object uri - URI or session name.
username, password - PostgreSQL credentials.
dbName - Database name.
pgsql.bgwriter[uri,<username>,<password>,<dbName>]
Combined number of checkpoints for the database cluster, broken down by checkpoint type. JSON object uri - URI or session name.
username, password - PostgreSQL credentials.
dbName - Database name.
pgsql.cache.hit[uri,<username>,<password>,<dbName>]
PostgreSQL buffer cache hit rate. Float uri - URI or session name.
username, password - PostgreSQL credentials.
dbName - Database name.
pgsql.connections[uri,<username>,<password>,<dbName>]
Connections by type. JSON object uri - URI or session name.
username, password - PostgreSQL credentials.
dbName - Database name.
pgsql.custom.query[uri,<username>,<password>,queryName,<args...>]
Returns result of a custom query. JSON object uri - URI or session name.
username, password - PostgreSQL credentials.
queryName - name of a custom query, must match SQL file name without an extension.
args - one or several comma-separated arguments to pass to a query.
pgsql.dbstat[uri,<username>,<password>,dbName]
Collects statistics per database. Used for low-level discovery. JSON object uri - URI or session name.
username, password - PostgreSQL credentials.
dbName - Database name.
pgsql.dbstat.sum[uri,<username>,<password>,<dbName>]
Summarized data for all databases in a cluster. JSON object uri - URI or session name.
username, password - PostgreSQL credentials.
dbName - Database name.
pgsql.db.age[uri,<username>,<password>,dbName]
Age of the oldest FrozenXID of the database. Integer uri - URI or session name.
username, password - PostgreSQL credentials.
dbName - Database name.
pgsql.db.bloating_tables[uri,<username>,<password>,<dbName>]
The number of bloating tables per database. Integer uri - URI or session name.
username, password - PostgreSQL credentials.
dbName - Database name.
pgsql.db.discovery[uri,<username>,<password>,<dbName>]
List of the PostgreSQL databases. Used for low-level discovery. JSON object uri - URI or session name.
username, password - PostgreSQL credentials.
dbName - Database name.
pgsql.db.size[uri,<username>,<password>,dbName]
Database size in bytes. Integer uri - URI or session name.
username, password - PostgreSQL credentials.
dbName - Database name.
pgsql.locks[uri,<username>,<password>,<dbName>]
Information about granted locks per database. Used for low-level discovery. JSON object uri - URI or session name.
username, password - PostgreSQL credentials.
dbName - Database name.
pgsql.oldest.xid[uri,<username>,<password>,<dbName>]
Age of the oldest XID. Integer uri - URI or session name.
username, password - PostgreSQL credentials.
dbName - Database name.
pgsql.ping[uri,<username>,<password>,<dbName>]
Tests whether a connection is alive or not. 1 - connection is alive

0 - connection is broken (if there is any error presented including AUTH and configuration issues).
uri - URI or session name.
username, password - PostgreSQL credentials.
dbName - Database name.
pgsql.queries[uri,<username>,<password>,<dbName>,timePeriod]
Measures query execution time. JSON object uri - URI or session name.
username, password - PostgreSQL credentials.
dbName - Database name.
timePeriod - execution time limit for count of slow queries (must be a positive integer).
This item is supported since Zabbix 6.0.3
pgsql.replication.count[uri,<username>,<password>]
The number of standby servers. Integer uri - URI or session name.
username, password - PostgreSQL credentials.
pgsql.replication.process[uri,<username>,<password>]
Flush lag, write lag and replay lag per each sender process. JSON object uri - URI or session name.
username, password - PostgreSQL credentials.
pgsql.replication.process.discovery[uri,<username>,<password>]
Replication process name discovery. JSON object uri - URI or session name.
username, password - PostgreSQL credentials.
pgsql.replication.recovery_role[uri,<username>,<password>]
Recovery status. 0 - master mode
1 - recovery is still in progress (standby mode)
uri - URI or session name.
username, password - PostgreSQL credentials.
pgsql.replication.status[uri,<username>,<password>]
The status of replication. 0 - streaming is down
1 - streaming is up
2 - master mode
uri - URI or session name.
username, password - PostgreSQL credentials.
pgsql.replication_lag.b[uri,<username>,<password>]
Replication lag in bytes. Integer uri - URI or session name.
username, password - PostgreSQL credentials.
pgsql.replication_lag.sec[uri,<username>,<password>]
Replication lag in seconds. Integer uri - URI or session name.
username, password - PostgreSQL credentials.
pgsql.uptime[uri,<username>,<password>,<dbName>]
PostgreSQL uptime in milliseconds. Float uri - URI or session name.
username, password - PostgreSQL credentials.
dbName - Database name.
pgsql.version[uri,<username>,<password>,<dbName>]
Returns PostgreSQL version. String uri - URI or session name.
username, password - PostgreSQL credentials.
dbName - Database name.
pgsql.wal.stat[uri,<username>,<password>,<dbName>]
WAL statistics. JSON object uri - URI or session name.
username, password - PostgreSQL credentials.
dbName - Database name.

Redis

Key
Description Return value Parameters Comments
redis.config[connString,<password>,<pattern>]
Gets the configuration parameters of a Redis instance that match the pattern. JSON - if a glob-style pattern was used

single value - if a pattern did not contain any wildcard character
connString - URI or session name.
password - Redis password.
pattern - glob-style pattern (* by default).
redis.info[connString,<password>,<section>]
Gets the output of the INFO command. JSON - output is serialized as JSON connString - URI or session name.
password - Redis password.
section - section of information (default by default).
redis.ping[connString,<password>]
Test if a connection is alive or not. 1 - connection is alive

0 - connection is broken (if there is any error presented including AUTH and configuration issues)
connString - URI or session name.
password - Redis password.
redis.slowlog.count[connString,<password>]
The number of slow log entries since Redis was started. Integer connString - URI or session name.
password - Redis password.

S.M.A.R.T.

Key
Description Return value Parameters Comments
smart.attribute.discovery
Returns a list of S.M.A.R.T. device attributes. JSON object The following macros and their values are returned: {#NAME}, {#DISKTYPE}, {#ID}, {#ATTRNAME}, {#THRESH}.
HDD, SSD and NVME drive types are supported. Drives can be alone or combined in a RAID. {#NAME} will have an add-on in case of RAID, e.g: {"{#NAME}": "/dev/sda cciss,2"}
smart.disk.discovery
Returns a list of S.M.A.R.T. devices. JSON object The following macros and their values are returned: {#NAME}, {#DISKTYPE}, {#MODEL}, {#SN}, {#PATH}, {#ATTRIBUTES}, {#RAIDTYPE}.
HDD, SSD and NVME drive types are supported. If a drive does not belong to a RAID, {#RAIDTYPE} will be empty. {#NAME} will have an add-on in case of RAID, e.g: {"{#NAME}": "/dev/sda cciss,2"}
smart.disk.get[<path>,<raid_type>]
Returns all available properties of S.M.A.R.T. devices. JSON object path (since Zabbix 6.0.4) - disk path, the {#PATH} macro may be used as a value
raid_type (since Zabbix 6.0.4) - RAID type, the {#RAID} macro may be used as a value
HDD, SSD and NVME drive types are supported. Drives can be alone or combined in a RAID.
The data includes smartctl version and call arguments, and additional fields:
disk_name - holds the name with the required add-ons for RAID discovery, e.g: {"disk_name": "/dev/sda cciss,2"}
disk_type - holds the disk type HDD, SSD, or NVME, e.g: {"disk_type": "ssd"})
If no parameters are specified, the item will return information about all disks.

Systemd

Key
Description Return value Parameters Comments
systemd.unit.get[unit name,<interface>]
Returns all properties of a systemd unit. JSON object unit name - unit name (you may want to use the {#UNIT.NAME} macro in item prototype to discover the name)
interface - unit interface type, possible values: Unit (default), Service, Socket, Device, Mount, Automount, Swap, Target, Path
This item is supported on Linux platform only.

LoadState, ActiveState and UnitFileState for Unit interface are returned as text and integer:
"ActiveState":{"state":1,"text":"active"}
systemd.unit.info[unit name,<property>,<interface>]
Systemd unit information. String unit name - unit name (you may want to use the {#UNIT.NAME} macro in item prototype to discover the name)
property - unit property (e.g. ActiveState (default), LoadState, Description)
interface - unit interface type (e.g. Unit (default), Socket, Service)
This item allows to retrieve a specific property from specific type of interface as described in dbus API.

This item is supported on Linux platform only.

Examples:
=> systemd.unit.info["{#UNIT.NAME}"] - collect active state (active, reloading, inactive, failed, activating, deactivating) info on discovered systemd units
=> systemd.unit.info["{#UNIT.NAME}",LoadState] - collect load state info on discovered systemd units
=> systemd.unit.info[mysqld.service,Id] - retrieve service technical name (mysqld.service)
=> systemd.unit.info[mysqld.service,Description] - retrieve service description (MySQL Server)
=> systemd.unit.info[mysqld.service,ActiveEnterTimestamp] - retrieve the last time the service entered the active state (1562565036283903)
=> systemd.unit.info[dbus.socket,NConnections,Socket] - collect the number of connections from this socket unit
systemd.unit.discovery[<type>]
List of systemd units and their details. Used for low-level discovery. JSON object type - possible values: all, automount, device, mount, path, service (default), socket, swap, target This item is supported on Linux platform only.

Web certificate

Key
Description Return value Parameters Comments
web.certificate.get[hostname,<port>,<address>]
Validates certificates and returns certificate details. JSON object hostname - can be either IP or DNS.
May contain the URL scheme (https only), path (it will be ignored), and port.
If a port is provided in both the first and the second parameters, their values must match.
If address (the 3rd parameter) is specified, the hostname is only used for SNI and hostname verification.
port - port number (default is 443 for HTTPS).
address - can be either IP or DNS. If specified, it will be used for connection, and hostname (the 1st parameter) will be used for SNI, and host verification.
In case, the 1st parameter is an IP and the 3rd parameter is DNS, the 1st parameter will be used for connection, and the 3rd parameter will be used for SNI and host verification.
This item turns unsupported if the resource specified in host does not exist or is unavailable or if TLS handshake fails with any error except an invalid certificate.

Currently, AIA (Authority Information Access) X.509 extension, CRLs and OCSP (including OCSP stapling), Certificate Transparency, and custom CA trust store are not supported.