Documentation
Table of Contents
4 Agent Zabbix (Windows)
Les valeurs par défaut reflètent les valeurs par défaut du démon, pas les valeurs des fichiers de configuration livrés.
Les paramètres supportés dans le fichier de configuration de l'agent Zabbix (Windows) :
| Paramètre | Obligatoire | Intervalle | Par défaut | Description |
|---|---|---|---|---|
| Alias | non | 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 petite et plus simple. Plusieurs paramètres d'Alias peuvent être présents. Plusieurs paramètres avec la même clé Alias sont autorisés. Des clés alias différentes peuvent faire référence à la même clé d’élément. Les alias peuvent être utilisés dans HostMetadataItem mais pas dans les paramètres HostnameItem. Exemples : 1. Récupération de l'ID de l'utilisateur 'zabbix'. Alias=zabbix.userid:vfs.file.regexp[/etc/passwd,"^zabbix:.:([0-9]+)",,,,\1] Maintenant, la clé abrégée zabbix.userid peut être utilisée pour récupérer des données. 2. Utilisation du processeur avec les paramètres par défaut et personnalisés. Alias=cpu.util:system.cpu.util Alias=cpu.util[*]:system.cpu.util[*] Cela permet à la clé cpu.util d’obtenir le pourcentage d’utilisation du processeur avec les paramètres par défaut, ainsi que cpu.util[all, idle, avg15] pour obtenir des données spécifiques sur l’utilisation du processeur. 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 maintenant 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. |
||
| BufferSend | non | 1-3600 | 5 | Ne conservez pas les données plus de N secondes dans la mémoire tampon. |
| BufferSize | non | 2-65535 | 100 | Nombre maximum de valeurs dans une mémoire tampon. L'agent enverra toutes les données collectées sur le serveur Zabbix ou le proxy si la mémoire tampon est saturée. |
| DebugLevel | non | 0-5 | 3 | Spécifie le niveau de debug : 0 - informations de base sur le démarrage et l'arrêt des processus Zabbix 1 - informations critiques 2 - information d'erreur 3 - avertissements 4 - pour le débogage (produit beaucoup d'informations) 5 - débogage étendu (produit encore plus d'informations) |
| EnableRemoteCommands | non | 0 | Si les commandes à distance du serveur Zabbix sont autorisées. 0 - non autorisé 1 - autorisé |
|
| HostMetadata | non | 0-255 characters | Paramètre facultatif définissant les métadonnées de l'hôte. Les métadonnées de l'hôte sont utilisées uniquement lors du processus d'enregistrement automatique de l'hôte (agent actif). Si non défini, la valeur sera acquise de HostMetadataItem. Un agent émettra une erreur et ne démarrera pas si la valeur spécifiée est supérieure à la limite ou à une chaîne non UTF-8. Cette option est prise en charge dans les versions 2.2.0 et supérieures. |
|
| HostMetadataItem | non | Paramètre facultatif définissant un élément d'agent Zabbix utilisé pour obtenir les métadonnées de l'hôte. Cette option est uniquement utilisée lorsque HostMetadata n'est pas défini. Prend en charge les UserParameters et les alias. Prend en charge system.run[] indépendamment de la valeur EnableRemoteCommands. La valeur du HostMetadataItem est récupérée à chaque tentative d'enregistrement automatique et elles sont utilisées uniquement lors du processus d'enregistrement automatique de l'hôte (agent actif). Lors d'une demande d'enregistrement automatique, un agent enregistre un message d'avertissement si la valeur renvoyée par l'élément spécifié dépasse 255 caractères. La valeur renvoyée par l'élément doit être une chaîne UTF-8, sinon elle sera ignorée. Cette option est prise en charge dans les versions 2.2.0 et supérieures. |
||
| Hostname | non | Défini par HostnameItem | Nom d'hôte unique et sensible à la casse. Requis pour les vérifications actives et doit correspondre au nom d'hôte tel que configuré sur le serveur. Caractères autorisés : alphanumérique, '.', ' ', '_' Et '-'. Longueur maximale: 64 |
|
| HostnameItem | non | system.hostname | 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 le nom d'hôte n'est pas défini. Ne prend pas en charge les UserParameters ni les alias, mais prend en charge system.run[] indépendamment de la valeur EnableRemoteCommands. Cette option est prise en charge dans les versions 1.8.6 et supérieures. Voir aussi une description plus détaillée. |
|
| Include | non | Vous pouvez inclure des fichiers individuels ou tous les fichiers d’un répertoire dans le fichier de configuration. Pour inclure uniquement 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 modèle. Par exemple : /absolute/path/to/config/files/*.conf. La correspondance de modèle est prise en charge depuis Zabbix 2.4.0.Voir les notes spéciales sur les limitations. |
||
| ListenIP | non | 0.0.0.0 | Liste des adresses IP séparées par des virgules sur lesquelles l'agent doit écouter. Plusieurs adresses IP sont prises en charge dans les versions 1.8.3 et supérieures. |
|
| ListenPort | non | 1024-32767 | 10050 | L'agent écoutera sur ce port les connexions du serveur. |
| LogFile | oui, si LogType est défini sur file, sinon non |
C:\zabbix_agentd.log | Nom du fichier journal. | |
| LogFileSize | non | 0-1024 | 1 | Taille maximale du fichier journal en Mo. 0 - désactive la rotation automatique du journal. Remarque : Si la taille limite du fichier journal est atteinte et que la rotation du fichier échoue, le fichier journal existant est tronqué et commencé à neuf. |
| LogType | non | file | 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. Ce paramètre est supporté depuis Zabbix 3.0.0. |
|
| LogRemoteCommands | non | 0 | Activer la journalisation des commandes shell exécutées en tant qu'avertissements. 0 - désactivé 1 - activé |
|
| MaxLinesPerSecond | non | 1-1000 | 20 | Nombre maximal de nouvelles lignes que l'agent enverra par seconde au serveur Zabbix ou au proxy lors du traitement des vérifications actives "journal" et "journal des événements". La valeur fournie sera remplacée par le paramètre 'maxlines', fourni dans la clé de l'élément 'log' ou 'eventlog'. Remarque : Zabbix traitera 10 fois plus de nouvelles lignes que celles définies dans MaxLinesPerSecond pour rechercher la chaîne requise dans les éléments journaux. |
| RefreshActiveChecks | non | 60-3600 | 120 | Fréquence à laquelle la liste des vérifications actives est actualisée, en secondes. Notez que, après un échec d'actualisation des vérifications actives, la prochaine actualisation sera tentée après 60 secondes. |
| Server | oui, si StartAgents n'est pas explicitement défini sur 0 | Liste des adresses IP délimitées par des virgules, éventuellement en notation CIDR, ou des noms d’hôte de serveurs Zabbix et de proxys Zabbix. Les connexions entrantes ne seront acceptées que des hôtes énumérés ici. Si la prise en charge IPv6 est activée, les options "127.0.0.1", "::127.0.0.1", "::ffff:127.0.0.1" sont traitées de la même manière et "::/0" autorise toutes les adresses 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 par la RFC4291. Exemple : Server=127.0.0.1,192.168.1.0/24,::1,2001:db8::/32,zabbix.domain Les espaces sont autorisés. |
||
| ServerActive | non | (*) | IP:port (ou nom d'hôte:port) du serveur Zabbix ou du proxy Zabbix pour les vérifications actives. 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 contrôles actifs sont désactivés. |
|
| SourceIP | non | Adresse IP source pour les connexions sortantes. | ||
| StartAgents | non | 0-63 (*) | 3 | Nombre d'instances prédéfinies de zabbix_agentd qui traitent les vérifications passives. Si défini sur 0, désactive les vérifications passives et l'agent n'écoutera aucun port TCP. Auparavant, la limite supérieure était 16 avant la version 1.8.5. |
| Timeout | non | 1-30 | 3 | Ne pas dépenser plus de Timeout secondes pour le traitement |
| TLSAccept | oui, si le certificat TLS ou les paramètres PSK sont définis (même pour une connexion non chiffrée), sinon non | Quelles connexions entrantes accepter. Utilisé pour les vérifications passives. Plusieurs valeurs peuvent être spécifiées, séparées par une virgule : unencrypted - accepte les connexions sans cryptage (par défaut) psk - accepte les connexions avec TLS et une clé pré-partagée (PSK) cert - accepte les connexions avec TLS et un certificat Ce paramètre est supporté depuis Zabbix 3.0.0. |
||
| TLSCAFile | non | Chemin d'accès complet d'un fichier contenant les certificats de l'autorité de certification de niveau supérieur pour la vérification de certificat homologue, utilisé pour les communications chiffrées entre les composants Zabbix. Ce paramètre est supporté depuis Zabbix 3.0.0. |
||
| TLSCertFile | non | Chemin d'accès complet d'un fichier contenant le certificat de l'agent ou la chaîne de certificats, utilisé pour les communications chiffrées avec les composants Zabbix. Ce paramètre est supporté depuis Zabbix 3.0.0. |
||
| TLSConnect | oui, si le certificat TLS ou les paramètres PSK sont définis (même pour une connexion non chiffrée), sinon non | Quelles sont les connexions entrantes à accepter. Utilisé pour les vérifications passives. Plusieurs valeurs peuvent être spécifiées, séparées par une virgule : unencrypted - accepte les connexions sans cryptage (par défaut) psk - accepte les connexions avec TLS et une clé pré-partagée (PSK) cert - accepte les connexions avec TLS et un certificat Ce paramètre est supporté depuis Zabbix 3.0.0. |
||
| TLSCRLFile | non | Chemin d'accès complet d'un fichier contenant les certificats révoqués, utilisé pour les communications chiffrées entre les composants Zabbix. Ce paramètre est supporté depuis Zabbix 3.0.0. |
||
| TLSKeyFile | non | Chemin d'accès complet d'un fichier contenant le fichier de clé privée de l'agent utilisé pour les communications chiffrées avec les composants Zabbix. Ce paramètre est supporté depuis Zabbix 3.0.0. |
||
| TLSPSKFile | non | Chemin d'accès complet d'un fichier contenant la clé pré-partagée de l'agent utilisée pour les communications chiffrées avec les composants Zabbix. Ce paramètre est supporté depuis Zabbix 3.0.0. |
||
| TLSPSKIdentity | non | Chaîne d'identité de clé pré-partagée, utilisée pour les communications chiffrées avec le serveur Zabbix. Ce paramètre est supporté depuis Zabbix 3.0.0. |
||
| TLSServerCertIssuer | non | Émetteur de certificat serveur autorisé (ou proxy). Ce paramètre est supporté depuis Zabbix 3.0.0. |
||
| TLSServerCertSubject | non | Sujet du certificat serveur autorisé (ou proxy). Ce paramètre est supporté depuis Zabbix 3.0.0. |
||
| UnsafeUserParameters | non | 0,1 | 0 | Autorise tous les caractères à être passés en arguments aux paramètres définis par l'utilisateur. Pris en charge depuis Zabbix 1.8.2. Les caractères suivants ne sont pas autorisés : \ ' " ` * ? [ ] { } ~ $ ! & ; ( ) < > | # @ De plus, les caractères de nouvelle ligne ne sont pas autorisés. |
| UserParameter | non | Paramètre à surveiller défini par l'utilisateur. 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 de chaîne vide ou d’EOL uniquement. Exemple : UserParameter=system.test,echo 1 |
||
(*) Le nombre de serveurs actifs répertoriés dans ServerActive, ainsi que le nombre d'instances prédéfinies pour les vérifications passives spécifiées dans StartAgents, doit être inférieur à 64.
Dans Zabbix agent 2.0.0, les paramètres de configuration liés aux vérifications actives et passives ont été modifiées.
Reportez-vous à la section "Voir aussi" en bas de cette page pour obtenir plus de détails sur ces modifications.
Zabbix prend en charge les fichiers de configuration uniquement en codage UTF-8 sans BOM.
Les commentaires commençant par "#" ne sont pris en charge qu'au début de la ligne.
Voir aussi
Parameters
| Parameter | Mandatory | Range | Default | Description |
|---|---|---|---|---|
| Alias | no | Sets an alias for an item key. It can be used to substitute long and complex item key with a smaller and simpler one. Multiple Alias parameters may be present. Multiple parameters with the same Alias key are allowed. Different Alias keys may reference the same item key. Aliases can be used in HostMetadataItem but not in HostnameItem or PerfCounter parameters. Examples: 1. Retrieving paging file usage in percents from the server. Alias=pg_usage:perf_counter[\Paging File(_Total)\% Usage] Now shorthand key pg_usage may be used to retrieve data. 2. Getting CPU load with default and custom parameters. Alias=cpu.load:system.cpu.load Alias=cpu.load[*]:system.cpu.load[*] This allows use cpu.load key to get CPU utilization percentage with default parameters as well as use cpu.load[percpu,avg15] to get specific data about CPU load. 3. Running multiple low-level discovery rules processing the same discovery items. Alias=vfs.fs.discovery[*]:vfs.fs.discovery Now it is possible to set up several discovery rules using vfs.fs.discovery with different parameters for each rule, e.g., vfs.fs.discovery[foo], vfs.fs.discovery[bar], etc. |
||
| BufferSend | no | 1-3600 | 5 | Do not keep data longer than N seconds in buffer. |
| BufferSize | no | 2-65535 | 100 | Maximum number of values in a memory buffer. The agent will send all collected data to Zabbix server or proxy if the buffer is full. |
| DebugLevel | no | 0-5 | 3 | Specifies debug level: 0 - basic information about starting and stopping of Zabbix processes 1 - critical information 2 - error information 3 - warnings 4 - for debugging (produces lots of information) 5 - extended debugging (produces even more information) |
| EnableRemoteCommands | no | 0 | Whether remote commands from Zabbix server are allowed. 0 - not allowed 1 - allowed |
|
| HostMetadata | no | 0-255 characters | Optional parameter that defines host metadata. Host metadata is used only at host auto-registration process (active agent). If not defined, the value will be acquired from HostMetadataItem. An agent will issue an error and not start if the specified value is over the limit or a non-UTF-8 string. This option is supported in version 2.2.0 and higher. |
|
| HostMetadataItem | no | Optional parameter that defines a Zabbix agent item used for getting host metadata. This option is only used when HostMetadata is not defined. Supports UserParameters, performance counters and aliases. Supports system.run[] regardless of EnableRemoteCommands value. HostMetadataItem value is retrieved on each auto-registration attempt and is used only at host auto-registration process (active agent). During an auto-registration request an agent will log a warning message if the value returned by the specified item is over the limit of 255 characters. The value returned by the item must be a UTF-8 string otherwise it will be ignored. This option is supported in version 2.2.0 and higher. |
||
| Hostname | no | Set by HostnameItem | Unique, case sensitive hostname. Required for active checks and must match hostname as configured on the server. Allowed characters: alphanumeric, '.', ' ', '_' and '-'. Maximum length: 64 |
|
| HostnameItem | no | system.hostname | Optional parameter that defines a Zabbix agent item used for getting host name. This option is only used when Hostname is not defined. Does not support UserParameters, performance counters or aliases, but does support system.run[] regardless of EnableRemoteCommands value. This option is supported in version 1.8.6 and higher. See also a more detailed description. |
|
| Include | no | You may include individual files or all files in a directory in the configuration file. To only include relevant files in the specified directory, the asterisk wildcard character is supported for pattern matching. For example: /absolute/path/to/config/files/*.conf. Pattern matching is supported since Zabbix 2.4.0.See special notes about limitations. |
||
| ListenIP | no | 0.0.0.0 | List of comma-delimited IP addresses that the agent should listen on. Multiple IP addresses are supported since Zabbix 1.8.3. |
|
| ListenPort | no | 1024-32767 | 10050 | Agent will listen on this port for connections from the server. |
| LogFile | yes, if LogType is set to file, otherwise no |
C:\zabbix_agentd.log | Name of the agent log file. | |
| LogFileSize | no | 0-1024 | 1 | Maximum size of log file in MB. 0 - disable automatic log rotation. Note: If the log file size limit is reached and file rotation fails, for whatever reason, the existing log file is truncated and started anew. |
| LogType | no | file | Log output type: file - write log to file specified by LogFile parameter, system - write log Windows Event Log, console - write log to standard output. This parameter is supported since Zabbix 3.0.0. |
|
| LogRemoteCommands | no | 0 | Enable logging of executed shell commands as warnings. 0 - disabled 1 - enabled |
|
| MaxLinesPerSecond | no | 1-1000 | 20 | Maximum number of new lines the agent will send per second to Zabbix server or proxy processing 'log', 'logrt' and 'eventlog' active checks. The provided value will be overridden by the parameter 'maxlines', provided in 'log', 'logrt' or 'eventlog' item keys. Note: Zabbix will process 10 times more new lines than set in MaxLinesPerSecond to seek the required string in log items. |
| PerfCounter | no | Syntax: <parameter_name>,"<perf_counter_path>",<period> Defines new parameter <parameter_name> which is an average value for system performance counter <perf_counter_path> for the specified time period <period> (in seconds). For example, if you wish to receive average number of processor interrupts per second for last minute, you can define new parameter "interrupts" as following: PerfCounter = interrupts,"\Processor(0)\Interrupts/sec",60 Please note double quotes around performance counter path. The parameter name (interrupts) is to be used as the item key when creating an item. Samples for calculating average value will be taken every second. You may run "typeperf -qx" to get list of all performance counters available in Windows. |
||
| PerfCounterEn | no | Syntax: <parameter_name>,"<perf_counter_path>",<period> Defines new parameter <parameter_name> which is an average value for system performance counter <perf_counter_path> for the specified time period <period> (in seconds). Compared to PerfCounter, perfcounter paths must be in English. Supported only on Windows Server 2008/Vista and above. For example, if you wish to receive average number of processor interrupts per second for last minute, you can define new parameter "interrupts" as following: PerfCounterEn = interrupts,"\Processor(0)\Interrupts/sec",60 Please note double quotes around performance counter path. The parameter name (interrupts) is to be used as the item key when creating an item. Samples for calculating average value will be taken every second. You can find the list of English strings by viewing the following registry key: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Perflib\009.This parameter is supported since Zabbix 4.0.13. |
||
| RefreshActiveChecks | no | 60-3600 | 120 | How often list of active checks is refreshed, in seconds. Note that after failing to refresh active checks the next refresh will be attempted after 60 seconds. |
| Server | yes, if StartAgents is not explicitly set to 0 | List of comma delimited IP addresses, optionally in CIDR notation, or hostnames of Zabbix servers. Incoming connections will be accepted only from the hosts listed here. If IPv6 support is enabled then '127.0.0.1', '::127.0.0.1', '::ffff:127.0.0.1' are treated equally and '::/0' will allow any IPv4 or IPv6 address. '0.0.0.0/0' can be used to allow any IPv4 address. Note, that "IPv4-compatible IPv6 addresses" (0000::/96 prefix) are supported but deprecated by RFC4291. Example: Server=127.0.0.1,192.168.1.0/24,::1,2001:db8::/32,zabbix.domain Spaces are allowed. |
||
| ServerActive | no | (*) | IP:port (or hostname:port) of Zabbix server or Zabbix proxy for active checks. Multiple comma-delimited addresses can be provided to use several independent Zabbix servers in parallel. Spaces are allowed. If port is not specified, default port is used. IPv6 addresses must be enclosed in square brackets if port for that host is specified. If port is not specified, square brackets for IPv6 addresses are optional. If this parameter is not specified, active checks are disabled. |
|
| SourceIP | no | Source IP address for: - outgoing connections to Zabbix server or Zabbix proxy; - making connections while executing some items (web.page.get, net.tcp.port, etc.) |
||
| StartAgents | no | 0-63 (*) | 3 | Number of pre-forked instances of zabbix_agentd that process passive checks. If set to 0, disables passive checks and the agent will not listen on any TCP port. The upper limit used to be 16 before version 1.8.5. |
| Timeout | no | 1-30 | 3 | Spend no more than Timeout seconds on processing |
| TLSAccept | yes, if TLS certificate or PSK parameters are defined (even for unencrypted connection), otherwise no | What incoming connections to accept. Used for a passive checks. Multiple values can be specified, separated by comma: unencrypted - accept connections without encryption (default) psk - accept connections with TLS and a pre-shared key (PSK) cert - accept connections with TLS and a certificate This parameter is supported since Zabbix 3.0.0. |
||
| TLSCAFile | no | Full pathname of a file containing the top-level CA(s) certificates for peer certificate verification, used for encrypted communications between Zabbix components. This parameter is supported since Zabbix 3.0.0. |
||
| TLSCertFile | no | Full pathname of a file containing the agent certificate or certificate chain, used for encrypted communications with Zabbix components. This parameter is supported since Zabbix 3.0.0. |
||
| TLSConnect | yes, if TLS certificate or PSK parameters are defined (even for unencrypted connection), otherwise no | How the agent should connect to Zabbix server or proxy. Used for active checks. Only one value can be specified: unencrypted - connect without encryption (default) psk - connect using TLS and a pre-shared key (PSK) cert - connect using TLS and a certificate This parameter is supported since Zabbix 3.0.0. |
||
| TLSCRLFile | no | Full pathname of a file containing revoked certificates. This parameter is used for encrypted communications with Zabbix components. This parameter is supported since Zabbix 3.0.0. |
||
| TLSKeyFile | no | Full pathname of a file containing the agent private key used for encrypted communications with Zabbix components. This parameter is supported since Zabbix 3.0.0. |
||
| TLSPSKFile | no | Full pathname of a file containing the agent pre-shared key used for encrypted communications with Zabbix components. This parameter is supported since Zabbix 3.0.0. |
||
| TLSPSKIdentity | no | Pre-shared key identity string, used for encrypted communications with Zabbix server. This parameter is supported since Zabbix 3.0.0. |
||
| TLSServerCertIssuer | no | Allowed server (proxy) certificate issuer. This parameter is supported since Zabbix 3.0.0. |
||
| TLSServerCertSubject | no | Allowed server (proxy) certificate subject. This parameter is supported since Zabbix 3.0.0. |
||
| UnsafeUserParameters | no | 0-1 | 0 | Allow all characters to be passed in arguments to user-defined parameters. 0 - do not allow 1 - allow The following characters are not allowed: \ ' " ` * ? [ ] { } ~ $ ! & ; ( ) < > | # @ Additionally, newline characters are not allowed. |
| UserParameter | User-defined parameter to monitor. There can be several user-defined parameters. Format: UserParameter=<key>,<shell command> Note that shell command must not return empty string or EOL only. Example: UserParameter=system.test,echo 1 |
|||
(*) The number of active servers listed in ServerActive plus the number of pre-forked instances for passive checks specified in StartAgents must be less than 64.