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 solo 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>,*] o AllowKeyRegexp=^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. Si noti 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 accanto ai rispettivi script e fai clic su Elimina.

Uso del filtro

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

Il link Filter è disponibile sopra l'elenco degli script. Se lo si fa clic, diventa disponibile un filtro in cui è possibile 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 sono configurati sia l'input manuale dell'utente sia un messaggio di conferma, verranno visualizzati in finestre popup consecutive.

Input manuale dell'utente

L'input manuale dell'utente consente di fornire un parametro personalizzato a ogni esecuzione dello script. In questo modo non è necessario creare più script utente simili, che differiscono solo per un parametro.

Ad esempio, è possibile fornire allo script un intero diverso o un indirizzo URL diverso durante l'esecuzione.

Per abilitare l'input manuale dell'utente:

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

Con l'input dell'utente abilitato, prima dell'esecuzione dello script, all'utente verrà mostrata una finestra popup Input manuale che richiede 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 elenco a discesa di opzioni predefinite:

L'input manuale dell'utente è disponibile solo per gli script il cui ambito è "Azione manuale sull'host" o "Azione manuale sull'evento".

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 sull'agent Zabbix

È possibile che si verifichi un timeout durante l'esecuzione di uno script.

Di seguito è riportato un esempio di script in esecuzione sull'agent Zabbix e della 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 situazioni di questo tipo, si consiglia di ottimizzare lo script stesso (nell'esempio precedente, "5") invece di modificare il parametro Timeout nella configurazione dell'agent Zabbix e nella configurazione del server Zabbix.

Se il parametro Timeout è stato modificato nella configurazione dell'agent Zabbix, verrà visualizzato il seguente messaggio di errore:

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

Ciò significa che la modifica è stata apportata nella configurazione dell'agent Zabbix, ma è necessario modificare il parametro Timeout anche nella configurazione del server Zabbix.

Timeout dello script sugli agent attivi

È possibile eseguire script solo sugli agent in modalità attiva. Una volta che l'esecuzione dello script viene avviata dall'operazione dell'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 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 possa restituire il risultato.

Timeout dello script sul server/proxy Zabbix

Di seguito è riportato un esempio di script in esecuzione sul server Zabbix e la relativa finestra dei risultati:

sleep 11
df -h

È inoltre consigliabile ottimizzare lo script stesso, invece di modificare il parametro TrapperTimeout impostandolo su un valore corrispondente (nel nostro caso, > 11) modificando la configurazione del server Zabbix.