Powershell: Ninja-Property-Docs-Set

Thema

In diesem Artikel wird erläutert, wie Sie mit Ninja-Property-Docs-Setden Wert eines bestimmten benutzerdefinierten Feldes in einem 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“ legt den Wert eines angegebenen benutzerdefinierten Feldes in einem Dokument fest. Sie können den Feldnamen mit dem Parameter „-AttributeName“, das Dokument mit dem Parameter „-DocumentName“, die Dokumentvorlage mit dem Parameter „-TemplateId“ und den festzulegenden Wert mit dem Parameter „-AttributeValue“ angeben. Das Cmdlet aktualisiert den Wert des angegebenen benutzerdefinierten Feldes in dem Dokument, das der angegebenen Vorlage zugeordnet ist.

Mit diesem Cmdlet können nur Felder aktualisiert werden, für die Schreibberechtigungen für die Automatisierung vorhanden sind. 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 [[-TemplateId] <Object>] [[-DocumentName] <Object>] [[-AttributeName] <Object>] [[-AttributeValue] <Object>] [<CommonParameters>]

Beispiel

Festlegen eines Werts für ein benutzerdefiniertes Textfeld in einem Dokument

PS C:> Ninja-Property-Docs-Set -TemplateId "12345" -DocumentName "Mein
Beispieldokument" -AttributeName "exampleTextField" -AttributeValue "Neuer
Wert"

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

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

-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: 3
Standardwert: Keine
Pipeline-Eingabe zulassen: Falsch
Platzhalterzeichen zulassen: Falsch

-DocumentName

Geben Sie den Namen des Dokuments an, das das benutzerdefinierte Feld enthält, das Sie festlegen möchten.

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

-TemplateId

Legen Sie die ID der Dokumentvorlage fest, die dem Dokument zugeordnet ist, das das benutzerdefinierte Feld „
“ enthält, das Sie festlegen möchten.

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

Eingaben

System.String

Dieses Cmdlet akzeptiert keine Eingaben aus der Pipeline. Die Parameter -TemplateId, -DocumentName, -AttributeName und -AttributeValue akzeptieren Zeichenfolgenwerte, die jeweils die ID der Dokumentvorlage, den Namen des Dokuments, 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, 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: