[comment]: # translation:outdated

[comment]: # ({3a2a8d58-3a2a8d58})
# script.execute

[comment]: # ({/3a2a8d58-3a2a8d58})

[comment]: # ({ac5defee-60a9dbe3})
### Description

`object script.execute(object parameters)`

Cette méthode permet d’exécuter un script sur un hôte ou un événement. À l’exception des scripts de type URL. Ceux-ci ne sont pas exécutables.

::: noteclassic
Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations
d’appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir [User
roles](/manual/web_interface/frontend_sections/users/user_roles)
pour plus d’informations.
:::

[comment]: # ({/ac5defee-60a9dbe3})

[comment]: # ({4a3ef91f-e4fa8ac7})
### Paramètres

`(object)` Paramètres contenant l'ID du script à exécuter, soit
l'ID de l'hôte, soit l'ID de l'événement et la valeur manualinput.

|Paramètre|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|scriptid|ID|ID du [script](/manual/api/reference/script/object#script) à exécuter.<br><br>[Comportement du paramètre](/manual/api/reference_commentary#parameter-behavior) :<br>- *obligatoire*|
|hostid|ID|ID de l'[hôte](/manual/api/reference/host/object#host) sur lequel exécuter le script.<br><br>[Comportement du paramètre](/manual/api/reference_commentary#parameter-behavior) :<br>- *obligatoire* si `eventid` n'est pas défini|
|eventid|ID|ID de l'[événement](/manual/api/reference/event/object#event) sur lequel exécuter le script.<br><br>[Comportement du paramètre](/manual/api/reference_commentary#parameter-behavior) :<br>- *obligatoire* si `hostid` n'est pas défini|
|manualinput|string|Valeur fournie par l'utilisateur pour exécuter le script, en remplaçant <br>la macro {MANUALINPUT}.|

[comment]: # ({/4a3ef91f-e4fa8ac7})

[comment]: # ({abb1babb-dde54e60})
### Valeurs de retour

`(object)` Renvoie le résultat de l'exécution du script.

|Propriété|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|response|string|Indique si le script a été exécuté avec succès.<br><br>Valeur possible - `success`.|
|value|string|Sortie du script.|
|debug|object|Contient un objet [debug](/manual/api/reference/script/object#debug) si un script webhook est exécuté. Pour les autres types de scripts, il contient un objet vide.|

[comment]: # ({/abb1babb-dde54e60})

[comment]: # ({b41637d2-b41637d2})
### Exemples

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({89444531-03cb1cf3})
#### Exécuter un script webhook

Exécutez un script webhook qui envoie une requête HTTP à un service externe.

[Requête](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "script.execute",
    "params": {
        "scriptid": "4",
        "hostid": "30079"
    },
    "id": 1
}
```

Réponse :

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

[comment]: # ({/89444531-03cb1cf3})

[comment]: # ({fc7b2309-baebff97})
#### Exécuter un script personnalisé

Exécutez un script « ping » sur un hôte.

[Requête](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "script.execute",
    "params": {
        "scriptid": "1",
        "hostid": "30079"
    },
    "id": 1
}
```

Réponse :

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

[comment]: # ({/fc7b2309-baebff97})

[comment]: # ({7ff793a4-dae60a2d})
#### Exécuter un script personnalisé avec saisie manuelle

Exécutez un script "ping" avec la commande "ping -c {MANUALINPUT} {HOST.CONN}; case $? in [01]) true;; *)
false;; esac" sur un hôte.

[Requête](/manual/api#performing-requests) :

```json
{
    "jsonrpc": "2.0",
    "method": "script.execute",
    "params": {
        "scriptid": "7",
        "hostid": "30079",
        "manualinput": "2"
    },
    "id": 1
}
```

Réponse :

```json
{
    "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_seq=1 ttl=64 time=0.051 ms\n64 bytes from 127.0.0.1: icmp_seq=2 ttl=64 time=0.025 ms\n\n--- 127.0.0.1 ping statistics ---\n2 packets transmitted, 2 received, 0% packet loss, time 1021ms\nrtt min/avg/max/mdev = 0.025/0.038/0.051/0.013 ms\n",
        "debug": []
    },
    "id": 1
}
```

[comment]: # ({/7ff793a4-dae60a2d})

[comment]: # ({e7dc45a5-e7dc45a5})
### Source

CScript::execute() dans *ui/include/classes/api/services/CScript.php*.

[comment]: # ({/e7dc45a5-e7dc45a5})
