Parámetros de configuración: Zabbix agent 2 (Windows)

Descripción general

Los parámetros de configuración permiten personalizar el comportamiento de Zabbix agent 2 en Windows.

Especifique los valores de los parámetros en el archivo de configuración (zabbix_agent2.win.conf). Todos los parámetros son opcionales, salvo que se indique explícitamente que el parámetro es obligatorio.

Esta página está estructurada de la siguiente manera:

• Resumen de parámetros (para ver los detalles completos de un parámetro, haga clic en su nombre)
• Detalles de los parámetros

Tenga en cuenta que:

• Los valores predeterminados reflejan los valores predeterminados del proceso, no los valores de los archivos de configuración suministrados;
• Los valores admiten variables de entorno;
• Zabbix solo admite archivos de configuración en codificación UTF-8 sin BOM;
• Los comentarios que comienzan con "#" solo se admiten al inicio de la línea.

Detalles del parámetro

Alias

Establezca un alias para una clave de item. Puede usarse para sustituir una clave de item larga y compleja por una más corta y sencilla.
Pueden estar presentes varios parámetros Alias. No se permiten varios parámetros con la misma clave Alias.
Distintas claves Alias pueden hacer referencia a la misma clave de item.
Los alias pueden usarse en HostMetadataItem, pero no en el parámetro HostnameItem.

Ejemplo 1: Recuperar el uso del archivo de paginación en porcentaje desde el server.

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

Ahora se puede usar la clave abreviada pg_usage para recuperar datos.

Ejemplo 2: Obtener la carga de CPU con parámetros predeterminados y personalizados.

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

Esto permite usar la clave cpu.load para obtener la carga de CPU con parámetros predeterminados, así como usar cpu.load[percpu,avg15] para obtener datos específicos sobre la carga de CPU.

Ejemplo 3: Ejecutar varias reglas de descubrimiento de bajo nivel procesando los mismos elementos descubiertos.

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

Ahora es posible configurar varias reglas de descubrimiento usando vfs.fs.discovery con diferentes parámetros para cada regla, por ejemplo, vfs.fs.discovery[foo], vfs.fs.discovery[bar], etc.

AllowKey

Permite la ejecución de aquellas claves de item que coincidan con un patrón. El patrón de clave es una expresión comodín que admite el carácter "*" para coincidir con cualquier número de caracteres.
Se pueden definir varias reglas de coincidencia de claves en combinación con DenyKey. Los parámetros se procesan uno por uno según el orden en que aparecen. Consulte también: Restricting agent checks.

BufferSend

Establece la frecuencia de envío de valores desde el buffer al Zabbix server/proxy (en segundos).
Tenga en cuenta que, si el buffer está lleno, los datos se enviarán antes.

Predeterminado: 5
Rango: 1-3600

BufferSize

Establece el número máximo de valores en el búfer de memoria.
El agent enviará todos los datos recopilados al server o proxy de Zabbix si el búfer está lleno.
Este parámetro solo debe usarse si el búfer persistente está deshabilitado (EnablePersistentBuffer=0).

Predeterminado: 1000
Rango: 2-65535

ControlSocket

Especifique el socket de control, utilizado para enviar comandos en tiempo de ejecución con la opción '-R'.

Predeterminado: \\.\pipe\agent.sock

DebugLevel

Establezca el nivel de depuración:
0 - información básica sobre el inicio y la detención de los procesos de Zabbix
1 - información crítica;
2 - información de error;
3 - advertencias;
4 - para depuración (genera mucha información);
5 - depuración extendida (genera aún más información).

Predeterminado: 3
Rango: 0-5

DenyKey

Deniega la ejecución de aquellas claves de item que coincidan con un patrón. El patrón de clave es una expresión comodín que admite el carácter "*" para coincidir con cualquier número de caracteres.
Se pueden definir varias reglas de coincidencia de claves en combinación con AllowKey. Los parámetros se procesan uno por uno según su orden de aparición. Véase también: Restricting agent checks.

EnablePersistentBuffer

Habilita el uso de almacenamiento persistente local para los items activos. Si el almacenamiento persistente está deshabilitado, se usará el búfer de memoria.

Predeterminado: 0
Valores: 0 - deshabilitado, 1 - habilitado

ForceActiveChecksOnStart

Realiza comprobaciones activas inmediatamente después del reinicio para la primera configuración recibida. También está disponible como un parámetro de configuración por plugin, por ejemplo: Plugins.Uptime.System.ForceActiveChecksOnStart=1

