manual:config:items:itemtypes:zabbix_agent

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Last revision Both sides next revision
manual:config:items:itemtypes:zabbix_agent [2015/04/22 12:50]
asaveljevs net.tcp.service(.perf)[ntp]
manual:config:items:itemtypes:zabbix_agent [2016/12/07 09:23]
martins-v removing formatting that is not used in this table
Line 42: Line 42:
 | ||||| | |||||
 ^log[file,<​regexp>,<​encoding>,<​maxlines>,<​mode>​] ​ ^^^^^ ^log[file,<​regexp>,<​encoding>,<​maxlines>,<​mode>​] ​ ^^^^^
-^ |Monitoring of log file.  |Log  |**file** - full path and name of log file\\ **regexp** - regular expression describing the required pattern\\ **encoding** - code page identifier\\ **maxlines** - maximum number of new lines per second the agent will send to Zabbix server or proxy. This parameter overrides the value of '​MaxLinesPerSecond'​ in [[manual:​appendix:​config:​zabbix_agentd|zabbix_agentd.conf]]\\ **mode** - possible values:\\ //all// (default), //​skip// ​(skip processing of older data).\\ The **mode** parameter is supported from version 2.0.  |The item must be configured as an [[manual:​appendix:​items:​activepassive#​active_checks|active check]].\\ If file is missing or permissions do not allow access, item turns unsupported.\\ //Example key//: \\ log[/​home/​zabbix/​logs/​logfile,,,​100] \\ See a more [[log_items|detailed description]]. ​ |+^ |Monitoring of log file.  |Log  |**file** - full path and name of log file\\ **regexp** - regular expression describing the required pattern\\ **encoding** - code page [[:​manual/​config/​items/​itemtypes/​zabbix_agent#​available_encodings|identifier]]\\ **maxlines** - maximum number of new lines per second the agent will send to Zabbix server or proxy. This parameter overrides the value of '​MaxLinesPerSecond'​ in [[manual:​appendix:​config:​zabbix_agentd|zabbix_agentd.conf]]\\ **mode** - possible values:\\ //all// (default), //​skip// ​skip processing of older data (affects only newly created items that have not returned any data yet).\\ The **mode** parameter is supported from version 2.0.  |The item must be configured as an [[manual:​appendix:​items:​activepassive#​active_checks|active check]].\\ If file is missing or permissions do not allow access, item turns unsupported.\\ //Example key//: \\ log[/​home/​zabbix/​logs/​logfile,,,​100] \\ See a more [[log_items|detailed description]]. ​ |
 | ||||| | |||||
 ^logrt[file_regexp,<​regexp>,<​encoding>,<​maxlines>,<​mode>​] ​ ^^^^^ ^logrt[file_regexp,<​regexp>,<​encoding>,<​maxlines>,<​mode>​] ​ ^^^^^
-^ |Monitoring of log file with log rotation support. ​ |Log  |**file_regexp** - absolute path to file and regexp describing the file name pattern\\ **regexp** - regular expression describing the required content pattern\\ **encoding** - code page identifier\\ **maxlines** - maximum number of new lines per second the agent will send to Zabbix server or proxy. This parameter overrides the value of '​MaxLinesPerSecond'​ in [[manual:​appendix:​config:​zabbix_agentd|zabbix_agentd.conf]]\\ **mode** - possible values:\\ //all// (default), //​skip// ​(skip processing of older data).\\ The **mode** parameter is supported from version 2.0.  |The item must be configured as an [[manual:​appendix:​items:​activepassive#​active_checks|active check]].\\ \\ //​Examples//:​ \\ %%logrt["/​home/​zabbix/​logs/​^logfile[0-9]{1,​3}$",,,​100] - will match a file like "​logfile1"​ (will not match "​.logfile1"​)%%\\ %%logrt["/​home/​user/​^logfile_.*_[0-9]{1,​3}$","​pattern_to_match","​UTF-8",​100]%% - will collect data from files such "​logfile_abc_1"​ or "​logfile__001"​.\\ \\ Log rotation is based on the last modification time of files.\\ See a more [[log_items|detailed description]]. ​ |+^ |Monitoring of log file with log rotation support. ​ |Log  |**file_regexp** - absolute path to file and regexp describing the file name pattern\\ **regexp** - regular expression describing the required content pattern\\ **encoding** - code page [[:​manual/​config/​items/​itemtypes/​zabbix_agent#​available_encodings|identifier]]\\ **maxlines** - maximum number of new lines per second the agent will send to Zabbix server or proxy. This parameter overrides the value of '​MaxLinesPerSecond'​ in [[manual:​appendix:​config:​zabbix_agentd|zabbix_agentd.conf]]\\ **mode** - possible values:\\ //all// (default), //​skip// ​skip processing of older data (affects only newly created items that have not returned any data yet).\\ The **mode** parameter is supported from version 2.0.  |The item must be configured as an [[manual:​appendix:​items:​activepassive#​active_checks|active check]].\\ \\ //​Examples//:​ \\ %%logrt["/​home/​zabbix/​logs/​^logfile[0-9]{1,​3}$",,,​100] - will match a file like "​logfile1"​ (will not match "​.logfile1"​)%%\\ %%logrt["/​home/​user/​^logfile_.*_[0-9]{1,​3}$","​pattern_to_match","​UTF-8",​100]%% - %%will collect data from files such "​logfile_abc_1"​ or "​logfile__001"​.%%\\ \\ Log rotation is based on the last modification time of files.\\ See a more [[log_items|detailed description]]. ​ |
 | ||||| | |||||
-^net.dns[<​ip>,​zone,<​type>,<​timeout>,<​count>​] ​ ^^^^^ +^net.dns[<​ip>,​name,<​type>,<​timeout>,<​count>​] ​ ^^^^^ 
-^ |Checks if DNS service is up.  |0 - DNS is down (server did not respond or DNS resolution failed)\\ \\ 1 - DNS is up  |**ip** - IP address of DNS server (leave empty for the default DNS server, ignored on Windows)\\ **zone** - zone to test the DNS\\ **type** - record type to be queried (default is SOA)\\ **timeout** (ignored on Windows) - timeout for the request in seconds (default is 1 second)\\ **count** (ignored on Windows) - number of tries for the request (default is 2)  |//Example key//:\\ net.dns[8.8.8.8,​zabbix.com,​MX,​2,​1] \\ \\ The possible values for **type** are: \\ ANY, A, NS, CNAME, MB, MG, MR, PTR, MD, MF, MX, SOA, NULL, WKS (except for Windows), HINFO, MINFO, TXT, SRV\\ \\ SRV record type is supported since Zabbix agent versions 1.8.6 (Unix) and 2.0.0 (Windows).\\ \\ Internationalized domain names are not supported, please use IDNA encoded names instead.\\ \\ Naming before Zabbix 2.0 (still supported): //​net.tcp.dns//​|+^ |Checks if DNS service is up.  |0 - DNS is down (server did not respond or DNS resolution failed)\\ \\ 1 - DNS is up  |**ip** - IP address of DNS server (leave empty for the default DNS server, ignored on Windows)\\ **name** - DNS name to query\\ **type** - record type to be queried (default is SOA)\\ **timeout** (ignored on Windows) - timeout for the request in seconds (default is 1 second)\\ **count** (ignored on Windows) - number of tries for the request (default is 2)  |//Example key//:\\ net.dns[8.8.8.8,​zabbix.com,​MX,​2,​1] \\ \\ The possible values for **type** are: \\ ANY, A, NS, CNAME, MB, MG, MR, PTR, MD, MF, MX, SOA, NULL, WKS (except for Windows), HINFO, MINFO, TXT, SRV\\ \\ SRV record type is supported since Zabbix agent versions 1.8.6 (Unix) and 2.0.0 (Windows).\\ \\ Internationalized domain names are not supported, please use IDNA encoded names instead.\\ \\ Naming before Zabbix 2.0 (still supported): //​net.tcp.dns//​|
 | ||||| | |||||
-^net.dns.record[<​ip>,​zone,<​type>,<​timeout>,<​count>​] ​ ^^^^^ +^net.dns.record[<​ip>,​name,<​type>,<​timeout>,<​count>​] ​ ^^^^^ 
-^ |Performs a DNS query. ​ |Character string with the required type of information ​ |**ip** - IP address of DNS server (leave empty for the default DNS server, ignored on Windows)\\ **zone** - zone to test the DNS\\ **type** - record type to be queried (default is SOA)\\ **timeout** (ignored on Windows) - timeout for the request in seconds (default is 1 second)\\ **count** (ignored on Windows) - number of tries for the request (default is 2)  |//Example key//:\\ net.dns.record[8.8.8.8,​zabbix.com,​MX,​2,​1] \\ \\ The possible values for **type** are: \\ ANY, A, NS, CNAME, MB, MG, MR, PTR, MD, MF, MX, SOA, NULL, WKS (except for Windows), HINFO, MINFO, TXT, SRV\\ \\ SRV record type is supported since Zabbix agent versions 1.8.6 (Unix) and 2.0.0 (Windows).\\ \\ Internationalized domain names are not supported, please use IDNA encoded names instead.\\ \\ Naming before Zabbix 2.0 (still supported): //​net.tcp.dns.query//​|+^ |Performs a DNS query. ​ |Character string with the required type of information ​ |**ip** - IP address of DNS server (leave empty for the default DNS server, ignored on Windows)\\ **name** - DNS name to query\\ **type** - record type to be queried (default is SOA)\\ **timeout** (ignored on Windows) - timeout for the request in seconds (default is 1 second)\\ **count** (ignored on Windows) - number of tries for the request (default is 2)  |//Example key//:\\ net.dns.record[8.8.8.8,​zabbix.com,​MX,​2,​1] \\ \\ The possible values for **type** are: \\ ANY, A, NS, CNAME, MB, MG, MR, PTR, MD, MF, MX, SOA, NULL, WKS (except for Windows), HINFO, MINFO, TXT, SRV\\ \\ SRV record type is supported since Zabbix agent versions 1.8.6 (Unix) and 2.0.0 (Windows).\\ \\ Internationalized domain names are not supported, please use IDNA encoded names instead.\\ \\ Naming before Zabbix 2.0 (still supported): //​net.tcp.dns.query//​|
 | ||||| | |||||
 ^net.if.collisions[if] ​ ^^^^^ ^net.if.collisions[if] ​ ^^^^^
Line 60: Line 60:
 | ||||| | |||||
 ^net.if.in[if,<​mode>​] ​ ^^^^^ ^net.if.in[if,<​mode>​] ​ ^^^^^
-^ |Incoming traffic statistics on network interface. ​ |Integer ​ |**if** - network interface name\\ **mode** - possible values:\\ //bytes// - number of bytes (default)\\ //packets// - number of packets\\ //errors// - number of errors\\ //dropped// - number of dropped packets ​ |Multi-byte interface names on Windows are supported since Zabbix agent version 1.8.6.\\ \\ //Example keys//:\\ net.if.in[eth0,​errors]\\ net.if.in[eth0]\\ \\ You may use this key with a //Delta (speed per second)// store value in order to get bytes per second statistics. ​ |+^ |Incoming traffic statistics on network interface. ​ |Integer ​ |**if** - network interface name (Unix); network interface full description or IPv4 address (Windows)\\ **mode** - possible values:\\ //bytes// - number of bytes (default)\\ //packets// - number of packets\\ //errors// - number of errors\\ //dropped// - number of dropped packets ​ |Multi-byte interface names on Windows are supported since Zabbix agent version 1.8.6.\\ \\ Examples:\\ => net.if.in[eth0,​errors]\\ ​=> net.if.in[eth0]\\ \\ You may obtain network interface descriptions on Windows with net.if.discovery or net.if.list items.\\ \\ You may use this key with a //Delta (speed per second)// store value in order to get bytes per second statistics. ​ |
 | ||||| | |||||
 ^net.if.out[if,<​mode>​] ​ ^^^^^ ^net.if.out[if,<​mode>​] ​ ^^^^^
-^ |Outgoing traffic statistics on network interface. ​ |Integer ​ |**if** - network interface name\\ **mode** - possible values:\\ //bytes// - number of bytes (default)\\ //packets// - number of packets\\ //errors// - number of errors\\ //dropped// - number of dropped packets ​ |Multi-byte interface names on Windows are supported since Zabbix agent 1.8.6 version.\\ \\ //Example keys//:\\ net.if.out[eth0,​errors]\\ net.if.out[eth0]\\ \\ You may use this key with a //Delta (speed per second)// store value in order to get bytes per second statistics. ​ |+^ |Outgoing traffic statistics on network interface. ​ |Integer ​ |**if** - network interface name (Unix); network interface full description or IPv4 address (Windows)\\ **mode** - possible values:\\ //bytes// - number of bytes (default)\\ //packets// - number of packets\\ //errors// - number of errors\\ //dropped// - number of dropped packets ​ |Multi-byte interface names on Windows are supported since Zabbix agent 1.8.6 version.\\ \\ Examples:\\ => net.if.out[eth0,​errors]\\ ​=> net.if.out[eth0]\\ \\ You may obtain network interface descriptions on Windows with net.if.discovery or net.if.list items.\\ \\ You may use this key with a //Delta (speed per second)// store value in order to get bytes per second statistics. ​ |
 | ||||| | |||||
 ^net.if.total[if,<​mode>​] ​ ^^^^^ ^net.if.total[if,<​mode>​] ​ ^^^^^
-^ |Sum of incoming and outgoing traffic statistics on network interface. ​ |Integer ​ |**if** - network interface name\\ **mode** - possible values:\\ //bytes// - number of bytes (default)\\ //packets// - number of packets\\ //errors// - number of errors\\ //dropped// - number of dropped packets ​ |//Example keys//:\\ net.if.total[eth0,​errors]\\ net.if.total[eth0]\\ You may use this key with a //Delta (speed per second)// store value in order to get bytes per second statistics.\\ Note that dropped packets are supported only if both net.if.in and net.if.out work for dropped packets on your platform. ​ |+^ |Sum of incoming and outgoing traffic statistics on network interface. ​ |Integer ​ |**if** - network interface name (Unix); network interface full description or IPv4 address (Windows)\\ **mode** - possible values:\\ //bytes// - number of bytes (default)\\ //packets// - number of packets\\ //errors// - number of errors\\ //dropped// - number of dropped packets ​ |Examples:\\ => net.if.total[eth0,​errors]\\ ​=> net.if.total[eth0]\\ \\ You may obtain network interface descriptions on Windows with net.if.discovery or net.if.list items.\\ ​\\ You may use this key with a //Delta (speed per second)// store value in order to get bytes per second statistics.\\ \\ Note that dropped packets are supported only if both net.if.in and net.if.out work for dropped packets on your platform. ​ |
 | ||||| | |||||
 ^net.tcp.listen[port] ​ ^^^^^ ^net.tcp.listen[port] ​ ^^^^^
Line 72: Line 72:
 | ||||| | |||||
 ^net.tcp.port[<​ip>,​port] ​ ^^^^^ ^net.tcp.port[<​ip>,​port] ​ ^^^^^
-^ |Checks if it is possible to make TCP connection to port number port.  |0 - cannot connect\\ \\ 1 - can connect ​ |**ip** - IP address(default is 127.0.0.1)\\ **port** - port number ​ |Example:\\ net.tcp.port[,​80] can be used to test availability of web server running on port 80.\\ Old naming: check_port[*]\\ For simple TCP performance testing use net.tcp.service.perf[tcp,<​ip>,<​port>​]\\ Note that these checks may result in additional messages in system daemon logfiles (SMTP and SSH sessions being logged usually).|+^ |Checks if it is possible to make TCP connection to port number port.  |0 - cannot connect\\ \\ 1 - can connect ​ |**ip** - IP address (default is 127.0.0.1)\\ **port** - port number ​ |Example:\\ net.tcp.port[,​80] can be used to test availability of web server running on port 80.\\ Old naming: check_port[*]\\ For simple TCP performance testing use net.tcp.service.perf[tcp,<​ip>,<​port>​]\\ Note that these checks may result in additional messages in system daemon logfiles (SMTP and SSH sessions being logged usually).|
 | ||||| | |||||
 ^net.tcp.service[service,<​ip>,<​port>​] ​ ^^^^^ ^net.tcp.service[service,<​ip>,<​port>​] ​ ^^^^^
-^ |Checks if service is running and accepting TCP connections. ​ |0 - service is down\\ \\ 1 - service is running ​ |**service** - either of:\\ //ssh//, //ntp//, //ldap//, //smtp//, //ftp//, //http//, //pop//, //nntp//, //imap//, //tcp//, //https//, //​telnet//​\\ **ip** - IP address (default is 127.0.0.1)\\ **port** - port number (by default standard service port number is used)  |//Example key//:\\ net.tcp.service[ftp,,​45] - can be used to test the availability of FTP server on TCP port 45.\\ Note that 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 by Windows agent is currently not supported.\\ Note that the telnet check looks for a login prompt (':'​ at the end).\\ Old naming: check_service[*]\\ Note that before Zabbix 1.8.3 version **service.ntp** should be used instead of **ntp**.\\ **https** and **telnet** services are supported since Zabbix 2.0.\\ **ntp** service only works since Zabbix 2.0.15, despite being available in earlier versions.|+^ |Checks if service is running and accepting TCP connections. ​ |0 - service is down\\ \\ 1 - service is running ​ |**service** - either of:\\ //ssh//, //ntp//, //ldap//, //smtp//, //ftp//, //http//, //pop//, //nntp//, //imap//, //tcp//, //https//, //​telnet// ​(see [[:​manual/​appendix/​items/​service_check_details|details]])\\ **ip** - IP address (default is 127.0.0.1)\\ **port** - port number (by default standard service port number is used)  |//Example key//:\\ net.tcp.service[ftp,,​45] - can be used to test the availability of FTP server on TCP port 45.\\ Note that 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 by Windows agent is currently not supported.\\ Note that the telnet check looks for a login prompt (':'​ at the end).\\ Old naming: check_service[*]\\ **https** and **telnet** services are supported since Zabbix 2.0.\\ **ntp** service only works since Zabbix 2.0.15, despite being available in earlier versions.|
 | ||||| | |||||
 ^net.tcp.service.perf[service,<​ip>,<​port>​] ​ ^^^^^ ^net.tcp.service.perf[service,<​ip>,<​port>​] ​ ^^^^^
-^ |Checks performance of service. ​ |0 - service is down\\ \\ seconds - the number of seconds spent while connecting to the service ​ |**service** - either of:\\ //ssh//, //ntp//, //ldap//, //smtp//, //ftp//, //http//, //pop//, //nntp//, //imap//, //tcp//, //https//, //​telnet//​\\ **ip** - IP address (default is 127.0.0.1)\\ **port** - port number (by default standard service port number is used)  |//Example key//:\\ net.tcp.service.perf[ssh] - can be used to test the speed of initial response from SSH server.\\ 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,<​ip>,<​port>​] for checks like these.\\ Checking of LDAP and HTTPS by Windows agent is currently not supported.\\ Note that the telnet check looks for a login prompt (':'​ at the end).\\ Old naming: check_service_perf[*]\\ Note that before Zabbix 1.8.3 version **service.ntp** should be used instead of **ntp**.\\ **https** and **telnet** services are supported since Zabbix 2.0.\\ **ntp** service only works since Zabbix 2.0.15, despite being available in earlier versions.|+^ |Checks performance of service. ​ |0 - service is down\\ \\ seconds - the number of seconds spent while connecting to the service ​ |**service** - either of:\\ //ssh//, //ntp//, //ldap//, //smtp//, //ftp//, //http//, //pop//, //nntp//, //imap//, //tcp//, //https//, //​telnet// ​(see [[:​manual/​appendix/​items/​service_check_details|details]])\\ **ip** - IP address (default is 127.0.0.1)\\ **port** - port number (by default standard service port number is used)  |//Example key//:\\ net.tcp.service.perf[ssh] - can be used to test the speed of initial response from SSH server.\\ 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,<​ip>,<​port>​] for checks like these.\\ Checking of LDAP and HTTPS by Windows agent is currently not supported.\\ Note that the telnet check looks for a login prompt (':'​ at the end).\\ Old naming: check_service_perf[*]\\ **https** and **telnet** services are supported since Zabbix 2.0.\\ **ntp** service only works since Zabbix 2.0.15, despite being available in earlier versions.|
 | ||||| | |||||
 ^net.udp.listen[port] ​ ^^^^^ ^net.udp.listen[port] ​ ^^^^^
Line 84: Line 84:
 | ||||| | |||||
 ^proc.mem[<​name>,<​user>,<​mode>,<​cmdline>​] ​ ^^^^^ ^proc.mem[<​name>,<​user>,<​mode>,<​cmdline>​] ​ ^^^^^
