Zabbix Documentation 2.0

2.23.04.04.2 (current)In development:4.4 (devel)Unsupported:1.82.02.43.23.4

User Tools

Site Tools


Sidebar

manual:appendix:config:zabbix_agentd_win

4 Zabbix agent (Windows)

The parameters supported in a Zabbix agent (Windows) configuration file:

ParameterMandatoryRangeDefaultDescription
Alias no Sets an alias for an item key.
The alias can be used instead of the full item key in item configuration. For example, to retrieve paging file usage percentage from the server, you may use the following item key:
perf_counter[\Paging File(_Total)\% Usage]
However, you may also define an alias by adding the following line to configuration file:
Alias=pg_usage:perf_counter[\Paging File(_Total)\% Usage]
and then use “pg_usage” instead of the full item key in item configuration.
An alias can be especially useful to substitute a long and complex item key with a smaller and simpler one. Multiple aliases can be defined. Aliases cannot be reused in PerfCounter parameters.
BufferSend no 1-3600 5 Do not keep data longer than N seconds in buffer.
BufferSize no 2-65535 100 Maximum number of values in a memory buffer. The agent will send
all collected data to Zabbix server or proxy if the buffer is full.
DebugLevel no 0-4 3 Specifies debug level:
0 - no debug
1 - critical information
2 - error information
3 - warnings
4 - for debugging (produces lots of information)
EnableRemoteCommands no 0 Whether remote commands from Zabbix server are allowed.
0 - not allowed
1 - allowed
Hostname no Set by HostnameItem Unique, case sensitive hostname.
Required for active checks and must match hostname as configured on the server.
Allowed characters: alphanumeric, '.', ' ', '_' and '-'.
Maximum length: 64
HostnameItem no system.hostname Item used for setting Hostname if it is undefined.
Does not support UserParameters, performance counters or aliases, but does support system.run[] regardless of EnableRemoteCommands value.

Ignored if Hostname is set.

This option is supported in version 1.8.6 and higher.

See also a more detailed description.
Include no You may include individual file in the configuration file.
ListenIP no 0.0.0.0 List of comma-delimited IP addresses that the agent should listen on.
Multiple IP addresses are supported since Zabbix 1.8.3.
ListenPort no 1024-32767 10050 Agent will listen on this port for connections from the server.
LogFileSize no 0-1024 1 Maximum size of log file in MB.
0 - disable automatic log rotation.
LogFile no Name of log file.
If not set, Windows Event Log is used.
LogRemoteCommands no 0 Enable logging of executed shell commands as warnings.
0 - disabled
1 - enabled
MaxLinesPerSecond no 1-1000 100 Maximum number of new lines the agent will send per second to Zabbix server
or proxy processing 'log', 'logrt' and 'eventlog' active checks.
The provided value will be overridden by the parameter 'maxlines',
provided in 'log', 'logrt' or 'eventlog' item keys.
PerfCounter no Syntax: <parameter_name>,“<perf_counter_path>”,<period>
Defines new parameter <parameter_name> which is an average value for system performance counter <perf_counter_path> for the specified time period <period> (in seconds).
For example, if you wish to receive average number of processor interrupts per second for last minute, you can define new parameter “interrupts” as following:
PerfCounter = interrupts,“\Processor(0)\Interrupts/sec”,60
Please note double quotes around performance counter path.
The parameter name (interrupts) is to be used as the item key when creating an item.
Samples for calculating average value will be taken every second.
You may run “typeperf -qx” to get list of all performance counters available in Windows.
RefreshActiveChecks no 60-3600 120 How often 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 no List of comma delimited IP addresses (or hostnames) of Zabbix servers. No spaces allowed.
Incoming connections will be accepted only from the hosts listed here.
If IPv6 support is enabled then '127.0.0.1', '::127.0.0.1', '::ffff:127.0.0.1' are treated equally.
ServerActive no IP:port (or hostname:port) of Zabbix server or Zabbix proxy for active checks.
Multiple comma-delimited addresses can be provided to use several independent Zabbix servers in parallel. No spaces 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.
SourceIP no Source IP address for outgoing connections.
StartAgents no 0-63 (*) 3 Number of pre-forked instances of zabbix_agentd that process passive checks.
If set to 0, disables passive checks and the agent will not listen on any TCP port.
The upper limit used to be 16 before version 1.8.5.
Timeout no 1-30 3 Spend no more than Timeout seconds on processing
UnsafeUserParameters no 0-1 0 Allow all characters to be passed in arguments to user-defined parameters.
0 - do not allow
1 - allow
UserParameter 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.
Example: UserParameter=system.test,echo 1
(*) The number of active servers listed in ServerActive plus the number of pre-forked instances for passive checks specified in StartAgents must be less than 64.
In Zabbix agent 2.0.0 version configuration parameters related to active and passive checks have been changed.
See the "See also" section at the bottom of this page to read more details about these changes.
Zabbix supports configuration files only in UTF-8 encoding without BOM.

See also