Powershell: Ninja-Eigenschafts-Dokumentation-Namen

Thema

In diesem Artikel wird erläutert, wie Sie mit Ninja-Property-Docs-Names die ID oder den Namen von Dokumenten abrufen können, die einer Vorlagen-ID zugeordnet sind.

Wenn Sie das NinjaOne-PowerShell-Modul außerhalb eines Automatisierungsskripts verwenden, müssen Sie möglicherweise die Ausführungsrichtlinie von PowerShell anpassen. Weitere Informationen zu Ausführungsrichtlinien finden Sie in der Dokumentation von Microsoft: Über Ausführungsrichtlinien ( externer Link).

Umgebung

NinjaOne
Microsoft PowerShell

Beschreibung

Das Cmdlet „Ninja-Property-Docs-Names“ ruft die ID oder den Namen von Dokumenten ab, die einer Vorlagen-ID zugeordnet sind. Sie können die Dokumentvorlage mithilfe des Parameters „-TemplateId“ angeben. Das Cmdlet gibt die ID oder den Namen des Dokuments bzw. der Dokumente, die der angegebenen Vorlagen-ID zugeordnet sind, im Format <id>=<name> zurück.

Syntax

Ninja-Property-Docs-Names [[-TemplateId] <Object>] [<CommonParameters>]

Beispiele

Beispiel 1: Liste der Seiten

PS C:> Ninja-Property-Docs-Names -TemplateId "11"
10=Dokument 1
11=Dokument 2

Wenn eine Dokumentvorlage mehrere Dokumente enthält, gibt das Cmdlet die ID und den „
“-Namen jedes zugehörigen Dokuments im Format <id>=<name> zurück.

Beispiel 2: Einzelnes Dokument

PS C:> Ninja-Property-Docs-Names -TemplateId "4"
5=Remotezugriff

Wenn ein einzelnes Dokument einer Dokumentvorlage zugeordnet ist, gibt das Cmdlet die ID, den „
“-Namen und den Namen nur dieses einzelnen Dokuments im Format <id>=<name> zurück.

Parameter

TemplateId

Geben Sie die ID der Dokumentvorlage an, die die Dokumente enthält, die Sie abrufen möchten.

Typ: Objekt
Parametersätze: (Alle)
Aliase:
Erforderlich: False
Position: 0
Standardwert: Keine
Pipeline-Eingabe zulassen: False
Platzhalterzeichen zulassen: False

Eingaben

System.String

Dieses Cmdlet akzeptiert keine Eingaben aus der Pipeline. Der Parameter „-TemplateId“ akzeptiert Zeichenfolgenwerte, die die ID der Dokumentvorlage darstellen, die die Dokumente enthält, die Sie abrufen möchten.

Ausgaben

System.String[]

Das Cmdlet gibt die ID und den Namen des Dokuments bzw. der Dokumente zurück, die der angegebenen Vorlagen-ID zugeordnet sind, im Format <id>=<name> als Zeichenfolge oder als Array von Zeichenfolgen, falls der Vorlage mehr als ein Dokument zugeordnet ist.

Zum Abrufen von Werten benutzerdefinierter Felder sind Leseberechtigungen für die Automatisierung erforderlich. Informationen zu Berechtigungen für benutzerdefinierte Felder finden Sie unter „NinjaOne Custom Fields: Getting Started“.

Weitere Ressourcen

Weitere Informationen zur Asset-Verwaltung und zur Erstellung benutzerdefinierter Skripte finden Sie in den folgenden Ressourcen: