Table des matières :
- Qu’est-ce qu’un paramètre ?
- Comment savoir quels paramètres utiliser dans les scripts d’application d’installation/d’exécution natifs de NinjaOne ?
- Comment savoir quels paramètres utiliser dans mes scripts personnalisés ?
- À quoi cela ressemble-t-il dans NinjaOne ?
- Autre utilisation des paramètres prédéfinis
- Documentation associée
Qu’est-ce qu’un paramètre ?
Les termes « paramètres » et « arguments » sont souvent utilisés de manière interchangeable, mais ils sont très légèrement différents. Lorsque vous appelez une fonction, un script ou un fichier exécutable, vous utilisez des arguments. Lorsque vous définissez la fonction, vous définissez les paramètres qui prendront les arguments de l'appel pour les valeurs des paramètres. Dans le cadre de la création de scripts d'automatisation pour NinjaOne, ces termes peuvent être utilisés de manière interchangeable, c'est pourquoi NinjaOne utilise le terme « paramètres » tout au long du document.
Les paramètres ne sont pas requis par défaut dans les scripts personnalisés. Toutefois, si votre script personnalisé est écrit pour accepter des paramètres, vous avez la possibilité de spécifier des chaînes de paramètres prédéfinies dans l’éditeur de script.
Comment savoir quels paramètres utiliser dans les scripts d’application d’installation/d’exécution natifs de NinjaOne ?
Pour les fichiers .EXE, les paramètres sont spécifiques à l’application. Il n’y a pas un seul ensemble de paramètres à utiliser.
Pour les fichiers .MSI, veuillez cliquer ici pour obtenir une liste des paramètres possibles.
/quiet /qn /norestart /log {path to our script folder}ninjascript-output-{current-time}.txt
NinjaOne n’accepte que des paramètres de type chaîne de caractères.
Comment savoir quels paramètres utiliser dans mes scripts personnalisés ?
Chaque langage de script possède sa propre méthode de consommation des paramètres de script. Les paramètres doivent être formatés conformément aux exigences de la langue que votre script personnalisé utilise. Voici quelques ressources concernant le fonctionnement des paramètres dans les différents langages de script pris en charge par NinjaOne :
- Paramètres de lot
- Paramètres de JS et VBScript (nous utilisons CScript pour exécuter les deux, donc le formatage des paramètres sera le même)
- Paramètres de PowerShell
- Paramètres de ShellScript
- Stack Overflow est une autre ressource populaire pour les scripts personnalisés
- Les caractères spéciaux suivants ne peuvent pas être utilisés dans les paramètres : &|;$><`!
- NinjaOne ne peut pas transmettre plusieurs valeurs pour les paramètres de type tableau. Par exemple, lorsque nous ajoutons -param 1, 2 dans notre zone de texte de paramètres, cela ne donne que « 1 » au lieu de « 1 » « 2 ».
- Pour l’instant, NinjaOne ne peut pas transmettre de valeurs booléennes via nos paramètres.
- NinjaOne n’accepte que des paramètres de type chaîne de caractères.
Nous exposons également les variables d’environnement suivantes qui peuvent être utilisées à partir de scripts Windows :
NINJA_EXECUTING_PATH - Emplacement de l’installation
NINJA_AGENT_VERSION_INSTALLED - Version de l’agent
NINJA_PATCHER_VERSION_INSTALLED - Version du correcteur
NINJA_DATA_PATH - Dossier de données de l’agent (scripts, stratégie, téléchargements, journaux)
NINJA_AGENT_PASSWORD - Mot de passe de l’agent pour obtenir la clé de session
NINJA_AGENT_MACHINE_ID - Identifiant de la machine utilisé sur le serveur
NINJA_AGENT_NODE_ID - Identifiant 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ée 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.
À quoi les paramètres prédéfinis ressemblent-ils dans NinjaOne ?
Voici un exemple de passage de paramètres à un script de lot qui crée un nouvel utilisateur sur un appareil.
Dans le scénario ci-dessus, nous utilisons le script de lot suivant pour créer un nouvel utilisateur :
net user %1 %2
« % 1 » et « % 2 » sont des valeurs qui consommeront des paramètres (dans ce cas, un nom d’utilisateur et un mot de passe pour le nouvel utilisateur).
Nous avons créé trois chaînes de paramètres prédéfinis :
« Bob Password1 »« Linda NewPassword »« Joe Passw0rd »
Lors de l’exécution du script, nous pouvons soit spécifier les paramètres à la volée, soit choisir dans notre liste de chaînes de paramètres prédéfinies.
Les paramètres sont transmis aux valeurs respectives dans l’ordre où ils ont été saisis. Ainsi, si nous choisissons les paramètres prédéfinis « Bob Password1 », « Bob » est transmis à la valeur « % 1 » dans le script, et « Password1 » est transmis à la valeur « % 2 », ce qui donne un nouvel utilisateur avec le nom d’utilisateur Bob et le mot de passe Password1.
Chaque fois que vous créez un nouveau script dans la bibliothèque de scripts de NinjaOne, un nouveau fichier est créé, par exemple « customscript1.bat ». Ainsi, la commande ressemble à ce qui suit avec des paramètres :
customscript1.Bat <VOS PARAMÈTRES ICI>
Autre utilisation des paramètres prédéfinis :
Si vous ne souhaitez pas saisir de paramètres en texte en dur dans votre script, vous pouvez également appeler des variables vides dans votre script et insérer leurs valeurs dans le champ des paramètres juste avant d’exécuter votre script.
Voici un exemple avec un script appelant trois variables et les affichant dans la sortie du script :
param(
[String]$variable1=’’,
[String]$variable2=’’,
[String]$variable3=’’)
Write-Host $variable1
Write-Host $variable2
Write-Host $variable3
variable1 prendra la valeur « 5.1.1574 », la variable2 la valeur « 5 », la variable3 la valeur « 1 » : 
« Peter Smith » Pa5sW0rd