Parámetros de configuración: adaptador de puente de Zabbix

Descripción general

Los parámetros de configuración permiten personalizar el comportamiento del adaptador de Zabbix Bridge.

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

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

  • Descripción general de los parámetros (para consultar todos los detalles de un parámetro, haga clic en su nombre)
  • Detalles de los parámetros
Parámetro Descripción
AllowedAPIMethods Especifique qué métodos de la API de Zabbix se pueden llamar a través del adaptador de Bridge.
DataDir Especifique el directorio donde se crean y almacenan el archivo de estado del adaptador de Bridge y las claves de cifrado.
DebugLevel Establezca el nivel de depuración.
Include Especifique un directorio o archivos individuales que se incluirán en el archivo de configuración.
ListenHealthPort Especifique el puerto en el que se escucharán las conexiones HTTP entrantes de comprobación del estado.
ListenIP Especifique la dirección IP o el nombre de host en el que se escucharán las conexiones HTTP(S) entrantes del server de Zabbix.
ListenPort Especifique el puerto en el que se escucharán las conexiones HTTP(S) entrantes del server de Zabbix.
LogFile Especifique el archivo de registro del adaptador de Bridge.
LogFileSize Establezca el tamaño máximo del archivo de registro (en MB).
LogType Especifique el tipo de salida del registro.
PidFile Especifique el archivo PID.
ServerId Especifique el identificador único del server de Zabbix. Obligatorio.
TLSConfig.AllowedCN Especifique una lista separada por comas de nombres comunes de cliente permitidos (solo mTLS).
TLSConfig.CAFile Especifique la ruta completa a un archivo que contenga los certificados de CA de nivel superior utilizados para verificar los certificados de cliente en el modo mTLS.
TLSConfig.CertFile Especifique la ruta completa a un archivo que contenga el certificado o la cadena de certificados.
TLSConfig.KeyFile Especifique la ruta completa a un archivo que contenga la clave privada.
TLSConfig.Mode Establezca el modo TLS para las conexiones entrantes en ListenPort.
ZabbixAPITLSCAFile Especifique la ruta completa a un archivo que contenga los certificados de CA de nivel superior utilizados por el adaptador de Bridge para verificar el certificado de la API de Zabbix.
ZabbixAPITLSConnect Establezca el modo TLS para las conexiones salientes a la API de Zabbix.
ZabbixAPIURL Especifique la URL del endpoint de la API de Zabbix. Obligatorio.
ZabbixBridgeURL Especifique la URL de Zabbix Bridge para recuperar la configuración de Zabbix Bridge (se recupera cuando se inicia el adaptador de Bridge).

Tenga en cuenta lo siguiente:

  • Los valores predeterminados reflejan los valores predeterminados del proceso, no los valores de los archivos de configuración incluidos.
  • Los valores admiten variables de entorno.
  • Zabbix admite archivos de configuración únicamente con codificación UTF-8 y sin BOM.
  • Los comentarios que comienzan con # solo se admiten al principio de la línea.

Detalles de los parámetros

AllowedAPIMethods

Especifique qué métodos de la API de Zabbix se pueden llamar a través del adaptador bridge.
Para varios métodos, repita el parámetro, un método por línea.

Cada valor del parámetro debe ser un nombre de método exacto (por ejemplo, problem.get) o un patrón comodín que sustituya únicamente el nombre completo de la API (por ejemplo, *.get) o el nombre completo del método (por ejemplo, problem.*).

Cualquier otro valor no es válido e impide que se inicie el adaptador bridge. Esto incluye un comodín independiente (*), un patrón comodín parcial (host* o host*.*) o un valor vacío (AllowedAPIMethods=).

Ejemplo:

AllowedAPIMethods=apiinfo.version
AllowedAPIMethods=problem.*
AllowedAPIMethods=*.get

El conjunto mínimo de métodos que requiere la aplicación móvil de Zabbix:

AllowedAPIMethods=apiinfo.version
AllowedAPIMethods=device.onboard
AllowedAPIMethods=device.offboard
AllowedAPIMethods=user.get
AllowedAPIMethods=role.get
AllowedAPIMethods=problem.get
AllowedAPIMethods=event.get
AllowedAPIMethods=event.acknowledge
AllowedAPIMethods=trigger.get
AllowedAPIMethods=alert.get
AllowedAPIMethods=host.get
AllowedAPIMethods=hostgroup.get

Predeterminado: no establecido (todos los métodos de la API de Zabbix están denegados)

DataDir

Especifique el directorio donde se crean y almacenan el archivo de estado del adaptador bridge y las claves de cifrado.
El directorio debe existir y tener permisos 0700, y todos los archivos almacenados en él deben tener permisos 0600.

Valor predeterminado: /var/lib/zabbix-bridge-adapter

DebugLevel

Establece 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 sobre errores
  • 3 - advertencias
  • 4 - para la depuración (genera mucha información)
  • 5 - depuración ampliada (genera aún más información)

Predeterminado: 3
Rango: 0-5

Incluir

Especifique un directorio o archivos individuales que se incluirán en el archivo de configuración.
Durante la instalación de Zabbix, este parámetro se establece en /etc/zabbix, a menos que lo cambie durante la compilación.

Reglas generales para el parámetro Include:

  • La ruta puede ser relativa a la ubicación del archivo zabbix_bridge_adapter.conf.
  • Puede especificar varios parámetros Include en un mismo archivo de configuración.
  • Zabbix procesa el parámetro Include en cuanto lo lee, por lo que se recomienda colocarlo al final del archivo de configuración.

Reglas para los archivos incluidos:

  • Cada archivo debe ser legible.
  • Cada archivo debe tener una sintaxis correcta. De lo contrario, el componente no se iniciará.

Reglas para incluir directorios o patrones de archivos:

  • No dé por supuesto ningún orden de inclusión (por ejemplo, los archivos no se incluyen en orden alfabético).
  • No defina el mismo parámetro en más de un archivo incluido (por ejemplo, para sobrescribir una configuración general con una específica), ya que no puede predecir qué valor se utilizará.
  • Preste atención a las copias de seguridad que algunos editores de texto crean automáticamente (por ejemplo, al editar include/my_specific.conf se puede crear include/my_specific.conf.BAK), ya que ambos archivos se incluirán.

Para incluir únicamente los archivos relevantes de un directorio, utilice el comodín (*) para la coincidencia de patrones.

Ejemplo:

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

Especifique el puerto en el que se escucharán las conexiones entrantes de comprobación de estado HTTP.
Proporciona los endpoints /health y /ready.
Si no se especifica, el servicio de estado no se inicia.

Valor predeterminado: 8081
Rango: 1024-32767

ListenIP

Especifique la dirección IP o el nombre de host en el que se escucharán las conexiones HTTP(S) entrantes del Zabbix server.
Si no se especifica, el adaptador bridge escucha en todas las direcciones IP disponibles del sistema local.

ListenPort

Especifique el puerto en el que se escucharán las conexiones HTTP(S) entrantes del Zabbix server.

Valor predeterminado: 10054
Rango: 1024-32767

LogFile

Especifique el archivo de registro del bridge adapter.

Obligatorio: Sí si LogType está establecido en file; de lo contrario, no

Valor predeterminado: /tmp/zabbix_bridge_adapter.log

LogFileSize

Establece el tamaño máximo del archivo de registro (en MB).
0 - deshabilita la rotación automática de registros.

Valor 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.
  • system: escribe el registro en syslog.
  • console: escribe el registro en la salida estándar.

Valor predeterminado: file

PidFile

Especifique el archivo PID.

Predeterminado: /tmp/zabbix_bridge_adapter.pid

ServerId

Especifique el identificador único del server de Zabbix.
Disponible en Reports > System information en el web frontend de Zabbix.

Obligatorio: Sí

TLSConfig.AllowedCN

Especifique una lista separada por comas de los nombres comunes de cliente permitidos (solo mTLS).
Si no se especifica, el adaptador bridge no comprueba el nombre común del cliente.

TLSConfig.CAFile

Especifique la ruta completa a un archivo que contenga el/los certificado(s) de CA de nivel superior utilizados para verificar los certificados de cliente en el modo mTLS.

TLSConfig.CertFile

Especifique la ruta completa a un archivo que contenga el certificado o la cadena de certificados.

TLSConfig.KeyFile

Especifique la ruta completa a un archivo que contenga la clave privada.

TLSConfig.Mode

Establece el modo TLS para las conexiones entrantes en ListenPort:

  • none: acepta conexiones sin cifrado.
  • tls: TLS estándar con v1.2 como versión mínima.
  • mtls: amplía TLS con autenticación mutua.

Valor predeterminado: none

Véase también: TLS desde Zabbix server hasta el adaptador de puente de Zabbix

ZabbixAPITLSCAFile

Especifique la ruta completa de un archivo que contenga el/los certificado(s) de CA de nivel superior utilizados por el adaptador puente para verificar el certificado de la API de Zabbix.

Obligatorio: Sí si ZabbixAPITLSConnect está establecido en verify_ca o verify_full.

ZabbixAPITLSConnect

Establece el modo TLS para las conexiones salientes a la API de Zabbix:

  • disabled: usa HTTP sin cifrado; ZabbixAPIURL debe usar http://.
  • required: usa HTTPS sin verificar el certificado (solo para pruebas).
  • verify_ca: usa HTTPS y verifica el certificado de la API de Zabbix.
  • verify_full: usa HTTPS y verifica el certificado y el nombre de host de la API de Zabbix.

Un valor vacío o no establecido se trata como required.

Valor predeterminado: required

Véase también: TLS desde el adaptador de puente de Zabbix hasta la API de Zabbix

ZabbixAPIURL

Especifique la URL del endpoint de la API de Zabbix.

Obligatorio: Sí

Ejemplo:

ZabbixAPIURL=https://example.com/zabbix/api_jsonrpc.php
ZabbixBridgeURL

Especifique la URL de Zabbix Bridge para recuperar la configuración de Zabbix Bridge (se recupera cuando se inicia el adaptador de bridge).

Valor predeterminado: ZabbixBridgeURL=https://config.mobilebridge.zabbix.com/.well-known/bridge-configuration