Documentation
Table of Contents
script.get
Description
integer/array script.get(object parameters)
La m¨¦thode permet de r¨¦cup¨¦rer des scripts en fonction des param¨¨tres donn¨¦s.
Cette m¨¦thode est disponible ¨¤ tous les types d'utilisateurs. Les autorisations d'appeler la m¨¦thode peuvent ¨ºtre r¨¦voqu¨¦es dans les param¨¨tres du le r?le d'utilisateur. Voir R?les Utilisateur pour plus d'informations.
±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ
(objet) ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ d¨¦finissant la sortie souhait¨¦e.
La m¨¦thode prend en charge les param¨¨tres suivants.
| ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð | Type | Description |
|---|---|---|
| groupids | string/array | Renvoie uniquement les scripts pouvant ¨ºtre ex¨¦cut¨¦s sur les groupes d'h?tes donn¨¦s. |
| hostids | string/array | Renvoie uniquement les scripts pouvant ¨ºtre ex¨¦cut¨¦s sur les h?tes donn¨¦s. |
| scriptids | string/array | Renvoie uniquement les scripts avec les ID donn¨¦s. |
| usrgrpids | string/array | Renvoie uniquement les scripts pouvant ¨ºtre ex¨¦cut¨¦s par les utilisateurs des groupes d'utilisateurs donn¨¦s. |
| selectGroups | query | Renvoie une propri¨¦t¨¦ groups avec les groupes d'h?tes sur lesquels le script peut ¨ºtre ex¨¦cut¨¦. |
| selectHosts | query | Renvoie une propri¨¦t¨¦ hosts avec les h?tes sur lesquels le script peut ¨ºtre ex¨¦cut¨¦. |
| selectActions | query | Renvoie une propri¨¦t¨¦ actions avec les actions auxquelles le script est associ¨¦. |
| sortfield | string/array | Trier le r¨¦sultat selon les propri¨¦t¨¦s donn¨¦es. Les valeurs possibles sont?: scriptid et name. |
| countOutput | boolean | Ces param¨¨tres, communs ¨¤ toutes les m¨¦thodes get, sont d¨¦crits dans les commentaires de r¨¦f¨¦rence. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valeurs retourn¨¦es
(integer/array) Retourne soit :
- un tableau d'objets ;
- le nombre d'objets r¨¦cup¨¦r¨¦s, si le param¨¨tre
countOutputa ¨¦t¨¦ utilis¨¦.
Exemples
R¨¦cup¨¦ration de tous les scripts
R¨¦cup¨¦rez tous les scripts configur¨¦s.
Requ¨ºte :
{
"jsonrpc": "2.0",
"method": "script.get",
"params": {
"output": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}R¨¦ponse :
{
"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
}Voir ¨¦galement
Source
CScript::get() dans ui/include/classes/api/services/CScript.php.