Paramètres de configuration : adaptateur de pont Zabbix

Vue d’ensemble

Les paramètres de configuration permettent de personnaliser le comportement de l’adaptateur de pont Zabbix.

Indiquez les valeurs des paramètres dans le fichier de configuration (zabbix_bridge_adapter.conf). Tous les paramètres sont facultatifs, sauf indication explicite contraire.

Cette page est structurée comme suit :

  • Vue d’ensemble des paramètres (pour afficher tous les détails d’un paramètre, cliquez sur son nom)
  • Détails des paramètres
Paramètre Description
AllowedAPIMethods Indiquer les méthodes de l’API Zabbix pouvant être appelées via l’adaptateur de pont Zabbix.
DataDir Indiquer le répertoire dans lequel le fichier d’état de l’adaptateur de pont et les clés de chiffrement sont créés et stockés.
DebugLevel Définir le niveau de débogage.
Include Indiquer un répertoire ou des fichiers individuels à inclure dans le fichier de configuration.
ListenIP Indiquer l’adresse IP d’écoute de l’adaptateur de pont pour les connexions HTTP[S] entrantes depuis le serveur Zabbix.
ListenHealthPort Indiquer le port d’écoute de l’adaptateur de pont pour les connexions HTTP entrantes de vérification de l’état.
ListenPort Indiquer le port d’écoute de l’adaptateur de pont pour les connexions HTTP[S] entrantes depuis le serveur Zabbix.
LogFile Indiquer le chemin complet du fichier journal de l’adaptateur de pont.
LogFileSize Définir la taille maximale du fichier journal (en Mo).
LogType Indiquer le type de sortie du journal.
PidFile Indiquer le fichier PID.
TLSConfig.AllowedCN Indiquer une liste séparée par des virgules des noms communs des clients autorisés (mTLS uniquement).
TLSConfig.CAFile Indiquer le chemin complet d’un fichier contenant le ou les certificats CA de niveau supérieur utilisés pour vérifier les certificats des clients en mode mTLS.
TLSConfig.CertFile Indiquer le chemin complet d’un fichier contenant le certificat ou la chaîne de certificats.
TLSConfig.KeyFile Indiquer le chemin complet d’un fichier contenant la clé privée.
TLSConfig.Mode Définir le mode TLS pour les connexions entrantes sur ListenPort.
ServerId Indiquer l’identifiant unique du serveur Zabbix. Obligatoire.
ZabbixAPITLSCAFile Indiquer le chemin complet d’un fichier contenant le ou les certificats CA de niveau supérieur utilisés par l’adaptateur de pont pour vérifier le certificat de l’API Zabbix.
ZabbixAPITLSConnect Définir le mode TLS pour les connexions sortantes vers l’API Zabbix.
ZabbixAPIURL Indiquer l’URL du point de terminaison de l’API Zabbix. Obligatoire.
ZabbixBridgeURL Indiquer l’URL du pont Zabbix pour récupérer la configuration du pont Zabbix (récupérée au démarrage de l’adaptateur de pont).

Notez que :

  • Les valeurs par défaut correspondent aux valeurs par défaut du processus, et non aux valeurs des fichiers de configuration fournis.
  • Les valeurs prennent en charge les variables d’environnement.
  • Zabbix prend uniquement en charge les fichiers de configuration encodés en UTF-8 sans BOM ;
  • Les commentaires commençant par # sont pris en charge uniquement au début de la ligne.

Détails des paramètres

AllowedAPIMethods

Indiquez quelles méthodes de l’API Zabbix peuvent être appelées via l’adaptateur Zabbix bridge.
Pour plusieurs méthodes, répétez le paramètre, à raison d’une méthode par ligne.

Chaque valeur de paramètre doit être soit un nom de méthode exact (par exemple, problem.get), soit un modèle générique qui remplace uniquement le nom complet de l’API (par exemple, *.get) ou le nom complet de la méthode (par exemple, problem.*).

Toute autre valeur n’est pas valide et empêche le démarrage de l’adaptateur Zabbix bridge. Cela inclut un caractère générique seul (*), un modèle générique partiel (host* ou host*.*) ou une valeur vide (AllowedAPIMethods=).

Exemple :

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

Ensemble minimal de méthodes requises par l’application mobile 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

Par défaut : non défini (toutes les méthodes de l’API Zabbix sont refusées)

DataDir

Spécifiez le répertoire dans lequel le fichier d’état de l’adaptateur bridge et les clés de chiffrement sont créés et stockés.
Le répertoire doit disposer des permissions 0700, et tous les fichiers qui y sont stockés doivent disposer des permissions 0600.

Par défaut : /var/lib/zabbix-bridge-adapter

DebugLevel

