配置参数:Zabbix bridge 适配器
概述
配置参数可用于自定义 Zabbix bridge adapter 的行为。
在配置文件(zabbix_bridge_adapter.conf)中指定参数值。
除非明确说明参数为必需参数,否则所有参数均为可选参数。
本页面的结构如下:
- 参数概览(要查看参数的完整详细信息,请单击参数名称)
- 参数详细信息
| 参数 | 描述 |
|---|---|
| AllowedAPIMethods | 指定可通过 Zabbix bridge adapter 调用的 Zabbix API 方法。 |
| DataDir | 指定创建和存储 bridge adapter 状态文件及加密密钥的目录。 |
| DebugLevel | 设置调试级别。 |
| Include | 指定要包含在配置文件中的目录或单个文件。 |
| ListenIP | 指定 bridge adapter 监听来自 Zabbix 服务器的 HTTP[S] 连接时使用的 IP 地址。 |
| ListenHealthPort | 指定 bridge adapter 监听传入 HTTP 健康检查连接时使用的端口。 |
| ListenPort | 指定 bridge adapter 监听来自 Zabbix 服务器的 HTTP[S] 连接时使用的端口。 |
| LogFile | 指定 bridge adapter 日志文件的完整路径。 |
| LogFileSize | 设置日志文件的最大大小(MB)。 |
| LogType | 指定日志输出类型。 |
| PidFile | 指定 PID 文件。 |
| TLSConfig.AllowedCN | 指定允许的客户端通用名称(Common Name)列表,各名称之间使用逗号分隔(仅适用于 mTLS)。 |
| TLSConfig.CAFile | 指定包含用于在 mTLS 模式下验证客户端证书的顶级 CA 证书的文件的完整路径。 |
| TLSConfig.CertFile | 指定包含证书或证书链的文件的完整路径。 |
| TLSConfig.KeyFile | 指定包含私钥的文件的完整路径。 |
| TLSConfig.Mode | 设置 ListenPort 上传入连接的 TLS 模式。 |
| ServerId | 指定 Zabbix 服务器的唯一标识符。必需。 |
| ZabbixAPITLSCAFile | 指定包含顶级 CA 证书的文件的完整路径,bridge adapter 使用该证书验证 Zabbix API 证书。 |
| ZabbixAPITLSConnect | 设置连接到 Zabbix API 的出站连接的 TLS 模式。 |
| ZabbixAPIURL | 指定 Zabbix API 端点的 URL。必需。 |
| ZabbixBridgeURL | 指定用于获取 Zabbix Bridge 配置的 Zabbix Bridge URL(bridge adapter 启动时获取)。 |
请注意:
参数详细信息
AllowedAPIMethods
指定可通过 Zabbix bridge adapter 调用的 Zabbix API 方法。
对于多个方法,请重复此参数,每行指定一个方法。
每个参数值必须是精确的方法名称(例如 problem.get),或仅替换完整 API 名称(例如 *.get)或完整方法名称(例如 problem.*)的通配符模式。
任何其他值均无效,并会阻止 Zabbix 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 时,此参数默认设置为 /usr/local/etc,除非您在编译时更改了该设置。
Include 参数的一般规则:
- 路径可以是相对于
zabbix_bridge_adapter.conf文件所在位置的相对路径。 - 可以在一个配置文件中指定多个
Include参数。 - Zabbix 在读取
Include参数后会立即对其进行处理,因此请考虑将其放置在配置文件末尾。
所包含文件的规则:
- 每个文件都必须可读。
- 每个文件都必须具有正确的语法。否则,组件将无法启动。
包含目录或文件模式的规则:
- 不要假定包含顺序(例如,文件不会按字母顺序包含)。
- 不要在多个所包含文件中定义相同的参数(例如,使用特定设置覆盖常规设置),因为无法预测最终使用哪个值。
- 注意某些文本编辑器会自动创建备份副本(例如,编辑
include/my_specific.conf时可能会创建include/my_specific.conf.BAK),因为这两个文件都会被包含。
若要仅包含目录中的相关文件,请使用通配符 (*) 进行模式匹配。
示例:
Include=/absolute/path/to/config/files/*.conf
ListenIP
指定用于接收来自 Zabbix 服务器的 HTTP[S] 连接的桥接适配器监听 IP 地址。
如果未指定,桥接适配器将在所有 IP 地址上监听。
ListenHealthPort
指定用于接收传入 HTTP 健康检查连接的 bridge 适配器监听端口。
提供 /health 和 /ready 端点。
如果未指定,则不会启动健康检查服务。
默认值:8081
范围:1024-32767
ListenPort
指定桥接适配器用于接收来自 Zabbix 服务器的 HTTP[S] 连接的监听端口。
默认值:10005
范围: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
指定包含用于在 mTLS 模式下验证客户端证书的顶级 CA 证书的文件完整路径。
TLSConfig.CertFile
指定包含证书或证书链的文件的完整路径。
TLSConfig.KeyFile
指定包含私钥的文件的完整路径。
TLSConfig.Mode
设置 ListenPort 上传入连接的 TLS 模式:
none- 接受未加密的连接。tls- 使用最低版本为 v1.2 的标准 TLS。mtls- 在 TLS 的基础上启用双向身份验证。
默认值:none
ZabbixAPITLSCAFile
指定一个文件的完整路径名,该文件包含 bridge adapter 用于验证 Zabbix API 证书的顶级 CA 证书。
必填:如果 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 证书和主机名。
ZabbixAPIURL
指定 Zabbix API 端点的 URL。
必填:是
示例:
ZabbixAPIURL=https://example.com/zabbix/api_jsonrpc.php
ZabbixBridgeURL
指定用于检索 Zabbix Bridge 配置的 Zabbix bridge URL(在 bridge 适配器启动时检索)。
默认值:ZabbixBridgeURL=https://test.aws.zabbix-lab.win/.well-known/bridge-configuration