Predeterminado: 0
Valores: 0 - deshabilitado, 1 - habilitado

HeartbeatFrequency

Establece la frecuencia de los mensajes de heartbeat en segundos. Se utiliza para supervisar la disponibilidad de las comprobaciones activas.
0 - mensajes de heartbeat deshabilitados.

Predeterminado: 60
Rango: 0-3600

HostInterface

Especifique la interfaz del host (dirección IP o nombre DNS) utilizada durante el autoregistro del host. Este valor se utilizará para rellenar la interfaz en el host recién creado y permite configurar explícitamente una dirección IP o DNS. Para más detalles, consulte Uso de DNS como interfaz predeterminada.

Si no se define, el valor se obtendrá de HostInterfaceItem.

El agent mostrará un error y no se iniciará si el valor supera el límite de 255 caracteres.

Rango: 0-255 caracteres

HostInterfaceItem

Especifique un item para determinar la interfaz del host (dirección IP o nombre DNS) durante el autoregistro del host. Este valor se usa solo si HostInterface no está definido. Para más detalles, consulte Uso de DNS como interfaz predeterminada.

Durante una solicitud de autoregistro, el agent registrará un mensaje de advertencia si el valor devuelto por el item especificado supera el límite de 255 caracteres.

El item system.run[] es compatible independientemente de la configuración de AllowKey/DenyKey.

HostMetadata

Especifique los metadatos utilizados para identificar o distinguir el host durante el autoregistro del host (agent activo). HostMetadata permite distinguir entre hosts más allá del nombre de host.

Si no se define, el valor se obtendrá de HostMetadataItem.

El agent generará un error y no se iniciará si el valor especificado supera el límite de 2034 bytes o si es una cadena que no está en UTF-8. Cuando un parámetro espera una dirección IP o un nombre DNS, también se rechazarán y se informarán como inválidos los valores que sean UTF-8 válidos pero no sean IP ni nombres DNS válidos.

No se admite metadata de varias líneas: la salida se truncará en el primer salto de línea.

Rango: 0-2034 bytes

HostMetadataItem

Especifique un item de Zabbix agent para obtener metadatos del host. Esta opción solo se utiliza cuando HostMetadata no está definido.

El valor de HostMetadataItem se recupera en cada intento de autoregistration y solo se usa en el proceso de autoregistration del host (active agent). HostMetadataItem permite distinguir entre hosts más allá del hostname.

Se admiten parámetros de usuario y alias. Se admite el item system.run[] independientemente de la configuración AllowKey/DenyKey.

Durante una solicitud de autoregistration, el agent registrará un mensaje de advertencia si el valor devuelto por el item especificado supera el límite de 65535 puntos de código UTF-8. El valor devuelto por el item debe ser una cadena UTF-8; de lo contrario, se ignorará. Cuando un parámetro espera una dirección IP o un nombre DNS, los valores que sean UTF-8 válidos pero no sean IP ni nombres DNS válidos también se rechazarán y se informarán como no válidos.

No se admite metadatos de varias líneas: la salida se truncará en el primer salto de línea.

Nombre de host

Especifique nombres de host únicos y sensibles a mayúsculas y minúsculas. Una lista delimitada por comas.
Requerido para comprobaciones activas y debe coincidir con los nombres de host configurados en el server. El valor se obtiene de HostnameItem si no está definido.
Caracteres permitidos: alfanuméricos, '.', ' ', '_' y '-'. Longitud máxima: 128 caracteres por nombre de host, 2048 caracteres para toda la línea.

Predeterminado: establecido por HostnameItem

HostnameItem

Especifique un item para obtener el nombre de host. Esta opción solo se usa cuando Hostname no está definido. No se admiten parámetros de usuario ni alias, pero el item system.run[] es compatible independientemente de los valores de AllowKey/DenyKey.

Predeterminado: system.hostname

Incluir

Especifique un directorio o archivos individuales para incluir en el archivo de configuración (ubicado en C:\Program Files\Zabbix Agent 2 de forma predeterminada si Zabbix agent se instala mediante los paquetes del instalador MSI de Windows; ubicado en la carpeta especificada durante la instalación si Zabbix agent se instala como un archivo zip). Todos los archivos incluidos deben tener una sintaxis correcta; de lo contrario, el agent no se iniciará. La ruta puede ser relativa a la ubicación del archivo zabbix_agent2.conf (por ejemplo, Include=.\zabbix_agent2.d\plugins.d\*.conf).
Para incluir solo los archivos relevantes en el directorio especificado, se admite el carácter comodín asterisco para la coincidencia de patrones.
Consulte las notas especiales sobre las limitaciones.

Ejemplo:

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

ListenIP

Especifique la dirección IP de escucha del agent para conexiones desde el server/proxy. Una lista delimitada por comas.
La primera dirección IP se envía al server de Zabbix, si se conecta a él, para recuperar la lista de comprobaciones activas.

Predeterminado: 0.0.0.0

ListenPort

Especifique el puerto de escucha del agent para conexiones desde el server/proxy.

Predeterminado: 10050
Rango: 1024-32767

LogFile

Especifique el archivo de registro del agent.

Predeterminado: c:\zabbix_agent2.log
Obligatorio: Sí, si LogType está establecido en file; de lo contrario, no

LogFileSize

Establece el tamaño máximo del archivo de registro (en MB).
0 - deshabilita la rotación automática de registros.
Nota: Si se alcanza el límite de tamaño del archivo de registro y la rotación del archivo falla, por cualquier motivo, el archivo de registro existente se trunca y se inicia uno nuevo.

Predeterminado: 1
Rango: 0-1024

LogType

Especifique el tipo de salida del registro:
file - escribe el registro en el archivo especificado por el parámetro LogFile;
console - escribe el registro en la salida estándar.

Predeterminado: file

PerfCounter

Defina un nuevo parámetro <parameter_name> que sea el valor promedio del contador de rendimiento del sistema <perf_counter_path> para el período de tiempo especificado <period> (en segundos).
Sintaxis: <parameter_name>,"<perf_counter_path>",<period>

Por ejemplo, si desea recibir el número promedio de interrupciones del procesador por segundo durante el último minuto, puede definir un nuevo parámetro "interrupts" de la siguiente manera:

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

Tenga en cuenta las comillas dobles alrededor de la ruta del contador de rendimiento. El nombre del parámetro (interrupts) se usará como la clave del item al crear un item. Las muestras para calcular el valor promedio se tomarán cada segundo.
Puede ejecutar "typeperf -qx" para obtener la lista de todos los contadores de rendimiento disponibles en Windows.

PerfCounterEn

Defina un nuevo parámetro <parameter_name> que sea el valor promedio del contador de rendimiento del sistema <perf_counter_path> para el período de tiempo especificado <period> (en segundos). En comparación con PerfCounter, las rutas de perfcounter deben estar en inglés. Solo es compatible con Windows Server 2008/Vista y versiones posteriores.
Sintaxis: <parameter_name>,"<perf_counter_path>",<period>

Por ejemplo, si desea recibir el número promedio de interrupciones del procesador por segundo durante el último minuto, puede definir un nuevo parámetro "interrupts" de la siguiente manera:

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

Tenga en cuenta las comillas dobles alrededor de la ruta del contador de rendimiento. El nombre del parámetro (interrupts) se utilizará como la clave del item al crear un item. Las muestras para calcular el valor promedio se tomarán cada segundo.
Puede encontrar la lista de cadenas en inglés consultando la siguiente clave del registro: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Perflib\009.

PersistentBufferFile

Especifique el archivo donde Zabbix agent 2 debe guardar la base de datos SQLite. Debe ser un nombre de archivo completo. Este parámetro solo se usa si el búfer persistente está habilitado (EnablePersistentBuffer=1).

PersistentBufferPeriod

Establece la duración del almacenamiento de datos cuando no hay conexión con el server o proxy. Los datos más antiguos se perderán. Los datos de registro se conservarán. Este parámetro solo se usa si el búfer persistente está habilitado (EnablePersistentBuffer=1).

Predeterminado: 1h
Rango: 1m-365d

Plugins.<PluginName>.System.Capacity

Establece el límite de comprobaciones por plugin <PluginName> que pueden ejecutarse al mismo tiempo.

Predeterminado: 1000 Rango: 1-1000

Plugins.Log.MaxLinesPerSecond

Establece el número máximo de nuevas líneas que el agent enviará por segundo al server o proxy de Zabbix al procesar comprobaciones activas log, logrt y eventlog. El valor proporcionado se sobrescribirá con el parámetro 'maxlines', especificado en la clave de item 'log', 'logrt' o 'eventlog'.
Nota: Zabbix procesará 10 veces más nuevas líneas que las establecidas en MaxLinesPerSecond para buscar la cadena requerida en los items de log.

