3 Script

Panoramica

Nella sezione Avvisi > Script è possibile configurare e gestire gli script globali definiti dall'utente.

Questo menu è disponibile solo per gli utenti di tipo SuperAdmin.

Gli script globali, in base all'ambito configurato e alle autorizzazioni dell'utente, sono disponibili per l'esecuzione:

• Dal menu dell'host in varie sezioni del frontend (Dashboard, Problemi, Ultimi dati, Mappe, ecc.).
• Dal menu dell'evento.
• Possono essere eseguiti come operazione di un'azione.

Gli script vengono eseguiti da Zabbix agent, Zabbix server (proxy) o esclusivamente da Zabbix server. Vedere anche Esecuzione dei comandi.

I comandi remoti sono disabilitati per impostazione predefinita sia su Zabbix agent sia su Zabbix proxy. Possono essere abilitati come segue:

• Per i comandi remoti eseguiti da Zabbix agent, aggiungere un parametro AllowKey=system.run[<command>,*] per ogni comando consentito nella configurazione dell'agent, dove * corrisponde a una delle modalità di esecuzione (wait o nowait).
• Per i comandi remoti eseguiti da Zabbix proxy, impostare il parametro EnableRemoteCommands su 1 nella configurazione del proxy. Tenere presente che non è necessario abilitare i comandi remoti su Zabbix proxy quando vengono eseguiti da Zabbix agent su un host monitorato dal proxy.

L'esecuzione degli script globali su Zabbix server può essere disabilitata impostando EnableGlobalScripts=0 nella configurazione del server. Per le nuove installazioni a partire da Zabbix 7.0, l'esecuzione degli script globali su Zabbix server è disabilitata per impostazione predefinita.

Viene visualizzato un elenco degli script esistenti con i relativi dettagli.

Dati visualizzati:

Per configurare un nuovo script, fare clic sul pulsante Crea script nell'angolo superiore destro.

Opzioni di modifica massiva

Un pulsante sotto l'elenco offre una opzione di modifica massiva:

• Elimina - elimina gli script

Per usare questa opzione, seleziona le caselle di controllo davanti agli script corrispondenti e fai clic su Elimina.

Uso del filtro

È possibile usare il filtro per visualizzare solo gli script di interesse. Per prestazioni di ricerca migliori, i dati vengono cercati con i macro non risolti.

Il link Filter è disponibile sopra l'elenco degli script. Se vi fai clic, viene visualizzato un filtro che consente di filtrare gli script per nome e ambito.

Configurazione di uno script globale

Attributi dello script:

Configurazione avanzata

Le opzioni di configurazione avanzata sono disponibili nella sezione comprimibile Configurazione avanzata:

Se sia l'input manuale dell'utente sia un messaggio di conferma sono configurati, verranno visualizzati in finestre popup consecutive.

Input utente manuale

L'input utente manuale consente di fornire un parametro personalizzato a ogni esecuzione dello script. In questo modo si evita la necessità di creare più script utente simili che differiscono solo per un singolo parametro.

Ad esempio, durante l'esecuzione potresti voler fornire allo script un numero intero diverso o un indirizzo URL diverso.

Per abilitare l'input utente manuale:

• utilizzare la macro {MANUALINPUT} nello script (comandi, script, parametro dello script) dove richiesto; oppure nel campo URL degli script URL;
• nella configurazione avanzata dello script, abilitare l'input utente manuale e configurare le opzioni di input.

Con l'input utente abilitato, prima dell'esecuzione dello script, all'utente verrà mostrato un popup Input manuale che richiederà di fornire un valore personalizzato. Il valore fornito sostituirà {MANUALINPUT} nello script.

A seconda della configurazione, all'utente verrà richiesto di inserire un valore stringa:

Oppure di selezionare il valore da un menu a discesa con opzioni predefinite:

L'input utente manuale è disponibile solo per gli script in cui l'ambito è 'Manual host action' o 'Manual event action'.

Esecuzione dello script e risultato

Gli script eseguiti dal server Zabbix vengono eseguiti nell'ordine descritto nella pagina sull'esecuzione dei comandi.

Il risultato dello script viene visualizzato in una finestra pop-up che appare dopo l'esecuzione dello script. Il valore restituito dallo script è l'output standard:

• Se lo script termina correttamente (codice di uscita 0), il valore restituito è limitato a 16 MB (inclusi gli spazi bianchi finali, che vengono troncati).
• Se lo script termina con un errore (codice di uscita diverso da zero), il valore restituito è l'errore standard, limitato a 2 KB.

Zabbix non memorizza per impostazione predefinita l'output esteso dello script. Per conservare tutti i dettagli dell'output, è possibile implementare la registrazione direttamente nello script (ad esempio, reindirizzando l'output a un file di log locale).

Si noti che per gli script eseguiti dal server Zabbix o dal proxy Zabbix si applicano anche i limiti del database.

Di seguito è riportato un esempio di script e della finestra dei risultati:

uname -v
/tmp/non_existing_script.sh
echo "This script was started by {USER.USERNAME}"

Il risultato dello script non visualizza lo script stesso.

Timeout dello script su Zabbix agent

Potresti incontrare una situazione in cui si verifica un timeout durante l'esecuzione di uno script.

Vedi un esempio di uno script in esecuzione su Zabbix agent e la finestra del risultato qui sotto:

sleep 5
df -h

Il messaggio di errore, in questo caso, è il seguente:

Timeout while executing a shell script.

Per evitare situazioni di questo tipo, si consiglia di ottimizzare lo script stesso (nell'esempio sopra, "5") invece di modificare il parametro Timeout nella configurazione di Zabbix agent e nella configurazione di Zabbix server.

Nel caso in cui il parametro Timeout sia stato modificato nella configurazione di Zabbix agent, verrà visualizzato il seguente messaggio di errore:

Get value from agent failed: ZBX_TCP_READ() timed out.

Ciò significa che la modifica è stata effettuata nella configurazione di Zabbix agent, ma è necessario modificare anche il parametro Timeout nella configurazione di Zabbix server.

Timeout dello script sugli agent attivi

È possibile eseguire script sugli agent che operano solo in modalità attiva (da Zabbix 7.0). Una volta che l'esecuzione dello script viene attivata da un'operazione dell'azione o dall'esecuzione manuale dello script, il comando viene incluso nella configurazione dei controlli attivi ed eseguito quando l'agent attivo lo riceve.

Gli script manuali vengono inviati all'agent attivo insieme al timeout di server/proxy per l'esecuzione dello script. Aumentare il timeout predefinito di server/proxy per l'esecuzione dello script. Il timeout deve essere superiore alla frequenza di aggiornamento dei controlli attivi, altrimenti il timeout viene superato prima che l'agent attivo riceva lo script e sia in grado di restituire il risultato.

Timeout dello script su Zabbix server/proxy

Vedi un esempio di script in esecuzione su Zabbix server e la finestra del risultato qui sotto:

sleep 11
df -h

Si consiglia inoltre di ottimizzare lo script stesso (anziché modificare il parametro TrapperTimeout impostandolo a un valore corrispondente (nel nostro caso, > 11) modificando la configurazione di Zabbix server).