Définir le niveau de débogage :

  • 0 - informations de base sur le démarrage et l'arrêt des processus Zabbix
  • 1 - informations critiques
  • 2 - informations sur les erreurs
  • 3 - avertissements
  • 4 - pour le débogage (génère de nombreuses informations)
  • 5 - débogage étendu (génère encore plus d'informations)

Par défaut : 3
Plage : 0-5

Inclure

Indiquez un répertoire ou des fichiers individuels à inclure dans le fichier de configuration.
Lors de l'installation de Zabbix, ce paramètre est défini sur /usr/local/etc, sauf si vous modifiez cette valeur lors de la compilation.

Règles générales pour le paramètre Include :

  • Le chemin peut être relatif à l'emplacement du fichier zabbix_bridge_adapter.conf.
  • Vous pouvez spécifier plusieurs paramètres Include dans un même fichier de configuration.
  • Zabbix traite le paramètre Include dès qu'il le lit. Il est donc recommandé de le placer à la fin du fichier de configuration.

Règles applicables aux fichiers inclus :

  • Chaque fichier doit être lisible.
  • Chaque fichier doit avoir une syntaxe correcte. Dans le cas contraire, le composant ne démarrera pas.

Règles applicables à l'inclusion de répertoires ou de modèles de fichiers :

  • Ne partez pas du principe qu'un ordre d'inclusion est appliqué (par exemple, les fichiers ne sont pas inclus dans l'ordre alphabétique).
  • Ne définissez pas le même paramètre dans plusieurs fichiers inclus (par exemple, pour remplacer un paramètre général par un paramètre spécifique), car vous ne pouvez pas prévoir quelle valeur sera utilisée.
  • Faites attention aux copies de sauvegarde que certains éditeurs de texte créent automatiquement (par exemple, la modification de include/my_specific.conf peut créer include/my_specific.conf.BAK), car les deux fichiers seront inclus.

Pour inclure uniquement les fichiers pertinents d'un répertoire, utilisez le caractère générique (*) pour la correspondance de modèles.

Exemple :

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

Indiquez l’adresse IP d’écoute de l’adaptateur bridge pour les connexions HTTP[S] entrantes du serveur Zabbix.
Si elle n’est pas spécifiée, l’adaptateur bridge écoute sur toutes les adresses IP.

ListenHealthPort

Spécifiez le port d'écoute de l'adaptateur bridge pour les connexions HTTP entrantes de vérification de l'état.
Fournit les points de terminaison /health et /ready.
S'il n'est pas spécifié, le service d'état n'est pas démarré.

Valeur par défaut : 8081
Plage : 1024-32767

ListenPort

Spécifiez le port d'écoute de l'adaptateur bridge pour les connexions HTTP[S] entrantes du serveur Zabbix.

Valeur par défaut : 10005
Plage : 1024-32767

LogFile

Indiquez le chemin complet vers le fichier journal de l’adaptateur bridge.

Obligatoire : Oui si LogType est défini sur file

Par défaut : /tmp/zabbix_bridge_adapter.log

LogFileSize

Définir la taille maximale du fichier journal (en Mo).
0 - désactiver la rotation automatique des journaux.

Valeur par défaut : 1
Plage : 0-1024

LogType

Spécifiez le type de sortie du journal :

  • file - écrit le journal dans le fichier spécifié par le paramètre LogFile.
  • system - écrit le journal dans syslog.
  • console - écrit le journal sur la sortie standard.

Valeur par défaut : file

PidFile

Spécifiez le fichier PID.

Par défaut : /tmp/zabbix_bridge_adapter.pid

ServerId

Spécifiez l’identifiant unique du serveur Zabbix.
Disponible dans Rapports > Informations système dans l’interface utilisateur de Zabbix.

Obligatoire : Oui

TLSConfig.AllowedCN

Spécifiez une liste de noms communs (Common Names) des clients autorisés, séparés par des virgules (mTLS uniquement).
Si cette option n’est pas spécifiée, l’adaptateur bridge ne vérifie pas le nom commun du client.

TLSConfig.CAFile

Spécifiez le chemin complet vers un fichier contenant le ou les certificats CA racine utilisés pour vérifier les certificats client en mode mTLS.

TLSConfig.CertFile

Spécifiez le chemin complet vers un fichier contenant le certificat ou la chaîne de certificats.

TLSConfig.KeyFile

Spécifiez le chemin complet vers un fichier contenant la clé privée.

TLSConfig.Mode

Définissez le mode TLS pour les connexions entrantes sur ListenPort :

  • none - accepte les connexions sans chiffrement.
  • tls - TLS standard avec v1.2 comme version minimale.
  • mtls - étend TLS avec une authentification mutuelle.

Valeur par défaut : none

ZabbixAPITLSCAFile

Spécifiez le chemin complet d’un fichier contenant le ou les certificats CA de niveau supérieur utilisés par l’adaptateur de pont pour vérifier le certificat de l’API Zabbix.

Obligatoire : Oui si ZabbixAPITLSConnect est défini sur verify_ca ou verify_full.

ZabbixAPITLSConnect

Définissez le mode TLS pour les connexions sortantes vers l’API Zabbix :

  • disabled (ou vide) - utilise HTTP en clair ; ZabbixAPIURL doit utiliser http://.
  • required - utilise HTTPS sans vérification du certificat (uniquement pour les tests).
  • verify_ca - utilise HTTPS et vérifie le certificat de l’API Zabbix.
  • verify_full - utilise HTTPS et vérifie le certificat ainsi que le nom d’hôte de l’API Zabbix.
ZabbixAPIURL

Spécifiez l’URL du point de terminaison de l’API Zabbix.

Obligatoire : Oui

Exemple :

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

Spécifiez l’URL du bridge Zabbix pour récupérer la configuration du bridge Zabbix (récupérée au démarrage de l’adaptateur du bridge).

Par défaut : ZabbixBridgeURL=https://test.aws.zabbix-lab.win/.well-known/bridge-configuration