Vous êtes déjà client NinjaOne ? Connectez-vous pour consulter d'autres guides et les dernières nouvelles.

Bibliothèque d’automatisation : Utilisation des variables dans les scripts

Sujet

Cet article explique comment utiliser les variables d'environnement lors de l'exécution de scripts dans NinjaOne.

Environnement

Gestion des terminaux NinjaOne

Description

Lorsque vous exécutez un script contenant des variables, l'agent NinjaOne les ajoute en tant que variables d'environnement uniquement pour la durée d'exécution du script. Si NinjaOne dispose déjà d'une variable d'environnement provenant du script, celui-ci échoue et envoie un journal d'activité précisant quel script a échoué et pourquoi.

Les scripts envoient également une entrée de journal d'activité pour les modifications apportées à une variable. Ces informations peuvent aider les utilisateurs à identifier et à planifier les besoins en matière de débogage ou de dépannage.

Sélectionnez une catégorie pour en savoir plus :

Variables d'environnement

Nous mettons également à disposition les variables d'environnement suivantes, que vous pouvez utiliser pour tous les types de scripts (Windows, macOS et Linux) :

NINJA_EXECUTING_PATH - Emplacement d'installation
NINJA_AGENT_VERSION_INSTALLED - Version de l'agent
NINJA_PATCHER_VERSION_INSTALLED - Version du patcher
NINJA_DATA_PATH - Dossier de données de l'agent (scripts, politiques, téléchargements, journaux)
NINJA_AGENT_PASSWORD - Mot de passe de l'agent pour obtenir la clé de session
NINJA_AGENT_MACHINE_ID - ID de la machine utilisé sur le serveur
NINJA_AGENT_NODE_ID - ID du nœud utilisé sur le serveur.
NINJA_ORGANIZATION_NAME - Nom de l'organisation utilisé sur le serveur.
NINJA_ORGANIZATION_ID - ID de l'organisation utilisé sur le serveur.
NINJA_COMPANY_NAME - Nom de la société utilisé sur le serveur.
NINJA_LOCATION_ID - ID de l'emplacement utilisé sur le serveur.
NINJA_LOCATION_NAME - Nom de l'emplacement utilisé sur le serveur

Windows dispose d'une variable supplémentaire NINJARMMCLI avec la valeur suivante :

C:ProgramDataNinjaRMMAgentninjarmm-cli.exe

La partie C:ProgramData au début de ce chemin correspond aux valeurs suivantes des variables d'environnement natives :

  • $env:ALLUSERSPROFILE
  • $env:ProgramData
Si vous modifiez une variable et qu'elle n'est pas mise à jour lors de l'exécution du script, redémarrez la cible pour mettre à jour les variables.

Créer des variables de script

Vous pouvez ajouter de nouvelles variables de script à partir du champ Variables de script dans l'éditeur de script. Reportez-vous à NinjaOne Endpoint Management : Prise en main des scripts d'automatisation pour en savoir plus.

NinjaOne prend en charge les caractères Unicode (scripts non latins, symboles, kanji, emojis et autres). Vous ne pouvez pas utiliser les caractères spéciaux suivants : &|;$><`!.

Pour ajouter une variable de script, procédez comme suit :

  1. Créez un nouveau script ou ouvrez un modèle à partir de la bibliothèque d'automatisation de NinjaOne.
  2. Cliquez sur Ajouter dans la section Variables de script et sélectionnez une option dans le menu déroulant. Vous pouvez ajouter jusqu'à 20 variables à un même script. Pour une description de chaque variable, consultez NinjaOne Endpoint Management : Types de variables de script d'automatisation.
Figure 1: L'éditeur de script (cliquez pour agrandir)
  1. La boîte de dialogue Ajouter une variable s'ouvre et affiche les options de configuration correspondant au type de variable que vous avez sélectionné. Reportez-vous au tableau ci-dessous pour obtenir une explication de chaque champ de configuration et des types de variables auxquels il s'applique.
Champ Description Types de variables concernés
Rendre la variable obligatoire Activez le bouton pour rendre la variable obligatoire lors de l'exécution du script. Si cette option est activée, le formulaire généré par le script ne s'affichera pas si cette valeur n'est pas renseignée. Toutes sauf la case à cocher
Nom Donnez un nom descriptif à votre variable. Tout
Nom calculé NinjaOne remplira automatiquement ce champ avec un nom de variable. Tout
Description Ce champ facultatif permet de définir une description de la variable. Lors de l'exécution d'un script, NinjaOne affiche la description sous forme d'icône d'info-bulle (i) au-dessus de la variable, fournissant ainsi des informations supplémentaires ou des conseils utiles. Tout
Définir la valeur par défaut Cette valeur facultative utilise un contenu prédéfini lorsque vous exécutez le script. Le format de ce champ varie en fonction du type de variable sélectionné. Tout
Valeur de l'option Cette valeur obligatoire permet aux utilisateurs de sélectionner des options dans une liste. Chaque valeur saisie correspond à une option distincte. Liste déroulante
Figure 2: La fenêtre Ajouter une variable (cliquez pour agrandir)

Modifier ou supprimer des variables créées

Vous pouvez modifier ou supprimer des variables de script selon vos besoins. Placez le curseur de votre souris sur le nom de la variable, puis cliquez sur l'icône Modifier, ou cliquez sur le X pour la supprimer. Vous pouvez également modifier l'ordre des variables en les faisant glisser vers le haut ou vers le bas dans la pile.

Figure 3: Modifier ou supprimer une variable de script

Ajouter des variables à un script

Dans l'éditeur de script, cliquez sur le volet d'édition, puis appuyez sur CTRL + Espace. Le sélecteur de variables de script s'affiche sous forme de menu contextuel. Placez votre curseur sur la variable pour afficher une description. Les champs personnalisés s'affichent également dans ce sélecteur de variables de script.

Figure 4: Le sélecteur de variables de script

Une fois la variable sélectionnée, NinjaOne l'insère dans le code de l'éditeur de script, formatée selon le langage que vous avez sélectionné lors de l'ajout de la variable.

Ressources supplémentaires

Consultez le catalogue de ressources NinjaOne Endpoint Management : Scripting, Automation and CLI pour en savoir plus sur la bibliothèque d'automatisation de NinjaOne.

FAQ

Pour aller plus loin