Plugin MSSQL

Panoramica

I parametri di configurazione consentono di personalizzare il comportamento del plugin MSSQL.

Si consiglia di specificarli in un file di configurazione separato (ad esempio mssql.conf), anziché nel file di configurazione di agent 2. Quindi usare la direttiva Include per includere questo file nella configurazione di Zabbix agent 2.

Il plugin MSSQL è un plugin caricabile ed è disponibile e descritto in modo completo nel repository del plugin MSSQL.

Tutti i parametri sono opzionali, a meno che non sia esplicitamente indicato che il parametro è obbligatorio.

Nota che:

  • I valori predefiniti riflettono i default del processo, non i valori presenti nei file di configurazione distribuiti.
  • I valori supportano variabili di ambiente;
  • Zabbix supporta file di configurazione solo in codifica UTF-8 senza BOM.
  • I commenti che iniziano con "#" sono supportati solo all'inizio della riga.

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

Opzioni

Parameter Description
-V --version Stampa la versione del plugin e le informazioni sulla licenza.
-h --help Stampa le informazioni di aiuto (scorciatoia).
-t, --test <item key> Avvia il plugin per il test (la configurazione del plugin viene ignorata).

Parametri

Parameter Mandatory Range Default Description
Plugins.MSSQL.CustomQueriesDir no /usr/local/share/zabbix/custom-queries/mssql per sistemi Unix

*:\Program Files\Zabbix Agent 2\Custom Queries\MSSQL per sistemi Windows, dove * è il nome dell'unità dalla variabile di ambiente ProgramFiles		 Specifica il percorso del file a una directory contenente file .sql definiti dall'utente con query personalizzate che il plugin può eseguire. Il plugin carica tutti i file .sql disponibili nella directory configurata all'avvio. Ciò significa che eventuali modifiche ai file di query personalizzate non verranno applicate finché il plugin non viene riavviato. Il plugin viene avviato e arrestato insieme a Zabbix agent 2.
Plugins.MSSQL.CustomQueriesEnabled no false Se impostato, abilita l'esecuzione della chiave item mssql.custom.query. Se disabilitato, non verrà caricato alcun query dal percorso della directory delle query personalizzate.
Plugins.MSSQL.Default.CACertPath no Il percorso predefinito del file al certificato della chiave pubblica dell'autorità di certificazione (CA) che ha emesso il certificato del server MSSQL. Il certificato deve essere in formato PEM.
Plugins.MSSQL.Default.Database no Il nome del database predefinito a cui connettersi.
Plugins.MSSQL.Default.Encrypt no Specifica il tipo di crittografia predefinito della connessione. I valori possibili sono:
true - l'invio dei dati tra plugin e server è crittografato;
false - l'invio dei dati tra plugin e server non è crittografato oltre il pacchetto di accesso;
strict - l'invio dei dati tra plugin e server è crittografato end-to-end usando TDS8;
disable - l'invio dei dati tra plugin e server non è crittografato.
Plugins.MSSQL.Default.HostNameInCertificate no Il nome comune (CN) del certificato del server MSSQL per impostazione predefinita.
Plugins.MSSQL.Default.Password no La password da inviare a un server MSSQL protetto per impostazione predefinita.
Plugins.MSSQL.Default.TLSMinVersion no La versione minima di TLS da usare per impostazione predefinita. I valori possibili sono: 1.0, 1.1, 1.2, 1.3.
Plugins.MSSQL.Default.TrustServerCertificate no Indica se il plugin deve considerare attendibile il certificato del server senza convalidarlo per impostazione predefinita. Valori possibili: true, false.
Plugins.MSSQL.Default.Uri no sqlserver://localhost:1433 L'URI predefinito a cui connettersi. L'unico schema supportato è sqlserver://. Lo schema può essere omesso. Le credenziali incorporate verranno ignorate.
Plugins.MSSQL.Default.User no Il nome utente predefinito da inviare a un server MSSQL protetto.
Plugins.MSSQL.KeepAlive no 60-900 300 Il tempo massimo di attesa (in secondi) prima che le connessioni del plugin inutilizzate vengano chiuse.
Plugins.MSSQL.Sessions.<SessionName>.CACertPath no Il percorso del file al certificato della chiave pubblica dell'autorità di certificazione (CA) che ha emesso il certificato del server MSSQL per la sessione specificata. Il certificato deve essere in formato PEM.
<SessionName> - definisce il nome di una sessione da usare nelle chiavi item.
Plugins.MSSQL.Sessions.<SessionName>.Database no Il nome del database a cui connettersi per la sessione specificata.
<SessionName> - definisce il nome di una sessione da usare nelle chiavi item.
Plugins.MSSQL.Sessions.<SessionName>.Encrypt no Specifica il tipo di crittografia della connessione per la sessione specificata. I valori possibili sono:
true - l'invio dei dati tra plugin e server è crittografato;
false - l'invio dei dati tra plugin e server non è crittografato oltre il pacchetto di accesso;
strict - l'invio dei dati tra plugin e server è crittografato end-to-end usando TDS8;
disable - l'invio dei dati tra plugin e server non è crittografato.
<SessionName> - definisce il nome di una sessione da usare nelle chiavi item.
Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate no Il nome comune (CN) del certificato del server MSSQL per la sessione specificata.
<SessionName> - definisce il nome di una sessione da usare nelle chiavi item.
Plugins.MSSQL.Sessions.<SessionName>.Password no La password da inviare a un server MSSQL protetto per la sessione specificata.
<SessionName> - definisce il nome di una sessione da usare nelle chiavi item.
Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion no La versione minima di TLS da usare per la sessione specificata. I valori possibili sono: 1.0, 1.1, 1.2, 1.3.
<SessionName> - definisce il nome di una sessione da usare nelle chiavi item.
Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate no Indica se il plugin deve considerare attendibile il certificato del server senza convalidarlo per la sessione specificata. Valori possibili: true, false.
<SessionName> - definisce il nome di una sessione da usare nelle chiavi item.
Plugins.MSSQL.Sessions.<SessionName>.Uri no sqlserver://localhost:1433 L'URI a cui connettersi, per la sessione specificata. L'unico schema supportato è sqlserver://. Lo schema può essere omesso. Le credenziali incorporate verranno ignorate.
<SessionName> - definisce il nome di una sessione da usare nelle chiavi item.
Plugins.MSSQL.Sessions.<SessionName>.User no Il nome utente da inviare a un server MSSQL protetto per la sessione specificata.
<SessionName> - definisce il nome di una sessione da usare nelle chiavi item.
Plugins.MSSQL.System.Path no Percorso dell'eseguibile del plugin MSSQL.
Impostazione globale per il plugin MSSQL. Applicata a tutte le connessioni.
Esempio di utilizzo: Plugins.MSSQL.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-mssql
Plugins.MSSQL.Timeout no 1-30 global timeout La durata, in secondi, da attendere affinché un server risponda durante la connessione iniziale e nelle operazioni successive nella sessione.

Vedi anche: