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
manual:config:items:itemtypes:zabbix_agent [2021/09/17 09:17]
martins-v clarified log item definitions
manual:config:items:itemtypes:zabbix_agent [2021/10/08 17:26] (current)
martins-v zabbix.com -> example.com
Line 65: Line 65:
 | ||||| | |||||
 ^net.dns[<​ip>,​name,<​type>,<​timeout>,<​count>,<​protocol>​] ​ ^^^^^ ^net.dns[<​ip>,​name,<​type>,<​timeout>,<​count>,<​protocol>​] ​ ^^^^^
-^ |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)\\ **protocol** (since version 3.0) - the protocol used to perform DNS queries: //udp// (default) or //​tcp// ​ |Example:\\ => 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//\\ \\ Internationalized domain names are not supported, please use IDNA encoded names instead.\\ \\ SRV record type is supported since Zabbix 1.8.6 (Unix) and 2.0.0 (Windows).\\ \\ 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)\\ **protocol** (since version 3.0) - the protocol used to perform DNS queries: //udp// (default) or //​tcp// ​ |Example:\\ => net.dns[8.8.8.8,​example.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//\\ \\ Internationalized domain names are not supported, please use IDNA encoded names instead.\\ \\ SRV record type is supported since Zabbix 1.8.6 (Unix) and 2.0.0 (Windows).\\ \\ Naming before Zabbix 2.0 (still supported): //​net.tcp.dns//​|
 | ||||| | |||||
 ^net.dns.record[<​ip>,​name,<​type>,<​timeout>,<​count>,<​protocol>​] ​ ^^^^^ ^net.dns.record[<​ip>,​name,<​type>,<​timeout>,<​count>,<​protocol>​] ​ ^^^^^
-^ |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)\\ **protocol**(since version 3.0) - the protocol used to perform DNS queries: //udp// (default) or //​tcp// ​ |Example:\\ => 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//\\ \\ Internationalized domain names are not supported, please use IDNA encoded names instead.\\ \\ SRV record type is supported since Zabbix 1.8.6 (Unix) and 2.0.0 (Windows).\\ \\ 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)\\ **protocol**(since version 3.0) - the protocol used to perform DNS queries: //udp// (default) or //​tcp// ​ |Example:\\ => net.dns.record[8.8.8.8,​example.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//\\ \\ Internationalized domain names are not supported, please use IDNA encoded names instead.\\ \\ SRV record type is supported since Zabbix 1.8.6 (Unix) and 2.0.0 (Windows).\\ \\ Naming before Zabbix 2.0 (still supported): //​net.tcp.dns.query//​|
 | ||||| | |||||
 ^net.if.collisions[if] ​ ^^^^^ ^net.if.collisions[if] ​ ^^^^^
Line 148: Line 148:
 | ||||| | |||||
 ^system.hostname[<​type>​] ​ ^^^^^ ^system.hostname[<​type>​] ​ ^^^^^
-^ |System host name.  |String ​ |**type** (since version 1.8.6 for Windows only, must not be used on other systems) - possible values: //netbios// (default) or //host// | The value is acquired by either GetComputerName() (for **netbios**) or gethostname() (for **host**) functions on Windows and by "​hostname"​ command on other systems.\\ \\ Examples of returned values:\\ //on Linux//:\\ => system.hostname -> linux-w7x1\\ => system.hostname ->  %%www.zabbix.com%%\\ //on Windows//:​\\ => system.hostname -> WIN-SERV2008-I6\\ => system.hostname[host] -> Win-Serv2008-I6LonG\\ \\ See also a [[manual:​appendix:​install:​windows_agent#​configuration|more detailed description]]. ​ |+^ |System host name.  |String ​ |**type** (since version 1.8.6 for Windows only, must not be used on other systems) - possible values: //netbios// (default) or //host// | The value is acquired by either GetComputerName() (for **netbios**) or gethostname() (for **host**) functions on Windows and by "​hostname"​ command on other systems.\\ \\ Examples of returned values:\\ //on Linux//:\\ => system.hostname -> linux-w7x1\\ => system.hostname ->  %%www.example.com%%\\ //on Windows//:​\\ => system.hostname -> WIN-SERV2008-I6\\ => system.hostname[host] -> Win-Serv2008-I6LonG\\ \\ See also a [[manual:​appendix:​install:​windows_agent#​configuration|more detailed description]]. ​ |
 | ||||| | |||||
 ^system.hw.chassis[<​info>​] ​ ^^^^^ ^system.hw.chassis[<​info>​] ​ ^^^^^
Line 264: Line 264:
 | ||||| | |||||
 ^web.page.get[host,<​path>,<​port>​] ​ ^^^^^ ^web.page.get[host,<​path>,<​port>​] ​ ^^^^^
-^ |Get content of web page.  |Web page source as text (including headers) ​ |**host** - hostname or URL (as ''​%%scheme://​host:​port/​path%%'',​ where only //host// is mandatory).\\ Allowed URL schemes: //http//, //​https//<​sup>​**[[#​footnotes|4]]**</​sup>​. Missing scheme will be treated as //http//. If URL is specified ''​path''​ and ''​port''​ must be empty. Specifying user name/​password when connecting to servers that require authentication,​ for example: ''​%%http://​user:​[email protected]%%''​ is only possible with cURL support <​sup>​**[[#​footnotes|4]]**</​sup>​.\\ Punycode is supported in hostnames.\\ **path** - path to HTML document (default is /)\\ **port** - port number (default is 80 for HTTP)  |This item turns unsupported if the resource specified in ''​host''​ does not exist or is unavailable.\\ \\ ''​host''​ can be hostname, domain name, IPv4 or IPv6 address. But for IPv6 address Zabbix agent must be compiled with IPv6 support enabled.\\ \\ Example:\\ => %%web.page.get[www.zabbix.com,​index.php,​80]%%\\ ​ => %%web.page.get[https://​www.zabbix.com]%%\\ => %%web.page.get[https://​blog.zabbix.com/?​s=zabbix]%%\\ ​ => %%web.page.get[localhost:​80]%%\\ => %%web.page.get["​[::​1]/​server-status"​]%% ​ |+^ |Get content of web page.  |Web page source as text (including headers) ​ |**host** - hostname or URL (as ''​%%scheme://​host:​port/​path%%'',​ where only //host// is mandatory).\\ Allowed URL schemes: //http//, //​https//<​sup>​**[[#​footnotes|4]]**</​sup>​. Missing scheme will be treated as //http//. If URL is specified ''​path''​ and ''​port''​ must be empty. Specifying user name/​password when connecting to servers that require authentication,​ for example: ''​%%http://​user:​[email protected]%%''​ is only possible with cURL support <​sup>​**[[#​footnotes|4]]**</​sup>​.\\ Punycode is supported in hostnames.\\ **path** - path to HTML document (default is /)\\ **port** - port number (default is 80 for HTTP)  |This item turns unsupported if the resource specified in ''​host''​ does not exist or is unavailable.\\ \\ ''​host''​ can be hostname, domain name, IPv4 or IPv6 address. But for IPv6 address Zabbix agent must be compiled with IPv6 support enabled.\\ \\ Example:\\ => %%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"​]%% ​ |
 | ||||| | |||||
 ^web.page.perf[host,<​path>,<​port>​] ​ ^^^^^ ^web.page.perf[host,<​path>,<​port>​] ​ ^^^^^
-^ |Loading time of full web page (in seconds). ​ |Float ​ |**host** - hostname or URL (as ''​%%scheme://​host:​port/​path%%'',​ where only //host// is mandatory).\\ Allowed URL schemes: //http//, //​https//<​sup>​**[[#​footnotes|4]]**</​sup>​. Missing scheme will be treated as //http//. If URL is specified ''​path''​ and ''​port''​ must be empty. Specifying user name/​password when connecting to servers that require authentication,​ for example: ''​%%http://​user:​[email protected]%%''​ is only possible with cURL support <​sup>​**[[#​footnotes|4]]**</​sup>​.\\ Punycode is supported in hostnames.\\ **path** - path to HTML document (default is /)\\ **port** - port number (default is 80 for HTTP)  |This item turns unsupported if the resource specified in ''​host''​ does not exist or is unavailable.\\ \\ ''​host''​ can be hostname, domain name, IPv4 or IPv6 address. But for IPv6 address Zabbix agent must be compiled with IPv6 support enabled.\\ \\ Example:\\ => %%web.page.perf[www.zabbix.com,​index.php,​80]%%\\ ​ => %%web.page.perf[https://​www.zabbix.com]%% ​ |+^ |Loading time of full web page (in seconds). ​ |Float ​ |**host** - hostname or URL (as ''​%%scheme://​host:​port/​path%%'',​ where only //host// is mandatory).\\ Allowed URL schemes: //http//, //​https//<​sup>​**[[#​footnotes|4]]**</​sup>​. Missing scheme will be treated as //http//. If URL is specified ''​path''​ and ''​port''​ must be empty. Specifying user name/​password when connecting to servers that require authentication,​ for example: ''​%%http://​user:​[email protected]%%''​ is only possible with cURL support <​sup>​**[[#​footnotes|4]]**</​sup>​.\\ Punycode is supported in hostnames.\\ **path** - path to HTML document (default is /)\\ **port** - port number (default is 80 for HTTP)  |This item turns unsupported if the resource specified in ''​host''​ does not exist or is unavailable.\\ \\ ''​host''​ can be hostname, domain name, IPv4 or IPv6 address. But for IPv6 address Zabbix agent must be compiled with IPv6 support enabled.\\ \\ Example:\\ => %%web.page.perf[www.example.com,​index.php,​80]%%\\ ​ => %%web.page.perf[https://​www.example.com]%% ​ |
 | ||||| | |||||
 ^web.page.regexp[host,<​path>,<​port>,​regexp,<​length>,<​output>​] ​ ^^^^^ ^web.page.regexp[host,<​path>,<​port>,​regexp,<​length>,<​output>​] ​ ^^^^^
-^ |Find string on a web page.  | The matched string, or as specified by the optional ''​output''​ parameter ​ |**host** - hostname or URL (as ''​%%scheme://​host:​port/​path%%'',​ where only //host// is mandatory).\\ Allowed URL schemes: //http//, //​https//<​sup>​**[[#​footnotes|4]]**</​sup>​. Missing scheme will be treated as //http//. If URL is specified ''​path''​ and ''​port''​ must be empty. Specifying user name/​password when connecting to servers that require authentication,​ for example: ''​%%http://​user:​[email protected]%%''​ is only possible with cURL support <​sup>​**[[#​footnotes|4]]**</​sup>​.\\ Punycode is supported in hostnames.\\ **path** - path to HTML document (default is /)\\ **port** - port number (default is 80 for HTTP)\\ **regexp** - regular [[:​manual/​regular_expressions#​overview|expression]] describing the required pattern\\ **length** - 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). ​ |This item turns unsupported if the resource specified in ''​host''​ does not exist or is unavailable.\\ \\ ''​host''​ can be 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.\\ \\ The ''​output''​ parameter is supported from version 2.2. \\ \\  Example:\\ => %%web.page.regexp[www.zabbix.com,​index.php,​80,​OK,​2]%%\\ ​ => %%web.page.regexp[https://​www.zabbix.com,,,​OK,​2]%% ​ |+^ |Find string on a web page.  | The matched string, or as specified by the optional ''​output''​ parameter ​ |**host** - hostname or URL (as ''​%%scheme://​host:​port/​path%%'',​ where only //host// is mandatory).\\ Allowed URL schemes: //http//, //​https//<​sup>​**[[#​footnotes|4]]**</​sup>​. Missing scheme will be treated as //http//. If URL is specified ''​path''​ and ''​port''​ must be empty. Specifying user name/​password when connecting to servers that require authentication,​ for example: ''​%%http://​user:​[email protected]%%''​ is only possible with cURL support <​sup>​**[[#​footnotes|4]]**</​sup>​.\\ Punycode is supported in hostnames.\\ **path** - path to HTML document (default is /)\\ **port** - port number (default is 80 for HTTP)\\ **regexp** - regular [[:​manual/​regular_expressions#​overview|expression]] describing the required pattern\\ **length** - 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). ​ |This item turns unsupported if the resource specified in ''​host''​ does not exist or is unavailable.\\ \\ ''​host''​ can be 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.\\ \\ The ''​output''​ parameter is supported from version 2.2. \\ \\  Example:\\ => %%web.page.regexp[www.example.com,​index.php,​80,​OK,​2]%%\\ ​ => %%web.page.regexp[https://​www.example.com,,,​OK,​2]%% ​ |
 ^zabbix.stats[<​ip>,<​port>​] ​ ^^^^^ ^zabbix.stats[<​ip>,<​port>​] ​ ^^^^^
 ^ |Return a set of Zabbix server or proxy internal metrics remotely. ​ |JSON object ​ |**ip** - IP/​DNS/​network mask list of servers/​proxies to be remotely queried (default is 127.0.0.1)\\ **port** - port of server/​proxy to be remotely queried (default is 10051) ​ |Note that the stats request will only be accepted from the addresses listed in the '​StatsAllowedIP'​ [[:​manual/​appendix/​config/​zabbix_server|server]]/​[[:​manual/​appendix/​config/​zabbix_proxy|proxy]] parameter on the target instance.\\ \\ A selected set of internal metrics is returned by this item. For details, see [[:​manual/​appendix/​items/​remote_stats#​exposed_metrics|Remote monitoring of Zabbix stats]]. ​ | ^ |Return a set of Zabbix server or proxy internal metrics remotely. ​ |JSON object ​ |**ip** - IP/​DNS/​network mask list of servers/​proxies to be remotely queried (default is 127.0.0.1)\\ **port** - port of server/​proxy to be remotely queried (default is 10051) ​ |Note that the stats request will only be accepted from the addresses listed in the '​StatsAllowedIP'​ [[:​manual/​appendix/​config/​zabbix_server|server]]/​[[:​manual/​appendix/​config/​zabbix_proxy|proxy]] parameter on the target instance.\\ \\ A selected set of internal metrics is returned by this item. For details, see [[:​manual/​appendix/​items/​remote_stats#​exposed_metrics|Remote monitoring of Zabbix stats]]. ​ |