Table of Contents
7 MSSQL plugin
Overview
This section lists parameters supported in the MSSQL Zabbix agent 2 plugin configuration file (mssql.conf).
This plugin is supported since Zabbix 6.0.27. For more information see the MSSQL plugin readme.
Note that:
- The default values reflect process defaults, not the values in the shipped configuration files;
- Zabbix supports configuration files only in UTF-8 encoding without BOM;
- Comments starting with "#" are only supported at the beginning of the line.
Parameters
| Parameter | Mandatory | Range | Default | Description |
|---|---|---|---|---|
| Plugins.MSSQL.CustomQueriesDir | no | empty | Specifies the file path to a directory containing user-defined .sql files with custom queries that the plugin can execute. The plugin loads all available .sql files in the configured directory at startup. This means that any changes to the custom query files will not be reflected until the plugin is restarted. The plugin is started and stopped together with Zabbix agent 2. | |
| Plugins.MSSQL.Default.CACertPath | no | The default file path to the public key certificate of the certificate authority (CA) that issued the certificate of the MSSQL server. The certificate must be in PEM format. | ||
| Plugins.MSSQL.Default.Database | no | The default database name to connect to. | ||
| Plugins.MSSQL.Default.Encrypt | no | Specifies the default connection encryption type. Possible values are: true - data sending between plugin and server is encrypted; false - data sending between plugin and server is not encrypted beyond the login packet; strict - data sending between plugin and server is encrypted E2E using TDS8; disable - data sending between plugin and server is not encrypted. |
||
| Plugins.MSSQL.Default.HostNameInCertificate | no | The common name (CN) of the certificate of the MSSQL server by default. | ||
| Plugins.MSSQL.Default.Password | no | The password to be sent to a protected MSSQL server by default. | ||
| Plugins.MSSQL.Default.TLSMinVersion | no | The minimum TLS version to use by default. Possible values are: 1.0, 1.1, 1.2, 1.3. |
||
| Plugins.MSSQL.Default.TrustServerCertificate | no | Whether the plugin should trust the server certificate without validating it by default. Possible values: true, false. |
||
| Plugins.MSSQL.Default.Uri | no | sqlserver://localhost:1433 | The default URI to connect. The only supported schema is sqlserver://. A schema can be omitted. Embedded credentials will be ignored. |
|
| Plugins.MSSQL.Default.User | no | The default username to be sent to a protected MSSQL server. | ||
| Plugins.MSSQL.KeepAlive | no | 60-900 | 300 | The maximum time of waiting (in seconds) before unused plugin connections are closed. |
| Plugins.MSSQL.Sessions.<SessionName>.CACertPath | no | The file path to the public key certificate of the certificate authority (CA) that issued the certificate of the MSSQL server for the named session. The certificate must be in PEM format. <SessionName> - define name of a session for using in item keys. |
||
| Plugins.MSSQL.Sessions.<SessionName>.Database | no | The database name to connect to for the named session. <SessionName> - define name of a session for using in item keys. |
||
| Plugins.MSSQL.Sessions.<SessionName>.Encrypt | no | Specifies the connection encryption type for the named session. Possible values are: true - data sending between plugin and server is encrypted; false - data sending between plugin and server is not encrypted beyond the login packet; strict - data sending between plugin and server is encrypted E2E using TDS8; disable - data sending between plugin and server is not encrypted. <SessionName> - define name of a session for using in item keys. |
||
| Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate | no | The common name (CN) of the certificate of the MSSQL server for the named session. <SessionName> - define name of a session for using in item keys. |
||
| Plugins.MSSQL.Sessions.<SessionName>.Password | no | The password to be sent to a protected MSSQL server for the named session. <SessionName> - define name of a session for using in item keys. |
||
| Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion | no | The minimum TLS version to use for the named session. Possible values are: 1.0, 1.1, 1.2, 1.3.<SessionName> - define name of a session for using in item keys. |
||
| Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate | no | Whether the plugin should trust the server certificate without validating it for the named session. Possible values: true, false.<SessionName> - define name of a session for using in item keys. |
||
| Plugins.MSSQL.Sessions.<SessionName>.Uri | no | sqlserver://localhost:1433 | The URI to connect, for the named session. The only supported schema is sqlserver://. A schema can be omitted. Embedded credentials will be ignored.<SessionName> - define name of a session for using in item keys. |
|
| Plugins.MSSQL.Sessions.<SessionName>.User | no | The username to be sent to a protected MSSQL server for the named session. <SessionName> - define name of a session for using in item keys. |
||
| Plugins.MSSQL.System.Path | no | Path to the MSSQL plugin executable. Global setting for the MSSQL plugin. Applied to all connections. Example usage: Plugins.MSSQL.System.Path=/usr/sbin/zabbix-agent2-plugin/zabbix-agent2-plugin-mssql |
||
| Plugins.MSSQL.Timeout | no | 1-30 | global timeout | The amount of time to wait for a server to respond when first connecting and on follow-up operations in the session. |
See also:
- Description of general Zabbix agent 2 configuration parameters: Zabbix agent 2 (UNIX) / Zabbix agent 2 (Windows)
- Instructions for configuring plugins