Wtyczka MSSQL

Omówienie

Parametry konfiguracyjne umożliwiają dostosowanie zachowania wtyczki MSSQL.

Zaleca się określanie ich w osobnym pliku konfiguracyjnym (np. mssql.conf), a nie w pliku konfiguracyjnym agenta 2. Następnie użyj dyrektywy Include, aby dołączyć ten plik do konfiguracji Zabbix agent 2.

Wtyczka MSSQL jest wtyczką ładowaną i jest dostępna oraz w pełni opisana w repozytorium wtyczki MSSQL.

Wszystkie parametry są opcjonalne, chyba że wyraźnie zaznaczono, że dany parametr jest obowiązkowy.

Należy pamiętać, że:

  • Wartości domyślne odzwierciedlają domyślne ustawienia procesu, a nie wartości w dostarczonych plikach konfiguracyjnych.
  • Wartości obsługują zmienne środowiskowe;
  • Zabbix obsługuje pliki konfiguracyjne wyłącznie w kodowaniu UTF-8 bez BOM.
  • Komentarze rozpoczynające się od "#" są obsługiwane tylko na początku wiersza.

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

Opcje

Parameter Description
-V --version Wyświetla wersję wtyczki i informacje o licencji.
-h --help Wyświetla informacje pomocy (skrót).
-t, --test <item key> Uruchamia wtyczkę do testowania (konfiguracja wtyczki jest ignorowana).

Parametry

Parameter Mandatory Range Default Description
Plugins.MSSQL.CustomQueriesDir no /usr/local/share/zabbix/custom-queries/mssql dla systemów Unix

*:\Program Files\Zabbix Agent 2\Custom Queries\MSSQL dla systemów Windows, gdzie * to nazwa dysku z zmiennej środowiskowej ProgramFiles		 Określa ścieżkę do katalogu zawierającego zdefiniowane przez użytkownika pliki .sql z niestandardowymi zapytaniami, które plugin może wykonywać. Plugin ładuje wszystkie dostępne pliki .sql z skonfigurowanego katalogu podczas uruchamiania. Oznacza to, że wszelkie zmiany w plikach niestandardowych zapytań nie zostaną uwzględnione do czasu ponownego uruchomienia pluginu. Plugin jest uruchamiany i zatrzymywany razem z Zabbix agent 2.
Plugins.MSSQL.CustomQueriesEnabled no false Jeśli ustawione, włącza wykonywanie klucza pozycja mssql.custom.query. Jeśli wyłączone, żadne zapytania nie będą ładowane z ścieżki katalogu niestandardowych zapytań.
Plugins.MSSQL.Default.CACertPath no Domyślna ścieżka do pliku certyfikatu klucza publicznego urzędu certyfikacji (CA), który wydał certyfikat serwera MSSQL. Certyfikat musi być w formacie PEM.
Plugins.MSSQL.Default.Database no Domyślna nazwa bazy danych, z którą należy się połączyć.
Plugins.MSSQL.Default.Encrypt no Określa domyślny typ szyfrowania połączenia. Dostępne wartości:
true - przesyłanie danych między pluginem a serwerem jest szyfrowane;
false - przesyłanie danych między pluginem a serwerem nie jest szyfrowane poza pakietem logowania;
strict - przesyłanie danych między pluginem a serwerem jest szyfrowane E2E przy użyciu TDS8;
disable - przesyłanie danych między pluginem a serwerem nie jest szyfrowane.
Plugins.MSSQL.Default.HostNameInCertificate no Domyślna nazwa pospolita (CN) certyfikatu serwera MSSQL.
Plugins.MSSQL.Default.Password no Domyślne hasło przekazywane do chronionego serwera MSSQL.
Plugins.MSSQL.Default.TLSMinVersion no Domyślna minimalna wersja TLS do użycia. Dostępne wartości: 1.0, 1.1, 1.2, 1.3.
Plugins.MSSQL.Default.TrustServerCertificate no Określa, czy plugin ma domyślnie ufać certyfikatowi serwera bez jego weryfikacji. Dostępne wartości: true, false.
Plugins.MSSQL.Default.Uri no sqlserver://localhost:1433 Domyślny URI połączenia. Jedynym obsługiwanym schematem jest sqlserver://. Schemat można pominąć. Osadzone poświadczenia zostaną zignorowane.
Plugins.MSSQL.Default.User no Domyślna nazwa użytkownika przekazywana do chronionego serwera MSSQL.
Plugins.MSSQL.KeepAlive no 60-900 300 Maksymalny czas oczekiwania (w sekundach) przed zamknięciem nieużywanych połączeń pluginu.
Plugins.MSSQL.Sessions.<SessionName>.CACertPath no Ścieżka do pliku certyfikatu klucza publicznego urzędu certyfikacji (CA), który wydał certyfikat serwera MSSQL dla nazwanej sesji. Certyfikat musi być w formacie PEM.
<SessionName> - zdefiniuj nazwę sesji do użycia w kluczach pozycja.
Plugins.MSSQL.Sessions.<SessionName>.Database no Nazwa bazy danych, z którą należy się połączyć dla nazwanej sesji.
<SessionName> - zdefiniuj nazwę sesji do użycia w kluczach pozycja.
Plugins.MSSQL.Sessions.<SessionName>.Encrypt no Określa typ szyfrowania połączenia dla nazwanej sesji. Dostępne wartości:
true - przesyłanie danych między pluginem a serwerem jest szyfrowane;
false - przesyłanie danych między pluginem a serwerem nie jest szyfrowane poza pakietem logowania;
strict - przesyłanie danych między pluginem a serwerem jest szyfrowane E2E przy użyciu TDS8;
disable - przesyłanie danych między pluginem a serwerem nie jest szyfrowane.
<SessionName> - zdefiniuj nazwę sesji do użycia w kluczach pozycja.
Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate no Domyślna nazwa pospolita (CN) certyfikatu serwera MSSQL dla nazwanej sesji.
<SessionName> - zdefiniuj nazwę sesji do użycia w kluczach pozycja.
Plugins.MSSQL.Sessions.<SessionName>.Password no Hasło przekazywane do chronionego serwera MSSQL dla nazwanej sesji.
<SessionName> - zdefiniuj nazwę sesji do użycia w kluczach pozycja.
Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion no Minimalna wersja TLS do użycia dla nazwanej sesji. Dostępne wartości: 1.0, 1.1, 1.2, 1.3.
<SessionName> - zdefiniuj nazwę sesji do użycia w kluczach pozycja.
Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate no Określa, czy plugin ma ufać certyfikatowi serwera bez jego weryfikacji dla nazwanej sesji. Dostępne wartości: true, false.
<SessionName> - zdefiniuj nazwę sesji do użycia w kluczach pozycja.
Plugins.MSSQL.Sessions.<SessionName>.Uri no sqlserver://localhost:1433 URI połączenia dla nazwanej sesji. Jedynym obsługiwanym schematem jest sqlserver://. Schemat można pominąć. Osadzone poświadczenia zostaną zignorowane.
<SessionName> - zdefiniuj nazwę sesji do użycia w kluczach pozycja.
Plugins.MSSQL.Sessions.<SessionName>.User no Nazwa użytkownika przekazywana do chronionego serwera MSSQL dla nazwanej sesji.
<SessionName> - zdefiniuj nazwę sesji do użycia w kluczach pozycja.
Plugins.MSSQL.System.Path no Ścieżka do pliku wykonywalnego pluginu MSSQL.
Ustawienie globalne dla pluginu MSSQL. Stosowane do wszystkich połączeń.
Przykład użycia: Plugins.MSSQL.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-mssql
Plugins.MSSQL.Timeout no 1-30 global timeout Czas oczekiwania, w sekundach, na odpowiedź serwera przy pierwszym połączeniu oraz podczas kolejnych operacji w sesji.

Zobacz także: