event.acknowledge

Descrizione

object event.acknowledge(object/array parameters)

Questo metodo consente di aggiornare gli eventi. È possibile eseguire le seguenti azioni di aggiornamento:

  • Chiudere l'evento. Se l'evento è già risolto, questa azione verrà ignorata.
  • Acknowledge dell'evento. Se l'evento è già acknowledged, questa azione verrà ignorata.
  • Rimuovere l'acknowledge dell'evento. Se l'evento non è acknowledged, questa azione verrà ignorata.
  • Aggiungere un messaggio.
  • Modificare la severità dell'evento. Se l'evento ha già la stessa severità, questa azione verrà ignorata.
  • Sopprimere l'evento. Se l'evento è già soppresso, questa azione verrà ignorata.
  • Rimuovere la soppressione dell'evento. Se l'evento non è soppresso, questa azione verrà ignorata.
  • Modificare il rank dell'evento in causa. Se l'evento è già classificato come causa, questa azione verrà ignorata.
  • Modificare il rank dell'evento in sintomo. Se l'evento è già classificato come sintomo, questa azione verrà ignorata.

Possono essere aggiornati solo gli eventi di trigger.
Possono essere aggiornati solo gli eventi di problema.
Per chiudere l'evento o modificare la severità dell'evento sono necessari i diritti di lettura/scrittura per il trigger.
Per chiudere un evento, la chiusura manuale deve essere consentita nel trigger.

Questo metodo è disponibile per utenti di qualsiasi tipo. Le autorizzazioni per chiamare il metodo possono essere revocate nelle impostazioni del ruolo utente. Per ulteriori informazioni, vedere Ruoli utente.

Parametri

(object/array) Parametri contenenti gli ID degli eventi e le operazioni di aggiornamento che devono essere eseguite.

Parameter Type Description
eventids ID/array ID degli eventi da confermare.

Comportamento del parametro:
- required
action integer Azione/i di aggiornamento dell'evento.

Possibili valori bitmap:
1 - chiudi il problema;
2 - conferma evento;
4 - aggiungi messaggio;
8 - cambia severità;
16 - annulla conferma evento;
32 - sopprimi evento;
64 - rimuovi soppressione evento;
128 - cambia il rank dell'evento in causa;
256 - cambia il rank dell'evento in sintomo.

Questo è un campo bitmask; è accettabile qualsiasi somma dei possibili valori bitmap (ad esempio, 34 per confermare e sopprimere l'evento).

Comportamento del parametro:
- required
cause_eventid ID ID dell'evento in causa.

Comportamento del parametro:
- required se action contiene il bit "change event rank to symptom"
message string Testo del messaggio.

Comportamento del parametro:
- required se action contiene il bit "add message"
severity integer Nuova severità per gli eventi.

Valori possibili:
0 - non classificato;
1 - informazione;
2 - avviso;
3 - medio;
4 - alto;
5 - disastro.

Comportamento del parametro:
- required se action contiene il bit "change severity"
suppress_until integer Timestamp Unix fino al quale l'evento deve essere soppresso.

Se impostato a "0", la soppressione sarà indefinita.

Comportamento del parametro:
- required se action contiene il bit "suppress event"

Valori restituiti

(object) Restituisce un oggetto contenente gli ID degli eventi aggiornati nella proprietà eventids.

Esempi

Riconoscimento di un evento

Riconosci un singolo evento e lascia un messaggio.

Richiesta:

{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": "20427",
        "action": 6,
        "message": "Problema risolto."
    },
    "id": 1
}

Risposta:

{
    "jsonrpc": "2.0",
    "result": {
        "eventids": [
            "20427"
        ]
    },
    "id": 1
}

Modifica della gravità dell'evento

Modificare la gravità per più eventi e lasciare un messaggio.

Richiesta:

{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": ["20427", "20428"],
        "action": 12,
        "message": "Maintenance required to fix it.",
        "severity": 4
    },
    "id": 1
}

Risposta:

{
    "jsonrpc": "2.0",
    "result": {
        "eventids": [
            "20427",
            "20428"
        ]
    },
    "id": 1
}

Sopprimere un evento indefinitamente

Sopprimere un singolo evento senza una data di scadenza.

Richiesta:

{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": "20427",
        "action": 32,
        "suppress_until": 0
    },
    "id": 1
}

Risposta:

{
    "jsonrpc": "2.0",
    "result": {
        "eventids": [
            20427
        ]
    },
    "id": 1
}

Riattivazione della soppressione di un evento

Rimuove la soppressione di un singolo evento precedentemente soppresso.

Richiesta:

{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": "20427",
        "action": 64
    },
    "id": 1
}

Risposta:

{
    "jsonrpc": "2.0",
    "result": {
        "eventids": [
            20427
        ]
    },
    "id": 1
}

Confermare e sopprimere un evento

Conferma uno o più eventi, aggiungi un messaggio e sopprimili nella stessa richiesta.

Richiesta:

{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": [
            "20427",
            "20428"
        ],
        "action": 38,
        "message": "Suppressing during planned maintenance.",
        "suppress_until": 0
    },
    "id": 1
}

Risposta:

{
    "jsonrpc": "2.0",
    "result": {
        "eventids": [
            20427,
            20428
        ]
    },
    "id": 1
}

Fonte

CEvent::acknowledge() in ui/include/classes/api/services/CEvent.php.