Sujet
Cet article décrit comment utiliser l'automatisation, l'interface de ligne de commande (CLI) et l'API avec la fonctionnalité Documentation de NinjaOne.
Environnement
Documentation NinjaOne
Description
Vous pouvez utiliser l'API publique de NinjaOne et le composant ninjarmm-cli pour gérer vos documents et modèles dans NinjaOne.
Sélectionnez une catégorie pour en savoir plus :
Scripts
- Accédez à Administration> Bibliothèque > Automatisation > Ajouter > Nouveau script.
- À partir de là, vous pouvez accéder aux extraits personnalisés de NinjaOne. Les extraits 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.
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 extraire automatiquement des informations de la Documentation référencée.
CLI
Les champs de la documentation peuvent être lus via l'interface CLI ; cela inclut la possibilité 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 Champs personnalisés et documentation : CLI et scripts. Pour plus d'informations sur le HTML WYSIWYG, veuillez consulter 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 "<template id/name>" - récupère la liste des documents d'un modèle par ID ou nom (guillemets obligatoires)
get "<template id/name>" "<document name>" <attribute name> - récupère un attribut d'un document par nom de document et ID/nom de modèle (guillemets obligatoires)
get "<single template name>" <attribute name> - récupérer l'attribut d'un document unique par nom de modèle (guillemets obligatoires)
org-set "<template id/name>" "<document name>" <attribute name> "<attribute value / comma-separated values list>" - définir l'attribut pour le document/attribut spécifié par nom de document et ID/nom du modèle (guillemets obligatoires)
org-set "<single template name>" <nom d'attribut> "<valeur d'attribut / liste de valeurs séparées par des virgules>" - définit l'attribut d'un document/attribut unique par nom de modèle (guillemets obligatoires)
org-clear "<identifiant/nom du modèle>" "<nom du document>" <nom d'attribut> - efface la valeur d'un document par nom de document et ID/nom de modèle (guillemets obligatoires, représenté par NULL)
org-clear "<nom de modèle unique>" <nom d'attribut> - efface la valeur d'un document unique par nom de modèle (guillemets obligatoires, représenté par NULL)
org-options "<ID/nom de modèle>" "<nom de document>" <nom d'attribut> - récupère la liste des valeurs valides pour le nom d'attribut d'un document en fonction du nom du document et de l'ID/nom du modèle (utilisable pour les attributs de liste déroulante et de sélection multiple)
org-options "<nom de modèle unique>" <nom d'attribut> - récupère la liste des valeurs valides pour le nom d'attribut d'un document unique en fonction du nom du modèle (utilisable pour les attributs de liste déroulante et de sélection multiple)
Il est également possible d'y accéder via l'interface PowerShell sous Windows, à savoir :
Ninja-Property-Docs-Templates
Ninja-Property-Docs-Names $TemplateId
Ninja-Property-Docs-Names "$TemplateName"
Ninja-Property-Docs-Get $TemplateId "$DocumentName" $AttributeName
Ninja-Property-Docs-Set $TemplateID "$DocumentName" $AttributeName
Ninja-Property-Docs-Get-Single "templateName" "fieldName"
Ninja-Property-Docs-Set-Single "templateName" "fieldName" "new value"
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 API publics 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.