3 Zabbix agent (UNIX)

Vue d'ensemble

Les paramètres pris en charge par le fichier de configuration de l'agent Zabbix (zabbix_agentd.conf) sont répertoriés dans cette section.

Les paramètres sont listés sans informations supplémentaires. Cliquez sur le paramètre pour afficher les détails complets.

Tous les paramètres sont facultatifs, sauf indication explicite qu'un paramètre est obligatoire.

Notez que :

• Les valeurs par défaut reflètent les valeurs par défaut du démon, et non celles des fichiers de configuration fournis ;
• Zabbix prend en charge les fichiers de configuration uniquement en encodage UTF-8 sans BOM ;
• Les commentaires commençant par "#" ne sont pris en charge qu'au début de la ligne.

Détails du paramètre

Alias

Définit un alias pour une clé d'élément. Il peut être utilisé pour remplacer une clé d'élément longue et complexe par une clé plus courte et plus simple.
Plusieurs paramètres Alias peuvent être présents. Plusieurs paramètres avec la même clé Alias ne sont pas autorisés.
Différentes clés Alias peuvent référencer la même clé d'élément.
Les alias peuvent être utilisés dans HostMetadataItem mais pas dans le paramètre HostnameItem.

Exemple 1 : Récupération de l'ID de l'utilisateur 'zabbix'.

Alias=zabbix.userid:vfs.file.regexp[/etc/passwd,"^zabbix:.:([0-9]+)",,,,\1]

Désormais, la clé abrégée zabbix.userid peut être utilisée pour récupérer des données.

Exemple 2 : Obtention de l'utilisation CPU avec des paramètres par défaut et personnalisés.

Alias=cpu.util:system.cpu.util
Alias=cpu.util[*]:system.cpu.util[*]

Cela permet d'utiliser la clé cpu.util pour obtenir le pourcentage d'utilisation CPU avec les paramètres par défaut, ainsi que d'utiliser cpu.util[all, idle, avg15] pour obtenir des données spécifiques sur l'utilisation CPU.

Exemple 3 : Exécution de plusieurs règles de découverte de bas niveau traitant les mêmes éléments découverts.

Alias=vfs.fs.discovery[*]:vfs.fs.discovery

Il est désormais possible de configurer plusieurs règles de découverte en utilisant vfs.fs.discovery avec des paramètres différents pour chaque règle, par exemple vfs.fs.discovery[foo], vfs.fs.discovery[bar], etc.

AllowKey

Autoriser l'exécution des clés d'élément qui correspondent à un modèle. Le modèle de clé est une expression générique qui prend en charge le caractère "*" pour correspondre à n'importe quel nombre de caractères.
Plusieurs règles de correspondance de clés peuvent être définies en combinaison avec DenyKey. Les paramètres sont traités un par un selon leur ordre d'apparition. Voir aussi: Restricting agent checks.

AllowRoot

Autoriser l'agent à s'exécuter en tant que 'root'. Si cette option est désactivée et que l'agent est démarré par 'root', l'agent tentera de basculer vers l'utilisateur 'zabbix' à la place. Sans effet si l'agent est démarré sous un utilisateur standard.

Par défaut: 0
Valeurs: 0 - ne pas autoriser; 1 - autoriser

BufferSend

Ne conservez pas les données plus de N secondes dans le tampon.

Par défaut: 5
Plage: 1-3600

BufferSize

Le nombre maximal de valeurs dans le tampon mémoire. L'agent enverra toutes les données collectées au serveur Zabbix ou au proxy si le tampon est plein.

Par défaut: 100
Plage: 2-65535

DebugLevel

Spécifiez 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 d'erreur;
3 - avertissements;
4 - pour le débogage (génère beaucoup d'informations);
5 - débogage étendu (génère encore plus d'informations).

Par défaut : 3
Plage : 0-5

DenyKey

Interdire l'exécution des clés d'élément qui correspondent à un modèle. Le modèle de clé est une expression générique qui prend en charge le caractère "*" pour correspondre à n'importe quel nombre de caractères.
Plusieurs règles de correspondance de clés peuvent être définies en combinaison avec AllowKey. Les paramètres sont traités un par un selon leur ordre d'apparition. Voir aussi : Restriction des vérifications de l'agent.

EnableRemoteCommands

Indique si les commandes à distance provenant du serveur Zabbix sont autorisées. Ce paramètre est obsolète ; utilisez plutôt AllowKey=system.run[*] ou DenyKey=system.run[*].
Il s'agit d'un alias interne des paramètres AllowKey/DenyKey selon la valeur :
0 - DenyKey=system.run[*]
1 - AllowKey=system.run[*]

Valeur par défaut : 0
Valeurs : 0 - ne pas autoriser, 1 - autoriser

HeartbeatFrequency

La fréquence des messages de heartbeat en secondes. Utilisée pour surveiller la disponibilité des vérifications actives.
0 - messages de heartbeat désactivés.

Par défaut: 60
Plage: 0-3600

HostInterface

Un paramètre facultatif qui définit l'interface de l'hôte (adresse IP ou nom DNS) utilisée pendant le processus d'enregistrement automatique de l'hôte. Cette valeur sera utilisée pour renseigner l'interface dans le nouvel hôte créé et permet de configurer explicitement une adresse IP ou DNS. Pour plus de détails, voir Utiliser DNS comme interface par défaut.

Si elle n'est pas définie, la valeur sera obtenue à partir de HostInterfaceItem.

L'agent signalera une erreur et ne démarrera pas si la valeur dépasse la limite de 255 caractères.

Plage : 0-255 caractères

HostInterfaceItem

Un paramètre facultatif qui définit un élément utilisé pour déterminer l'interface de l'hôte (adresse IP ou nom DNS) pendant le processus d'autoréenregistrement de l'hôte. Cette valeur est utilisée uniquement si HostInterface n'est pas défini. Pour plus de détails, consultez Utiliser DNS comme interface par défaut.

Lors d'une requête d'autoréenregistrement, l'agent consignera un message d'avertissement si la valeur renvoyée par l'élément spécifié dépasse la limite de 255 caractères.

L'élément system.run[] est pris en charge indépendamment des paramètres AllowKey/DenyKey.

HostMetadata

Un paramètre facultatif qui définit les métadonnées utilisées pour identifier ou distinguer l'hôte pendant le processus d'autoregistration de l'hôte (agent actif). HostMetadata permet de distinguer les hôtes au-delà du nom d'hôte.

Si elle n'est pas définie, la valeur sera récupérée à partir de HostMetadataItem.

L'agent signalera une erreur et ne démarrera pas si la valeur spécifiée dépasse la limite de 2034 octets ou s'il s'agit d'une chaîne non UTF-8. Lorsqu'un paramètre attend une adresse IP ou un nom DNS, les valeurs valides en UTF-8 mais qui ne sont pas des IP ou des noms DNS valides seront également rejetées et signalées comme invalides.

Les métadonnées multilignes ne sont pas prises en charge — la sortie sera tronquée au premier saut de ligne.

Plage: 0-2034 octets

HostMetadataItem

Un paramètre facultatif qui définit un élément d'agent Zabbix utilisé pour obtenir les métadonnées de l'hôte. Cette option est utilisée uniquement lorsque HostMetadata n'est pas défini.

La valeur de HostMetadataItem est récupérée à chaque tentative d'auto-enregistrement et n'est utilisée que lors du processus d'auto-enregistrement de l'hôte (agent actif). HostMetadataItem permet de distinguer les hôtes au-delà du nom d'hôte.

Les paramètres utilisateur et les alias sont pris en charge. L'élément system.run[] est pris en charge indépendamment des paramètres AllowKey/DenyKey.

Lors d'une demande d'auto-enregistrement, l'agent consignera un message d'avertissement si la valeur renvoyée par l'élément spécifié dépasse la limite de 65535 points de code UTF-8. La valeur renvoyée par l'élément doit être une chaîne UTF-8, sinon elle sera ignorée. Lorsqu'un paramètre attend une adresse IP ou un nom DNS, les valeurs valides en UTF-8 mais non valides en tant qu'adresses IP ou noms DNS seront également rejetées et signalées comme invalides.

Les métadonnées multilignes ne sont pas prises en charge — la sortie sera tronquée au premier saut de ligne.

Nom d'hôte

Une liste de noms d'hôte uniques, sensibles à la casse et séparés par des virgules. Requis pour les vérifications actives et doit correspondre aux noms d'hôte tels qu'ils sont configurés sur le serveur. La valeur est obtenue à partir de HostnameItem si elle n'est pas définie.
Caractères autorisés: alphanumériques, '.', ' ', '_' et '-'. Longueur maximale: 128 caractères par nom d'hôte, 2048 caractères pour l'ensemble de la ligne.

Par défaut: défini par HostnameItem

HostnameItem

Un paramètre facultatif qui définit un élément d'agent Zabbix utilisé pour obtenir le nom de l'hôte. Cette option n'est utilisée que lorsque Hostname n'est pas défini. Les paramètres utilisateur ou les alias ne sont pas pris en charge, mais l'élément system.run[] est pris en charge indépendamment des valeurs AllowKey/DenyKey.

Par défaut: system.hostname

Inclure

Vous pouvez inclure des fichiers individuels ou tous les fichiers d'un répertoire dans le fichier de configuration. Pour n'inclure que les fichiers pertinents dans le répertoire spécifié, le caractère générique astérisque est pris en charge pour la correspondance de motifs.
Consultez les notes spéciales concernant les limitations.

Exemple :

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

ListenBacklog

Le nombre maximal de connexions en attente dans la file TCP.
La valeur par défaut est une constante codée en dur, qui dépend du système.
La valeur maximale prise en charge dépend également du système ; des valeurs trop élevées peuvent être tronquées silencieusement à la « valeur maximale spécifiée par l'implémentation ».

Par défaut: SOMAXCONN
Plage: 0 - INT_MAX

ListenIP

Une liste d'adresses IP séparées par des virgules sur lesquelles l'agent doit écouter.

Par défaut: 0.0.0.0

ListenPort

L'agent écoutera sur ce port pour les connexions provenant du serveur.

Par défaut: 10050
Plage: 1024-32767

LoadModule

Le module à charger au démarrage de l'agent. Les modules sont utilisés pour étendre les fonctionnalités de l'agent. Le module doit se trouver dans le répertoire spécifié par LoadModulePath ou le chemin doit précéder le nom du module. Si le chemin précédent est absolu (commence par '/') alors LoadModulePath est ignoré.
Formats :
LoadModule=<module.so>
LoadModule=<path/module.so>
LoadModule=</abs_path/module.so>
Il est permis d'inclure plusieurs paramètres LoadModule.

LoadModulePath

Le chemin complet vers l'emplacement des modules de l'agent. La valeur par défaut dépend des options de compilation.

LogFile

Le nom du fichier journal.

Obligatoire : Oui, si LogType est défini sur file ; sinon non

LogFileSize

La taille maximale d'un fichier journal en MB.
0 - désactive la rotation automatique des journaux.
Remarque : si la limite de taille du fichier journal est atteinte et que la rotation du fichier échoue, quelle qu'en soit la raison, le fichier journal existant est tronqué et recréé.

Par défaut : 1
Plage : 0-1024

LogRemoteCommands

Active l'enregistrement des commandes shell exécutées en tant qu'avertissements. Les commandes ne seront consignées que si elles sont exécutées à distance. Aucune entrée de journal ne sera créée si system.run[] est lancé localement par les paramètres HostMetadataItem, HostInterfaceItem ou HostnameItem.

Par défaut: 0
Valeurs: 0 - désactivé, 1 - activé

LogType

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.

Par défaut : file

MaxLinesPerSecond

Le nombre maximal de nouvelles lignes que l'agent enverra par seconde au serveur Zabbix ou au proxy lors du traitement des vérifications actives 'log' et 'logrt'. La valeur fournie sera remplacée par le paramètre 'maxlines', fourni dans la clé d'élément 'log' ou 'logrt'.
Note : Zabbix traitera 10 fois plus de nouvelles lignes que la valeur définie dans MaxLinesPerSecond afin de rechercher la chaîne requise dans les éléments de journal.

Par défaut : 20
Plage : 1-1000

PidFile

Le nom du fichier PID.

Par défaut : /tmp/zabbix_agentd.pid

RefreshActiveChecks

Fréquence de rafraîchissement de la liste des vérifications actives, en secondes. Notez qu'après un échec de rafraîchissement des vérifications actives, la prochaine tentative de rafraîchissement sera effectuée dans 60 secondes.

Par défaut: 5
Plage: 1-86400

Serveur

Une liste d'adresses IP séparées par des virgules, éventuellement en notation CIDR, ou des noms DNS des serveurs Zabbix et des proxies Zabbix. Les connexions entrantes ne seront acceptées que depuis les hôtes répertoriés ici. Si la prise en charge d'IPv6 est activée, alors '127.0.0.1', '::127.0.0.1', '::ffff:127.0.0.1' sont traitées de la même manière et '::/0' autorisera toute adresse IPv4 ou IPv6. '0.0.0.0/0' peut être utilisé pour autoriser toute adresse IPv4. Notez que les "adresses IPv6 compatibles IPv4" (préfixe 0000::/96) sont prises en charge mais déconseillées par RFC4291. Les espaces sont autorisés.

Exemple :

Server=127.0.0.1,192.168.1.0/24,::1,2001:db8::/32,zabbix.example.com

Obligatoire : oui, si StartAgents n'est pas explicitement défini sur 0

ServerActive

L'adresse du serveur/proxy Zabbix ou la configuration du cluster à partir de laquelle récupérer les vérifications actives. L'adresse du serveur/proxy est une adresse IP ou un nom DNS, avec un port facultatif séparé par deux-points.
La configuration du cluster est constituée d'une ou plusieurs adresses de membres de groupe de serveur ou de proxy séparées par un point-virgule. Plusieurs serveurs/clusters Zabbix et proxies Zabbix peuvent être spécifiés, séparés par une virgule. Sauf en cas d'utilisation de groupes de proxy, il ne faut pas spécifier plus d'un proxy Zabbix pour chaque serveur/cluster Zabbix. Si un proxy Zabbix est spécifié, alors le serveur/cluster Zabbix correspondant à ce proxy ne doit pas être spécifié.
Plusieurs adresses séparées par des virgules peuvent être fournies pour utiliser plusieurs serveurs Zabbix indépendants en parallèle. Les espaces sont autorisés.
Si le port n'est pas spécifié, le port par défaut est utilisé.
Les adresses IPv6 doivent être placées entre crochets si le port de cet hôte est spécifié. Si le port n'est pas spécifié, les crochets pour les adresses IPv6 sont facultatifs.
Si ce paramètre n'est pas spécifié, les vérifications actives sont désactivées.

Exemple pour un proxy Zabbix :

ServerActive=127.0.0.1:10051

Exemple pour un groupe de proxy Zabbix :

ServerActive=proxy1.example.com;proxy2.example.com;proxy3.example.com;proxy4.example.com;proxy5.example.com

Exemple pour plusieurs serveurs :

ServerActive=127.0.0.1:20051,zabbix.domain,[::1]:30051,::1,[12fc::1]

Exemple pour la haute disponibilité :

ServerActive=zabbix.cluster.node1;zabbix.cluster.node2:20051;zabbix.cluster.node3

Exemple pour la haute disponibilité avec deux clusters et un serveur :

ServerActive=zabbix.cluster.node1;zabbix.cluster.node2:20051,zabbix.cluster2.node1;zabbix.cluster2.node2,zabbix.domain

SourceIP

L'adresse IP source pour :

• les connexions sortantes vers le serveur Zabbix ou le proxy Zabbix ;
• l'établissement de connexions lors de l'exécution de certains éléments (web.page.get, net.tcp.port, etc.).

StartAgents

Le nombre d'instances pré-forkées de zabbix_agentd qui traitent les vérifications passives. Si la valeur est définie sur 0, les vérifications passives sont désactivées et l'agent n'écoutera sur aucun port TCP.

Par défaut: 10
Plage: 0-100

Délai d'attente

Spécifie la durée d'attente, en secondes, pour établir la connexion et échanger des données avec un proxy ou un serveur Zabbix.

Ce paramètre définit la durée de diverses opérations de communication, notamment :

• l'attente d'une réponse du serveur Zabbix ;
• l'envoi de requêtes au serveur Zabbix, y compris les requêtes de configuration des éléments et les données des éléments dans les vérifications actives ;
• la récupération des données de journal via logfile ;
• l'envoi de messages de heartbeat ;
• la durée maximale des vérifications vfs.* ;
• l'utilisation par les modules de l'agent Zabbix ;
• le rôle de solution de repli dans les scénarios où un serveur ou un proxy antérieur à la version 7.0 envoie des vérifications sans délais d'attente.

Ce délai d'attente ne sera pas utilisé pour les vérifications d'agent qui disposent de paramètres de délai d'attente configurables dans l'interface (au niveau global, du proxy ou par élément).

Par défaut : 3
Plage : 1-30

TLSAccept

Quelles connexions entrantes accepter. Utilisé pour les vérifications passives. Plusieurs valeurs peuvent être spécifiées, séparées par des virgules :
unencrypted - accepter les connexions sans chiffrement (par défaut)
psk - accepter les connexions avec TLS et une clé prépartagée (PSK)
cert - accepter les connexions avec TLS et un certificat

Obligatoire : oui, si les paramètres de certificat TLS ou de PSK sont définis (même pour une connexion unencrypted) ; sinon non

TLSCAFile

Le chemin d'accès complet du fichier contenant le ou les certificats de l'autorité de certification racine utilisés pour la vérification du certificat du pair, employé pour les communications chiffrées entre les composants Zabbix.

TLSCertFile

Le chemin d'accès complet du fichier contenant le certificat de l'agent ou la chaîne de certificats, utilisé pour les communications chiffrées avec les composants Zabbix.

TLSCipherAll

La chaîne de priorité GnuTLS ou la chaîne de suites de chiffrement OpenSSL (TLS 1.2). Remplace les critères de sélection par défaut des suites de chiffrement pour le chiffrement basé sur les certificats et sur PSK.

Exemple :

TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256

TLSCipherAll13

La chaîne de chiffrement pour OpenSSL 1.1.1 ou une version plus récente en TLS 1.3. Remplace les critères de sélection par défaut de la suite de chiffrement pour le chiffrement basé sur les certificats et sur PSK.

Exemple pour GnuTLS :

NONE:+VERS-TLS1.2:+ECDHE-RSA:+RSA:+ECDHE-PSK:+PSK:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+CURVE-ALL:+COMP-NULL::+SIGN-ALL:+CTYPE-X.509

Exemple pour OpenSSL :

EECDH+aRSA+AES128:RSA+aRSA+AES128:kECDHEPSK+AES128:kPSK+AES128

TLSCipherCert

La chaîne de priorité GnuTLS ou la chaîne de chiffrement OpenSSL (TLS 1.2). Remplace les critères de sélection par défaut de la suite de chiffrement pour le chiffrement basé sur des certificats.

Exemple pour GnuTLS :

NONE:+VERS-TLS1.2:+ECDHE-RSA:+RSA:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+CURVE-ALL:+COMP-NULL:+SIGN-ALL:+CTYPE-X.509

Exemple pour OpenSSL :

EECDH+aRSA+AES128:RSA+aRSA+AES128

TLSCipherCert13

La chaîne de chiffrement pour OpenSSL 1.1.1 ou une version plus récente en TLS 1.3. Remplacez les critères de sélection par défaut de la suite de chiffrement pour le chiffrement basé sur des certificats.

TLSCipherPSK

La chaîne de priorité GnuTLS ou la chaîne de chiffrement OpenSSL (TLS 1.2). Remplacez les critères de sélection par défaut de la suite de chiffrement pour le chiffrement basé sur PSK.

Exemple pour GnuTLS :

NONE:+VERS-TLS1.2:+ECDHE-PSK:+PSK:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+CURVE-ALL:+COMP-NULL:+SIGN-ALL

Exemple pour OpenSSL :

kECDHEPSK+AES128:kPSK+AES128

TLSCipherPSK13

La chaîne de chiffrement pour OpenSSL 1.1.1 ou version ultérieure en TLS 1.3. Remplacez les critères de sélection de la suite de chiffrement par défaut pour le chiffrement basé sur PSK.

Exemple :

TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256

TLSConnect

Comment l'agent doit se connecter au serveur ou au proxy Zabbix. Utilisé pour les vérifications actives. Une seule valeur peut être spécifiée :
unencrypted - se connecter sans chiffrement (par défaut)
psk - se connecter en utilisant TLS et une clé prépartagée (PSK)
cert - se connecter en utilisant TLS et un certificat

Obligatoire : oui, si les paramètres du certificat TLS ou du PSK sont définis (même pour une connexion unencrypted) ; sinon non

TLSCRLFile

Le chemin d'accès complet du fichier contenant les certificats révoqués. Ce paramètre est utilisé pour les communications chiffrées entre les composants Zabbix.

TLSKeyFile

Le chemin d'accès complet du fichier contenant la clé privée de l'agent, utilisé pour les communications chiffrées entre les composants Zabbix.

TLSPSKFile

Le chemin d'accès complet du fichier contenant la clé pré-partagée de l'agent, utilisée pour les communications chiffrées avec le serveur Zabbix.

TLSPSKIdentity

La chaîne d'identité de la clé prépartagée, utilisée pour les communications chiffrées avec le serveur Zabbix.

TLSServerCertIssuer

L'émetteur autorisé du certificat du serveur (proxy).

TLSServerCertSubject

Le sujet du certificat du serveur (proxy) autorisé.

UnsafeUserParameters

Autoriser tous les caractères à être transmis dans les arguments des paramètres définis par l'utilisateur. Les caractères suivants ne sont pas autorisés : \ ' " ` * ? [ ] { } \~ $ ! & ; ( ) < > | # @
De plus, les caractères de nouvelle ligne ne sont pas autorisés.

Par défaut : 0
Valeurs : 0 - ne pas autoriser, 1 - autoriser

Utilisateur

Abaisser les privilèges à un utilisateur spécifique existant sur le système.
Ne prend effet que si l'exécution est effectuée en tant que 'root' et si AllowRoot est désactivé.

Par défaut: zabbix

UserParameter

Un paramètre défini par l'utilisateur pour la surveillance. Il peut y avoir plusieurs paramètres définis par l'utilisateur.
Format : UserParameter=<key>,<shell command>
Notez que la commande shell ne doit pas renvoyer une chaîne vide ni uniquement un EOL. Les commandes shell peuvent utiliser des chemins relatifs si le paramètre UserParameterDir est spécifié.

Exemple :

UserParameter=system.test,who|wc -l
UserParameter=check_cpu,./custom_script.sh

UserParameterDir

Le chemin de recherche par défaut pour les commandes UserParameter. Si cette option est utilisée, l'agent changera son répertoire de travail vers celui spécifié ici avant d'exécuter une commande. Ainsi, les commandes UserParameter peuvent utiliser un préfixe relatif ./ au lieu d'un chemin complet.
Une seule entrée est autorisée.

Exemple :

UserParameterDir=/opt/myscripts

Voir aussi

1. Différences dans la configuration de l'agent Zabbix pour les vérifications actives et passives à partir de la version 2.0.0