Powershell: Ninja-Property-Docs-Set-Single-Piped

Thema

In diesem Artikel wird erläutert, wie Sie mit „Ninja-Property-Docs-Set-Single-Piped“ den Wert eines bestimmten benutzerdefinierten Feldes in einem einzelnen Dokument mithilfe der PowerShell-Pipeline 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

Dieses Cmdlet legt den Wert eines angegebenen benutzerdefinierten Feldes in einem einzelnen Dokument mithilfe der PowerShell-Pipeline fest. Sie können den Feldnamen über den Parameter „-AttributeName“ und die Dokumentvorlage über den Parameter „TemplateName“ angeben. Der Wert kann über die Pipeline oder mithilfe des Parameters „-Value“ bereitgestellt werden. Das Cmdlet aktualisiert den Wert des angegebenen benutzerdefinierten Feldes in dem einzelnen Dokument, das der angegebenen Vorlage zugeordnet ist, mit dem bereitgestellten Wert.

Nur Felder mit Schreibberechtigungen für die Automatisierung können mit diesem Cmdlet aktualisiert werden. Das Gerät, auf dem dieses Cmdlet ausgeführt wird, muss als Dokumentationsbeauftragter für das Dokument zugewiesen sein, das das zu aktualisierende benutzerdefinierte Feld enthält. Das angegebene benutzerdefinierte Feld im Dokument wird nach der nächsten erfolgreichen Synchronisierung mit der NinjaOne-Plattform aktualisiert, was in der Regel innerhalb weniger Minuten erfolgt.

Syntax

Ninja-Property-Docs-Set-Single-Piped [[-TemplateName] <Object>] [[-AttributeName] <Object>] [[-Value] <Object>] [<CommonParameters>]

Beispiel

Festlegen eines benutzerdefinierten Feldes mit 199.999 Zeichen

$alphabet = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMOPQRSTUVWXYZ1234567890"
$DesiredValue = New-Object System.Collections.Generic.List
for($i = 0; $i -lt 199999; $i++){
$DesiredValue.Add("$($alphabet[(Get-Random -Maximum
$alphabet.Length)])")
}
$CustomFieldValue = "$($DesiredValue -join '')"
PS C:> $CustomFieldValue | Ninja-Property-Docs-Set-Single-Piped -
TemplateName "My Example Document" -AttributeName "exampleWYSIWYG"

Mit Piped-Befehlen lässt sich der Wert eines benutzerdefinierten Feldes auf eine lange Zeichenfolge festlegen, beispielsweise 199.999 Zeichen – dies entspricht der maximalen Länge für ein benutzerdefiniertes WYSIWYG-Feld. In diesem Beispiel wird eine zufällige Zeichenfolge mit 199.999 Zeichen generiert und als Wert für das benutzerdefinierte Feld „exampleWYSIWYG“ im Dokument „My Example Document“ festgelegt.

Parameter

-AttributeName

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: 1
Standardwert: Keine
Pipeline-Eingabe zulassen: False
Platzhalterzeichen zulassen: False

-Vorlagenname

Geben Sie den Namen der Dokumentvorlage an, in der Sie den Wert für das angegebene benutzerdefinierte Feld fest
n.

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

-Value

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

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

Eingaben

System.String

Das Cmdlet akzeptiert Zeichenfolgen aus der Pipeline, die als Wert für das angegebene benutzerdefinierte Feld verwendet werden. Die Parameter „-TemplateName“ und „-AttributeName“ akzeptieren Zeichenfolgen, die den Namen der Dokumentvorlage bzw. den Namen des benutzerdefinierten Felds darstellen, für das Sie einen Wert festlegen möchten.

Ausgaben

Keine

Das Gerät, auf dem dieses Cmdlet ausgeführt wird, muss als Dokumentationsdelegierter für das Dokument zugewiesen sein, dessen benutzerdefiniertes Feld aktualisiert werden soll.
Mit diesem Cmdlet können nur Felder aktualisiert werden, für die Schreibberechtigungen für die Automatisierung vorhanden sind. Informationen zu Berechtigungen für benutzerdefinierte Felder finden Sie unter „NinjaOne Custom Fields: Getting Started“.
Das angegebene benutzerdefinierte Feld im Dokument 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: