script.update

Descripció

object script.update(object/array scripts)

Aquest mètode permet actualitzar scripts existents.

Tenim aquest mètode disponible només per a l'usuari Super admin. Els permisos per cridar el mètode es poden revocar a la configuració dels rols d'usuari. Per a més informació, veieu Rols d'usuari.

Paràmetres

(object/array) Propietats de l'script per actualitzar.

La propietat scriptid s'ha d'establir per a cada script, totes les altres propietats són opcionals. Només s'actualitzaran les propietats aprovades, totes les altres romandran sense canvis. Una excepció és canviar la propietat type de 5 (Webhook) a una altra: la propietat parameters es netejarà.

Valors de retorn

(object) Torna un objecte que contingui els IDs dels scripts actualitzats sota la propietat scriptids.

Exemples

Canviar la comanda d'un script

Canviar la comanda d'un script a "/bin/ping -c 10 {HOST.CONN} 2>&1".

Petició:

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

Resposta:

{
           "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
       }

Font

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

Documentation