MSSQL spraudnis

Pārskats

Konfigurācijas parametri ļauj pielāgot MSSQL spraudņa darbību.

Ieteicams tos norādīt atsevišķā konfigurācijas failā (piem., mssql.conf), nevis aģents 2 konfigurācijas failā. Pēc tam izmantojiet direktīvu Include, lai iekļautu šo failu Zabbix aģents 2 konfigurācijā.

MSSQL spraudnis ir ielādējams spraudnis, un tas ir pieejams, kā arī pilnībā aprakstīts MSSQL spraudņa repozitorijā.

Visi parametri ir neobligāti, ja vien nav skaidri norādīts, ka parametrs ir obligāts.

Ņemiet vērā:

  • Noklusējuma vērtības atspoguļo procesa noklusējumus, nevis vērtības piegādātajos konfigurācijas failos.
  • Vērtības atbalsta vides mainīgos;
  • Zabbix atbalsta konfigurācijas failus tikai UTF-8 kodējumā bez BOM.
  • Komentāri, kas sākas ar "#", tiek atbalstīti tikai rindas sākumā.

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

Opcijas

Parameter Description
-V --version Izdrukā spraudņa versiju un licences informāciju.
-h --help Izdrukā palīdzības informāciju (saīsināti).
-t, --test <item key> Palaiž spraudni testēšanai (spraudņa konfigurācija tiek ignorēta).

Parametri

Parameter Mandatory Range Default Description
Plugins.MSSQL.CustomQueriesDir no /usr/local/share/zabbix/custom-queries/mssql Unix sistēmām

*:\Program Files\Zabbix Agent 2\Custom Queries\MSSQL Windows sistēmām, kur * ir diska nosaukums no vides mainīgā ProgramFiles		 Norāda faila ceļu uz direktoriju, kurā ir lietotāja definēti .sql faili ar pielāgotiem vaicājumiem, ko spraudnis var izpildīt. Spraudnis startēšanas laikā ielādē visus pieejamos .sql failus konfigurētajā direktorijā. Tas nozīmē, ka jebkuras izmaiņas pielāgoto vaicājumu failos netiks atspoguļotas, līdz spraudnis tiks restartēts. Spraudnis tiek palaists un apturēts kopā ar Zabbix aģents 2.
Plugins.MSSQL.CustomQueriesEnabled no false Ja ir iestatīts, iespējo mssql.custom.query vienums atslēgas izpildi. Ja ir atspējots, no pielāgoto vaicājumu direktorija ceļa netiks ielādēti nekādi vaicājumi.
Plugins.MSSQL.Default.CACertPath no Noklusējuma faila ceļš uz sertifikācijas iestādes (CA) publiskās atslēgas sertifikātu, kas izdevusi MSSQL servera sertifikātu. Sertifikātam jābūt PEM formātā.
Plugins.MSSQL.Default.Database no Noklusējuma datubāzes nosaukums, ar ko izveidot savienojumu.
Plugins.MSSQL.Default.Encrypt no Norāda noklusējuma savienojuma šifrēšanas tipu. Iespējamās vērtības ir:
true - datu sūtīšana starp spraudni un serveris ir šifrēta;
false - datu sūtīšana starp spraudni un serveris nav šifrēta ārpus pieteikšanās paketes;
strict - datu sūtīšana starp spraudni un serveris ir šifrēta E2E, izmantojot TDS8;
disable - datu sūtīšana starp spraudni un serveris nav šifrēta.
Plugins.MSSQL.Default.HostNameInCertificate no Pēc noklusējuma MSSQL servera sertifikāta kopējais nosaukums (CN).
Plugins.MSSQL.Default.Password no Parole, kas pēc noklusējuma tiks nosūtīta aizsargātam MSSQL serveris.
Plugins.MSSQL.Default.TLSMinVersion no Pēc noklusējuma izmantojamā minimālā TLS versija. Iespējamās vērtības: 1.0, 1.1, 1.2, 1.3.
Plugins.MSSQL.Default.TrustServerCertificate no Vai spraudnim pēc noklusējuma vajadzētu uzticēties serveris sertifikātam, to nepārbaudot. Iespējamās vērtības: true, false.
Plugins.MSSQL.Default.Uri no sqlserver://localhost:1433 Noklusējuma URI savienojuma izveidei. Vienīgā atbalstītā shēma ir sqlserver://. Shēmu var arī nenorādīt. Iegultie akreditācijas dati tiks ignorēti.
Plugins.MSSQL.Default.User no Pēc noklusējuma lietotājvārds, kas tiks nosūtīts aizsargātam MSSQL serveris.
Plugins.MSSQL.KeepAlive no 60-900 300 Maksimālais gaidīšanas laiks (sekundēs) pirms neizmantotie spraudņa savienojumi tiek aizvērti.
Plugins.MSSQL.Sessions.<SessionName>.CACertPath no Faila ceļš uz sertifikācijas iestādes (CA) publiskās atslēgas sertifikātu, kas izdevusi MSSQL servera sertifikātu norādītajai sesijai. Sertifikātam jābūt PEM formātā.
<SessionName> - definē sesijas nosaukumu izmantošanai vienums atslēgās.
Plugins.MSSQL.Sessions.<SessionName>.Database no Datubāzes nosaukums, ar ko izveidot savienojumu norādītajai sesijai.
<SessionName> - definē sesijas nosaukumu izmantošanai vienums atslēgās.
Plugins.MSSQL.Sessions.<SessionName>.Encrypt no Norāda savienojuma šifrēšanas tipu norādītajai sesijai. Iespējamās vērtības ir:
true - datu sūtīšana starp spraudni un serveris ir šifrēta;
false - datu sūtīšana starp spraudni un serveris nav šifrēta ārpus pieteikšanās paketes;
strict - datu sūtīšana starp spraudni un serveris ir šifrēta E2E, izmantojot TDS8;
disable - datu sūtīšana starp spraudni un serveris nav šifrēta.
<SessionName> - definē sesijas nosaukumu izmantošanai vienums atslēgās.
Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate no MSSQL servera sertifikāta kopējais nosaukums (CN) norādītajai sesijai.
<SessionName> - definē sesijas nosaukumu izmantošanai vienums atslēgās.
Plugins.MSSQL.Sessions.<SessionName>.Password no Parole, kas tiks nosūtīta aizsargātam MSSQL serveris norādītajai sesijai.
<SessionName> - definē sesijas nosaukumu izmantošanai vienums atslēgās.
Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion no Minimālā TLS versija, kas jāizmanto norādītajai sesijai. Iespējamās vērtības: 1.0, 1.1, 1.2, 1.3.
<SessionName> - definē sesijas nosaukumu izmantošanai vienums atslēgās.
Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate no Vai spraudnim vajadzētu uzticēties serveris sertifikātam, to nepārbaudot, norādītajai sesijai. Iespējamās vērtības: true, false.
<SessionName> - definē sesijas nosaukumu izmantošanai vienums atslēgās.
Plugins.MSSQL.Sessions.<SessionName>.Uri no sqlserver://localhost:1433 URI savienojuma izveidei norādītajai sesijai. Vienīgā atbalstītā shēma ir sqlserver://. Shēmu var arī nenorādīt. Iegultie akreditācijas dati tiks ignorēti.
<SessionName> - definē sesijas nosaukumu izmantošanai vienums atslēgās.
Plugins.MSSQL.Sessions.<SessionName>.User no Lietotājvārds, kas tiks nosūtīts aizsargātam MSSQL serveris norādītajai sesijai.
<SessionName> - definē sesijas nosaukumu izmantošanai vienums atslēgās.
Plugins.MSSQL.System.Path no Ceļš uz MSSQL spraudņa izpildāmo failu.
Globāls iestatījums MSSQL spraudnim. Tiek piemērots visiem savienojumiem.
Lietošanas piemērs: Plugins.MSSQL.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-mssql
Plugins.MSSQL.Timeout no 1-30 global timeout Laiks sekundēs, cik ilgi gaidīt, līdz serveris atbild, veidojot pirmo savienojumu un veicot turpmākās darbības sesijā.

Skatiet arī: