[comment]: # (tags: mssql)

[comment]: # ({12942068-2b91b381})
# 8 MSSQL 插件

[comment]: # ({/12942068-2b91b381})

[comment]: # ({824434d2-982c8358})
#### 概述

本节列出了MSSQL Zabbix agent 2插件配置file (mssql.conf)中支持的参数。

MSSQL插件是一个可加载插件，在[MSSQL plugin repository](https://git.zabbix.com/projects/AP/repos/mssql/browse?at=refs%2Fheads%2Frelease%2F6.0)中有完整描述并可用。

该插件自Zabbix 6.0.27版本开始支持。
Windows平台的预编译插件二进制文件自[Zabbix 6.0.28](https://cdn.zabbix.com/zabbix/binaries/stable/6.0/6.0.28/)起可用，并与6.0.27版本version兼容。

请注意：

-   默认值反映的是进程默认值，而非随附配置文件中的值；
-   Zabbix仅支持UTF-8编码的配置文件，不包含[BOM](https://en.wikipedia.org/wiki/Byte_order_mark)；
-   以"\#"开头的注释仅在行首时被支持。

[comment]: # ({/824434d2-982c8358})

[comment]: # ({03a0ccba-efe3e04c})
#### 参数

| 参数 | 必填 | 范围 | 默认值 | 描述 |
|--|--|--|--|----------|
| Plugins.MSSQL.CustomQueriesDir | no |       | 空   | 指定包含用户自定义.sql文件的file路径，这些文件带有插件可execute的自定义queries。插件在启动时会加载配置目录中所有可用的.sql文件。这意味着对自定义query文件的任何更改在插件重启前都不会生效。插件随Zabbix agent 2一起启动和停止。 |
| Plugins.MSSQL.Default.CACertPath | no |       |         | 默认file路径，指向颁发MSSQL服务器证书的证书颁发机构(CA)的公钥证书。证书必须为PEM格式。 |
| Plugins.MSSQL.Default.Database | no |       |         | 默认连接的数据库名称。 |
| Plugins.MSSQL.Default.Encrypt | no |       |         | 指定默认连接加密类型。可能值包括:<br>*true* - 插件与服务器间的数据传输加密;<br>*false* - 插件与服务器间的数据传输仅login包加密;<br>*strict* - 使用[TDS8](https://learn.microsoft.com/en-us/sql/relational-databases/security/networking/tds-8?view=sql-server-ver16)实现插件与服务器间的端到端加密;<br>*disable* - 插件与服务器间的数据传输不加密。 |
| Plugins.MSSQL.Default.HostNameInCertificate | no |       |         | MSSQL服务器证书的默认通用名(CN)。 |
| Plugins.MSSQL.Default.Password | no |       |         | 发送到受保护MSSQL服务器的默认密码。 |
| Plugins.MSSQL.Default.TLSMinVersion | no |       |         | 默认使用的最低TLSversion。可能值: `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公钥证书的file路径。证书必须为PEM格式。<br>**<SessionName>** - 定义用于监控项键的会话名称。 |
| Plugins.MSSQL.Sessions.<SessionName>.Database | no |       |         | 命名会话连接的数据库名称。<br>**<SessionName>** - 定义用于监控项键的会话名称。 |
| Plugins.MSSQL.Sessions.<SessionName>.Encrypt | no |       |         | 指定命名会话的连接加密类型。可能值包括:<br>*true* - 插件与服务器间的数据传输加密;<br>*false* - 插件与服务器间的数据传输仅login包加密;<br>*strict* - 使用[TDS8](https://learn.microsoft.com/en-us/sql/relational-databases/security/networking/tds-8?view=sql-server-ver16)实现端到端加密;<br>*disable* - 数据传输不加密。<br>**<SessionName>** - 定义用于监控项键的会话名称。 |
| Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate | no |       |         | 命名会话中MSSQL服务器证书的通用名(CN)。<br>**<SessionName>** - 定义用于监控项键的会话名称。 |
| Plugins.MSSQL.Sessions.<SessionName>.Password | no |       |         | 命名会话中发送到受保护MSSQL服务器的密码。<br>**<SessionName>** - 定义用于监控项键的会话名称。 |
| Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion | no |       |         | 命名会话中使用的最低TLSversion。可能值: `1.0`, `1.1`, `1.2`, `1.3`。<br>**<SessionName>** - 定义用于监控项键的会话名称。 |
| Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate | no |       |         | 命名会话中插件是否不验证服务器证书而信任它。可能值: `true`, `false`。<br>**<SessionName>** - 定义用于监控项键的会话名称。 |
| Plugins.MSSQL.Sessions.<SessionName>.Uri | no |       | sqlserver://localhost:1433 | 命名会话的连接URI。唯一支持的协议是`sqlserver://`。可省略协议。嵌入的凭据将被忽略。<br>**<SessionName>** - 定义用于监控项键的会话名称。 |
| Plugins.MSSQL.Sessions.<SessionName>.User | no |       |         | 命名会话中发送到受保护MSSQL服务器的用户名。<br>**<SessionName>** - 定义用于监控项键的会话名称。 |
| Plugins.MSSQL.System.Path | no |       |         | MSSQL插件可执行文件路径。<br>MSSQL插件的全局设置。适用于所有连接。<br>使用示例: `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)](/manual/appendix/config/zabbix_agent2) /
    [Zabbix agent 2
    (Windows)](/manual/appendix/config/zabbix_agent2_win)
-   [plugins](/manual/extensions/plugins)配置指南

[comment]: # ({/03a0ccba-efe3e04c})