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

Обзор

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

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

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

• Обзор параметров (чтобы просмотреть подробные сведения о параметре, нажмите его имя)
• Подробные сведения о параметрах

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

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

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

AllowedAPIMethods

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

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

Любое другое значение является недопустимым и препятствует запуску адаптера моста Zabbix. К таким значениям относятся одиночный подстановочный символ (*), шаблон с частичным подстановочным символом (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

Подключение

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

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

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

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

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

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

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

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

Пример:

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

ListenIP

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

ListenHealthPort

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

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

ListenPort

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

Значение по умолчанию: 10005
Диапазон: 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

ZabbixAPITLSCAFile

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

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

ZabbixAPITLSConnect

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

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

ZabbixAPIURL

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

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

Пример:

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

ZabbixBridgeURL

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

Значение по умолчанию: ZabbixBridgeURL=https://test.aws.zabbix-lab.win/.well-known/bridge-configuration