Parametry konfiguracji: adapter mostu Zabbix

Przegląd

Parametry konfiguracji umożliwiają dostosowanie działania adaptera bridge Zabbix.

Określ wartości parametrów w pliku konfiguracyjnym (zabbix_bridge_adapter.conf). Wszystkie parametry są opcjonalne, chyba że wyraźnie zaznaczono, że dany parametr jest wymagany.

Ta strona ma następującą strukturę:

  • Przegląd parametrów (aby wyświetlić pełne informacje o parametrze, kliknij jego nazwę)
  • Szczegóły parametrów
Parametr Opis
AllowedAPIMethods Określa, które metody API Zabbix mogą być wywoływane za pośrednictwem adaptera bridge.
DataDir Określa katalog, w którym tworzony i przechowywany jest plik stanu adaptera bridge oraz klucze szyfrowania.
DebugLevel Ustawia poziom debugowania.
Include Określa katalog lub pojedyncze pliki, które mają zostać uwzględnione w pliku konfiguracyjnym.
ListenHealthPort Określa port, na którym nasłuchiwane są przychodzące połączenia HTTP służące do sprawdzania stanu.
ListenIP Określa adres IP lub nazwę hosta, na którym nasłuchiwane są przychodzące połączenia HTTP(S) z serwera Zabbix.
ListenPort Określa port, na którym nasłuchiwane są przychodzące połączenia HTTP(S) z serwera Zabbix.
LogFile Określa plik dziennika adaptera bridge.
LogFileSize Ustawia maksymalny rozmiar pliku dziennika (w MB).
LogType Określa typ danych wyjściowych dziennika.
PidFile Określa plik PID.
ServerId Określa unikatowy identyfikator serwera Zabbix. Wymagane.
TLSConfig.AllowedCN Określa rozdzielaną przecinkami listę dozwolonych nazw Common Name klientów (tylko mTLS).
TLSConfig.CAFile Określa pełną ścieżkę do pliku zawierającego najwyższy certyfikat lub certyfikaty CA używane do weryfikowania certyfikatów klientów w trybie mTLS.
TLSConfig.CertFile Określa pełną ścieżkę do pliku zawierającego certyfikat lub łańcuch certyfikatów.
TLSConfig.KeyFile Określa pełną ścieżkę do pliku zawierającego klucz prywatny.
TLSConfig.Mode Ustawia tryb TLS dla przychodzących połączeń na porcie ListenPort.
ZabbixAPITLSCAFile Określa pełną ścieżkę do pliku zawierającego najwyższy certyfikat lub certyfikaty CA używane przez adapter bridge do weryfikowania certyfikatu API Zabbix.
ZabbixAPITLSConnect Ustawia tryb TLS dla wychodzących połączeń z API Zabbix.
ZabbixAPIURL Określa URL punktu końcowego API Zabbix. Wymagane.
ZabbixBridgeURL Określa URL Zabbix Bridge używany do pobierania konfiguracji Zabbix Bridge (pobieranej podczas uruchamiania adaptera bridge).

Należy pamiętać, że:

  • Wartości domyślne odzwierciedlają wartości domyślne procesu, a nie wartości w dostarczonych plikach konfiguracyjnych.
  • Wartości obsługują zmienne środowiskowe.
  • Zabbix obsługuje pliki konfiguracyjne wyłącznie w kodowaniu UTF-8, bez BOM.
  • Komentarze rozpoczynające się od # są obsługiwane tylko na początku wiersza.

Szczegóły parametrów

AllowedAPIMethods

Określ, które metody API Zabbix mogą być wywoływane za pośrednictwem bridge adapter.
W przypadku kilku metod powtórz parametr, podając jedną metodę w każdym wierszu.

Każda wartość parametru musi być dokładną nazwą metody (np. problem.get) albo wzorcem wieloznacznym, który zastępuje wyłącznie całą nazwę API (np. *.get) lub całą nazwę metody (np. problem.*).

Każda inna wartość jest nieprawidłowa i uniemożliwia uruchomienie bridge adapter. Dotyczy to między innymi pojedynczego symbolu wieloznacznego (*), częściowego wzorca wieloznacznego (host* lub host*.*) oraz pustej wartości (AllowedAPIMethods=).

Przykład:

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

Minimalny zestaw metod wymaganych przez aplikację mobilną 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

Domyślnie: nieustawione (wszystkie metody API Zabbix są odrzucane)

DataDir

Określ katalog, w którym tworzony i przechowywany jest plik stanu adaptera bridge oraz klucze szyfrowania.
Katalog musi istnieć i mieć uprawnienia 0700, a wszystkie przechowywane w nim pliki muszą mieć uprawnienia 0600.

Wartość domyślna: /var/lib/zabbix-bridge-adapter

DebugLevel

Ustaw poziom debugowania:

  • 0 - podstawowe informacje o uruchamianiu i zatrzymywaniu procesów Zabbix
  • 1 - informacje krytyczne
  • 2 - informacje o błędach
  • 3 - ostrzeżenia
  • 4 - debugowanie (generuje dużo informacji)
  • 5 - rozszerzone debugowanie (generuje jeszcze więcej informacji)

Wartość domyślna: 3
Zakres: 0-5

Include

Określ katalog lub pojedyncze pliki, które mają zostać uwzględnione w pliku konfiguracyjnym.
Podczas instalacji Zabbix ten parametr jest ustawiany na /etc/zabbix, chyba że zmienisz tę wartość podczas kompilacji.

Ogólne zasady dotyczące parametru Include:

  • Ścieżka może być względna względem lokalizacji pliku zabbix_bridge_adapter.conf.
  • W jednym pliku konfiguracyjnym można określić wiele parametrów Include.
  • Zabbix przetwarza parametr Include natychmiast po jego odczytaniu, dlatego rozważ umieszczenie go na końcu pliku konfiguracyjnego.

Zasady dotyczące uwzględnianych plików:

  • Każdy plik musi być możliwy do odczytu.
  • Każdy plik musi mieć poprawną składnię. W przeciwnym razie komponent nie zostanie uruchomiony.

Zasady dotyczące uwzględniania katalogów lub wzorców plików:

  • Nie zakładaj żadnej kolejności uwzględniania plików (np. pliki nie są uwzględniane w kolejności alfabetycznej).
  • Nie definiuj tego samego parametru w więcej niż jednym uwzględnianym pliku (np. aby zastąpić ustawienie ogólne konkretnym), ponieważ nie można przewidzieć, która wartość zostanie użyta.
  • Zwracaj uwagę na kopie zapasowe tworzone automatycznie przez niektóre edytory tekstu (np. edycja include/my_specific.conf może utworzyć plik include/my_specific.conf.BAK), ponieważ oba pliki zostaną uwzględnione.

Aby uwzględnić tylko odpowiednie pliki z katalogu, użyj symbolu wieloznacznego (*) do dopasowania wzorca.

Przykład:

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

Określa port, na którym nasłuchiwać połączeń przychodzących HTTP używanych do sprawdzania stanu.
Udostępnia endpointy /health i /ready.
Jeśli nie określono, usługa sprawdzania stanu nie zostanie uruchomiona.

Wartość domyślna: 8081
Zakres: 1024-32767

ListenIP

Określ adres IP lub nazwę hosta, na którym mają być nasłuchiwane przychodzące połączenia HTTP(S) z serwera Zabbix.
Jeśli nie określono tej wartości, adapter bridge nasłuchuje na wszystkich dostępnych adresach IP systemu lokalnego.

ListenPort

Określ port, na którym mają być nasłuchiwane przychodzące połączenia HTTP(S) z serwera Zabbix.

Wartość domyślna: 10054
Zakres: 1024-32767

LogFile

Określ plik dziennika bridge adaptera.

Wymagane: Tak, jeśli LogType ma wartość file; w przeciwnym razie nie

Wartość domyślna: /tmp/zabbix_bridge_adapter.log

LogFileSize

Ustaw maksymalny rozmiar pliku dziennika (w MB).
0 - wyłącza automatyczną rotację dziennika.

Wartość domyślna: 1
Zakres: 0-1024

LogType

Określ typ wyjścia dziennika:

  • file - zapisuje dziennik do pliku określonego parametrem LogFile.
  • system - zapisuje dziennik do syslog.
  • console - zapisuje dziennik na standardowe wyjście.

Wartość domyślna: file

PidFile

Określ plik PID.

Wartość domyślna: /tmp/zabbix_bridge_adapter.pid

ServerId

Określ unikatowy identyfikator serwera Zabbix.
Dostępny w sekcji Raporty > Informacje o systemie w frontend Zabbix.

Wymagane: Tak

TLSConfig.AllowedCN

Określ rozdzielaną przecinkami listę dozwolonych nazw Common Name klientów (tylko mTLS).
Jeśli nie określono, adapter bridge nie sprawdza nazwy Common Name klienta.

TLSConfig.CAFile

Określ pełną ścieżkę do pliku zawierającego certyfikat(y) głównego urzędu certyfikacji (CA) używane do weryfikacji certyfikatów klienta w trybie mTLS.

TLSConfig.CertFile

Określ pełną ścieżkę do pliku zawierającego certyfikat lub łańcuch certyfikatów.

TLSConfig.KeyFile

Określ pełną ścieżkę do pliku zawierającego klucz prywatny.

TLSConfig.Mode

Ustaw tryb TLS dla połączeń przychodzących na ListenPort:

  • none - akceptuj połączenia bez szyfrowania.
  • tls - standardowy TLS z minimalną wersją v1.2.
  • mtls - rozszerza TLS o wzajemne uwierzytelnianie.

Wartość domyślna: none

Zobacz także: TLS z serwera Zabbix do adaptera mostu Zabbix

ZabbixAPITLSCAFile

Określ pełną ścieżkę do pliku zawierającego certyfikat(y) głównego urzędu certyfikacji (CA) używane przez adapter bridge do weryfikacji certyfikatu API Zabbix.

Wymagane: Tak, jeśli ZabbixAPITLSConnect jest ustawione na verify_ca lub verify_full.

ZabbixAPITLSConnect

Ustaw tryb TLS dla połączeń wychodzących do Zabbix API:

  • disabled - używaj zwykłego HTTP; ZabbixAPIURL musi używać http://.
  • required - używaj HTTPS bez weryfikacji certyfikatu (tylko do testów).
  • verify_ca - używaj HTTPS i weryfikuj certyfikat Zabbix API.
  • verify_full - używaj HTTPS oraz weryfikuj certyfikat Zabbix API i nazwę hosta.

Pusta lub nieustawiona wartość jest traktowana jako required.

Wartość domyślna: required

Zobacz także: TLS z adaptera mostka Zabbix do Zabbix API

ZabbixAPIURL

Określ adres URL punktu końcowego interfejsu API Zabbix.

Wymagane: Tak

Przykład:

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

Określ adres URL Zabbix Bridge do pobierania konfiguracji Zabbix Bridge (pobieranej podczas uruchamiania adaptera bridge).

Wartość domyślna: ZabbixBridgeURL=https://config.mobilebridge.zabbix.com/.well-known/bridge-configuration