[comment]: # aside: 1

[comment]: # translation:outdated

[comment]: # ({43284bfe-8b1700c1})
# Objet script

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

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

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

L'objet script possède les propriétés suivantes.

|Propriété|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|scriptid|ID|ID du script.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *lecture seule*<br>- *obligatoire* pour les opérations de mise à jour|
|name|string|Nom du script.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *obligatoire* pour les opérations de création|
|type|integer|Type de script.<br><br>Valeurs possibles si `scope` est défini sur "action operation" :<br>0 - Script;<br>1 - IPMI;<br>2 - SSH;<br>3 - TELNET;<br>5 - Webhook.<br><br>Valeurs possibles si `scope` est défini sur "manual host action" ou "manual event action" :<br>6 - URL.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *obligatoire* pour les opérations de création|
|command|string|Commande à exécuter.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *obligatoire* si `type` est défini sur "Script", "IPMI", "SSH", "TELNET" ou "Webhook"|
|scope|integer|Portée du script.<br><br>Valeurs possibles :<br>1 - action operation;<br>2 - manual host action;<br>4 - manual event action.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *obligatoire* pour les opérations de création|
|execute\_on|integer|Où exécuter le script.<br><br>Valeurs possibles :<br>0 - exécuter sur l'agent Zabbix ;<br>1 - exécuter sur le serveur Zabbix. Ceci est *pris en charge* uniquement si l'exécution des scripts globaux est activée sur le serveur Zabbix ;<br>2 - *(par défaut)* exécuter sur le serveur Zabbix ou le proxy.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *pris en charge* si `type` est défini sur "Script"|
|menu\_path|string|Dossiers séparés par des barres obliques formant une navigation de type menu dans l'interface lors d'un clic sur un hôte ou un événement.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *pris en charge* si `scope` est défini sur "manual host action" ou "manual event action"|
|authtype|integer|Méthode d'authentification utilisée pour le type de script SSH.<br><br>Valeurs possibles :<br>0 - mot de passe ;<br>1 - clé publique.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *pris en charge* si `type` est défini sur "SSH"|
|username|string|Nom d'utilisateur utilisé pour l'authentification.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *obligatoire* si `type` est défini sur "SSH" ou "TELNET"|
|password|string|Mot de passe utilisé pour les scripts SSH avec authentification par mot de passe et pour les scripts TELNET.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *pris en charge* si `type` est défini sur "SSH" et `authtype` est défini sur "password", ou si `type` est défini sur "TELNET"|
|publickey|string|Nom du fichier de clé publique utilisé pour les scripts SSH avec authentification par clé publique.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *obligatoire* si `type` est défini sur "SSH" et `authtype` est défini sur "public key"|
|privatekey|string|Nom du fichier de clé privée utilisé pour les scripts SSH avec authentification par clé publique.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *obligatoire* si `type` est défini sur "SSH" et `authtype` est défini sur "public key"|
|port|string|Numéro de port utilisé pour les scripts SSH et TELNET.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *pris en charge* si `type` est défini sur "SSH" ou "TELNET"|
|groupid|ID|ID du groupe d'hôtes sur lequel le script peut être exécuté.<br><br>Si défini sur "0", le script sera disponible sur tous les groupes d'hôtes.<br><br>Par défaut : 0.|
|usrgrpid|ID|ID du groupe d'utilisateurs autorisé à exécuter le script.<br><br>Si défini sur "0", le script sera disponible pour tous les groupes d'utilisateurs.<br><br>Par défaut : 0.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *pris en charge* si `scope` est défini sur "manual host action" ou "manual event action"|
|host\_access|integer|Autorisations sur l'hôte nécessaires pour exécuter le script.<br><br>Valeurs possibles :<br>2 - *(par défaut)* lecture ;<br>3 - écriture.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *pris en charge* si `scope` est défini sur "manual host action" ou "manual event action"|
|confirmation|string|Texte de la fenêtre contextuelle de confirmation.<br>La fenêtre contextuelle apparaîtra lors de la tentative d'exécution du script depuis l'interface Zabbix.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *pris en charge* si `scope` est défini sur "manual host action" ou "manual event action"|
|timeout|string|Délai d'expiration de l'exécution du script webhook en secondes. Les suffixes de temps sont pris en charge (par exemple, 30s, 1m).<br><br>Valeurs possibles : 1-60s.<br><br>Par défaut : 30s.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *obligatoire* si `type` est défini sur "Webhook"|
|parameters|array|Tableau des [paramètres d'entrée du webhook](/manual/api/reference/script/object#webhook-parameters).<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *pris en charge* si `type` est défini sur "Webhook"|
|description|string|Description du script.|
|url|string|URL définie par l'utilisateur.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *obligatoire* si `type` est défini sur "URL"|
|new_window|integer|Ouvrir l'URL dans une nouvelle fenêtre.<br><br>Valeurs possibles :<br>0 - Non ;<br>1 - *(par défaut)* Oui.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *pris en charge* si `type` est défini sur "URL"|
|manualinput|integer|Indique si le script accepte une entrée fournie par l'utilisateur.<br><br>Valeurs possibles :<br>0 - *(par défaut)* Désactivé ;<br>1 - Activé ;<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *pris en charge* si `scope` est défini sur "manual host action" ou "manual event action"|
|manualinput_prompt|string|Texte de l'invite de saisie manuelle.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *obligatoire* si `manualinput` est défini sur "Enabled"|
|manualinput_validator|string|Champ de chaîne de caractères utilisé pour valider l'entrée fournie par l'utilisateur. La chaîne se compose soit d'une expression régulière, soit d'un ensemble de valeurs séparées par des virgules.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *obligatoire* si `manualinput` est défini sur "Enabled"|
|manualinput_validator_type|integer|Détermine le type d'entrée utilisateur attendu.<br><br>Valeurs possibles :<br>0 - *(par défaut)* Chaîne. Indique que manualinput_validator doit être traité comme une expression régulière ;<br>1 - Liste. Indique que manualinput_validator doit être traité comme une liste de valeurs d'entrée possibles séparées par des virgules.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *pris en charge* si `manualinput` est défini sur "Enabled"|
|manualinput_default_value|string|Valeur par défaut pour le préremplissage de l'entrée utilisateur.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *pris en charge* si `manualinput_validator_type` est défini sur "String"|

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

[comment]: # ({4ab66f57-05b0e37d})
#### Paramètres du webhook

Les paramètres transmis au script de webhook lors de son appel possèdent les propriétés suivantes.

|Propriété|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|name|string|Nom du paramètre.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :<br>- *obligatoire*|
|value|string|Valeur du paramètre. Prend en charge les [macros](/manual/appendix/macros/supported_by_location).|

[comment]: # ({/4ab66f57-05b0e37d})

[comment]: # ({0ba46586-587d2fd0})
### Débogage

Informations de débogage du script webhook exécuté. L'objet debug possède les
propriétés suivantes.

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

[comment]: # ({/0ba46586-587d2fd0})

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

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

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

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