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

Contenu

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

Environnement

• NinjaOne Endpoint Management
• NinjaOne Documentation
• Fenêtres 
• macOS
• Linux

Description

Ce fichier est un exécutable que vous pouvez utiliser pour accéder et interagir avec des champs personnalisés particuliers et des données de la documentation NinjaOne à partir de l'interface de ligne de commande (CLI), du terminal ou de scripts personnalisés. Voir Utilisation de l'interface de ligne de commande (CLI) dans NinjaOne et Premiers pas avec la bibliothèque d'automatisation de NinjaOne (Scripting).

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

• À propos des champs pris en charge par l'interface de programmation
• Champs pris en charge
  • Champs de calcul (compute fields)
  • Paramètres avancés
• Ressources supplémentaires

À propos des champs pris en charge par l'interface de programmation

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

• Utilisez l'interface CLI pour définir l'identifiant de l'appareil sur n'importe quelle valeur prise en charge. 
• Les champs sécurisés sont en écriture seule pour les champs de la documentation NinjaOne. 
  • Pour plus d'informations sur les champs personnalisés, voir Configuration des champs personnalisés. Pour plus de détails, reportez-vous à la section Configuration des champs personnalisés. 
  • Pour en savoir plus sur les champs de documentation, consultez NinjaOne Documentation : Apps et services.
• Le système peut lire ou écrire des données de documentation à partir de la CLI ou de scripts personnalisés. Vous pouvez obtenir une liste de modèles, une liste de documents par nom de modèle ou ID, et la valeur de chaque champ d'un document.
  • Seuls les modèles ou les documents comportant au moins un champ rempli sont accessibles via la CLI ou les scripts personnalisés. Le système n'affiche pas de modèles ou de documents vides.
• Vous pouvez utiliser des scripts personnalisés écrits en Batch ou en PowerShell pour Windows, ou en ShellScript pour macOS et Linux.
  • Étant donné que ninjarmm-cli.exe réside dans un dossier protégé inaccessible aux utilisateurs ordinaires, 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 la documentation via le CLI ou les scripts. Pour plus d'informations, reportez-vous à la section Affectation d'appareils en tant que délégués à la documentation. 
• Les appareils lisent la valeur la plus proche qui leur est attribuée sur la base de l'héritage avec le flux de travail de : Appareil → utilisateur final assigné à l'appareil → emplacement de l'appareil → organisation de l'appareil. 
  • Si le résultat de l'héritage du dispositif 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 n'a pas de valeur, il héritera de la valeur de l'emplacement. 
  • Si le résultat de l'héritage de l'emplacement n'a pas de valeur, il héritera de la valeur de l'organisation. 
  • Si le résultat de l'héritage pour l'organisation n'a pas de valeur, le champ restera vide.

Champs personnalisés et documentation Champs pris en charge

Le tableau suivant indique les champs auxquels il est possible d'accéder par l'intermédiaire de l'interface CLI et de scripts personnalisés.

Fonctionnalités supplémentaires prises en charge

Les informations suivantes concernent les champs calculés et les 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 faire quelque chose comme ceci :

> 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 peut gérer 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 décimales, 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
• Script, automatisation, CLI : Catalogue de ressources