script.update

Description

object script.update(object/array scripts)

Cette méthode permet de mettre à jour des scripts existants.

Paramètres

(object/array) Propriétés du script à mettre à jour.

La propriété scriptid doit être définie pour chaque script, toutes les autres propriétés sont facultatives. Seules les propriétés transmises seront mises à jour, toutes les autres resteront inchangées. Une exception est le changement de la propriété type de 5 (Webhook) à other : la propriété parameters sera nettoyée.

Valeurs retournées

(object) Retourne un objet contenant les identifiants des scripts mis à jour sous la propriété scriptids.

Exemples

Modifier la commande du script

Modifiez la commande du script en "/bin/ping -c 10 {HOST.CONN} 2>&1".

Requête:

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

Réponse :

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

Modifier la commande du script et ajouter une entrée manuelle

Modifiez la commande du script en "/bin/ping -c {MANUALINPUT} {HOST.CONN} 2>&1".

Requête :

{
    "jsonrpc": "2.0",
    "method": "script.update",
    "params": {
      "scriptid": "1",
      "command": "/bin/ping -c {MANUALINPUT} {HOST.CONN} 2>&1",
      "manualinput": "1",
      "manualinput_prompt": "Indiquez le nombre de paquets ICMP à envoyer avec la commande ping",
      "manualinput_validator": "^(?:[1-9]|10)$",
      "manualinput_validator_type": "0",
      "manualinput_default_value": "10"
    },
    "id": 1
}

Réponse :

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

Source

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