3 Script

Panoramica

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

Gli script globali, a seconda dell'ambito configurato e anche dei permessi utente, sono disponibili per l'esecuzione:

• dal menu host in varie posizioni del frontend (Dashboard, Problemi, Ultimi dati, Mappe, ecc.)
• dal menu evento
• possono essere eseguiti come operazione di un'azione

Gli script vengono eseguiti su Zabbix agent, Zabbix server (proxy) oppure solo su Zabbix server. Vedere anche Esecuzione dei comandi.

Sia su Zabbix agent sia su Zabbix proxy gli script remoti sono disabilitati per impostazione predefinita. Possono essere abilitati come segue:

• Per i comandi remoti eseguiti su Zabbix agent:
  • aggiungendo un parametro AllowKey=system.run[<command>,*] per ciascun comando consentito nella configurazione dell'agent, dove * indica la modalità wait e nowait;
• Per i comandi remoti eseguiti su Zabbix proxy:
  • Avviso: non è necessario abilitare i comandi remoti su Zabbix proxy se i comandi remoti vengono eseguiti su Zabbix agent monitorato da Zabbix proxy. Tuttavia, se è necessario eseguire comandi remoti su Zabbix proxy, impostare il parametro EnableRemoteCommands su '1' nella configurazione del 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 Create script nell'angolo superiore destro.

Opzioni di modifica di massa

Un pulsante sotto l'elenco offre un'opzione di modifica di massa:

• Delete - elimina gli script

Per utilizzare questa opzione, seleziona le caselle di controllo davanti ai rispettivi script e fai clic su Delete.

Utilizzo del filtro

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

Il link Filtro è disponibile sopra l'elenco degli script. Facendo clic su di esso, 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 in una sezione comprimibile Configurazione avanzata:

Se sono configurati sia l'input utente manuale sia un messaggio di conferma, 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 da Zabbix server 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 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.

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

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

Di seguito è riportato un esempio di script e della finestra del risultato:

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

Il risultato dello script non mostra lo script stesso.

Timeout dello script su Zabbix agent

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

Di seguito è riportato un esempio di uno script in esecuzione su Zabbix agent e la relativa finestra dei risultati:

sleep 5
df -h

In questo caso, il messaggio di errore è il seguente:

Timeout while executing a shell script.

Per evitare tali situazioni, 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 degli script sugli agent attivi

È possibile eseguire gli script solo sugli agent che operano in modalità attiva. Una volta che l'esecuzione dello script viene attivata da una operazione di un'azione o dall'esecuzione manuale dello script, il comando viene incluso nella configurazione dei controlli attivi ed eseguito non appena l'agent attivo lo riceve.

Gli script manuali vengono inviati all'agent attivo insieme al timeout del server/proxy per l'esecuzione dello script. Aumentare il timeout predefinito del 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

Di seguito è riportato un esempio di uno script in esecuzione su Zabbix server e la finestra del risultato:

sleep 11
df -h

Si consiglia inoltre di ottimizzare lo script stesso (invece di regolare il parametro TrapperTimeout su un valore corrispondente (nel nostro caso, > 11) modificando la configurazione di Zabbix server).