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.

Cette page est structurée comme suit :

  • Vue d'ensemble des paramètres (pour voir tous les détails d'un paramètre, cliquez sur son nom)
  • Détails des paramètres
Parameter Description
Plugins.MSSQL.CustomQueriesDir Spécifie le chemin du répertoire contenant les fichiers .sql définis par l'utilisateur avec des requêtes personnalisées que le plugin peut exécuter.
Plugins.MSSQL.CustomQueriesEnabled Active l'exécution de la clé d'élément mssql.custom.query.
Plugins.MSSQL.Default.CACertPath Spécifie 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.
Plugins.MSSQL.Default.Database Spécifie le nom de base de données par défaut.
Plugins.MSSQL.Default.Encrypt Spécifie le niveau de chiffrement par défaut.
Plugins.MSSQL.Default.HostNameInCertificate Spécifie par défaut le nom commun (CN) du certificat du serveur MSSQL.
Plugins.MSSQL.Default.Password Spécifie le mot de passe par défaut.
Plugins.MSSQL.Default.TLSMinVersion Spécifie par défaut la version minimale de TLS.
Plugins.MSSQL.Default.TrustServerCertificate Fait confiance au certificat du serveur sans le valider par défaut.
Plugins.MSSQL.Default.Uri Spécifie l'URI par défaut.
Plugins.MSSQL.Default.User Spécifie le nom d'utilisateur par défaut.
Plugins.MSSQL.KeepAlive Spécifie le temps d'attente maximal, en secondes, avant la fermeture des connexions inutilisées du plugin.
Plugins.MSSQL.Sessions.<SessionName>.CACertPath Spécifie le chemin du fichier de session nommée vers le certificat de clé publique de l'autorité de certification (CA) qui a émis le certificat du serveur MSSQL.
Plugins.MSSQL.Sessions.<SessionName>.Database Spécifie le nom de base de données de la session nommée.
Plugins.MSSQL.Sessions.<SessionName>.Encrypt Spécifie le niveau de chiffrement de la session nommée.
Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate Spécifie le nom commun (CN) du certificat du serveur MSSQL pour la session nommée.
Plugins.MSSQL.Sessions.<SessionName>.Password Spécifie le mot de passe de la session nommée.
Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion Spécifie la version minimale de TLS de la session nommée.
Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate Fait confiance au certificat du serveur de la session nommée sans le valider.
Plugins.MSSQL.Sessions.<SessionName>.Uri Spécifie l'URI de la session nommée.
Plugins.MSSQL.Sessions.<SessionName>.User Spécifie le nom d'utilisateur de la session nommée.
Plugins.MSSQL.System.Path Spécifie le chemin de l'exécutable du plugin MSSQL.
Plugins.MSSQL.Timeout Définit la 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.

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.

Détails du paramètre

Plugins.MSSQL.CustomQueriesDir

Spécifie le chemin du répertoire contenant les 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 apportée aux fichiers de requêtes personnalisées ne sera prise en compte qu'après le redémarrage du plugin. Le plugin est démarré et arrêté en même temps que Zabbix agent 2.

Valeurs par défaut :
/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)

Plugins.MSSQL.CustomQueriesEnabled

Active l'exécution de la clé d'élément mssql.custom.query.
Si cette option est désactivée, aucune requête ne sera chargée depuis le chemin du répertoire des requêtes personnalisées.

Par défaut: false
Plage: true/false

Plugins.MSSQL.Default.CACertPath

Spécifie 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

Spécifiez le nom de la base de données par défaut.

Plugins.MSSQL.Default.Encrypt

Spécifie le niveau de chiffrement par défaut.

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

Spécifiez par défaut le nom commun (CN) du certificat du serveur MSSQL.

Plugins.MSSQL.Default.Password

Spécifiez le mot de passe par défaut pour un serveur MSSQL protégé.

Plugins.MSSQL.Default.TLSMinVersion

Spécifiez par défaut la version minimale de TLS.

Plage : 1.0, 1.1, 1.2, 1.3

Plugins.MSSQL.Default.TrustServerCertificate

Faire confiance au certificat du serveur sans le valider par défaut.

Plage : true, false

Plugins.MSSQL.Default.Uri

Spécifiez l'URI par défaut pour la connexion au serveur MSSQL.
Les identifiants intégrés seront ignorés.
Le seul schéma pris en charge est sqlserver://.
Le schéma peut être omis.

Par défaut: sqlserver://localhost:1433

Plugins.MSSQL.Default.User

Spécifiez le nom d'utilisateur par défaut pour un serveur MSSQL protégé.

Plugins.MSSQL.KeepAlive

Spécifie le temps d'attente maximal (en secondes) avant que les connexions de plugin inutilisées ne soient fermées.

Par défaut: 300
Plage: 60-900

Plugins.MSSQL.Sessions.<SessionName>.CACertPath

Spécifiez le chemin du fichier de session nommé vers le certificat de clé publique de l'autorité de certification (CA) qui a émis le certificat du serveur MSSQL.
<SessionName> - définit le nom d'une session à utiliser dans les clés d'élément.
Le certificat doit être au format PEM.

Plugins.MSSQL.Sessions.<SessionName>.Database

Spécifie le nom de la base de données de la session nommée.
<SessionName> - définit le nom d'une session à utiliser dans les clés d'élément.

Plugins.MSSQL.Sessions.<SessionName>.Encrypt

Spécifie le niveau de chiffrement de la session nommée.
<SessionName> - définit le nom d'une session à utiliser dans les clés d'élément.

Plage :
true - les données envoyées entre le plugin et le serveur sont chiffrées ;
false - les données envoyées entre le plugin et le serveur ne sont pas chiffrées au-delà du paquet de connexion ;
strict - les données envoyées entre le plugin et le serveur sont chiffrées de bout en bout à l'aide de TDS8 ;
disable - les données envoyées entre le plugin et le serveur ne sont pas chiffrées.

Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate

Spécifiez le nom commun (CN) du certificat du serveur MSSQL pour la session nommée.
<SessionName> - définissez le nom d'une session à utiliser dans les clés d'élément.

Plugins.MSSQL.Sessions.<SessionName>.Password

Spécifiez le mot de passe de la session nommée pour un serveur MSSQL protégé.
<SessionName> - définit le nom d'une session à utiliser dans les clés d'élément.

Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion

Spécifie la version TLS minimale de la session nommée.
<SessionName> - définit le nom d'une session à utiliser dans les clés d'élément.

Plage : 1.0, 1.1, 1.2, 1.3

Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate

Faire confiance au certificat du serveur de la session nommée sans le valider.
<SessionName> - définit le nom d'une session à utiliser dans les clés d'élément.

Plage : true, false

Plugins.MSSQL.Sessions.<SessionName>.Uri

Spécifiez l'URI de session nommée pour la connexion au serveur MSSQL.
<SessionName> - définit le nom d'une session à utiliser dans les clés d'élément.
Les identifiants intégrés seront ignorés.
Le seul schéma pris en charge est sqlserver://.
Le schéma peut être omis.

Par défaut: sqlserver://localhost:1433

Plugins.MSSQL.Sessions.<SessionName>.User

Spécifiez le nom d'utilisateur de la session nommée pour un serveur MSSQL protégé.
<SessionName> - définissez le nom d'une session à utiliser dans les clés d'élément.

Plugins.MSSQL.System.Path

Spécifiez le chemin vers l'exécutable du plugin MSSQL.
Paramètre global pour le plugin MSSQL. Appliqué à toutes les connexions.

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

Plugins.MSSQL.Timeout

Définissez la 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.

Par défaut: global timeout
Plage: 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).

Voir aussi