Champs et fonctionnalités de l’interface de ligne de commande (CLI) pris en charge

Sujet

Cette documentation décrit l'du composant ninjarmm-cli pour les appareils Windows, Mac et Linux.

Environnement

• Gestion des terminaux NinjaOne
• Documentation NinjaOne
• Microsoft Windows 
• macOS
• Linux

Description

Ce fichier est un exécutable qui vous permet d'accéder à des champs personnalisés spécifiques et aux données de la documentation NinjaOne, et d'interagir avec ceux-ci depuis l'interface de ligne de commande (CLI), le Terminal ou des scripts personnalisés. Reportez-vous aux sections Utilisation de l'interface de ligne de commande (CLI) dans NinjaOne et Prise en main de la bibliothèque d'automatisation de NinjaOne (scripting).

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

• À propos des champs pris en charge par la CLI
• Champs pris en charge
  • Champs de calcul
  • Paramètres avancés
• Ressources supplémentaires

À propos des champs pris en charge par l'interface CLI

Gardez ces considérations à l'esprit lorsque vous utilisez les champs pris en charge par l'interface CLI :

• Utilisez l'interface CLI pour définir l'ID d'actif de l'appareil sur n'importe quelle valeur prise en charge. 
• Les champs sécurisés sont en écriture seule pour les champs de documentation NinjaOne. 
  • Pour plus d'informations sur les champs personnalisés, consultez la section Configuration des champs personnalisés. Consultez la section Configuration des champs personnalisés pour plus de détails. 
  • Pour en savoir plus sur les champs de documentation, consultez NinjaOne Documentation : Applications et services.
• Le système peut lire des données de documentation à partir de la CLI ou de scripts personnalisés, ou y écrire des données. Vous pouvez obtenir une liste de modèles, une liste de documents par nom ou ID de modèle, ainsi que la valeur de chaque champ dans un document.
  • Seuls les modèles ou les documents comportant au moins un champ renseigné sont accessibles via l'interface CLI ou les scripts personnalisés. Le système n'affiche pas les modèles ou les documents vides.
• Vous pouvez utiliser des scripts personnalisés écrits en Batch ou PowerShell pour Windows, ou en ShellScript pour macOS et Linux.
  • Étant donné que ninjarmm-cli.exe se trouve dans un dossier protégé inaccessible aux utilisateurs standard, tout script utilisant cette fonctionnalité doit être exécuté en tant que système (ou les autorisations doivent être modifiées en conséquence).
• Seuls les appareils désignés comme délégués peuvent mettre à jour les champs de documentation via l'interface CLI ou des scripts. Reportez-vous à la section Désignation d'appareils comme délégués de documentation pour plus d'informations. 
• Les appareils lisent la valeur la plus proche qui leur est attribuée en fonction de l'héritage selon le flux suivant : Appareil → utilisateur final attribué à l'appareil → emplacement de l'appareil → organisation de l'appareil. 
  • Si le résultat de l'héritage de l'appareil n'a pas de valeur, il héritera de la valeur de l'utilisateur final. 
  • Si le résultat de l'héritage pour l'utilisateur final ne comporte pas de valeur, il héritera de la valeur de l'emplacement. 
  • Si le résultat de l'héritage de l'emplacement ne comporte pas de valeur, il héritera de la valeur de l'organisation. 
  • Si le résultat de l'héritage pour l'organisation ne contient pas de valeur, le champ restera vide.

Champs personnalisés et documentation Champs pris en charge

Le tableau suivant présente les champs prenant en charge l'accès via l'interface CLI et les scripts personnalisés.

Fonctionnalités supplémentaires prises en charge

Les informations suivantes traitent des champs calculés et des paramètres avancés.

Champs calculés

L'outil CLI prend en charge les champs calculés, ce qui vous permet d'afficher des valeurs générées automatiquement à partir d'autres données. Par exemple, vous pouvez procéder comme suit :

> ninjarmm-cli.exe set firstfield myvalue
myvalue
> ninjarmm-cli.exe get firstfield
myvalue
> ninjarmm-cli.exe get secondfield
othervalue
> ninjarmm-cli.exe set secondfield __firstfield__
myvalue
> ninjarmm-cli.exe get secondfield
myvalue

Paramètres avancés

L'utilitaire CLI prend en charge des paramètres avancés, qui peuvent être définis lors de la configuration des différents champs. Par exemple, vous pouvez définir des plages pour les entiers, les nombres décimaux, les dates, les dates et heures, et les heures. 

Ressources supplémentaires

Consultez les ressources suivantes pour en savoir plus sur les champs personnalisés et l'automatisation dans NinjaOne :

• Champs personnalisés : Catalogue de ressources
• Scripts, automatisation, CLI : Catalogue de ressources