Documentation
Table of Contents
> Objet Script
Les objets suivants sont directement liés à l'API script.
Script
L'objet script a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| scriptid | string | (lecture seule) ID du script. |
| name (obligatoire) |
string | Nom du script. |
| type (obligatoire) |
integer | Type de script. Valeurs possibles : 0 - Script ; 1 - IPMI ; 2 - SSH ; 3 - Telnet ; 5 - (par défaut) Webhook. |
| command (obligatoire) |
string | Commande à exécuter. |
| scope | integer | Portée du script. Valeurs possibles : 1 - par défaut opération d'action ; 2 - action manuelle sur hôte ; 4 - action manuelle sur évènement. |
| execute_on | integer | Où exécuter le script. Utilisé si type est à 0 (script).Valeurs possibles : 0 - exécuter sur l'agent Zabbix ; 1 - exécuter sur le serveur Zabbix ; 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. Utilisé si scope est à 2 ou 4. |
| authtype | integer | Méthode d'authentification utilisée pour le type de script SSH. Utilisé si type est 2.Valeurs possibles : 0 - mot de passe ; 1 - clé publique. |
| username | string | Nom d'utilisateur utilisé pour l'authentification. 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. 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. 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. Requis si le type est 2 et authtype est 1. |
| port | string | Numéro de port utilisé pour les scripts SSH et Telnet. 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. 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. Utilisé si scope est 2 ou 4.Par défaut : 0. |
| host_access | integer | Autorisations de l'hôte requises pour exécuter le script. Utilisé si scope est 2 ou 4.Valeurs possibles : 2 - (par défaut) lecture ; 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. 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. Requis si type est 5.Valeurs possibles : 1-60s Valeur par défaut : 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.
Paramètres du Webhook
Les paramètres transmis au script webhook lorsqu'il est appelé ont les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| name (obligatoire) |
string | Nom du paramètre. |
| value | string | Valeur du paramètre. Supporte les macros. |
Debug
Informations de debug du script Webhook exécuté. L'objet de debug a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| logs | array | Tableau de entrées de journal. |
| ms | string | Durée d'exécution du script en millisecondes. |
Entrée de journal
L'objet d'entrée de journal a les propriétés suivantes.
| Propriété | Type | 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. |