MSSQL-Plugin

Übersicht

Konfigurationsparameter ermöglichen die Anpassung des Verhaltens des MSSQL-Plugins.

Es wird empfohlen, sie in einer eigenen Konfigurationsdatei (z. B. mssql.conf) anzugeben, statt in der Konfigurationsdatei von Agent 2. Verwenden Sie dann die Direktive Include, um diese Datei in die Konfiguration von Zabbix Agent 2 einzubinden.

Das MSSQL-Plugin ist ein ladbares Plugin und ist im Repository des MSSQL-Plugins verfügbar und dort vollständig beschrieben.

Alle Parameter sind optional, sofern nicht ausdrücklich angegeben ist, dass der Parameter obligatorisch ist.

Beachten Sie:

  • Die Standardwerte spiegeln die Prozess-Standardeinstellungen wider, nicht die Werte in den mitgelieferten Konfigurationsdateien.
  • Werte unterstützen Umgebungsvariablen;
  • Zabbix unterstützt Konfigurationsdateien nur in der UTF-8-Kodierung ohne BOM.
  • Kommentare, die mit "#" beginnen, werden nur am Zeilenanfang unterstützt.

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

Optionen

Parameter Beschreibung
-V --version Gibt die Plugin-Version und Lizenzinformationen aus.
-h --help Gibt Hilfsinformationen aus (Kurzform).
-t, --test <item key> Startet das Plugin zum Testen (Plugin-Konfiguration wird ignoriert).

Parameter

Parameter Mandatory Range Default Description
Plugins.MSSQL.CustomQueriesDir no /usr/local/share/zabbix/custom-queries/mssql für Unix-Systeme

*:\Program Files\Zabbix Agent 2\Custom Queries\MSSQL für Windows-Systeme, wobei * der Laufwerksname aus der Umgebungsvariable ProgramFiles ist		 Gibt den Dateipfad zu einem Verzeichnis an, das benutzerdefinierte .sql-Dateien mit benutzerdefinierten Abfragen enthält, die das Plugin ausführen kann. Das Plugin lädt beim Start alle verfügbaren .sql-Dateien aus dem konfigurierten Verzeichnis. Das bedeutet, dass Änderungen an den Dateien mit den benutzerdefinierten Abfragen erst nach einem Neustart des Plugins wirksam werden. Das Plugin wird zusammen mit Zabbix Agent 2 gestartet und beendet.
Plugins.MSSQL.CustomQueriesEnabled no false Wenn gesetzt, wird die Ausführung des Item-Schlüssels mssql.custom.query aktiviert. Wenn deaktiviert, werden keine Abfragen aus dem Pfad des Verzeichnisses für benutzerdefinierte Abfragen geladen.
Plugins.MSSQL.Default.CACertPath no Der standardmäßige Dateipfad zum öffentlichen Schlüsselzertifikat der Zertifizierungsstelle (CA), die das Zertifikat des MSSQL-Servers ausgestellt hat. Das Zertifikat muss im PEM-Format vorliegen.
Plugins.MSSQL.Default.Database no Der standardmäßige Name der Datenbank, mit der verbunden werden soll.
Plugins.MSSQL.Default.Encrypt no Gibt den standardmäßigen Verschlüsselungstyp für die Verbindung an. Mögliche Werte sind:
true - die Datenübertragung zwischen Plugin und Server ist verschlüsselt;
false - die Datenübertragung zwischen Plugin und Server ist über das Login-Paket hinaus nicht verschlüsselt;
strict - die Datenübertragung zwischen Plugin und Server ist Ende-zu-Ende mit TDS8 verschlüsselt;
disable - die Datenübertragung zwischen Plugin und Server ist nicht verschlüsselt.
Plugins.MSSQL.Default.HostNameInCertificate no Der Common Name (CN) des Zertifikats des MSSQL-Servers standardmäßig.
Plugins.MSSQL.Default.Password no Das standardmäßig an einen geschützten MSSQL-Server zu sendende Passwort.
Plugins.MSSQL.Default.TLSMinVersion no Die standardmäßig zu verwendende minimale TLS-Version. Mögliche Werte sind: 1.0, 1.1, 1.2, 1.3.
Plugins.MSSQL.Default.TrustServerCertificate no Gibt an, ob das Plugin dem Serverzertifikat standardmäßig ohne Validierung vertrauen soll. Mögliche Werte: true, false.
Plugins.MSSQL.Default.Uri no sqlserver://localhost:1433 Die standardmäßige URI für die Verbindung. Das einzige unterstützte Schema ist sqlserver://. Ein Schema kann weggelassen werden. Eingebettete Anmeldedaten werden ignoriert.
Plugins.MSSQL.Default.User no Der standardmäßig an einen geschützten MSSQL-Server zu sendende Benutzername.
Plugins.MSSQL.KeepAlive no 60-900 300 Die maximale Wartezeit in Sekunden, bevor ungenutzte Plugin-Verbindungen geschlossen werden.
Plugins.MSSQL.Sessions.<SessionName>.CACertPath no Der Dateipfad zum öffentlichen Schlüsselzertifikat der Zertifizierungsstelle (CA), die das Zertifikat des MSSQL-Servers für die benannte Sitzung ausgestellt hat. Das Zertifikat muss im PEM-Format vorliegen.
<SessionName> - Name einer Sitzung, die in Item-Schlüsseln verwendet wird.
Plugins.MSSQL.Sessions.<SessionName>.Database no Der Datenbankname, mit der für die benannte Sitzung verbunden werden soll.
<SessionName> - Name einer Sitzung, die in Item-Schlüsseln verwendet wird.
Plugins.MSSQL.Sessions.<SessionName>.Encrypt no Gibt den Verschlüsselungstyp der Verbindung für die benannte Sitzung an. Mögliche Werte sind:
true - die Datenübertragung zwischen Plugin und Server ist verschlüsselt;
false - die Datenübertragung zwischen Plugin und Server ist über das Login-Paket hinaus nicht verschlüsselt;
strict - die Datenübertragung zwischen Plugin und Server ist Ende-zu-Ende mit TDS8 verschlüsselt;
disable - die Datenübertragung zwischen Plugin und Server ist nicht verschlüsselt.
<SessionName> - Name einer Sitzung, die in Item-Schlüsseln verwendet wird.
Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate no Der Common Name (CN) des Zertifikats des MSSQL-Servers für die benannte Sitzung.
<SessionName> - Name einer Sitzung, die in Item-Schlüsseln verwendet wird.
Plugins.MSSQL.Sessions.<SessionName>.Password no Das an einen geschützten MSSQL-Server für die benannte Sitzung zu sendende Passwort.
<SessionName> - Name einer Sitzung, die in Item-Schlüsseln verwendet wird.
Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion no Die für die benannte Sitzung zu verwendende minimale TLS-Version. Mögliche Werte sind: 1.0, 1.1, 1.2, 1.3.
<SessionName> - Name einer Sitzung, die in Item-Schlüsseln verwendet wird.
Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate no Gibt an, ob das Plugin dem Serverzertifikat für die benannte Sitzung ohne Validierung vertrauen soll. Mögliche Werte: true, false.
<SessionName> - Name einer Sitzung, die in Item-Schlüsseln verwendet wird.
Plugins.MSSQL.Sessions.<SessionName>.Uri no sqlserver://localhost:1433 Die URI für die Verbindung für die benannte Sitzung. Das einzige unterstützte Schema ist sqlserver://. Ein Schema kann weggelassen werden. Eingebettete Anmeldedaten werden ignoriert.
<SessionName> - Name einer Sitzung, die in Item-Schlüsseln verwendet wird.
Plugins.MSSQL.Sessions.<SessionName>.User no Der Benutzername, der für die benannte Sitzung an einen geschützten MSSQL-Server gesendet werden soll.
<SessionName> - Name einer Sitzung, die in Item-Schlüsseln verwendet wird.
Plugins.MSSQL.System.Path no Pfad zur ausführbaren MSSQL-Plugin-Datei.
Globale Einstellung für das MSSQL-Plugin. Wird auf alle Verbindungen angewendet.
Beispiel: Plugins.MSSQL.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-mssql
Plugins.MSSQL.Timeout no 1-30 global timeout Die Wartezeit in Sekunden, bis ein Server bei der ersten Verbindung und bei nachfolgenden Vorgängen in der Sitzung antwortet.

Siehe auch: