Powershell: Ninja-Property-Get

Thema

In diesem Artikel wird erläutert, wie Sie mit „Ninja-Property-Get“ den Wert eines bestimmten benutzerdefinierten Gerätefelds abrufen können.

„Ninja-Property-Get“ ist ein veraltetes Cmdlet. Es funktioniert zwar möglicherweise noch, wir empfehlen jedoch, stattdessen „Get-NinjaProperty“ zu verwenden.

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-Get“ ruft den Wert eines angegebenen benutzerdefinierten Feldes eines Geräts ab. Sie können den Namen des benutzerdefinierten Feldes mithilfe des Parameters „-Name“ angeben. Das Cmdlet gibt den aktuellen Wert des angegebenen benutzerdefinierten Feldes für das Gerät zurück. Mit diesem Cmdlet können nur Felder abgerufen werden, für die Lesezugriffsrechte für die Automatisierung bestehen.

Syntax

Ninja-Property-Get [[-Name] <Object>] [<CommonParameters>]

Beispiele

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

PS C:> Ninja-Property-Get -Name "exampleAppsAndServicesDropdown"
{"entityId":5,"type":"CLIENT_DOCUMENT"}

Beim Abrufen des Werts eines benutzerdefinierten Felds „Apps und Dienste“ (Dropdown) gibt das Cmdlet eine JSON-Zeichenkette zurück, die die „entityId“ und den „type“ des ausgewählten Elements enthält.

Beispiel 2: Benutzerdefiniertes Feld „Apps und Dienste“ (Mehrfachauswahl)

PS C:> Ninja-Property-Get -Name "exampleAppsAndServicesMultiselect"
{"entityIds":[6,5,4],"type":"CLIENT_DOCUMENT"}

Beim Abrufen des Werts eines benutzerdefinierten Felds vom Typ „Apps und Dienste – Mehrfachauswahl“ gibt das Cmdlet eine JSON-Zeichenkette zurück, die ein Array von „entityIds“ enthält, welche die ausgewählten Elemente repräsentieren, sowie den Typ der ausgewählten Elemente.

