��Ĳ�

Table of Contents

6 ��Ĳ� agent 2 (Windows)
- Overview
- Parameters

6 ��Ĳ� agent 2 (Windows)

Overview

��Ĳ� agent 2 is a new generation of ��Ĳ� agent and may be used in place of ��Ĳ� agent.

This section lists parameters supported in a ��Ĳ� agent 2 configuration file (zabbix_agent2.win.conf).

Note that:

The default values reflect process defaults, not the values in the shipped configuration files;
��Ĳ� supports configuration files only in UTF-8 encoding without ;
Comments starting with "#" are only supported in the beginning of the line.

Parameters

Parameter		Mandatory	Range	Default	Description
Alias		no			Sets an alias for an item key. It can be used to substitute long and complex item key with a smaller and simpler one. Multiple Alias parameters may be present. Multiple parameters with the same Alias key are allowed. Different Alias keys may reference the same item key. Aliases can be used in HostMetadataItem but not in HostnameItem parameters. Examples: 1. Retrieving the ID of user 'zabbix'. Alias=zabbix.userid:vfs.file.regexp[/etc/passwd,"^zabbix:.:([0-9]+)",,,,\1] Now shorthand key zabbix.userid may be used to retrieve data. 2. Getting CPU utilization with default and custom parameters. Alias=cpu.util:system.cpu.util Alias=cpu.util[]:system.cpu.util[] This allows use cpu.util key to get CPU utilization percentage with default parameters as well as use cpu.util[all, idle, avg15] to get specific data about CPU utilization. 3. Running multiple low-level discovery rules processing the same discovery items. Alias=vfs.fs.discovery[]:vfs.fs.discovery Now it is possible to set up several discovery rules using vfs.fs.discovery* with different parameters for each rule, e.g., vfs.fs.discovery[foo], vfs.fs.discovery[bar], etc.
AllowKey		no			Allow execution of those item keys that match a pattern. Key pattern is a wildcard expression that supports "*" character to match any number of any characters. Multiple key matching rules may be defined in combination with DenyKey. The parameters are processed one by one according to their appearance order. This parameter is supported since ��Ĳ� 5.0.0. See also: Restricting agent checks.
BufferSend		no	1-3600	5	The time interval in seconds which determines how often values are sent from the buffer to ��Ĳ� server. Note, that if the buffer is full, the data will be sent sooner.
BufferSize		no	2-65535	100	Maximum number of values in a memory buffer. The agent will send all collected data to ��Ĳ� server or proxy if the buffer is full. This parameter should only be used if persistent buffer is disabled (EnablePersistentBuffer=0).
ControlSocket		no		\\.\pipe\agent.sock	The control socket, used to send runtime commands with '-R' option.
DebugLevel		no	0-5	3	Specifies debug level: 0 - basic information about starting and stopping of ��Ĳ� processes 1 - critical information 2 - error information 3 - warnings 4 - for debugging (produces lots of information) 5 - extended debugging (produces even more information)
DenyKey		no			Deny execution of those item keys that match a pattern. Key pattern is a wildcard expression that supports "*" character to match any number of any characters. Multiple key matching rules may be defined in combination with AllowKey. The parameters are processed one by one according to their appearance order. This parameter is supported since ��Ĳ� 5.0.0. See also: Restricting agent checks.
EnablePersistentBuffer		no	0-1	0	Enable usage of local persistent storage for active items. 0 - disabled 1 - enabled If persistent storage is disabled, the memory buffer will be used.
ForceActiveChecksOnStart		no	0-1	0	Perform active checks immediately after restart for the first received configuration. 0 - disabled 1 - enabled Also available as per plugin configuration parameter, for example: `Plugins.Uptime.System.ForceActiveChecksOnStart=1`
HeartbeatFrequency		no	0-3600	60	Frequency of heartbeat messages in seconds. Used for monitoring the availability of active checks. 0 - heartbeat messages disabled.
HostInterface		no	0-255 characters		Optional parameter that defines host interface. Host interface is used at host autoregistration process. An agent will issue an error and not start if the value is over the limit of 255 characters. If not defined, value will be acquired from HostInterfaceItem. Supported since ��Ĳ� 4.4.0.
HostInterfaceItem		no			Optional parameter that defines an item used for getting host interface. Host interface is used at host autoregistration process. During an autoregistration request an agent will log a warning message if the value returned by specified item is over limit of 255 characters. The system.run[] item is supported regardless of AllowKey/DenyKey values. This option is only used when HostInterface is not defined. Supported since ��Ĳ� 4.4.0.
HostMetadata		no	0-255 characters		Optional parameter that defines host metadata. Host metadata is used at host autoregistration process. An agent will issue an error and not start if the specified value is over the limit or a non-UTF-8 string. If not defined, the value will be acquired from HostMetadataItem.
HostMetadataItem		no			Optional parameter that defines an item used for getting host metadata. Host metadata item value is retrieved on each autoregistration attempt for host autoregistration process. During an autoregistration request an agent will log a warning message if the value returned by the specified item is over the limit of 255 characters. This option is only used when HostMetadata is not defined. Supports UserParameters and aliases. Supports system.run[] regardless of EnableRemoteCommands value. The value returned by the item must be a UTF-8 string otherwise it will be ignored.
Hostname		no		Set by HostnameItem	List of comma-delimited unique, case-sensitive hostnames. Required for active checks and must match hostnames as configured on the server. Value is acquired from HostnameItem if undefined. Allowed characters: alphanumeric, '.', ' ', '_' and '-'. Maximum length: 128 characters per hostname, 2048 characters for the entire line.
HostnameItem		no		system.hostname	Item used for generating Hostname if it is not defined. Ignored if Hostname is defined. Does not support UserParameters or aliases, but does support system.run[] regardless of EnableRemoteCommands value. The output length is limited to 512KB.
Include		no			You may include individual files or all files in a directory in the configuration file. All included files must have correct syntax, otherwise agent will not start. The path can be relative to the zabbix_agent2.conf file location (e.g., `Include=.\zabbix_agent2.d\plugins.d\.conf`). To only include relevant files in the specified directory, the asterisk wildcard character is supported for pattern matching. For example: `C:\Program Files\��Ĳ� Agent2\zabbix_agent2.d\.conf`. See special notes about limitations.
ListenIP		no		0.0.0.0	List of comma-delimited IP addresses that the agent should listen on. The first IP address is sent to ��Ĳ� server, if connecting to it, to retrieve the list of active checks.
ListenPort		no	1024-32767	10050	Agent will listen on this port for connections from the server.
LogFile		yes, if LogType is set to file, otherwise no		c:\zabbix_agent2.log	Log file name if LogType is 'file'.
LogFileSize		no	0-1024	1	Maximum size of log file in MB. 0 - disable automatic log rotation. Note: If the log file size limit is reached and file rotation fails, for whatever reason, the existing log file is truncated and started anew.
LogType		no		file	Specifies where log messages are written to: file - file specified by LogFile parameter, console - standard output.
PersistentBufferFile		no			The file, where ��Ĳ� Agent2 should keep SQLite database. Must be a full filename. This parameter is only used if persistent buffer is enabled (EnablePersistentBuffer=1).
PersistentBufferPeriod		no	1m-365d	1h	The time period for which data should be stored, when there is no connection to the server or proxy. Older data will be lost. Log data will be preserved. This parameter is only used if persistent buffer is enabled (EnablePersistentBuffer=1).
Plugins		no			Since ��Ĳ� 6.0.0 most of the plugins have their own configuration files. The agent configuration file contains plugin parameters listed below.
	Plugins.Log.MaxLinesPerSecond	no	1-1000	20	Maximum number of new lines the agent will send per second to ��Ĳ� server or proxy when processing 'log' and 'eventlog' active checks. The provided value will be overridden by the parameter 'maxlines', provided in 'log' or 'eventlog' item key. Note: ��Ĳ� will process 10 times more new lines than set in MaxLinesPerSecond to seek the required string in log items. This parameter is supported since 4.4.2 and replaces MaxLinesPerSecond.
	Plugins.SystemRun.LogRemoteCommands	no		0	Enable logging of executed shell commands as warnings. 0 - disabled 1 - enabled Commands will be logged only if executed remotely. Log entries will not be created if system.run[] is launched locally by HostMetadataItem, HostInterfaceItem or HostnameItem parameters. This parameter is supported since 4.4.2 and replaces LogRemoteCommands.
