Konfigurationsparameter: Zabbix-Bridge-Adapter

Übersicht

Konfigurationsparameter ermöglichen die Anpassung des Verhaltens des Zabbix-Bridge-Adapters.

Geben Sie die Parameterwerte in der Konfigurationsdatei (zabbix_bridge_adapter.conf) an.
Alle Parameter sind optional, sofern nicht ausdrücklich angegeben ist, dass der Parameter erforderlich ist.

Diese Seite ist wie folgt strukturiert:

  • Parameterübersicht (um die vollständigen Details eines Parameters anzuzeigen, klicken Sie auf seinen Namen)
  • Parameterdetails
Parameter Beschreibung
AllowedAPIMethods Geben Sie an, welche Zabbix-API-Methoden über den Zabbix-Bridge-Adapter aufgerufen werden können.
DataDir Geben Sie das Verzeichnis an, in dem die Statusdatei und die Verschlüsselungsschlüssel des Bridge-Adapters erstellt und gespeichert werden.
DebugLevel Legen Sie die Debug-Stufe fest.
Include Geben Sie ein Verzeichnis oder einzelne Dateien an, die in die Konfigurationsdatei aufgenommen werden sollen.
ListenIP Geben Sie die IP-Adresse an, unter der der Bridge-Adapter eingehende HTTP[S]-Verbindungen vom Zabbix-Server entgegennimmt.
ListenHealthPort Geben Sie den Port an, unter dem der Bridge-Adapter eingehende HTTP-Verbindungen für Zustandsprüfungen entgegennimmt.
ListenPort Geben Sie den Port an, unter dem der Bridge-Adapter eingehende HTTP[S]-Verbindungen vom Zabbix-Server entgegennimmt.
LogFile Geben Sie den vollständigen Pfad zur Protokolldatei des Bridge-Adapters an.
LogFileSize Legen Sie die maximale Größe der Protokolldatei (in MB) fest.
LogType Geben Sie den Typ der Protokollausgabe an.
PidFile Geben Sie die PID-Datei an.
TLSConfig.AllowedCN Geben Sie eine durch Kommas getrennte Liste zulässiger allgemeiner Namen (Common Names) von Clients an (nur mTLS).
TLSConfig.CAFile Geben Sie den vollständigen Pfad zu einer Datei an, die das bzw. die übergeordneten CA-Zertifikat(e) enthält, die zur Überprüfung von Clientzertifikaten im mTLS-Modus verwendet werden.
TLSConfig.CertFile Geben Sie den vollständigen Pfad zu einer Datei an, die das Zertifikat oder die Zertifikatskette enthält.
TLSConfig.KeyFile Geben Sie den vollständigen Pfad zu einer Datei an, die den privaten Schlüssel enthält.
TLSConfig.Mode Legen Sie den TLS-Modus für eingehende Verbindungen an ListenPort fest.
ServerId Geben Sie den eindeutigen Bezeichner des Zabbix-Servers an. Erforderlich.
ZabbixAPITLSCAFile Geben Sie den vollständigen Pfadnamen einer Datei an, die das bzw. die übergeordneten CA-Zertifikat(e) enthält, die der Bridge-Adapter zur Überprüfung des Zabbix-API-Zertifikats verwendet.
ZabbixAPITLSConnect Legen Sie den TLS-Modus für ausgehende Verbindungen zur Zabbix-API fest.
ZabbixAPIURL Geben Sie die URL des Zabbix-API-Endpunkts an. Erforderlich.
ZabbixBridgeURL Geben Sie die Zabbix-Bridge-URL für den Abruf der Zabbix-Bridge-Konfiguration an (der Abruf erfolgt beim Start des Bridge-Adapters).

Beachten Sie Folgendes:

  • Die Standardwerte entsprechen den Prozessstandards, nicht den Werten in den mitgelieferten Konfigurationsdateien.
  • Werte unterstützen Umgebungsvariablen.
  • Zabbix unterstützt Konfigurationsdateien nur in der UTF-8-Kodierung ohne BOM.
  • Kommentare, die mit # beginnen, werden nur am Anfang der Zeile unterstützt.

Parameterdetails

AllowedAPIMethods

Geben Sie an, welche Zabbix-API-Methoden über den Zabbix bridge adapter aufgerufen werden können.
Für mehrere Methoden wiederholen Sie den Parameter, eine Methode pro Zeile.

Jeder Parameterwert muss entweder ein exakter Methodenname (z. B. problem.get) oder ein Platzhaltermuster sein, das nur den gesamten API-Namen (z. B. *.get) oder den gesamten Methodennamen (z. B. problem.*) ersetzt.

Jeder andere Wert ist ungültig und verhindert den Start des Zabbix bridge adapter. Dies umfasst einen alleinstehenden Platzhalter (*), ein partielles Platzhaltermuster (host* oder host*.*) oder einen leeren Wert (AllowedAPIMethods=).

Beispiel:

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

Der Mindestsatz an Methoden, den die mobile Zabbix-App benötigt:

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

Standard: nicht festgelegt (alle Zabbix-API-Methoden sind nicht zulässig)

DataDir

Geben Sie das Verzeichnis an, in dem die Statusdatei des Bridge-Adapters und die Verschlüsselungsschlüssel erstellt und gespeichert werden.
Das Verzeichnis muss über die Berechtigungen 0700 verfügen, und alle darin gespeicherten Dateien müssen über die Berechtigungen 0600 verfügen.

Standard: /var/lib/zabbix-bridge-adapter

DebugLevel

Legen Sie die Debug-Stufe fest:

  • 0 – grundlegende Informationen zum Starten und Beenden von Zabbix-Prozessen
  • 1 – kritische Informationen
  • 2 – Fehlerinformationen
  • 3 – Warnungen
  • 4 – zum Debuggen (erzeugt viele Informationen)
  • 5 – erweitertes Debuggen (erzeugt noch mehr Informationen)

Standard: 3
Bereich: 0-5

Include

Geben Sie ein Verzeichnis oder einzelne Dateien an, die in die Konfigurationsdatei aufgenommen werden sollen.
Bei der Installation von Zabbix wird dieser Parameter auf /usr/local/etc gesetzt, sofern Sie dies nicht während der Kompilierung ändern.

Allgemeine Regeln für den Parameter Include:

  • Der Pfad kann relativ zum Speicherort der Datei zabbix_bridge_adapter.conf angegeben werden.
  • Sie können mehrere Include-Parameter in einer Konfigurationsdatei angeben.
  • Zabbix verarbeitet den Parameter Include, sobald er gelesen wird. Ziehen Sie daher in Betracht, ihn am Ende der Konfigurationsdatei zu platzieren.

Regeln für eingeschlossene Dateien:

  • Jede Datei muss lesbar sein.
  • Jede Datei muss eine korrekte Syntax aufweisen. Andernfalls wird die Komponente nicht gestartet.

Regeln für das Einschließen von Verzeichnissen oder Dateimustern:

  • Gehen Sie nicht von einer bestimmten Reihenfolge beim Einschließen aus (Dateien werden beispielsweise nicht alphabetisch eingeschlossen).
  • Definieren Sie denselben Parameter nicht in mehreren eingeschlossenen Dateien (beispielsweise, um eine allgemeine Einstellung durch eine spezifische zu überschreiben), da Sie nicht vorhersagen können, welcher Wert verwendet wird.
  • Achten Sie auf Sicherungskopien, die einige Texteditoren automatisch erstellen (beispielsweise kann beim Bearbeiten von include/my_specific.conf die Datei include/my_specific.conf.BAK erstellt werden), da beide Dateien eingeschlossen werden.

Um nur relevante Dateien aus einem Verzeichnis einzuschließen, verwenden Sie den Platzhalter (*) für den Musterabgleich.

Beispiel:

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

Geben Sie die IP-Adresse an, an der der Bridge-Adapter auf eingehende HTTP[S]-Verbindungen vom Zabbix Server wartet.
Wenn nicht angegeben, wartet der Bridge-Adapter an allen IP-Adressen.

ListenHealthPort

Geben Sie den Listen-Port des Bridge-Adapters für eingehende HTTP-Health-Check-Verbindungen an.
Stellt die Endpunkte /health und /ready bereit.
Wenn nicht angegeben, wird der Health-Service nicht gestartet.

Standard: 8081
Bereich: 1024-32767

ListenPort

Geben Sie den Überwachungsport des Bridge-Adapters für eingehende HTTP[S]-Verbindungen vom Zabbix Server an.

Standard: 10005
Bereich: 1024-32767

LogFile

Geben Sie den vollständigen Pfad zur Protokolldatei des Bridge-Adapters an.

Obligatorisch: Ja, wenn LogType auf file gesetzt ist

Standard: /tmp/zabbix_bridge_adapter.log

LogFileSize

Legt die maximale Größe der Protokolldatei (in MB) fest.
0 - deaktiviert die automatische Protokollrotation.

Standard: 1
Bereich: 0-1024

LogType

Geben Sie den Typ der Protokollausgabe an:

  • file - schreibt das Protokoll in die durch den Parameter LogFile angegebene Datei.
  • system - schreibt das Protokoll in Syslog.
  • console - schreibt das Protokoll in die Standardausgabe.

Standard: file

PidFile

Geben Sie die PID-Datei an.

Standard: /tmp/zabbix_bridge_adapter.pid

ServerId

Geben Sie den eindeutigen Bezeichner des Zabbix-Servers an.
Verfügbar unter Berichte > Systeminformationen in der Zabbix-Benutzeroberfläche.

Obligatorisch: Ja

TLSConfig.AllowedCN

Geben Sie eine durch Kommas getrennte Liste der zulässigen Common Names der Clients an (nur mTLS).
Wenn nicht angegeben, überprüft der Bridge-Adapter den Common Name des Clients nicht.

TLSConfig.CAFile

Geben Sie den vollständigen Pfad zu einer Datei an, die das/die übergeordnete(n) CA-Zertifikat(e) enthält, die zur Überprüfung von Clientzertifikaten im mTLS-Modus verwendet werden.

TLSConfig.CertFile

Geben Sie den vollständigen Pfad zu einer Datei an, die das Zertifikat oder die Zertifikatskette enthält.

TLSConfig.KeyFile

Geben Sie den vollständigen Pfad zu einer Datei an, die den privaten Schlüssel enthält.

TLSConfig.Mode

Legen Sie den TLS-Modus für eingehende Verbindungen an ListenPort fest:

  • none - Verbindungen ohne Verschlüsselung akzeptieren.
  • tls - Standard-TLS mit mindestens v1.2.
  • mtls - erweitert TLS um gegenseitige Authentifizierung.

Standard: none

ZabbixAPITLSCAFile

Geben Sie den vollständigen Pfadnamen einer Datei an, die das bzw. die übergeordneten CA-Zertifikat(e) enthält, die der Bridge-Adapter zur Überprüfung des Zabbix-API-Zertifikats verwendet.

Obligatorisch: Ja, wenn ZabbixAPITLSConnect auf verify_ca oder verify_full gesetzt ist.

ZabbixAPITLSConnect

Legt den TLS-Modus für ausgehende Verbindungen zur Zabbix-API fest:

  • disabled (oder leer) – verwendet einfaches HTTP; ZabbixAPIURL muss http:// verwenden.
  • required – verwendet HTTPS ohne Zertifikatsüberprüfung (nur zu Testzwecken).
  • verify_ca – verwendet HTTPS und überprüft das Zabbix-API-Zertifikat.
  • verify_full – verwendet HTTPS und überprüft das Zabbix-API-Zertifikat sowie den Hostnamen.
ZabbixAPIURL

Geben Sie die URL des Zabbix-API-Endpunkts an.

Obligatorisch: Ja

Beispiel:

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

Geben Sie die Zabbix-Bridge-URL für den Abruf der Zabbix-Bridge-Konfiguration an (wird beim Start des Bridge-Adapters abgerufen).

Standard: ZabbixBridgeURL=https://test.aws.zabbix-lab.win/.well-known/bridge-configuration