script.get

Опис

integer/array script.get(object parameters)

Ова метода омогућава преузимање скрипти према датим параметрима.

Овај метод је доступан корисницима било које врсте. Дозволе за позивање методе може се опозвати у подешавањима улоге корисника. Погледајте Корисничке улоге за више информација.

Параметри

(object) Параметри који дефинишу жељени излаз.

Метод подржава следеће параметре.

Parameter Type Description
groupids ID/array Враћа само скрипте које се могу покренути на датим групама домаћина.
hostids ID/array Враћа само скрипте које се могу покренути на датим домаћинима.
scriptids ID/array Враћа само скрипте са датим ID-ијевима.
usrgrpids ID/array Враћа само скрипте које могу да покрећу корисници у датим групама корисника.
сselectHostGroups query Враћа својство hostgroups са групама домаћина на којима се скрипта може покренути.
selectHosts query Враћа својство hosts са домаћинима на којима се скрипта може покренути.
selectActions query Враћа својство actions са акцијама са којима је скрипта повезана.
sortfield string/array Сортирај резултат према датим особинама.

Могуће вредности: scriptid, name.
countOutput boolean Ови параметри који су заједнички за све get методе су детаљно описани у референтном коментару.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGroups
(deprecated)
query Овај параметар је застарео, користите selectHostGroups уместо тога.
Вратите својство groups са групама домаћина на којима се скрипта може извршити.

Повратне вредности

(integer/array) Враћа било:

  • низ објеката;
  • број преузетих објеката, ако је параметар countOutput коришћен.

Примери

Преузимање свих скрипти

Преузмите све конфигурисане скрипте.

Захтев:

{
           "jsonrpc": "2.0",
           "method": "script.get",
           "params": {
               "output": "extend"
           },
           "id": 1
       }

Одговор:

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

Погледајте такође

Извор

CScript::get() у ui/include/classes/api/services/CScript.php.