script.execute

Beschrijving

object script.execute(objectparameters)

Met deze methode kan een script op een host of evenement worden uitgevoerd.

Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen, kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruiker rollen voor meer informatie.

Parameters

(object) Parameters met de ID van het uit te voeren script en ofwel de ID van de host of de ID van het evenement.

Parameter Type Beschrijving
scriptid
(vereist)		 string ID van het uit te voeren script.
hostid string ID van de host waarop het script moet worden uitgevoerd.
eventid string ID van de gebeurtenis waarop het script moet worden uitgevoerd.

Teruggegeven waarden

(object) Geeft het resultaat van scriptuitvoering weer.

Eigenschap Type Beschrijving
reactie string Geeft aan of het script succesvol is uitgevoerd.

Mogelijke waarde - succes.
waarde string Uitvoer van het script.
debug object Bevat een debug-object als een webhook-script wordt uitgevoerd. Voor andere scripttypen bevat het een leeg object.

Voorbeelden

Voer een webhook-script uit

Voer een webhook-script uit dat een HTTP-verzoek naar een externe service verzendt.

Verzoek:

{
    "jsonrpc": "2.0",
    "method": "script.execute",
    "params": {
        "scriptid": "4",
        "hostid": "30079"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Antwoord:

{
    "jsonrpc": "2.0",
    "result": {
        "response": "success",
        "value": "{\"status\":\"sent\",\"timestamp\":\"1611235391\"}",
        "debug": {
            "logs": [
                 {
                     "level": 3,
                     "ms": 480,
                     "message": "[Webhook Script] HTTP status: 200."
                 }
             ],
             "ms": 495
        }
    },
    "id": 1
}

Voer een aangepast script uit

Voer een "ping"-script uit op een host.

Verzoek:

{
    "jsonrpc": "2.0",
    "method": "script.execute",
    "params": {
        "scriptid": "1",
        "hostid": "30079"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Antwoord:

{
    "jsonrpc": "2.0",
    "result": {
        "response": "success",
        "value": "PING 127.0.0.1 (127.0.0.1) 56(84) bytes of data.\n64 bytes from 127.0.0.1: icmp_req=1 ttl=64 time=0.074 ms\n64 bytes from 127.0.0.1: icmp_req=2 ttl=64 time=0.030 ms\n64 bytes from 127.0.0.1: icmp_req=3 ttl=64 time=0.030 ms\n\n--- 127.0.0.1 ping statistics ---\n3 packets transmitted, 3 received, 0% packet loss, time 1998ms\nrtt min/avg/max/mdev = 0.030/0.044/0.074/0.022 ms\n",
        "debug": []
    },
    "id": 1
}

Bron

CScript::execute() in ui/include/classes/api/services/CScript.php.