Powershell: Ninja-Property-Set

Thema

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

Umgebung

• NinjaOne
• Microsoft Powershell

Beschreibung

Dieses Cmdlet legt den Wert eines angegebenen benutzerdefinierten Feldes auf dem Gerät fest. Sie können den Feldnamen mit dem Parameter „-Name“ und den festzulegenden Wert mit dem Parameter „-Value“ angeben. Das Cmdlet aktualisiert den Wert des angegebenen benutzerdefinierten Feldes auf dem Gerät.

Mit diesem Cmdlet können nur Felder aktualisiert werden, für die Schreibberechtigungen für Automatisierungen vorhanden sind. Das angegebene benutzerdefinierte Feld wird nach der nächsten erfolgreichen Synchronisierung mit der NinjaOne-Plattform aktualisiert, was in der Regel innerhalb weniger Minuten erfolgt.

Syntax

Ninja-Property-Set [[-Name] <OBJECT>] [[-Wert] <OBJECT>] [<COMMONPARAMETERS>]

Beispiele

Beispiel 1: Benutzerdefiniertes Kontrollkästchen-Feld

PS C:> Ninja-Property-Set -Name „deployed“ -Wert $True

In diesem Beispiel wird das benutzerdefinierte Kontrollkästchenfeld „deployed“ aktiviert, indem sein Wert auf $True gesetzt wird. Sie könnten das Kontrollkästchen auch mit 1 anstelle von $True aktivieren, da beide Werte für benutzerdefinierte Kontrollkästchenfelder akzeptiert werden. Zulässige Werte für Kontrollkästchen: 0, 1, true, false.

Beispiel 2: Benutzerdefiniertes Datumsfeld

$DeploymentDate = Get-Date -Jahr "2026" -Monat "02" -Tag "01" -Stunde "0" -
Minute „0“ -Second „0“
$StartOfEpoch = Get-Date -Year „1970“ -Month „01“ -Day „01“ -Hour „0“ -
Minute „0“ -Second „0“
$DeploymentInUTC = $DeploymentDate.ToUniversalTime()
$TimeSpan = New-TimeSpan -Start $StartOfEpoch -End $DeploymentInUTC
$DeploymentInEpochTime = [math]::Round($TimeSpan.TotalSeconds)
PS C:> Ninja-Property-Set -Name "deploymentDate" -Value
$DeploymentInEpochTime

In diesem Beispiel wird das benutzerdefinierte Feld „deploymentDate“ auf den 1. Februar 2026 gesetzt. Das Datum wird in die Epochenzeit (die Anzahl der Sekunden, die seit dem 1. Januar 1970 UTC vergangen sind) umgewandelt, bevor es als Wert des benutzerdefinierten Feldes festgelegt wird, da benutzerdefinierte Felder in der CLI Epochenzeitwerte akzeptieren. Zulässige Datumsformate: Unix-Epochenzeit (Sekunden seit dem 1. Januar 1970 UTC), ISO-Format „yyyy-MM-dd“ UTC

Beispiel 3: Benutzerdefiniertes Feld für Datum und Uhrzeit

$LastSeen = Get-Date -Year "2026" -Month "02" -Day "02" -Hour "13" -Minute
"0" -Second "0"
$StartOfEpoch = Get-Date -Year "1970" -Month "01" -Day "01" -Hour "0" -
Minute "0" -Second "0"
$LastSeenInUTC = $LastSeen.ToUniversalTime()
$TimeSpan = New-TimeSpan -Start $StartOfEpoch -End $LastSeenInUTC
$LastSeenInEpochTime = [math]::Round($TimeSpan.TotalSeconds)
PS C:> Ninja-Property-Set -Name "lastSeen" -Value $LastSeenInEpochTime

In diesem Beispiel wird das benutzerdefinierte Feld „lastSeen“ auf den 2. Februar 2026 um 13:00 Uhr gesetzt. Der Datums- und Zeitwert wird in die Epochenzeit (die Anzahl der Sekunden, die seit dem 1. Januar 1970 UTC verstrichen sind) umgewandelt, bevor er als Wert des benutzerdefinierten Feldes festgelegt wird, da benutzerdefinierte Datums- und Uhrzeitfelder in der CLI Epochenzeitwerte akzeptieren. Zulässige Formate für Datum und Uhrzeit: Unix-Epoch-Zeit (Sekunden seit dem 1. Januar 1970 UTC), ISO-Format „yyyy-MM-ddTHH:mm:ss“ UTC

Beispiel 4: Benutzerdefiniertes Dezimalfeld

PS C:> Ninja-Property-Set -Name „pi“ -Wert „3.14“

In diesem Beispiel wird das benutzerdefinierte Feld „pi“ auf 3,14 gesetzt. Zulässige Dezimalwerte: Jede Zahl zwischen -9999999,999999 und 9999999,999999.

Beispiel 5: Benutzerdefiniertes Dropdown-Feld

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

In diesem Beispiel wird das benutzerdefinierte Drop-down-Feld „favoriteBand“ auf die Option mit der GUID „2a100199-4067-4332-8f4d-451e14b94a76“ gesetzt. Benutzerdefinierte Drop-down-Felder in der CLI akzeptieren die GUID der Option, die Sie festlegen möchten; diese können Sie mithilfe des Cmdlets „Ninja-Property-Options“ ermitteln. Zulässige Drop-down-Werte: Die GUID der Option, die eingestellt werden soll und die mithilfe des Cmdlets „Ninja-Property-Options“ ermittelt werden kann.

Beispiel 6: Benutzerdefiniertes Feld für E-Mails

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

In diesem Beispiel wird das benutzerdefinierte E-Mail-Feld „supportEmail“ auf „[email protected]“ gesetzt. Zulässige E-Mail-Werte: Irgendeine Zeichenfolge, die dem offiziellen RFC 5322-Standard für E-Mail-Adressen entspricht.

Beispiel 7: Benutzerdefiniertes Feld vom Typ „Ganze Zahl“

PS C:> Ninja-Property-Set -Name „favoriteNumber“ -Value „42“

In diesem Beispiel wird das benutzerdefinierte Feld „favoriteNumber“ auf 42 gesetzt. Zulässige Ganzzahlwerte: Irgendeine ganze Zahl im Bereich von -2147483648 bis 2147483647.

Beispiel 8: Benutzerdefiniertes Feld „IP-Adresse“

PS C:> Ninja-Property-Set -Name „primaryDNS“ -Value „1.1.1.1“

In diesem Beispiel wird das benutzerdefinierte Feld „primaryDNS“ (IP-Adresse) auf „1.1.1.1“ gesetzt. Zulässige IP-Adresswerte: Jede gültige IPv4- oder IPv6-Adresse.

Beispiel 9: Mehrzeiliges benutzerdefiniertes Feld

PS C:> Ninja-Property-Set -Name "exampleMultiline" -Wert "Zeile 1`n`nZeile
3"

In diesem Beispiel wird das mehrzeilige benutzerdefinierte Feld „exampleMultiline“ auf eine Zeichenfolge mit mehreren Textzeilen eingestellt.

Beispiel 10: Benutzerdefiniertes Feld mit Mehrfachauswahl

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

In diesem Beispiel wird das benutzerdefinierte Mehrfachauswahl-Feld „exampleMultiselect“ auf die Optionen mit den GUIDs 154d90cf-3d4a-4e43-8b79-232ccd5b74a6 und 834d0865-1c70-492b-ac11-73854fd0294d festgelegt. Benutzerdefinierte Mehrfachauswahlfelder in der CLI akzeptieren eine durch Kommas getrennte Liste von GUIDs, die die Optionen darstellen, die Sie festlegen möchten. Diese können Sie mit dem Cmdlet „Ninja-Property-Options“ ermitteln. Zulässige Werte für die Mehrfachauswahl: Eine durch Kommas getrennte Liste von GUIDs, die die festzulegenden Optionen darstellen und mit dem Cmdlet „Ninja-Property-Options“ ermittelt werden können.

Beispiel 11: Benutzerdefiniertes Feld „Telefonnummer“

PS C:> Ninja-Property-Set -Name „supportNumber“ -Wert „+18008675309“

In diesem Beispiel wird das benutzerdefinierte Feld „supportNumber“ auf „+18008675309“ gesetzt. Zulässige Telefonwerte: Irgendeine Zeichenfolge, die dem E.164-Standard für Telefonnummern entspricht, d. h. ein Pluszeichen, gefolgt von der Ländervorwahl und der Teilnehmernummer (z. B. +18008675309).

Beispiel 12: Sicheres benutzerdefiniertes Feld

PS C:> Ninja-Property-Set -Name "superSecretPassword" -Value "Hunter42"

In diesem Beispiel wird das gesicherte benutzerdefinierte Feld „superSecretPassword“ auf „Hunter42“ gesetzt. Zulässige Werte für gesicherte Felder: Irgendeine Zeichenfolge mit weniger als 200 Zeichen.

Beispiel 13: Benutzerdefiniertes Feld

PS C:> Ninja-Property-Set -Name "exampleTextField" -Value "My Text Value"

In diesem Beispiel wird das benutzerdefinierte Feld „exampleTextField“ auf „My Text Value“ gesetzt. Zulässige Textwerte: Irgendeine Zeichenfolge, die kleiner als 200 Zeichen ist.

