Oggetto azione

I seguenti oggetti sono direttamente correlati all'API action.

Azione

L'oggetto action ha le seguenti proprietà.

Proprietà Type Descrizione
actionid ID ID dell'azione.

Comportamento della proprietà:
- sola lettura
- obbligatoria per le operazioni di aggiornamento
esc_period string Durata predefinita del passo dell'operazione. Deve essere di almeno 60 secondi. Accetta secondi, un'unità di tempo con suffisso oppure una macro utente.

Comportamento della proprietà:
- supportata se eventsource è impostato su "evento creato da un trigger", "evento interno" oppure "evento creato all'aggiornamento dello stato del servizio"
eventsource integer Tipo di eventi che l'azione gestirà.

Fare riferimento alla proprietà source dell'evento per un elenco dei tipi di evento supportati.

Comportamento della proprietà:
- costante
- obbligatoria per le operazioni di creazione
name string Nome dell'azione.

Comportamento della proprietà:
- obbligatoria per le operazioni di creazione
status integer Indica se l'azione è abilitata o disabilitata.

Valori possibili:
0 - (predefinito) abilitata;
1 - disabilitata.
pause_symptoms integer Indica se mettere in pausa l'escalation se l'evento è un evento sintomo.

Valori possibili:
0 - Non mettere in pausa l'escalation per i problemi sintomo;
1 - (predefinito) Mettere in pausa l'escalation per i problemi sintomo.

Comportamento della proprietà:
- supportata se eventsource è impostato su "evento creato da un trigger"
pause_suppressed integer Indica se mettere in pausa l'escalation durante i periodi di manutenzione oppure no.

Valori possibili:
0 - Non mettere in pausa l'escalation;
1 - (predefinito) Mettere in pausa l'escalation.

Comportamento della proprietà:
- supportata se eventsource è impostato su "evento creato da un trigger"
notify_if_canceled integer Indica se inviare una notifica quando l'escalation viene annullata.

Valori possibili:
0 - Non inviare una notifica quando l'escalation viene annullata;
1 - (predefinito) Inviare una notifica quando l'escalation viene annullata.

Comportamento della proprietà:
- supportata se eventsource è impostato su "evento creato da un trigger"

Operazione dell'azione

L'oggetto operazione dell'azione definisce un'operazione che verrà eseguita quando un'azione viene eseguita. Ha le seguenti proprietà.

Property Type Description
operationtype integer Tipo di operazione.

Valori possibili:
0 - invia messaggio;
1 - script globale;
2 - aggiungi host;
3 - rimuovi host;
4 - aggiungi al gruppo host;
5 - rimuovi dal gruppo host;
6 - collega template;
7 - scollega template;
8 - abilita host;
9 - disabilita host;
10 - imposta la modalità di inventario dell'host;
13 - aggiungi tag host;
14 - rimuovi tag host.

Valori possibili se eventsource di Action object è impostato su "event created by a trigger" o "event created on service status update":
0 - "send message";
1 - "global script".

Valori possibili se eventsource di Action object è impostato su "internal event":
0 - "send message".

Property behavior:
- required
esc_period string Durata di un passaggio di escalation in secondi. Deve essere maggiore di 60 secondi. Accetta secondi, un'unità di tempo con suffisso o una macro utente. Se impostato a 0 o 0s, verrà utilizzato il periodo di escalation predefinito dell'azione.

Predefinito: 0s.

Property behavior:
- supported se eventsource di Action object è impostato su "event created by a trigger", "internal event" o "event created on service status update"
esc_step_from integer Passaggio da cui iniziare l'escalation.

Predefinito: 1.

Property behavior:
- supported se eventsource di Action object è impostato su "event created by a trigger", "internal event" o "event created on service status update"
esc_step_to integer Passaggio in cui terminare l'escalation.

Predefinito: 1.

Property behavior:
- supported se eventsource di Action object è impostato su "event created by a trigger", "internal event" o "event created on service status update"
evaltype integer Metodo di valutazione della condizione dell'operazione.

Valori possibili:
0 - (predefinito) And/Or;
1 - And;
2 - Or.
opcommand object Script globale da eseguire.

Lo script globale deve avere definita la proprietà scriptid.

