Параметры конфигурации: адаптер моста Zabbix

Обзор

Параметры конфигурации позволяют настраивать поведение адаптера моста Zabbix.

Укажите значения параметров в файле конфигурации (zabbix_bridge_adapter.conf). Все параметры являются необязательными, если явно не указано, что параметр является обязательным.

Эта страница состоит из следующих разделов:

  • Обзор параметров (чтобы просмотреть подробные сведения о параметре, нажмите его имя)
  • Подробные сведения о параметрах
Параметр Описание
AllowedAPIMethods Укажите, какие методы API Zabbix можно вызывать через адаптер моста.
DataDir Укажите каталог, в котором создаются и хранятся файл состояния адаптера моста и ключи шифрования.
DebugLevel Установите уровень отладки.
Include Укажите каталог или отдельные файлы, которые необходимо включить в файл конфигурации.
ListenHealthPort Укажите порт для прослушивания входящих HTTP-подключений проверки работоспособности.
ListenIP Укажите IP-адрес или имя узла сети для прослушивания входящих HTTP(S)-подключений от сервера Zabbix.
ListenPort Укажите порт для прослушивания входящих HTTP(S)-подключений от сервера Zabbix.
LogFile Укажите файл журнала адаптера моста.
LogFileSize Установите максимальный размер файла журнала (в МБ).
LogType Укажите тип вывода журнала.
PidFile Укажите файл PID.
ServerId Укажите уникальный идентификатор сервера Zabbix. Обязательный параметр.
TLSConfig.AllowedCN Укажите разделенный запятыми список разрешенных общих имен клиентов (mTLS только).
TLSConfig.CAFile Укажите полный путь к файлу, содержащему сертификат(ы) корневого центра сертификации, используемый(е) для проверки сертификатов клиентов в режиме mTLS.
TLSConfig.CertFile Укажите полный путь к файлу, содержащему сертификат или цепочку сертификатов.
TLSConfig.KeyFile Укажите полный путь к файлу, содержащему закрытый ключ.
TLSConfig.Mode Установите режим TLS для входящих подключений на ListenPort.
ZabbixAPITLSCAFile Укажите полный путь к файлу, содержащему сертификат(ы) корневого центра сертификации, используемый(е) адаптером моста для проверки сертификата API Zabbix.
ZabbixAPITLSConnect Установите режим TLS для исходящих подключений к API Zabbix.
ZabbixAPIURL Укажите URL конечной точки API Zabbix. Обязательный параметр.
ZabbixBridgeURL Укажите URL моста Zabbix для получения конфигурации моста Zabbix (получается при запуске адаптера моста).

Обратите внимание:

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

Сведения о параметрах

AllowedAPIMethods

Укажите, какие методы API Zabbix можно вызывать через адаптер моста.
Для нескольких методов повторите параметр, указывая по одному методу в каждой строке.

Каждое значение параметра должно быть либо точным именем метода (например, problem.get), либо шаблоном с подстановочным символом, заменяющим только полное имя API (например, *.get) или только полное имя метода (например, problem.*).

Любое другое значение является недопустимым и препятствует запуску адаптера моста. К таким значениям относятся одиночный подстановочный символ (*), частичный шаблон с подстановочным символом (host* или host*.*) и пустое значение (AllowedAPIMethods=).

Пример:

AllowedAPIMethods=apiinfo.version
AllowedAPIMethods=problem.*
AllowedAPIMethods=*.get

Минимальный набор методов, необходимый мобильному приложению Zabbix:

AllowedAPIMethods=apiinfo.version
AllowedAPIMethods=device.onboard
AllowedAPIMethods=device.offboard
AllowedAPIMethods=user.get
AllowedAPIMethods=role.get
AllowedAPIMethods=problem.get
AllowedAPIMethods=event.get
AllowedAPIMethods=event.acknowledge
AllowedAPIMethods=trigger.get
AllowedAPIMethods=alert.get
AllowedAPIMethods=host.get
AllowedAPIMethods=hostgroup.get

По умолчанию: не задано (все методы API Zabbix запрещены)

DataDir

Укажите каталог, в котором создаются и хранятся файл состояния адаптера моста и ключи шифрования.
Каталог должен существовать и иметь права доступа 0700, а все хранящиеся в нем файлы должны иметь права доступа 0600.

Значение по умолчанию: /var/lib/zabbix-bridge-adapter

DebugLevel

Установите уровень отладки:

  • 0 — основная информация о запуске и остановке процессов Zabbix
  • 1 — критическая информация
  • 2 — информация об ошибках
  • 3 — предупреждения
  • 4 — отладка (создает большой объем информации)
  • 5 — расширенная отладка (создает еще больший объем информации)

Значение по умолчанию: 3
Диапазон: 0-5

Include

Укажите каталог или отдельные файлы, которые необходимо включить в файл конфигурации.
При установке Zabbix этому параметру присваивается значение /etc/zabbix, если во время компиляции не указано другое значение.

Общие правила для параметра Include:

  • Путь может быть относительным к расположению файла zabbix_bridge_adapter.conf.
  • В одном файле конфигурации можно указать несколько параметров Include.
  • Zabbix обрабатывает параметр Include сразу после его чтения, поэтому рекомендуется размещать его в конце файла конфигурации.

Правила для включаемых файлов:

  • Каждый файл должен быть доступен для чтения.
  • Каждый файл должен иметь корректный синтаксис. В противном случае компонент не запустится.

Правила включения каталогов или шаблонов файлов:

  • Не следует рассчитывать на определенный порядок включения (например, файлы не включаются в алфавитном порядке).
  • Не определяйте один и тот же параметр более чем в одном включаемом файле (например, чтобы переопределить общую настройку конкретной), поскольку невозможно предсказать, какое значение будет использовано.
  • Обращайте внимание на резервные копии, которые некоторые текстовые редакторы создают автоматически (например, при редактировании include/my_specific.conf может быть создан файл include/my_specific.conf.BAK), поскольку будут включены оба файла.

Чтобы включить из каталога только нужные файлы, используйте подстановочный знак (*) для сопоставления с шаблоном.

Пример:

Include=/absolute/path/to/config/files/*.conf
ListenHealthPort

Укажите порт для прослушивания входящих HTTP-подключений для проверки состояния.
Обслуживает конечные точки /health и /ready.
Если параметр не указан, служба проверки состояния не запускается.

Значение по умолчанию: 8081
Диапазон: 1024-32767

ListenIP

Укажите IP-адрес или имя узла сети, на котором следует принимать входящие HTTP(S)-подключения от сервера Zabbix.
Если параметр не указан, адаптер моста принимает подключения на всех доступных IP-адресах локальной системы.

ListenPort

Укажите порт для прослушивания входящих HTTP(S)-подключений от сервера Zabbix.

Значение по умолчанию: 10054
Диапазон: 1024–32767

LogFile

Укажите файл журнала адаптера моста.

Обязательно: Да, если LogType имеет значение file; в противном случае — нет

Значение по умолчанию: /tmp/zabbix_bridge_adapter.log

LogFileSize

Задайте максимальный размер файла журнала (в МБ).
0 - отключить автоматическую ротацию журналов.

По умолчанию: 1
Диапазон: 0-1024

LogType

Укажите тип вывода журнала:

  • file - записывать журнал в файл, указанный параметром LogFile.
  • system - записывать журнал в системный журнал.
  • console - записывать журнал в стандартный вывод.

Значение по умолчанию: file

PidFile

Укажите PID-файл.

Значение по умолчанию: /tmp/zabbix_bridge_adapter.pid

ServerId

Укажите уникальный идентификатор сервера Zabbix.
Доступен в разделе Отчёты > Сведения о системе веб-интерфейса Zabbix.

Обязательный параметр: Да

TLSConfig.AllowedCN

Укажите разделенный запятыми список разрешенных общих имен клиентов (только для mTLS).
Если параметр не указан, адаптер моста не проверяет общее имя клиента.

TLSConfig.CAFile

Укажите полный путь к файлу, содержащему корневые сертификаты центра сертификации, используемые для проверки сертификатов клиентов в режиме mTLS.

TLSConfig.CertFile

Укажите полный путь к файлу, содержащему сертификат или цепочку сертификатов.

TLSConfig.KeyFile

Укажите полный путь к файлу, содержащему закрытый ключ.

TLSConfig.Mode

Задайте режим TLS для входящих подключений на ListenPort:

  • none - принимать подключения без шифрования.
  • tls - стандартный TLS с минимальной версией v1.2.
  • mtls - расширяет TLS взаимной аутентификацией.

Значение по умолчанию: none

См. также: TLS от сервера Zabbix к адаптеру моста Zabbix

ZabbixAPITLSCAFile

Укажите полный путь к файлу, содержащему сертификат(ы) корневого центра сертификации, используемые адаптером моста для проверки сертификата Zabbix API.

Обязательно: Да, если ZabbixAPITLSConnect имеет значение verify_ca или verify_full.

ZabbixAPITLSConnect

Задаёт режим TLS для исходящих подключений к Zabbix API:

  • disabled - использовать обычный HTTP; ZabbixAPIURL должен использовать http://.
  • required - использовать HTTPS без проверки сертификата (только для тестирования).
  • verify_ca - использовать HTTPS и проверять сертификат Zabbix API.
  • verify_full - использовать HTTPS и проверять сертификат Zabbix API и имя узла сети.

Пустое или не заданное значение обрабатывается как required.

По умолчанию: required

См. также: TLS от адаптера моста Zabbix к Zabbix API

ZabbixAPIURL

Укажите URL конечной точки API Zabbix.

Обязательный параметр: Да

Пример:

ZabbixAPIURL=https://example.com/zabbix/api_jsonrpc.php
ZabbixBridgeURL

Укажите URL-адрес Zabbix Bridge для получения конфигурации Zabbix Bridge (получается при запуске адаптера моста).

Значение по умолчанию: ZabbixBridgeURL=https://config.mobilebridge.zabbix.com/.well-known/bridge-configuration