[comment]: # attributes: notoc [comment]: # ({4963afdf-4963afdf}) # 6 Zabbix agent 2 (Windows) [comment]: # ({/4963afdf-4963afdf}) [comment]: # ({94748412-9fe069f9}) ### Overview Zabbix agent 2 is a new generation of Zabbix agent and may be used in place of Zabbix agent. The parameters supported by the Windows Zabbix agent 2 configuration file (zabbix\_agent2.conf) are listed in this section. The parameters are listed without additional information. Click on the parameter to see the full details. |Parameter|Description| |--|--------| |[Alias](#alias)|Sets an alias for an item key.| |[AllowKey](#allowkey)|Allow the execution of those item keys that match a pattern.| |[BufferSend](#buffersend)|Do not keep data longer than N seconds in buffer.| |[BufferSize](#buffersize)|The maximum number of values in the memory buffer.| |[ControlSocket](#controlsocket)|The control socket, used to send runtime commands with the '-R' option.| |[DebugLevel](#debuglevel)|The debug level.| |[DenyKey](#denykey)|Deny the execution of those item keys that match a pattern.| |[EnablePersistentBuffer](#enablepersistentbuffer)|Enable the usage of local persistent storage for active items.| |[ForceActiveChecksOnStart](#forceactivechecksonstart)|Perform active checks immediately after the restart for the first received configuration.| |[HeartbeatFrequency](#heartbeatfrequency)|The frequency of heartbeat messages in seconds.| |[HostInterface](#hostinterface)|An optional parameter that defines the host interface.| |[HostInterfaceItem](#hostinterfaceitem)|An optional parameter that defines an item used for getting the host interface.| |[HostMetadata](#hostmetadata)|An optional parameter that defines the host metadata.| |[HostMetadataItem](#hostmetadataitem)|An optional parameter that defines a Zabbix agent item used for getting the host metadata.| |[Hostname](#hostname)|An optional parameter that defines the hostname.| |[HostnameItem](#hostnameitem)|An optional parameter that defines a Zabbix agent item used for getting the hostname.| |[Include](#include)|You may include individual files or all files in a directory in the configuration file.| |[ListenIP](#listenip)|A list of comma-delimited IP addresses that the agent should listen on.| |[ListenPort](#listenport)|The agent will listen on this port for connections from the server.| |[LogFile](#logfile)|The name of the log file.| |[LogFileSize](#logfilesize)|The maximum size of the log file.| |[LogType](#logtype)|The type of the log output.| |[PersistentBufferFile](#persistentbufferfile)|The file where Zabbix agent 2 should keep the SQLite database.| |[PersistentBufferPeriod](#persistentbufferperiod)|The time period for which data should be stored when there is no connection to the server or proxy.| |[Plugins..System.Capacity](#plugins.systemcapacity)|The limit of checks per plugin that can be executed at the same time.| |[Plugins.Log.MaxLinesPerSecond](#plugins.log.maxlinespersecond)|The maximum number of new lines the agent will send per second to Zabbix server or proxy when processing 'log' and 'logrt' active checks.| |[Plugins.SystemRun.LogRemoteCommands](#plugins.systemrun.logremotecommands)|Enable the logging of the executed shell commands as warnings.| |[PluginSocket](#pluginsocket)|The path to the UNIX socket for loadable plugin communications.| |[PluginTimeout](#plugintimeout)|The timeout for connections with loadable plugins, in seconds.| |[PerfCounter](#perfcounter)|Defines a new parameter which is the average value for system performance counter for the specified time period (in seconds).| |[PerfCounterEn](#perfcounteren)|Defines a new parameter which is the average value for system performance counter for the specified time period (in seconds). Compared to PerfCounter, the perfcounter paths must be in English.| |[RefreshActiveChecks](#refreshactivechecks)|How often the list of active checks is refreshed.| |[Server](#server)|A list of comma-delimited IP addresses, optionally in CIDR notation, or DNS names of Zabbix servers and Zabbix proxies.| |[ServerActive](#serveractive)|The Zabbix server/proxy address or cluster configuration to get active checks from.| |[SourceIP](#sourceip)|The source IP address.| |[StatusPort](#statusport)|If set, the agent will listen on this port for HTTP status requests (http://localhost:/status).| |[Timeout](#timeout)|Specifies how long to wait (in seconds) for establishing connection and exchanging data with Zabbix proxy or server.| |[TLSAccept](#tlsaccept)|What incoming connections to accept.| |[TLSCAFile](#tlscafile)|The full pathname of a file containing the top-level CA(s) certificates for peer certificate verification, used for encrypted communications between Zabbix components.| |[TLSCertFile](#tlscertfile)|The full pathname of a file containing the agent certificate or certificate chain, used for encrypted communications between Zabbix components.| |[TLSCipherAll13](#tlscipherall13)|The OpenSSL cipher string (TLS 1.3). Override the default ciphersuite selection criteria for certificate- and PSK-based encryption.| |[TLSCipherCert13](#tlsciphercert13)|The OpenSSL cipher string (TLS 1.3). Override the default ciphersuite selection criteria for certificate-based encryption.| |[TLSCipherPSK13](#tlscipherpsk13)|The OpenSSL cipher string (TLS 1.3). Override the default ciphersuite selection criteria for PSK-based encryption.| |[TLSConnect](#tlsconnect)|How the agent should connect to Zabbix server or proxy.| |[TLSCRLFile](#tlscrlfile)|The full pathname of a file containing revoked certificates. This parameter is used for encrypted communications between Zabbix components.| |[TLSKeyFile](#tlskeyfile)|The full pathname of a file containing the agent private key, used for encrypted communications between Zabbix components.| |[TLSPSKFile](#tlspskfile)|The full pathname of a file containing the agent pre-shared key, used for encrypted communications with Zabbix server.| |[TLSPSKIdentity](#tlspskidentity)|The pre-shared key identity string, used for encrypted communications with Zabbix server.| |[TLSServerCertIssuer](#tlsservercertissuer)|The allowed server (proxy) certificate issuer.| |[TLSServerCertSubject](#tlsservercertsubject)|The allowed server (proxy) certificate subject.| |[UnsafeUserParameters](#unsafeuserparameters)|Allow all characters to be passed in arguments to user-defined parameters.| |[UserParameter](#userparameter)|A user-defined parameter to monitor.| |[UserParameterDir](#userparameterdir)|The default search path for UserParameter commands.| All parameters are non-mandatory unless explicitly stated that the parameter is mandatory. Note that: - The default values reflect process defaults, not the values in the shipped configuration files; - Values support [environment variables](/manual/appendix/config/environment_variables); - Zabbix supports configuration files only in UTF-8 encoding without [BOM](https://en.wikipedia.org/wiki/Byte_order_mark); - Comments starting with "\#" are only supported in the beginning of the line. [comment]: # ({/94748412-9fe069f9}) [comment]: # ({8085875f-324d4c30}) ### Parameter details [comment]: # ({/8085875f-324d4c30}) [comment]: # ({0e8f6372-fa6993fd}) ##### Alias Sets an alias for an item key. It can be used to substitute a long and complex item key with a shorter and simpler one.
Multiple *Alias* parameters may be present. Multiple parameters with the same *Alias* key are not allowed.
Different *Alias* keys may reference the same item key.
Aliases can be used in *HostMetadataItem* but not in the *HostnameItem* parameter. Example 1: Retrieving the paging file usage in percentage from the server. ```default Alias=pg_usage:perf_counter[\Paging File(_Total)\% Usage] ``` Now the shorthand key **pg_usage** may be used to retrieve data. Example 2: Getting the CPU load with default and custom parameters. ```default Alias=cpu.load:system.cpu.load Alias=cpu.load[*]:system.cpu.load[*] ``` This allows use **cpu.load** key to get the CPU load with default parameters as well as use **cpu.load[percpu,avg15]** to get specific data about the CPU load. Example 3: Running multiple [low-level discovery](/manual/discovery/low_level_discovery) rules processing the same discovery items. ```default 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. [comment]: # ({/0e8f6372-fa6993fd}) [comment]: # ({3ed0c834-e05b8a23}) ##### AllowKey Allow the execution of those item keys that match a pattern. The key pattern is a wildcard expression that supports the "\*" 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. See also: [Restricting agent checks](/manual/config/items/restrict_checks). [comment]: # ({/3ed0c834-e05b8a23}) [comment]: # ({fc56d912-5d573779}) ##### BufferSend The time interval in seconds which determines how often values are sent from the buffer to Zabbix server.
Note that if the buffer is full, the data will be sent sooner. Default: `5`
Range: 1-3600 [comment]: # ({/fc56d912-5d573779}) [comment]: # ({bd027b5f-adbf2018}) ##### BufferSize The maximum number of values in the memory buffer. The agent will send all collected data to the Zabbix server or proxy if the buffer is full.
This parameter should only be used if persistent buffer is disabled (*EnablePersistentBuffer=0*). Default: `1000`
Range: 2-65535 [comment]: # ({/bd027b5f-adbf2018}) [comment]: # ({78069119-dee4d084}) ##### ControlSocket The control socket, used to send runtime commands with the '-R' option. Default: `\\.\pipe\agent.sock` [comment]: # ({/78069119-dee4d084}) [comment]: # ({9c071f70-74594585}) ##### DebugLevel Specify the debug level:
*0* - basic information about starting and stopping of Zabbix processes
*1* - critical information;
*2* - error information;
*3* - warnings;
*4* - for debugging (produces lots of information);
*5* - extended debugging (produces even more information). Default: `3`
Range: 0-5 [comment]: # ({/9c071f70-74594585}) [comment]: # ({26eddabd-ad027e43}) ##### DenyKey Deny the execution of those item keys that match a pattern. The key pattern is a wildcard expression that supports the "\*" 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. See also: [Restricting agent checks](/manual/config/items/restrict_checks). [comment]: # ({/26eddabd-ad027e43}) [comment]: # ({ae3ff74a-d9d538db}) ##### EnablePersistentBuffer Enable the usage of local persistent storage for active items. If persistent storage is disabled, the memory buffer will be used. Default: `0`
Values: 0 - disabled, 1 - enabled [comment]: # ({/ae3ff74a-d9d538db}) [comment]: # ({da2ce1bd-1970c2c5}) ##### ForceActiveChecksOnStart Perform active checks immediately after the restart for the first received configuration. Also available as a per-plugin configuration parameter, for example: `Plugins.Uptime.System.ForceActiveChecksOnStart=1` Default: `0`
Values: 0 - disabled, 1 - enabled [comment]: # ({/da2ce1bd-1970c2c5}) [comment]: # ({70ff69c8-bce527af}) ##### HeartbeatFrequency The frequency of heartbeat messages in seconds. Used for monitoring the availability of active checks.
0 - heartbeat messages disabled. Default: `60`
Range: 0-3600 [comment]: # ({/70ff69c8-bce527af}) [comment]: # ({1d584bf3-9d3624af}) ##### HostInterface An optional parameter that defines the host interface (IP address or DNS name) used during the host [autoregistration](/manual/discovery/auto_registration) process. This value will be used to populate the interface in the newly created host, and allows configuring either IP or DNS address explicitly. For more details, see [Using DNS as default interface](/manual/discovery/auto_registration#using_dns_as_default_interface). If not defined, the value will be acquired from HostInterfaceItem. The agent will issue an error and not start if the value is over the limit of 255 characters. Range: 0-255 characters [comment]: # ({/1d584bf3-9d3624af}) [comment]: # ({46385051-7378e07f}) ##### HostInterfaceItem An optional parameter that defines an item used to determine the host interface (IP address or DNS name) during the host [autoregistration](/manual/discovery/auto_registration) process. This value is used only if HostInterface is not defined. For more details, see [Using DNS as default interface](/manual/discovery/auto_registration#using_dns_as_default_interface). During an autoregistration request the agent will log a warning message if the value returned by the specified item is over the limit of 255 characters. The [system.run[]](/manual/config/items/itemtypes/zabbix_agent#system.run) item is supported regardless of AllowKey/DenyKey settings. [comment]: # ({/46385051-7378e07f}) [comment]: # ({ed067cab-3b42353f}) ##### HostMetadata An optional parameter that defines the [metadata](/manual/discovery/auto_registration#using-host-metadata) used to identify or distinguish the host during the host [autoregistration](/manual/discovery/auto_registration) process (active agent). HostMetadata allows distinguishing between hosts beyond the hostname. If not defined, the value will be acquired from HostMetadataItem. The agent will issue an error and not start if the specified value is over the limit of 2034 bytes or a non-UTF-8 string. When a parameter expects an IP address or DNS name, values that are valid UTF-8 but are not valid IPs or DNS names will also be rejected and reported as invalid. Multi-line metadata is not supported — the output will be truncated at the first line break. Range: 0-2034 bytes [comment]: # ({/ed067cab-3b42353f}) [comment]: # ({1ef8844f-eff97518}) ##### HostMetadataItem An optional parameter that defines a Zabbix agent item used to obtain [host metadata](/manual/discovery/auto_registration#using-host-metadata). This option is only used when HostMetadata is not defined. The HostMetadataItem value is retrieved on each [autoregistration](/manual/discovery/auto_registration) attempt and is used only at host autoregistration process (active agent). HostMetadataItem allows distinguishing between hosts beyond the hostname. User parameters and aliases are supported. The [system.run[]](/manual/config/items/itemtypes/zabbix_agent#system.run) item is supported regardless of AllowKey/DenyKey settings. During an autoregistration request the agent will log a warning message if the value returned by the specified item is over the limit of 65535 UTF-8 code points. The value returned by the item must be a UTF-8 string otherwise it will be ignored. When a parameter expects an IP address or DNS name, values that are valid UTF-8 but are not valid IPs or DNS names will also be rejected and reported as invalid. Multi-line metadata is not supported — the output will be truncated at the first line break. [comment]: # ({/1ef8844f-eff97518}) [comment]: # ({39406dda-542b591a}) ##### Hostname A list of comma-delimited, unique, case-sensitive hostnames. Required for active checks and must match hostnames as configured on the server. The value is acquired from HostnameItem if undefined.
Allowed characters: alphanumeric, '.', ' ', '\_' and '-'. Maximum length: 128 characters per hostname, 2048 characters for the entire line. Default: Set by HostnameItem [comment]: # ({/39406dda-542b591a}) [comment]: # ({77a62307-085b8ddc}) ##### HostnameItem An optional parameter that defines an item used for getting the host name. This option is only used when Hostname is not defined. User parameters or aliases are not supported, but the [system.run[]](/manual/config/items/itemtypes/zabbix_agent#system.run) item is supported regardless of AllowKey/DenyKey values. Default: `system.hostname` [comment]: # ({/77a62307-085b8ddc}) [comment]: # ({183802f3-d06cc342}) ##### Include You may include individual files or all files in a directory in the configuration file (located in `C:\Program Files\Zabbix Agent 2` by default if Zabbix agent is installed using Windows MSI installer packages; located in the folder specified during installation if Zabbix agent is installed as a zip archive). 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.
See [special notes](special_notes_include) about limitations. Example: ```default Include=C:\Program Files\Zabbix Agent2\zabbix_agent2.d\*.conf ``` [comment]: # ({/183802f3-d06cc342}) [comment]: # ({43e741ee-21abf7b1}) ##### ListenIP A list of comma-delimited IP addresses that the agent should listen on. The first IP address is sent to the Zabbix server, if connecting to it, to retrieve the list of active checks. Default: `0.0.0.0` [comment]: # ({/43e741ee-21abf7b1}) [comment]: # ({5f95bc53-2f2c8140}) ##### ListenPort The agent will listen on this port for connections from the server. Default: `10050`
Range: 1024-32767 [comment]: # ({/5f95bc53-2f2c8140}) [comment]: # ({d3241aab-988826b6}) ##### LogFile The name of the agent log file. Default: `c:\zabbix_agent2.log`
Mandatory: Yes, if LogType is set to *file*; otherwise no [comment]: # ({/d3241aab-988826b6}) [comment]: # ({f7604f8f-ae05fc8d}) ##### LogFileSize The maximum size of a 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. Default: `1`
Range: 0-1024 [comment]: # ({/f7604f8f-ae05fc8d}) [comment]: # ({4226072e-e8dc6df9}) ##### LogType The type of the log output:
*file* - write log to the file specified by LogFile parameter;
*console* - write log to standard output. Default: `file` [comment]: # ({/4226072e-e8dc6df9}) [comment]: # ({357a4f09-dde3e6b9}) ##### PersistentBufferFile The file where Zabbix agent 2 should keep the SQLite database. Must be a full filename. This parameter is only used if persistent buffer is enabled (*EnablePersistentBuffer=1*). [comment]: # ({/357a4f09-dde3e6b9}) [comment]: # ({2937cc76-379dc265}) ##### PersistentBufferPeriod 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*). Default: `1h`
Range: 1m-365d [comment]: # ({/2937cc76-379dc265}) [comment]: # ({9b0fb2d6-a2a522ee}) ##### Plugins..System.Capacity {#plugins.systemcapacity} The limit of checks per `` plugin that can be executed at the same time. Default: `1000` Range: 1-1000 [comment]: # ({/9b0fb2d6-a2a522ee}) [comment]: # ({99218c04-c6daef84}) ##### Plugins.Log.MaxLinesPerSecond The maximum number of new lines the agent will send per second to Zabbix server or proxy when processing 'log', 'logrt' and 'eventlog' active checks. The provided value will be overridden by the 'maxlines' parameter, provided in the 'log', 'logrt' or 'eventlog' item key.
*Note*: Zabbix will process 10 times more new lines than set in *MaxLinesPerSecond* to seek the required string in log items. Default: `20`
Range: 1-1000 [comment]: # ({/99218c04-c6daef84}) [comment]: # ({487e5b60-d7133c6e}) ##### Plugins.SystemRun.LogRemoteCommands Enable the logging of the executed shell commands as warnings. The commands will be logged only if executed remotely. Log entries will not be created if system.run\[\] is launched locally by the HostMetadataItem, HostInterfaceItem or HostnameItem parameters. Default: `0`
Values: 0 - disabled, 1 - enabled [comment]: # ({/487e5b60-d7133c6e}) [comment]: # ({9450d7ef-c712bfb8}) ##### PluginSocket The path to the UNIX socket for loadable plugin communications. Default: `\\.\pipe\agent.plugin.sock` [comment]: # ({/9450d7ef-c712bfb8}) [comment]: # ({14afe8ce-1db534a6}) ##### PluginTimeout The timeout for connections with loadable plugins, in seconds. Default: `Timeout`
Range: 1-30 [comment]: # ({/14afe8ce-1db534a6}) [comment]: # ({444f6259-104bd089}) ##### PerfCounter Defines a new parameter which is the average value for system performance counter for the specified time period (in seconds).
Syntax: ,"", For example, if you wish to receive the average number of processor interrupts per second for the last minute, you can define a new parameter "interrupts" as the following:
```default PerfCounter = interrupts,"\Processor(0)\Interrupts/sec",60 ``` Please note the double quotes around the performance counter path. The parameter name (interrupts) is to be used as the item key when creating an item. Samples for calculating the average value will be taken every second.
You may run "typeperf -qx" to get the list of all performance counters available in Windows. [comment]: # ({/444f6259-104bd089}) [comment]: # ({c2cc7bf4-b31fd405}) ##### PerfCounterEn Defines a new parameter which is the average value for system performance counter for the specified time period (in seconds). Compared to PerfCounter, the perfcounter paths must be in English. Supported only on **Windows Server 2008/Vista** and later.
Syntax: ,"", For example, if you wish to receive the average number of processor interrupts per second for the last minute, you can define a new parameter "interrupts" as the following:
```default PerfCounterEn = interrupts,"\Processor(0)\Interrupts/sec",60 ``` Please note the double quotes around the performance counter path. The parameter name (interrupts) is to be used as the item key when creating an item. Samples for calculating the average value will be taken every second.
You can find the list of English strings by viewing the following registry key: `HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Perflib\009`. [comment]: # ({/c2cc7bf4-b31fd405}) [comment]: # ({3d47a4c2-25e3871b}) ##### RefreshActiveChecks 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 in 60 seconds. Default: `5`
Range: 1-86400 [comment]: # ({/3d47a4c2-25e3871b}) [comment]: # ({bb2bfe8d-0ad80cbc}) ##### Server A list of comma-delimited IP addresses, optionally in CIDR notation, or DNS names of Zabbix servers or Zabbix proxies. 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 and '::/0' will allow any IPv4 or IPv6 address. '0.0.0.0/0' can be used to allow any IPv4 address. Spaces are allowed. If this parameter is not specified, disables passive checks and the agent will not listen on any TCP port. Example: ```default Server=127.0.0.1,192.168.1.0/24,::1,2001:db8::/32,zabbix.example.com ``` [comment]: # ({/bb2bfe8d-0ad80cbc}) [comment]: # ({56b8410d-0d31e03a}) ##### ServerActive The Zabbix server/proxy address or cluster configuration to get active checks from. The server/proxy address is an IP address or DNS name and optional port separated by colon.
The cluster configuration is one or more server or proxy group member addresses separated by semicolon. Multiple Zabbix servers/clusters and Zabbix proxies can be specified, separated by comma. Unless using proxy groups, more than one Zabbix proxy should not be specified from each Zabbix server/cluster. If a Zabbix proxy is specified then Zabbix server/cluster for that proxy should not be specified.
Multiple comma-delimited addresses can be provided to use several independent Zabbix servers in parallel. Spaces are allowed.
If the 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 Zabbix proxy: ```default ServerActive=127.0.0.1:10051 ``` Example for Zabbix proxy group: ServerActive=proxy1.example.com;proxy2.example.com;proxy3.example.com;proxy4.example.com;proxy5.example.com Example for multiple servers: ```default ServerActive=127.0.0.1:20051,zabbix.domain,\[::1\]:30051,::1,\[12fc::1\] ``` Example for high availability: ```default ServerActive=zabbix.cluster.node1;zabbix.cluster.node2:20051;zabbix.cluster.node3 ``` Example for high availability with two clusters and one server: ```default ServerActive=zabbix.cluster.node1;zabbix.cluster.node2:20051,zabbix.cluster2.node1;zabbix.cluster2.node2,zabbix.domain ``` [comment]: # ({/56b8410d-0d31e03a}) [comment]: # ({76194937-f96761ad}) ##### SourceIP The source IP address for: - outgoing connections to Zabbix server or Zabbix proxy; - making connections while executing some items (web.page.get, net.tcp.port, etc.). [comment]: # ({/76194937-f96761ad}) [comment]: # ({7d3f343b-8b9a658a}) ##### StatusPort If set, the agent will listen on this port for HTTP status requests (http://localhost:/status). Range: 1024-32767 [comment]: # ({/7d3f343b-8b9a658a}) [comment]: # ({37e987ac-baa42b03}) ##### Timeout Specifies how long to wait (in seconds) for establishing connection and exchanging data with Zabbix proxy or server.
This parameter defines the duration of various communication operations, including: - awaiting a response from the Zabbix server; - sending requests to Zabbix server, including item configuration requests and item data in [active checks](/manual/appendix/items/activepassive#active-checks); - retrieving log data through logfile or Windows event log monitoring; - sending heartbeat messages; - maximum duration for `vfs.*` checks; - serving as a fallback in scenarios where a server or proxy older than version 7.0 sends checks without timeouts. This timeout will **not** be used for those agent checks that have configurable timeout settings in the frontend (on global, proxy, or per-item level). Default: `3`
Range: 1-30 [comment]: # ({/37e987ac-baa42b03}) [comment]: # ({2200adc7-5fffe23e}) ##### TLSAccept The incoming connections to accept. Used for 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 Mandatory: yes, if TLS certificate or PSK parameters are defined (even for *unencrypted* connection); otherwise no [comment]: # ({/2200adc7-5fffe23e}) [comment]: # ({65d07bda-01a58fb9}) ##### TLSCAFile The full pathname of the file containing the top-level CA(s) certificates for peer certificate verification, used for encrypted communications between Zabbix components. [comment]: # ({/65d07bda-01a58fb9}) [comment]: # ({005f60f1-64ff2b38}) ##### TLSCertFile The full pathname of the file containing the agent certificate or certificate chain, used for encrypted communications with Zabbix components. [comment]: # ({/005f60f1-64ff2b38}) [comment]: # ({22f70994-63d2a63f}) ##### TLSCipherAll13 The OpenSSL cipher string (TLS 1.3). Override the default ciphersuite selection criteria for certificate- and PSK-based encryption. Example: ```default TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256 ``` [comment]: # ({/22f70994-63d2a63f}) [comment]: # ({f390777c-4312ca04}) ##### TLSCipherCert13 The OpenSSL cipher string (TLS 1.3). Override the default ciphersuite selection criteria for certificate-based encryption. Note that this parameter cannot be used together with `TLSAccept=cert,psk`; for certificate connection (`TLSConnect=cert`) use TLSCipherAll13 instead. [comment]: # ({/f390777c-4312ca04}) [comment]: # ({07c8874d-6944686a}) ##### TLSCipherPSK13 The OpenSSL cipher string (TLS 1.3). Override the default ciphersuite selection criteria for PSK-based encryption. Example: ```default TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256 ``` [comment]: # ({/07c8874d-6944686a}) [comment]: # ({e2ebc18f-0c14341a}) ##### TLSConnect How the agent should connect to Zabbix 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 Mandatory: yes, if TLS certificate or PSK parameters are defined (even for *unencrypted* connection); otherwise no [comment]: # ({/e2ebc18f-0c14341a}) [comment]: # ({ad4dc889-353fa6b2}) ##### TLSCRLFile The full pathname of the file containing revoked certificates. This parameter is used for encrypted communications between Zabbix components. [comment]: # ({/ad4dc889-353fa6b2}) [comment]: # ({c2aa4315-40db7da5}) ##### TLSKeyFile The full pathname of the file containing the agent private key, used for encrypted communications between Zabbix components. [comment]: # ({/c2aa4315-40db7da5}) [comment]: # ({11defa44-216346d5}) ##### TLSPSKFile The full pathname of the file containing the agent pre-shared key, used for encrypted communications with Zabbix server. [comment]: # ({/11defa44-216346d5}) [comment]: # ({92d3eff0-d9d037af}) ##### TLSPSKIdentity The pre-shared key identity string, used for encrypted communications with Zabbix server. [comment]: # ({/92d3eff0-d9d037af}) [comment]: # ({ae5c568f-4a08c667}) ##### TLSServerCertIssuer The allowed server (proxy) certificate issuer. [comment]: # ({/ae5c568f-4a08c667}) [comment]: # ({fb69617f-6446ac76}) ##### TLSServerCertSubject The allowed server (proxy) certificate subject. [comment]: # ({/fb69617f-6446ac76}) [comment]: # ({bac62bc8-42a95de3}) ##### UnsafeUserParameters Allow all characters to be passed in arguments to user-defined parameters. The following characters are not allowed: \\ ' " \` \* ? \[ \] { } \~ $ ! & ; ( ) < > \| \# @ %
Additionally, newline characters are not allowed. Default: `0`
Values: 0 - do not allow, 1 - allow [comment]: # ({/bac62bc8-42a95de3}) [comment]: # ({e817d9a2-cba7618d}) ##### UserParameter A user-defined parameter to monitor. There can be several user-defined parameters.
Format: UserParameter=,
Note that the shell command must not return empty string or EOL only. Shell commands may have relative paths, if the UserParameterDir parameter is specified. Example: ```default UserParameter=system.test,dir /b | find /c /v "" UserParameter=check_cpu,.\custom\_script.bat ``` [comment]: # ({/e817d9a2-cba7618d}) [comment]: # ({c9cc7c82-f6be7620}) ##### UserParameterDir The 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: ```default UserParameterDir=C:\opt\myscripts ``` [comment]: # ({/c9cc7c82-f6be7620})