Documentation
Table of Contents
script.get
Opis
integer/array script.get(object parameters)
Metoda umo?liwia pobranie skrypt¨®w zgodnie z podanymi parametrami.
Ta metoda jest dost?pna dla u?ytkownik¨®w dowolnego typu. Uprawnienia do jej wywo?ania mog? zosta? cofni?te w ustawieniach r¨®l u?ytkownika. Zobacz Role u?ytkownik¨®w , aby uzyska? wi?cej informacji.
Parametry
(object) Parametry definiuj?ce ??dany wynik.
Metoda obs?uguje nast?puj?ce parametry.
| Parametr | Typ | Opis |
|---|---|---|
| groupids | string/array | Zwr¨®? tylko skrypty, kt¨®re mo?na uruchomi? na podanych grupach host¨®w. |
| hostids | string/array | Zwr¨®? tylko skrypty, kt¨®re mo?na uruchomi? na podanych hostach. |
| scriptids | string/array | Zwr¨®? tylko skrypty o podanych identyfikatorach. |
| usrgrpids | string/array | Zwr¨®? tylko skrypty, kt¨®re mog? by? uruchamiane przez u?ytkownik¨®w w podanych grupach u?ytkownik¨®w. |
| selectGroups | query | Zwr¨®? w?a?ciwo?? groups z grupami host¨®w, na kt¨®rych mo?na uruchomi? skrypt. |
| selectHosts | query | Zwr¨®? w?a?ciwo?? hosts z hostami, na kt¨®rych mo?na uruchomi? skrypt. |
| selectActions | query | Zwr¨®? w?a?ciwo?? actions z akcjami, z kt¨®rymi skrypt jest powi?zany. |
| sortfield | string/array | Posortuj wyniki wed?ug podanych w?a?ciwo?ci. Mo?liwe warto?ci to: scriptid i name. |
| countOutput | boolean | Te parametry, b?d?ce wsp¨®lne dla wszystkich metod get, s? szczeg¨®?owo opisane na stronie komentarza referencyjnego. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Zwracane warto?ci
(integer/array) Zwraca jedn? z opcji:
- tablic? obiekt¨®w;
- liczb? pobranych obiekt¨®w, je?li parametr
countOutputzosta? wykorzystany.
Przyk?ady
Pobierz wszystkie skrypty
Pobierz wszystkie skonfigurowane skrypty.
Zapytanie:
{
"jsonrpc": "2.0",
"method": "script.get",
"params": {
"output": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Odpowied?:
{
"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",
"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",
"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",
"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 Áú»¢¶Ä²©.Log(3, '[Webhook Script] response data: ' + data);\n\n return data;\n}\ncatch (error) {\n Áú»¢¶Ä²©.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",
"parameters": [
{
"name": "token",
"value": "{$WEBHOOK.TOKEN}"
},
{
"name": "host",
"value": "{HOST.HOST}"
},
{
"name": "v",
"value": "2.2"
}
]
}
],
"id": 1
}Zobacz tak?e
?°ù¨®»å?´Ç
CScript::get() w ui/include/classes/api/services/CScript.php.