Powershell: Set-NinjaProperty

Thema

In diesem Artikel wird erläutert, wie Sie mit „Set-NinjaProperty“ den Wert eines benutzerdefinierten Feldes basierend auf dessen Namen und Typ festlegen können.

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

Mit dem Cmdlet „Set-NinjaProperty“ können Sie den Wert eines benutzerdefinierten Feldes festlegen, indem Sie dessen Namen, Typ und Wert angeben. Wenn ein Typ angegeben wird, konvertiert das Cmdlet den bereitgestellten Wert automatisch in ein Format, das mit dem angegebenen Feldtyp kompatibel ist. Wenn beispielsweise ein „DateTime“-Objekt bereitgestellt wird und der Typ „Date“ ist, konvertiert das Cmdlet den Wert in einen Unix-Epochen-Zeitstempel, bevor das Feld gesetzt wird.

Dieses Cmdlet unterstützt außerdem das Festlegen von Werten für Dropdown- und Mehrfachauswahlfelder unter Verwendung von Feldnamen anstelle von GUIDs. Zu den unterstützten Feldtypen gehören: „Checkbox“, „Date“, „Date“, „DateTime“, „Decimal“, „
“, „Dropdown“, „Email“, „Integer“, „IP Address“, „MultiLine“, „MultiSelect“, „Phone“, „Secure“, „Text“, „Time“, „URL“ und „WYSIWYG“.

Nur Felder mit Schreibberechtigungen für die Automatisierung können mit diesem Cmdlet aktualisiert werden. Das angegebene benutzerdefinierte Feld wird nach der nächsten erfolgreichen Synchronisierung mit der NinjaOne-Plattform aktualisiert, was in der Regel innerhalb weniger Minuten erfolgt. Das Gerät, auf dem dieses Cmdlet ausgeführt wird, muss ein Dokumentdelegat für das Dokument sein, das das benutzerdefinierte Feld enthält, wenn der Parameter „-DocumentName“ verwendet wird.

Syntax