Predeterminado: 20
Rango: 1-1000

Plugins.SystemRun.LogRemoteCommands

Habilita el registro de los comandos de shell ejecutados como advertencias. Los comandos se registrarán solo si se ejecutan de forma remota. No se crearán entradas de registro si system.run[] se inicia localmente mediante los parámetros HostMetadataItem, HostInterfaceItem o HostnameItem.

Predeterminado: 0
Valores: 0 - deshabilitado, 1 - habilitado

PluginSocket

Especifique la ruta de la canalización con nombre de Windows para las comunicaciones del plugin cargable.

Predeterminado: \\.\pipe\agent.plugin.sock

PluginTimeout

Establece el tiempo de espera para las conexiones con plugins cargables, en segundos.

Predeterminado: Timeout
Rango: 1-30

RefreshActiveChecks

Especifique la frecuencia de actualización de la lista de comprobaciones activas, en segundos.
Tenga en cuenta que, si falla la actualización de las comprobaciones activas, el siguiente intento se realizará en 60 segundos.

Predeterminado: 5
Rango: 1-86400

Server

Especifique las direcciones IP, opcionalmente en notación CIDR, o los nombres DNS de los servers/proxies de Zabbix. Una lista delimitada por comas.
Las conexiones entrantes solo se aceptarán desde los hosts enumerados aquí. Si el soporte IPv6 está habilitado, entonces '127.0.0.1', '::127.0.0.1', '::ffff:127.0.0.1' se tratan por igual y '::/0' permitirá cualquier dirección IPv4 o IPv6. '0.0.0.0/0' puede usarse para permitir cualquier dirección IPv4. Se permiten espacios. Si este parámetro no se especifica, se deshabilitan las comprobaciones pasivas y el agent no escuchará en ningún puerto TCP.

Ejemplo:

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

ServerActive

Especifique la dirección del server/proxy de Zabbix o la configuración del clúster para obtener active checks.
La dirección del server/proxy es una dirección IP o un nombre DNS, y un puerto opcional separado por dos puntos.
La configuración del clúster es una o más direcciones de miembros de un grupo de server o proxy separadas por punto y coma. Se pueden especificar varios Zabbix servers/clusters y Zabbix proxies, separados por coma. A menos que se utilicen grupos de proxy, no se debe especificar más de un Zabbix proxy para cada Zabbix server/cluster. Si se especifica un Zabbix proxy, entonces no se debe especificar el Zabbix server/cluster para ese proxy.
Se pueden proporcionar varias direcciones separadas por comas para usar varios Zabbix servers independientes en paralelo. Se permiten espacios.
Si no se especifica el puerto, se usa el puerto predeterminado.
Las direcciones IPv6 deben ir entre corchetes si se especifica el puerto para ese host. Si no se especifica el puerto, los corchetes para direcciones IPv6 son opcionales.
Si no se especifica este parámetro, los active checks se deshabilitan.

Ejemplo para Zabbix proxy:

ServerActive=127.0.0.1:10051

Ejemplo para grupo de Zabbix proxy:

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

Ejemplo para varios servers:

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

Ejemplo para alta disponibilidad:

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

Ejemplo para alta disponibilidad con dos clústeres y un server:

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

SourceIP

Especifique la dirección IP de origen para:

• conexiones salientes a Zabbix server o Zabbix proxy;
• realizar conexiones al ejecutar algunos items (web.page.get, net.tcp.port, etc.).

StatusPort

