4 Zabbix агент 2 (UNIX)

Zabbix агент 2 - новое поколение Zabbix агента и может использоваться в качестве замены Zabbix агента.

В этом разделе перечислены параметры, поддерживаемые в файле конфигурации Zabbix агента 2 (zabbix_agent2.conf). Обратите внимание, что:

  • Значения по умолчанию отражают значения по умолчанию процесса, а не значения в поставляемых файлах конфигурации;
  • Zabbix поддерживает файлы конфигурации только в кодировке UTF-8 без BOM;
  • Комментарии, начинающиеся с "#", поддерживаются только в начале строки.

Поддерживаемые параметры в файле конфигурации Zabbix агента 2 (zabbix_agent2):

Параметр Обязательный Диапазон Умолчание Описание
Alias нет Задает алиас ключу элемента данных. Его можно использовать для замены длинных и сложных ключей элементов данных на более простые и короткие.
Можно добавлять несколько параметров Alias. Разрешено указывать несколько параметров с одинаковым ключом Alias.
Несколько ключей Alias могут ссылаться на один и тот же ключ.
Алиасы можно использовать в HostMetadataItem, но нельзя в HostnameItem параметрах.

Примеры:

1. Получение ID пользователя 'zabbix'.
Alias=zabbix.userid:vfs.file.regexp[/etc/passwd,"^zabbix:.:([0-9]+)",,,,\1]
Теперь можно использовать сокращенный ключ zabbix.userid, чтобы получать данные.

2. Получение утилизации CPU с параметрами по умолчанию и с пользовательскими параметрами.
Alias=cpu.util:system.cpu.util
Alias=cpu.util[*]:system.cpu.util[*]
Такая запись позволяет использовать cpu.util ключ для получения утилизации CPU в процентах с параметрами по умолчанию, а также использовать cpu.util[all, idle, avg15] для получения конкретных данных об утилизации CPU.

3. Выполнение нескольких правил низкоуровневого обнаружения, которые обрабатывают одни и те же элементы данных обнаружения.
Alias=vfs.fs.discovery[*]:vfs.fs.discovery
Теперь имеется возможность добавить несколько правил обнаружения, используя vfs.fs.discovery с разными параметрами для каждого правила, например, vfs.fs.discovery[foo], vfs.fs.discovery[bar], и т.д.
AllowKey нет Разрешить выполнение тех ключей элементов данных, которые соответствуют шаблону. Шаблон ключа - это выражение, которое поддерживает символ «*» для соответствия любому количеству любых символов.
Несколько правил соответствия ключей могут быть определены в сочетании с DenyKey. Параметры обрабатываются по очереди в соответствии с порядком их появления.
Этот параметр поддерживается, начиная с Zabbix 5.0.0.
См. также: ограничение проверок агента.
BufferSend нет 1-3600 5 Не хранить данные в буфере дольше N секунд.
BufferSize нет 2-65535 100 Максимальное количество значений в буфере памяти. Агент будет отправлять
все собранные данные Zabbix серверу или прокси при заполнении буфера.
Обратите внимание, что если буфер заполнен, данные будут отправлены раньше.
ControlSocket нет /tmp/agent.sock Сокет управления, используется при отправке команд управления при помощи '-R' опции.
DebugLevel нет 0-5 3 Задает уровень журналирования:
0 - основная информация о запуске и остановки процессов Zabbix
1 - критичная информация
2 - информация об ошибках
3 - предупреждения
4 - для отладки (записывается очень много информации)
5 - расширенная отладка (записывается еще больше информации)
DenyKey нет Запретить выполнение тех ключей элементов данных, которые соответствуют шаблону. Шаблон ключа - это выражение, которое поддерживает символ «*» для соответствия любому количеству любых символов.
Несколько правил соответствия ключей могут быть определены в сочетании с AllowKey. Параметры обрабатываются по очереди в соответствии с порядком их появления.
Этот параметр поддерживается, начиная с Zabbix 5.0.0.
См. также: ограничение проверок агента.
EnablePersistentBuffer нет 0-1 0 Включить использование локального постоянного хранилища.
0 - отключено
1 - включено
Если постоянное хранилище отключено, будет использован буфер памяти.
HostInterface нет 0-255 символов Необязательный параметр, определяющий интерфейс узла сети.
Интерфейс хоста используется в процессе автоматической регистрации узла сети.
Агент выдаст ошибку и не запустится, если значение превышает ограничение в 255 символов.
Если значение не определено, значение будет получено от HostInterfaceItem.
Поддерживается, начиная с Zabbix 4.4.0.
HostInterfaceItem нет Необязательный параметр, который определяет элемент данных, используемый для получения интерфейса узла сети.
Интерфейс узла сети используется в процессе автоматической регистрации узла сети.
Во время запроса на автоматическую регистрацию агент регистрирует предупреждающее сообщение, если значение, возвращаемое указанным элементом данных, превышает ограничение в 255 символов.
Эта опция используется только когда HostInterface не определен.
Поддерживается, начиная с Zabbix 4.4.0.
HostMetadata нет 0-255 символов Опциональный параметр, который задает метаданные узла сети. Метаданные узла сети используются только в процессе автоматической регистрации узлов сети (активный агент).
Агент выдаст ошибку и не запустится, если указанное значение выходит за лимит длины строки или не является UTF-8 строкой.
Если не определено, то значение берётся от HostMetadataItem.
HostMetadataItem нет Опциональный параметр, который задает элемент данных, чтобы затем использовать его для получения метаданных узла сети.
В процессе запроса авторегистрации агент запишет в журнал предупреждающее сообщение, если полученное значение от указанного элемента данных выходит за лимит в 255 символов.
Этот параметр используется только, если HostMetadata не определен.
Поддерживаются UserParameters и алиасы. Поддерживается system.run[] независимо от значения EnableRemoteCommands.
Значение полученное от указанного элемента данных должно являться UTF-8 строкой, в противном случае оно будет игнорироваться.
Hostname нет Задается HostnameItem'ом Уникальное, регистрозависимое имя хоста.
Требуется для активных проверок и должно совпадать с именем узла сети указанном на сервере.
Допустимые символы: буквенно-цифровые, '.', ' ', '_' и '-'.
Максимальная длина: 128
HostnameItem нет system.hostname Элемент данных, который используется для формирования Hostname, если этот параметр не указан. Игнорируется, если задан параметр Hostname.
Не поддерживает UserParameters, счетчики производительности и алиасы, но поддерживает system.run[], независимо от значения EnableRemoteCommands.
Include нет Вы можете включить отдельные файлы или все файлы из папки с файлом конфигурации.
В процессе инсталляции Zabbix будет создана директория для включения файлов в /usr/local/etc, независимо от того изменена она или нет в процессе компиляции.
Для включения только необходимых файлов из указанной папки, поддерживается символ звездочки для поиска совпадения по маске. Например: /абсолютный/путь/к/файлам/конфигурации/*.conf.
Смотрите специальные заметки по поводу ограничений.
ListenIP нет 0.0.0.0 Список IP адресов разделенных запятыми, которые должен слушать агент.
Первый IP адрес отправляется на Zabbix сервер, если удается подключиться к нему, тогда происходит получение списка активных проверок.
ListenPort нет 1024-32767 10050 Агент будет слушать этот порт для подключений с сервера.
LogFile Да, если LogType задан как file, иначе
нет.
/tmp/zabbix_agentd.log Имя файла журнала, если LogType равен значению 'file'.
LogFileSize нет 0-1024 1 Максимальный размер файла журнала в МБ.
0 - отключение автоматической ротации журнала.
Примечание: Если лимит достигнут и ротация не удалась, по каким-либо причинам, существующий файл журнала очищается и начинается новый.
LogType нет file Задает место куда будут записываться сообщения журнала:
system - запись журнала в syslog,
file - запись журнала в файл указанный в LogFile параметре,
console - вывод журнала в стандартный вывод.
PersistentBufferFile нет Файл, в котором Zabbix агент 2 должен хранить базу данных SQLite.
Обязательно указывать полное имя файла.
Этот параметр используется, только если включен постоянный буфер (EnablePersistentBuffer=1).
PersistentBufferPeriod нет 1m-365d 1h Период времени, в течение которого должны храниться данные, когда нет соединения с сервером или прокси. Более старые данные будут потеряны. Данные журнала будут сохранены.
Этот параметр используется, только если включен постоянный буфер (EnablePersistentBuffer=1).
PidFile нет /tmp/zabbix_agent2.pid Имя PID файла.
Plugins нет Плагины могут иметь один и более специфичных параметров конфигурации в формате:
Plugins.<ИмяПлагина>.<Параметр1>=<значение1>
Plugins.<ИмяПлагина>.<Параметр2>=<значение2>
Plugins.<PluginName>.KeepAlive нет 60-900 300 Максимальное время ожидания (в секундах) до закрытия неиспользуемых подключаемых модулей.
Пример: Plugins.Memcached.KeepAlive=200
Поддерживается для следующих плагинов: Memcached, MySQL, Redis, PostgreSQL.
Plugins.<PluginName>.Sessions.<sessionName>.<sessionParameter> нет Параметры именованых сессий.
<sessionName> - имя объекта мониторинга.
<sessionParameter> - название параметра (допустимые: Uri, Username, Password).
Пример: Plugins.Memcached.Sessions.Memcached1.Uri=tcp://localhost:11211
Plugins.Memcached.Sessions.Memcached1.Username=boss
Plugins.Memcached.Sessions.Memcached1.Password=secret
Plugins.Memcached.Sessions.Memcached2.Uri=tcp://localhost:11212 \\Поддерживается для плагинов: Memcached, MySQL, Redis, PostgreSQL.
Plugins.<PluginName>.Timeout нет 1-30 Глобальный таймаут Максимальное время ожидания (в секундах) для завершения запроса плагина.
\Поддерживается для плагинов: Memcached, MySQL, Redis, Docker, PostgreSQL.
Plugins.Docker.Entrypoint нет unix:///var/run/docker.sock Расположение unix-сокета демона Docker.
Должна содержать схему (поддерживается только unix://).
Plugins.Log.MaxLinesPerSecond нет 1-1000 20 Максимальное количество новых строк, которые агент будет отправлять в секунду на Zabbix сервер или прокси при обработке активных проверок 'log' и 'eventlog'.
Предоставленное значение будет переопределено параметром 'maxlines',
предоставленным в ключе элемента 'log' или 'eventlog'.
Обратите внимание: Zabbix обработает в 10 раз больше новых строк, чем установлено в MaxLinesPerSecond в процессе поиска нужной строки в элементах журнала.
Этот параметр поддерживается начиная с 4.4.2 и заменяет MaxLinesPerSecond.
Plugins.Postgres.Database нет postgres Имя базы данных, которое будет использоваться для PostgreSQL.
Plugins.Postgres.Host нет localhost IP адрес или DNS имя узла сети, используемого для PostgreSQL.
Примеры: localhost, 192.168.1.1
Plugins.Postgres.Port нет 5432 Порт, который будет использоваться для PostgreSQL.
Plugins.SystemRun.EnableRemoteCommands нет 0 Разрешены ли удаленные команды с Zabbix сервера.
0 - не разрешены
1 - разрешены
Этот параметр поддерживается начиная с 4.4.2 и заменяет EnableRemoteCommands.
Этот параметр не поддерживается начиная с 5.0.2, вместо этого используйте параметры AllowKey / DenyKey.
Plugins.SystemRun.LogRemoteCommands нет 0 Включение журналирования выполняемых shell команд как предупреждений.
0 - отключено
1 - включено
Этот параметр поддерживается начиная с 4.4.2 и заменяет LogRemoteCommands.
Plugins.Log.MaxLinesPerSecond нет 1-1000 20 Максимальное количество новых строк в секунду, которые агент будет отправлять Zabbix серверу или прокси при обработке активных проверок 'log' и 'eventlog'.
Указаное значение будет перезаписано параметром 'maxlines',
указанное в ключах элементов данных 'log' и 'eventlog'.
Обратите внимание: Zabbix будет обрабатывать в 10 раз больше новых строк, чем указано в MaxLinesPerSecond при поиске требуемой строки в элементах данных журналов.
Этот параметр поддерживается начиная с 4.4.2 и заменяет MaxLinesPerSecond.
RefreshActiveChecks нет 60-3600 120 Как часто обновлять список активных проверок, в секундах.
Обратите внимание, что после неуспешного обновления активных проверок, следующая попытка будет предпринята через 60 секунд.
Server да Список разделенных запятой IP адресов, опционально в CIDR нотации, или имен хостов Zabbix серверов и Zabbix прокси.
Входящие соединения будут приниматься только с хостов указанных в этом списке.
Если включена поддержка IPv6, то '127.0.0.1', '::127.0.0.1', '::ffff:127.0.0.1' обрабатываются одинаково и '::/0' разрешает все IPv4 и IPv6 адреса.
'0.0.0.0/0' можно использовать, чтобы разрешить любой IPv4 адрес.
Обратите внимание, что "IPv4-совместимые IPv6 адреса" (0000::/96 prefix) поддерживаются, но являются устаревшими согласно RFC4291 [en].
Пример: Server=127.0.0.1,192.168.1.0/24,::1,2001:db8::/32,zabbix.domain
Пробелы допускаются.
ServerActive нет Список пар IP:порт (или имя хоста:порт) Zabbix серверов или Zabbix прокси для активных проверок.
Можно указывать несколько адресов разделенных запятыми, чтобы параллельно использовать несколько независимых Zabbix серверов. Пробелы допускаются.
Если порт не указан, то используется порт по умолчанию.
IPv6 адреса должны быть заключены в квадратные скобки, если для хоста указывается порт.
Если порт порт не указан, то квадратные скобки для IPv6 адресов опциональны.
Если параметр не указан, активные проверки будут отключены.
Пример: ServerActive=127.0.0.1:20051,zabbix.example.com,[::1]:30051,::1,[12fc::1]
SourceIP нет Локальный IP адрес для исходящих подключений.
StatusPort нет 1024-32767 Если задан, агент будет слушать указанный порт для HTTP запросов состояния (http://localhost:<порт>/status).
Timeout нет 1-30 3 Тратить не более Timeout секунд при обработке.
TLSAccept да, если заданы TLS сертификат или параметры PSK (даже при незашифрованном соединении), в противном случае - нет Какие принимаются входящие подключения. Используется пассивными проверками. Можно указывать несколько значений, разделенных запятой:
unencrypted - принимать подключения без шифрования (по умолчанию)
psk - принимать подключения с TLS и pre-shared ключом (PSK)
cert - принимать подключения с TLS и сертификатом
TLSCAFile нет Абсолютный путь к файлу, который содержит сертификаты верхнего уровня CA(и) для верификации сертификата узла, используется для зашифрованных соединений между Zabbix компонентами.
TLSCertFile нет Абсолютный путь к файлу, который содержит сертификат или цепочку сертификатов, используется для зашифрованных соединений между Zabbix компонентами.
TLSConnect да, если заданы TLS сертификат или параметры PSK (даже при незашифрованном соединении), в противном случае - нет Как агент должен соединяться с Zabbix сервером или прокси. Используется активными проверками. Можно указать только одно значение:
unencrypted - подключаться без шифрования (по умолчанию)
psk - подключаться, используя TLS и pre-shared ключом (PSK)
cert - подключаться, используя TLS и сертификат
TLSCRLFile нет Абсолютный путь к файлу, который содержит отозванные сертификаты. Этот параметр используется для зашифрованных соединений между Zabbix компонентами.
TLSKeyFile нет Абсолютный путь к файлу, который содержит приватный ключ агента, используется для зашифрованных соединений между Zabbix компонентами.
TLSPSKFile нет Абсолютный путь к файлу, который содержит pre-shared ключ агента, используется для зашифрованных соединений с Zabbix сервером.
TLSPSKIdentity нет Строка идентификатор pre-shared ключа, используется для зашифрованных соединений с Zabbix сервером.
TLSServerCertIssuer нет Разрешенный эмитент сертификата сервера (прокси).
TLSServerCertSubject нет Разрешенная тема сертификата сервера (прокси).
UnsafeUserParameters нет 0,1 0 Разрешить все символы, которые можно передать аргументами в пользовательские параметры.
Не разрешены следующие символы:
\ ' " ` * ? [ ] { } ~ $ ! & ; ( ) < > | # @
Кроме того, не разрешены символы новой строки.
UserParameter нет Пользовательский параметр для мониторинга. Можно указать нескольких пользовательских параметров.
Формат: UserParameter=<ключ>,<shell команда>
Обратите внимание, что команда не должна возвращать только пустую строку или только EOL.
Например: UserParameter=system.test,who|wc -l

Overview

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

This section lists parameters supported in a Zabbix agent 2 configuration file (zabbix_agent2.conf). Note that:

  • The default values reflect process defaults, not the values in the shipped configuration files;
  • Zabbix supports configuration files only in UTF-8 encoding without BOM;
  • 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 Zabbix 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 Zabbix 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 Zabbix server or proxy if the buffer is full.
This parameter should only be used if persistent buffer is disabled (EnablePersistentBuffer=0).
ControlSocket no /tmp/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 Zabbix 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 Zabbix 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.
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 Zabbix 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.
This option is only used when HostInterface is not defined.
Supported since Zabbix 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 AllowKey/DenyKey values.
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 AllowKey/DenyKey values.
The output length is limited to 512KB.
Include no You may include individual files or all files in a directory in the configuration file.
During installation Zabbix will create the include directory in /usr/local/etc, unless modified during the compile time.
To only include relevant files in the specified directory, the asterisk wildcard character is supported for pattern matching. For example: /absolute/path/to/config/files/*.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 Zabbix 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
/tmp/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:
system - syslog,
file - file specified by LogFile parameter,
console - standard output.
PersistentBufferFile no The file, where Zabbix 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).
PidFile no /tmp/zabbix_agent2.pid Name of PID file.
Plugins no A plugin can have one or more plugin-specific configuration parameters in the format:
Plugins.<PluginName>.<Parameter1>=<value1>
Plugins.<PluginName>.<Parameter2>=<value2>
Plugins.<PluginName>.KeepAlive no 60-900 300 The maximum time of waiting (in seconds) before unused plugin connections are closed.
Supported for the following plugins: Ceph, Memcached, MongoDB, MySQL, Oracle, Redis, PostgreSQL.
<PluginName> - name of the plugin.
Example: Plugins.Memcached.KeepAlive=200
Plugins.<PluginName>.Timeout no 1-30 global timeout Request execution timeout (how long to wait for a request to complete before shutting it down).
Supported for the following plugins: Docker, Memcached, Modbus, MongoDB, MQTT, MySQL, Redis, PostgreSQL, Smart, WebCertificate.
Plugins.Ceph.InsecureSkipVerify no false / true false Determines whether an http client should verify the server's certificate chain and host name.
If true, TLS accepts any certificate presented by the server and any host name in that certificate. In this mode, TLS is susceptible to man-in-the-middle attacks (should be used only for testing).
Plugins.Docker.Endpoint no unix:///var/run/docker.sock Docker daemon unix-socket location.
Must contain a scheme (only unix:// is supported).
Plugins.Log.MaxLinesPerSecond no 1-1000 20 Maximum number of new lines the agent will send per second to Zabbix 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: Zabbix 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.Oracle.CallTimeout no 1-30 global timeout The maximum wait time in seconds for a request to be completed.
Plugins.Oracle.ConnectTimeout no 1-30 global timeout The maximum wait time in seconds for a connection to be established.
Plugins.Oracle.CustomQueriesPath no Full pathname of a directory containing .sql files with custom queries.
Disabled by default.
Example: /etc/zabbix/oracle/sql
Plugins.Oracle.Service no XE A service name to be used for connection (SID is not supported).
Plugins.Postgres.Host no localhost IP address or DNS name of the host used for PostgreSQL.
Examples: localhost, 192.168.1.1
Plugins.Postgres.Port no 5432 A port to be used for PostgreSQL.
Plugins.Smart.Path no smartctl Path to the smartctl executable.
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.
Plugins' named sessions no If Zabbix agent is used to monitor several instances of the same kind, you can create a named session with own set of authorization parameters for each instance. Named session parameters format:
Plugins.<PluginName>.<SessionName1>.<Parameter1>=<value1>
Plugins.<PluginName>.<SessionName2>.<Parameter1>=<value2>
Plugins.<PluginName>.Sessions.<SessionName>.Password no Named session password.
Supported for: Memcached, MongoDB, MySQL, Oracle, PostgreSQL, Redis.
<PluginName> - name of the plugin.
<SessionName> - name of a session for using in item keys.
Plugins.<PluginName>.Sessions.<SessionName>.TLSCAFile no Full pathname of a file containing the top-level CA(s) certificates for peer certificate verification, used for encrypted communications between Zabbix agent 2 and monitored databases.
Supported for: MySQL, PostgreSQL.
<PluginName> - name of the plugin.
<SessionName> - name of a session for using in item keys.
Plugins.<PluginName>.Sessions.<SessionName>.TLSCertFile no Full pathname of a file containing the agent certificate or certificate chain, used for encrypted communications between Zabbix agent 2 and monitored databases.
Supported for: MySQL, PostgreSQL.
<PluginName> - name of the plugin.
<SessionName> - name of a session for using in item keys.
Plugins.<PluginName>.Sessions.<SessionName>.TLSConnect no Encryption type for communications between Zabbix agent 2 and monitored databases.
Supported for: MySQL, PostgreSQL.
<PluginName> - name of the plugin.
<SessionName> - name of a session for using in item keys.

Accepted values:
required - require TLS connection;
verify_ca - verify certificates;
verify_full - verify certificates and IP address.
Plugins.<PluginName>.Sessions.<SessionName>.TLSKeyFile no Full pathname of a file containing the database private key used for encrypted communications between Zabbix agent 2 and monitored databases.
Supported for: MySQL, PostgreSQL.
<PluginName> - name of the plugin.
<SessionName> - name of a session for using in item keys.
Plugins.<PluginName>.Sessions.<SessionName>.User no Named session username.
Supported for: Ceph, Memcached, MongoDB, MySQL, Oracle, PostgreSQL.
<PluginName> - name of the plugin.
<SessionName> - name of a session for using in item keys.
Plugins.Ceph.Sessions.<SessionName>.ApiKey no Named session API key.
Supported for: Ceph.
<PluginName> - name of the plugin.
<SessionName> - name of a session for using in item keys.
Plugins.Ceph.Sessions.<SessionName>.Uri no https://localhost:8003 Connection string of a named session.
<SessionName> - name of a session for using in item keys.

Should not include embedded credentials (they will be ignored).
Must match the URI format.
Only https scheme is supported; a scheme can be omitted (since version 5.2.3).
A port can be omitted (default=8003).
Examples: https://127.0.0.1:8003
localhost
Plugins.Memcached.Sessions.<SessionName>.Uri no tcp://localhost:11211 Connection string of a named session.
<SessionName> - name of a session for using in item keys.

Should not include embedded credentials (they will be ignored).
Must match the URI format.
Supported schemes: tcp, unix; a scheme can be omitted (since version 5.2.3).
A port can be omitted (default=11211).
Examples: tcp://localhost:11211
localhost
unix:/var/run/memcached.sock
Plugins.Modbus.Sessions.<SessionName>.Endpoint no Endpoint of a named session.
Supported for: Modbus.
<SessionName> - name of a session for using in item keys.
Example: Plugins.Modbus.Sessions.MB1.Endpoint=tcp://127.0.0.1:502
Note that this named session parameter is checked only if the value provided in the item key endpoint parameter is empty.
Plugins.Modbus.Sessions.<SessionName>.SlaveID no Slave ID of a named session.
Supported for: Modbus.
<SessionName> - name of a session for using in item keys.
Example: Plugins.Modbus.Sessions.MB1.SlaveID=20
Note that this named session parameter is checked only if the value provided in the item key slave ID parameter is empty.
Plugins.Modbus.Sessions.<SessionName>.Timeout no Timeout of a named session.
Supported for: Modbus.
<SessionName> - name of a session for using in item keys.
Example: Plugins.Modbus.Sessions.MB1.Timeout=2
Plugins.Mongo.Sessions.<SessionName>.Uri no Connection string of a named session.
<SessionName> - name of a session for using in item keys.

Should not include embedded credentials (they will be ignored).
Must match the URI format.
Only tcp scheme is supported; a scheme can be omitted.
A port can be omitted (default=27017).
Examples: tcp://127.0.0.1:27017, tcp:localhost, localhost
Plugins.Mysql.Sessions.<SessionName>.Uri no tcp://localhost:3306 Connection string of a named session.
<SessionName> - name of a session for using in item keys.

Should not include embedded credentials (they will be ignored).
Must match the URI format.
Supported schemes: tcp, unix; a scheme can be omitted (since version 5.2.3).
A port can be omitted (default=3306).
Examples: tcp://localhost:3306
localhost
unix:/var/run/mysql.sock
Plugins.Oracle.Sessions.<SessionName>.Service no Named session service name to be used for connection (SID is not supported).
Supported for: Oracle.
<PluginName> - name of the plugin.
<SessionName> -name of a session for using in item keys.
Plugins.Oracle.Sessions.<SessionName>.Uri no tcp://localhost:1521 Named session connection string for Oracle.
<SessionName> - name of a session for using in item keys.

Should not include embedded credentials (they will be ignored).
Must match the URI format.
Only tcp scheme is supported; a scheme can be omitted (since version 5.2.3).
A port can be omitted (default=1521).
Examples: tcp://127.0.0.1:1521
localhost
Plugins.Postgres.Sessions.<SessionName>.Database no postgres Database name of a named session.
<SessionName> - name of a session for using in item keys.
Plugins.Redis.Sessions.<SessionName>.Uri no tcp://localhost:6379 Connection string of a named session.
<SessionName> - name of a session for using in item keys.

Should not include embedded credentials (they will be ignored).
Must match the URI format.
Supported schemes: tcp, unix; a scheme can be omitted (since version 5.2.3).
A port can be omitted (default=6379).
Examples: tcp://localhost:6379
localhost
unix:/var/run/redis.sock
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 Zabbix servers and Zabbix 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 List of comma-delimited IP:port (or DNS name:port) pairs of Zabbix servers and Zabbix proxies for active checks.
Multiple addresses can be provided to use several independent Zabbix 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: ServerActive=127.0.0.1:20051,zabbix.example.com,[::1]:30051,::1,[12fc::1]
SourceIP no 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.)
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 Zabbix components.
TLSCertFile no Full pathname of a file containing the agent certificate or certificate chain, used for encrypted communications with Zabbix components.
TLSConnect yes, if TLS certificate or PSK parameters are defined (even for unencrypted connection), otherwise no 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
TLSCRLFile no Full pathname of a file containing revoked certificates. This parameter is used for encrypted communications with Zabbix components.
TLSKeyFile no Full pathname of a file containing the agent private key used for encrypted communications with Zabbix components.
TLSPSKFile no Full pathname of a file containing the agent pre-shared key used for encrypted communications with Zabbix components.
TLSPSKIdentity no Pre-shared key identity string, used for encrypted communications with Zabbix 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