Powershell: Ninja-Property-Docs-Set-Single

Thema

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

Das Cmdlet „Ninja-Property-Docs-Set-Single“ legt den Wert eines angegebenen benutzerdefinierten Feldes in einem einzelnen Dokument fest. Sie können den Feldnamen mit dem Parameter „-AttributeName“, die Dokumentvorlage mit dem Parameter „-TemplateName“ und den festzulegenden Wert mit dem Parameter „-AttributeValue“ angeben. Das Cmdlet aktualisiert den Wert des angegebenen benutzerdefinierten Feldes in dem einzelnen Dokument, das der angegebenen Vorlage zugeordnet ist.

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 [[-TemplateName] <Object>] [[-AttributeName] <Object>] [[-AttributeValue] <Object>] [<CommonParameters>]

Beispiel

Festlegen eines Werts für ein benutzerdefiniertes Feld in einem einzelnen Dokument

PS C:> Ninja-Property-Docs-Set-Single -TemplateName "My Example Document" -
AttributeName "exampleTextField" -AttributeValue "New Value"

Das angegebene benutzerdefinierte Feld im Dokument wird nach der nächsten erfolgreichen Synchronisierung von
mit der NinjaOne-Plattform auf „New Value“ aktualisiert, was in der Regel innerhalb weniger Minuten geschieht.

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: Keiner
Pipeline-Eingabe akzeptieren: False
Platzhalterzeichen akzeptieren: False

-AttributeValue

Legen Sie den Wert fest, den Sie für das angegebene benutzerdefinierte Feld setzen möchten. Der angegebene Wert sollte mit dem Typ des zu aktualisierenden benutzerdefinierten Feldes kompatibel sein (z. B. Text, Dropdown, Mehrfachauswahl)

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

-TemplateName

Geben Sie den Namen der Dokumentvorlage ein, die mit dem einzelnen Dokument verknüpft ist, das das benutzerdefinierte Feld enthält, das Sie festlegen möchten.

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

Eingaben

System.String

Dieses Cmdlet akzeptiert keine Eingaben aus der Pipeline. Die Parameter -TemplateName, -AttributeName und -AttributeValue akzeptieren Zeichenfolgenwerte, die jeweils den Namen der Dokumentvorlage, den Namen des benutzerdefinierten Felds und den für das benutzerdefinierte Feld festzulegenden Wert darstellen.

Ausgaben

Keine

Das Gerät, auf dem dieses Cmdlet ausgeführt wird, muss als Dokumentationsdelegierter für das Dokument „
“ zugewiesen sein, das das zu aktualisierende benutzerdefinierte Feld enthält.
Nur Felder mit Schreibberechtigungen für die Automatisierung können mit diesem Cmdlet aktualisiert werden. 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: