script.update

Beschrijving

object script.update(object/array scripts)

Deze methode maakt het mogelijk om bestaande scripts bij te werken.

Deze methode is alleen beschikbaar voor gebruikers van het type Super admin. Toestemming om de methode aan te roepen kan worden ingetrokken in de gebruikersrolinstellingen. Zie Gebruikersrollen voor meer informatie.

Parameters

(object/array) Scripteigenschappen die moeten worden bijgewerkt.

De eigenschap scriptid moet voor elk script worden gedefinieerd, alle andere eigenschappen zijn optioneel. Alleen de doorgegeven eigenschappen worden bijgewerkt, allemaal andere blijven ongewijzigd. Een uitzondering is type eigenschap wijziging van 5 (Webhook) naar andere: de eigenschap parameters wordt opgeschoond.

Retourwaarden

(object) Retourneert een object dat de ID's van de bijgewerkte scripts bevat onder de eigenschap 'scriptids'.

Voorbeelden

Wijzigen van scriptopdracht

Wijzig de opdracht van het script naar "/bin/ping -c 10 {HOST.CONN} 2>&1".

Request:

{
           "jsonrpc": "2.0",
           "method": "script.update",
           "params": {
               "scriptid": "1",
               "command": "/bin/ping -c 10 {HOST.CONN} 2>&1"
           },
           "id": 1
       }

Reactie:

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

Change script command and add manual input

Change the command of the script to "/bin/ping -c {MANUALINPUT} {HOST.CONN} 2>&1".

Request:

{
           "jsonrpc": "2.0",
           "method": "script.update",
           "params": {
             "scriptid": "1",
             "command": "/bin/ping -c {MANUALINPUT} {HOST.CONN} 2>&1",
             "manualinput": "1",
             "manualinput_prompt": "Specify the number of ICMP packets to send with the ping command",
             "manualinput_validator": "^(?:[1-9]|10)$",
             "manualinput_validator_type": "0",
             "manualinput_default_value": "10"
           },
           "id": 1
       }

Response:

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

Bron

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

Documentation