Documentation
Table of Contents
script.get
Descrição
integer/array script.get(object parameters)
O método permite recuperar scripts de acordo com os parâmetros fornecidos.
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.
Parâmetros
(object) Parâmetros que definem a saída desejada.
O método suporta os seguintes parâmetros.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| groupids | ID/array | Retorna apenas scripts que podem ser executados nos grupos de hosts fornecidos. |
| hostids | ID/array | Retorna apenas scripts que podem ser executados nos hosts fornecidos. |
| scriptids | ID/array | Retorna apenas scripts com os IDs fornecidos. |
| usrgrpids | ID/array | Retorna apenas scripts que podem ser executados por usuários nos grupos de usuários fornecidos. |
| selectHostGroups | query | Retorna uma propriedade hostgroups com grupos de hosts nos quais o script pode ser executado. |
| selectHosts | query | Retorna uma propriedade hosts com hosts nos quais o script pode ser executado. |
| selectActions | query | Retorna uma propriedade actions com ações às quais o script está associado. |
| sortfield | string/array | Ordena o resultado pelas propriedades fornecidas. Valores possíveis: scriptid, name. |
| countOutput | boolean | Esses parâmetros são descritos no comentário de referência. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean | |
| selectGroups (obsoleto) | query | Este parâmetro está obsoleto, por favor use selectHostGroups em seu lugar.Retorna uma propriedade groups com grupos de hosts nos quais o script pode ser executado. |
Valores de retorno
(integer/array) Retorna:
- uma array de objetos;
- a contagem de objetos recuperados, se o parâmetro
countOutputfoi usado.
Exemplos
Recuperar todos os scripts
Recupera todos os scripts configurados.
Resposta:
{ "jsonrpc": "2.0", "result": [ { "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": "2", "port": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "menu_path": "", "url": "", "new_window": "1", "manualinput": "0", "manualinput_prompt": "", "manualinput_validator": "", "manualinput_validator_type": "0", "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": "2", "port": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "menu_path": "", "url": "", "new_window": "1", "manualinput": "0", "manualinput_prompt": "", "manualinput_validator": "", "manualinput_validator_type": "0", "manualinput_default_value": "", "parameters": [] }, { "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": "2", "port": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "menu_path": "", "url": "", "new_window": "1", "manualinput": "0", "manualinput_prompt": "", "manualinput_validator": "", "manualinput_validator_type": "0", "manualinput_default_value": "", "parameters": [] }, { "scriptid": "4", "name": "Webhook", "command": "try {\n var request = new HttpRequest(),\n response,\n data;\n\n request.addHeader('Content-Type: application/json');\n\n response = request.post('https://localhost/post', value);\n\n try {\n response = JSON.parse(response);\n }\n catch (error) {\n response = null;\n }\n\n if (request.getStatus() !== 200 || !('data' in response)) {\n throw 'Unexpected response.';\n }\n\n data = JSON.stringify(response.data);\n\n Zabbix.log(3, '[Webhook Script] response data: ' + data);\n\n return data;\n}\ncatch (error) {\n Zabbix.log(3, '[Webhook Script] script execution failed: ' + error);\n throw 'Execution failed: ' + error + '.';\n}", "host_access": "2", "usrgrpid": "7", "groupid": "0", "description": "", "confirmation": "", "type": "5", "execute_on": "1", "timeout": "30s", "scope": "2", "port": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "menu_path": "", "url": "", "new_window": "1", "manualinput": "0", "manualinput_prompt": "", "manualinput_validator": "", "manualinput_validator_type": "0", "manualinput_default_value": "", "parameters": [ { "name": "token", "value": "{$WEBHOOK.TOKEN}" }, { "name": "host", "value": "{HOST.HOST}" }, { "name": "v", "value": "2.2" } ] }, { "scriptid": "5", "name": "URL", "command": "", "host_access": "2", "usrgrpid": "0", "groupid": "0", "description": "", "confirmation": "Go to {HOST.NAME}?", "type": "6", "execute_on": "1", "timeout": "30s", "scope": "4", "port": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "menu_path": "", "url": "http://zabbix/ui/zabbix.php?action=latest.view&hostids[]={HOST.ID}", "new_window": "0", "manualinput": "0", "manualinput_prompt": "", "manualinput_validator": "", "manualinput_validator_type": "0", "manualinput_default_value": "", "parameters": [] }, { "scriptid": "6", "name": "URL with user input", "command": "", "host_access": "2", "usrgrpid": "0", "groupid": "0", "description": "", "confirmation": "Open zabbix page {MANUALINPUT}?", "type": "6", "execute_on": "1", "timeout": "30s", "scope": "2", "port": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "menu_path": "", "url": "http://zabbix/ui/zabbix.php?action={MANUALINPUT}", "new_window": "0", "manualinput": "1", "manualinput_prompt": "Select a page to open:", "manualinput_validator": "dashboard.view,script.list,actionlog.list", "manualinput_validator_type": "1", "parameters": [] } ], "id": 1 }Veja também
Fonte
CScript::get() in ui/include/classes/api/services/CScript.php.