Contexte
La fonctionnalité des custom scripts vous permet d'utiliser l'un des 5 types de script pour exécuter des actions sur un agent ou un nœud que vous aurez préalablement sélectionné.
Pour y accéder, cliquez sur la section "Action" du menu principal.
Exécuter une commande
En choisissant ce type de script vous pourrez directement rédiger vos scripts dans un éditeur de code sur le Dashboard en utilisant différents langages de programmation.
Editeur de code
L'éditeur de code comprend une coloration syntaxique pour vous aider dans la manière de rédiger vos script.
Vous retrouverez associé, un champ "Commande" qui sera automatiquement rempli en fonction du langage que vous choisirez. Vous pouvez agrémenter ce champ commande par d'autres éléments propres à l'exécution de votre script.
A noter : La variable [%pathScript%] est toujours présente par défaut et permet de lire le script rédigé dans l'éditeur de code. Si vous la supprimez, le script ne sera pas exécuté. Assurez vous donc d'intégrer cette variable dans la commande si vous rédigez un script.
Il est possible d'agrandir la zone de rédaction du script via l'action "Zoom" et de copier rapidement l'intégralité du code via l'action "Copier"
Langage de programmation disponibles
Les langages actuellement présents sont :
- PowerShell,
- Python,
- Batch,
- VBScript
- Shell
- Empty
Le mode "Empty" est un mode qui permet de s'abstraire de l'éditeur de code et d'utiliser seulement la commande d'exécution.
Paramétrage
Les paramétrages sont scindés en 2 sections : Général et Personnalisation.
- Général
Vous retrouverez des champs permettant de nommer, d'ajouter une description, de définir une cible en choisissant des critères de système d'exploitation et / ou de type d'agent et vous pourrez définir une fréquence d'exécution.
La fréquence d'exécution déterminera combien de résultats vous pourrez conserver de manière glissante. Le nombre maximal de résultats glissant sauvegardé est 1440.
Exemple de fréquence :
Si j'ai choisi une fréquence 5 min la rétention de mes données a pour durée maximal 5 jours (5 min x1440). Après 5 jours le premier résultat de mon script est supprimé.
- Personnalisation
Vous pourrez ici définir le nom des valeurs retournées dans les résultats du script pour avoir une meilleur compréhension dans la lecture des résultats. cela permet aussi de choisir le type et le format de la réponse (textes ou courbes).
Paramétrage avancé
Les paramétrages avancés sont scindés en 2 sections : Paramètres d'exécution et Paramètres optionnels.
- Paramètres d'exécution
Timeout :
Définissez le timeout et déterminez le temps d'attente maximal de la réponse attendue après exécution du script. Par défaut la valeur du timeout est de 20000 ms.
Working Directory :
Vous pouvez préciser ici l'environnement ou le dossier dans lequel vous souhaitez exécuter votre script.
RunAs64Bits :
Le paramètre "RunAs64Bits" spécifie si le script doit être exécuté dans un environnement 64 bits. Ce paramètre est particulièrement utile lorsqu'il s'agit de scripts ou d'applications nécessitant une architecture spécifique pour une exécution correcte.
En définissant le paramètre "RunAs64Bits", vous pourrez garantir la compatibilité et les performances optimales de vos scripts sur différentes configurations système.
DetachProcess :
Le paramètre "DetachProcess" permet de spécifier si le processus de script doit être détaché du processus principal de l'agent de surveillance.
En d'autres termes, cela signifie que le script fonctionnera de manière autonome, séparé du processus principal de l'agent. Cependant, il ne sera pas possible de récupérer les résultats du script.
Par conséquent, il n'est pas possible de déclencher d'alerte ou de réaliser des tests basés sur les résultats du script lorsqu'il est exécuté avec cette option de détachement.
- Paramètres optionnels.
URL :
Le paramètre "URL" permet l'exécution de scripts stockés de manière externe, généralement sur un serveur distant ou une plateforme de stockage cloud. En spécifiant une URL, vous pouvez récupérer et exécuter dynamiquement des scripts à partir d'emplacements distants.
A noter : pour que le script appelé par L'url soit bien téléchargé, il faudra ajouter dans votre commande la variable [%pathFile%].
Exécuter le script
Avant de déployer définitivement votre script sur l'agent ou les agents du nœud sélectionné, vous pouvez ajouter une ou plusieurs Alertes et Tester votre script sur un agent spécifiquement choisi.
Une fois que le script est conforme à vos attentes, appuyer sur "Créer" pour exécuter le script.