Documentation
Table of Contents
script.execute
Description
object script.execute(object parameters)
Cette m¨¦thode permet d'ex¨¦cuter un script sur un h?te ou un ¨¦v¨¦nement.
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.
±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ
(object) ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ contenant l'ID du script ¨¤ ex¨¦cuter et soit l'ID de l'h?te, soit l'ID de l'¨¦v¨¦nement.
| ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð | Type | Description |
|---|---|---|
| scriptid (obligatoire) |
string | ID du script ¨¤ ex¨¦cuter. |
| hostid | string | ID de l'h?te sur lequel ex¨¦cuter le script. |
| eventid | string | ID de l'¨¦v¨¦nement sur lequel ex¨¦cuter le script. |
Valeurs retourn¨¦es
(object) Renvoie le r¨¦sultat de l'ex¨¦cution du script.
| ±Ê°ù´Ç±è°ù¾±¨¦³Ù¨¦ | Type | Description |
|---|---|---|
| response | string | Indique si le script a ¨¦t¨¦ ex¨¦cut¨¦ avec succ¨¨s. Valeur possible - success. |
| value | string | Sortie du script. |
| debug | object | Contient un objet de d¨¦bogage si un script webhook est ex¨¦cut¨¦. Pour les autres types de script, il contient un objet vide. |
Exemples
Ex¨¦cuter un script de webhook
Ex¨¦cutez un script webhook qui envoie une requ¨ºte HTTP ¨¤ un service externe.
Requ¨ºte :
{
"jsonrpc": "2.0",
"method": "script.execute",
"params": {
"scriptid": "4",
"hostid": "30079"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}R¨¦ponse :
{
"jsonrpc": "2.0",
"result": {
"response": "success",
"value": "{\"status\":\"sent\",\"timestamp\":\"1611235391\"}",
"debug": {
"logs": [
{
"level": 3,
"ms": 480,
"message": "[Webhook Script] HTTP status: 200."
}
],
"ms": 495
}
},
"id": 1
}Ex¨¦cution d'un script personnalis¨¦
Ex¨¦cutez un script "ping" sur un h?te.
Requ¨ºte :
{
"jsonrpc": "2.0",
"method": "script.execute",
"params": {
"scriptid": "1",
"hostid": "30079"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}R¨¦ponse :
{
"jsonrpc": "2.0",
"result": {
"response": "success",
"value": "PING 127.0.0.1 (127.0.0.1) 56(84) bytes of data.\n64 bytes from 127.0.0.1: icmp_req=1 ttl=64 time=0.074 ms\n64 bytes from 127.0.0.1: icmp_req=2 ttl=64 time=0.030 ms\n64 bytes from 127.0.0.1: icmp_req=3 ttl=64 time=0.030 ms\n\n--- 127.0.0.1 ping statistics ---\n3 packets transmitted, 3 received, 0% packet loss, time 1998ms\nrtt min/avg/max/mdev = 0.030/0.044/0.074/0.022 ms\n",
"debug": []
},
"id": 1
}Source
CScript::execute() dans ui/include/classes/api/services/CScript.php.