Plugin MSSQL

Vue d'ensemble

Les paramètres de configuration permettent de personnaliser le comportement du plugin MSSQL.

Il est recommandé de les spécifier dans leur propre fichier de configuration (par exemple mssql.conf), plutôt que dans le fichier de configuration de l'agent 2. Utilisez ensuite la directive Include pour inclure ce fichier dans la configuration de Zabbix agent 2.

Le plugin MSSQL est un plugin chargeable et est disponible, avec une description complète, dans le dépôt du plugin MSSQL.

Tous les paramètres sont facultatifs, sauf indication explicite précisant que le paramètre est obligatoire.

Notez que :

  • Les valeurs par défaut reflètent les valeurs par défaut du processus, et non celles des fichiers de configuration fournis.
  • Les valeurs prennent en charge les variables d'environnement ;
  • Zabbix prend en charge les fichiers de configuration uniquement en encodage UTF-8 sans BOM.
  • Les commentaires commençant par "#" ne sont pris en charge qu'au début de la ligne.

Parameter details

Plugins.MSSQL.CustomQueriesDir

Specify path to the 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.

Defaults:
/usr/local/share/zabbix/custom-queries/mssql - for Unix systems,
*:\Program Files\Zabbix Agent 2\Custom Queries\MSSQL - for Windows systems (where * is the drive name from the ProgramFiles environment variable)

Plugins.MSSQL.CustomQueriesEnabled

Enable execution of the mssql.custom.query item key.
If disabled, no queries will be loaded from the custom query directory path.

Default: false Range: true/false

Plugins.MSSQL.Default.CACertPath

Specify 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

Specify the default database name.

Plugins.MSSQL.Default.Encrypt

Specify the level of default encryption.

Range:
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

Specify the common name (CN) of the MSSQL server certificate by default.

Plugins.MSSQL.Default.Password

Specify the default password for a protected MSSQL server.

Plugins.MSSQL.Default.TLSMinVersion

Specify the minimum TLS version by default.

Range: 1.0, 1.1, 1.2, 1.3

Plugins.MSSQL.Default.TrustServerCertificate

Trust the server certificate without validating it by default.

Range: true, false

Plugins.MSSQL.Default.Uri

Specify the default URI for connecting to MSSQL server.
Embedded credentials will be ignored.
The only supported schema is sqlserver://.
The schema can be omitted.

Default: sqlserver://localhost:1433

Plugins.MSSQL.Default.User

Specify the default username for a protected MSSQL server.

Plugins.MSSQL.KeepAlive

Specify the maximum time of waiting (in seconds) before unused plugin connections are closed.

Default: 300 Range: 60-900

Plugins.MSSQL.Sessions.<SessionName>.CACertPath

Specify the named session file path to the public key certificate of the certificate authority (CA) that issued the certificate of the MSSQL server.
<SessionName> - define name of a session for using in item keys.
The certificate must be in PEM format.

Plugins.MSSQL.Sessions.<SessionName>.Database

Specify the named session database name.
<SessionName> - define name of a session for using in item keys.

Plugins.MSSQL.Sessions.<SessionName>.Encrypt

Specify the level of named session encryption.
<SessionName> - define name of a session for using in item keys.

Range:
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.Sessions.<SessionName>.HostNameInCertificate

Specify the common name (CN) of the MSSQL server certificate for named session.
<SessionName> - define name of a session for using in item keys.

Plugins.MSSQL.Sessions.<SessionName>.Password

Specify the named session password for a protected MSSQL server.
<SessionName> - define name of a session for using in item keys.

Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion

Specify the named session minimum TLS version.
<SessionName> - define name of a session for using in item keys.

Range: 1.0, 1.1, 1.2, 1.3

Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate

Trust the named session server certificate without validating it.
<SessionName> - define name of a session for using in item keys.

Range: true, false

Plugins.MSSQL.Sessions.<SessionName>.Uri

Specify the named session URI for connecting to MSSQL server.
<SessionName> - define name of a session for using in item keys.
Embedded credentials will be ignored.
The only supported schema is sqlserver://.
The schema can be omitted.

Default: sqlserver://localhost:1433

Plugins.MSSQL.Sessions.<SessionName>.User

Specify the named session username for a protected MSSQL server.
<SessionName> - define name of a session for using in item keys.

Plugins.MSSQL.System.Path

Specify path to the MSSQL plugin executable.
Global setting for the MSSQL plugin. Applied to all connections.

Example: Plugins.MSSQL.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-mssql

Plugins.MSSQL.Timeout

Set the duration, in seconds, to wait for a server to respond when first connecting and on follow-up operations in the session.

Default: default timeout Range: 1-30

Options

Parameter Description
-V --version Afficher la version du plugin et les informations de licence.
-h --help Afficher les informations d'aide (raccourci).
-t, --test <item key> Lancer le plugin pour les tests (la configuration du plugin est ignorée).

Paramètres

Parameter Mandatory Range Default Description
Plugins.MSSQL.CustomQueriesDir no /usr/local/share/zabbix/custom-queries/mssql pour les systèmes Unix

*:\Program Files\Zabbix Agent 2\Custom Queries\MSSQL pour les systèmes Windows, où * est le nom du lecteur provenant de la variable d'environnement ProgramFiles		 Spécifie le chemin d'accès à un répertoire contenant des fichiers .sql définis par l'utilisateur avec des requêtes personnalisées que le plugin peut exécuter. Le plugin charge tous les fichiers .sql disponibles dans le répertoire configuré au démarrage. Cela signifie que toute modification des fichiers de requêtes personnalisées ne sera pas prise en compte tant que le plugin n'aura pas été redémarré. Le plugin est démarré et arrêté avec Zabbix agent 2.
Plugins.MSSQL.CustomQueriesEnabled no false Si cette option est définie, elle active l'exécution de la clé d'élément mssql.custom.query. Si elle est désactivée, aucune requête ne sera chargée depuis le chemin du répertoire des requêtes personnalisées.
Plugins.MSSQL.Default.CACertPath no Le chemin de fichier par défaut vers le certificat de clé publique de l'autorité de certification (CA) qui a émis le certificat du serveur MSSQL. Le certificat doit être au format PEM.
Plugins.MSSQL.Default.Database no Le nom de base de données par défaut auquel se connecter.
Plugins.MSSQL.Default.Encrypt no Spécifie le type de chiffrement de connexion par défaut. Les valeurs possibles sont :
true - l'envoi des données entre le plugin et le serveur est chiffré ;
false - l'envoi des données entre le plugin et le serveur n'est pas chiffré au-delà du paquet de connexion ;
strict - l'envoi des données entre le plugin et le serveur est chiffré de bout en bout à l'aide de TDS8 ;
disable - l'envoi des données entre le plugin et le serveur n'est pas chiffré.
Plugins.MSSQL.Default.HostNameInCertificate no Le nom commun (CN) du certificat du serveur MSSQL par défaut.
Plugins.MSSQL.Default.Password no Le mot de passe à envoyer par défaut à un serveur MSSQL protégé.
Plugins.MSSQL.Default.TLSMinVersion no La version minimale de TLS à utiliser par défaut. Les valeurs possibles sont : 1.0, 1.1, 1.2, 1.3.
Plugins.MSSQL.Default.TrustServerCertificate no Indique si le plugin doit faire confiance au certificat du serveur sans le valider par défaut. Valeurs possibles : true, false.
Plugins.MSSQL.Default.Uri no sqlserver://localhost:1433 L'URI par défaut pour la connexion. Le seul schéma pris en charge est sqlserver://. Un schéma peut être omis. Les identifiants intégrés seront ignorés.
Plugins.MSSQL.Default.User no Le nom d'utilisateur par défaut à envoyer à un serveur MSSQL protégé.
Plugins.MSSQL.KeepAlive no 60-900 300 Le temps d'attente maximal, en secondes, avant la fermeture des connexions du plugin inutilisées.
Plugins.MSSQL.Sessions.<SessionName>.CACertPath no Le chemin de fichier vers le certificat de clé publique de l'autorité de certification (CA) qui a émis le certificat du serveur MSSQL pour la session nommée. Le certificat doit être au format PEM.
<SessionName> - définir le nom d'une session à utiliser dans les clés d'élément.
Plugins.MSSQL.Sessions.<SessionName>.Database no Le nom de base de données auquel se connecter pour la session nommée.
<SessionName> - définir le nom d'une session à utiliser dans les clés d'élément.
Plugins.MSSQL.Sessions.<SessionName>.Encrypt no Spécifie le type de chiffrement de connexion pour la session nommée. Les valeurs possibles sont :
true - l'envoi des données entre le plugin et le serveur est chiffré ;
false - l'envoi des données entre le plugin et le serveur n'est pas chiffré au-delà du paquet de connexion ;
strict - l'envoi des données entre le plugin et le serveur est chiffré de bout en bout à l'aide de TDS8 ;
disable - l'envoi des données entre le plugin et le serveur n'est pas chiffré.
<SessionName> - définir le nom d'une session à utiliser dans les clés d'élément.
Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate no Le nom commun (CN) du certificat du serveur MSSQL pour la session nommée.
<SessionName> - définir le nom d'une session à utiliser dans les clés d'élément.
Plugins.MSSQL.Sessions.<SessionName>.Password no Le mot de passe à envoyer à un serveur MSSQL protégé pour la session nommée.
<SessionName> - définir le nom d'une session à utiliser dans les clés d'élément.
Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion no La version minimale de TLS à utiliser pour la session nommée. Les valeurs possibles sont : 1.0, 1.1, 1.2, 1.3.
<SessionName> - définir le nom d'une session à utiliser dans les clés d'élément.
Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate no Indique si le plugin doit faire confiance au certificat du serveur sans le valider pour la session nommée. Valeurs possibles : true, false.
<SessionName> - définir le nom d'une session à utiliser dans les clés d'élément.
Plugins.MSSQL.Sessions.<SessionName>.Uri no sqlserver://localhost:1433 L'URI de connexion pour la session nommée. Le seul schéma pris en charge est sqlserver://. Un schéma peut être omis. Les identifiants intégrés seront ignorés.
<SessionName> - définir le nom d'une session à utiliser dans les clés d'élément.
Plugins.MSSQL.Sessions.<SessionName>.User no Le nom d'utilisateur à envoyer à un serveur MSSQL protégé pour la session nommée.
<SessionName> - définir le nom d'une session à utiliser dans les clés d'élément.
Plugins.MSSQL.System.Path no Chemin vers l'exécutable du plugin MSSQL.
Paramètre global pour le plugin MSSQL. Appliqué à toutes les connexions.
Exemple d'utilisation : Plugins.MSSQL.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-mssql
Plugins.MSSQL.Timeout no 1-30 global timeout Durée, en secondes, d'attente d'une réponse du serveur lors de la première connexion et des opérations suivantes dans la session.

Voir aussi :