[comment]: # translation:outdated

[comment]: # ({8b1700c1-8b1700c1})
# > Objet Script

Les objets suivants sont directement liés à l'API `script`.

[comment]: # ({/8b1700c1-8b1700c1})

[comment]: # ({cd8ec58e-9c6db006})
### Script

L'objet script a les propriétés suivantes.

|Propriété|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|scriptid|string|*(lecture seule)* ID du script.|
|**name**<br>(obligatoire)|string|Nom du script.|
|**type**<br>(obligatoire)|integer|Type de script.<br><br>Valeurs possibles :<br>0 - Script ;<br>1 - IPMI ;<br>2 - SSH ;<br>3 - Telnet ;<br>5 - *(par défaut)* Webhook.|
|**command**<br>(obligatoire)|string|Commande à exécuter.|
|scope|integer|Portée du script.<br><br>Valeurs possibles :<br>1 - *par défaut* opération d'action ;<br>2 - action manuelle sur hôte ;<br>4 - action manuelle sur évènement.|
|execute\_on|integer|Où exécuter le script.<br>Utilisé si `type` est à `0` (script).<br><br>Valeurs possibles :<br>0 - exécuter sur l'agent Zabbix ;<br>1 - exécuter sur le serveur Zabbix ;<br>2 - *(par défaut)* exécuter sur le serveur Zabbix (proxy).|
|menu\_path|string|Dossiers séparés par une barre oblique qui forment un menu comme la navigation dans le frontend lorsque l'on clique sur l'hôte ou l'événement.<br>Utilisé si `scope` est à `2` ou `4`.|
|authtype|integer|Méthode d'authentification utilisée pour le type de script SSH.<br>Utilisé si `type` est `2`.<br><br>Valeurs possibles :<br>0 - mot de passe ;<br>1 - clé publique.|
|username|string|Nom d'utilisateur utilisé pour l'authentification.<br>Requis si `type` est `2` ou `3`.|
|password|string|Mot de passe utilisé pour les scripts SSH avec authentification par mot de passe et les scripts Telnet.<br>Utilisé si `type` est `2` et `authtype` est `0` ou `type` est `3`.|
|publickey|string|Nom du fichier de clé publique utilisé pour les scripts SSH avec authentification par clé publique.<br>Requis si le type est `2` et `authtype` est `1`.|
|privatekey|string|Nom du fichier de clé privée utilisé pour les scripts SSH avec authentification par clé publique.<br>Requis si le type est `2` et `authtype` est `1`.|
|port|string|Numéro de port utilisé pour les scripts SSH et Telnet.<br>Utilisé si le type est '2' ou '3'.|
|groupid|string|ID du groupe d'hôtes sur lequel le script peut être exécuté. Si la valeur est 0, le script sera disponible sur tous les groupes hôtes.<br><br>Par défaut : 0.|
|usrgrpid|string|ID du groupe d'utilisateurs qui sera autorisé à exécuter le script. S'il est défini sur 0, le script sera disponible pour tous les groupes d'utilisateurs.<br>Utilisé si `scope` est `2` ou `4`.<br><br>Par défaut : 0.|
|host\_access|integer|Autorisations de l'hôte requises pour exécuter le script.<br>Utilisé si `scope` est `2` ou `4`.<br><br>Valeurs possibles :<br>2 - *(par défaut)* lecture ;<br>3 - écriture.|
|confirmation|string|Texte contextuel de confirmation. La fenêtre contextuelle apparaît lorsque vous essayez d'exécuter le script à partir de l'interface Zabbix.<br><br>Utilisé si `scope` est `2` ou `4`.|
|timeout|string|Délai d'exécution du script Webhook en secondes. Les suffixes horaires sont pris en charge, par ex. 30s, 1m.<br>Requis si `type` est `5`.<br><br>Valeurs possibles :<br>1-60s<br><br>Valeur par défaut :<br>30s|
|description|string|Description du script.|

Notez que pour certaines méthodes (mise à jour, suppression) la combinaison de paramètres requise/optionnelle est différente.

[comment]: # ({/cd8ec58e-9c6db006})

[comment]: # ({3378eaae-05b0e37d})
### Paramètres du Webhook

Les paramètres transmis au script webhook lorsqu'il est appelé ont les propriétés suivantes.

|Propriété|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**name**<br>(obligatoire)|string|Nom du paramètre.|
|value|string|Valeur du paramètre. Supporte les [macros](/manual/appendix/macros/supported_by_location).|

[comment]: # ({/3378eaae-05b0e37d})

[comment]: # ({44d8d2c4-587d2fd0})
### Debug

Informations de debug du script Webhook exécuté. L'objet de debug a les propriétés suivantes.

|Propriété|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|logs|array|Tableau de [entrées de journal](/manual/api/reference/script/object#Log entry).|
|ms|string|Durée d'exécution du script en millisecondes.|

[comment]: # ({/44d8d2c4-587d2fd0})

[comment]: # ({63401e0b-8ea23127})
### Entrée de journal

L'objet d'entrée de journal a les propriétés suivantes.

|Propriété|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|level|integer|Niveau de journal.|
|ms|string|Le temps écoulé en millisecondes depuis l'exécution du script avant l'ajout de l'entrée de journal.|
|message|string|Message de journal.|

[comment]: # ({/63401e0b-8ea23127})
