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 Skripts für Automatisierungen 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.

Mit diesem Cmdlet können nur Felder aktualisiert werden, für die Schreibberechtigungen für die Automatisierung vorliegen. 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>] [[-Wert] <OBJECT>] [<COMMONPARAMETERS>]

Beispiel

Festlegen eines benutzerdefinierten Feldes mit 199.999 Zeichen

$alphabet = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMOPQRSTUVWXYZ1234567890"
$DesiredValue = New-Object System.Collections.Generic.Liste
für($i = 0; $i -lt 199999; $i++){
$DesiredValue.Hinzufügen("$($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 einstellen möchten.

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

-TemplateName

Geben Sie den Namen der Dokumentvorlage an, in der Sie den Wert für das angegebene benutzerdefinierte Feld „
“ festlegen möchten.

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

-Wert

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

Typ: Objekt
Parametersätze: (Alle)
Aliase:
Erforderlich: Falsch
Position: 2
Standardwert: Keiner
Pipeline-Eingabe akzeptieren: Wahr (ByValue)
Platzhalterzeichen akzeptieren: 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 Feldes darstellen, für das Sie einen Wert festlegen möchten.

Ausgaben

Kein(e)

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

Zusätzliche Ressourcen

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