Rubrique
Cet article décrit comment utiliser l'automatisation, l'interface de ligne de commande (CLI) et l'API avec la fonctionnalité NinjaOne Documentation.
Environnement
NinjaOne Documentation
Description
Vous pouvez utiliser l'API publique de NinjaOne et le composant ninjarmm-cli pour gérer vos documents et vos modèles dans NinjaOne.
Sélectionnez une catégorie pour en savoir plus :
Scripts
- Accédez à Administration> Bibliothèque > Automatisation > Ajouter > Nouveau script.
- Depuis cette page, vous pouvez accéder aux extraits de code personnalisés de NinjaOne. Les extraits de code personnalisés sont des éléments constitutifs des scripts qui indiquent « lire ceci » ou « écrire ceci », et qui facilitent la création d'un script interagissant avec la Documentation.
- Pour commencer, sélectionnez le langage de programmation de votre choix, le système d’exploitation et l’Architecture. Utilisez Ctrl + Espace pour afficher le menu des extraits de code.
Désormais, lorsque vous exécutez le script sur un appareil (via une tâche planifiée, un script planifié ou de manière ponctuelle), vous pouvez récupérer automatiquement des informations issues de la Documentation référencée.
CLI
Les champs de la Documentation peuvent être lus via l’interface CLI ; cela inclut l’autorisation de transmettre du code HTML via l’interface CLI pour définir la valeur des champs WYSIWYG. Pour plus d’informations sur les scripts et la Documentation, veuillez consulter la section « Champs personnalisés et Documentation : CLI et scripts ». Pour plus d’informations sur le HTML WYSIWYG, veuillez consulter la section « WYSIWYG : HTML pris en charge et styles en ligne ».
Voici un exemple d’interface relative à la documentation pour la CLI Windows :
templates - récupère la liste des modèles, qui contiennent des documents et des attributs
documents "<ID/nom du modèle>" - récupère la liste des documents d’un modèle par id ou nom (guillemets obligatoires)
get "<ID/nom du modèle>" "<NOM du document>" <NOM de l’attribut> - récupère un attribut d’un document à partir du nom du document et de l’id/nom du modèle (guillemets obligatoires)
get "<NOM d’un modèle unique>" <NOM d’attribut> — récupérer un attribut d’un document unique par le nom du modèle (guillemets obligatoires)
org-set « <ID/nom du modèle> » « <NOM du document> » <NOM d’attribut> « <VALEUR de l’attribut / liste de valeurs séparées par des virgules> » — définir un attribut pour le document/attribut spécifié par le nom du document et l’id/nom du modèle (guillemets obligatoires)
org-set « <NOM d’un modèle unique> » <NOM d’attribut> "<VALEUR d’attribut / liste de valeurs séparées par des virgules>" - définit l’attribut d’un document/attribut unique en fonction du nom du modèle (guillemets obligatoires)
org-clear "<IDENTIFIANT/nom du modèle>" "<NOM du document>" <NOM d’attribut> – effacer la valeur d’un document par nom de document et ID/nom de modèle (guillemets obligatoires, la valeur est représentée par NULL)
org-clear "<NOM d’un modèle>" <NOM d’attribut> – effacer la valeur d’un document donné par nom de modèle (guillemets obligatoires, la valeur est représentée par NULL)
org-options "<ID/nom de modèle>" "<NOM du document>" <NOM d'attribut> - récupère la liste des valeurs valides pour le nom d'un attribut de document en fonction du nom du document et de l'ID/nom du modèle (utilisable pour les attributs de type Menu déroulant et Sélection multiple)
org-options "<NOM d'un modèle unique>" <NOM d'attribut> - récupère la liste des valeurs valides pour le nom d'un attribut d'un document unique en fonction du nom du modèle (utilisable pour les attributs de type Menu déroulant et Sélection multiple)
Il est également possible d'y accéder via l'interface PowerShell sous Windows, à l'adresse suivante :
Ninja-Property-Docs-Modèles
Ninja-Property-Docs-Modèles Noms $TemplateId
Ninja-Property-Docs-Modèles Noms "$TemplateName"
Ninja-Property-Docs-Clear
Ninja-Property-Docs-Options
API
Les champs de documentation peuvent être créés et mis à jour via des points de terminaison de l’API publique avec une authentification client_credential et permettent l’intégration de services tiers. Pour plus d’informations, veuillez consulter les opérations de l’API publique NinjaOne.