Table of Contents
8 MSSQL 插件
概述
本节列出了MSSQL Zabbix agent 2插件配置文件(mssql.conf)支持的参数。
MSSQL插件是一个可加载插件，其完整描述可在MSSQL plugin repository中获取。
该插件自Zabbix 6.0.27版本开始支持。 Windows平台的预编译插件二进制文件自Zabbix 6.0.28开始提供，并与6.0.27版本兼容。
注意事项：
- 默认值反映的是进程默认值，而非随附配置文件中的值；
- Zabbix仅支持UTF-8编码的配置文件，不支持BOM；
- 以"#"开头的注释仅支持在行首使用。
参数
| 参数 | 必选 | 取值范围 | 默认值 | 描述 |
|---|---|---|---|---|
| Plugins.MSSQL.CustomQueriesDir | no | 空 | 指定包含用户自定义.sql文件的目录路径，这些文件包含插件可执行的自定义queries。插件在启动时会加载配置目录中所有可用的.sql文件。这意味着对自定义query文件的任何更改在插件重启前不会生效。插件随Zabbix agent 2一起启动和停止。 | |
| Plugins.MSSQL.Default.CACertPath | no | 默认的证书颁发机构(CA)公钥证书路径，该CA签发了MSSQL服务器的证书。证书必须为PEM格式。 | ||
| Plugins.MSSQL.Default.Database | no | 默认连接的数据库名称。 | ||
| Plugins.MSSQL.Default.Encrypt | no | 指定默认连接加密类型。可选值： true - 插件与服务器间的数据传输加密； false - 仅登录数据包加密； strict - 使用TDS8实现端到端加密； disable - 不加密数据传输。 |
||
| Plugins.MSSQL.Default.HostNameInCertificate | no | MSSQL服务器证书的默认通用名(CN)。 | ||
| Plugins.MSSQL.Default.Password | no | 发送到受保护MSSQL服务器的默认密码。 | ||
| Plugins.MSSQL.Default.TLSMinVersion | no | 默认使用的最低TLS版本。可选值：1.0、1.1、1.2、1.3。 |
||
| Plugins.MSSQL.Default.TrustServerCertificate | no | 插件是否默认不验证服务器证书而直接信任。可选值：true、false。 |
||
| Plugins.MSSQL.Default.Uri | no | sqlserver://localhost:1433 | 默认连接URI。唯一支持的协议为sqlserver://。协议前缀可省略，嵌入的凭证将被忽略。 |
|
| Plugins.MSSQL.Default.User | no | 发送到受保护MSSQL服务器的默认用户名。 | ||
| Plugins.MSSQL.KeepAlive | no | 60-900 | 300 | 关闭未使用的插件连接前的最大等待时间（秒）。 |
| Plugins.MSSQL.Sessions.<SessionName>.CACertPath | no | 命名会话中MSSQL服务器CA证书的路径。证书必须为PEM格式。 <SessionName> - 定义用于监控项键的会话名称。 |
||
| Plugins.MSSQL.Sessions.<SessionName>.Database | no | 命名会话连接的数据库名称。 <SessionName> - 定义用于监控项键的会话名称。 |
||
| Plugins.MSSQL.Sessions.<SessionName>.Encrypt | no | 命名会话的连接加密类型。可选值： true - 数据传输加密； false - 仅登录数据包加密； strict - 使用TDS8端到端加密； disable - 不加密。 <SessionName> - 定义用于监控项键的会话名称。 |
||
| Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate | no | 命名会话中MSSQL服务器证书的通用名(CN)。 <SessionName> - 定义用于监控项键的会话名称。 |
||
| Plugins.MSSQL.Sessions.<SessionName>.Password | no | 命名会话中发送到受保护MSSQL服务器的密码。 <SessionName> - 定义用于监控项键的会话名称。 |
||
| Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion | no | 命名会话中使用的最低TLS版本。可选值：1.0、1.1、1.2、1.3。<SessionName> - 定义用于监控项键的会话名称。 |
||
| Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate | no | 命名会话中是否不验证服务器证书而直接信任。可选值：true、false。<SessionName> - 定义用于监控项键的会话名称。 |
||
| Plugins.MSSQL.Sessions.<SessionName>.Uri | no | sqlserver://localhost:1433 | 命名会话的连接URI。唯一支持的协议为sqlserver://。协议前缀可省略，嵌入的凭证将被忽略。<SessionName> - 定义用于监控项键的会话名称。 |
|
| Plugins.MSSQL.Sessions.<SessionName>.User | no | 命名会话中发送到受保护MSSQL服务器的用户名。 <SessionName> - 定义用于监控项键的会话名称。 |
||
| Plugins.MSSQL.System.Path | no | MSSQL插件可执行文件路径。 MSSQL插件的全局设置，适用于所有连接。 使用示例： Plugins.MSSQL.System.Path=/usr/sbin/zabbix-agent2-plugin/zabbix-agent2-plugin-mssql |
||
| Plugins.MSSQL.Timeout | no | 1-30 | 全局超时 | 会话中首次连接及后续操作等待服务器响应的时长（秒）。 |
另请参阅：
- Zabbix agent 2通用配置参数说明： Zabbix agent 2 (UNIX) / Zabbix agent 2 (Windows)
- plugins配置指南