script.update

Descripción

object script.update(object/array scripts)

Este método permite actualizar los scripts existentes.

Este método solo está disponible para el tipo de usuario Super administrador. Los permisos para llamar al método se pueden revocar en la configuración de roles de usuario. Ver Roles de usuario para obtener más información.

Parámetros

(objeto/matriz) Propiedades del script que se actualizará.

La propiedad scriptid debe definirse para cada script, todas las demás propiedades son opcionales. Sólo se actualizarán las propiedades pasadas, todas las otras permanecerán sin cambios. Una excepción es el cambio de propiedad type de 5 (Webhook) a otro: se limpiará la propiedad parameters.

Valores de retorno

(objeto) Devuelve un objeto que contiene los ID de los scripts actualizados bajo la propiedad scriptids.

Ejemplos

Cambiar comando de script

Cambie el comando del script a "/bin/ping -c 10 {HOST.CONN} 2>&1".

Solicitud:

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

Respuesta:

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

Fuente

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

Documentation