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 je nach Typ des abgerufenen benutzerdefinierten Feldes in ein entsprechendes PowerShell-Objekt konvertieren. 

Wenn ein Dokumentname angegeben wird, ruft das Cmdlet den Eigenschaftswert aus dem angegebenen einzelnen Dokument statt aus dem benutzerdefinierten Feld des Geräts ab. Bei Feldern, die zusätzliche Optionen erfordern (z. B. Dropdown-Menüs oder Felder mit Mehrfachauswahl), 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: „Apps und Dienste – Dropdown“, „Apps und Dienste –
-Mehrfachauswahl“, „Anhang“, „Kontrollkästchen“, „Datum“, „Datum/Uhrzeit“, „Dezimalzahl“, „Gerät – Dropdown“, „
“, „Gerät – Mehrfachauswahl“, „Dropdown“, „E-Mail“, „Ganzzahl“, „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 Rohzeichenfolgenwert 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[]> [[-Type] <String>] [[-DocumentName] <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 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 and Services“ mit Mehrfachauswahl

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

Wenn der Wert eines benutzerdefinierten „Apps and Services MultiSelect“-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 „Attachment“
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 Kontrollkästchen-Feld

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

Beispiel 5: Benutzerdefiniertes Datumsfeld

PS C:> Get-NinjaProperty -Name „deploymentDay“ -Type „Date“
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 Datums- und Zeitwert des benutzerdefinierten Feldes 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 „Decimal“

PS C:> Get-NinjaProperty -Name „pi“ -Type „Decimal“
3.14

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

Beispiel 8: Benutzerdefiniertes Dropdown-Feld für Geräte

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 Entity-ID des ausgewählten Geräts und den Entity-Typ enthält.

Beispiel 9: Benutzerdefiniertes Feld „Device MultiSelect“

PS C:> Get-NinjaProperty -Name „exampleDeviceMultiselect“ -Type
„DeviceMultiSelect“
entityIds type
--------- ----
{160, 188} NODE

Wenn ein Wert des benutzerdefinierten Felds „Device MultiSelect“ abgerufen wird, gibt das Cmdlet ein benutzerdefiniertes „
“-Objekt zurück, das ein Array von „entityIds“ für die ausgewählten Geräte sowie den Entitätstyp 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 des „
“ als Zeichenfolge zurück.

Beispiel 11: Benutzerdefiniertes E-Mail-Feld

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

Wenn der Wert eines benutzerdefinierten E-Mail-Feldes abgerufen wird, gibt das Cmdlet die E-Mail-Adresse als Zeichenfolge vom Typ „
“ zurück.

Beispiel 12: Benutzerdefiniertes Feld vom Typ „Integer“

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

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

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

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

Wenn der Wert 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" -Type "Multiline"
Zeile 1
Zeile 3

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

Beispiel 15: Benutzerdefiniertes Feld vom Typ „MultiSelect“

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

Wenn der Wert 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 Wert eines benutzerdefinierten Felds „Organisations-Dropdown“ abgerufen wird, gibt das Cmdlet ein benutzerdefiniertes Objekt vom Typ „
“ zurück, das die „entityId“ der ausgewählten Organisation und den Entitätstyp enthält.

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

PS C:> Get-NinjaProperty -Name "exampleOrganizationLocationDropdown" -Type
"OrganizationLocationDropdown"
entityId type
-------- ----
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 „entityId“ des ausgewählten Organisationsstandorts und den Entitätstyp „
“ enthält.

Beispiel 18: Benutzerdefiniertes Feld „Organization MultiSelect“

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

Wenn ein Wert 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 „Standort der Organisation“ (MultiSelect)

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

entityIds type
--------- ----
{8, 1} CLIENT_LOCATION

Wenn der Wert eines benutzerdefinierten Felds vom 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“ -Type „Phone“
+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" -Type "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 Textfeld

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

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

Beispiel 23: Benutzerdefiniertes Zeitfeld

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

Wenn der Wert eines benutzerdefinierten Zeitfelds 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" -Type "WYSIWYG"
html
----
<div> <div class='card flex-grow-1'>...

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

Parameter

-DocumentName

Geben Sie den Namen des Dokuments an, aus dem der Wert des angegebenen benutzerdefinierten Dokumentationsfelds abgerufen werden soll.

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

-Name

Geben Sie den Namen des Geräts oder des benutzerdefinierten Dokumentationsfeldes an, dessen Wert Sie abrufen möchten
.

Typ: Zeichenkette[]
Parametersätze: (Alle)
Aliase:
Erforderlich: True
Position: 0
Standardwert: Keine
Pipeline-Eingabe zulassen: True (ByValue)
Platzhalterzeichen zulassen: False

-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“, „Ganzzahl“, „IP-Adresse“, „Mehrzeilig“, „Mehrfachauswahl“,
„Dropdown-Menü ‚Organisation‘“, „Dropdown-Menü ‚Standort der Organisation‘“, „
-Menü ‚Standort der Organisation‘ (Mehrfachauswahl)“, „Mehrfachauswahl ‚Organisation‘“, „Telefon“, „Sicher“, „Text“, „Zeit“, „URL“ und
„WYSIWYG“.

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