Thema
In diesem Artikel wird beschrieben, wie Sie Automatisierung, CLI und API mit der Dokumentationsfunktion von NinjaOne verwenden können.
Umgebung
NinjaOne Documentation
Beschreibung
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 "Lesen Sie dies" oder "Schreiben Sie dies" sagen und bei der Erstellung eines Skripts helfen, das mit der Dokumentation interagiert.
- Um zu beginnen, wählen Sie die gewünschte Programmiersprache, das Betriebssystem und die Architektur aus. Verwenden Sie Strg + Leertaste, um das Snippet-Menü aufzurufen.
Wenn Sie nun das Skript auf einem Gerät ausführen (entweder über ein geplantes Skript oder ad hoc), können Sie Informationen automatisch aus der referenzierten Dokumentation abrufen.
CLI
Dokumentationsfelder können über die CLI gelesen 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 Skripting. Weitere Informationen zu WYSIWYG HTML finden Sie unter WYSIWYG: Unterstützte HTML- und Inline-Stile.
Das folgende Beispiel zeigt die Schnittstelle für die Dokumentation für Windows CLI:
templates – Liste der Vorlagen mit Dokumenten und Attributen abrufen
documents "<template id/name>" – Liste der Dokumente für die Vorlage nach ID oder Name abrufen (Anführungszeichen erforderlich)
get "<template id/name>" "<Dokumentname>" <Attributname> - Attribut aus Dokument nach Dokumentname und Vorlagen-ID/Name abrufen (Anführungszeichen erforderlich)
get "<Einzelvorlagenname>" <Attributname> - Attribut aus Einzel-Dokument nach Vorlagenname abrufen (Anführungszeichen erforderlich)
org-set "<Vorlagen-ID/Name>" "<Dokumentname>" <Attributname> "<Attributwert / durch Kommas getrennte Liste von Werten>" - setzt das Attribut für das angegebene Dokument/Attribut anhand des Dokumentnamens und der Vorlagen-ID/des Vorlagennamens (Anführungszeichen erforderlich)
org-set "<single template name>" <attribute name> "<attribute value / comma-separated values list>" - Setzt das Attribut für ein einzelnes Dokument/Attribut anhand des Vorlagennamens (Anführungszeichen erforderlich)
org-clear "<template id/name>" "<Dokumentname>" <Attributname> - Wert des Dokuments nach Dokumentname und Vorlagen-ID/Name löschen (Anführungszeichen erforderlich, wird als NULL dargestellt)
org-clear "<Name der einzelnen Vorlage>" <Attributname> - Wert des einzelnen Dokuments nach Vorlagenname löschen (Anführungszeichen erforderlich, wird als NULL dargestellt)
org-options "<Vorlagen-ID/Name>" "<Dokumentname>" <Attributname> - Liste der gültigen Werte für Dokumentattributnamen nach Dokumentname und Vorlagen-ID/Name abrufen (gilt für Drop-down- und Mehrfachauswahl-Attribute)
org-options "<Einzelvorlagenname>" <Attributname> - Liste der gültigen Werte für einzelne Dokumentattributnamen nach Vorlagenname abrufen (gilt für Drop-down- und Mehrfachauswahl-Attribute)
Auf diese kann auch über die PowerShell-Schnittstelle unter Windows zugegriffen werden, die wie folgt lautet:
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.