Establezca el puerto en el que el agent escucha las solicitudes de estado HTTP (http://localhost:<port>/status).

Rango: 1024-32767

Tiempo de espera

Especifique cuánto tiempo esperar (en segundos) para establecer la conexión e intercambiar datos con Zabbix proxy o server.

Este parámetro define la duración de varias operaciones de comunicación, incluidas:

• esperar una respuesta del Zabbix server;
• enviar solicitudes al Zabbix server, incluidas las solicitudes de configuración de item y los datos de item en active checks;
• recuperar datos de registro mediante la supervisión de logfile o del registro de eventos de Windows;
• enviar mensajes de latido;
• duración máxima para comprobaciones vfs.*;
• servir como respaldo en escenarios en los que un server o proxy anterior a la versión 7.0 envía comprobaciones sin tiempos de espera.

Este tiempo de espera no se utilizará para aquellas comprobaciones de agent que tienen configuraciones de tiempo de espera ajustables en el frontend (a nivel global, de proxy o por item).

Predeterminado: 3
Rango: 1-30

TLSAccept

Especifique el nivel de cifrado requerido para las conexiones entrantes.
Se utiliza para comprobaciones pasivas.
Se pueden especificar varios valores, separados por comas:
unencrypted - aceptar conexiones sin cifrado (predeterminado)
psk - aceptar conexiones con TLS y una clave precompartida (PSK)
cert - aceptar conexiones con TLS y un certificado

Obligatorio: sí, si se definen parámetros de certificado TLS o PSK (incluso para una conexión unencrypted); en caso contrario, no

TLSCAFile

Especifique la ruta completa del archivo que contiene los certificados de la CA de nivel superior para la verificación del certificado del par, utilizados para las comunicaciones cifradas entre los componentes de Zabbix.

TLSCertFile

Especifique la ruta completa del archivo que contiene el certificado del agent o la cadena de certificados, utilizado para comunicaciones cifradas con los componentes de Zabbix.

TLSCipherAll13

Especifique la cadena de cifrado de OpenSSL (TLS 1.3). Anule los criterios de selección predeterminados de la suite de cifrado para el cifrado basado en certificados y PSK.

Ejemplo:

TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256

TLSCipherCert13

Especifique la cadena de cifrado de OpenSSL (TLS 1.3). Anule los criterios de selección predeterminados de la suite de cifrado para el cifrado basado en certificados.

Tenga en cuenta que este parámetro no se puede usar junto con TLSAccept=cert,psk; para la conexión mediante certificado (TLSConnect=cert), use en su lugar TLSCipherAll13.

TLSCipherPSK13

Especifique la cadena de cifrado de OpenSSL (TLS 1.3). Anule los criterios de selección predeterminados del conjunto de cifrado para el cifrado basado en PSK.

Ejemplo:

TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256

TLSConnect

Especifique el nivel de cifrado requerido para las conexiones del agent a Zabbix server o proxy.
Se usa para comprobaciones activas.
Solo se puede especificar un valor:
unencrypted - conectar sin cifrado (predeterminado)
psk - conectar usando TLS y una clave precompartida (PSK)
cert - conectar usando TLS y un certificado

Obligatorio: sí, si se definen parámetros de certificado TLS o PSK (incluso para una conexión unencrypted); de lo contrario, no

TLSCRLFile

Especifique la ruta completa del archivo que contiene los certificados revocados. Este parámetro se utiliza para las comunicaciones cifradas entre los componentes de Zabbix.

TLSKeyFile

Especifique la ruta completa del archivo que contiene la clave privada del agent, utilizada para las comunicaciones cifradas entre los componentes de Zabbix.

TLSPSKFile

Especifique la ruta completa del archivo que contiene la clave precompartida del agent, utilizada para las comunicaciones cifradas con el server de Zabbix.

TLSPSKIdentity

Especifique la cadena de identidad de la clave precompartida, utilizada para las comunicaciones cifradas con Zabbix server.

TLSServerCertIssuer

Especifique el emisor del certificado del server (proxy) permitido.

TLSServerCertSubject

Especifica el subject del certificado del server permitido (proxy).

UnsafeUserParameters

Permite que todos los caracteres se pasen como argumentos a parámetros definidos por el usuario. Los siguientes caracteres no están permitidos: \ ' " ` * ? [ ] { } \~ $ ! & ; ( ) < > | # @ %
Además, no se permiten caracteres de nueva línea.

Predeterminado: 0
Valores: 0 - no permitir, 1 - permitir

UserParameter

Especifique un parámetro definido por el usuario para supervisar. Puede haber varios parámetros definidos por el usuario.
Formato: UserParameter=<key>,<shell command>
Tenga en cuenta que el comando de shell no debe devolver una cadena vacía ni solo EOL. Los comandos de shell pueden tener rutas relativas si se especifica el parámetro UserParameterDir.

Ejemplo:

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

UserParameterDir

Especifique la ruta de búsqueda predeterminada para los comandos UserParameter. Si se utiliza, el agent cambiará su directorio de trabajo al especificado aquí antes de ejecutar un comando. De este modo, los comandos UserParameter pueden usar un prefijo relativo .\ en lugar de una ruta completa.
Solo se permite una entrada.

Ejemplo:

UserParameterDir=C:\opt\myscripts