Beispiel 14: Benutzerdefiniertes Feld für die Zeit

$UpdateTime = Get-Date -Stunde „09“ -Minute „0“ -Sekunde „0“
$LocalTimeZone = [System.TimeZoneInfo]: :Local
$UpdateTimeInUTC = [System.TimeZoneInfo]: :ConvertTimeToUtc($UpdateTime,
$LocalTimeZone)
$TimeInSecondsSinceMidnight =
[math]: :Round(($UpdateTimeInUTC.TimeOfDay).TotalSeconds)
PS C:> Ninja-Property-Set -Name „updateTime“ -Value
$TimeInSecondsSinceMidnight

In diesem Beispiel wird das benutzerdefinierte Feld „updateTime“ auf 9:00 AM gesetzt. Der Zeitwert wird in die Anzahl der Sekunden seit Mitternacht in UTC umgerechnet, bevor er als Wert des benutzerdefinierten Feldes festgelegt wird, da benutzerdefinierte Felder in der CLI nur Werte in diesem Format akzeptieren. Zulässige Zeitwerte: Die Anzahl der Sekunden seit Mitternacht UTC oder eine Zeitangabe im Format „HH:mm:ss“ UTC.

Beispiel 15: Benutzerdefiniertes URL-Feld

PS C:> Ninja-Property-Set -Name „exampleUrl“ -Value „https://www.ninjaone.com“

In diesem Beispiel wird das benutzerdefinierte URL-Feld „exampleUrl“ auf „https://www.ninjaone.com“ gesetzt. Zulässige URL-Werte: Irgendeine Zeichenfolge, die kleiner als 200 Zeichen ist und mit „https://“ beginnt.

Beispiel 16: Benutzerdefiniertes WYSIWYG-Feld

PS C:> Ninja-Property-Set -Name "exampleWYSIWYG" -Value "<H1
style='color:#f015ca'>Hello World</H1>"

In diesem Beispiel wird das benutzerdefinierte WYSIWYG-Feld „exampleWYSIWYG“ auf „<H1 style='color:#f015ca'>Hello World</H1>“ gesetzt. Benutzerdefinierte WYSIWYG-Felder in der CLI akzeptieren HTML als Wert, was eine Rich-Text-Formatierung im benutzerdefinierten Feld ermöglicht. Um den vollen Zugang zu den Funktionen der benutzerdefinierten WYSIWYG-Felder nutzen zu können, wird empfohlen, „Set NinjaProperty“ oder „Ninja-Property-Set-Piped“ zu verwenden, da diese im Vergleich zu „Ninja-Property-Set“ größere Zeichenbegrenzungen für die Feldwerte der benutzerdefinierten Felder unterstützen.

Es wird empfohlen, in Ihrem HTML-Code einfache Anführungszeichen zu verwenden, um zu vermeiden, dass Sie doppelte Anführungszeichen in Ihrer HTML-Zeichenkette escapen müssen, wenn Sie einen Wert für ein WYSIWYG-Benutzerdefiniertes Feld mit „Ninja-Property-Set“ festlegen. Zulässige WYSIWYG-Werte: Irgendeine Zeichenkette mit weniger als 199.999 Zeichen. Die Zeichenkette sollte für optimale Ergebnisse gültiges HTML enthalten, und es wird empfohlen, einfache Anführungszeichen im HTML-Code zu verwenden, um zu vermeiden, dass Sie doppelte Anführungszeichen in der HTML-Zeichenkette escapen müssen.

Parameter

-Name

Geben Sie den Namen des benutzerdefinierten Feldes an, für das Sie einen Wert einstellen möchten.

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

-Wert

Geben Sie den Wert an, der für das angegebene benutzerdefinierte Feld eingestellt werden soll.

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

Eingaben

System.String

Das Cmdlet akzeptiert keine Eingaben aus der Pipeline. Die Parameter „-Name“ und „-Value“ akzeptieren Zeichenfolgenwerte, die jeweils den Namen des festzulegenden benutzerdefinierten Felds und den für das benutzerdefinierte Feld festzulegenden Wert darstellen.

Ausgaben

Kein(e)

Zusätzliche Ressourcen

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

• NinjaOne: Index der Powershell-Befehle und Artikel 
• Befehlszeilenschnittstelle (CLI) 
• Geräte als Dokumentationsdelegierte zuweisen
• Aus der Dokumentation lesen oder in diese schreiben: Automatisierung, CLI und API
• Befehlszeilenschnittstelle (CLI): Unterstützte Felder und Funktionalität
• Benutzerdefinierte Felder in NinjaOne: Erste Schritte