[comment]: # attributes: notoc [comment]: # (terms: kernel.maxfiles, kernel.maxproc, kernel.openfiles, log, log.count, logrt, logrt.count, modbus.get, net.dns, net.dns.perf, net.dns.record, net.if.collisions, net.if.discovery, net.if.in, net.if.out, net.if.total, net.tcp.listen, net.tcp.port, net.tcp.service, net.tcp.service.perf, net.tcp.socket.count, net.udp.listen, net.udp.service, net.udp.service.perf, net.udp.socket.count, proc.cpu.util, proc.mem, proc.num, sensor, system.boottime, system.cpu.discovery, system.cpu.intr, system.cpu.load, system.cpu.num, system.cpu.switches, system.cpu.util, system.hostname, system.hw.chassis, system.hw.cpu, system.hw.devices, system.hw.macaddr, system.localtime, system.run, system.stat, system.sw.arch, system.sw.os, system.sw.packages, system.swap.in, system.swap.out, system.swap.size, system.uname, system.uptime, system.users.num, vfs.dev.discovery, vfs.dev.read, vfs.dev.write, vfs.dir.count, vfs.dir.get, vfs.dir.size, vfs.file.cksum, vfs.file.contents, vfs.file.exists, vfs.file.get, vfs.file.md5sum, vfs.file.owner, vfs.file.permissions, vfs.file.regexp, vfs.file.regmatch, vfs.file.size, vfs.file.time, vfs.fs.discovery, vfs.fs.get, vfs.fs.inode, vfs.fs.size, vm.memory.size, web.page.get, web.page.perf, web.page.regexp, agent.hostmetadata, agent.hostname, agent.ping, agent.variant, agent.version, zabbix.stats, zabbix.stats ) [comment]: # (tags: agent, item, items, keys, agent keys, type zabbix agent, Zabbix agent keys ) [comment]: # ({22d75789-22d75789}) # 1 Zabbix agent [comment]: # ({/22d75789-22d75789}) [comment]: # ({aae5ae72-d63c67a4}) ### Overview This section provides details on the item keys that use communication with Zabbix agent for data gathering. There are [passive and active](/manual/appendix/items/activepassive) agent checks. When configuring an item, you can select the required type: - *Zabbix agent* - for passive checks - *Zabbix agent (active)* - for active checks Note that all item keys supported by Zabbix agent are also supported by the new generation Zabbix agent 2. See the [additional item keys](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2) that you can use with the agent 2 only. [comment]: # ({/aae5ae72-d63c67a4}) [comment]: # ({3fd8c340-cefe2e1b}) ### Supported item keys The item keys that you can use with Zabbix agent are listed below. The item keys are listed without parameters and additional information. Click on the item key to see the full details. |Item key|Description|Item group| |--|-------|-| |[kernel.maxfiles](#kernel.maxfiles)|The maximum number of opened files supported by OS.|Kernel| |[kernel.maxproc](#kernel.maxproc)|The maximum number of processes supported by OS.|^| |[kernel.openfiles](#kernel.openfiles)|The number of currently open file descriptors.|^| |[log](#log)|The monitoring of a log file.|[Log monitoring](log_items)| |[log.count](#log.count)|The count of matched lines in a monitored log file.|^| |[logrt](#logrt)|The monitoring of a log file that is rotated.|^| |[logrt.count](#logrt.count)|The count of matched lines in a monitored log file that is rotated.|^| |[modbus.get](#modbus)|Reads Modbus data.|Modbus| |[net.dns](#net.dns)|Checks the status of a DNS service.|Network| |[net.dns.perf](#net.dns.perf)|Checks the performance of a DNS service.|^| |[net.dns.record](#net.dns.record)|Performs a DNS query.|^| |[net.if.collisions](#net.if.collisions)|The number of out-of-window collisions.|^| |[net.if.discovery](#net.if.discovery)|The list of network interfaces.|^| |[net.if.in](#net.if.in)|The incoming traffic statistics on a network interface.|^| |[net.if.out](#net.if.out)|The outgoing traffic statistics on a network interface.|^| |[net.if.total](#net.if.total)|The sum of incoming and outgoing traffic statistics on a network interface.|^| |[net.tcp.listen](#net.tcp.listen)|Checks if this TCP port is in LISTEN state.|^| |[net.tcp.port](#net.tcp.port)|Checks if it is possible to make a TCP connection to the specified port.|^| |[net.tcp.service](#net.tcp.service)|Checks if a service is running and accepting TCP connections.|^| |[net.tcp.service.perf](#net.tcp.service.perf)|Checks the performance of a TCP service.|^| |[net.tcp.socket.count](#net.tcp.socket.count)|Returns the number of TCP sockets that match parameters.|^| |[net.udp.listen](#net.udp.listen)|Checks if this UDP port is in LISTEN state.|^| |[net.udp.service](#net.udp.service)|Checks if a service is running and responding to UDP requests.|^| |[net.udp.service.perf](#net.udp.service.perf)|Checks the performance of a UDP service.|^| |[net.udp.socket.count](#net.udp.socket.count)|Returns the number of UDP sockets that match parameters.|^| |[proc.cpu.util](#proc.cpu.util)|The process CPU utilization percentage.|Processes| |[proc.get](#proc.get)|The list of OS processes and their parameters.|^| |[proc.mem](#proc.mem)|The memory used by the process in bytes.|^| |[proc.num](#proc.num)|The number of processes.|^| |[sensor](#sensor)|Hardware sensor reading.|Sensors| |[system.boottime](#system.boottime)|The system boot time.|System| |[system.cpu.discovery](#system.cpu.discovery)|The list of detected CPUs/CPU cores.|^| |[system.cpu.intr](#system.cpu.intr)|The device interrupts.|^| |[system.cpu.load](#system.cpu.load)|The CPU load.|^| |[system.cpu.num](#system.cpu.num)|The number of CPUs.|^| |[system.cpu.switches](#system.cpu.switches)|The count of context switches.|^| |[system.cpu.util](#system.cpu.util)|The CPU utilization percentage.|^| |[system.hostname](#system.hostname)|The system host name.|^| |[system.hw.chassis](#system.hw.chassis)|The chassis information.|^| |[system.hw.cpu](#system.hw.cpu)|The CPU information.|^| |[system.hw.devices](#system.hw.devices)|The listing of PCI or USB devices.|^| |[system.hw.macaddr](#system.hw.macaddr)|The listing of MAC addresses.|^| |[system.localtime](#system.localtime)|The system time.|^| |[system.run](#system.run)|Run the specified command on the host.|^| |[system.stat](#system.stat)|The system statistics.|^| |[system.sw.arch](#system.sw.arch)|The software architecture information.|^| |[system.sw.os](#system.sw.os)|The operating system information.|^| |[system.sw.os.get](#system.sw.os.get)|Detailed information about the operating system (version, type, distribution name, minor and major version, etc).|^| |[system.sw.packages](#system.sw.packages)|The listing of installed packages.|^| |[system.sw.packages.get](#system.sw.packages.get)|A detailed listing of installed packages.|^| |[system.swap.in](#system.swap.in)|The swap-in (from device into memory) statistics.|^| |[system.swap.out](#system.swap.out)|The swap-out (from memory onto device) statistics.|^| |[system.swap.size](#system.swap.size)|The swap space size in bytes or in percentage from total.|^| |[system.uname](#system.uname)|Identification of the system.|^| |[system.uptime](#system.uptime)|The system uptime in seconds.|^| |[system.users.num](#system.users.num)|The number of users logged in.|^| |[vfs.dev.discovery](#vfs.dev.discovery)|The list of block devices and their type.|Virtual file systems| |[vfs.dev.read](#vfs.dev.read)|The disk read statistics.|^| |[vfs.dev.write](#vfs.dev.write)|The disk write statistics.|^| |[vfs.dir.count](#vfs.dir.count)|The directory entry count.|^| |[vfs.dir.get](#vfs.dir.get)|The directory entry list.|^| |[vfs.dir.size](#vfs.dir.size)|The directory size.|^| |[vfs.file.cksum](#vfs.file.cksum)|The file checksum, calculated by the UNIX cksum algorithm.|^| |[vfs.file.contents](#vfs.file.contents)|Retrieving the contents of a file.|^| |[vfs.file.exists](#vfs.file.exists)|Checks if the file exists.|^| |[vfs.file.get](#vfs.file.get)|Returns information about a file.|^| |[vfs.file.md5sum](#vfs.file.md5sum)|The MD5 checksum of file.|^| |[vfs.file.owner](#vfs.file.owner)|Retrieves the owner of a file.|^| |[vfs.file.permissions](#vfs.file.permissions)|Returns a 4-digit string containing the octal number with UNIX permissions.|^| |[vfs.file.regexp](#vfs.file.regexp)|Retrieve a string in the file.|^| |[vfs.file.regmatch](#vfs.file.regmatch)|Find a string in the file.|^| |[vfs.file.size](#vfs.file.size)|The file size.|^| |[vfs.file.time](#vfs.file.time)|The file time information.|^| |[vfs.fs.discovery](#vfs.fs.discovery)|The list of mounted filesystems with their type and mount options.|^| |[vfs.fs.get](#vfs.fs.get)|The list of mounted filesystems with their type, available disk space, inode statistics and mount options.|^| |[vfs.fs.inode](#vfs.fs.inode)|The number or percentage of inodes.|^| |[vfs.fs.size](#vfs.fs.size)|The disk space in bytes or in percentage from total.|^| |[vm.memory.size](#vm.memory.size)|The memory size in bytes or in percentage from total.|Virtual memory| |[web.page.get](#web.page.get)|Get the content of a web page.|Web monitoring| |[web.page.perf](#web.page.perf)|The loading time of a full web page.|^| |[web.page.regexp](#web.page.regexp)|Find a string on the web page.|^| |[agent.hostmetadata](#agent.hostmetadata)|The agent host metadata.|Zabbix| |[agent.hostname](#agent.hostname)|The agent host name.|^| |[agent.ping](#agent.ping)|The agent availability check.|^| |[agent.variant](#agent.variant)|The variant of Zabbix agent (Zabbix agent or Zabbix agent 2).|^| |[agent.version](#agent.version)|The version of Zabbix agent.|^| |[zabbix.stats](#zabbix.stats)|Returns a set of Zabbix server or proxy internal metrics. If `ip` and `port` are specified, metrics are retrieved from the remote instance; otherwise, from the local instance.|^| |[zabbix.stats](#zabbix.stats.two)|Returns the number of monitored items in the queue which are delayed on Zabbix server or proxy. If `ip` and `port` are specified, metrics are retrieved from the remote instance; otherwise, from the local instance.|^| [comment]: # ({/3fd8c340-cefe2e1b}) [comment]: # ({07f3d331-cea3fc45}) #### Supported platforms Except where specified differently in the item details, the agent items (and all parameters) are supported on: - **Linux** - **FreeBSD** - **Solaris** - **HP-UX** - **AIX** - **MacOS X** - **OpenBSD** - **NetBSD** Many agent items are also supported on **Windows**. See the [Windows agent item](/manual/config/items/itemtypes/zabbix_agent/win_keys#shared-items) page for details. [comment]: # ({/07f3d331-cea3fc45}) [comment]: # ({dc120678-3077d649}) ### Item key details Parameters without angle brackets are mandatory. Parameters marked with angle brackets **<** **>** are optional. [comment]: # ({/dc120678-3077d649}) [comment]: # ({39b5e2c9-20fc641c}) ##### kernel.maxfiles {#kernel.maxfiles}
The maximum number of opened files supported by OS.
Return value: *Integer*.
[Supported platforms](#supported-platforms): Linux, FreeBSD, MacOS X, OpenBSD, NetBSD. [comment]: # ({/39b5e2c9-20fc641c}) [comment]: # ({9aaac02a-6dbdc04a}) ##### kernel.maxproc {#kernel.maxproc}
The maximum number of processes supported by OS.
Return value: *Integer*.
[Supported platforms](#supported-platforms): Linux 2.6 and later, FreeBSD, Solaris, MacOS X, OpenBSD, NetBSD. [comment]: # ({/9aaac02a-6dbdc04a}) [comment]: # ({725bd0fa-9f31067e}) ##### kernel.openfiles {#kernel.openfiles}
The number of currently open file descriptors.
Return value: *Integer*.
[Supported platforms](#supported-platforms): Linux (the item may work on other UNIX-like platforms). [comment]: # ({/725bd0fa-9f31067e}) [comment]: # ({5c22a7c6-f0ef2c24}) ##### log[file,,,,,,,,] {#log}
The monitoring of a log file.
Return value: *Log*.
See [supported platforms](#supported-platforms). Parameters: - **file** - the full path and name of a log file;
- **regexp** - a regular [expression](/manual/regular_expressions#overview) describing the required pattern;
- **encoding** - the code page [identifier](/manual/config/items/itemtypes/zabbix_agent#encoding-settings);
- **maxlines** - the maximum number of new lines per second the agent will send to Zabbix server or proxy. This parameter overrides the value of 'MaxLinesPerSecond' in [zabbix\_agentd.conf](/manual/appendix/config/zabbix_agentd);
- **mode** - possible values: *all* (default) or *skip* - skip processing of older data (affects only newly created items);
- **output** - an optional output formatting template. The **\\0** escape sequence is replaced with the matched part of text (from the first character where match begins until the character where match ends) while an **\\N** (where N=1...9) escape sequence is replaced with Nth matched group (or an empty string if the N exceeds the number of captured groups);
- **maxdelay** - the maximum delay in seconds. Type: float. Values: 0 - (default) never ignore log file lines; > 0.0 - ignore older lines in order to get the most recent lines analyzed within "maxdelay" seconds. Read the [maxdelay](log_items#using-maxdelay-parameter) notes before using it!
- **options** - additional options:
*mtime-noreread* - non-unique records, reread only if the file size changes (ignore modification time change). (This parameter is deprecated since 5.0.2, because now mtime is ignored.)
- **persistent dir** (only in zabbix\_agentd on Unix systems; not supported in Zabbix agent 2) - the absolute pathname of directory where to store persistent files. See also additional notes on [persistent files](log_items#notes-on-persistent-files-for-log-items). Comments: - The item must be configured as an [active check](/manual/appendix/items/activepassive#active-checks); - If the file is missing or permissions do not allow access, the item turns unsupported; - If `output` is left empty - the whole line containing the matched text is returned. Note that all global regular expression types except 'Result is TRUE' always return the whole matched line and the `output` parameter is ignored. - Content extraction using the `output` parameter takes place on the agent. Examples: ```default log[/var/log/syslog] log[/var/log/syslog,error] log[/home/zabbix/logs/logfile,,,100] ``` Example of using the `output` parameter for extracting a number from log record: ```default log[/app1/app.log,"task run [0-9.]+ sec, processed ([0-9]+) records, [0-9]+ errors",,,,\1] #this item will match a log record "2015-11-13 10:08:26 task run 6.08 sec, processed 6080 records, 0 errors" and send only '6080' to server. Because a numeric value is being sent, the "Type of information" for this item can be set to "Numeric (unsigned)" and the value can be used in graphs, triggers etc. ``` Example of using the `output` parameter for rewriting a log record before sending to server: ```default log[/app1/app.log,"([0-9 :-]+) task run ([0-9.]+) sec, processed ([0-9]+) records, ([0-9]+) errors",,,,"\1 RECORDS: \3, ERRORS: \4, DURATION: \2"] #this item will match a log record "2015-11-13 10:08:26 task run 6.08 sec, processed 6080 records, 0 errors" and send a modified record "2015-11-13 10:08:26 RECORDS: 6080, ERRORS: 0, DURATION: 6.08" to the server. ``` [comment]: # ({/5c22a7c6-f0ef2c24}) [comment]: # ({63539684-0cc87dbe}) ##### log.count[file,,,,,,,] {#log.count}
The count of matched lines in a monitored log file.
Return value: *Integer*.
See [supported platforms](#supported-platforms). Parameters: - **file** - the full path and name of log file;
- **regexp** - a regular [expression](/manual/regular_expressions#overview) describing the required pattern;
- **encoding** - the code page [identifier](/manual/config/items/itemtypes/zabbix_agent#encoding-settings);
- **maxproclines** - the maximum number of new lines per second the agent will analyze (cannot exceed 10000). The default value is 10\*'MaxLinesPerSecond' in [zabbix\_agentd.conf](/manual/appendix/config/zabbix_agentd).
- **mode** - possible values: *all* (default) or *skip* - skip processing of older data (affects only newly created items).
- **maxdelay** - the maximum delay in seconds. Type: float. Values: 0 - (default) never ignore log file lines; > 0.0 - ignore older lines in order to get the most recent lines analyzed within "maxdelay" seconds. Read the [maxdelay](log_items#using-maxdelay-parameter) notes before using it!
- **options** - additional options:
*mtime-noreread* - non-unique records, reread only if the file size changes (ignore modification time change). (This parameter is deprecated since 5.0.2, because now mtime is ignored.)
- **persistent dir** (only in zabbix\_agentd on Unix systems; not supported in Zabbix agent 2) - the absolute pathname of directory where to store persistent files. See also additional notes on [persistent files](log_items#notes-on-persistent-files-for-log-items). Comments: - The item must be configured as an [active check](/manual/appendix/items/activepassive#active-checks); - Matching lines are counted in the new lines since the last log check by the agent, and thus depend on the item update interval; - If the file is missing or permissions do not allow access, the item turns unsupported. [comment]: # ({/63539684-0cc87dbe}) [comment]: # ({2b5e82b3-95734be0}) ##### logrt[file regexp,,,,,,,,] {#logrt}
The monitoring of a log file that is rotated.
Return value: *Log*.
See [supported platforms](#supported-platforms). Parameters: - **file regexp** - the absolute path to file, with the file name specified using a regular [expression](/manual/regular_expressions). Note that the regular expression applies only to the file name and does not need to match the entire name (e.g., /path/to/agent will match zabbix\_agentd.log).
- **regexp** - a regular [expression](/manual/regular_expressions#overview) describing the required content pattern.
- **encoding** - the code page [identifier](/manual/config/items/itemtypes/zabbix_agent#encoding-settings).
- **maxlines** - the maximum number of new lines per second the agent will send to Zabbix server or proxy. This parameter overrides the value of 'MaxLinesPerSecond' in [zabbix\_agentd.conf](/manual/appendix/config/zabbix_agentd).
- **mode** - possible values: *all* (default) or *skip* - skip processing of older data (affects only newly created items).
- **output** - an optional output formatting template. The **\\0** escape sequence is replaced with the matched part of text (from the first character where match begins until the character where match ends) while an **\\N** (where N=1...9) escape sequence is replaced with Nth matched group (or an empty string if the N exceeds the number of captured groups).
- **maxdelay** - the maximum delay in seconds. Type: float. Values: 0 - (default) never ignore log file lines; > 0.0 - ignore older lines in order to get the most recent lines analyzed within "maxdelay" seconds. Read the [maxdelay](log_items#using-maxdelay-parameter) notes before using it!
- **options** - the type of log file rotation and other options. Possible values:
*rotate* (default),
*copytruncate* - note that *copytruncate* cannot be used together with *maxdelay*. In this case *maxdelay* must be 0 or not specified; see [copytruncate](log_items#notes-on-handling-copytruncate-log-file-rotation) notes,
*mtime-reread* - non-unique records, reread if modification time or size changes (used by default if no `mtime-*` option is explicitly set),
*mtime-noreread* - non-unique records, reread only if the size changes (ignore modification time change).
- **persistent dir** (only in zabbix\_agentd on Unix systems; not supported in Zabbix agent 2) - the absolute pathname of directory where to store persistent files. See also additional notes on [persistent files](log_items#notes-on-persistent-files-for-log-items). Comments: - The item must be configured as an [active check](/manual/appendix/items/activepassive#active-checks); - Log rotation is based on the last modification time of files; - Note that logrt is designed to work with one currently active log file, with several other matching inactive files rotated. If, for example, a directory has many active log files, a separate logrt item should be created for each one. Otherwise if one logrt item picks up too many files it may lead to exhausted memory and a crash of monitoring. - If `output` is left empty - the whole line containing the matched text is returned. Note that all global regular expression types except 'Result is TRUE' always return the whole matched line and the `output` parameter is ignored. - Content extraction using the `output` parameter takes place on the agent. - In the `file regexp` parameter, the log directory path and log file regular expression must be separated by the correct directory separator: - on Windows, the separator must be a backslash (\\); forward slashes may be tolerated at other positions, except the one that separates the log directory path and the log file regular expression (see examples below). - on other systems, it must be a forward slash (/). Examples for Windows: ```default logrt["c:/dir1/dir2/dir3\filename.*\.log","pattern_to_match"] #this item will collect data from log files in "c:/dir1/dir2/dir3" where the file name starts with "filename" and ends with any extension matching ".log". logrt["//example.com/share/dir1/dir2/dir3\filename.*\.log","pattern_to_match"] #this item will collect data from log files in the network share "//example.com/share/dir1/dir2/dir3" where the file name starts with "filename" and ends with any extension matching ".log". ``` Examples for other systems: ```default logrt["/home/zabbix/logs/^logfile[0-9]{1,3}$",,,100] #this item will match a file like "logfile1" (will not match ".logfile1"). logrt["/home/user/^logfile_.*_[0-9]{1,3}$","pattern_to_match","UTF-8",100] #this item will collect data from files such as "logfile_abc_1" or "logfile__001". ``` Example of using the `output` parameter for extracting a number from log record: ```default logrt[/app1/^test.*log$,"task run [0-9.]+ sec, processed ([0-9]+) records, [0-9]+ errors",,,,\1] #this item will match a log record "2015-11-13 10:08:26 task run 6.08 sec, processed 6080 records, 0 errors" and send only '6080' to server. Because a numeric value is being sent, the "Type of information" for this item can be set to "Numeric (unsigned)" and the value can be used in graphs, triggers etc. ``` Example of using the `output` parameter for rewriting a log record before sending to server: ```default logrt[/app1/^test.*log$,"([0-9 :-]+) task run ([0-9.]+) sec, processed ([0-9]+) records, ([0-9]+) errors",,,,"\1 RECORDS: \3, ERRORS: \4, DURATION: \2"] #this item will match a log record "2015-11-13 10:08:26 task run 6.08 sec, processed 6080 records, 0 errors" and send a modified record "2015-11-13 10:08:26 RECORDS: 6080, ERRORS: 0, DURATION: 6.08" to server. ``` [comment]: # ({/2b5e82b3-95734be0}) [comment]: # ({d5ad0a08-8ad8a2af}) ##### logrt.count[file regexp,,,,,,,] {#logrt.count}
The count of matched lines in a monitored log file that is rotated.
Return value: *Integer*.
See [supported platforms](#supported-platforms). Parameters: - **file regexp** - the absolute path to file, with the file name specified using a regular [expression](/manual/regular_expressions). Note that the regular expression applies only to the file name and does not need to match the entire name (e.g., /path/to/agent will match zabbix\_agentd.log).
- **regexp** - a regular [expression](/manual/regular_expressions#overview) describing the required pattern.
- **encoding** - the code page [identifier](/manual/config/items/itemtypes/zabbix_agent#encoding-settings).
- **maxproclines** - the maximum number of new lines per second the agent will analyze (cannot exceed 10000). The default value is 10\*'MaxLinesPerSecond' in [zabbix\_agentd.conf](/manual/appendix/config/zabbix_agentd).
- **mode** - possible values: *all* (default) or *skip* - skip processing of older data (affects only newly created items).
- **maxdelay** - the maximum delay in seconds. Type: float. Values: 0 - (default) never ignore log file lines; > 0.0 - ignore older lines in order to get the most recent lines analyzed within "maxdelay" seconds. Read the [maxdelay](log_items#using-maxdelay-parameter) notes before using it!
- **options** - the type of log file rotation and other options. Possible values:
*rotate* (default),
*copytruncate* - note that *copytruncate* cannot be used together with *maxdelay*. In this case *maxdelay* must be 0 or not specified; see [copytruncate](log_items#notes-on-handling-copytruncate-log-file-rotation) notes,
*mtime-reread* - non-unique records, reread if modification time or size changes (default),
*mtime-noreread* - non-unique records, reread only if the size changes (ignore modification time change).
- **persistent dir** (only in zabbix\_agentd on Unix systems; not supported in Zabbix agent 2) - the absolute pathname of directory where to store persistent files. See also additional notes on [persistent files](log_items#notes-on-persistent-files-for-log-items). Comments: - The item must be configured as an [active check](/manual/appendix/items/activepassive#active-checks); - Matching lines are counted in the new lines since the last log check by the agent, and thus depend on the item update interval; - Log rotation is based on the last modification time of files; - In the `file regexp` parameter, the log directory path and log file regular expression must be separated by the correct directory separator: - on Windows, the separator must be a backslash (\\); forward slashes may be tolerated at other positions, except the one that separates the log directory path and the log file regular expression (see examples below). - on other systems, it must be a forward slash (/). Examples for Windows: ```default logrt.count["c:/dir1/dir2/dir3\filename.*\.log","pattern_to_match"] #this item will count the number of matches for the pattern "pattern_to_match" in log files located in "c:/dir1/dir2/dir3". logrt.count["//example.com/share/dir1/dir2/dir3\filename.*\.log","pattern_to_match"] #this item will count the number of matches for the pattern "pattern_to_match" in log files on the network share "//example.com/share/dir1/dir2/dir3". ``` Examples for other systems: ```default logrt.count["/home/zabbix/logs/.*","^logfile[0-9]{1,3}$",,100] #this item will count the number of matches for the pattern "^logfile[0-9]{1,3}$" in log files in the "/home/zabbix/logs" directory. logrt.count["/home/user/^logfile_.*_[0-9]{1,3}$","pattern_to_match","UTF-8",100] #this item will count the number of occurrences of the pattern "pattern_to_match" in log files located in "/home/user". ``` [comment]: # ({/d5ad0a08-8ad8a2af}) [comment]: # ({d4ecaf54-518a2dd0}) ##### modbus.get[endpoint,,,
,,,,] {#modbus}
Reads Modbus data.
Return value: *JSON object*.
[Supported platforms](#supported-platforms): Linux, Windows. Parameters: - **endpoint** - the endpoint defined as `protocol://connection_string`;
- **slave id** - the slave ID;
- **function** - the Modbus function;
- **address** - the address of first registry, coil or input;
- **count** - the number of records to read;
- **type** - the type of data;
- **endianness** - the endianness configuration;
- **offset** - the number of registers, starting from 'address', the results of which will be discarded. On Windows, this item follows UNC paths in the **endpoint** parameter, which can be a [security risk](/manual/best_practices/security/access_control#unc-path-access-on-windows-by-zabbix-agent). See a [detailed description](/manual/appendix/items/modbus) of parameters. [comment]: # ({/d4ecaf54-518a2dd0}) [comment]: # ({599b71f4-ba7da5e1}) ##### net.dns[,name,,,,] {#net.dns}
Checks the status of a DNS service.
Return values: 0 - DNS resolution failed (DNS server did not respond or returned an error); 1 - DNS resolution succeeded.
See [supported platforms](#supported-platforms). Parameters: - **ip** (ignored on Windows unless using Zabbix agent 2) - the IP address of DNS server (leave empty for the default DNS server); - **name** - the DNS name to query; - **type** - the record type to be queried (default is *SOA*); - **timeout** (ignored on Windows unless using Zabbix agent 2) - the timeout for the request in seconds (default is 1 second); - **count** (ignored on Windows unless using Zabbix agent 2) - the number of tries for the request (default is 2); - **protocol** - the protocol used to perform DNS queries: *udp* (default) or *tcp*. Comments: - The possible values for `type` are: *ANY*, *A*, *NS*, *CNAME*, *MB*, *MG*, *MR*, *PTR*, *MD*, *MF*, *MX*, *SOA*, *NULL*, *WKS* (not supported for Zabbix agent on Windows, Zabbix agent 2 on all OS), *HINFO*, *MINFO*, *TXT*, *SRV* - For reverse DNS lookups (when `type` is set to *PTR*), you can provide the DNS name in both reversed and non-reversed format (see examples below). Note that when PTR record is requested, the DNS name is actually an IP address. - Internationalized domain names are not supported, please use IDNA encoded names instead. Examples: ```default net.dns[198.51.100.1,example.com,MX,2,1] net.dns[,198.51.100.1,PTR] net.dns[,1.100.51.198.in-addr.arpa,PTR] net.dns[,2a00:1450:400f:800::200e,PTR] net.dns[,e.0.0.2.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.0.f.0.0.4.0.5.4.1.0.0.a.2.ip6.arpa,PTR] ``` [comment]: # ({/599b71f4-ba7da5e1}) [comment]: # ({78b9fae7-ea9e0739}) ##### net.dns.perf[,name,,,,] {#net.dns.perf}
Checks the performance of a DNS service.
Return value: *Float* (0 - service is down; seconds - the number of seconds spent waiting for a response from the service).
See [supported platforms](#supported-platforms). Parameters: - **ip** (ignored on Windows unless using Zabbix agent 2) - the IP address of DNS server (leave empty for the default DNS server); - **name** - the DNS name to query; - **type** - the record type to be queried (default is *SOA*); - **timeout** (ignored on Windows unless using Zabbix agent 2) - the timeout for the request in seconds (default is 1 second); - **count** (ignored on Windows unless using Zabbix agent 2) - the number of tries for the request (default is 2); - **protocol** - the protocol used to perform DNS queries: *udp* (default) or *tcp*. Comments: - The possible values for `type` are:
*ANY*, *A*, *NS*, *CNAME*, *MB*, *MG*, *MR*, *PTR*, *MD*, *MF*, *MX*, *SOA*, *NULL*, *WKS* (not supported for Zabbix agent on Windows, Zabbix agent 2 on all OS), *HINFO*, *MINFO*, *TXT*, *SRV* - For reverse DNS lookups (when `type` is set to *PTR*), you can provide the DNS name in both reversed and non-reversed format (see examples below). Note that when PTR record is requested, the DNS name is actually an IP address. - Internationalized domain names are not supported, please use IDNA encoded names instead. - Since Zabbix 7.0.1, the item returns a response time instead of `0` when the DNS server responds with an error code (for example, `NXDOMAIN` or `SERVFAIL`). Examples: ```default net.dns.perf[198.51.100.1,example.com,MX,2,1] net.dns.perf[,198.51.100.1,PTR] net.dns.perf[,1.100.51.198.in-addr.arpa,PTR] net.dns.perf[,2a00:1450:400f:800::200e,PTR] net.dns.perf[,e.0.0.2.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.0.f.0.0.4.0.5.4.1.0.0.a.2.ip6.arpa,PTR] ``` [comment]: # ({/78b9fae7-ea9e0739}) [comment]: # ({86f73efb-d5dc268a}) ##### net.dns.record[,name,,,,] {#net.dns.record}
Performs a DNS query.
Zabbix agent 2 also provides [net.dns.get](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2#net.dns.get), which offers additional features such as more record types and greater control over DNS monitoring. Return value: a character string with the required type of information.
See [supported platforms](#supported-platforms). Parameters: - **ip** (ignored on Windows unless using Zabbix agent 2) - the IP address of DNS server (leave empty for the default DNS server); - **name** - the DNS name to query; - **type** - the record type to be queried (default is *SOA*); - **timeout** (ignored on Windows unless using Zabbix agent 2) - the timeout for the request in seconds (default is 1 second); - **count** (ignored on Windows unless using Zabbix agent 2) - the number of tries for the request (default is 2); - **protocol** - the protocol used to perform DNS queries: *udp* (default) or *tcp*. Comments: - The possible values for `type` are:
*ANY*, *A*, *NS*, *CNAME*, *MB*, *MG*, *MR*, *PTR*, *MD*, *MF*, *MX*, *SOA*, *NULL*, *WKS* (not supported for Zabbix agent on Windows, Zabbix agent 2 on all OS), *HINFO*, *MINFO*, *TXT*, *SRV* - For reverse DNS lookups (when `type` is set to *PTR*), you can provide the DNS name in reversed or non-reversed format (see examples below). Note that when PTR record is requested, the DNS name is actually an IP address. - Internationalized domain names are not supported, please use IDNA encoded names instead. Examples: ```default net.dns.record[198.51.100.1,example.com,MX,2,1] net.dns.record[,198.51.100.1,PTR] net.dns.record[,1.100.51.198.in-addr.arpa,PTR] net.dns.record[,2a00:1450:400f:800::200e,PTR] net.dns.record[,e.0.0.2.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.0.f.0.0.4.0.5.4.1.0.0.a.2.ip6.arpa,PTR] ``` [comment]: # ({/86f73efb-d5dc268a}) [comment]: # ({3bbd623d-1e07380f}) ##### net.if.collisions[if] {#net.if.collisions}
The number of out-of-window collisions.
Return value: *Integer*.
[Supported platforms](#supported-platforms): Linux, FreeBSD, Solaris, AIX, MacOS X, OpenBSD, NetBSD. Root privileges are required on NetBSD. Parameter: - **if** - network interface name [comment]: # ({/3bbd623d-1e07380f}) [comment]: # ({08eb686e-8911d171}) ##### net.if.discovery {#net.if.discovery}
The list of network interfaces. Used for low-level discovery.
Return value: *JSON object*.
[Supported platforms](#supported-platforms): Linux, FreeBSD, Solaris, HP-UX, AIX, OpenBSD, NetBSD, Windows. [comment]: # ({/08eb686e-8911d171}) [comment]: # ({abe11167-e53ce465}) ##### net.if.in[if,] {#net.if.in}
The incoming traffic statistics on a network interface.
Return value: *Integer*.
[Supported platforms](#supported-platforms): Linux, FreeBSD, Solaris^**[5](#footnotes)**^, HP-UX, AIX, MacOS X, OpenBSD, NetBSD, Windows. Root privileges are required on NetBSD. Parameters: - **if** - network interface name (Unix); network interface full description or IPv4 address; or, if in braces, network interface GUID (Windows); - **mode** - possible values:
*bytes* - number of bytes (default)
*packets* - number of packets
*errors* - number of errors
*dropped* - number of dropped packets
*overruns (fifo)* - the number of FIFO buffer errors
*frame* - the number of packet framing errors
*compressed* - the number of compressed packets received by the device driver
*multicast* - the number of multicast frames received by the device driver Comments: - You may use this key with the *Change per second* preprocessing step in order to get the bytes-per-second statistics; - The *dropped* mode is supported only on Linux, FreeBSD, HP-UX, MacOS X, OpenBSD, NetBSD; - The *overruns*, *frame*, *compressed*, *multicast* modes are supported only on Linux; - On HP-UX this item does not provide details on loopback interfaces (e.g. lo0). Examples: ```default net.if.in[eth0] net.if.in[eth0,errors] ``` [comment]: # ({/abe11167-e53ce465}) [comment]: # ({b622fbac-ab67e043}) ##### net.if.out[if,] {#net.if.out}
The outgoing traffic statistics on a network interface.
Return value: *Integer*.
[Supported platforms](#supported-platforms): Linux, FreeBSD, Solaris^**[5](#footnotes)**^, HP-UX, AIX, MacOS X, OpenBSD, NetBSD, Windows. Root privileges are required on NetBSD. Parameters: - **if** - network interface name (Unix); network interface full description or IPv4 address; or, if in braces, network interface GUID (Windows); - **mode** - possible values:
*bytes* - number of bytes (default)
*packets* - number of packets
*errors* - number of errors
*dropped* - number of dropped packets
*overruns (fifo)* - the number of FIFO buffer errors
*collisions (colls)* - the number of collisions detected on the interface
*carrier* - the number of carrier losses detected by the device driver
*compressed* - the number of compressed packets transmitted by the device driver Comments: - You may use this key with the *Change per second* preprocessing step in order to get the bytes-per-second statistics; - The *dropped* mode is supported only on Linux, HP-UX; - The *overruns*, *collision*, *carrier*, *compressed* modes are supported only on Linux; - On HP-UX this item does not provide details on loopback interfaces (e.g. lo0). Examples: ```default net.if.out[eth0] net.if.out[eth0,errors] ``` [comment]: # ({/b622fbac-ab67e043}) [comment]: # ({e1079e2c-3c96d291}) ##### net.if.total[if,] {#net.if.total}
The sum of incoming and outgoing traffic statistics on a network interface.
Return value: *Integer*.
[Supported platforms](#supported-platforms): Linux, FreeBSD, Solaris^**[5](#footnotes)**^, HP-UX, AIX, MacOS X, OpenBSD, NetBSD, Windows. Root privileges are required on NetBSD. Parameters: - **if** - network interface name (Unix); network interface full description or IPv4 address; or, if in braces, network interface GUID (Windows); - **mode** - possible values:
*bytes* - number of bytes (default)
*packets* - number of packets
*errors* - number of errors
*dropped* - number of dropped packets
*overruns (fifo)* - the number of FIFO buffer errors
*collisions (colls)* - the number of collisions detected on the interface
*compressed* - the number of compressed packets transmitted or received by the device driver Comments: - You may use this key with the *Change per second* preprocessing step in order to get the bytes-per-second statistics; - The *dropped* mode is supported only on Linux, HP-UX. Dropped packets are supported only if both `net.if.in` and `net.if.out` work for dropped packets on your platform. - The *overruns*, *collision*, *compressed* modes are supported only on Linux; - On HP-UX this item does not provide details on loopback interfaces (e.g. lo0). Examples: ```default net.if.total[eth0] net.if.total[eth0,errors] ``` [comment]: # ({/e1079e2c-3c96d291}) [comment]: # ({2f569538-a72f9721}) ##### net.tcp.listen[port] {#net.tcp.listen}
Checks if this TCP port is in LISTEN state.
Return values: 0 - it is not in LISTEN state; 1 - it is in LISTEN state.
[Supported platforms](#supported-platforms): Linux, FreeBSD, Solaris, MacOS X, Windows. Parameter: - **port** - TCP port number On Linux kernels 2.6.14 and above, the information about listening TCP sockets is obtained from the kernel's NETLINK interface, if possible. Otherwise, the information is retrieved from /proc/net/tcp and /roc/net/tcp6 files. Example: ```default net.tcp.listen[80] ``` [comment]: # ({/2f569538-a72f9721}) [comment]: # ({40c963e3-000f516d}) ##### net.tcp.port[,port] {#net.tcp.port}
Checks if it is possible to make a TCP connection to the specified port.
Return values: 0 - cannot connect; 1 - can connect.
See [supported platforms](#supported-platforms). Parameters: - **ip** - the IP address or DNS name (default is 127.0.0.1); - **port** - the port number. Comments: - For simple TCP performance testing use `net.tcp.service.perf[tcp,,]`; - These checks may result in additional messages in system daemon logfiles (SMTP and SSH sessions being logged usually). Example: ```default net.tcp.port[,80] #this item can be used to test the web server availability running on port 80 ``` [comment]: # ({/40c963e3-000f516d}) [comment]: # ({b810edae-11ca536e}) ##### net.tcp.service[service,,] {#net.tcp.service}
Checks if a service is running and accepting TCP connections.
Return values: 0 - service is down; 1 - service is running.
See [supported platforms](#supported-platforms). Parameters: - **service** - *ssh*, *ldap*, *smtp*, *ftp*, *http*, *pop*, *nntp*, *imap*, *tcp*, *https*, or *telnet* (see [details](/manual/appendix/items/service_check_details)); - **ip** - the IP address or DNS name (default is 127.0.0.1); - **port** - the port number (by default the standard service port number is used). Comments: - These checks may result in additional messages in system daemon logfiles (SMTP and SSH sessions being logged usually); - Checking of encrypted protocols (like IMAP on port 993 or POP on port 995) is currently not supported. As a workaround, please use `net.tcp.port[]` for checks like these. - Checking of LDAP and HTTPS on Windows is only supported by Zabbix agent 2; - The telnet check looks for a login prompt (':' at the end). Example: ```default net.tcp.service[ftp,,45] #this item can be used to test the availability of FTP server on TCP port 45 ``` [comment]: # ({/b810edae-11ca536e}) [comment]: # ({4bb92b46-49a8f9ac}) ##### net.tcp.service.perf[service,,] {#net.tcp.service.perf}
Checks the performance of a TCP service.
Return values: *Float* (0 - service is down; seconds - the number of seconds spent waiting for a response from the service).
See [supported platforms](#supported-platforms). Parameters: - **service** - *ssh*, *ldap*, *smtp*, *ftp*, *http*, *pop*, *nntp*, *imap*, *tcp*, *https*, or *telnet* (see [details](/manual/appendix/items/service_check_details)); - **ip** - the IP address or DNS name (default is 127.0.0.1); - **port** - the port number (by default the standard service port number is used). Comments: - Checking of encrypted protocols (like IMAP on port 993 or POP on port 995) is currently not supported. As a workaround, please use `net.tcp.service.perf[tcp,,]` for checks like these. - The telnet check looks for a login prompt (':' at the end). Example: ```default net.tcp.service.perf[ssh] #this item can be used to test the speed of initial response from the SSH server ``` [comment]: # ({/4bb92b46-49a8f9ac}) [comment]: # ({ea50d3fb-29fba160}) ##### net.tcp.socket.count[,,,,] {#net.tcp.socket.count}
Returns the number of TCP sockets that match parameters.
Return value: *Integer*.
[Supported platforms](#supported-platforms): Linux, Windows. Parameters: - **laddr** - the local IPv4/6 address or CIDR subnet; - **lport** - the local port number or service name; - **raddr** - the remote IPv4/6 address or CIDR subnet; - **rport** - the remote port number or service name; - **state** - the connection state (*established*, *syn\_sent*, *syn\_recv*, *fin\_wait1*, *fin\_wait2*, *time\_wait*, *close*, *close\_wait*, *last\_ack*, *listen*, *closing*). Example: ```default net.tcp.socket.count[,80,,,established] #the number of connections to local TCP port 80 in the established state ``` [comment]: # ({/ea50d3fb-29fba160}) [comment]: # ({ae22cf5b-b9f198f7}) ##### net.udp.listen[port] {#net.udp.listen}
Checks if this UDP port is in LISTEN state.
Return values: 0 - it is not in LISTEN state; 1 - it is in LISTEN state.
[Supported platforms](#supported-platforms): Linux, FreeBSD, Solaris, MacOS X. Parameter: - **port** - UDP port number Example: ```default net.udp.listen[68] ``` [comment]: # ({/ae22cf5b-b9f198f7}) [comment]: # ({c9e3662b-7c60892f}) ##### net.udp.service[service,,] {#net.udp.service}
Checks if a service is running and responding to UDP requests.
Return values: 0 - service is down; 1 - service is running.
See [supported platforms](#supported-platforms). Parameters: - **service** - *ntp* (see [details](/manual/appendix/items/service_check_details)); - **ip** - the IP address or DNS name (default is 127.0.0.1); - **port** - the port number (by default the standard service port number is used). Example: ```default net.udp.service[ntp,,45] #this item can be used to test the availability of NTP service on UDP port 45 ``` [comment]: # ({/c9e3662b-7c60892f}) [comment]: # ({e00eff59-8697ef9c}) ##### net.udp.service.perf[service,,] {#net.udp.service.perf}
Checks the performance of a UDP service.
Return values: *Float* (0 - service is down; seconds - the number of seconds spent waiting for a response from the service).
See [supported platforms](#supported-platforms). Parameters: - **service** - *ntp* (see [details](/manual/appendix/items/service_check_details)); - **ip** - the IP address or DNS name (default is 127.0.0.1); - **port** - the port number (by default the standard service port number is used). Example: ```default net.udp.service.perf[ntp] #this item can be used to test response time from NTP service ``` [comment]: # ({/e00eff59-8697ef9c}) [comment]: # ({a220d1e6-25a2206c}) ##### net.udp.socket.count[,,,,] {#net.udp.socket.count}
Returns the number of UDP sockets that match parameters.
Return value: *Integer*.
[Supported platforms](#supported-platforms): Linux, Windows. Parameters: - **laddr** - the local IPv4/6 address or CIDR subnet; - **lport** - the local port number or service name; - **raddr** - the remote IPv4/6 address or CIDR subnet; - **rport** - the remote port number or service name; - **state** - the connection state (*established*, *unconn*). Example: ```default net.udp.socket.count[,,,,established] #returns the number of UDP sockets in the connected state ``` [comment]: # ({/a220d1e6-25a2206c}) [comment]: # ({9ea97b28-4c3ddb55}) ##### proc.cpu.util[,,,,,] {#proc.cpu.util}
The process CPU utilization percentage.
Return value: *Float*.
[Supported platforms](#supported-platforms): Linux, Solaris^**[6](#footnotes)**^. Parameters: - **name** - the process name (default is *all processes*); - **user** - the user name (default is *all users*); - **type** - the CPU utilization type: *total* (default), *user*, or *system*; - **cmdline** - filter by command line (it is a regular [expression](/manual/regular_expressions#overview)); - **mode** - the data gathering mode: *avg1* (default), *avg5*, or *avg15*; - **zone** - the target zone: *current* (default) or *all*. This parameter is supported on Solaris only. Comments: - The returned value is based on a single CPU core utilization percentage. For example, the CPU utilization of a process fully using two cores is 200%. - The process CPU utilization data is gathered by a collector which supports the maximum of 1024 unique (by name, user and command line) queries. Queries not accessed during the last 24 hours are removed from the collector. - When setting the `zone` parameter to *current* (or default) in case the agent has been compiled on a Solaris without zone support, but running on a newer Solaris where zones are supported, then the agent will return NOTSUPPORTED (the agent cannot limit results to only the current zone). However, *all* is supported in this case. Examples: ```default proc.cpu.util[,root] #CPU utilization of all processes running under the "root" user proc.cpu.util[zabbix_server,zabbix] #CPU utilization of all zabbix_server processes running under the zabbix user ``` [comment]: # ({/9ea97b28-4c3ddb55}) [comment]: # ({6aaa3575-02480d9a}) ##### proc.get[,,,] {#proc.get}
The list of OS processes and their parameters. Can be used for low-level discovery.
Return value: *JSON object*.
[Supported platforms](#supported-platforms): Linux, FreeBSD, Windows, OpenBSD, NetBSD. Parameters: - **name** - the process name (default *all processes*); - **user** - the user name (default *all users*); - **cmdline** - filter by command line (it is a regular [expression](/manual/regular_expressions#overview)). This parameter is not supported for Windows; on other platforms it is not supported if mode is set to 'summary'. - **mode** - possible values:
*process* (default), *thread* (not supported for NetBSD), *summary*. See a list of [process parameters](/manual/appendix/items/proc_get) returned for each mode and OS. Comments: - If a value cannot be retrieved, for example, because of an error (process already died, lack of permissions, system call failure), `-1` will be returned; - See [notes](/manual/appendix/items/proc_mem_num_notes) on selecting processes with `name` and `cmdline` parameters (Linux-specific). Examples: ```default proc.get[zabbix_server,zabbix,,process] #list of all zabbix_server processes running under the zabbix user, returns one entry per PID proc.get[java,,,thread] #list of all Java processes, returns one entry per thread proc.get[,zabbix,,summary] #combined data for processes of each type running under the zabbix user, returns one entry per process name ``` [comment]: # ({/6aaa3575-02480d9a}) [comment]: # ({00ea1ea2-d3e42b1a}) ##### proc.mem[,,,,] {#proc.mem}
The memory used by the process in bytes.
Return value: *Integer* - with `mode` as *max*, *min*, *sum*; *Float* - with `mode` as *avg*
[Supported platforms](#supported-platforms): Linux, FreeBSD, Solaris, AIX, OpenBSD, NetBSD. Parameters: - **name** - the process name (default is *all processes*); - **user** - the user name (default is *all users*); - **mode** - possible values: *avg*, *max*, *min*, or *sum* (default); - **cmdline** - filter by command line (it is a regular [expression](/manual/regular_expressions#overview)); - **memtype** - the [type of memory](/manual/appendix/items/proc_mem_notes) used by process Comments: - The `memtype` parameter is supported only on Linux, FreeBSD, Solaris^**[6](#footnotes)**^, AIX; - When several processes use shared memory, the sum of memory used by processes may result in large, unrealistic values.

See [notes](/manual/appendix/items/proc_mem_num_notes) on selecting processes with `name` and `cmdline` parameters (Linux-specific).

When this item is invoked from the command line and contains a command line parameter (e.g. using the agent test mode: `zabbix_agentd -t proc.mem[,,,apache2]`), one extra process will be counted, as the agent will count itself. Examples: ```default proc.mem[,root] #the memory used by all processes running under the "root" user proc.mem[zabbix_server,zabbix] #the memory used by all zabbix_server processes running under the zabbix user proc.mem[,oracle,max,oracleZABBIX] #the memory used by the most memory-hungry process running under Oracle having oracleZABBIX in its command line ``` [comment]: # ({/00ea1ea2-d3e42b1a}) [comment]: # ({5f0c2dc1-8e6bf30e}) ##### proc.num[,,,,] {#proc.num}
The number of processes.
Return value: *Integer*.
[Supported platforms](#supported-platforms): Linux, FreeBSD, Solaris^**[6](#footnotes)**^, HP-UX, AIX, OpenBSD, NetBSD, Windows. Parameters: - **name** - the process name (default is *all processes*); - **user** - the user name (default is *all users*); - **state** - possible values:
*all* (default),
*disk* - uninterruptible sleep,
*run* - running,
*sleep* - interruptible sleep,
*trace* - stopped,
*zomb* - zombie; - **cmdline** - filter by command line (it is a regular [expression](/manual/regular_expressions#overview)); - **zone** - the target zone: *current* (default), or *all*. This parameter is supported on Solaris only. Comments: - The *disk* and *trace* state parameters are supported only on Linux, FreeBSD, OpenBSD, NetBSD; - On Windows, only the `name` and `user` parameters are supported; - When this item is invoked from the command line and contains a command line parameter (e.g. using the agent test mode: `zabbix_agentd -t proc.num[,,,apache2]`), one extra process will be counted, as the agent will count itself; - When setting the `zone` parameter to *current* (or default) in case the agent has been compiled on a Solaris without zone support, but running on a newer Solaris where zones are supported, then the agent will return NOTSUPPORTED (the agent cannot limit results to only the current zone). However, *all* is supported in this case. - See [notes](/manual/appendix/items/proc_mem_num_notes) on selecting processes with `name` and `cmdline` parameters (Linux-specific). Examples: ```default proc.num[,mysql] #the number of processes running under the mysql user proc.num[apache2,www-data] #the number of apache2 processes running under the www-data user proc.num[,oracle,sleep,oracleZABBIX] #the number of processes in sleep state running under Oracle having oracleZABBIX in its command line ``` [comment]: # ({/5f0c2dc1-8e6bf30e}) [comment]: # ({7a39c690-7cdd8214}) ##### sensor[device,sensor,] {#sensor}
Hardware sensor reading.
Return value: *Float*.
[Supported platforms](#supported-platforms): Linux, OpenBSD. Parameters: - **device** - the device name; - **sensor** - the sensor name; - **mode** - possible values: *avg*, *max*, or *min*. Comments: - Reads /proc/sys/dev/sensors on Linux 2.4; - Reads /sys/class/hwmon on Linux 2.6+. See a more detailed description of [sensor](/manual/appendix/items/sensor) item on Linux; - Reads the *hw.sensors* MIB on OpenBSD; - On Linux 2.4, if you specify mode then device and sensor are treated as regular expressions; - On Linux 2.6+ and OpenBSD, or if mode is omitted, device and sensor are treated as verbatim. Examples: ```default sensor[w83781d-i2c-0-2d,temp1] sensor[cpu0,temp0] #the temperature of one CPU sensor["cpu[0-2]$",temp,avg] #the average temperature of the first three CPUs ``` [comment]: # ({/7a39c690-7cdd8214}) [comment]: # ({e9d6ac0b-f46449fd}) ##### system.boottime {#system.boottime}
The system boot time.
Return value: *Integer (Unix timestamp)*.
[Supported platforms](#supported-platforms): Linux, FreeBSD, Solaris, MacOS X, OpenBSD, NetBSD. [comment]: # ({/e9d6ac0b-f46449fd}) [comment]: # ({fbfe668c-b01f71c5}) ##### system.cpu.discovery {#system.cpu.discovery}
The list of detected CPUs/CPU cores. Used for low-level discovery.
Return value: *JSON object*.
See [supported platforms](#supported-platforms). [comment]: # ({/fbfe668c-b01f71c5}) [comment]: # ({10a8dca8-956c4ef9}) ##### system.cpu.intr {#system.cpu.intr}
The device interrupts.
Return value: *Integer*.
[Supported platforms](#supported-platforms): Linux, FreeBSD, Solaris, AIX, OpenBSD, NetBSD. [comment]: # ({/10a8dca8-956c4ef9}) [comment]: # ({6c32a6cf-c8c74d92}) ##### system.cpu.load[,] {#system.cpu.load}
The [CPU load](http://en.wikipedia.org/wiki/Load_(computing)).
Return value: *Float*.
See [supported platforms](#supported-platforms). Parameters: - **cpu** - possible values: *all* (default) or *percpu* (the total load divided by online CPU count); - **mode** - possible values: *avg1* (one-minute average, default), *avg5*, or *avg15*. Example: ```default system.cpu.load[,avg5] ``` [comment]: # ({/6c32a6cf-c8c74d92}) [comment]: # ({86d05d2e-e110ddf9}) ##### system.cpu.num[] {#system.cpu.num}
The number of CPUs.
Return value: *Integer*.
[Supported platforms](#supported-platforms): Linux, FreeBSD, Solaris, HP-UX, AIX, MacOS X, OpenBSD, NetBSD, Windows. Parameter: - **type** - possible values: *online* (default) or *max* The *max* type parameter is supported only on Linux, FreeBSD, Solaris, MacOS X. Example: ```default system.cpu.num ``` [comment]: # ({/86d05d2e-e110ddf9}) [comment]: # ({43d94c7f-addfe1ba}) ##### system.cpu.switches {#system.cpu.switches}
The count of context switches.
Return value: *Integer*.
[Supported platforms](#supported-platforms): Linux, FreeBSD, Solaris, AIX, OpenBSD, NetBSD. [comment]: # ({/43d94c7f-addfe1ba}) [comment]: # ({85535844-d1abd90a}) ##### system.cpu.util[,,,] {#system.cpu.util}
The CPU utilization percentage.
Return value: *Float*.
[Supported platforms](#supported-platforms): Linux, FreeBSD, Solaris, HP-UX, AIX, OpenBSD, NetBSD, Windows. Parameters: - **cpu** - ** or *all* (default); - **type** - possible values: *user* (default), *idle*, *nice*, *system*, *iowait*, *interrupt*, *softirq*, *steal*, *guest* (on Linux kernels 2.6.24 and above), or *guest\_nice* (on Linux kernels 2.6.33 and above); - **mode** - possible values: *avg1* (one-minute average, default), *avg5*, or *avg15*; - **logical or physical** - possible values: *logical* (default) or *physical*. This parameter is supported on AIX only. Comments: - The *nice* type parameter is supported only on Linux, FreeBSD, HP-UX, OpenBSD, NetBSD. - The *iowait* type parameter is supported only on Linux 2.6 and later, Solaris, AIX. - The *interrupt* type parameter is supported only on Linux 2.6 and later, FreeBSD, OpenBSD. - The *softirq*, *steal*, *guest*, *guest_nice* type parameters are supported only on Linux 2.6 and later. - The *avg5* and *avg15* mode parameters are supported on Linux, FreeBSD, Solaris, HP-UX, AIX, OpenBSD, NetBSD. Example: ```default system.cpu.util[0,user,avg5] ``` [comment]: # ({/85535844-d1abd90a}) [comment]: # ({da2f7667-05f3200c}) ##### system.hostname[,] {#system.hostname}
The system host name.
Return value: *String*.
See [supported platforms](#supported-platforms). Parameters: - **type** - possible values: *netbios* (default on Windows), *host* (default on Linux), *shorthost* (returns part of the hostname before the first dot, a full string for names without dots), *fqdn* (returns Fully Qualified Domain Name); - **transform** - possible values: *none* (default) or *lower* (convert to lowercase). The value is acquired by taking `nodename` from the uname() system API output. Examples of returned values: ```default system.hostname → linux-w7x1 system.hostname → example.com system.hostname[shorthost] → example system.hostname → WIN-SERV2008-I6 system.hostname[host] → Win-Serv2008-I6LonG system.hostname[host,lower] → win-serv2008-i6long system.hostname[fqdn,lower] → blog.zabbix.com ``` [comment]: # ({/da2f7667-05f3200c}) [comment]: # ({829bfadb-d14d8400}) ##### system.hw.chassis[] {#system.hw.chassis}
The chassis information.
Return value: *String*.
[Supported platforms](#supported-platforms): Linux. Parameter: - **info** - possible values: *full* (default), *model*, *serial*, *type*, or *vendor* Comments: - This item key depends on the availability of the [SMBIOS](http://en.wikipedia.org/wiki/System_Management_BIOS) table; - It will try to read the DMI table from sysfs, if sysfs access fails then try reading directly from memory; - **Root permissions** are required because the value is acquired by reading from sysfs or memory. Example: ```default system.hw.chassis[full] → Hewlett-Packard HP Pro 3010 Small Form Factor PC CZXXXXXXXX Desktop ``` [comment]: # ({/829bfadb-d14d8400}) [comment]: # ({359280f5-33f13e22}) ##### system.hw.cpu[,] {#system.hw.cpu}
The CPU information.
Return value: *String* or *Integer*.
[Supported platforms](#supported-platforms): Linux. Parameters: - **cpu** - ** or *all* (default); - **info** - possible values: *full* (default), *curfreq*, *maxfreq*, *model* or *vendor*. Comments: - Gathers info from `/proc/cpuinfo` and `/sys/devices/system/cpu/[cpunum]/cpufreq/cpuinfo_max_freq`; - If a CPU number and *curfreq* or *maxfreq* is specified, a numeric value is returned (Hz). Example: ```default system.hw.cpu[0,vendor] → AuthenticAMD ``` [comment]: # ({/359280f5-33f13e22}) [comment]: # ({82b6b82e-87688787}) ##### system.hw.devices[] {#system.hw.devices}
The listing of PCI or USB devices.
Return value: *Text*.
[Supported platforms](#supported-platforms): Linux. Parameter: - **type** - *pci* (default) or *usb* Returns the output of either the lspci or lsusb utility (executed without any parameters). Example: ```default system.hw.devices → 00:00.0 Host bridge: Advanced Micro Devices [AMD] RS780 Host Bridge ``` [comment]: # ({/82b6b82e-87688787}) [comment]: # ({e398211b-ee01b8b4}) ##### system.hw.macaddr[,] {#system.hw.macaddr}
The listing of MAC addresses.
Return value: *String*.
[Supported platforms](#supported-platforms): Linux. Parameters: - **interface** - *all* (default) or a regular [expression](/manual/regular_expressions#overview); - **format** - *full* (default) or *short* Comments: - Lists MAC addresses of the interfaces whose name matches the given `interface` regular [expression](/manual/regular_expressions#overview) (*all* lists for all interfaces); - If `format` is specified as *short*, interface names and identical MAC addresses are not listed. Example: ```default system.hw.macaddr["eth0$",full] → [eth0] 00:11:22:33:44:55 ``` [comment]: # ({/e398211b-ee01b8b4}) [comment]: # ({a6bc1582-1729b15d}) ##### system.localtime[] {#system.localtime}
The system time.
Return value: *Integer* - with `type` as *utc*; *String* - with `type` as *local*.
See [supported platforms](#supported-platforms). Parameters: - **type** - possible values: *utc* - (default) the time since the Epoch (00:00:00 UTC, January 1, 1970), measured in seconds or *local* - the time in the 'yyyy-mm-dd,hh:mm:ss.nnn,+hh:mm' format Must be used as a [passive check](/manual/appendix/items/activepassive#passive-checks) for Zabbix agent; on Zabbix agent 2 it may be configured as an active check. Example: ```default system.localtime[local] #create an item using this key and then use it to display the host time in the *Clock* dashboard widget. ``` [comment]: # ({/a6bc1582-1729b15d}) [comment]: # ({84cbfb96-806250ba}) ##### system.run[command,] {#system.run}
Run the specified command on the host.
Return value: *Text* result of the command or 1 - with `mode` as *nowait* (regardless of the command result).
See [supported platforms](#supported-platforms). Parameters: - **command** - command for execution;
- **mode** - possible values: *wait* - wait end of execution (default) or *nowait* - do not wait. Comments: - This item is disabled by default. Learn how to [enable them](/manual/config/items/restrict_checks); - The return value of the item is a standard output together with a standard error produced by the command. [Exit code checking](/manual/appendix/command_execution#exit-code-checking) is not performed; - To be processed correctly, the return value of the command must be of `text` data type. An empty result is also allowed; - The return value is limited to 16MB (including trailing whitespace that is truncated); [database limits](/manual/config/items/item#text-data-limits) also apply; - See also: [Command execution](/manual/appendix/command_execution). Example: ```default system.run[ls -l /] #return a detailed file list of the root directory ``` [comment]: # ({/84cbfb96-806250ba}) [comment]: # ({1ab49bd1-ed8aa2a2}) ##### system.stat[resource,] {#system.stat}
The system statistics.
Return value: *Integer* or *float*.
[Supported platforms](#supported-platforms): AIX. Parameters: - **ent** - the number of processor units this partition is entitled to receive (float); - **kthr,** - information about kernel thread states:
*r* - average number of runnable kernel threads (float)
*b* - average number of kernel threads placed in the Virtual Memory Manager wait queue (float) - **memory,** - information about the usage of virtual and real memory:
*avm* - active virtual pages (integer)
*fre* - size of the free list (integer) - **page,** - information about page faults and paging activity:
*fi* - file page-ins per second (float)
*fo* - file page-outs per second (float)
*pi* - pages paged in from paging space (float)
*po* - pages paged out to paging space (float)
*fr* - pages freed (page replacement) (float)
*sr* - pages scanned by page-replacement algorithm (float) - **faults,** - trap and interrupt rate:
*in* - device interrupts (float)
*sy* - system calls (float)
*cs* - kernel thread context switches (float) - **cpu,** - breakdown of percentage usage of processor time:
*us* - user time (float)
*sy* - system time (float)
*id* - idle time (float)
*wa* - idle time during which the system had outstanding disk/NFS I/O request(s) (float)
*pc* - number of physical processors consumed (float)
*ec* - the percentage of entitled capacity consumed (float)
*lbusy* - indicates the percentage of logical processor(s) utilization that occurred while executing at the user and system level (float)
*app* - indicates the available physical processors in the shared pool (float) - **disk,** - disk statistics:
*bps* - indicates the amount of data transferred (read or written) to the drive in bytes per second (integer)
*tps* - indicates the number of transfers per second that were issued to the physical disk/tape (float) Comments: - Take note of the following limitations in these items:
`system.stat[cpu,app]` - supported only on AIX LPAR of type "Shared"
`system.stat[cpu,ec]` - supported on AIX LPAR of type "Shared" and "Dedicated" ("Dedicated" always returns 100 (percent))
`system.stat[cpu,lbusy]` - supported only on AIX LPAR of type "Shared"
`system.stat[cpu,pc]` - supported on AIX LPAR of type "Shared" and "Dedicated"
`system.stat[ent]` - supported on AIX LPAR of type "Shared" and "Dedicated" [comment]: # ({/1ab49bd1-ed8aa2a2}) [comment]: # ({a425b76d-087e6420}) ##### system.sw.arch {#system.sw.arch}
The software architecture information.
Return value: *String*.
See [supported platforms](#supported-platforms). The info is acquired from the `uname()` function. Example: ```default system.sw.arch → i686 ``` [comment]: # ({/a425b76d-087e6420}) [comment]: # ({49a57063-ed818157}) ##### system.sw.os[] {#system.sw.os}
The operating system information.
Return value: *String*.
[Supported platforms](#supported-platforms): Linux, Windows. Parameter: - **info** - possible values: *full* (default), *short*, or *name* The info is acquired from (note that not all files and options are present in all distributions): - `/proc/version` (*full*) on Linux; - `/proc/version_signature` (*short*) on Linux; - the PRETTY_NAME parameter from `/etc/os-release` on Linux-systems supporting it or `/etc/issue.net` (*name*); - the ``HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion`` registry key on Windows. Examples: ```default system.sw.os[short] → Ubuntu 2.6.35-28.50-generic 2.6.35.11 system.sw.os[full] → [s|Windows 10 Enterprise 22621.1.asd64fre.ni_release.220506-1250 Build 22621.963] ``` [comment]: # ({/49a57063-ed818157}) [comment]: # ({e125942e-38e87471}) ##### system.sw.os.get {#system.sw.os.get}
Detailed information about the operating system (version, type, distribution name, minor and major version, etc).
Return value: *JSON object*.
[Supported platforms](#supported-platforms): Linux, Windows. [comment]: # ({/e125942e-38e87471}) [comment]: # ({594444c2-bc2ee313}) ##### system.sw.packages[,,] {#system.sw.packages}
The listing of installed packages.
Return value: *Text*.
[Supported platforms](#supported-platforms): Linux. Parameters: - **regexp** - *all* (default) or a regular [expression](/manual/regular_expressions#overview); - **manager** - *all* (default) or a package manager; - **format** - *full* (default) or *short*. Comments: - Lists (alphabetically) installed packages whose name matches the given regular [expression](/manual/regular_expressions#overview) (*all* lists them all); - Supported package managers (executed command):
dpkg (dpkg --get-selections)
pkgtool (ls /var/log/packages)
rpm (rpm -qa)
pacman (pacman -Q)
portage - If `format` is specified as *full*, packages are grouped by package managers (each manager on a separate line beginning with its name in square brackets); - If `format` is specified as *short*, packages are not grouped and are listed on a single line. Example: ```default system.sw.packages[mini,dpkg,short] → python-minimal, python2.6-minimal, ubuntu-minimal ``` [comment]: # ({/594444c2-bc2ee313}) [comment]: # ({f596138e-43f5d666}) ##### system.sw.packages.get[,] {#system.sw.packages.get}
A detailed listing of installed packages.
Return value: *JSON object*.
[Supported platforms](#supported-platforms): Linux. Parameters: - **regexp** - *all* (default) or a regular [expression](/manual/regular_expressions#overview); - **manager** - *all* (default) or a package manager (possible values: *rpm*, *dpkg*, *pkgtool*, *pacman*, or *portage*). Comments: - Returns unformatted JSON with the installed packages whose name matches the given regular expression; - The output is an array of objects each containing the following keys: name, manager, version, size, architecture, buildtime and installtime (see [more details](/manual/appendix/items/return_values_system_sw_packages_get)). [comment]: # ({/f596138e-43f5d666}) [comment]: # ({640e6b41-b0c4a5e8}) ##### system.swap.in[,] {#system.swap.in}
The swap-in (from device into memory) statistics.
Return value: *Integer*.
[Supported platforms](#supported-platforms): Linux, FreeBSD, OpenBSD. Parameters: - **device** - specify the device used for swapping (Linux only) or *all* (default); - **type** - possible values: *count* (number of swapins, default on non-Linux platforms), *sectors* (sectors swapped in), or *pages* (pages swapped in, default on Linux). Comments: - The source of this information is:
/proc/swaps, /proc/partitions, /proc/stat (Linux 2.4)
/proc/swaps, /proc/diskstats, /proc/vmstat (Linux 2.6) - Note that *pages* will only work if device was not specified; - The *sectors* type parameter is supported only on Linux. Example: ```default system.swap.in[,pages] ``` [comment]: # ({/640e6b41-b0c4a5e8}) [comment]: # ({bc3b1823-6cc86983}) ##### system.swap.out[,] {#system.swap.out}
The swap-out (from memory onto device) statistics.
Return value: *Integer*.
[Supported platforms](#supported-platforms): Linux, FreeBSD, OpenBSD. Parameters: - **device** - specify the device used for swapping (Linux only) or *all* (default); - **type** - possible values: *count* (number of swapouts, default on non-Linux platforms), *sectors* (sectors swapped out), or *pages* (pages swapped out, default on Linux). Comments: - The source of this information is:
`/proc/swaps`, `/proc/partitions`, `/proc/stat` (Linux 2.4)
`/proc/swaps`, `/proc/diskstats`, `/proc/vmstat` (Linux 2.6) - Note that *pages* will only work if device was not specified; - The *sectors* type parameter is supported only on Linux. Example: ```default system.swap.out[,pages] ``` [comment]: # ({/bc3b1823-6cc86983}) [comment]: # ({89e3a043-5815bd72}) ##### system.swap.size[,] {#system.swap.size}
The swap space size in bytes or in percentage from total.
Return value: *Integer* - for bytes; *Float* - for percentage.
[Supported platforms](#supported-platforms): Linux, FreeBSD, Solaris, AIX, OpenBSD, Windows. Parameters: - **device** - specify the device used for swapping (FreeBSD only) or *all* (default); - **type** - possible values: *free* (free swap space, default), *pfree* (free swap space, in percent), *pused* (used swap space, in percent), *total* (total swap space), or *used* (used swap space). Comments: - Note that *pfree*, *pused* are not supported on Windows if swap size is 0; - If device is not specified Zabbix agent will only take into account swap devices (files), the physical memory will be ignored. For example, on Solaris systems the `swap -s` command includes a portion of physical memory and swap devices (unlike `swap -l`). Example: ```default system.swap.size[,pfree] → free swap space percentage ``` [comment]: # ({/89e3a043-5815bd72}) [comment]: # ({cb1e7147-6ceb79d2}) ##### system.uname {#system.uname}
Identification of the system.
Return value: *String*.
See [supported platforms](#supported-platforms). Comments: - On UNIX the value for this item is obtained with the uname() system call; - On Windows the item returns the OS architecture, whereas on UNIX it returns the CPU architecture. Examples: ```default system.uname → FreeBSD localhost 4.2-RELEASE FreeBSD 4.2-RELEASE #0: Mon Nov i386 system.uname → Windows ZABBIX-WIN 6.0.6001 Microsoft® Windows Server® 2008 Standard Service Pack 1 x86 ``` [comment]: # ({/cb1e7147-6ceb79d2}) [comment]: # ({5ebb3397-545f6370}) ##### system.uptime {#system.uptime}
The system uptime in seconds.
Return value: *Integer*.
[Supported platforms](#supported-platforms): Linux, FreeBSD, Solaris, AIX, MacOS X, OpenBSD, NetBSD, Windows. In [item configuration](/manual/config/items/item#configuration), use **s** or **uptime** units to get readable values. [comment]: # ({/5ebb3397-545f6370}) [comment]: # ({18cfe8a9-c03c81d9}) ##### system.users.num {#system.users.num}
The number of users logged in.
Return value: *Integer*.
See [supported platforms](#supported-platforms). The **who** command is used on the agent side to obtain the value. [comment]: # ({/18cfe8a9-c03c81d9}) [comment]: # ({e3b2cdd5-48d7b263}) ##### vfs.dev.discovery {#vfs.dev.discovery}
The list of block devices and their type. Used for low-level discovery.
Return value: *JSON object*.
[Supported platforms](#supported-platforms): Linux. [comment]: # ({/e3b2cdd5-48d7b263}) [comment]: # ({5a5cba69-bde9774e}) ##### vfs.dev.read[,,] {#vfs.dev.read}
The disk read statistics.
Return value: *Integer* - with `type` in *sectors*, *operations*, *bytes*; *Float* - with `type` in *sps*, *ops*, *bps*.
[Supported platforms](#supported-platforms): Linux, FreeBSD, Solaris, AIX, OpenBSD. Parameters: - **device** - disk device (default is *all* ^**[3](#footnotes)**^); - **type** - possible values: *sectors*, *operations*, *bytes*, *sps*, *ops*, or *bps* (*sps*, *ops*, *bps* stand for: sectors, operations, bytes per second, respectively); - **mode** - possible values: *avg1* (one-minute average, default), *avg5*, or *avg15*. This parameter is supported only with `type` in: sps, ops, bps. Comments: - If using an update interval of three hours or more^**[2](#footnotes)**^, this item will always return '0'; - The *sectors* and *sps* type parameters are supported only on Linux; - The *ops* type parameter is supported only on Linux and FreeBSD; - The *bps* type parameter is supported only on FreeBSD; - The *bytes* type parameter is supported only on FreeBSD, Solaris, AIX, OpenBSD; - The `mode` parameter is supported only on Linux, FreeBSD; - You may use relative device names (for example, `sda`) as well as an optional /dev/ prefix (for example, `/dev/sda`); - LVM logical volumes are supported; - The default values of 'type' parameter for different OSes:
*AIX* - operations
*FreeBSD* - bps
*Linux* - sps
*OpenBSD* - operations
*Solaris* - bytes - *sps*, *ops* and *bps* on supported platforms is limited to 1024 devices (1023 individual and one for *all*). Example: ```default vfs.dev.read[,operations] ``` [comment]: # ({/5a5cba69-bde9774e}) [comment]: # ({ef4aa6f7-beef0883}) ##### vfs.dev.write[,,] {#vfs.dev.write}
The disk write statistics.
Return value: *Integer* - with `type` in *sectors*, *operations*, *bytes*; *Float* - with `type` in *sps*, *ops*, *bps*.
[Supported platforms](#supported-platforms): Linux, FreeBSD, Solaris, AIX, OpenBSD. Parameters: - **device** - disk device (default is *all* ^**[3](#footnotes)**^); - **type** - possible values: *sectors*, *operations*, *bytes*, *sps*, *ops*, or *bps* (*sps*, *ops*, *bps* stand for: sectors, operations, bytes per second, respectively); - **mode** - possible values: *avg1* (one-minute average, default), *avg5*, or *avg15*. This parameter is supported only with `type` in: sps, ops, bps. Comments: - If using an update interval of three hours or more^**[2](#footnotes)**^, this item will always return '0'; - The *sectors* and *sps* type parameters are supported only on Linux; - The *ops* type parameter is supported only on Linux and FreeBSD; - The *bps* type parameter is supported only on FreeBSD; - The *bytes* type parameter is supported only on FreeBSD, Solaris, AIX, OpenBSD; - The `mode` parameter is supported only on Linux, FreeBSD; - You may use relative device names (for example, `sda`) as well as an optional /dev/ prefix (for example, `/dev/sda`); - LVM logical volumes are supported; - The default values of 'type' parameter for different OSes:
*AIX* - operations
*FreeBSD* - bps
*Linux* - sps
*OpenBSD* - operations
*Solaris* - bytes - *sps*, *ops* and *bps* on supported platforms is limited to 1024 devices (1023 individual and one for *all*). Example: ```default vfs.dev.write[,operations] ``` [comment]: # ({/ef4aa6f7-beef0883}) [comment]: # ({8abe9d9f-a28e06f9}) ##### vfs.dir.count[dir,,,,,,,,,,] {#vfs.dir.count}
The directory entry count.
Return value: *Integer*.
See [supported platforms](#supported-platforms). Parameters: - **dir** - the absolute path to directory; - **regex incl** - a regular [expression](/manual/regular_expressions#overview) describing the name pattern of the entity (file, directory, symbolic link) to include; include all if empty (default value); - **regex excl** - a regular [expression](/manual/regular_expressions#overview) describing the name pattern of the entity (file, directory, symbolic link) to exclude; don't exclude any if empty (default value); - **types incl** - directory entry types to count, possible values: *file* - regular file, *dir* - subdirectory, *sym* - symbolic link, *sock* - socket, *bdev* - block device, *cdev* - character device, *fifo* - FIFO, *dev* - synonymous with "bdev,cdev", *all* - all types (default), i.e. "file,dir,sym,sock,bdev,cdev,fifo". Multiple types must be separated with comma and quoted. - **types excl** - directory entry types (see `types incl`) to NOT count. If some entry type is in both `types incl` and `types excl`, directory entries of this type are NOT counted. - **max depth** - the maximum depth of subdirectories to traverse:
**-1** (default) - unlimited,
**0** - no descending into subdirectories. - **min size** - the minimum size (in bytes) for file to be counted. Smaller files will not be counted. [Memory suffixes](/manual/appendix/suffixes#memory-size-suffixes) can be used. - **max size** - the maximum size (in bytes) for file to be counted. Larger files will not be counted. [Memory suffixes](/manual/appendix/suffixes#memory-size-suffixes) can be used. - **min age** - the minimum age (in seconds) of directory entry to be counted. More recent entries will not be counted. [Time suffixes](/manual/appendix/suffixes#time-suffixes) can be used. - **max age** - the maximum age (in seconds) of directory entry to be counted. Entries so old and older will not be counted (modification time). [Time suffixes](/manual/appendix/suffixes#time-suffixes) can be used. - **regex excl dir** - a regular [expression](/manual/regular_expressions#overview) describing the name pattern of the directory to exclude. All content of the directory will be excluded (in contrast to regex\_excl) Comments: - On Windows, this item follows UNC paths, which can be a [security risk](/manual/best_practices/security/access_control#unc-path-access-on-windows-by-zabbix-agent); - Environment variables, e.g. %APP_HOME%, $HOME and %TEMP% are not supported; - Pseudo-directories "." and ".." are never counted; - Symbolic links are never followed for directory traversal; - Both `regex incl` and `regex excl` are being applied to files and directories when calculating the entry count, but are ignored when picking subdirectories to traverse (if `regex incl` is "(?i)\^.+\\.zip$" and `max depth` is not set, then all subdirectories will be traversed, but only the files of type zip will be counted). - The execution time is limited by the timeout value in agent [configuration](/manual/appendix/config/zabbix_agentd#timeout) (3 sec). Since large directory traversal may take longer than that, no data will be returned and the item will turn unsupported. Partial count will not be returned. - When filtering by size, only regular files have meaningful sizes. Under Linux and BSD, directories also have non-zero sizes (a few Kb typically). Devices have zero sizes, e.g. the size of **/dev/sda1** does not reflect the respective partition size. Therefore, when using `` and ``, it is advisable to specify `` as "*file*", to avoid surprises. Examples: ```default vfs.dir.count[/dev] #monitors the number of devices in /dev (Linux) vfs.dir.count["C:\Users\ADMINI~1\AppData\Local\Temp"] #monitors the number of files in a temporary directory ``` [comment]: # ({/8abe9d9f-a28e06f9}) [comment]: # ({82ed1999-4a354b20}) ##### vfs.dir.get[dir,,,,,,,,,,] {#vfs.dir.get}
The directory entry list.
Return value: *JSON object*.
See [supported platforms](#supported-platforms). Parameters: - **dir** - the absolute path to directory; - **regex incl** - a regular [expression](/manual/regular_expressions#overview) describing the name pattern of the entity (file, directory, symbolic link) to include; include all if empty (default value); - **regex excl** - a regular [expression](/manual/regular_expressions#overview) describing the name pattern of the entity (file, directory, symbolic link) to exclude; don't exclude any if empty (default value); - **types incl** - directory entry types to list, possible values: *file* - regular file, *dir* - subdirectory, *sym* - symbolic link, *sock* - socket, *bdev* - block device, *cdev* - character device, *fifo* - FIFO, *dev* - synonymous with "bdev,cdev", *all* - all types (default), i.e. "file,dir,sym,sock,bdev,cdev,fifo". Multiple types must be separated with comma and quoted. - **types excl** - directory entry types (see `types incl`) to NOT list. If some entry type is in both `types incl` and `types excl`, directory entries of this type are NOT listed. - **max depth** - the maximum depth of subdirectories to traverse:
**-1** (default) - unlimited,
**0** - no descending into subdirectories. - **min size** - the minimum size (in bytes) for file to be listed. Smaller files will not be listed. [Memory suffixes](/manual/appendix/suffixes#memory-size-suffixes) can be used. - **max size** - the maximum size (in bytes) for file to be listed. Larger files will not be listed. [Memory suffixes](/manual/appendix/suffixes#memory-size-suffixes) can be used. - **min age** - the minimum age (in seconds) of directory entry to be listed. More recent entries will not be listed. [Time suffixes](/manual/appendix/suffixes#time-suffixes) can be used. - **max age** - the maximum age (in seconds) of directory entry to be listed. Entries so old and older will not be listed (modification time). [Time suffixes](/manual/appendix/suffixes#time-suffixes) can be used. - **regex excl dir** - a regular [expression](/manual/regular_expressions#overview) describing the name pattern of the directory to exclude. All content of the directory will be excluded (in contrast to `regex excl`) Comments: - On Windows, this item follows UNC paths, which can be a [security risk](/manual/best_practices/security/access_control#unc-path-access-on-windows-by-zabbix-agent); - Environment variables, e.g. %APP_HOME%, $HOME and %TEMP% are not supported; - Pseudo-directories "." and ".." are never listed; - Symbolic links are never followed for directory traversal; - Both `regex incl` and `regex excl` are being applied to files and directories when generating the entry list, but are ignored when picking subdirectories to traverse (if `regex incl` is "(?i)\^.+\\.zip$" and `max depth` is not set, then all subdirectories will be traversed, but only the files of type zip will be counted). - The execution time is limited by the timeout value in agent [configuration](/manual/appendix/config/zabbix_agentd#timeout). Since large directory traversal may take longer than that, no data will be returned and the item will turn unsupported. Partial list will not be returned. - When filtering by size, only regular files have meaningful sizes. Under Linux and BSD, directories also have non-zero sizes (a few Kb typically). Devices have zero sizes, e.g. the size of **/dev/sda1** does not reflect the respective partition size. Therefore, when using `min size` and `max size`, it is advisable to specify `types incl` as "*file*", to avoid surprises. Examples: ```default vfs.dir.get[/dev] #retrieves the device list in /dev (Linux) vfs.dir.get["C:\Users\ADMINI~1\AppData\Local\Temp"] #retrieves the file list in a temporary directory ``` [comment]: # ({/82ed1999-4a354b20}) [comment]: # ({8ac8c233-c1571da2}) ##### vfs.dir.size[dir,,,,,] {#vfs.dir.size}
The directory size (in bytes).
Return value: *Integer*.
[Supported platforms](#supported-platforms): Linux, Windows. The item may work on other UNIX-like platforms. Parameters: - **dir** - the absolute path to directory; - **regex incl** - a regular [expression](/manual/regular_expressions#overview) describing the name pattern of the entity (file, directory, symbolic link) to include; include all if empty (default value); - **regex excl** - a regular [expression](/manual/regular_expressions#overview) describing the name pattern of the entity (file, directory, symbolic link) to exclude; don't exclude any if empty (default value); - **mode** - possible values: *apparent* (default) - gets apparent file sizes rather than disk usage (acts as `du -sb dir`), *disk* - gets disk usage (acts as `du -s -B1 dir`). Unlike the `du` command, the vfs.dir.size item takes hidden files in account when calculating the directory size (acts as `du -sb .[^.]* *` within dir). - **max depth** - the maximum depth of subdirectories to traverse: **-1** (default) - unlimited, **0** - no descending into subdirectories. - **regex excl dir** - a regular [expression](/manual/regular_expressions#overview) describing the name pattern of the directory to exclude. All content of the directory will be excluded (in contrast to `regex excl`) Comments: - On Windows, this item follows UNC paths, which can be a [security risk](/manual/best_practices/security/access_control#unc-path-access-on-windows-by-zabbix-agent); - Only directories with at least the read permission for *zabbix* user are calculated. For directories with read permission only, the size of the directory itself is calculated. Directories with read & execute permissions are calculated including contents. - With large directories or slow drives this item may time out due to the Timeout setting in [agent](/manual/appendix/config/zabbix_agentd) and [server](/manual/appendix/config/zabbix_server)/[proxy](/manual/appendix/config/zabbix_proxy) configuration files. Increase the timeout values as necessary. - The file size limit depends on [large file support](/manual/appendix/items/large_file_support). Examples: ```default vfs.dir.size[/tmp,log] #calculates the size of all files in /tmp containing 'log' in their names vfs.dir.size[/tmp,log,^.+\.old$] #calculates the size of all files in /tmp containing 'log' in their names, excluding files with names ending with '.old' ``` [comment]: # ({/8ac8c233-c1571da2}) [comment]: # ({50995de0-44cb41f6}) ##### vfs.file.cksum[file,] {#vfs.file.cksum}
The file checksum, calculated by the UNIX cksum algorithm.
Return value: *Integer* - with `mode` as *crc32*, *String* - with `mode` as *md5*, *sha256*.
See [supported platforms](#supported-platforms). Parameters: - **file** - the full path to file; - **mode** - *crc32* (default), *md5*, or *sha256*. Comments: - On Windows, this item follows UNC paths, which can be a [security risk](/manual/best_practices/security/access_control#unc-path-access-on-windows-by-zabbix-agent); - The file size limit depends on [large file support](/manual/appendix/items/large_file_support). Example: ```default vfs.file.cksum[/etc/passwd] ``` Examples of returned values (crc32/md5/sha256 respectively): ```default 675436101 9845acf68b73991eb7fd7ee0ded23c44 ae67546e4aac995e5c921042d0cf0f1f7147703aa42bfbfb65404b30f238f2dc ``` [comment]: # ({/50995de0-44cb41f6}) [comment]: # ({c426ad8f-0f4f51a1}) ##### vfs.file.contents[file,] {#vfs.file.contents}
Retrieving the contents of a file^**[7](#footnotes)**^.
Return value: *Text*.
See [supported platforms](#supported-platforms). Parameters: - **file** - the full path to file; - **encoding** - the code page [identifier](/manual/config/items/itemtypes/zabbix_agent#encoding-settings). Comments: - On Windows, this item follows UNC paths, which can be a [security risk](/manual/best_practices/security/access_control#unc-path-access-on-windows-by-zabbix-agent); - The return value is limited to 16MB (including trailing whitespace that is truncated); [database limits](/manual/config/items/item#text-data-limits) also apply; - An empty string is returned if the file is empty or contains LF/CR characters only; - The byte order mark (BOM) is excluded from the output. Example: ```default vfs.file.contents[/etc/passwd] ``` [comment]: # ({/c426ad8f-0f4f51a1}) [comment]: # ({f808b303-cb77c4fb}) ##### vfs.file.exists[file,,] {#vfs.file.exists}
Checks if the file exists.
Return value: 0 - not found; 1 - file of the specified type exists.
See [supported platforms](#supported-platforms). Parameters: - **file** - the full path to file; - **types incl** - the list of file types to include, possible values: *file* (regular file, default (if types\_excl is not set)), *dir* (directory), *sym* (symbolic link), *sock* (socket), *bdev* (block device), *cdev* (character device), *fifo* (FIFO), *dev* (synonymous with "bdev,cdev"), *all* (all mentioned types, default if types\_excl is set). - **types excl** - the list of file types to exclude, see types_incl for possible values (by default no types are excluded) Comments: - On Windows, this item follows UNC paths, which can be a [security risk](/manual/best_practices/security/access_control#unc-path-access-on-windows-by-zabbix-agent); - Multiple types must be separated with a comma and the entire set enclosed in quotes ""; - If the same type is in both and , files of this type are excluded; - The file size limit depends on [large file support](/manual/appendix/items/large_file_support). Examples: ```default vfs.file.exists[/tmp/application.pid] vfs.file.exists[/tmp/application.pid,"file,dir,sym"] vfs.file.exists[/tmp/application_dir,dir] ``` [comment]: # ({/f808b303-cb77c4fb}) [comment]: # ({d7e06106-12c8307e}) ##### vfs.file.get[file] {#vfs.file.get}
Returns information about a file.
Return value: *JSON object*.
See [supported platforms](#supported-platforms). Parameter: - **file** - the full path to file Comments: - On Windows, this item follows UNC paths, which can be a [security risk](/manual/best_practices/security/access_control#unc-path-access-on-windows-by-zabbix-agent); - Supported file types on UNIX-like systems: regular file, directory, symbolic link, socket, block device, character device, FIFO. - The file size limit depends on [large file support](/manual/appendix/items/large_file_support). Example: ```default vfs.file.get[/etc/passwd] #return a JSON with information about the /etc/passwd file (type, user, permissions, SID, uid etc) ``` [comment]: # ({/d7e06106-12c8307e}) [comment]: # ({ede72ea9-731f3af2}) ##### vfs.file.md5sum[file] {#vfs.file.md5sum}
The MD5 checksum of file.
Return value: Character string (MD5 hash of the file).
See [supported platforms](#supported-platforms). Parameter: - **file** - the full path to file Comments: - On Windows, this item follows UNC paths, which can be a [security risk](/manual/best_practices/security/access_control#unc-path-access-on-windows-by-zabbix-agent); - The file size limit depends on [large file support](/manual/appendix/items/large_file_support). Example: ```default vfs.file.md5sum[/usr/local/etc/zabbix_agentd.conf] ``` Example of returned value: ```default b5052decb577e0fffd622d6ddc017e82 ``` [comment]: # ({/ede72ea9-731f3af2}) [comment]: # ({995cbe7a-c191e68e}) ##### vfs.file.owner[file,,] {#vfs.file.owner}
Retrieves the owner of a file.
Return value: *String*.
See [supported platforms](#supported-platforms). Parameters: - **file** - the full path to file; - **ownertype** - *user* (default) or *group* (Unix only); - **resulttype** - *name* (default) or *id*; for id - return uid/gid on Unix, SID on Windows. Comments: - On Windows, this item follows UNC paths, which can be a [security risk](/manual/best_practices/security/access_control#unc-path-access-on-windows-by-zabbix-agent); - The file size limit depends on [large file support](/manual/appendix/items/large_file_support). Examples: ```default vfs.file.owner[/tmp/zabbix_server.log] #return the file owner of /tmp/zabbix_server.log vfs.file.owner[/tmp/zabbix_server.log,,id] #return the file owner ID of /tmp/zabbix_server.log ``` [comment]: # ({/995cbe7a-c191e68e}) [comment]: # ({630f07da-781f8e91}) ##### vfs.file.permissions[file] {#vfs.file.permissions}
Return a 4-digit string containing the octal number with UNIX permissions.
Return value: *String*.
[Supported platforms](#supported-platforms): Linux. The item may work on other UNIX-like platforms. Parameters: - **file** - the full path to file The file size limit depends on [large file support](/manual/appendix/items/large_file_support). Example: ```default vfs.file.permissions[/etc/passwd] #return permissions of /etc/passwd, for example, '0644' ``` [comment]: # ({/630f07da-781f8e91}) [comment]: # ({6fb64cef-679ce640}) ##### vfs.file.regexp[file,regexp,,,,] {#vfs.file.regexp}
Retrieve a string in the file^**[7](#footnotes)**^.
Return value: The line containing the matched string, or as specified by the optional `output` parameter.
See [supported platforms](#supported-platforms). Parameters: - **file** - the full path to file; - **regexp** - a regular [expression](/manual/regular_expressions#overview) describing the required pattern; - **encoding** - the code page [identifier](/manual/config/items/itemtypes/zabbix_agent#encoding-settings); - **start line** - the number of the first line to search (first line of file by default); - **end line** - the number of the last line to search (last line of file by default); - **output** - an optional output formatting template. The **\\0** escape sequence is replaced with the matched part of text (from the first character where match begins until the character where match ends) while an **\\N** (where N=1...9) escape sequence is replaced with Nth matched group (or an empty string if the N exceeds the number of captured groups). Comments: - On Windows, this item follows UNC paths, which can be a [security risk](/manual/best_practices/security/access_control#unc-path-access-on-windows-by-zabbix-agent); - The file size limit depends on [large file support](/manual/appendix/items/large_file_support). - Only the first matching line is returned; - An empty string is returned if no line matched the expression; - The byte order mark (BOM) is excluded from the output; - Content extraction using the `output` parameter takes place on the agent. Examples: ```default vfs.file.regexp[/etc/passwd,zabbix] vfs.file.regexp[/path/to/some/file,"([0-9]+)$",,3,5,\1] vfs.file.regexp[/etc/passwd,"^zabbix:.:([0-9]+)",,,,\1] → getting the ID of user *zabbix* ``` [comment]: # ({/6fb64cef-679ce640}) [comment]: # ({3ce8c47b-5216f821}) ##### vfs.file.regmatch[file,regexp,,,] {#vfs.file.regmatch}
Find a string in the file^**[7](#footnotes)**^.
Return values: 0 - match not found; 1 - found.
See [supported platforms](#supported-platforms). Parameters: - **file** - the full path to file; - **regexp** - a regular [expression](/manual/regular_expressions#overview) describing the required pattern; - **encoding** - the code page [identifier](/manual/config/items/itemtypes/zabbix_agent#encoding-settings); - **start line** - the number of the first line to search (first line of file by default); - **end line** - the number of the last line to search (last line of file by default). Comments: - On Windows, this item follows UNC paths, which can be a [security risk](/manual/best_practices/security/access_control#unc-path-access-on-windows-by-zabbix-agent); - The file size limit depends on [large file support](/manual/appendix/items/large_file_support). - The byte order mark (BOM) is ignored. Example: ```default vfs.file.regmatch[/var/log/app.log,error] ``` [comment]: # ({/3ce8c47b-5216f821}) [comment]: # ({3a0726ba-705b33c8}) ##### vfs.file.size[file,] {#vfs.file.size}
The file size (in bytes).
Return value: *Integer*.
See [supported platforms](#supported-platforms). Parameters: - **file** - the full path to file; - **mode** - possible values: *bytes* (default) or *lines* (empty lines are counted, too). Comments: - On Windows, this item follows UNC paths, which can be a [security risk](/manual/best_practices/security/access_control#unc-path-access-on-windows-by-zabbix-agent); - The file must have read permissions for user *zabbix*; - The file size limit depends on [large file support](/manual/appendix/items/large_file_support). Example: ```default vfs.file.size[/var/log/syslog] ``` [comment]: # ({/3a0726ba-705b33c8}) [comment]: # ({24c104b4-d590c33f}) ##### vfs.file.time[file,] {#vfs.file.time}
The file time information.
Return value: *Integer* (Unix timestamp).
See [supported platforms](#supported-platforms). Parameters: - **file** - the full path to file; - **mode** - possible values:
*modify* (default) - the last time of modifying file content,
*access* - the last time of reading file,
*change* - the last time of changing file properties Comments: - On Windows, this item follows UNC paths, which can be a [security risk](/manual/best_practices/security/access_control#unc-path-access-on-windows-by-zabbix-agent); - The file size limit depends on [large file support](/manual/appendix/items/large_file_support). Example: ```default vfs.file.time[/etc/passwd,modify] ``` [comment]: # ({/24c104b4-d590c33f}) [comment]: # ({96a8d12e-5c6f1f9c}) ##### vfs.fs.discovery {#vfs.fs.discovery}
The list of mounted filesystems with their type and mount options. Used for low-level discovery.
Return value: *JSON object*.
[Supported platforms](#supported-platforms): Linux, FreeBSD, Solaris, HP-UX, AIX, MacOS X, OpenBSD, NetBSD, Windows. [comment]: # ({/96a8d12e-5c6f1f9c}) [comment]: # ({9a40552f-dee74854}) ##### vfs.fs.get {#vfs.fs.get}
The list of mounted filesystems with their type, available disk space, inode statistics and mount options. Can be used for low-level discovery.
Return value: *JSON object*.
[Supported platforms](#supported-platforms): Linux, FreeBSD, Solaris, HP-UX, AIX, MacOS X, OpenBSD, NetBSD, Windows. Comments: - File systems with the inode count equal to zero, which can be the case for file systems with dynamic inodes (e.g. btrfs), are also reported; - See also: [Discovery of mounted filesystems](/manual/discovery/low_level_discovery/examples/mounted_filesystems). [comment]: # ({/9a40552f-dee74854}) [comment]: # ({fdf19acf-c1ad7314}) ##### vfs.fs.inode[fs,] {#vfs.fs.inode}
The number or percentage of inodes.
Return value: *Integer* - for number; *Float* - for percentage.
See [supported platforms](#supported-platforms). Parameters: - **fs** - the filesystem; - **mode** - possible values: *total* (default), *free*, *used*, *pfree* (free, percentage), or *pused* (used, percentage). If the inode count equals zero, which can be the case for file systems with dynamic inodes (e.g. btrfs), the pfree/pused values will be reported as "100" and "0" respectively. Example: ```default vfs.fs.inode[/,pfree] ``` [comment]: # ({/fdf19acf-c1ad7314}) [comment]: # ({c4232422-2aa216f1}) ##### vfs.fs.size[fs,] {#vfs.fs.size}
The disk space in bytes or in percentage from total.
Return value: *Integer* - for bytes; *Float* - for percentage.
See [supported platforms](#supported-platforms). Parameters: - **fs** - the filesystem; - **mode** - possible values: *total* (default), *free*, *used*, *pfree* (free, percentage), or *pused* (used, percentage). Comments: - If the filesystem is not mounted, returns the size of a local filesystem where the mount point is located; - The reserved space of a file system is taken into account and not included when using the *free* mode. Example: ```default vfs.fs.size[/tmp,free] ``` [comment]: # ({/c4232422-2aa216f1}) [comment]: # ({992ae7f8-07413e69}) ##### vm.memory.size[] {#vm.memory.size}
The memory size in bytes or in percentage from total.
Return value: *Integer* - for bytes; *Float* - for percentage.
See [supported platforms](#supported-platforms). Parameter: - **mode** - possible values: *total* (default), *active*, *anon*, *buffers*, *cached*, *exec*, *file*, *free*, *inactive*, *pinned*, *shared*, *slab*, *wired*, *used*, *pused* (used, percentage), *available*, or *pavailable* (available, percentage). Comments: - This item accepts three categories of parameters:
- *total* - total amount of memory; - platform-specific memory types: *active*, *anon*, *buffers*, *cached*, *exec*, *file*, *free*, *inactive*, *pinned*, *shared*, *slab*, *wired*; - user-level estimates on how much memory is used and available: *used*, *pused*, *available*, *pavailable*; - The *active* mode parameter is supported only on FreeBSD, HP-UX, MacOS X, OpenBSD, NetBSD; - The *anon*, *exec*, *file* mode parameters are supported only on NetBSD; - The *buffers* mode parameter is supported only on Linux, FreeBSD, OpenBSD, NetBSD; - The *cached* mode parameter is supported only on Linux, FreeBSD, AIX, OpenBSD, NetBSD; - The *inactive*, *wired* mode parameters are supported only on FreeBSD, MacOS X, OpenBSD, NetBSD; - The *pinned* mode parameter is supported only on AIX; - The *shared* mode parameter is supported only on Linux 2.4, FreeBSD, OpenBSD, NetBSD; - See also [additional details](/manual/appendix/items/vm.memory.size_params) for this item. Example: ```default vm.memory.size[pavailable] ``` [comment]: # ({/992ae7f8-07413e69}) [comment]: # ({2a3fbd6e-cd3defd2}) ##### web.page.get[host,,] {#web.page.get}
Get the content of a web page.
Return value: Web page source as text (including headers).
See [supported platforms](#supported-platforms). Parameters: - **host** - the hostname or URL (as `scheme://host:port/path`, where only *host* is mandatory). Allowed URL schemes: *http*, *https*^**[4](#footnotes)**^. A missing scheme will be treated as *http*. If a URL is specified `path` and `port` must be empty. Specifying user name/password when connecting to servers that require authentication, for example: `http://user:password@www.example.com` is only possible with cURL support ^**[4](#footnotes)**^. [Punycode](https://en.wikipedia.org/wiki/Punycode) is supported in hostnames. - **path** - the path to an HTML document (default is /); - **port** - the port number (default is 80 for HTTP) Comments: - This item turns unsupported if the resource specified in `host` does not exist or is unavailable; - `host` can be a hostname, domain name, IPv4 or IPv6 address. But for IPv6 address Zabbix agent must be compiled with IPv6 support enabled. Examples: ```default web.page.get[www.example.com,index.php,80] web.page.get[https://www.example.com] web.page.get[https://blog.example.com/?s=zabbix] web.page.get[localhost:80] web.page.get["[::1]/server-status"] ``` [comment]: # ({/2a3fbd6e-cd3defd2}) [comment]: # ({27e5419e-ef902e6e}) ##### web.page.perf[host,,] {#web.page.perf}
The loading time of a full web page (in seconds).
Return value: *Float*.
See [supported platforms](#supported-platforms). Parameters: - **host** - the hostname or URL (as `scheme://host:port/path`, where only *host* is mandatory). Allowed URL schemes: *http*, *https*^**[4](#footnotes)**^. A missing scheme will be treated as *http*. If a URL is specified `path` and `port` must be empty. Specifying user name/password when connecting to servers that require authentication, for example: `http://user:password@www.example.com` is only possible with cURL support ^**[4](#footnotes)**^. Punycode is supported in hostnames. - **path** - the path to an HTML document (default is /); - **port** - the port number (default is 80 for HTTP) Comments: - This item turns unsupported if the resource specified in `host` does not exist or is unavailable; - `host` can be a hostname, domain name, IPv4 or IPv6 address. But for IPv6 address Zabbix agent must be compiled with IPv6 support enabled. Examples: ```default web.page.perf[www.example.com,index.php,80] web.page.perf[https://www.example.com] ``` [comment]: # ({/27e5419e-ef902e6e}) [comment]: # ({e7d1f328-a78ae078}) ##### web.page.regexp[host,,,regexp,,] {#web.page.regexp}
Find a string on the web page.
Return value: The matched string, or as specified by the optional `output` parameter.
See [supported platforms](#supported-platforms). Parameters: - **host** - the hostname or URL (as `scheme://host:port/path`, where only *host* is mandatory). Allowed URL schemes: *http*, *https*^**[4](#footnotes)**^. A missing scheme will be treated as *http*. If a URL is specified `path` and `port` must be empty. Specifying user name/password when connecting to servers that require authentication, for example: `http://user:password@www.example.com` is only possible with cURL support ^**[4](#footnotes)**^. Punycode is supported in hostnames. - **path** - the path to an HTML document (default is /); - **port** - the port number (default is 80 for HTTP) - **regexp** - a regular [expression](/manual/regular_expressions#overview) describing the required pattern; - **length** - the maximum number of characters to return; - **output** - an optional output formatting template. The **\\0** escape sequence is replaced with the matched part of text (from the first character where match begins until the character where match ends) while an **\\N** (where N=1...9) escape sequence is replaced with Nth matched group (or an empty string if the N exceeds the number of captured groups). Comments: - This item turns unsupported if the resource specified in `host` does not exist or is unavailable; - `host` can be a hostname, domain name, IPv4 or IPv6 address. But for IPv6 address Zabbix agent must be compiled with IPv6 support enabled. - Content extraction using the `output` parameter takes place on the agent. Examples: ```default web.page.regexp[www.example.com,index.php,80,OK,2] web.page.regexp[https://www.example.com,,,OK,2] ``` [comment]: # ({/e7d1f328-a78ae078}) [comment]: # ({634d9a4e-3030d112}) ##### agent.hostmetadata {#agent.hostmetadata}
The agent host metadata.
Return value: *String*.
See [supported platforms](#supported-platforms). Returns the value of [HostMetadata](/manual/appendix/config/zabbix_agentd#hostmetadata) or [HostMetadataItem](/manual/appendix/config/zabbix_agentd#hostmetadataitem) parameters, or empty string if none are defined. [comment]: # ({/634d9a4e-3030d112}) [comment]: # ({48e98549-e20fbf57}) ##### agent.hostname {#agent.hostname}
The agent host name.
Return value: *String*.
See [supported platforms](#supported-platforms). Returns: - As passive check - the name of the first host listed in the [Hostname](/manual/appendix/config/zabbix_agentd#hostname) parameter of the agent configuration file; - As active check - the name of the current hostname. [comment]: # ({/48e98549-e20fbf57}) [comment]: # ({16f6a0c6-3a10c7e2}) ##### agent.ping {#agent.ping}
The agent availability check.
Return value: Nothing - unavailable; 1 - available.
See [supported platforms](#supported-platforms). Use the **nodata()** trigger function to check for host unavailability. [comment]: # ({/16f6a0c6-3a10c7e2}) [comment]: # ({f3b2b036-d276be7d}) ##### agent.variant {#agent.variant}
The variant of Zabbix agent (Zabbix agent or Zabbix agent 2).
Return value: 1 - Zabbix agent; 2 - Zabbix agent 2.
See [supported platforms](#supported-platforms). [comment]: # ({/f3b2b036-d276be7d}) [comment]: # ({77e624b5-f391e3aa}) ##### agent.version {#agent.version}
The version of Zabbix agent.
Return value: *String*.
See [supported platforms](#supported-platforms). Example of returned value: ```default 6.0.3 ``` [comment]: # ({/77e624b5-f391e3aa}) [comment]: # ({819350bc-31497288}) ##### zabbix.stats[,] {#zabbix.stats}
Returns a set of Zabbix server or proxy internal metrics. If `ip` and `port` are specified, metrics are retrieved from the remote instance; otherwise, from the local instance.
Return value: *JSON object*.
See [supported platforms](#supported-platforms). Parameters: - **ip** - the IP/DNS/network mask list of servers/proxies to be remotely queried (default is 127.0.0.1); - **port** - the port of server/proxy to be remotely queried (default is 10051) Comments: - A selected set of internal metrics is returned by this item. For details, see [Remote monitoring of Zabbix stats](/manual/appendix/items/remote_stats#exposed-metrics); - Note that the stats request will only be accepted from the addresses listed in the 'StatsAllowedIP' [server](/manual/appendix/config/zabbix_server)/[proxy](/manual/appendix/config/zabbix_proxy) parameter on the target instance. [comment]: # ({/819350bc-31497288}) [comment]: # ({1e463e1d-ea79fb35}) ##### zabbix.stats[,,queue,,] {#zabbix.stats.two}
Returns the number of monitored items in the queue which are delayed on Zabbix server or proxy. If `ip` and `port` are specified, metrics are retrieved from the remote instance; otherwise, from the local instance.
Return value: *JSON object*.
See [supported platforms](#supported-platforms). Parameters: - **ip** - the IP/DNS/network mask list of servers/proxies to be remotely queried (default is 127.0.0.1); - **port** - the port of server/proxy to be remotely queried (default is 10051) - **queue** - constant (to be used as is) - **from** - delayed by at least (default is 6 seconds) - **to** - delayed by at most (default is infinity) Note that the stats request will only be accepted from the addresses listed in the 'StatsAllowedIP' [server](/manual/appendix/config/zabbix_server)/[proxy](/manual/appendix/config/zabbix_proxy) parameter on the target instance. [comment]: # ({/1e463e1d-ea79fb35}) [comment]: # ({b49a16e9-a2a6198d}) #### Footnotes ^**1**^A Linux-specific note. Zabbix agent must have read-only access to filesystem */proc*. Kernel patches from www.grsecurity.org limit access rights of non-privileged users. ^**2**^ `vfs.dev.read[]`, `vfs.dev.write[]`: Zabbix agent will terminate "stale" device connections if the item values are not accessed for more than 3 hours. This may happen if a system has devices with dynamically changing paths or if a device gets manually removed. Note also that these items, if using an update interval of 3 hours or more, will always return '0'. ^**3**^ `vfs.dev.read[]`, `vfs.dev.write[]`: If default *all* is used for the first parameter then the key will return summary statistics, including all block devices like sda, sdb, and their partitions (sda1, sda2, sdb3...) and multiple devices (MD raid) based on those block devices/partitions and logical volumes (LVM) based on those block devices/partitions. In such cases returned values should be considered only as relative value (dynamic in time) but not as absolute values. ^**4**^ SSL (HTTPS) is supported only if agent is compiled with cURL support. Otherwise the item will turn unsupported. ^**5**^ The `bytes` and `errors` values are not supported for loopback interfaces on Solaris systems up to and including Solaris 10 6/06 as byte, error and utilization statistics are not stored and/or reported by the kernel. However, if you're monitoring a Solaris system via net-snmp, values may be returned as net-snmp carries legacy code from the cmu-snmp dated as old as 1997 that, upon failing to read byte values from the interface statistics returns the packet counter (which does exist on loopback interfaces) multiplied by an arbitrary value of 308. This makes the assumption that the average length of a packet is 308 octets, which is a very rough estimation as the MTU limit on Solaris systems for loopback interfaces is 8892 bytes. These values should not be assumed to be correct or even closely accurate. They are guestimates. Zabbix agent does not do any guess work, but net-snmp will return a value for these fields. ^**6**^ The command line on Solaris, obtained from /proc/pid/psinfo, is limited to 80 bytes and contains the command line as it was when the process was started. ^**7**^ `vfs.file.contents[]`, `vfs.file.regexp[]`, `vfs.file.regmatch[]` items can be used for retrieving file contents. If you want to restrict access to specific files with sensitive information, run Zabbix agent under a user that has no access permissions to viewing these files. [comment]: # ({/b49a16e9-a2a6198d}) [comment]: # ({bc60d97c-2e3a2e64}) ### Usage with command-line utilities Note that when testing or using item keys with zabbix_agentd or zabbix_get from the command line you should consider shell syntax too. For example, if a certain parameter of the key has to be enclosed in double quotes you have to explicitly escape double quotes, otherwise they will be trimmed by the shell as special characters and will not be passed to the Zabbix utility. Examples: ```default zabbix_agentd -t 'vfs.dir.count[/var/log,,,"file,dir",,0]' zabbix_agentd -t vfs.dir.count[/var/log,,,\"file,dir\",,0] ``` [comment]: # ({/bc60d97c-2e3a2e64}) [comment]: # ({b6df4604-b7e5172f}) ### Encoding settings To make sure that the acquired data are not corrupted you may specify the correct encoding for processing the check (e.g. 'vfs.file.contents') in the `encoding` parameter. The list of supported encodings (code page identifiers) may be found in documentation for [libiconv](http://www.gnu.org/software/libiconv/) (GNU Project) or in Microsoft Windows SDK documentation for ["Code Page Identifiers"](https://learn.microsoft.com/en-us/windows/win32/intl/code-page-identifiers). Note that Microsoft sometimes marks some code pages as "available only to managed applications" — i.e. exposed only via the .NET runtime and not available through the native Win32 APIs. Zabbix agent implements its own encoding-conversion logic, therefore those code pages are supported by Zabbix agent even when the native Windows functions do not provide them. If no encoding is specified in the `encoding` parameter the following resolution strategies are applied: - If encoding is not specified (or is an empty string) it is assumed to be UTF-8, the data is processed "as-is"; - BOM analysis - applicable for items 'vfs.file.contents', 'vfs.file.regexp', 'vfs.file.regmatch'. An attempt is made to determine the correct encoding by using the byte order mark (BOM) at the beginning of the file. If BOM is not present - standard resolution (see above) is applied instead. [comment]: # ({/b6df4604-b7e5172f}) [comment]: # ({4f4d51c0-40450e88}) ### Troubleshooting agent items In case of passive checks, to prevent that item does not get any value because the server request to the agent times out first, the following should be noted: - Where agent version is older than server version, the *Timeout* value in the [item configuration](/manual/config/items/item#configuration) (or [global timeout](/manual/web_interface/frontend_sections/administration/general#timeouts)) may need to be higher than the `Timeout` value in the agent [configuration file](/manual/appendix/config/zabbix_agentd#timeout). - Where agent version is newer than server version, the `Timeout` value in the server [configuration file](/manual/appendix/config/zabbix_server#timeout) may need to be higher than the `Timeout` value in the agent [configuration file](/manual/appendix/config/zabbix_agentd#timeout). [comment]: # ({/4f4d51c0-40450e88})