Powershell: NinjaProperty abrufen

Thema

In diesem Artikel wird erläutert, wie Sie mit „Get-NinjaProperty“ den Wert eines benutzerdefinierten Feldes anhand seines Namens und Typs abrufen und konvertieren können.

Umgebung

• NinjaOne 
• Microsoft Powershell

Beschreibung

Das Cmdlet „Get-NinjaProperty“ ruft den Wert eines angegebenen benutzerdefinierten Feldes oder Dokumentationsfeldes ab. Sie können den Feldnamen, den Eigenschaftstyp und optional den Namen eines Dokuments oder einer Vorlage angeben. Anhand des Eigenschaftstyps kann das Cmdlet den Rohwert verarbeiten und entsprechend dem Typ des abgerufenen benutzerdefinierten Feldes in ein geeignetes PowerShell-Objekt konvertieren. 

Wird ein Dokumentname angegeben, ruft das Cmdlet den Eigenschaftswert aus dem angegebenen einzelnen Dokument statt aus dem Benutzerdefinierten Gerätefeld ab. Bei Feldern, die zusätzliche Optionen erfordern (z. B. Dropdown- oder Mehrfachauswahlfelder), ruft das Cmdlet diese Optionen ab und gibt die Anzeigenamen der ausgewählten Optionen anstelle des Rohwerts zurück, sofern Sie den entsprechenden Typ angegeben haben.

Zu den unterstützten Eigenschaftstypen gehören: „Anwendungen und Dienste – Dropdown“, „Anwendungen und Dienste –
-Mehrfachauswahl“, „Anhang“, „Kontrollkästchen“, „Datum“, „Datum/Uhrzeit“, „Dezimal“, „Geräte-Dropdown“, „
“, „Gerät – Mehrfachauswahl“, „Dropdown“, „E-Mail“, „Ganze Zahl“, „IP-Adresse“, „Mehrzeilig“, „Mehrfachauswahl“,
„Organisations-Dropdown“, „Organisationsstandort-Dropdown“, „Organisationsstandort-
-Mehrfachauswahl“, „Organisations-Mehrfachauswahl“, „Telefon“, „Sicher“, „Text“, „Zeit“, „URL“ und
„WYSIWYG“.

Wenn kein Eigenschaftstyp angegeben ist, gibt das Cmdlet den rohen Zeichenfolgenwert des benutzerdefinierten Feldes ohne weitere Verarbeitung oder Konvertierung zurück. In den Beispielen zu „Ninja-Property-Get“ wird erläutert, wie Werte verarbeitet werden, wenn kein Typ angegeben ist. Mit diesem Cmdlet können nur Felder abgerufen werden, für die Lesezugriffsrechte für die Automatisierung bestehen.

Syntax

Get-NinjaProperty [-Name] <STRING[]> [[-Typ] <STRING>] [[-Dokumentationsname] <STRING>] [<COMMONPARAMETERS>]

Beispiele

Beispiel 1: Benutzerdefiniertes Feld „Apps und Dienste“ (Dropdown)

PS C:> Get-NinjaProperty -Name „exampleAppsAndServicesDropdown“ -Type
„AppsAndServicesDropdown“
entityId type
-------- ----
5 CLIENT_DOCUMENT

Wenn ein Wert aus dem benutzerdefinierten Feld „Apps und Dienste“ (Dropdown) abgerufen wird, gibt das Cmdlet ein benutzerdefiniertes Objekt vom Typ „
“ zurück, das die EntityId der ausgewählten Option und den Typ der Entität enthält, für die die Option „
“ steht.

Beispiel 2: Benutzerdefiniertes Feld „Apps und Dienste“ mit Mehrfachauswahl

PS C:> Get-NinjaProperty -Name „exampleAppsAndServicesMultiSelect“ -Type„
“ „AppsAndServicesMultiSelect“
entityIds type„
“--------- ----„
“ {6, 5, 4} CLIENT_DOCUMENT

Wenn der Feldwert eines benutzerdefinierten „Apps und Dienste“-Feldes abgerufen wird, gibt das Cmdlet ein benutzerdefiniertes Objekt zurück, das ein Array von „entityIds“ für die ausgewählten Optionen sowie den Typ der Entität enthält, die die Optionen repräsentieren.

Beispiel 3: Benutzerdefiniertes Feld für Anhänge

