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 les détails complets d’un paramètre, cliquez sur son nom)
- Détails des paramètres
| Paramètre | Description |
|---|---|
| AllowedAPIMethods | Indique les méthodes de l’API Zabbix pouvant être appelées via l’adaptateur de pont. |
| DataDir | Indique 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éfinit le niveau de débogage. |
| Include | Indique un répertoire ou des fichiers individuels à inclure dans le fichier de configuration. |
| ListenHealthPort | Indique le port sur lequel écouter les connexions HTTP entrantes de vérification de l’état. |
| ListenIP | Indique l’adresse IP ou le nom d’hôte sur lequel écouter les connexions HTTP(S) entrantes provenant du serveur Zabbix. |
| ListenPort | Indique le port sur lequel écouter les connexions HTTP(S) entrantes provenant du serveur Zabbix. |
| LogFile | Indique le fichier journal de l’adaptateur de pont. |
| LogFileSize | Définit la taille maximale du fichier journal (en Mo). |
| LogType | Indique le type de sortie du journal. |
| PidFile | Indique le fichier PID. |
| ServerId | Indique l’identifiant unique du serveur Zabbix. Obligatoire. |
| TLSConfig.AllowedCN | Indique une liste séparée par des virgules de noms communs des clients autorisés (mTLS uniquement). |
| TLSConfig.CAFile | Indique le chemin complet vers 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 | Indique le chemin complet vers un fichier contenant le certificat ou la chaîne de certificats. |
| TLSConfig.KeyFile | Indique le chemin complet vers un fichier contenant la clé privée. |
| TLSConfig.Mode | Définit le mode TLS pour les connexions entrantes sur ListenPort. |
| ZabbixAPITLSCAFile | Indique le chemin complet vers 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éfinit le mode TLS pour les connexions sortantes vers l’API Zabbix. |
| ZabbixAPIURL | Indique l’URL du point de terminaison de l’API Zabbix. Obligatoire. |
| ZabbixBridgeURL | Indique l’URL du pont Zabbix utilisée 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
Spécifiez les méthodes de l’API Zabbix qui peuvent être appelées via l’adaptateur bridge.
Pour plusieurs méthodes, répétez le paramètre, à raison d’une méthode par ligne.
Chaque valeur du 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 l’adaptateur bridge de démarrer.
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
L’ensemble minimal de méthodes requis 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 exister et 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 Zabbix1- informations critiques2- informations sur les erreurs3- avertissements4- 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
Spécifiez 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 /etc/zabbix, 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
Includedans un même fichier de configuration. - Zabbix traite le paramètre
Includedès sa lecture. 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 respecté (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.confpeut créerinclude/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
ListenHealthPort
Spécifiez le port sur lequel écouter les connexions HTTP entrantes de vérification de l’état de santé.
Fournit les points de terminaison /health et /ready.
Si ce paramètre n’est pas spécifié, le service de vérification de l’état de santé n’est pas démarré.
Valeur par défaut : 8081
Plage : 1024-32767
ListenIP
Spécifiez l’adresse IP ou le nom d’hôte sur lequel écouter les connexions HTTP(S) entrantes du serveur Zabbix.
Si cette option n’est pas spécifiée, l’adaptateur bridge écoute sur toutes les adresses IP disponibles du système local.
ListenPort
Spécifiez le port d'écoute des connexions HTTP(S) entrantes provenant du serveur Zabbix.
Valeur par défaut : 10054
Plage : 1024-32767
LogFile
Spécifiez le fichier journal de l’adaptateur bridge.
Obligatoire : Oui si LogType est défini sur file ; sinon, non
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ètreLogFile.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
Indiquez l’identifiant unique du serveur Zabbix.
Disponible dans Rapports > Informations système dans l’interface web de Zabbix.
Obligatoire : Oui
TLSConfig.AllowedCN
Spécifiez une liste de noms communs de client 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 de niveau supérieur utilisés pour vérifier les certificats client en mode mTLS.
TLSConfig.CertFile
Indiquez le chemin complet vers un fichier contenant le certificat ou la chaîne de certificats.
TLSConfig.KeyFile
Indiquez le chemin complet vers un fichier contenant la clé privée.
TLSConfig.Mode
Définir le mode TLS pour les connexions entrantes sur ListenPort :
none- accepter 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
Voir aussi : TLS du serveur Zabbix vers l'adaptateur bridge Zabbix
ZabbixAPITLSCAFile
Spécifiez le chemin complet d’un fichier contenant le ou les certificats CA de niveau supérieur utilisés par l’adaptateur bridge pour vérifier le certificat de l’API Zabbix.
Obligatoire : Oui si ZabbixAPITLSConnect est défini sur verify_ca ou verify_full.
ZabbixAPITLSConnect
Définit le mode TLS pour les connexions sortantes vers l’API Zabbix :
disabled- utilise HTTP en clair ;ZabbixAPIURLdoit utiliserhttp://.required- utilise HTTPS sans vérifier le 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.
Une valeur vide ou non définie est traitée comme required.
Valeur par défaut : required
Voir également : TLS de l’adaptateur bridge Zabbix vers 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 Zabbix Bridge pour récupérer la configuration du Zabbix Bridge (récupérée au démarrage de l’adaptateur bridge).
Par défaut : ZabbixBridgeURL=https://config.mobilebridge.zabbix.com/.well-known/bridge-configuration