Set-NinjaProperty [-Name] <String> [[-Value] <Object>] [[-Type] <String>] [[-DocumentName] <String>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

Beispiele

Beispiel 1: Benutzerdefiniertes Kontrollkästchen-Feld

Set-NinjaProperty -Name „deployed“ -Value $True -Type „Checkbox“

Setzt das benutzerdefinierte Feld „deployed“ auf „true“. Zulässige Werte für das Kontrollkästchen: 0, 1, True, False oder ein boolescher Wert.

Beispiel 2: Benutzerdefiniertes Feld „Datum“

$DeploymentDate = Get-Date -Year „2026“ -Month „02“ -Day „01“ -Hour „0“ -
Minute „0“ -Second „0“
Set-NinjaProperty -Name „deploymentDate“ -Value $DeploymentDate -Type „Date“

Setzt das benutzerdefinierte Feld „deploymentDate“ auf das angegebene Datum. Zulässige Datumswerte: DateTime-Objekte oder Zeichenfolgen, die in DateTime konvertiert werden können.

Beispiel 3: Benutzerdefiniertes Feld für Datum und Uhrzeit

$LastSeen = Get-Date -Year "2026" -Month "02" -Day "02" -Hour "13" -Minute
"0" -Second "0"
Set-NinjaProperty -Name "lastSeen" -Value $LastSeen -Type "DateTime"

Setzt das benutzerdefinierte Feld „lastSeen“ auf das angegebene Datum und die angegebene Uhrzeit. Zulässige Datums- und Zeitwerte: DateTime-Objekte oder Zeichenfolgen, die in DateTime konvertiert werden können.

Beispiel 4: Benutzerdefiniertes Dezimalfeld

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

In diesem Beispiel wird das benutzerdefinierte Dezimalfeld „pi“ auf 3,14 gesetzt. Zulässige Dezimalwerte: Beliebige Zahlen im Bereich von -9999999,999999 bis 9999999,999999.

Beispiel 5: Benutzerdefiniertes Dropdown-Feld

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

In diesem Beispiel wird das benutzerdefinierte Dropdown-Feld „favoriteBand“ unter Verwendung des Optionsnamens „
“ anstelle der GUID auf „Mötley Crüe“ gesetzt. Zulässige Dropdown-Werte: Der Name einer der vordefinierten Optionen für das Feld.

Beispiel 6: Benutzerdefiniertes E-Mail-Feld

PS C:> Set-NinjaProperty -Name „supportEmail“ -Value „[email protected]“
-Type „Email“

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 „Ganzzahl“

PS C:> Set-NinjaProperty -Name „favoriteNumber“ -Value „42“ -Type „Integer“

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

Beispiel 8: Benutzerdefiniertes Feld „IP-Adresse“

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

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

Beispiel 9: Benutzerdefiniertes Feld mit mehreren Zeilen

PS C:> Set-NinjaProperty -Name „exampleMultiline“ -Value „Zeile 1`n`nZeile 3“
-Type „MultiLine“

In diesem Beispiel wird das mehrzeilige benutzerdefinierte Feld „exampleMultiline“ auf eine Zeichenfolge mit mehreren Text
-Zeilen gesetzt. Zulässige Werte für mehrzeilige Felder: Jede Zeichenfolge mit weniger als 10.000 Zeichen.

Beispiel 10: Benutzerdefiniertes Feld mit Mehrfachauswahl

PS C:> Set-NinjaProperty -Name „exampleMultiselect“ -Value („Value 3“,
„Option 1“) -Type „MultiSelect“

In diesem Beispiel wird das benutzerdefinierte Mehrfachauswahlfeld „exampleMultiselect“ auf „Value 3“ und „Option 1“ gesetzt, wobei die Anzeigenamen anstelle von GUIDs verwendet werden. Zulässige Werte für die Mehrfachauswahl: Ein Array von Zeichenfolgen, die die Anzeigenamen der gültigen Optionen darstellen, die mit dem Cmdlet „Ninja-Property-Options“ ermittelt werden können.

Beispiel 11: Benutzerdefiniertes Feld „Telefon“

PS C:> Set-NinjaProperty -Name „supportNumber“ -Value „+18008675309“ -Type
„Phone“

In diesem Beispiel wird das benutzerdefinierte Telefonfeld „supportNumber“ auf „+18008675309“ gesetzt. Zulässige Werte für „Phone“: 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:> Set-NinjaProperty -Name „superSecretPassword“ -Value „Hunter42“ -
Type „Secure“

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:> Set-NinjaProperty -Name „exampleTextField“ -Value „My Text Value“ -
Type „Text“

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"
PS C:> Set-NinjaProperty -Name "updateTime" -Value $UpdateTime -Type "Time"

In diesem Beispiel wird das benutzerdefinierte Zeitfeld „updateTime“ auf 9:00 Uhr gesetzt. Zulässige Zeitwerte: Ein DateTime-Objekt, das eine Zeit angibt, oder eine Zeichenfolge, die in ein DateTime-Objekt konvertiert werden kann.

Beispiel 15: Benutzerdefiniertes URL-Feld

PS C:> Set-NinjaProperty -Name „exampleUrl“ -Value
„https://www.ninjaone.com“ -Type „URL“

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

Beispiel 16: Benutzerdefiniertes WYSIWYG-Feld

PS C:> Set-NinjaProperty -Name "exampleWYSIWYG" -Value "<h1
style='color:#f015ca'>Hello World</h1>" -Type "WYSIWYG"

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. 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 den Wert eines benutzerdefinierten WYSIWYG-Feldes festlegen. Zulässige WYSIWYG-Werte: Jede Zeichenkette mit weniger als 199.999 Zeichen. Die Zeichenkette sollte gültiges HTML enthalten, um optimale Ergebnisse zu erzielen, und es wird empfohlen, in HTML einfache Anführungszeichen 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 für das Gerät oder die Dokumentation an, dessen Wert Sie festlegen möchten.

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

-Wert

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

Typ: Objekt
Parametersätze: (Alle)
Aliase:
Erforderlich: Falsch
Position: 2
Standardwert: Keiner
Pipeline-Eingabe zulassen: Wahr (ByValue)
Platzhalterzeichen zulassen: Falsch

-Typ

Der Typ des benutzerdefinierten Feldes, der bestimmt, wie der angegebene Wert verarbeitet und konvertiert wird. Zu den unterstützten Typen gehören: „Checkbox“, „Date“, „DateTime“, „Decimal“, „Dropdown“, „Email“, „Integer“, „IP Address“, „MultiLine“, „MultiSelect“, „Phone“, „Secure“, „Text“, „Time“, „URL“ und „WYSIWYG“.

Typ: String
Parametersätze: (Alle)
Aliase:
Erforderlich: Falsch
Position: 3
Standardwert: Keiner
Pipeline-Eingabe akzeptieren: Falsch
Platzhalterzeichen akzeptieren: Falsch

-DocumentName

Geben Sie den Namen des Dokuments an, aus dem der Wert für das angegebene benutzerdefinierte Dokumentationsfeld übernommen werden soll.

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

-Force

Wenn „confirm“ nicht angegeben ist und das Cmdlet eine Bestätigung anfordern würde, erzwingt dieser Parameter die Ausführung des Cmdlets ohne Bestätigungsabfrage.

Typ: SwitchParameter
Parametersätze: (Alle)
Aliase:
Erforderlich: False
Position: Benannt
Standardwert: False
Pipeline-Eingabe zulassen: False
Platzhalterzeichen zulassen: False

-WhatIf

Zeigt an, was passieren würde, wenn das Cmdlet ausgeführt würde. Das Cmdlet wird nicht ausgeführt.

Typ: SwitchParameter
Parametersätze: (Alle)
Aliase: „wi“
Erforderlich: „False“
Position: Benannt
Standardwert: „None“
Pipeline-Eingabe zulassen: „False“
Platzhalterzeichen zulassen: „False“

-Confirm

Fordert Sie vor der Ausführung des Cmdlets zur Bestätigung auf.

Typ: SwitchParameter
Parametersätze: (Alle)
Aliase: cf
Erforderlich: False
Position: Benannt
Standardwert: Keine
Pipeline-Eingabe zulassen: False
Platzhalterzeichen zulassen: False

Allgemeine Parameter

Dieses Cmdlet unterstützt die allgemeinen Parameter: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen zu allgemeinen Parametern finden Sie im Microsoft-Dokument „about_CommonParameters“ ( externer Link).

Eingaben

Ausgaben

Wenn Sie keinen Typ angeben, versucht das Cmdlet, den Zeichenfolgenwert unverändert festzulegen. In den Beispielen zu „Ninja-Property-Set“ erfahren Sie, wie Werte verarbeitet werden, wenn kein Typ angegeben ist.
Werte aus Dropdown- und MultiSelect-Listen werden vor dem Setzen anhand vordefinierter Optionen validiert.
Wird ein ungültiger Typ angegeben, wird eine Warnung angezeigt.
Nicht trennbare Leerzeichen werden bei „WYSIWYG“-Typen automatisch durch das HTML-Äquivalent   ersetzt.
Nur bei Feldern mit Schreibberechtigungen für die Automatisierung können die Optionen mit diesem Cmdlet abgerufen werden. Informationen zu Berechtigungen für benutzerdefinierte Felder finden Sie unter „NinjaOne Custom Fields: Erste Schritte“.
Das angegebene benutzerdefinierte Feld wird nach der nächsten erfolgreichen Synchronisierung mit der NinjaOne-Plattform aktualisiert, was in der Regel innerhalb weniger Minuten erfolgt.

Weitere Ressourcen

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