object script.getscriptsbyevents(object parameters)
Este método permite recuperar todos os scripts disponíveis para o evento fornecido ou um script específico se o ID do script for fornecido. Quando manualinput é fornecido, ele substitui a macro {MANUALINPUT} pelo valor especificado.
Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Veja Funções de usuário para mais informações.
(object/array) O método aceita um objeto ou array de objetos com os seguintes parâmetros.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| eventid | ID | ID do evento para retornar scripts. Deve ser único. Comportamento do parâmetro: - obrigatório |
| scriptid | ID | ID do script a ser retornado. |
| manualinput | string | Valor fornecido pelo usuário para o macro {MANUALINPUT}. |
(object) Retorna um objeto com os IDs de evento como propriedades e arrays de scripts disponíveis como valores. Se o ID do script for fornecido, o valor associado é um array contendo o script específico.
O método irá expandir automaticamente macros no texto de confirmation, no texto de manualinput prompt e na url.
Se o parâmetro manualinput for fornecido, a macro {MANUALINPUT} será resolvida para o valor especificado.
Recupere todos os scripts disponíveis para os eventos "632" e "614".
{ "jsonrpc": "2.0", "method": "script.getscriptsbyevents", "params": [ { "eventid": "632" }, { "eventid": "614" } ], "id": 1 }Resposta:
{ "jsonrpc": "2.0", "result": { "632": [ { "scriptid": "3", "name": "Detect operating system", "command": "sudo /usr/bin/nmap -O {HOST.CONN} 2>&1", "host_access": "2", "usrgrpid": "7", "groupid": "0", "description": "", "confirmation": "", "type": "0", "execute_on": "1", "timeout": "30s", "scope": "4", "port": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "menu_path": "", "url": "", "new_window": "1", "manualinput": "0", "manualinput_prompt": "", "manualinput_validator_type": "0", "manualinput_validator": "", "manualinput_default_value": "", "parameters": [] }, { "scriptid": "1", "name": "Ping", "command": "/bin/ping -c 3 {HOST.CONN} 2>&1", "host_access": "2", "usrgrpid": "0", "groupid": "0", "description": "", "confirmation": "", "type": "0", "execute_on": "1", "timeout": "30s", "scope": "4", "port": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "menu_path": "", "url": "", "new_window": "1", "manualinput": "0", "manualinput_prompt": "", "manualinput_validator_type": "0", "manualinput_validator": "", "manualinput_default_value": "", "parameters": [] }, { "scriptid": "4", "name": "Open Zabbix page", "command": "", "host_access": "2", "usrgrpid": "0", "groupid": "0", "description": "", "confirmation": "Are you sure you want to open page *UNKNOWN*?", "type": "6", "execute_on": "2", "timeout": "30s", "scope": "4", "port": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "menu_path": "", "url": "http://localhost/ui/zabbix.php?action=*UNKNOWN*", "new_window": "1", "manualinput": "1", "manualinput_prompt": "Zabbix page to open:", "manualinput_validator_type": "1", "manualinput_validator": "dashboard.view,discovery.view", "manualinput_default_value": "", "parameters": [] }, { "scriptid": "2", "name": "Traceroute", "command": "/usr/bin/traceroute {HOST.CONN} 2>&1", "host_access": "2", "usrgrpid": "0", "groupid": "0", "description": "", "confirmation": "", "type": "0", "execute_on": "1", "timeout": "30s", "scope": "4", "port": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "menu_path": "", "url": "", "new_window": "1", "manualinput": "0", "manualinput_prompt": "", "manualinput_validator_type": "0", "manualinput_validator": "", "manualinput_default_value": "", "parameters": [] } ], "614": [ { "scriptid": "3", "name": "Detect operating system", "command": "sudo /usr/bin/nmap -O {HOST.CONN} 2>&1", "host_access": "2", "usrgrpid": "7", "groupid": "0", "description": "", "confirmation": "", "type": "0", "execute_on": "1", "timeout": "30s", "scope": "4", "port": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "menu_path": "", "url": "", "new_window": "1", "manualinput": "0", "manualinput_prompt": "", "manualinput_validator_type": "1", "manualinput_validator": "", "manualinput_default_value": "", "parameters": [] }, { "scriptid": "1", "name": "Ping", "command": "/bin/ping -c 3 {HOST.CONN} 2>&1", "host_access": "2", "usrgrpid": "0", "groupid": "0", "description": "", "confirmation": "", "type": "0", "execute_on": "1", "timeout": "30s", "scope": "4", "port": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "menu_path": "", "url": "", "new_window": "1", "manualinput": "0", "manualinput_prompt": "", "manualinput_validator_type": "0", "manualinput_validator": "", "manualinput_default_value": "", "parameters": [] }, { "scriptid": "4", "name": "Open Zabbix page", "command": "", "host_access": "2", "usrgrpid": "0", "groupid": "0", "description": "", "confirmation": "Are you sure you want to open page *UNKNOWN*?", "type": "6", "execute_on": "2", "timeout": "30s", "scope": "4", "port": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "menu_path": "", "url": "http://localhost/ui/zabbix.php?action=*UNKNOWN*", "new_window": "1", "manualinput": "1", "manualinput_prompt": "Zabbix page to open:", "manualinput_validator_type": "1", "manualinput_validator": "dashboard.view,discovery.view", "manualinput_default_value": "", "parameters": [] }, { "scriptid": "2", "name": "Traceroute", "command": "/usr/bin/traceroute {HOST.CONN} 2>&1", "host_access": "2", "usrgrpid": "0", "groupid": "0", "description": "", "confirmation": "", "type": "0", "execute_on": "1", "timeout": "30s", "scope": "4", "port": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "menu_path": "", "url": "", "new_window": "1", "manualinput": "0", "manualinput_prompt": "", "manualinput_validator_type": "0", "manualinput_validator": "", "manualinput_default_value": "", "parameters": [] } ] }, "id": 1 }Recupere o script com ID "4" no evento "632" com valor manualinput "dashboard.view".
{ "jsonrpc": "2.0", "method": "script.getscriptsbyevents", "params": [ { "eventid": "632", "scriptid": "4", "manualinput": "dashboard.view" } ], "id": 1 }Resposta:
{ "jsonrpc": "2.0", "result": { "632": [ { "scriptid": "4", "name": "Open Zabbix page", "command": "", "host_access": "2", "usrgrpid": "0", "groupid": "0", "description": "", "confirmation": "Are you sure you want to open page dashboard.view?", "type": "6", "execute_on": "2", "timeout": "30s", "scope": "4", "port": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "menu_path": "", "url": "http://localhost/ui/zabbix.php?action=dashboard.view", "new_window": "1", "manualinput": "1", "manualinput_prompt": "Zabbix page to open:", "manualinput_validator_type": "1", "manualinput_validator": "dashboard.view,discovery.view", "manualinput_default_value": "", "parameters": [] } ] }, "id": 1 }CScript::getScriptsByEvents() em ui/include/classes/api/services/CScript.php.