5 Agent Zabbix (Windows)

Aperçu

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

Les paramètres sont listés sans informations supplémentaires. Cliquez sur un paramètre pour en voir tous les détails.

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

Notez que :

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

Détails des paramètres

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 ni PerfCounter.

Exemple 1 : Récupération du pourcentage d’utilisation du fichier d’échange depuis le serveur.

Alias=pg_usage:perf_counter[\Paging File(_Total)\% Usage]

La clé abrégée pg_usage peut désormais être utilisée pour récupérer les données.

Exemple 2 : Obtention de la charge CPU avec les paramètres par défaut et des paramètres personnalisés.

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

Cela permet d’utiliser la clé cpu.load pour obtenir la charge CPU avec les paramètres par défaut, ainsi que cpu.load[percpu,avg15] pour obtenir des données spécifiques sur la charge CPU.

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

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

Il est désormais possible de configurer plusieurs règles de découverte 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 quelconques.
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 : Restriction des contrôles de l’agent.

BufferSend

Ne pas conserver 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 sur les erreurs ;
3 - avertissements ;
4 - pour le débogage (produit beaucoup d’informations) ;
5 - débogage étendu (produit encore plus d’informations).

Par défaut : 3
Plage : 0-5

DenyKey

Refuse l’exécution des clés d’élément qui correspondent à un motif. Le motif de clé est une expression générique qui prend en charge le caractère « * » pour correspondre à n’importe quel nombre de caractères quelconques.
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 distantes 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[*]

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

HeartbeatFrequency

La fréquence des messages de pulsation en secondes. Utilisée pour surveiller la disponibilité des contrôles actifs.
0 - messages de pulsation désactivés.

Par défaut : 60
Plage : 0-3600

HostInterface

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

S’il n’est pas défini, la valeur sera obtenue à partir de HostInterfaceItem.

L’agent émettra 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’autoregistration de l’hôte. Cette valeur est utilisée uniquement si HostInterface n’est pas défini. Pour plus de détails, voir Utilisation de DNS comme interface par défaut.

Lors d’une requête d’autoregistration, 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 независимо 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’enregistrement automatique de l’hôte (agent actif). HostMetadata permet de distinguer les hôtes au-delà du nom d’hôte.

S’il n’est pas défini, la valeur sera obtenue à partir de HostMetadataItem.

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

Les métadonnées sur plusieurs lignes 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 n’est utilisée que 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, les compteurs de performance et les alias sont pris en charge. L’élément system.run[] est pris en charge независимоamment des paramètres AllowKey/DenyKey.

Lors d’une requête 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 qui sont valides en UTF-8 mais ne sont pas des adresses IP ou des noms DNS valides seront également rejetées et signalées comme invalides.

Les métadonnées sur plusieurs lignes 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, séparés par des virgules. Obligatoire 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 d’hôte. Cette option n’est utilisée que lorsque Hostname n’est pas défini. Les paramètres utilisateur, les compteurs de performance ou les alias ne sont pas pris en charge, mais l’élément system.run[] est pris en charge quelles que soient les valeurs de AllowKey/DenyKey.
Voir aussi une description plus détaillée.

Par défaut : system.hostname

Include

Vous pouvez inclure des fichiers individuels ou tous les fichiers d’un répertoire dans le fichier de configuration (situé par défaut dans C:\Program Files\Zabbix Agent si l’agent Zabbix est installé à l’aide des packages d’installation Windows MSI ; situé dans le dossier spécifié lors de l’installation si l’agent Zabbix est installé sous forme d’archive zip). Tous les fichiers inclus doivent avoir une syntaxe correcte, sinon l’agent ne démarrera pas.
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=C:\Program Files\Zabbix Agent\zabbix_agentd.d\*.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 jusqu’au « maximum spécifié 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 les connexions provenant du serveur.

Par défaut : 10050
Plage : 1024-32767

LogFile

Le nom du fichier journal de l'agent.

Par défaut : c:\zabbix_agentd.log
Obligatoire : Oui, si LogType est défini sur file ; sinon non

LogFileSize

La taille maximale d’un fichier journal en Mo.
0 - désactiver la rotation automatique des journaux.
Remarque : si la limite de taille du fichier journal est atteinte et que la rotation du fichier échoue, pour quelque raison que ce soit, le fichier journal existant est tronqué et redémarré à zéro.

Par défaut : 1
Plage : 0-1024

LogRemoteCommands

Activez la journalisation des commandes shell exécutées en tant qu’avertissements. Les commandes seront journalisées uniquement 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 la sortie du journal :
file - écrit le journal dans le fichier spécifié par le paramètre LogFile ;
system - écrit le journal dans le journal des événements Windows ;
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 contrôles actifs « log », « logrt » et « eventlog ». La valeur fournie sera remplacée par le paramètre « maxlines », fourni dans la clé d'élément « log », « logrt » ou « eventlog ».
Remarque : 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

PerfCounter

Définit un nouveau paramètre <parameter_name>, qui correspond à la valeur moyenne du compteur de performances système <perf_counter_path> pour la période <period> spécifiée (en secondes).
Syntaxe : <parameter_name>,"<perf_counter_path>",<period>

Par exemple, si vous souhaitez recevoir le nombre moyen d’interruptions du processeur par seconde pour la dernière minute, vous pouvez définir un nouveau paramètre « interrupts » comme suit :

PerfCounter = interrupts,"\Processor(0)\Interrupts/sec",60

Veuillez noter les guillemets doubles autour du chemin du compteur de performances. Le nom du paramètre (interrupts) doit être utilisé comme clé d’élément lors de la création d’un élément. Des échantillons pour le calcul de la valeur moyenne seront relevés chaque seconde.
Vous pouvez exécuter « typeperf -qx » pour obtenir la liste de tous les compteurs de performances disponibles dans Windows.

PerfCounterEn

Définit un nouveau paramètre <parameter_name>, qui correspond à la valeur moyenne du compteur de performance système <perf_counter_path> pour la période <period> spécifiée (en secondes). Par rapport à PerfCounter, les chemins des compteurs de performance doivent être en anglais. Pris en charge uniquement sur Windows Server 2008/Vista et versions ultérieures.
Syntaxe : <parameter_name>,"<perf_counter_path>",<period>

Par exemple, si vous souhaitez recevoir le nombre moyen d’interruptions du processeur par seconde pour la dernière minute, vous pouvez définir un nouveau paramètre « interrupts » comme suit :

PerfCounterEn = interrupts,"\Processor(0)\Interrupts/sec",60

Veuillez noter les guillemets doubles autour du chemin du compteur de performance. Le nom du paramètre (interrupts) doit être utilisé comme clé d’élément lors de la création d’un élément. Des échantillons pour calculer la valeur moyenne seront prélevés chaque seconde.
Vous pouvez trouver la liste des chaînes en anglais en consultant la clé de registre suivante : HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Perflib\009.

RefreshActiveChecks

Fréquence de rafraîchissement de la liste des contrôles actifs, en secondes. Notez qu'après un échec du rafraîchissement des contrôles actifs, la prochaine tentative de rafraîchissement sera effectuée dans 60 secondes.

Par défaut : 5
Plage : 1-86400

Server

Une liste d'adresses IP séparées par des virgules, éventuellement en notation CIDR, ou de noms DNS de serveurs Zabbix ou de proxies Zabbix. Les connexions entrantes seront acceptées uniquement 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 manière identique et '::/0' autorisera n'importe quelle adresse IPv4 ou IPv6. '0.0.0.0/0' peut être utilisé pour autoriser n'importe quelle adresse IPv4. Notez que les « adresses IPv6 compatibles IPv4 » (préfixe 0000::/96) sont prises en charge, mais obsolètes selon la 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 desquels obtenir les contrôles actifs. L'adresse du serveur/proxy est une adresse IP ou un nom DNS, avec un port optionnel séparé par deux-points.
La configuration du cluster est constituée d'une ou plusieurs adresses de membres du groupe de serveurs ou de proxies, séparées par des points-virgules. Plusieurs serveurs/clusters Zabbix et proxies Zabbix peuvent être spécifiés, séparés par des virgules. Sauf en cas d'utilisation de groupes de proxies, il ne faut pas spécifier plus d'un proxy Zabbix pour chaque serveur/cluster Zabbix. Si un proxy Zabbix est spécifié, 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 en parallèle plusieurs serveurs Zabbix indépendants. 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 un port est spécifié pour cet hôte. 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 contrôles actifs sont désactivés.

Exemple pour un proxy Zabbix :

ServerActive=127.0.0.1:10051

Exemple pour un groupe de proxies 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

Plage : (*)

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 contrôles passifs. S’il est défini sur 0, les contrôles passifs sont désactivés et l’agent n’écoutera sur aucun port TCP.

Par défaut : 10
Plage : 0-100 (*)

Délai d’attente

Indique combien de temps attendre (en secondes) pour établir une connexion et échanger des données avec le proxy ou le 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 d’éléments dans les contrôles actifs ;
• la récupération des données de journal via la surveillance de logfile ou du journal des événements Windows ;
• l’envoi de messages heartbeat ;
• la durée maximale des contrôles vfs.* ;
• l’utilisation par les modules de l’agent Zabbix ;
• le rôle de solution de secours dans les scénarios où un serveur ou un proxy antérieur à la version 7.0 envoie des contrôles sans délais d’attente.

Ce délai d’attente ne sera pas utilisé pour les contrôles d’agent qui disposent de paramètres de délai d’attente configurables dans l’interface web (au niveau global, du proxy ou de chaque élément).

Par défaut : 3
Plage : 1-30

TLSAccept

Les connexions entrantes à accepter. Utilisé pour les contrôles passifs. 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 complet du fichier contenant les certificats de la ou des autorités de certification (CA) de niveau supérieur pour la vérification du certificat du pair, utilisé pour les communications chiffrées entre les composants Zabbix.

TLSCertFile

Le chemin 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.

TLSConnect

Comment l'agent doit se connecter au serveur Zabbix ou au proxy. Utilisé pour les contrôles actifs. 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 de certificat TLS ou de PSK sont définis (même pour une connexion unencrypted) ; sinon non

TLSCRLFile

Le chemin 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 complet du fichier contenant la clé privée de l’agent, utilisée pour les communications chiffrées entre les composants Zabbix.

TLSPSKFile

Le chemin 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 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 autorisé du serveur (proxy).

UnsafeUserParameters

Autorise le passage de tous les caractères 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

UserParameter

Un paramètre défini par l'utilisateur à surveiller. 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 une fin de ligne. Les commandes shell peuvent avoir des chemins relatifs si le paramètre UserParameterDir est spécifié.

Exemple :

UserParameter=system.test,dir /b | find /c /v ""
UserParameter=check_cpu,.\custom\_script.bat

UserParameterDir

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

Exemple :

UserParameterDir=C:\opt\myscripts