6 Agent Zabbix 2 (Windows)

Vue d'ensemble

Zabbix agent 2 est une nouvelle génération de Zabbix agent et peut être utilisé à la place de Zabbix agent.

Les paramètres pris en charge par le fichier de configuration de Zabbix agent 2 pour Windows (zabbix_agent2.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 processus, 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 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 faire référence à 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'utilisation du fichier d'échange en pourcentage depuis le serveur.

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

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

Exemple 2 : Obtention de la charge CPU avec des paramètres par défaut et 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 des paramètres par défaut, ainsi que la clé 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 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 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.
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.

BufferSend

L'intervalle de temps, en secondes, qui détermine la fréquence à laquelle les valeurs sont envoyées du tampon au serveur Zabbix.
Notez que si le tampon est plein, les données seront envoyées plus tôt.

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.
Ce paramètre ne doit être utilisé que si le tampon persistant est désactivé (EnablePersistentBuffer=0).

Par défaut: 1000
Plage: 2-65535

ControlSocket

Le socket de contrôle, utilisé pour envoyer des commandes d'exécution avec l'option -R.

Par défaut: \\.\pipe\agent.sock

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.

EnablePersistentBuffer

Activez l'utilisation du stockage persistant local pour les éléments actifs. Si le stockage persistant est désactivé, le tampon mémoire sera utilisé.

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

ForceActiveChecksOnStart

Effectue les vérifications actives immédiatement après le redémarrage pour la première configuration reçue. Également disponible en tant que paramètre de configuration par plugin, par exemple : Plugins.Uptime.System.ForceActiveChecksOnStart=1

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

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 de ré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, consultez Utiliser DNS comme interface par défaut.

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

L'agent renverra 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 obtenue à 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 n'est utilisée que lorsque HostMetadata n'est pas défini.

La valeur de HostMetadataItem est récupérée à chaque tentative d'autodéclaration et n'est utilisée que dans le processus d'autodéclaration 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 requête d'autodéclaration, 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 à la première rupture 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

Paramètre facultatif qui définit un élément 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 (situé par défaut dans C:\Program Files\Zabbix Agent 2 si l'agent Zabbix est installé à l'aide des packages d'installation MSI Windows ; 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. Le chemin peut être relatif à l'emplacement du fichier zabbix_agent2.conf (par exemple, Include=.\zabbix_agent2.d\plugins.d\*.conf).
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.
Voir les notes spéciales concernant les limitations.

Exemple :

Include=C:\Program Files\Zabbix Agent2\zabbix_agent2.d\*.conf

ListenIP

Une liste d'adresses IP séparées par des virgules sur lesquelles l'agent doit écouter. La première adresse IP est envoyée au serveur Zabbix, lors de la connexion à celui-ci, afin de récupérer la liste des vérifications actives.

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

LogFile

Le nom du fichier journal de l'agent.

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

LogFileSize

La taille maximale d'un fichier journal en Mo.
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

LogType

Le type de sortie du journal :
file - écrit le journal dans le fichier spécifié par le paramètre LogFile ;
console - écrit le journal vers la sortie standard.

Par défaut : file

PersistentBufferFile

Le fichier dans lequel Zabbix agent 2 doit conserver la base de données SQLite. Doit être un nom de fichier complet. Ce paramètre est utilisé uniquement si le tampon persistant est activé (EnablePersistentBuffer=1).

PersistentBufferPeriod

La période pendant laquelle les données doivent être stockées lorsqu'il n'y a pas de connexion au serveur ou au proxy. Les données plus anciennes seront perdues. Les données de journal seront conservées. Ce paramètre est utilisé uniquement si le tampon persistant est activé (EnablePersistentBuffer=1).

Par défaut: 1h
Plage: 1m-365d

Plugins.<PluginName>.System.Capacity

La limite du nombre de vérifications par plugin <PluginName> pouvant être exécutées simultanément.

Par défaut: 1000 Plage: 1-1000

Plugins.Log.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', '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 pour MaxLinesPerSecond afin de rechercher la chaîne requise dans les éléments de journal.

Par défaut : 20
Plage : 1-1000

Plugins.SystemRun.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é

PluginSocket

Le chemin du canal nommé Windows pour les communications du plugin chargeable.

Par défaut: \\.\pipe\agent.plugin.sock

PluginTimeout

Le délai d'attente pour les connexions avec des plugins chargeables, en secondes.

Par défaut : Timeout
Plage : 1-30

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 spécifiée <period> (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é de l'élément lors de la création d'un élément. Les échantillons utilisés pour calculer 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 est la valeur moyenne du compteur de performances système <perf_counter_path> pour la période spécifiée <period> (en secondes). Par rapport à PerfCounter, les chemins de compteur de performances 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 performances. Le nom du paramètre (interrupts) doit être utilisé comme clé de l'élément lors de la création d'un élément. Les échantillons utilisés 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 vérifications actives, en secondes. Notez qu'après un échec du rafraîchissement des vérifications actives, la prochaine tentative 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 de noms DNS de serveurs Zabbix ou de proxys 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és de la même manière 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. Les espaces sont autorisés. Si ce paramètre n'est pas spécifié, les vérifications passives sont désactivées et l'agent n'écoutera sur aucun port TCP.

Exemple :

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

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 éventuellement un port 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 proxy 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 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 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 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.).

StatusPort

Si cette option est définie, l'agent écoutera sur ce port les requêtes HTTP de statut (http://localhost:<port>/status).

Plage : 1024-32767

Délai d'attente

Spécifie la durée d'attente, en secondes, pour établir la 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 des éléments dans les vérifications actives ;
• la récupération des données de journal via la surveillance des fichiers journaux ou du journal des événements Windows ;
• l'envoi de messages de heartbeat ;
• la durée maximale des vérifications vfs.* ;
• 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élai d'attente.

Ce délai d'attente ne sera pas utilisé pour les vérifications de l'agent qui disposent de paramètres de délai d'attente configurables dans l'interface (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 vérifications passives. Plusieurs valeurs peuvent être spécifiées, séparées par une virgule :
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 du certificat TLS ou du PSK sont définis (même pour une connexion unencrypted) ; sinon non

TLSCAFile

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

TLSCipherAll13

La chaîne de chiffrement OpenSSL (TLS 1.3). 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

Ce paramètre est pris en charge depuis Zabbix 7.0.4.

TLSCipherCert13

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

Notez que ce paramètre ne peut pas être utilisé avec TLSAccept=cert,psk ; pour une connexion par certificat (TLSConnect=cert), utilisez plutôt TLSCipherAll13.

Ce paramètre est pris en charge depuis Zabbix 7.0.4.

TLSCipherPSK13

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

Exemple :

TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256

Ce paramètre est pris en charge depuis Zabbix 7.0.4.

TLSConnect

Comment l'agent doit se connecter au serveur Zabbix ou au proxy. 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 de certificat TLS ou de 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é 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 du certificat autorisé du serveur (proxy).

TLSServerCertSubject

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

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

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 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. 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=C:\opt\myscripts