Beispiel 3: Benutzerdefiniertes Feld „Anhang“

 PS C:> Ninja-Property-Get -Name "deploymentChecklist"
{"contentId":"RgOJqWzVlAxkwBTBSLeb","extension":"docx","mimeType":"applicati
on/vnd.openxmlformatsofficedocument.
wordprocessingml.document","name":"Deployment
Checklist","size":27771}

Beim Abrufen des Werts eines benutzerdefinierten Felds vom Typ „Anhang“ gibt das Cmdlet eine JSON-Zeichenkette zurück, die Details zum Anhang enthält, darunter „contentId“, „extension“, „mimeType“, „name“ und „size“.

Beispiel 4: Benutzerdefiniertes Kontrollkästchen-Feld

 PS C:> Ninja-Property-Get -Name "deployed"
1

Beim Abrufen des Werts eines benutzerdefinierten Kontrollkästchen-Feldes gibt das Cmdlet 1 zurück, wenn das Kontrollkästchen aktiviert ist (true), und 0, wenn es nicht aktiviert ist (false). Ist kein Wert ausgewählt, gibt das Cmdlet keine Ausgabe zurück.

Beispiel 5: Benutzerdefiniertes Datumsfeld

 PS C:> Ninja-Property-Get -Name "deploymentDay"
1769976000

Beim Abrufen des Werts eines benutzerdefinierten Datumsfelds gibt das Cmdlet den Datumswert als Unix-Zeitstempel zurück, der die Anzahl der Sekunden angibt, die seit dem 1. Januar 1970 (UTC) vergangen sind.

Beispiel 6: Benutzerdefiniertes „DateTime“-Feld

 PS C:> Ninja-Property-Get -Name "lastSeen"
1770904800

Beim Abrufen des Werts eines benutzerdefinierten „DateTime“-Feldes gibt das Cmdlet den Datums- und Zeitwert als Unix-Zeitstempel zurück, der die Anzahl der Sekunden angibt, die seit dem 1. Januar 1970 (UTC) verstrichen sind.

Beispiel 7: Benutzerdefiniertes Feld vom Typ „Decimal“

PS C:> Ninja-Property-Get -Name "pi"
3,14

Beim Abrufen des Werts eines benutzerdefinierten Dezimalfelds gibt das Cmdlet den Dezimalwert als Zeichenfolge zurück.

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

PS C:> Ninja-Property-Get -Name "exampleDeviceDropdown"
{"entityId":1226,"type":"NODE"}

Beim Abrufen des Werts eines benutzerdefinierten Felds vom Typ „Geräte-Dropdown“ gibt das Cmdlet eine JSON-Zeichenkette zurück, die die `entityId` und den Typ des ausgewählten Geräts enthält.

Beispiel 9: Benutzerdefiniertes Feld „Geräte-Mehrfachauswahl“

PS C:> Ninja-Property-Get -Name "exampleDeviceMultiselect"
{"entityIds":[1226,1131],"type":"NODE"}

Beim Abrufen des Werts eines benutzerdefinierten Felds vom Typ „Geräte-Mehrfachauswahl“ gibt das Cmdlet eine JSON-Zeichenkette zurück, die ein Array von entityIds enthält, welche die ausgewählten Geräte repräsentieren, sowie den Typ der ausgewählten Geräte.

Beispiel 10: Benutzerdefiniertes Dropdown-Feld

PS C:> Ninja-Property-Get -Name "favoriteBand"
2a100199-4067-4332-8f4d-451e14b94a76

Beim Abrufen des Werts eines benutzerdefinierten Dropdown-Feldes gibt das Cmdlet die eindeutige Kennung (ID) der ausgewählten Option als Zeichenfolge zurück. Mit „Ninja-Property-Options“ können Sie die gültigen Optionen für das Dropdown-Feld und die entsprechenden IDs abrufen.

Beispiel 11: Benutzerdefiniertes E-Mail-Feld

PS C:> Ninja-Property-Get -Name „supportEmail“
[email protected]

Beim Abrufen des Werts eines benutzerdefinierten E-Mail-Feldes gibt das Cmdlet die E-Mail-Adresse als Zeichenfolge zurück.

Beispiel 12: Benutzerdefiniertes Feld vom Typ „Ganzzahl“

 PS C:> Ninja-Property-Get -Name "favoriteNumber"
42

Beim Abrufen des Werts eines benutzerdefinierten Felds vom Typ „Ganzzahl“ gibt das Cmdlet den ganzzahligen Wert als Zeichenfolge zurück.

Beispiel 13: Benutzerdefiniertes Feld für IP-Adressen

PS C:> Ninja-Property-Get -Name "primaryDNS"
1.1.1.1

Beim Abrufen des Werts eines benutzerdefinierten Felds vom Typ „IP-Adresse“ gibt das Cmdlet die IP-Adresse als Zeichenfolge zurück.

Beispiel 14: Benutzerdefiniertes Feld mit mehreren Zeilen

PS C:> Ninja-Property-Get -Name "exampleMultiline"
Zeile 1
Zeile 3

Beim Abrufen des Werts eines benutzerdefinierten mehrzeiligen Felds gibt das Cmdlet die mehreren Textzeilen als Array von Zeichenfolgen zurück, wobei jede Zeichenfolge im Array einer Textzeile im mehrzeiligen Feld entspricht. Ist nur eine Textzeile vorhanden, gibt das Cmdlet eine einzelne Zeichenfolge zurück.

Beispiel 15: Benutzerdefiniertes Feld mit Mehrfachauswahl

PS C:> Ninja-Property-Get -Name "exampleMultiselect"
834d0865-1c70-492b-ac11-73854fd0294d, 154d90cf-3d4a-4e43-8b79-232ccd5b74a6

Beim Abrufen des Werts eines benutzerdefinierten MultiSelect-Feldes gibt das Cmdlet eine durch Kommas getrennte Zeichenfolge der eindeutigen Kennungen (IDs) der ausgewählten Optionen zurück. Mit „Ninja -Property-Options“ können Sie die gültigen Optionen für das MultiSelect-Feld und die dazugehörigen IDs abrufen.

Beispiel 16: Benutzerdefiniertes Dropdown-Feld „Organisation“

PS C:> Ninja-Property-Get -Name "exampleOrganizationDropdown"
{"entityId":8,"type":"CLIENT"}

Beim Abrufen des Werts eines benutzerdefinierten Dropdown-Feldes für die Organisation gibt das Cmdlet eine JSON-Zeichenkette zurück, die die „entityId“ und den Typ der ausgewählten Organisation enthält.

Beispiel 17: Benutzerdefiniertes Dropdown-Feld für den Organisationsstandort

PS C:> Ninja-Property-Get -Name "exampleOrganizationLocationDropdown"
{"entityId":8,"type":"CLIENT_LOCATION"}

Beim Abrufen des Werts eines benutzerdefinierten Felds vom Typ „Standort der Organisation“ (Dropdown) gibt das Cmdlet eine JSON-Zeichenkette zurück, die die entityId und den Typ des ausgewählten Organisationsstandorts enthält.

Beispiel 18: Benutzerdefiniertes Feld „Mehrfachauswahl für Organisation“

PS C:> Ninja-Property-Get -Name "exampleOrganizationMultiSelect"
{"entityIds":[8,13],"type":"CLIENT"}

Beim Abrufen des Werts eines benutzerdefinierten Felds vom Typ „Organisations-Mehrfachauswahl“ gibt das Cmdlet eine JSON-Zeichenkette zurück, die ein Array von „entityIds“ enthält, welche die ausgewählten Organisationen repräsentieren, sowie den Typ der ausgewählten Organisationen.

Beispiel 19: Benutzerdefiniertes Feld „Standort der Organisation“ (MultiSelect)

PS C:> Ninja-Property-Get -Name "exampleOrganizationLocationMultiSelect"
{"entityIds":[8,1],"type":"CLIENT_LOCATION"}

Beim Abrufen des Werts eines benutzerdefinierten „Organization Location MultiSelect“-Feldes gibt das Cmdlet eine JSON-Zeichenkette zurück, die ein Array von „entityIds“ enthält, welche die ausgewählten Organisationsstandorte und den Typ der ausgewählten Organisationsstandorte darstellen.

Beispiel 20: Benutzerdefiniertes Feld „Telefonnummer“

PS C:> Ninja-Property-Get -Name "supportNumber"
+18008675309

Beim Abrufen des Werts eines benutzerdefinierten Felds „Telefonnummer“ gibt das Cmdlet die Telefonnummer als Zeichenfolge zurück.

Beispiel 21: Sicherheits-Benutzerdefiniertes Feld

PS C:> Ninja-Property-Get -Name "superSecretPassword"
Hunter42

Beim Abrufen des Werts eines sicheren benutzerdefinierten Felds gibt das Cmdlet den gesicherten Wert als Zeichenfolge zurück.

Beispiel 22: Benutzerdefiniertes Textfeld

PS C:> Ninja-Property-Get -Name "exampleText"
My Text

Beim Abrufen des Werts eines benutzerdefinierten Textfelds gibt das Cmdlet den Textwert als Zeichenfolge zurück.

Beispiel 23: Benutzerdefiniertes Zeitfeld

 PS C:> Ninja-Property-Get -Name "updateTime"
 79200

Beim Abrufen des Werts eines benutzerdefinierten Zeitfelds gibt das Cmdlet die Anzahl der Sekunden seit Mitternacht UTC (für den aktuellen Tag) zurück.

Beispiel 24: Benutzerdefiniertes URL-Feld

PS C:> Ninja-Property-Get -Name "exampleUrl"
https://www.google.com

Beim Abrufen des Werts eines benutzerdefinierten URL-Feldes gibt das Cmdlet die URL als Zeichenfolge zurück.

Beispiel 25: Benutzerdefiniertes WYSIWYG-Feld

PS C:> Ninja-Property-Get -Name "systemPerformance"
{"html":"<div> <div class='card flex-grow-1'>n <div class='card-titlebox'>
n <div class='card-title'><i class='fa-solid fa-gauge-high'>
</i>&nbsp;&nbsp;Systemleistungsmetriken</div>..."}

Beim Abrufen des Werts eines benutzerdefinierten WYSIWYG-Feldes gibt das Cmdlet eine JSON-Zeichenkette zurück, die den HTML-Inhalt des Feldes enthält.

Parameter

-Name

Geben Sie den Namen des benutzerdefinierten Gerätefelds an, dessen Wert 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

Das Cmdlet akzeptiert keine Eingaben aus der Pipeline. Der Parameter „-Name“ akzeptiert einen Zeichenfolgenwert, der den Namen des benutzerdefinierten Gerätefelds angibt, dessen Wert Sie abrufen möchten.

Ausgaben

System.String[]

Das Cmdlet gibt den Wert des angegebenen benutzerdefinierten Gerätefelds als Zeichenfolge zurück. Bei mehrzeiligen benutzerdefinierten Feldern gibt das Cmdlet ein Array von Zeichenfolgen zurück, wobei jede Zeichenfolge im Array einer Textzeile im mehrzeiligen Feld entspricht.

Alle zeit- und datumsbezogenen Felder werden in der UTC-Zeitzone zurückgegeben, in der Web-Benutzeroberfläche jedoch in der lokalen Zeitzone des Browsers angezeigt, mit dem das Feld aufgerufen wird.
Das Gerät, auf dem dieses Cmdlet ausgeführt wird, muss über die Berechtigung zum Anzeigen des angegebenen benutzerdefinierten Feldes verfügen, um dessen Wert abrufen zu können. Informationen zu Berechtigungen für benutzerdefinierte Felder finden Sie unter „NinjaOne Custom Fields: Getting Started“.

Weitere Ressourcen

Weitere Informationen zum Asset-Management und zu benutzerdefinierten Skripten finden Sie in den folgenden Ressourcen: