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. Utilizzare quindi 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 facoltativi, a meno che non sia esplicitamente indicato che il parametro è obbligatorio.

Questa pagina è strutturata come segue:

  • Panoramica dei parametri (per vedere i dettagli completi di un parametro, fare clic sul suo nome)
  • Dettagli dei parametri
Parameter Description
Plugins.MSSQL.CustomQueriesDir Specifica il percorso della directory contenente i file .sql definiti dall'utente con query personalizzate che il plugin può eseguire.
Plugins.MSSQL.CustomQueriesEnabled Abilita l'esecuzione della chiave item mssql.custom.query.
Plugins.MSSQL.Default.CACertPath Specifica il percorso predefinito del file del certificato della chiave pubblica dell'autorità di certificazione (CA) che ha emesso il certificato del server MSSQL.
Plugins.MSSQL.Default.Database Specifica il nome del database predefinito.
Plugins.MSSQL.Default.Encrypt Specifica il livello di crittografia predefinito.
Plugins.MSSQL.Default.HostNameInCertificate Specifica per impostazione predefinita il nome comune (CN) del certificato del server MSSQL.
Plugins.MSSQL.Default.Password Specifica la password predefinita.
Plugins.MSSQL.Default.TLSMinVersion Specifica per impostazione predefinita la versione minima di TLS.
Plugins.MSSQL.Default.TrustServerCertificate Considera attendibile il certificato del server senza convalidarlo, per impostazione predefinita.
Plugins.MSSQL.Default.Uri Specifica l'URI predefinito.
Plugins.MSSQL.Default.User Specifica il nome utente predefinito.
Plugins.MSSQL.KeepAlive Specifica il tempo massimo di attesa (in secondi) prima della chiusura delle connessioni del plugin non utilizzate.
Plugins.MSSQL.Sessions.<SessionName>.CACertPath Specifica il percorso del file della sessione denominata del certificato della chiave pubblica dell'autorità di certificazione (CA) che ha emesso il certificato del server MSSQL.
Plugins.MSSQL.Sessions.<SessionName>.Database Specifica il nome del database della sessione denominata.
Plugins.MSSQL.Sessions.<SessionName>.Encrypt Specifica il livello di crittografia della sessione denominata.
Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate Specifica il nome comune (CN) del certificato del server MSSQL per la sessione denominata.
Plugins.MSSQL.Sessions.<SessionName>.Password Specifica la password della sessione denominata.
Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion Specifica la versione minima di TLS della sessione denominata.
Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate Considera attendibile il certificato del server della sessione denominata senza convalidarlo.
Plugins.MSSQL.Sessions.<SessionName>.Uri Specifica l'URI della sessione denominata.
Plugins.MSSQL.Sessions.<SessionName>.User Specifica il nome utente della sessione denominata.
Plugins.MSSQL.System.Path Specifica il percorso dell'eseguibile del plugin MSSQL.
Plugins.MSSQL.Timeout Imposta la durata, in secondi, dell'attesa di una risposta da un server durante la connessione iniziale e nelle operazioni successive nella sessione.

Si noti che:

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

Dettagli del parametro

Plugins.MSSQL.CustomQueriesDir

Specifica il percorso della directory contenente i 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.

Valori predefiniti:
/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)

Plugins.MSSQL.CustomQueriesEnabled

Abilita l'esecuzione della chiave item mssql.custom.query.
Se disabilitato, non verranno caricate query dal percorso della directory delle query personalizzate.

Predefinito: false
Intervallo: true/false

Plugins.MSSQL.Default.CACertPath

Specifica il percorso file predefinito del 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

Specifica il nome del database predefinito.

Plugins.MSSQL.Default.Encrypt

Specifica il livello di crittografia predefinito.

Intervallo:
true - i dati inviati tra il plugin e il server sono crittografati;
false - i dati inviati tra il plugin e il server non sono crittografati oltre il pacchetto di accesso;
strict - i dati inviati tra il plugin e il server sono crittografati end-to-end usando TDS8;
disable - i dati inviati tra il plugin e il server non sono crittografati.

Plugins.MSSQL.Default.HostNameInCertificate

Specifica per impostazione predefinita il nome comune (CN) del certificato del server MSSQL.

Plugins.MSSQL.Default.Password

Specificare la password predefinita per un server MSSQL protetto.

Plugins.MSSQL.Default.TLSMinVersion

Specifica la versione minima di TLS predefinita.

Intervallo: 1.0, 1.1, 1.2, 1.3

Plugins.MSSQL.Default.TrustServerCertificate

Considera attendibile il certificato del server senza convalidarlo per impostazione predefinita.

Intervallo: true, false

Plugins.MSSQL.Default.Uri

Specifica l'URI predefinito per la connessione al server MSSQL.
Le credenziali incorporate verranno ignorate.
L'unico schema supportato è sqlserver://.
Lo schema può essere omesso.

Predefinito: sqlserver://localhost:1433

Plugins.MSSQL.Default.User

Specifica il nome utente predefinito per un server MSSQL protetto.

Plugins.MSSQL.KeepAlive

Specifica il tempo massimo di attesa (in secondi) prima che le connessioni del plugin non utilizzate vengano chiuse.

Predefinito: 300
Intervallo: 60-900

Plugins.MSSQL.Sessions.<SessionName>.CACertPath

Specifica il percorso del file della sessione denominata verso il certificato della chiave pubblica dell'autorità di certificazione (CA) che ha emesso il certificato del server MSSQL.
<SessionName> - definisce il nome di una sessione da usare nelle chiavi degli item.
Il certificato deve essere in formato PEM.

Plugins.MSSQL.Sessions.<SessionName>.Database

Specifica il nome del database della sessione denominata.
<SessionName> - definisce il nome di una sessione da usare nelle chiavi degli item.

Plugins.MSSQL.Sessions.<SessionName>.Encrypt

Specifica il livello di crittografia della sessione denominata.
<SessionName> - definisce il nome di una sessione da usare nelle chiavi degli item.

Intervallo:
true - i dati inviati tra il plugin e il server sono crittografati;
false - i dati inviati tra il plugin e il server non sono crittografati oltre il pacchetto di accesso;
strict - i dati inviati tra il plugin e il server sono crittografati end-to-end usando TDS8;
disable - i dati inviati tra il plugin e il server non sono crittografati.

Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate

Specifica il nome comune (CN) del certificato del server MSSQL per la sessione denominata.
<SessionName> - definisce il nome di una sessione da usare nelle chiavi degli item.

Plugins.MSSQL.Sessions.<SessionName>.Password

Specifica la password della sessione denominata per un server MSSQL protetto.
<SessionName> - definisce il nome di una sessione da usare nelle chiavi degli item.

Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion

Specifica la versione minima TLS della sessione denominata.
<SessionName> - definisce il nome di una sessione da usare nelle chiavi degli item.

Intervallo: 1.0, 1.1, 1.2, 1.3

Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate

Fidati del certificato del server della sessione specificata senza convalidarlo.
<SessionName> - definisce il nome di una sessione da usare nelle chiavi degli item.

Intervallo: true, false

Plugins.MSSQL.Sessions.<SessionName>.Uri

Specifica l'URI della sessione denominata per la connessione al server MSSQL.
<SessionName> - definisce il nome di una sessione da usare nelle chiavi degli item.
Le credenziali incorporate verranno ignorate.
L'unico schema supportato è sqlserver://.
Lo schema può essere omesso.

Predefinito: sqlserver://localhost:1433

Plugins.MSSQL.Sessions.<SessionName>.User

Specifica il nome utente della sessione denominata per un server MSSQL protetto.
<SessionName> - definisce il nome di una sessione da usare nelle chiavi degli item.

Plugins.MSSQL.System.Path

Specifica il percorso dell'eseguibile del plugin MSSQL.
Impostazione globale per il plugin MSSQL. Applicata a tutte le connessioni.

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

Plugins.MSSQL.Timeout

Imposta la durata, in secondi, da attendere affinché un server risponda durante la prima connessione e nelle operazioni successive della sessione.

Predefinito: global timeout
Intervallo: 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).

Vedi anche