script.get

Leírás

integer/array script.get(objektumparaméterek)

A metódus lehetővé teszi a szkriptek lekérését a megadott paraméterek szerint.

Ez a módszer bármilyen típusú felhasználó számára elérhető. Engedélyek A metódus meghívása a felhasználói szerepkör beállításaiban visszavonható. Lásd: User roles további információért.

Paraméterek

(object) A kívánt kimenetet meghatározó paraméterek.

A módszer a következő paramétereket támogatja.

Paraméter	Típus	Leírás
groupids	string/array	Csak az adott gazdagépcsoportokon futtatható szkripteket adja vissza.
hostids	string/array	Csak az adott gazdagépen futtatható szkripteket adja vissza.
scriptids	string/array	Csak a megadott azonosítókkal rendelkező szkripteket adja vissza.
usrgrpids	string/array	Csak azokat a szkripteket adja vissza, amelyeket az adott felhasználói csoportok felhasználói futtathatnak.
selectGroups	query	Egy groups tulajdonság visszaadása olyan gazdagépcsoportokkal, amelyeken a szkript futtatható.
selectHosts	query	Vitasson vissza egy hosts tulajdonságot olyan gazdagépekkel, amelyeken a szkript futtatható.
selectActions	query	Egy actions tulajdonság visszaadása olyan műveletekkel, amelyekhez a szkript társítva van.
sortfield	string/array	Rendezd az eredményt a megadott tulajdonságok szerint. A lehetséges értékek: `scriptid` és `name`.
countOutput	boolean	Ezek a paraméterek, amelyek minden `get` metódusnál közösek, a referenciakommentár részben találhatók.
szerkeszthető	logikai
excludeSearch	logikai
szűrő	objektum
korlát	egész szám
kimenet	lekérdezés
preservekeys	boolean
kereső	objektum
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	karakterlánc/tömb
startSearch	boolean

Visszatérési értékek

(integer/array) A következőket adja vissza:

objektumok tömbje;
a letöltött objektumok száma, ha a countOutput paraméter használva volt.

Példák

Retrieve all scripts

Retrieve all configured scripts.

Request:

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

Response:

{
           "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 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",
                   "parameters": [
                       {
                           "name": "token",
                           "value": "{$WEBHOOK.TOKEN}"
                       },
                       {
                           "name": "host",
                           "value": "{HOST.HOST}"
                       },
                       {
                           "name": "v",
                           "value": "2.2"
                       }
                   ]
               }
           ],
           "id": 1
       }

Lásd még

Forrás

CScript::get() az ui/include/classes/api/services/CScript.php-ban.

Documentation