Property behavior:
- required se operationtype è impostato su "global script"
opcommand_grp array Gruppi host su cui eseguire gli script globali.

I gruppi host devono avere definita la proprietà groupid.

Property behavior:
- required se operationtype è impostato su "global script" e opcommand_hst non è impostato
opcommand_hst array Host su cui eseguire gli script globali.

Gli host devono avere definita la proprietà hostid.

Property behavior:
- required se operationtype è impostato su "global script" e opcommand_grp non è impostato
opconditions array Condizioni dell'operazione utilizzate per le azioni dei trigger.

L'oggetto condizione dell'operazione è descritto in dettaglio di seguito.
opgroup array Gruppi host a cui aggiungere gli host.

I gruppi host devono avere definita la proprietà groupid.

Property behavior:
- required se operationtype è impostato su "add to host group" o "remove from host group"
opmessage object Oggetto contenente i dati del messaggio inviato dall'operazione.

L'oggetto messaggio dell'operazione è descritto in dettaglio di seguito.

Property behavior:
- required se operationtype è impostato su "send message"
opmessage_grp array Gruppi utenti a cui inviare messaggi.

I gruppi utenti devono avere definita la proprietà usrgrpid.

Property behavior:
- required se operationtype è impostato su "send message" e opmessage_usr non è impostato
opmessage_usr array Utenti a cui inviare messaggi.

Gli utenti devono avere definita la proprietà userid.

Property behavior:
- required se operationtype è impostato su "send message" e opmessage_grp non è impostato
optemplate array Template da collegare agli host.

I template devono avere definita la proprietà templateid.

Property behavior:
- required se operationtype è impostato su "link template" o "unlink template"
opinventory object Modalità di inventario da impostare per l'host.

L'inventario deve avere definita la proprietà inventory_mode.

Property behavior:
- required se operationtype è impostato su "set host inventory mode"
optag array Tag host da aggiungere o rimuovere.

I tag devono avere definita la proprietà tag.
La proprietà value è facoltativa.

Property behavior:
- supported se operationtype è impostato su "add host tags" o "remove host tags".

Messaggio dell'operazione dell'azione

L'oggetto del messaggio dell'operazione contiene i dati relativi al messaggio che verrà inviato dall'operazione. Ha le seguenti proprietà.

Proprietà Type Descrizione
default_msg integer Indica se utilizzare il testo e l'oggetto predefiniti del messaggio dell'azione.

Valori possibili:
0 - utilizzare i dati dell'operazione;
1 - (predefinito) utilizzare i dati del tipo di supporto.
mediatypeid ID ID del tipo di supporto che verrà utilizzato per inviare il messaggio.

Comportamento della proprietà:
- supportata se operationtype di Action operation object, Action recovery operation object o Action update operation object è impostato su "send message", oppure se operationtype di Action update operation object è impostato su "notify all involved"
message string Testo del messaggio dell'operazione.

Comportamento della proprietà:
- supportata se default_msg è impostato su "use the data from the operation"
subject string Oggetto del messaggio dell'operazione.

Comportamento della proprietà:
- supportata se default_msg è impostato su "use the data from the operation"

Condizione di operazione dell'azione

L'oggetto condizione di operazione dell'azione definisce una condizione che deve essere soddisfatta per eseguire l'operazione corrente. Ha le seguenti proprietà.

Property Type Description
conditiontype integer Tipo di condizione.

Valori possibili:
14 - evento riconosciuto.

Comportamento della proprietà:
- obbligatorio
value string Valore con cui confrontare.

Comportamento della proprietà:
- obbligatorio
operator integer Operatore della condizione.

Valori possibili:
0 - (predefinito) =

I seguenti operatori e valori sono supportati per ciascun tipo di condizione di operazione.

Condition Condition name Supported operators Expected value
14 Evento riconosciuto = Se l'evento è riconosciuto.

Valori possibili:
0 - non riconosciuto;
1 - riconosciuto.

Operazione di ripristino dell'azione

L'oggetto operazione di ripristino dell'azione definisce un'operazione che verrà eseguita quando un problema viene risolto. Le operazioni di ripristino sono possibili solo per azioni di trigger, interne e di servizio. Ha le seguenti proprietà.

Property Type Description
operationtype integer Tipo di operazione.

Valori possibili se eventsource dell'oggetto Action è impostato su "evento creato da un trigger" o "evento creato all'aggiornamento dello stato del servizio":
0 - invia messaggio;
1 - script globale;
11 - notifica tutti i coinvolti.

Valori possibili se eventsource dell'oggetto Action è impostato su "evento interno":
0 - invia messaggio;
11 - notifica tutti i coinvolti.

Comportamento della proprietà:
- obbligatoria
opcommand object Script globale da eseguire.

Lo script globale deve avere definita la proprietà scriptid.

Comportamento della proprietà:
- obbligatoria se operationtype è impostato su "script globale"
opcommand_grp array Gruppi di host su cui eseguire script globali.

I gruppi di host devono avere definita la proprietà groupid.

Comportamento della proprietà:
- obbligatoria se eventsource dell'oggetto Action è impostato su "evento creato da un trigger", operationtype è impostato su "script globale" e opcommand_hst non è impostato
opcommand_hst array Host su cui eseguire script globali.

Gli host devono avere definita la proprietà hostid.

Comportamento della proprietà:
- obbligatoria se eventsource dell'oggetto Action è impostato su "evento creato da un trigger", operationtype è impostato su "script globale" e opcommand_grp non è impostato
opmessage object Oggetto contenente i dati relativi al messaggio inviato dall'operazione di ripristino.

L'oggetto messaggio dell'operazione è descritto in dettaglio sopra.

Comportamento della proprietà:
- obbligatoria se operationtype è impostato su "invia messaggio"
opmessage_grp array Gruppi di utenti a cui inviare messaggi.

I gruppi di utenti devono avere definita la proprietà usrgrpid.

Comportamento della proprietà:
- obbligatoria se operationtype è impostato su "invia messaggio" e opmessage_usr non è impostato
opmessage_usr array Utenti a cui inviare messaggi.

Gli utenti devono avere definita la proprietà userid.

Comportamento della proprietà:
- obbligatoria se operationtype è impostato su "invia messaggio" e opmessage_grp non è impostato

Operazione di aggiornamento dell'azione

L'oggetto operazione di aggiornamento dell'azione definisce un'operazione che verrà eseguita quando un problema viene aggiornato (con un commento, confermato, con gravità modificata o chiuso manualmente). Le operazioni di aggiornamento sono possibili solo per le azioni di trigger e di servizio. Ha le seguenti proprietà.

Property Type Description
operationtype integer Tipo di operazione.

Valori possibili:
0 - invia messaggio;
1 - script globale;
12 - notifica tutti i soggetti coinvolti.

Property behavior:
- required
opcommand object Script globale da eseguire.

Lo script globale deve avere definita la proprietà scriptid.

Property behavior:
- required se operationtype è impostato su "script globale"
opcommand_grp array Gruppi di host sui quali eseguire gli script globali.

I gruppi di host devono avere definita la proprietà groupid.

Property behavior:
- required se eventsource dell'oggetto Action è impostato su "evento creato da un trigger", operationtype è impostato su "script globale" e opcommand_hst non è impostato
opcommand_hst array Host sui quali eseguire gli script globali.

Gli host devono avere definita la proprietà hostid.

Property behavior:
- required se eventsource dell'oggetto Action è impostato su "evento creato da un trigger", operationtype è impostato su "script globale" e opcommand_grp non è impostato
opmessage object Oggetto contenente i dati relativi al messaggio inviato dall'operazione di aggiornamento.

L'oggetto messaggio dell'operazione è descritto in dettaglio sopra.
opmessage_grp array Gruppi di utenti a cui inviare messaggi.

I gruppi di utenti devono avere definita la proprietà usrgrpid.

Property behavior:
- required se operationtype è impostato su "invia messaggio" e opmessage_usr non è impostato
opmessage_usr array Utenti a cui inviare messaggi.

Gli utenti devono avere definita la proprietà userid.

Property behavior:
- required se operationtype è impostato su "invia messaggio" e opmessage_grp non è impostato

Filtro dell'azione

L'oggetto filtro dell'azione definisce un insieme di condizioni che devono essere soddisfatte per eseguire le operazioni dell'azione configurata. Ha le seguenti proprietà.

