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 da eseguire.

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

Comportamento del parametro:
- obbligatorio
action integer Azione o azioni di aggiornamento dell'evento.

Valori bitmap possibili:
1 - chiudere il problema;
2 - riconoscere l'evento;
4 - aggiungere un messaggio;
8 - modificare la gravità;
16 - annullare il riconoscimento dell'evento;
32 - sopprimere l'evento;
64 - annullare la soppressione dell'evento;
128 - modificare la classificazione dell'evento in causa;
256 - modificare la classificazione dell'evento in sintomo.

Questo è un campo con maschera di bit; è accettabile qualsiasi somma dei valori bitmap possibili (ad esempio, 6 per riconoscere un evento e lasciare un messaggio, oppure 34 per riconoscere e sopprimere un evento).

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

Comportamento del parametro:
- obbligatorio se action contiene il bit "modificare la classificazione dell'evento in sintomo"
message string Testo del messaggio.

Comportamento del parametro:
- obbligatorio se action contiene il bit "aggiungere un messaggio"
severity integer Nuova gravità per gli eventi.

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

Comportamento del parametro:
- obbligatorio se action contiene il bit "modificare la gravità"
suppress_until integer Timestamp Unix fino al quale l'evento deve essere soppresso.

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

Comportamento del parametro:
- obbligatorio se action contiene il bit "sopprimere l'evento"

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.