-^ |Memory used by process in bytes. ​ |Integer ​ |**name** - process name (default is //all processes//​)\\ **user** - user name (default is //all users//)\\ **mode** - possible values:\\ //avg//, //max//, //min//, //sum// (default)\\ **cmdline** - filter by command line  |//Example keys//:\\ proc.mem[,​root] - memory used by all processes running under the "​root"​ user\\ proc.mem[zabbix_server,​zabbix] - memory used by all zabbix_server processes running under the zabbix user\\ proc.mem[,​oracle,​max,​oracleZABBIX] - memory used by the most memory-hungry process running under oracle having oracleZABBIX in its command line  |+^ |Memory used by process in bytes. ​ |Integer ​ |**name** - process name (default is //all processes//​)\\ **user** - user name (default is //all users//)\\ **mode** - possible values:\\ //avg//, //max//, //min//, //sum// (default)\\ **cmdline** - filter by command line  |//Example keys//:\\ proc.mem[,​root] - memory used by all processes running under the "​root"​ user\\ proc.mem[zabbix_server,​zabbix] - memory used by all zabbix_server processes running under the zabbix user\\ proc.mem[,​oracle,​max,​oracleZABBIX] - memory used by the most memory-hungry process running under oracle having oracleZABBIX in its command line\\ \\ //Note//: When several processes use shared memory, the sum of memory used by processes may result in large, unrealistic values. ​ |
 | ||||| | |||||
 ^proc.num[<​name>,<​user>,<​state>,<​cmdline>​] ​ ^^^^^ ^proc.num[<​name>,<​user>,<​state>,<​cmdline>​] ​ ^^^^^
Line 123: Line 123:
 | ||||| | |||||
 ^system.hw.macaddr[<​interface>,<​format>​] ​ ^^^^^ ^system.hw.macaddr[<​interface>,<​format>​] ​ ^^^^^
-^ |Listing of MAC addresses. ​ |String ​ |**interface** - all (default) or a regular expression\\ **format** - full (default) or short |Example: %%system.hw.macaddr["​eth0$",​full]%%\\ [eth0] 00:​11:​22:​33:​44:​55\\ \\ Lists MAC adresses of the interfaces whose names match the given **interface** ​regex (//all// lists for all interfaces).\\ If **format** is specified as **short**, interface names and identical MAC addresses are not listed.\\ \\ Supported since Zabbix agent version 2.0. |+^ |Listing of MAC addresses. ​ |String ​ |**interface** - all (default) or a regular expression\\ **format** - full (default) or short |Example: %%system.hw.macaddr["​eth0$",​full]%%\\ [eth0] 00:​11:​22:​33:​44:​55\\ \\ Lists MAC adresses of the interfaces whose names match the given **interface** ​regexp ​(//all// lists for all interfaces).\\ If **format** is specified as **short**, interface names and identical MAC addresses are not listed.\\ \\ Supported since Zabbix agent version 2.0. |
 | ||||| | |||||
 ^system.localtime[<​type>​] ​ ^^^^^ ^system.localtime[<​type>​] ​ ^^^^^
-^ |System time.  |Integer - with ''​type''​ as //utc//\\ \\ String - with ''​type''​ as //​local// ​ |**utc** - (default) the time since the Epoch (00:00:00 UTC, January 1, 1970), measured in seconds.\\ **local** - the time in the '​yyyy-mm-dd,​hh:​mm:​ss.nnn,​+hh:​mm'​ format\\ Parameters for this item supported from version 2.0.  |  |+^ |System time.  |Integer - with ''​type''​ as //utc//\\ \\ String - with ''​type''​ as //​local// ​ |**utc** - (default) the time since the Epoch (00:00:00 UTC, January 1, 1970), measured in seconds.\\ **local** - the time in the '​yyyy-mm-dd,​hh:​mm:​ss.nnn,​+hh:​mm'​ format\\ Parameters for this item supported from version 2.0.  |Example:\\ system.localtime[local] - create an item using this key and then use it to display host time in the //Clock// [[:​manual/​config/​visualisation/​screens|screen element]]. ​ |
 | ||||| | |||||
 ^system.run[command,<​mode>​] ​ ^^^^^ ^system.run[command,<​mode>​] ​ ^^^^^
-^ |Run specified command on the host.  |Text result of the command ​ |**command** - command for execution\\ **mode** - one of wait (default, wait end of execution), nowait (do not wait)  |Up to 512KB of data can be returned (64KB before Zabbix 2.0.5), including trailing whitespace that is truncated.\\ To be processed correctly, the output of the command must be text.\\ Example:\\ system.run[ls -l /] - detailed file list of root directory.\\ //Note//: To enable this functionality,​ agent configuration file must have EnableRemoteCommands=1 option. ​ |+^ |Run specified command on the host.  |Text result of the command\\ \\ 1 - with ''​mode''​ as //nowait// (regardless of command result) ​ ​|**command** - command for execution\\ **mode** - one of wait (default, wait end of execution), nowait (do not wait)  |Up to 512KB of data can be returned (64KB before Zabbix 2.0.5), including trailing whitespace that is truncated.\\ To be processed correctly, the output of the command must be text.\\ Example:\\ system.run[ls -l /] - detailed file list of root directory.\\ //Note//: To enable this functionality,​ agent configuration file must have EnableRemoteCommands=1 option.\\ See also: [[:​manual/​appendix/​command_execution|Command execution]].  |
 | ||||| | |||||
 ^system.stat[resource,<​type>​] ​ ^^^^^ ^system.stat[resource,<​type>​] ​ ^^^^^
Line 141: Line 141:
 | ||||| | |||||
 ^system.sw.packages[<​package>,<​manager>,<​format>​] ​ ^^^^^ ^system.sw.packages[<​package>,<​manager>,<​format>​] ​ ^^^^^
-^ |Listing of installed packages. ​ |Text  |**package** - all (default) or a regular expression\\ **manager** - all (default) or a package manager\\ **format** - full (default) or short |Example: system.sw.packages[mini,​dpkg,​short]\\ python-minimal,​ python2.6-minimal,​ ubuntu-minimal\\ \\ Lists (alphabetically) installed packages whose names match the given **package** ​regex (//all// lists them all).\\ \\ Supported packages managers:\\ **manager** (executed command)\\ dpkg (dpkg %%--get-selections%%)\\ pkgtool (ls /​var/​log/​packages)\\ rpm (rpm -qa)\\ pacman (pacman -Q)\\ \\ If **format** is specified as **full**, packages are grouped by package managers (each manager on a seperate line beginning with it's name in square brackets).\\ If **format** is specified as **short**, packages are not grouped and are listed on a single line.\\ \\ Supported since Zabbix agent version 2.0. |+^ |Listing of installed packages. ​ |Text  |**package** - all (default) or a regular expression\\ **manager** - all (default) or a package manager\\ **format** - full (default) or short |Example: system.sw.packages[mini,​dpkg,​short]\\ python-minimal,​ python2.6-minimal,​ ubuntu-minimal\\ \\ Lists (alphabetically) installed packages whose names match the given **package** ​regexp ​(//all// lists them all).\\ \\ Supported packages managers:\\ **manager** (executed command)\\ dpkg (dpkg %%--get-selections%%)\\ pkgtool (ls /​var/​log/​packages)\\ rpm (rpm -qa)\\ pacman (pacman -Q)\\ \\ If **format** is specified as **full**, packages are grouped by package managers (each manager on a seperate line beginning with it's name in square brackets).\\ If **format** is specified as **short**, packages are not grouped and are listed on a single line.\\ \\ Supported since Zabbix agent version 2.0. |
 | ||||| | |||||
 ^system.swap.in[<​device>,<​type>​] ​ ^^^^^ ^system.swap.in[<​device>,<​type>​] ​ ^^^^^
Line 150: Line 150:
 | ||||| | |||||
 ^system.swap.size[<​device>,<​type>​] ​ ^^^^^ ^system.swap.size[<​device>,<​type>​] ​ ^^^^^
-^ |Swap space size in bytes or in percentage from total. ​ |Integer - for bytes\\ \\ Float - for percentage<​sup>​1</​sup> ​ |**device** - device used for swapping (default is all)\\ **type** - possible values:\\ //free// (free swap space, default), //pfree// (free swap space, in percent), //pused// (used swap space, in percent), //total// (total swap space), //used// (used swap space) ​ |//Example key//:\\ system.swap.size[,​pfree] - free swap space percentage\\ \\ Old naming: system.swap.free,​ system.swap.total |+^ |Swap space size in bytes or in percentage from total. ​ |Integer - for bytes\\ \\ Float - for percentage<​sup>​1</​sup> ​ |**device** - device used for swapping (default is all)\\ **type** - possible values:\\ //free// (free swap space, default), //pfree// (free swap space, in percent), //pused// (used swap space, in percent), //total// (total swap space), //used// (used swap space) ​ |//Example key//:\\ system.swap.size[,​pfree] - free swap space percentage\\ \\ If //device// is not specified Zabbix agent will only take into account swap devices (files), physical memory will be ignored. For example, on Solaris systems //swap -s// command includes a portion of physical memory and swap devices (unlike //swap -l//).\\ \\ Old naming: system.swap.free,​ system.swap.total |
 | ||||| | |||||
 ^system.uname ​ ^^^^^ ^system.uname ​ ^^^^^
Line 171: Line 171:
 | ||||| | |||||
 ^vfs.file.contents[file,<​encoding>​] ​ ^^^^^ ^vfs.file.contents[file,<​encoding>​] ​ ^^^^^
-^ |Retrieving contents of a file.  |Text  |**file** - full path to file  |Returns EOF if the file is empty or contains LF/CR characters only.\\ \\ Example:\\ vfs.file.contents[/​etc/​passwd]\\ \\ This item is limited to files no larger than 64 Kbytes.\\ \\ Supported since Zabbix agent version 2.0.  |+^ |Retrieving contents of a file.  |Text  |**file** - full path to file\\ **encoding** - code page [[:​manual/​config/​items/​itemtypes/​zabbix_agent#​available_encodings|identifier]] ​ ​|Returns EOF if the file is empty or contains LF/CR characters only.\\ \\ Example:\\ vfs.file.contents[/​etc/​passwd]\\ \\ This item is limited to files no larger than 64 Kbytes.\\ \\ Supported since Zabbix agent version 2.0.  |
 | ||||| | |||||
 ^vfs.file.exists[file] ​ ^^^^^ ^vfs.file.exists[file] ​ ^^^^^
Line 180: Line 180:
 | ||||| | |||||
 ^vfs.file.regexp[file,​regexp,<​encoding>​] ​ ^^^^^ ^vfs.file.regexp[file,​regexp,<​encoding>​] ​ ^^^^^
-^ |Find string in a file.  |The whole line from file containing the matched string or EOF if expression not found  |**file** - full path to file\\ **regexp** - GNU regular expression\\ **encoding** - Code Page identifier ​ |Only the first matching line is returned.\\ Example: vfs.file.regexp[/​etc/​passwd,​zabbix] |+^ |Find string in a file.  |The whole line from file containing the matched string or EOF if expression not found  |**file** - full path to file\\ **regexp** - GNU regular expression\\ **encoding** - code page [[:​manual/​config/​items/​itemtypes/​zabbix_agent#​available_encodings|identifier]]  |Only the first matching line is returned.\\ Example: vfs.file.regexp[/​etc/​passwd,​zabbix] |
 | ||||| | |||||
 ^vfs.file.regmatch[file,​regexp,<​encoding>​] ​ ^^^^^ ^vfs.file.regmatch[file,​regexp,<​encoding>​] ​ ^^^^^
-^ |Find string in a file.  |0 - expression not found\\ \\ 1 - found  |**file** - full path to file\\ **regexp** - GNU regular expression\\ **encoding** - Code Page identifier ​ |Example: vfs.file.regmatch[/​var/​log/​app.log,​error] ​ |+^ |Find string in a file.  |0 - expression not found\\ \\ 1 - found  |**file** - full path to file\\ **regexp** - GNU regular expression\\ **encoding** - code page [[:​manual/​config/​items/​itemtypes/​zabbix_agent#​available_encodings|identifier]]  ​|Example:​ vfs.file.regmatch[/​var/​log/​app.log,​error] ​ |
 | ||||| | |||||
 ^vfs.file.size[file] ​ ^^^^^ ^vfs.file.size[file] ​ ^^^^^
Line 198: Line 198:
 | ||||| | |||||
 ^vfs.fs.size[fs,<​mode>​] ​ ^^^^^ ^vfs.fs.size[fs,<​mode>​] ​ ^^^^^
-^ |Disk space in bytes or in percentage from total. ​ |Integer - for bytes\\ \\ Float - for percentage ​ |**fs** - filesystem\\ **mode** - one of total (default), free, used, pfree (free, percentage),​ pused (used, percentage) ​ |In case of a mounted volume, disk space for local file system is returned. ​ Example: vfs.fs.size[/​tmp,​free] ​ Old naming: vfs.fs.free[*],​ vfs.fs.total[*],​ vfs.fs.used[*],​ vfs.fs.pfree[*],​ vfs.fs.pused[*] ​ |+^ |Disk space in bytes or in percentage from total. ​ |Integer - for bytes\\ \\ Float - for percentage ​ |**fs** - filesystem\\ **mode** - one of total (default), free, used, pfree (free, percentage),​ pused (used, percentage) ​ |In case of a mounted volume, disk space for local file system is returned.\\ \\ Example: vfs.fs.size[/​tmp,​free]\\ \\ Reserved space of a file system is taken into account and not included when using the //free// mode.\\ \\ Old naming: vfs.fs.free[*],​ vfs.fs.total[*],​ vfs.fs.used[*],​ vfs.fs.pfree[*],​ vfs.fs.pused[*] ​ |
 | ||||| | |||||
 ^vm.memory.size[<​mode>​] ​ ^^^^^ ^vm.memory.size[<​mode>​] ​ ^^^^^
Line 218: Line 218:
  
 <​note>​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.</​note>​ <​note>​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.</​note>​
 +
 +=== Available encodings ===
 +
 +The ''​encoding''​ parameter is used to specify encoding for processing corresponding item checks, so that data acquired will not be corrupted. For a list of supported encodings (code page identifiers),​ please consult respective documentation,​ such as documentation for [[http://​www.gnu.org/​software/​libiconv/​|libiconv]] (GNU Project) or Microsoft Windows SDK documentation for "Code Page Identifiers"​. ​
 +
 +If empty ''​encoding''​ is passed, then UTF-8 (default locale for newer Unix/Linux distributions,​ see your system'​s settings) or  ANSI with system-specific extension (Windows) is used by default.