Powershell: Ninja-Property-Docs-Optionen-Single

Thema

In diesem Artikel wird erläutert, wie Sie mit „Ninja-Property-Docs-Options-Single“gültige Werte für ein Dropdown- oder Mehrfachauswahl-Benutzerdefiniertes Feld in einem einzelnen Dokument abrufen können.

Wenn Sie das NinjaOne-PowerShell-Modul außerhalb eines Skripts für Automatisierungen 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

Dieses Cmdlet ruft gültige Werte für ein benutzerdefiniertes Dropdown- oder Mehrfachauswahlfeld in einem einzelnen Dokument ab. Sie können den Feldnamen mit dem Parameter -AttributeName und das Dokument mit dem Parameter -TemplateName angeben. Das Cmdlet gibt eine Liste gültiger Optionen im Format <GUID>=<NAME> zurück, wobei <GUID> die eindeutige Kennung der Option und <NAME> der Anzeigename der Option ist. Nur für Dokumentfelder mit Leserechten für die Automatisierung können die Optionen mit diesem Cmdlet abgerufen werden.

Syntax

Ninja-Property-Docs-Optionen-Single [[-TemplateName] <OBJECT>] [[-AttributeName] <OBJECT>] [<COMMONPARAMETERS>]

Beispiele

Beispiel 1: Ein benutzerdefiniertes Dropdown-Feld

PS C:> Ninja-Property-Docs-Optionen-Single -TemplateName „My Example
Dokument“ -AttributeName „exampleDropdown“
09d9ef8e-3cdf-4fb2-baf6-9b78b46643a9=Beispiel Option 3
1ff0944e-2bc8-4681-909b-688e77db1cae=Beispiel Option 2
61010919-654f-4448-ba15-48a160d42f44=Vereinfachtes Chinesisch
bd182518-e0ca-4a50-9afb-f9542c1e7d08=Mötley Crüe
c2444bd4-2e75-4acf-944d-b73afd66b27f=Beispiel Option 1

Wenn ein benutzerdefiniertes Dropdown-Feld angegeben wird, gibt das Cmdlet die gültigen Optionen für das Dropdown-Feld im Format <GUID>=<NAME> zurück, wobei <GUID> die eindeutige Kennung der Option und <NAME> der Anzeigename der Option ist.

Beispiel 2: Ein benutzerdefiniertes Feld mit Mehrfachauswahl

PS C:> Ninja-Property-Docs-Options-Single -TemplateName "Mein Beispiel
Dokument" -AttributeName "exampleMultiSelect"
1e6bcc4a-0272-414e-a77c-4109ef79f86e=Option 1
3e08d167-e830-41e7-ae8f-1128e22b00a9=Option 3
4f4f73ba-0d69-4518-a78b-9ca554471b8e=Option 2
680e655d-0b66-4dba-a96e-dcee77ddd1e4=Vereinfachtes Chinesisch

Wenn ein benutzerdefiniertes Feld mit Mehrfachauswahl angegeben wird, gibt das Cmdlet die gültigen Optionen für das Feld mit Mehrfachauswahl im Format <GUID>=<NAME> zurück, wobei <GUID> die eindeutige Kennung für die Option und <NAME> der Anzeigename der Option ist.

Beispiel 3: Ein benutzerdefiniertes Feld ohne Optionen

PS C:> Ninja-Property-Docs-Options-Single -TemplateName „My Example
Document“ -AttributeName „exampleTextField“

Wenn ein benutzerdefiniertes Feld ohne Optionen, wie z. B. ein Textfeld, angegeben wird, gibt das Cmdlet keine Ausgabe zurück.

Parameter

-AttributeName

Geben Sie den Namen des benutzerdefinierten Felds an, für das Sie gültige Optionen abrufen möchten.

Typ: Objekt
Parametersätze: (Alle)
Aliase:
Erforderlich: Falsch
Position: 1
Standardwert: Kein(e)
Pipeline-Eingabe akzeptieren: Falsch
Platzhalterzeichen akzeptieren: Falsch

-TemplateName

Geben Sie den Namen des einzelnen Dokuments an, das das benutzerdefinierte Feld enthält, für das Sie gültige Optionen abrufen möchten.

Typ: Objekt
Parametersätze: (Alle)
Aliase:
Erforderlich: False
Position: 0
Standardwert: Kein(e)
Pipeline-Eingabe akzeptieren: False
Platzhalterzeichen akzeptieren: False

Eingaben

System.String

Das Cmdlet akzeptiert keine Eingaben aus der Pipeline. Die Parameter -TemplateName und -AttributeName akzeptieren Zeichenfolgenwerte, die den Namen des einzelnen Dokuments bzw. den Namen des Benutzerdefinierten Feldes darstellen, für das Sie gültige Optionen abrufen möchten.

Ausgaben

System.String[]

Das Cmdlet gibt die gültigen Optionen für das angegebene benutzerdefinierte Feld im angegebenen einzelnen Dokument im Format <GUID>=<NAME> als Zeichenfolge oder als Array von Zeichenfolgen zurück, wenn mehr als eine Option verfügbar ist.

Dieses Cmdlet gilt nur für benutzerdefinierte Dropdown- und Mehrfachauswahl-Felder. Wenn ein benutzerdefiniertes Feld eines anderen Typs (
) angegeben wird, wird keine Ausgabe zurückgegeben.
Nur für Dokumentfelder mit Lesezugriffsrechten für die Automatisierung können die Optionen mithilfe dieses Cmdlets abgerufen werden. Informationen zu Berechtigungen für benutzerdefinierte Felder finden Sie unter „NinjaOne Custom Fields: Erste Schritte“.

Zusätzliche Ressourcen

Weitere Informationen zur Asset-Verwaltung und zu benutzerdefinierten Skripten finden Sie in den folgenden Ressourcen: