配置参数:Zabbix bridge 适配器

概述

配置参数可用于自定义 Zabbix bridge adapter 的行为。

请在配置文件(zabbix_bridge_adapter.conf)中指定参数值。 除非明确说明参数为必需参数,否则所有参数均为可选参数。

本页面的结构如下:

  • 参数概览(要查看参数的完整详细信息,请点击其名称)
  • 参数详细信息
参数 描述
AllowedAPIMethods 指定可通过 bridge adapter 调用的 Zabbix API 方法。
DataDir 指定用于创建和存储 bridge adapter 状态文件及加密密钥的目录。
DebugLevel 设置调试级别。
Include 指定要包含在配置文件中的目录或单个文件。
ListenHealthPort 指定用于监听传入 HTTP 健康检查连接的端口。
ListenIP 指定用于监听来自 Zabbix 服务器的传入 HTTP(S) 连接的 IP 地址或主机名。
ListenPort 指定用于监听来自 Zabbix 服务器的传入 HTTP(S) 连接的端口。
LogFile 指定 bridge adapter 日志文件。
LogFileSize 设置日志文件的最大大小(以 MB 为单位)。
LogType 指定日志输出类型。
PidFile 指定 PID 文件。
ServerId 指定 Zabbix 服务器的唯一标识符。必需。
TLSConfig.AllowedCN 指定允许的客户端通用名称列表,各名称之间以逗号分隔(仅适用于 mTLS)。
TLSConfig.CAFile 指定包含用于在 mTLS 模式下验证客户端证书的顶级 CA 证书的文件的完整路径。
TLSConfig.CertFile 指定包含证书或证书链的文件的完整路径。
TLSConfig.KeyFile 指定包含私钥的文件的完整路径。
TLSConfig.Mode 设置 ListenPort 上传入连接的 TLS 模式。
ZabbixAPITLSCAFile 指定包含顶级 CA 证书的文件的完整路径,bridge adapter 使用这些证书验证 Zabbix API 证书。
ZabbixAPITLSConnect 设置连接到 Zabbix API 的出站连接的 TLS 模式。
ZabbixAPIURL 指定 Zabbix API 端点的 URL。必需。
ZabbixBridgeURL 指定用于获取 Zabbix Bridge 配置的 Zabbix Bridge URL(在 bridge adapter 启动时获取)。

请注意:

  • 默认值反映的是进程默认值,而不是随附配置文件中的值。
  • 值支持环境变量。
  • Zabbix 仅支持使用 UTF-8 编码且不带 BOM 的配置文件。
  • 以 # 开头的注释仅支持出现在行首。

参数详细信息

AllowedAPIMethods

指定可通过 bridge adapter 调用的 Zabbix API 方法。
对于多个方法,请重复此参数,每行指定一个方法。

每个参数值必须是精确的方法名称(例如 problem.get),或仅替换完整 API 名称的通配符模式(例如 *.get),或仅替换完整方法名称的通配符模式(例如 problem.*)。

任何其他值均无效,并会阻止 bridge adapter 启动。 这包括单独的通配符(*)、部分通配符模式(host* 或 host*.*)以及空值(AllowedAPIMethods=)。

示例:

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

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

默认值:未设置(拒绝所有 Zabbix API 方法)

DataDir

指定创建和存储 bridge adapter 状态文件及加密密钥的目录。
该目录必须存在并具有 0700 权限,其中存储的所有文件必须具有 0600 权限。

默认值:/var/lib/zabbix-bridge-adapter

DebugLevel

设置调试级别:

  • 0 - 有关 Zabbix 进程启动和停止的基本信息
  • 1 - 关键​​信息
  • 2 - 错误信息
  • 3 - 警告
  • 4 - 用于调试(生成大量信息)
  • 5 - 扩展调试(生成更多信息)

默认值:3
范围:0-5

Include

指定要包含在配置文件中的目录或单个文件。
安装 Zabbix 时,此参数设置为 /etc/zabbix,除非您在编译时更改了该设置。

Include 参数的一般规则:

  • 路径可以是相对于 zabbix_bridge_adapter.conf 文件所在位置的相对路径。
  • 可以在一个配置文件中指定多个 Include 参数。
  • Zabbix 在读取 Include 参数后会立即对其进行处理,因此请考虑将其放置在配置文件末尾。

