Objet script

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

Script

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

Propriété Type Description
scriptid ID ID du script.

Comportement de la propriété :
- lecture seule
- obligatoire pour les opérations de mise à jour
name string Nom du script.

Comportement de la propriété :
- obligatoire pour les opérations de création
type integer Type de script.

Valeurs possibles si scope est défini sur "action operation" :
0 - Script;
1 - IPMI;
2 - SSH;
3 - TELNET;
5 - Webhook.

Valeurs possibles si scope est défini sur "manual host action" ou "manual event action" :
6 - URL.

Comportement de la propriété :
- obligatoire pour les opérations de création
command string Commande à exécuter.

Comportement de la propriété :
- obligatoire si type est défini sur "Script", "IPMI", "SSH", "TELNET" ou "Webhook"
scope integer Portée du script.

Valeurs possibles :
1 - action operation;
2 - manual host action;
4 - manual event action.

Comportement de la propriété :
- obligatoire pour les opérations de création
execute_on integer Où exécuter le script.

Valeurs possibles :
0 - exécuter sur l'agent Zabbix ;
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 ;
2 - (par défaut) exécuter sur le serveur Zabbix ou le proxy.

Comportement de la propriété :
- 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 le frontend lors d'un clic sur un hôte ou un événement.

Comportement de la propriété :
- 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.

Valeurs possibles :
0 - mot de passe ;
1 - clé publique.

Comportement de la propriété :
- pris en charge si type est défini sur "SSH"
username string Nom d'utilisateur utilisé pour l'authentification.

Comportement de la propriété :
- 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.

Comportement de la propriété :
- 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.

Comportement de la propriété :
- 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.

Comportement de la propriété :
- 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.

Comportement de la propriété :
- 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é.

S'il est défini sur "0", le script sera disponible pour tous les groupes d'hôtes.

Par défaut : 0.
usrgrpid ID ID du groupe d'utilisateurs autorisé à exécuter le script.

S'il est défini sur "0", le script sera disponible pour tous les groupes d'utilisateurs.

Par défaut : 0.

Comportement de la propriété :
- 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.

Valeurs possibles :
2 - (par défaut) lecture ;
3 - écriture.

Comportement de la propriété :
- 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.
La fenêtre contextuelle apparaîtra lors de la tentative d'exécution du script depuis le frontend Zabbix.

Comportement de la propriété :
- 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).

Valeurs possibles : 1-60s.

Par défaut : 30s.

Comportement de la propriété :
- obligatoire si type est défini sur "Webhook"
parameters array Tableau des paramètres d'entrée du webhook.

Comportement de la propriété :
- pris en charge si type est défini sur "Webhook"
description string Description du script.
url string URL définie par l'utilisateur.

Comportement de la propriété :
- obligatoire si type est défini sur "URL"
new_window integer Ouvrir l'URL dans une nouvelle fenêtre.

Valeurs possibles :
0 - Non ;
1 - (par défaut) Oui.

Comportement de la propriété :
- pris en charge si type est défini sur "URL"
manualinput integer Indique si le script accepte une entrée fournie par l'utilisateur.

Valeurs possibles :
0 - (par défaut) Désactivé ;
1 - Activé ;

Comportement de la propriété :
- 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.

Comportement de la propriété :
- obligatoire si manualinput est défini sur "Enabled"
manualinput_validator string Champ de chaîne de caractères utilisé pour valider la saisie 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.

Comportement de la propriété :
- obligatoire si manualinput est défini sur "Enabled"
manualinput_validator_type integer Détermine le type de saisie utilisateur attendu.

Valeurs possibles :
0 - (par défaut) Chaîne. Indique que manualinput_validator doit être traité comme une expression régulière ;
1 - Liste. Indique que manualinput_validator doit être traité comme une liste de valeurs d'entrée possibles séparées par des virgules.

Comportement de la propriété :
- pris en charge si manualinput est défini sur "Enabled"
manualinput_default_value string Valeur par défaut pour le préremplissage de la saisie utilisateur.

Comportement de la propriété :
- pris en charge si manualinput_validator_type est défini sur "String"

Paramètres du webhook

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

Propriété Type Description
name string Nom du paramètre.

Comportement de la propriété :
- obligatoire
value string Valeur du paramètre. Prend en charge les macros.

Débogage

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

Propriété Type Description
logs array Tableau des 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 possède les propriétés suivantes.

Propriété Type 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.