Documentation
Table of Contents
8 MSSQL 插件
概述
本节列出了 MSSQL Zabbix agent 2 插件配置 file（mssql.conf）中支持的参数。
MSSQL 插件是一个可加载插件，在 MSSQL plugin repository 中提供并有完整描述。
请注意：
- 默认值反映的是进程默认值，而不是随软件包提供的配置文件中的值；
- Zabbix 仅支持使用 UTF-8 编码且不带 BOM 的配置文件；
- 以 "#" 开头的注释仅支持出现在行首。
Options
| Parameter | Description |
|---|---|
| -V --version | Print the plugin version and license information. |
| -h --help | Print help information (shorthand). |
| -t, --test <item key> | Launch plugin for testing (plugin config ignored). |
参数
| 参数 | 必填 | 范围 | 默认值 | 描述 |
|---|---|---|---|---|
| Plugins.MSSQL.CustomQueriesDir | no | empty | 指定包含用户自定义 .sql 文件的目录的 file 路径，插件可以执行这些文件中的自定义 queries。插件在启动时加载配置目录中所有可用的 .sql 文件。这意味着对自定义 query 文件所做的更改，直到插件重新启动后才会生效。插件随 Zabbix agent 2 一起启动和停止。 | |
| Plugins.MSSQL.Default.CACertPath | no | 证书颁发机构（CA）的公钥证书的默认 file 路径，该证书颁发机构签发了 MSSQL 服务器的证书。证书必须为 PEM 格式。 | ||
| Plugins.MSSQL.Default.Database | no | 要连接的默认数据库名称。 | ||
| Plugins.MSSQL.Default.Encrypt | no | 指定默认的连接加密类型。可能的值为： true - 插件和服务器之间发送的数据被加密； false - 插件和服务器之间发送的数据除了 login 数据包外不加密； strict - 插件和服务器之间发送的数据使用 TDS8 进行端到端加密； disable - 插件和服务器之间发送的数据不加密。 |
||
| Plugins.MSSQL.Default.HostNameInCertificate | no | 默认情况下，MSSQL 服务器证书的通用名称（CN）。 | ||
| Plugins.MSSQL.Default.Password | no | 默认发送到受保护 MSSQL 服务器的密码。 | ||
| Plugins.MSSQL.Default.TLSMinVersion | no | 默认使用的最低 TLS version。可能的值为：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 | 证书颁发机构（CA）的公钥证书的 file 路径，该证书颁发机构为命名会话签发了 MSSQL 服务器的证书。证书必须为 PEM 格式。 <SessionName> - 定义用于 监控项 键的会话名称。 |
||
| Plugins.MSSQL.Sessions.<SessionName>.Database | no | 命名会话要连接的数据库名称。 <SessionName> - 定义用于 监控项 键的会话名称。 |
||
| Plugins.MSSQL.Sessions.<SessionName>.Encrypt | no | 指定命名会话的连接加密类型。可能的值为： true - 插件和服务器之间发送的数据被加密； false - 插件和服务器之间发送的数据除了 login 数据包外不加密； 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 version。可能的值为：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 | global timeout | 在首次连接和会话中的后续操作中，等待服务器响应的持续时间（以秒为单位）。 |
另请参阅：
- 通用 Zabbix agent 2 配置参数的描述： Zabbix agent 2 (UNIX) / Zabbix agent 2 (Windows)
- 配置 plugins 的说明