PS C:> Get-NinjaProperty -Name „deploymentChecklist“ -Type „Anhang“
contentId : RgOJqWzVlAxkwBTBSLeb
extension : docx
mimeType : application/vnd.openxmlformatsofficedocument.
wordprocessingml.document
name : Deployment Checklist
size : 27771

Wenn der Wert eines benutzerdefinierten Felds für einen Anhang abgerufen wird, gibt das Cmdlet ein benutzerdefiniertes Objekt zurück , das die contentId, die Erweiterung, den MIME-Typ, den Namen und die Größe des Anhangs enthält.

Beispiel 4: Benutzerdefiniertes Feld für Kontrollkästchen

PS C:> Get-NinjaProperty -Name „deployed“ -Type „Kontrollkästchen“
True
Wenn der Wert eines benutzerdefinierten Kontrollkästchens abgerufen wird, gibt das Cmdlet einen booleschen Wert („True“ oder „False“) zurück, je nachdem, ob das Kontrollkästchen aktiviert ist oder nicht. Ist der Wert des benutzerdefinierten Kontrollkästchens null, gibt das Cmdlet keine Ausgabe zurück.

Beispiel 5: Benutzerdefiniertes Feld für das Datum

PS C:> Get-NinjaProperty -Name „deploymentDay“ -Type „Datum“
Sonntag, 1. Februar 2026

Wenn der Wert eines benutzerdefinierten Datumsfelds abgerufen wird, gibt das Cmdlet ein „DateTime“-Objekt zurück, das den Datumswert des benutzerdefinierten Felds darstellt. Dieses Datum wird im kulturspezifischen Datumsformat angezeigt und entspricht der lokalen Zeitzone des Geräts.

Beispiel 6: Benutzerdefiniertes Feld für Datum und Uhrzeit

PS C:> Get-NinjaProperty -Name „lastSeen“ -Type „DateTime“
Montag, 2. Februar 2026, 13:00:00 Uhr
Wenn der Wert eines benutzerdefinierten „DateTime“-Feldes abgerufen wird, gibt das Cmdlet ein „DateTime“-Objekt
zurück, das den Wert des benutzerdefinierten Feldes für Datum und Uhrzeit darstellt. Dieses Datum und diese Uhrzeit werden unter
im kulturspezifischen Datums- und Zeitformat angezeigt und entsprechen der lokalen Zeitzone des Geräts.

Beispiel 7: Benutzerdefiniertes Feld vom Typ „Dezimal“

PS C:> Get-NinjaProperty -Name „pi“ -Typ „Dezimal“
3.14

Wenn der Wert eines benutzerdefinierten Dezimalfelds abgerufen wird, gibt das Cmdlet einen Wert vom Typ „Decimal“ zurück.

Beispiel 8: Benutzerdefiniertes Geräte-Dropdown-Feld

PS C:> Get-NinjaProperty -Name „exampleDeviceDropdown“ -Type
„DeviceDropdown“
entityIds type
--------- ----
{160} NODE

Wenn ein Wert des benutzerdefinierten Felds „Geräte-Dropdown“ abgerufen wird, gibt das Cmdlet ein benutzerdefiniertes Objekt vom Typ „
“ zurück, das die „entityId“ des ausgewählten Geräts und den Entitätstyp enthält.

Beispiel 9: Benutzerdefiniertes Feld „Device MultiSelect“

--------- ----{160, 188} NODE

Wenn ein Wert des benutzerdefinierten Felds „Device MultiSelect“ abgerufen wird, gibt das Cmdlet ein benutzerdefiniertes „
“-Objekt zurück, das ein Array mit den „entityIds“ der ausgewählten Geräte und den Typ der Entität enthält.

Beispiel 10: Benutzerdefiniertes Dropdown-Feld

PS C:> Get-NinjaProperty -Name „favoriteBand“ -Type „Dropdown“
Mötley Crüe

Wenn der Wert eines benutzerdefinierten Dropdown-Feldes abgerufen wird, gibt das Cmdlet den Anzeigenamen der ausgewählten Option von „
“ als Zeichenfolge zurück.

Beispiel 11: Benutzerdefiniertes Feld für E-Mails

PS C:> Get-NinjaProperty -Name „supportEmail“ -Type „E-Mail“
[email protected]

