script.update

Descrição

object script.update(object/array scripts)

Este método permite atualizar scripts existentes.

Este método está disponível apenas para o tipo de usuário Super admin. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Consulte Funções de usuário para mais informações.

Parâmetros

(object/array) Propriedades do script a serem atualizadas.

A propriedade scriptid deve ser definida para cada script, todas as outras propriedades são opcionais. Somente as propriedades passadas serão atualizadas, todas as outras permanecerão inalteradas. Uma exceção é a alteração da propriedade type de 5 (Webhook) para outra: a propriedade parameters será limpa.

Valores de retorno

(object) Retorna um objeto contendo os IDs dos scripts atualizados na propriedade scriptids.

Exemplos

Alterar comando do script

Altere o comando do script para "/bin/ping -c 10 {HOST.CONN} 2>&1".

Requisição:

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

Alterar comando do script e adicionar entrada manual

Altere o comando do script para "/bin/ping -c {MANUALINPUT} {HOST.CONN} 2>&1".

Requisição:

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

Resposta:

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

Fonte

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