Powershell: Ninja-Property-Docs-Clear

Thema

In diesem Artikel wird erläutert, wie Sie mit „Ninja-Property-Docs-Clear“ den Wert eines bestimmten benutzerdefinierten Feldes in einem Dokument löschen 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-Clear“ löscht den Wert eines angegebenen benutzerdefinierten Feldes in einem Dokument. Sie können den Feldnamen mit dem Parameter „-AttributeName“, das Dokument mit dem Parameter „-DocumentName“ und die Dokumentvorlage mit dem Parameter „-TemplateId“ angeben. Das Cmdlet entfernt alle vorhandenen Werte aus dem benutzerdefinierten Feld und setzt es damit effektiv auf einen leeren Zustand zurück.

Nur Felder mit Schreibberechtigungen für die Automatisierung können mit diesem Cmdlet zurückgesetzt werden. Der Wert des benutzerdefinierten Feldes wird nach der nächsten erfolgreichen Synchronisierung mit der NinjaOne-Plattform gelöscht, was in der Regel innerhalb weniger Minuten erfolgt. Das Gerät, auf dem dieses Cmdlet ausgeführt wird, muss als „
“ als Dokumentationsbeauftragter für das Dokument zugewiesen sein, das das zu löschende benutzerdefinierte Feld enthält.

Syntax

Ninja-Property-Docs-Clear [[-TemplateId] <Object>] [[-DocumentName] <Object>] [[-AttributeName] <Object>] [<CommonParameters>]

Das Textfeld wird nach der nächsten erfolgreichen Synchronisierung mit der NinjaOne-Plattform gelöscht, was in der Regel innerhalb weniger Minuten erfolgt.

Beispiele

Beispiel 1: Ein benutzerdefiniertes Feld in einem Dokument löschen

PS C:> Ninja-Property-Docs-Clear -TemplateId "12345" -DocumentName "Mein
Beispieldokument" -AttributeName "exampleAttribute"

Das angegebene benutzerdefinierte Feld im Dokument wird nach der nächsten erfolgreichen Synchronisierung mit der NinjaOne-Plattform gelöscht, was in der Regel innerhalb weniger Minuten geschieht.

Parameter

-AttributeName

Geben Sie den Namen des benutzerdefinierten Feldes an, das Sie im Dokument löschen möchten.

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

-DocumentName

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

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

-TemplateId

Geben Sie die ID der Dokumentvorlage an, die das Dokument und das benutzerdefinierte Feld enthält, das von „
“ gelöscht werden soll.

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 -AttributeName, -DocumentName und -TemplateId akzeptieren Zeichenfolgenwerte, die jeweils den Namen des zu löschenden benutzerdefinierten Felds, den Namen des Dokuments und die ID der Dokumentvorlage darstellen.

Ausgaben

System.Object

Das Gerät, auf dem dieses Cmdlet ausgeführt wird, muss als Dokumentationsdelegat für das Dokument zugewiesen sein, das das zu löschende benutzerdefinierte Feld enthält.
Zum Löschen eines benutzerdefinierten Feldwerts sind Schreibberechtigungen für die Automatisierung erforderlich. Informationen zu Berechtigungen für benutzerdefinierte Felder finden Sie unter „NinjaOne Custom Fields: Getting Started“.
Der Wert des benutzerdefinierten Feldes wird nach der nächsten erfolgreichen Synchronisierung mit der NinjaOne-Plattform gelöscht, 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: