Powershell: Ninja-Property-Docs-Set-Piped

Thema

In diesem Artikel wird erläutert, wie Sie mit „Ninja-Property-Docs-Set-Piped“ den Wert eines bestimmten benutzerdefinierten Feldes in einem 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 Dokument mithilfe der PowerShell-Pipeline fest. Sie können den Feldnamen mit dem Parameter „-AttributeName“, das Dokument mit dem Parameter „-DocumentName“ und die Dokumentvorlage mit dem Parameter „-TemplateId“ angeben. Der Wert kann über die Pipeline oder mithilfe des Parameters „-Value“ bereitgestellt werden. Das Cmdlet aktualisiert den Wert des angegebenen benutzerdefinierten Feldes im angegebenen Dokument mit dem bereitgestellten Wert.

Mit diesem Cmdlet können nur Felder aktualisiert werden, für die Schreibberechtigungen für die Automatisierung bestehen. 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 geschieht.

Syntax

Ninja-Property-Docs-Set-Piped [[-TemplateId] <Object>] [[-DocumentName] <Object>] [[-AttributeName] <Object>] [[-Value] <Object>] [<CommonParameters>]

Beispiele

Beispiel 1: 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:> Ninja-Property-Docs-Set-Piped -TemplateId "5" -DocumentName "My
Example Document" -AttributeName "exampleWYSIWYG" -Value $CustomFieldValue

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.

Beispiel 2: Unterstützung von Pipelines

$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-Piped -TemplateId "5" -
DocumentName "My Example Document" -AttributeName "exampleWYSIWYG"

Die PowerShell-Pipeline kann verwendet werden, um den Wert eines benutzerdefinierten Feldes festzulegen, indem der gewünschte Wert von „
“ an das Cmdlet „Ninja-Property-Docs-Set-Piped“ weitergeleitet wird.

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: 2
Standardwert: Keiner
Pipeline-Eingabe zulassen: False
Platzhalterzeichen zulassen: False

-DocumentName

Geben Sie den Namen des Dokuments an, das das benutzerdefinierte Feld enthält, für das Sie einen „
“-Wert festlegen möchten.

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

-TemplateId

Geben Sie die ID der Dokumentvorlage an, die das benutzerdefinierte Feld enthält, für das Sie
einen Wert festlegen möchten.

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

-Value

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

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

Eingaben

System.String

Das Cmdlet akzeptiert Zeichenfolgen aus der Pipeline als Eingabe für den Parameter -Value, der den Wert angibt, der für das angegebene benutzerdefinierte Feld festgelegt werden soll. Die Parameter -TemplateId, -DocumentName und -AttributeName akzeptieren Zeichenfolgen, die jeweils die ID der Dokumentvorlage, den Namen des Dokuments und 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 Dokumentationsdelegat für das Dokument zugewiesen sein, das das zu aktualisierende benutzerdefinierte Feld enthält.
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: 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.

Weitere Ressourcen

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