所包含文件的规则:

  • 每个文件都必须可读。
  • 每个文件都必须具有正确的语法。否则,组件将无法启动。

包含目录或文件模式的规则:

  • 不要假定包含顺序(例如,文件不会按字母顺序包含)。
  • 不要在多个所包含文件中定义相同的参数(例如,使用特定设置覆盖常规设置),因为无法预测将使用哪个值。
  • 注意某些文本编辑器会自动创建的备份副本(例如,编辑 include/my_specific.conf 可能会创建 include/my_specific.conf.BAK),因为这两个文件都会被包含。

若要仅包含目录中的相关文件,请使用通配符 (*) 进行模式匹配。

示例:

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

指定用于监听传入 HTTP 健康检查连接的端口。
提供 /health 和 /ready 端点。
如果未指定,则不会启动健康服务。

默认值:8081
范围:1024-32767

ListenIP

指定用于监听来自 Zabbix 服务器的传入 HTTP(S) 连接的 IP 地址或主机名。
如果未指定,bridge 适配器将监听本地系统上的所有可用 IP 地址。

ListenPort

指定用于监听来自 Zabbix 服务器的传入 HTTP(S) 连接的端口。

默认值:10054
范围:1024-32767

LogFile

指定 bridge adapter 日志文件。

当 LogType 设置为 file 时为必填:是;否则为否

默认值:/tmp/zabbix_bridge_adapter.log

LogFileSize

设置日志文件的最大大小(以 MB 为单位)。
0 - 禁用自动日志轮换。

默认值:1
范围:0-1024

LogType

指定日志输出类型:

  • file - 将日志写入由 LogFile 参数指定的文件。
  • system - 将日志写入 syslog。
  • console - 将日志写入标准输出。

默认值:file

PidFile

指定 PID 文件。

默认值:/tmp/zabbix_bridge_adapter.pid

ServerId

指定 Zabbix 服务器的唯一标识符。
可在 Zabbix 前端的 报表 > 系统信息 中查看。

必填:是

TLSConfig.AllowedCN

指定允许的客户端通用名称列表,名称之间以逗号分隔(仅适用于 mTLS)。
如果未指定,bridge 适配器不会检查客户端通用名称。

TLSConfig.CAFile

指定包含顶级 CA 证书的文件的完整路径,用于在 mTLS 模式下验证客户端证书。

TLSConfig.CertFile

指定包含证书或证书链的文件的完整路径。

TLSConfig.KeyFile

指定包含私钥的文件的完整路径。

TLSConfig.Mode

设置 ListenPort 上传入连接的 TLS 模式:

  • none - 接受未加密的连接。
  • tls - 使用最低版本为 v1.2 的标准 TLS。
  • mtls - 在 TLS 的基础上扩展双向身份验证。

默认值:none

另请参阅:从 Zabbix 服务器到 Zabbix bridge adapter 的 TLS

ZabbixAPITLSCAFile

指定包含顶级 CA 证书的文件的完整路径名,bridge adapter 使用这些证书验证 Zabbix API 证书。

必填:如果 ZabbixAPITLSConnect 设置为 verify_ca 或 verify_full,则为 是。

ZabbixAPITLSConnect

设置到 Zabbix API 的出站连接的 TLS 模式:

  • disabled - 使用普通 HTTP;ZabbixAPIURL 必须使用 http://。
  • required - 使用 HTTPS,但不验证证书(仅用于测试)。
  • verify_ca - 使用 HTTPS,并验证 Zabbix API 证书。
  • verify_full - 使用 HTTPS,并验证 Zabbix API 证书和主机名。

空值或未设置的值将按 required 处理。

默认值:required

另请参阅:从 Zabbix bridge adapter 到 Zabbix API 的 TLS

ZabbixAPIURL

指定 Zabbix API 端点的 URL。

必填:是

示例:

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

指定用于检索 Zabbix Bridge 配置的 Zabbix Bridge URL(在 bridge 适配器启动时检索)。

默认值:ZabbixBridgeURL=https://config.mobilebridge.zabbix.com/.well-known/bridge-configuration