Property Type Description
conditions array Insieme di condizioni del filtro da utilizzare per filtrare i risultati. Le condizioni saranno ordinate in base al loro posizionamento nella formula.

Property behavior:
- required
evaltype integer Metodo di valutazione delle condizioni del filtro.

Valori possibili:
0 - And/Or;
1 - And;
2 - Or;
3 - Espressione personalizzata.

Property behavior:
- required
eval_formula string Espressione generata che verrà utilizzata per valutare le condizioni del filtro. L'espressione contiene ID che fanno riferimento a specifiche condizioni del filtro tramite il relativo formulaid. Il valore di eval_formula è uguale al valore di formula per i filtri con un'espressione personalizzata.

Property behavior:
- read-only
formula string Espressione definita dall'utente da utilizzare per valutare le condizioni dei filtri con un'espressione personalizzata. L'espressione deve contenere ID che fanno riferimento a specifiche condizioni del filtro tramite il relativo formulaid. Gli ID utilizzati nell'espressione devono corrispondere esattamente a quelli definiti nelle condizioni del filtro: nessuna condizione può rimanere inutilizzata o essere omessa.

Property behavior:
- required se evaltype è impostato su "custom expression"

Condizione del filtro dell'azione

L'oggetto condizione del filtro dell'azione definisce una condizione specifica che deve essere verificata prima di eseguire le operazioni dell'azione.

Property Type Description
conditiontype integer Tipo di condizione.

Valori possibili se eventsource dell'oggetto Action è impostato su "evento creato da un trigger":
0 - gruppo host;
1 - host;
2 - trigger;
3 - nome evento;
4 - gravità del trigger;
6 - periodo di tempo;
13 - template host;
16 - il problema è soppresso;
25 - tag evento;
26 - valore del tag evento.

Valori possibili se eventsource dell'oggetto Action è impostato su "evento creato da una regola di discovery":
7 - IP host;
8 - tipo di servizio rilevato;
9 - porta del servizio rilevato;
10 - stato della discovery;
11 - durata di uptime o downtime;
12 - valore ricevuto;
18 - regola di discovery;
19 - controllo di discovery;
20 - proxy;
21 - oggetto di discovery.

Valori possibili se eventsource dell'oggetto Action è impostato su "evento creato da autoregistrazione active agent":
20 - proxy;
22 - nome host;
24 - metadati host.

Valori possibili se eventsource dell'oggetto Action è impostato su "evento interno":
0 - gruppo host;
1 - host;
13 - template host;
23 - tipo di evento;
25 - tag evento;
26 - valore del tag evento.

Valori possibili se eventsource dell'oggetto Action è impostato su "evento creato durante l'aggiornamento dello stato del servizio":
25 - tag evento;
26 - valore del tag evento;
27 - servizio;
28 - nome del servizio.

Comportamento della proprietà:
- required
value string Valore con cui confrontare.

Comportamento della proprietà:
- required
value2 string Valore secondario con cui confrontare.

Comportamento della proprietà:
- required se eventsource dell'oggetto Action è impostato su "evento creato da un trigger", conditiontype è impostato su uno qualsiasi dei valori possibili per le azioni trigger e il tipo di condizione (vedi sotto) è "26"
- required se eventsource dell'oggetto Action è impostato su "evento interno", conditiontype è impostato su uno qualsiasi dei valori possibili per le azioni interne e il tipo di condizione (vedi sotto) è "26"
- required se eventsource dell'oggetto Action è impostato su "evento creato durante l'aggiornamento dello stato del servizio", conditiontype è impostato su uno qualsiasi dei valori possibili per le azioni di servizio e il tipo di condizione (vedi sotto) è "26"
formulaid string ID univoco arbitrario utilizzato per fare riferimento alla condizione da un'espressione personalizzata. Può contenere solo lettere maiuscole. L'ID deve essere definito dall'utente durante la modifica delle condizioni del filtro, ma verrà generato nuovamente quando verranno richieste in seguito.
operator integer Operatore della condizione.

Valori possibili:
0 - (predefinito) uguale a;
1 - diverso da;
2 - contiene;
3 - non contiene;
4 - in;
5 - maggiore o uguale a;
6 - minore o uguale a;
7 - non in;
8 - corrisponde;
9 - non corrisponde;
10 - Sì;
11 - No.

Per comprendere meglio come utilizzare i filtri con vari tipi di espressioni, vedere gli esempi nelle pagine dei metodi action.get e action.create.

I seguenti operatori e valori sono supportati per ciascun tipo di condizione.

Condition Condition name Supported operators Expected value
0 Gruppo host uguale a,
diverso da		 ID del gruppo host.
1 Host uguale a,
diverso da		 ID host.
2 Trigger uguale a,
diverso da		 ID trigger.
3 Nome evento contiene,
non contiene		 Nome evento.
4 Gravità del trigger uguale a,
diverso da,
maggiore o uguale a,
minore o uguale a		 Gravità del trigger. Fare riferimento alla proprietà severity del trigger per un elenco delle gravità trigger supportate.
5 Valore del trigger uguale a Valore del trigger. Fare riferimento alla proprietà value del trigger per un elenco dei valori trigger supportati.
6 Periodo di tempo in, non in Ora in cui l'evento è stato attivato come periodo di tempo.
7 IP host uguale a,
diverso da		 Uno o più intervalli IP da controllare, separati da virgole. Fare riferimento alla sezione configurazione della network discovery per maggiori informazioni sui formati supportati degli intervalli IP.
8 Tipo di servizio rilevato uguale a,
diverso da		 Tipo di servizio rilevato. Il tipo di servizio corrisponde al tipo del controllo di discovery utilizzato per rilevare il servizio. Fare riferimento alla proprietà type del controllo di discovery per un elenco dei tipi supportati.
9 Porta del servizio rilevato uguale a,
diverso da		 Uno o più intervalli di porte, separati da virgole.
10 Stato della discovery uguale a Stato di un oggetto rilevato.

Valori possibili:
0 - host o servizio attivo;
1 - host o servizio non attivo;
2 - host o servizio rilevato;
3 - host o servizio perso.
11 Durata di uptime o downtime maggiore o uguale a,
minore o uguale a		 Tempo che indica da quanto il oggetto rilevato si trova nello stato corrente, in secondi.
12 Valori ricevuti uguale a,
diverso da,
maggiore o uguale a,
minore o uguale a,
contiene,
non contiene		 Valore restituito durante l'esecuzione di un controllo di discovery Zabbix agent, SNMPv1, SNMPv2 o SNMPv3.
13 Template host uguale a,
diverso da		 ID del template collegato.
16 Il problema è soppresso Sì, No Nessun valore richiesto: l'uso dell'operatore "Sì" significa che il problema deve essere soppresso, "No" - non soppresso.
18 Regola di discovery uguale a,
diverso da		 ID della regola di discovery.
19 Controllo di discovery uguale a,
diverso da		 ID del controllo di discovery.
20 Proxy uguale a,
diverso da		 ID del proxy.
21 Oggetto di discovery uguale a Tipo di oggetto che ha attivato l'evento di discovery.

Valori possibili:
1 - host rilevato;
2 - servizio rilevato.
22 Nome host contiene,
non contiene,
corrisponde,
non corrisponde		 Nome host.
L'uso di un'espressione regolare è supportato per gli operatori corrisponde e non corrisponde nelle condizioni di autoregistrazione.
23 Tipo di evento uguale a Evento interno specifico.

Valori possibili:
0 - item nello stato "non supportato";
1 - item nello stato "normale";
2 - regola LLD nello stato "non supportato";
3 - regola LLD nello stato "normale";
4 - trigger nello stato "sconosciuto";
5 - trigger nello stato "normale".
24 Metadati host contiene,
non contiene,
corrisponde,
non corrisponde		 Metadati dell'host autoregistrato.
L'uso di un'espressione regolare è supportato per gli operatori corrisponde e non corrisponde.
25 Tag uguale a,
diverso da,
contiene,
non contiene		 Tag evento.
26 Valore del tag uguale a,
diverso da,
contiene,
non contiene		 Valore del tag evento.
27 Servizio uguale a,
diverso da		 ID del servizio.
28 Nome del servizio uguale a,
diverso da		 Nome del servizio.