Wenn ein Wert aus einem benutzerdefinierten E-Mail-Feld abgerufen wird, gibt das Cmdlet die E-Mail-Adresse als Zeichenfolge vom Typ „
“ zurück.

Beispiel 12: Benutzerdefiniertes Feld vom Typ „Ganze Zahl“

PS C:> Get-NinjaProperty -Name "favoriteNumber" -Type "Ganze Zahl"
42

Wenn der Wert eines benutzerdefinierten Feldes vom Typ „Ganze Zahl“ abgerufen wird, gibt das Cmdlet einen Wert vom Typ „Ganze Zahl“ zurück.

Beispiel 13: Benutzerdefiniertes Feld vom Typ „IP-Adresse“

PS C:> Get-NinjaProperty -Name „primaryDNS“ -Type „IPAddress“
1.1.1.1

Wenn der Feldwert eines benutzerdefinierten Felds vom Typ „IP-Adresse“ abgerufen wird, gibt das Cmdlet die IP-Adresse als Zeichenfolge vom Typ „
“ zurück.

Beispiel 14: Mehrzeiliges benutzerdefiniertes Feld

PS C:> Get-NinjaProperty -Name "exampleMultiline" -Typ "Multiline"
Zeile 1
Zeile 3

Wenn der Wert eines mehrzeiligen benutzerdefinierten Felds abgerufen wird, gibt das Cmdlet den Wert als Zeichenfolge zurück – oder, falls mehr als eine Zeile vorhanden ist, als Array von Zeichenfolgen (
).

Beispiel 15: Benutzerdefiniertes Feld vom Typ „MultiSelect“

PS C:> Get-NinjaProperty -Name „exampleMultiselect“ -Type „MultiSelect“
Option 1
Wert 3

Wenn der Feldwert eines benutzerdefinierten „MultiSelect“-Feldes abgerufen wird, gibt das Cmdlet die Anzeigenamen der ausgewählten Optionen als Zeichenfolge oder – falls mehr als eine Option ausgewählt ist – als Array von Zeichenfolgen zurück.

Beispiel 16: Benutzerdefiniertes Feld „Organisations-Dropdown“

PS C:> Get-NinjaProperty -Name „exampleOrganizationDropdown“ -Type
OrganizationDropdown“
entityId type
-------- ----
8 CLIENT

Wenn der Feldwert eines benutzerdefinierten Felds „Organisations-Dropdown“ abgerufen wird, gibt das Cmdlet ein benutzerdefiniertes
-Objekt zurück, das die entityId der ausgewählten Organisation und den Typ der Entität enthält.

Beispiel 17: Benutzerdefiniertes Feld „Standort der Organisation“ (Dropdown)

PS C:> Get-NinjaProperty -Name „exampleOrganizationLocationDropdown“ -Typ
„OrganizationLocationDropdown“
entityId Typ
-------- ----
8 CLIENT_LOCATION

Wenn ein Wert des benutzerdefinierten Felds „Organization Location Dropdown“ abgerufen wird, gibt das Cmdlet ein benutzerdefiniertes Objekt vom Typ „
“ zurück, das die Entity-ID des ausgewählten Organisationsstandorts und den Entity-Typ „
“ enthält.

Beispiel 18: Benutzerdefiniertes Feld „Organization MultiSelect“

PS C:> Get-NinjaProperty -Name „exampleOrganizationMultiSelect“ -Type
„OrganizationMultiSelect“
entityIds type
--------- ----
{8, 13} CLIENT

Wenn ein Feldwert des benutzerdefinierten Felds „Organization MultiSelect“ abgerufen wird, gibt das Cmdlet ein benutzerdefiniertes „
“-Objekt zurück, das ein Array von „entityIds“ für die ausgewählten Organisationen und den Entitätstyp „
“ enthält.

Beispiel 19: Benutzerdefiniertes Feld „Organization Location MultiSelect“

PS C:> Get-NinjaProperty -Name „exampleOrganizationLocationMultiSelect“ -
Type „OrganizationLocationMultiSelect“

[email protected] --------- ----
{8, 1} CLIENT_LOCATION

Wenn der Feldwert eines benutzerdefinierten Feldesvom Typ „Organization Location MultiSelect“ abgerufen wird, gibt das Cmdlet „
“ ein benutzerdefiniertes Objekt zurück, das ein Array mit den Entity-IDs der ausgewählten Standorte der Organisation
sowie den Entitätstyp enthält.

Beispiel 20: Benutzerdefiniertes Feld „Telefon“

PS C:> Get-NinjaProperty -Name „supportNumber“ -Typ „Telefon“
+18008675309

Wenn der Wert eines benutzerdefinierten Felds vom Typ „Phone“ abgerufen wird, gibt das Cmdlet die Telefonnummer als Zeichenfolge zurück.

Beispiel 21: Benutzerdefiniertes Feld vom Typ „Secure“

PS C:> Get-NinjaProperty -Name „superSecretPassword“ -Typ „Secure“
Hunter42

Wenn der Wert eines benutzerdefinierten Felds vom Typ „Secure“ abgerufen wird, gibt das Cmdlet den Wert als Zeichenfolge zurück.

Beispiel 22: Benutzerdefiniertes Feld

PS C:> Get-NinjaProperty -Name „exampleTextField“ -Type „Text“
My Text

Wenn der Wert eines benutzerdefinierten Felds abgerufen wird, gibt das Cmdlet den Wert als Zeichenfolge zurück.

Beispiel 23: Benutzerdefiniertes Feld für die Zeit

PS C:> Get-NinjaProperty -Name "updateTime" -Type "Time"
9:00:00 Uhr

Wenn der Wert eines benutzerdefinierten Felds abgerufen wird, gibt das Cmdlet ein DateTime-Objekt
zurück, das den Zeitwert des benutzerdefinierten Felds darstellt. Diese Zeit wird im kulturspezifischen Zeitformat
angezeigt und entspricht der lokalen Zeitzone des Geräts.

Beispiel 24: Benutzerdefiniertes Feld „URL“

PS C:> Get-NinjaProperty -Name "exampleUrl" -Type "Url"
https://www.ninjaone.com

Wenn der Wert eines benutzerdefinierten URL-Feldes abgerufen wird, gibt das Cmdlet die URL als Zeichenfolge zurück.

Beispiel 25: Benutzerdefiniertes WYSIWYG-Feld

PS C:> Get-NinjaProperty -Name "systemPerformance" -Typ "WYSIWYG"
html
----
<DIV> <DIV class='card flex-grow-1'>...</DIV>

Wenn der Wert eines benutzerdefinierten WYSIWYG-Feldes abgerufen wird, gibt das Cmdlet ein benutzerdefiniertes Objekt
zurück, das den String-Wert des benutzerdefinierten Feldes enthält.

Parameter

-DocumentName

Geben Sie den Namen des Dokuments an, von dem der Wert des angegebenen Benutzerdefinierten Felds der Dokumentation abgerufen werden soll.

Typ: Zeichenfolge
Parameter-Sätze: (ALLES)
Aliase:
Erforderlich: False
Position: 2
Standardwert: Kein(e)
Pipeline-Eingabe akzeptieren: False
Platzhalterzeichen akzeptieren: False

-Name

Geben Sie den Namen des Geräts oder des benutzerdefinierten Feldes für die Dokumentation an, dessen Wert Sie abrufen möchten
.

Typ: Zeichenkette[]
Parameter-Sätze: (Alle)
Aliase:
Erforderlich: True
Position: 0
Standardwert: Kein(e)
Pipeline-Eingabe akzeptieren: True (ByValue)
Platzhalterzeichen akzeptieren: Falsch

-Typ

Der Typ des benutzerdefinierten Feldes, der bestimmt, wie der abgerufene Wert verarbeitet und
konvertiert wird.
Zu den unterstützten Typen gehören: „Apps und Dienste – Dropdown“, „Apps und Dienste – Mehrfachauswahl“,
„Anhang“, „Kontrollkästchen“, „Datum“, „Datum/Uhrzeit“, „Dezimalzahl“, „Gerät – Dropdown“, „Gerät –
-Mehrfachauswahl“, „Dropdown“, „E-Mail“, „Ganze Zahl“, „IP-Adresse“, „Mehrzeilig“, „Mehrfachauswahl“,
„Dropdown-Liste für Organisation“, „Dropdown-Liste für Organisationsstandort“, „
-Mehrfachauswahl für Organisationsstandort“, „Mehrfachauswahl für Organisation“, „Telefon“, „Sicher“, „Text“, „Zeit“, „URL“ und
„WYSIWYG“.

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