Esegui

Funzione

Esegue un comando o uno script shell inline (bash, perl, python) sul collector configurato per il job o su un host remoto specificato dall'indirizzo IP del dispositivo tramite ssh. Il comando da eseguire può essere inserito tramite il percorso del comando con argomenti facoltativi o tramite uno script inline.

Allarmi

Running time, Exit code, Return value <0-n>, String value <0-n>

I job Execute possono essere creati/modificati solo da utenti di tipo Administrator poiché consentono di eseguire codice arbitrario sullo SKOOR Collector o sul server (nel caso del collector locale).
L'eseguibile o il codice inserito nella casella di testo inline viene eseguito con i permessi dell'utente eranger. Pertanto è possibile eseguire solo comandi limitati, a meno che l'amministratore Linux (root) non abiliti comandi aggiuntivi utilizzando ad esempio sudo.

Dettagli di Execute

Selezionando la casella di controllo Execute remotely, la finestra di dialogo cambia e consente di inserire la porta ssh e le credenziali per eseguire il comando o lo script in remoto:

I job eseguiti in remoto non possono inviare file di allarme al server. I file possono essere elaborati solo sul collector, non sui sistemi remoti

Selezionando il pulsante di opzione Inline script, la finestra di dialogo cambia e consente di inserire il codice di scripting all'interno di una casella di testo più ampia:

Parametri di Execute

Parametro

Descrizione

Execute remotely

Attivare questa casella di controllo per eseguire il comando o lo script tramite ssh

SSH port

La porta TCP su cui è in ascolto il server ssh

Username

Un account utente esistente sulla macchina remota

Password

Una password corretta per l'account utente sulla macchina remota

Execute

Program:
Esegue un singolo eseguibile

Inline Script:
Esegue un intero script (sequenza di comandi), consentendo di inviare l'output dello script ai singoli valori di ritorno, valori stringa e al messaggio informativo

Program path

Il percorso assoluto del comando (script o binario) da eseguire

Inline script

Una casella di testo in cui è possibile inserire comandi e interi script. Gli Inline script vengono eseguiti per impostazione predefinita utilizzando la shell /bin/sh, ma tramite funzioni di inclusione preesistenti (vedere sotto) è possibile utilizzare lo scripting bash, perl e python (vedere sotto). Un vantaggio dell'aggiunta di script all'interno di Inline script è che vengono memorizzati nel database di configurazione di SKOOR e non è necessario gestire codice esterno a livello di file system.

I commenti possono essere inseriti con il carattere cancelletto (#).

Argument <n>

È possibile passare uno o più argomenti al comando. Fare clic sul pulsante + per aggiungere ulteriori argomenti.

Save output to file

Per impostazione predefinita, il nome del file inserito qui viene memorizzato in /var/opt/run/eranger/collector/tmp sullo SKOOR Engine Collector e conterrà lo standard output e/o lo standard error del comando. Si consiglia vivamente di utilizzare un nome file univoco, ad esempio utilizzando il tag $ID$ che verrà sostituito dall'ID del job (es. my_output_$ID$.out). Se si utilizzano nomi di file semplici, può accadere che più job scrivano sullo stesso file 

Suppress running time

Se questa casella di controllo è abilitata, il tempo di esecuzione di ogni controllo viene ignorato e non salvato nel database e il suo valore non è più visibile nella sezione dei valori. Il suo valore non è inoltre più disponibile per l'uso nelle specifiche dei limiti di allarme.

Exit code

Il pulsante Unit consente di specificare un nome per il codice di uscita dell'eseguibile, nonché un'unità, un divisore, una descrizione e la precisione numerica.

Return values

Consente di aggiungere un numero qualsiasi di valori di ritorno facendo clic sul pulsante +. Per ciascuno dei valori di ritorno viene visualizzato un pulsante Unit che consente di specificare il nome del valore di ritorno, nonché l'unità, il divisore, la descrizione e la precisione numerica (il numero di cifre decimali). Se non vengono definiti valori di ritorno, viene letto solo il codice di uscita.

String values

Consente di aggiungere un numero qualsiasi di valori stringa facendo clic sul pulsante +. Per ciascuno dei valori stringa viene visualizzato un pulsante Unit che consente di specificare il nome del valore stringa, nonché l'unità e la descrizione. Utilizzare solo per un insieme limitato di stringhe statiche note, non per stringhe che cambiano molto spesso (che contengono ad es. data e ora).

L'elenco a discesa Tags consente di inserire variabili predefinite nei campi precedenti, ad es. $NAME$ per il nome del job.

La directory di lavoro per l'esecuzione dello script è /var/opt/run/eranger/collector; pertanto, specificando un percorso di file relativo come bin/script.sh all'interno di Inline script o Program path, si farà riferimento a /var/opt/run/eranger/collector/bin/script.sh.

Funzioni di inclusione Execute per bash, perl e python

Selezionando il pulsante di opzione Inline script è possibile inserire uno script nell'ampia casella di testo. Sono supportati i linguaggi di scripting bash, perl e python. Il job Execute offre varie funzioni di inclusione per questi linguaggi per mappare l'output dello script sui valori di ritorno, sui valori stringa e sul messaggio informativo. Per poter utilizzare queste funzioni, è necessario includerle prima posizionando il cursore sulla prima riga della casella di testo Inline script e selezionando la funzione di inclusione corrispondente per uno dei 3 linguaggi di scripting dall'elenco a discesa Tags:

Ad esempio, aggiungendo la voce della funzione di inclusione sh/bash viene aggiunto il seguente codice a Inline script:

Ora è possibile utilizzare le seguenti funzioni all'interno dello script per mappare valori numerici e stringhe sui valori di ritorno, sui valori stringa e sul messaggio informativo:

Funzione

Descrizione

setErangerValue

Mappa un singolo valore numerico su un valore di ritorno identificato dal relativo indice (1-n)

setErangerValues

Mappa più valori numerici su più valori di ritorno, aggiungendo valori di ritorno in base al numero di valori di input specificati

setErangerStringValue

Mappa una singola stringa su un valore stringa identificato dal relativo indice (1-n)

setErangerStringValues

Mappa più stringhe su valori stringa, aggiungendo valori stringa in base al numero di stringhe di input specificate

setErangerInfoMessage

Mappa un valore numerico o una stringa sul contenuto del messaggio informativo del job

addErangerInfoMessage

Aggiunge un valore numerico o una stringa al contenuto del messaggio informativo del job

getLastErangerValue

Ottiene il valore dall'ultima misurazione tramite indice (1-n). Se non è disponibile alcuna misurazione precedente, la funzione restituirà 0

getLastErangerStringValue

Ottiene il valore stringa dall'ultima misurazione tramite indice (1-n). La funzione restituirà una stringa vuota se non è disponibile alcuna misurazione precedente

outputErangerValues

Se vengono aggiunti valori di ritorno, valori stringa o contenuti del messaggio informativo utilizzando le funzioni precedenti, questa funzione deve essere aggiunta come ultimo elemento dello script

Valori e limiti di allarme Execute

Valore / Limite di allarme

Descrizione

Running time

Il tempo impiegato per eseguire il comando o lo script (a meno che non sia disabilitato selezionando il parametro Suppress running time)

Exit code

Il codice di uscita del comando o dello script

Return value <0-n>

Un valore numerico con precisione intera o in virgola mobile. È possibile definire limiti di allarme su tutti i valori di ritorno configurati.

String value <0-n>

Un valore stringa. Utilizzare solo per un insieme limitato di stringhe statiche note, non per stringhe che cambiano molto spesso (che contengono ad es. data e ora). È possibile definire limiti di allarme su tutti i valori stringa configurati.

Error code

Codice di errore generico del job (vedere la sezione Codici di errore dei job)

Esempi Execute

Esempio 1 - Eseguire un singolo comando con più argomenti da riga di comando

I seguenti parametri eseguiranno il comando sudo per avviare uno script che riavvia il servizio report in SKOOR Engine:

Non è necessario definire alcun valore di ritorno o valore stringa; verrà verificato solo il codice di uscita del comando combinato.

Output 1

Se per qualche motivo il comando non dovesse funzionare, inserire un nome file nella casella di testo del parametro Save output to file:

Lo standard output e/o lo standard error del comando verranno reindirizzati in tale file, che può essere visualizzato dalla sezione dei valori del job:

Fare clic sul pulsante Update file; il nome del file si trasforma in un collegamento:

Fare clic sul collegamento per visualizzare l'output del comando in una scheda o finestra separata del browser:

Running /opt/eranger/bin/eRanger.sh with root privileges...
eRanger Server installation...
waiting up to 15 seconds for 7090 to terminate 

Stopping eranger-report[  OK  ]
Starting eranger-report[  OK  ]

Esempio 2 - Eseguire un Inline script con funzioni di inclusione bash

Contenuto della casella di testo Inline script per un semplice calcolo di un numero casuale:

. /opt/eranger/collector/eranger_exec_values.sh

newValue=$RANDOM
lastValue=$(getLastErangerValue 1)

diffValue=$(expr $newValue - $lastValue)

setErangerValues $newValue $diffValue
outputErangerValues

È necessario definire due valori di ritorno come configurato in Inline script. Nell'esempio seguente sono stati definiti New Value e Difference:

Facendo clic sul pulsante Unit è possibile specificare i dettagli del valore:

Output 2

Esempio 3 - Eseguire uno script inline con funzioni di inclusione bash utilizzando le proprietà personalizzate del job come variabili di script

L'esempio seguente esegue uno script specificato come variabile con argomenti di script passati da una proprietà personalizzata. Lo script scarica un file specificato (argomento 2) da un server FTP (argomento 1).

La proprietà personalizzata per gli argomenti della riga di comando deve essere definita prima tramite il menu Admin. Fare clic sul pulsante Admin nell'angolo in alto a destra della vista di configurazione, quindi selezionare Custom properties dall'elenco a discesa Search:


Fare clic sul pulsante + nella parte inferiore della schermata. Viene visualizzata una sezione Newly added properties:

Assegnare un nome alla proprietà personalizzata, quindi specificare che questa proprietà personalizzata deve essere disponibile solo per gli oggetti job:

Fare clic su Apply, quindi individuare l'ID della proprietà appena aggiunta passando il mouse sul relativo nome:

Uscire dal menu Admin facendo nuovamente clic sul pulsante Admin nell'angolo in alto a destra. La proprietà personalizzata è ora disponibile per essere aggiunta a qualsiasi job.

Aggiungerla al job Execute e inserire i parametri della riga di comando per lo script a cui si fa riferimento in Inline script:

In questo caso sono presenti 2 argomenti della riga di comando, delimitati da uno spazio.

Ora aggiungere il contenuto della casella di testo Inline script:

. /opt/eranger/collector/eranger_exec_values.sh

SCRIPT="/var/opt/run/eranger/bin/ftp_download_local.sh"

PARAMS="$OID_74$"

VALUE=$(${SCRIPT} ${PARAMS})
setErangerValue 1 $VALUE
outputErangerValues

Quindi aggiungere 1 valore di ritorno:

Lo script restituisce la velocità di download FTP in kB/s, quindi è necessario aggiungere un divisore per convertire in MBit/s.

Il vantaggio principale dell'utilizzo delle proprietà personalizzate per passare gli argomenti è che è possibile riutilizzare lo stesso blocco di codice Inline script per molti job tramite un modello di job (vedere la sezione Template) modificando solo la proprietà personalizzata tra i vari job.

Output 3

Esempio 4 - Eseguire uno script inline con funzioni di inclusione bash utilizzando una chiamata ssh remota

Il seguente Inline script esegue un comando in remoto utilizzando il comando ssh. Si presuppone che l'autenticazione ssh sia già configurata utilizzando chiavi pubbliche senza password, in modo che non venga richiesta alcuna password durante la connessione al server ssh remoto.

Il comando legge il numero di processi ddclient in esecuzione in remoto. Viene utilizzata la variabile interna $DEVICE_ADDRESS$.

. /opt/eranger/collector/eranger_exec_values.sh

cmd="ps -u root | grep 'ddclient - ' | wc -l"
num_procs=$(ssh -o ConnectTimeout=15 -o ConnectionAttempts=1 eranger@$DEVICE_ADDRESS$ "$cmd")

setErangerValue 1 $num_procs
outputErangerValues

Aggiungere 1 valore di ritorno:

Output 4

Esempio 5 - Eseguire un comando in remoto tramite ssh

L'esempio seguente utilizza la casella di controllo Execute remotely per poter inserire le credenziali di autenticazione ssh ed eseguire un comando su una macchina remota:

Quando si esegue in remoto non è possibile utilizzare valori di ritorno o valori stringa; viene verificato solo il codice di uscita.

Output 5

Esempio 6 - Eseguire una query WMI su un server Windows 2000 e leggerne il registro eventi

Utilizzare il seguente Inline script:

. /opt/eranger/collector/eranger_exec_values.sh

# this does a wmi query to windows 2000 servers
# for server 2003 upwards, use the dedicated "Agent Eventlog"
# job plugin directly.
# for the query to work, port tcp135 and the portrange tcp1025-tcp65535 
# must be accessible from this collector to the remote windows server

# BEWARE: when querying the eventlog for lots of events, especially events
# of severity 3, the query can take a very long time, sometimes hours.
# However, the maximum allowed runtime of a SKOOR execute job is merely 5
# minutes after which the job will kill this script and exit with a warning

# login credentials for wmi query (needs to be either an administrator 
# account or must have sufficient privileges to do remote wmi queries

USER=skoor
PWD=<fill in password here>

# Filter parameters (uncomment only parameters that are used)

# Logfile can be \'Application\', \'Security', 
# \'System\', or e.g. \'CustomEventLog\'
Logfile=\'Application\'

# Event source (always enclose in \'....\')
SourceName=\'FEP\'

# Event ID
#EventCode=203

# Severity (1=Error, 2=Warning, 3=Information, 
# 4=Security Audit Success, 5=Security Audit Failure)
EventType=1

# Event description (find events that contain the following string(s) 
# anywhere in the event description)
#Message='string1'
#Message='string1|string2' (for filtering multiple strings inside message field, use pipe delimiter)
Message='WSAECONNREFUSED'

# search only events which have been logged
# during the last XXX minutes (always adapt 
# to job execution interval)
Maxage=3

################################################3

Maxagesec=$((Maxage*60))
Tepoch=$(date +%s)
Tstart=$((Tepoch-Maxagesec))
# get start time in UTC
Tstart_datetime=\'$(date -u -d @$Tstart +%Y%m%d%H%M00.000000+000)\'

# construct query
Query="Select Logfile,Message,RecordNumber from Win32_NTLogEvent where Logfile=${Logfile} and TimeWritten>${Tstart_datetime}"
[ ! -z "${SourceName}" ] && Query+=" and SourceName=${SourceName}"
[ ! -z "${EventCode}" ] && Query+=" and EventCode=${EventCode}"
[ ! -z "${EventType}" ] && Query+=" and EventType=${EventType}"
echo "WMI Query is ${Query}"

wmic -U ${USER}%${PWD} //$DEVICE_ADDRESS$ "${Query}" > $DEVICE_NAME$_$ID$_eventlog.out
RC=$?

if [ ! -z "${Message}" ]; then
   Eventcount=$(grep -v dcerpc_connect $DEVICE_NAME$_$ID$_eventlog.out | grep -v 'Login to remote object' | egrep ${Message} | wc -l)
else
   Eventcount=$(grep -v dcerpc_connect $DEVICE_NAME$_$ID$_eventlog.out | grep -v 'Login to remote object' | wc -l)
fi

setErangerValue 1 $Eventcount
setErangerValue 2 $RC
outputErangerValues

Quindi aggiungere 2 valori di ritorno:


Output 6

Esempio 7 - Download wget con terminazione automatica dopo 45 secondi

Utilizzare la seguente notazione per assicurarsi che il comando esterno (wget in questo caso) venga terminato automaticamente se rimane in esecuzione per più di 45 secondi:

(sleep 45; kill -9 -$$) &
wget -O /dev/null http://www.debian.org/netinst.iso