Thema
Dieser Artikel beschreibt, wie Sie Automatisierung, CLI und API mit der Dokumentationsfunktion von NinjaOne nutzen können.
Umgebung
NinjaOne-Dokumentation
Beschreibung
Sie können die öffentliche API von NinjaOne und die Komponente „ninjarmm-cli“ verwenden, um Ihre Dokumente und Vorlagen in NinjaOne zu verwalten.
Wählen Sie eine Kategorie aus, um mehr zu erfahren:
Skripte
- Navigieren Sie zu „Administration“> „Bibliothek“ > „Automatisierung“ > „Hinzufügen“ > „Neues Skript“.
- Von hier aus können Sie auf die benutzerdefinierten Snippets von NinjaOne zugreifen. Benutzerdefinierte Snippets sind Bausteine innerhalb von Skripten, die Anweisungen wie „Lies dies“ oder „Schreibe dies“ enthalten und die Erstellung eines Skripts unterstützen, das mit der Dokumentation interagiert.
- Wählen Sie zunächst die gewünschte Programmiersprache, das Betriebssystem und die Architektur aus. Rufen Sie das Snippet-Menü mit Strg + Leertaste auf.
Wenn Sie das Skript nun auf einem Gerät ausführen (entweder über eine geplante Aufgabe, ein geplantes Skript oder ad hoc), können Sie Informationen automatisch aus der referenzierten Dokumentation abrufen.
CLI
Dokumentationsfelder können über die CLI ausgelesen werden; dies umfasst auch die Möglichkeit, HTML über die CLI zu übergeben, um den Wert von WYSIWYG-Feldern festzulegen. Ausführlichere Informationen zu Skripten und Dokumentation finden Sie unter Benutzerdefinierte Felder und Dokumentation: CLI und Skripte. Weitere Informationen zu WYSIWYG-HTML finden Sie unter WYSIWYG: Unterstützte HTML-Elemente und Inline-Styling.
Im Folgenden finden Sie ein Beispiel für die Schnittstelle zur Dokumentation für die Windows-CLI:
templates – Liste der Vorlagen abrufen, die Dokumente und Attribute enthalten
documents "<template id/name>" – Liste der Dokumente für eine Vorlage nach ID oder Name abrufen (Anführungszeichen erforderlich)
get "<template id/name>" "<document name>" <attribute name> – Attribut aus einem Dokument anhand des Dokumentnamens und der Vorlagen-ID/des Vorlagennamens abrufen (Anführungszeichen erforderlich)
get "<single template name>" <attribute name> – Attribut aus einem einzelnen Dokument anhand des Vorlagennamens abrufen (Anführungszeichen erforderlich)
org-set "<template id/name>" "<document name>" <attribute name> "<attribute value / comma-separated values list>" – Attribut für das angegebene Dokument/Attribut anhand des Dokumentnamens und der Vorlagen-ID/des Vorlagennamens setzen (Anführungszeichen erforderlich)
org-set "<single template name>" <Attributname> "<Attributwert / durch Kommas getrennte Werteliste>" – setzt das Attribut für ein einzelnes Dokument/Attribut anhand des Vorlagennamens (Anführungszeichen erforderlich)
org-clear "<Vorlagen-ID/Name>" "<Dokumentname>" <Attributname> – Wert des Dokuments anhand des Dokumentnamens und der Vorlagen-ID/des Vorlagennamens löschen (Anführungszeichen erforderlich, wird als NULL dargestellt)
org-clear "<Name einer einzelnen Vorlage>" <Attributname> – Wert eines einzelnen Dokuments anhand des Vorlagennamens löschen (Anführungszeichen erforderlich, wird als NULL dargestellt)
org-options "<Vorlagen-ID/Name>" "<Dokumentname>" <Attributname> – Liste der gültigen Werte für den Dokumentattributnamen anhand des Dokumentnamens und der Vorlagen-ID/des Vorlagennamens abrufen (gilt für Dropdown- und Mehrfachauswahl-Attribute)
org-options "<Name einer einzelnen Vorlage>" <Attributname> – Liste der gültigen Werte für den Attributnamen eines einzelnen Dokuments anhand des Vorlagennamens abrufen (gilt für Dropdown- und Mehrfachauswahl-Attribute)
Der Zugriff ist auch über die PowerShell-Schnittstelle unter Windows möglich, und zwar:
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
Dokumentationsfelder können über öffentliche API-Endpunkte mit client_credential-Authentifizierung erstellt und aktualisiert werden und ermöglichen die Integration von Drittanbieterdiensten. Weitere Informationen finden Sie unter NinjaOne Public API Operations.