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 die Automatisierung vorliegen. 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>] [[-Value] <Object>] [<CommonParameters>]

Beispiele

Beispiel 1: Benutzerdefiniertes Kontrollkästchen-Feld

PS C:> Ninja-Property-Set -Name „deployed“ -Value $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 -Year "2026" -Month "02" -Day "01" -Hour "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 Datumsfeld „deploymentDate“ auf den 1. Februar 2026 gesetzt. Das Datum wird in 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 Datumsfelder 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 vergangen sind) umgewandelt, bevor er als Wert des benutzerdefinierten Feldes festgelegt wird, da benutzerdefinierte Datums- und Zeitfelder in der CLI Epochenzeitwerte akzeptieren. Zulässige Datums- und Zeitformate: Unix-Epochenzeit (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" -Value "3.14"

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

Beispiel 5: Benutzerdefiniertes Dropdown-Feld

PS C:> Ninja-Property-Set -Name „favoriteBand“ -Value „2a100199-4067-4332-
8f4d-451e14b94a76“

In diesem Beispiel wird das benutzerdefinierte Dropdown-Feld „favoriteBand“ auf die Option mit der GUID 2a100199-4067-4332-8f4d-451e14b94a76 gesetzt. Benutzerdefinierte Dropdown-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 Dropdown-Werte: Die GUID der Option, die festgelegt werden soll. Diese kann mithilfe des Cmdlets „Ninja-Property-Options“ ermittelt werden.

Beispiel 6: Benutzerdefiniertes E-Mail-Feld

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: Jede Zeichenfolge, die dem offiziellen RFC-5322-Standard für E-Mail-Adressen entspricht.

Beispiel 7: Benutzerdefiniertes Feld vom Typ „Integer“

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

In diesem Beispiel wird das benutzerdefinierte Ganzzahlfeld „favoriteNumber“ auf 42 gesetzt. Zulässige Ganzzahlwerte: Jede 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" -Value "Zeile 1`n`nZeile
3"

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

Beispiel 10: Benutzerdefiniertes Feld mit Mehrfachauswahl

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

In diesem Beispiel wird das benutzerdefinierte Mehrfachauswahlfeld „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 mithilfe des Cmdlets „Ninja-Property-Options“ ermittelt werden. Zulässige Werte für die Mehrfachauswahl: Eine durch Kommas getrennte Liste von GUIDs, die die festzulegenden Optionen darstellen und mithilfe des Cmdlets „Ninja-Property-Options“ ermittelt werden können.

Beispiel 11: Benutzerdefiniertes Feld „Telefon“

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

In diesem Beispiel wird das benutzerdefinierte Telefonfeld „supportNumber“ auf „+18008675309“ gesetzt. Zulässige Telefonwerte: Jede 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: Jede Zeichenfolge mit weniger als 200 Zeichen.

Beispiel 13: Benutzerdefiniertes Textfeld

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

In diesem Beispiel wird das benutzerdefinierte Textfeld „exampleTextField“ auf „My Text Value“ gesetzt. Zulässige Textwerte: Beliebige Zeichenfolge mit weniger als 200 Zeichen.

Beispiel 14: Benutzerdefiniertes Zeitfeld

$UpdateTime = Get-Date -Hour "09" -Minute "0" -Second "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 Zeitfeld „updateTime“ auf 9:00 Uhr 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 Zeitfelder 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: Jede Zeichenfolge, die weniger als 200 Zeichen lang 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 Funktionsumfang 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 Werte benutzerdefinierter 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: Jede 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 festlegen möchten.

Typ: Objekt
Parametersätze: (Alle)
Aliase:
Erforderlich: False
Position: 0
Standardwert: Keiner
Pipeline-Eingabe zulassen: False
Platzhalterzeichen zulassen: False

-Wert

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

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

Eingaben

System.String

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

Ausgaben

Keine

Weitere Ressourcen

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

• NinjaOne: Verzeichnis der PowerShell-Befehle und Artikel 
• Befehlszeilenschnittstelle (CLI) 
• Geräte als Dokumentationsbeauftragte zuweisen
• Aus der Dokumentation lesen oder in diese schreiben: Automatisierung, CLI und API
• Befehlszeilenschnittstelle (CLI): Unterstützte Felder und Funktionen
• Benutzerdefinierte Felder in NinjaOne: Erste Schritte