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
manual:config:items:itemtypes:zabbix_agent [2021/03/03 10:52]
marinagen [ZBX-18345] net.tcp.port <ip> parameter can also be a DNS
manual:config:items:itemtypes:zabbix_agent [2021/04/16 19:30] (current)
martins-v fixing typo
Line 147: Line 147:
 | ||||| | |||||
 ^system.hw.macaddr[<​interface>,<​format>​] ​ ^^^^^ ^system.hw.macaddr[<​interface>,<​format>​] ​ ^^^^^
-^ |Listing of MAC addresses. ​ |String ​ |**interface** - //all// (default) or a regular expression<​sup>​**[[#​footnotes|4]]**</​sup>​\\ **format** - //full// (default) or //short// |Lists MAC adresses ​of the interfaces whose name matches the given ''​interface''​ regular expression<​sup>​**[[#​footnotes|4]]**</​sup>​ (//all// lists for all interfaces).\\ \\ Example:\\ => %%system.hw.macaddr["​eth0$",​full]%% -> [eth0] 00:​11:​22:​33:​44:​55\\ \\ 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<​sup>​**[[#​footnotes|4]]**</​sup>​\\ **format** - //full// (default) or //short// |Lists MAC addresses ​of the interfaces whose name matches the given ''​interface''​ regular expression<​sup>​**[[#​footnotes|4]]**</​sup>​ (//all// lists for all interfaces).\\ \\ Example:\\ => %%system.hw.macaddr["​eth0$",​full]%% -> [eth0] 00:​11:​22:​33:​44:​55\\ \\ 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>​] ​ ^^^^^
Line 209: Line 209:
 | ||||| | |||||
 ^vfs.file.exists[file,<​types_incl>,<​types_excl>​] ​ ^^^^^ ^vfs.file.exists[file,<​types_incl>,<​types_excl>​] ​ ^^^^^
-^ |Checks if file exists. ​ |0 - not found\\ \\ 1 - file of the specified type exists ​ |**file** - full path to file\\ **types_incl** - 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// (characer ​device), //fifo// (FIFO), //dev// (synonymous with %%"​bdev,​cdev"​%%),​ //all// (all mentioned types, default if types_excl is set).\\ **types_excl** - list of file types to exclude, see types_incl for possible values (by default no types are excluded) |Multiple types must be separated with a comma and the entire set enclosed in quotes %%""​%%.\\ On Windows the double quotes have to be backslash '​\'​ escaped and the whole item key enclosed in double quotes when using the command line utility for calling zabbix_get.exe or agent2.\\ \\ If the same type is in both <​types_incl>​ and <​types_excl>,​ files of this type are excluded.\\ \\ Examples:\\ => vfs.file.exists[/​tmp/​application.pid]\\ => vfs.file.exists[/​tmp/​application.pid,​%%"​file,​dir,​sym"​%%]\\ => vfs.file.exists[/​tmp/​application_dir,​dir]\\ \\ The file size limit depends on [[manual:​appendix:​items:​large_file_support|large file support]].\\ \\ The ''​types_incl'',​ ''​types_excl''​ parameters are supported since Zabbix 5.0.2.\\ Note that the item may turn unsupported in Windows if a directory is searched within a non-existing directory, e.g. vfs.file.exists[C:​\no\dir,​dir] (where '​no'​ does not exist). ​ |+^ |Checks if file exists. ​ |0 - not found\\ \\ 1 - file of the specified type exists ​ |**file** - full path to file\\ **types_incl** - 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** - list of file types to exclude, see types_incl for possible values (by default no types are excluded) |Multiple types must be separated with a comma and the entire set enclosed in quotes %%""​%%.\\ On Windows the double quotes have to be backslash '​\'​ escaped and the whole item key enclosed in double quotes when using the command line utility for calling zabbix_get.exe or agent2.\\ \\ If the same type is in both <​types_incl>​ and <​types_excl>,​ files of this type are excluded.\\ \\ Examples:\\ => vfs.file.exists[/​tmp/​application.pid]\\ => vfs.file.exists[/​tmp/​application.pid,​%%"​file,​dir,​sym"​%%]\\ => vfs.file.exists[/​tmp/​application_dir,​dir]\\ \\ The file size limit depends on [[manual:​appendix:​items:​large_file_support|large file support]].\\ \\ The ''​types_incl'',​ ''​types_excl''​ parameters are supported since Zabbix 5.0.2.\\ Note that the item may turn unsupported in Windows if a directory is searched within a non-existing directory, e.g. vfs.file.exists[C:​\no\dir,​dir] (where '​no'​ does not exist). ​ |
 | ||||| | |||||
 ^vfs.file.md5sum[file] ​ ^^^^^ ^vfs.file.md5sum[file] ​ ^^^^^
Line 242: Line 242:
 | ||||| | |||||
 ^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|5]]**</​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|5]]**</​sup>​.\\ Punycode is suported ​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|5]]**</​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|5]]**</​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"​]%% ​ |
 | ||||| | |||||
 ^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|5]]**</​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|5]]**</​sup>​.\\ Punycode is suported ​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|5]]**</​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|5]]**</​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]%% ​ |
 | ||||| | |||||
 ^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|5]]**</​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|5]]**</​sup>​.\\ Punycode is suported ​in hostnames.\\ **path** - path to HTML document (default is /)\\ **port** - port number (default is 80 for HTTP)\\ **regexp** - regular expression<​sup>​**[[#​footnotes|4]]**</​sup>​ 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|5]]**</​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|5]]**</​sup>​.\\ Punycode is supported ​in hostnames.\\ **path** - path to HTML document (default is /)\\ **port** - port number (default is 80 for HTTP)\\ **regexp** - regular expression<​sup>​**[[#​footnotes|4]]**</​sup>​ 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]%% ​ |
 ^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]]. ​ |