PluginSocket		no		\\..plugin.sock	Path to unix socket for loadable plugin communications.
PluginTimeout		no	1-30	Global timeout	Timeout for connections with loadable plugins.
RefreshActiveChecks		no	60-3600	120	How often the list of active checks is refreshed, in seconds. Note that after failing to refresh active checks the next refresh will be attempted after 60 seconds.
Server		yes			List of comma-delimited IP addresses, optionally in CIDR notation, or DNS names of ��Ĳ� servers and ��Ĳ� proxies. Incoming connections will be accepted only from the hosts listed here. If IPv6 support is enabled then '127.0.0.1', '::ffff:127.0.0.1' are treated equally and '::/0' will allow any IPv4 or IPv6 address. '0.0.0.0/0' can be used to allow any IPv4 address. Example: Server=127.0.0.1,192.168.1.0/24,::1,2001:db8::/32,zabbix.example.com Spaces are allowed.
ServerActive		no			��Ĳ� server/proxy address or cluster configuration to get active checks from. Server/proxy address is IP address or DNS name and optional port separated by colon. Cluster configuration is one or more server addresses separated by semicolon. Multiple ��Ĳ� servers/clusters and ��Ĳ� proxies can be specified, separated by comma. More than one ��Ĳ� proxy should not be specified from each ��Ĳ� server/cluster. If ��Ĳ� proxy is specified then ��Ĳ� server/cluster for that proxy should not be specified. Multiple addresses can be provided to use several independent ��Ĳ� servers in parallel. Spaces are allowed. If port is not specified, default port is used. IPv6 addresses must be enclosed in square brackets if port for that host is specified. If port is not specified, square brackets for IPv6 addresses are optional. If this parameter is not specified, active checks are disabled. Example for ��Ĳ� proxy: ServerActive=127.0.0.1:10051 Example for multiple servers: ServerActive=127.0.0.1:20051,zabbix.domain,[::1]:30051,::1,[12fc::1] Example for high availability: ServerActive=zabbix.cluster.node1;zabbix.cluster.node2:20051;zabbix.cluster.node3 Example for high availability with two clusters and one server: ServerActive=zabbix.cluster.node1;zabbix.cluster.node2:20051,zabbix.cluster2.node1;zabbix.cluster2.node2,zabbix.domain
SourceIP		no			Source IP address for: - outgoing connections to ��Ĳ� server or ��Ĳ� proxy; - making connections while executing some items (web.page.get, net.tcp.port, etc.)
StatusPort		no	1024-32767		If set, agent will listen on this port for HTTP status requests (http://localhost:<port>/status).
Timeout		no	1-30	3	Spend no more than Timeout seconds on processing.
TLSAccept		yes, if TLS certificate or PSK parameters are defined (even for unencrypted connection), otherwise no			What incoming connections to accept. Used for a passive checks. Multiple values can be specified, separated by comma: unencrypted - accept connections without encryption (default) psk - accept connections with TLS and a pre-shared key (PSK) cert - accept connections with TLS and a certificate
TLSCAFile		no			Full pathname of a file containing the top-level CA(s) certificates for peer certificate verification, used for encrypted communications between ��Ĳ� components.
TLSCertFile		no			Full pathname of a file containing the agent certificate or certificate chain, used for encrypted communications with ��Ĳ� components.
TLSConnect		yes, if TLS certificate or PSK parameters are defined (even for unencrypted connection), otherwise no			How the agent should connect to ��Ĳ� server or proxy. Used for active checks. Only one value can be specified: unencrypted - connect without encryption (default) psk - connect using TLS and a pre-shared key (PSK) cert - connect using TLS and a certificate
TLSCRLFile		no			Full pathname of a file containing revoked certificates. This parameter is used for encrypted communications with ��Ĳ� components.
TLSKeyFile		no			Full pathname of a file containing the agent private key used for encrypted communications with ��Ĳ� components.
TLSPSKFile		no			Full pathname of a file containing the agent pre-shared key used for encrypted communications with ��Ĳ� components.
TLSPSKIdentity		no			Pre-shared key identity string, used for encrypted communications with ��Ĳ� server.
TLSServerCertIssuer		no			Allowed server (proxy) certificate issuer.
TLSServerCertSubject		no			Allowed server (proxy) certificate subject.
UnsafeUserParameters		no	0,1	0	Allow all characters to be passed in arguments to user-defined parameters. The following characters are not allowed: \ ' " ` * ? [ ] { } ~ $ ! & ; ( ) < > \| # @ Additionally, newline characters are not allowed.
UserParameter		no			User-defined parameter to monitor. There can be several user-defined parameters. Format: UserParameter=<key>,<shell command> Note that shell command must not return empty string or EOL only. Shell commands may have relative paths, if UserParameterDir parameter is specified. Examples: UserParameter=system.test,who\|wc -l UserParameter=check_cpu,./custom_script.sh
UserParameterDir		no			Default search path for UserParameter commands. If used, the agent will change its working directory to the one specified here before executing a command. Thereby, UserParameter commands can have a relative `./` prefix instead of a full path. Only one entry is allowed. Example: UserParameterDir=/opt/myscripts

�����Ĳ�

Documentation

6 �����Ĳ� agent 2 (Windows)

Overview

Parameters

��Ĳ�

6 ��Ĳ� agent 2 (Windows)