Powershell: Ninja-Property-Docs-Clear

Argomento

Questo articolo spiega come utilizzare Ninja-Property-Docs-Clear per cancellare il valore di un campo personalizzato specificato in un documento

Se si utilizza il modulo PowerShell di NinjaOne al di fuori di uno script di automazione, potrebbe essere necessario modificare la politica di esecuzione di PowerShell. Per ulteriori informazioni sulle politiche di esecuzione, consultare la documentazione di Microsoft: Informazioni sulle politiche di esecuzione ( link esterno).

Ambiente

NinjaOne
Microsoft Powershell

Descrizione

Il cmdlet Ninja-Property-Docs-Clear cancella il valore di un campo personalizzato specificato in un documento. È possibile specificare il nome del campo utilizzando il parametro -AttributeName, il documento utilizzando il parametro -DocumentName e il modello di documento utilizzando il parametro -TemplateId. Il cmdlet rimuoverà qualsiasi valore esistente dal campo personalizzato, riportandolo di fatto allo stato vuoto.

Solo i campi con autorizzazioni di scrittura per l’automazione possono essere azzerati utilizzando questo cmdlet. Il valore del campo personalizzato verrà azzerato dopo la successiva sincronizzazione riuscita con la piattaforma NinjaOne, che in genere avviene entro pochi minuti. Il dispositivo che esegue questo cmdlet deve essere assegnato come
un delegato di documentazione per il documento contenente il campo personalizzato da azzerare.

Sintassi

Ninja-Property-Docs-Clear [[-TemplateId] <OBJECT>] [[-DocumentName] <OBJECT>] [[-AttributeName] <OBJECT>] [<COMMONPARAMETERS>]

Il campo di testo viene cancellato dopo la successiva sincronizzazione riuscita con la piattaforma NinjaOne, che in genere avviene nel giro di pochi minuti.

Esempi

Esempio 1: cancellazione di un campo personalizzato in un documento

PS C:> Ninja-Property-Docs-Clear -TemplateId "12345" -DocumentName "My
Esempio Documento" -AttributeName "exampleAttribute"

Il campo personalizzato specificato nel documento viene cancellato dopo la successiva sincronizzazione riuscita con la piattaforma NinjaOne, che in genere avviene nel giro di pochi minuti.

Parametri

-AttributeName

Specificare il nome del campo personalizzato che si desidera cancellare nel documento.

Tipo: Oggetto
Set di parametri: (Tutti)
Alias:
Obbligatorio: Falso
Posizione: 2
Valore predefinito: Nessuno
Accetta input dalla pipeline: Falso
Accetta caratteri jolly: Falso

-DocumentName

Specificare il nome del documento contenente il campo personalizzato che si desidera cancellare.

Tipo: Oggetto
Set di parametri: (Tutti)
Alias:
Obbligatorio: False
Posizione: 1
Valore predefinito: Nessuno
Accetta input dalla pipeline: False
Accetta caratteri jolly: False

-TemplateId

Specificare l'ID del modello di documento che contiene il documento e il Campo personalizzato che si desidera cancellare c
.

Tipo: Oggetto
Set di parametri: (Tutti)
Alias:
Obbligatorio: Falso
Posizione: 0
Valore predefinito: Nessuno
Accetta input dalla pipeline: Falso
Accetta caratteri jolly: Falso

Input

Sistema.String

Questo cmdlet non accetta input dalla pipeline. I parametri -AttributeName, -DocumentName e -TemplateId accettano valori di tipo stringa che rappresentano, rispettivamente, il nome del campo personalizzato da cancellare, il nome del documento e l'ID del modello di documento.

Uscite

System.Object

Il dispositivo che esegue questo cmdlet deve essere assegnato come delegato di documentazione per il documento contenente il campo personalizzato da cancellare.
Per cancellare qualsiasi valore del campo personalizzato sono necessari i permessi di scrittura per l’automazione. Per informazioni sui permessi relativi ai campi personalizzati, consultare NinjaOne Custom Fields: Getting Started.
Il valore del campo personalizzato verrà cancellato dopo la successiva sincronizzazione riuscita con la piattaforma NinjaOne, che in genere avviene entro pochi minuti.

Risorse aggiuntive

Per altre informazioni sulla gestione delle risorse e sugli script personalizzati, consultare le seguenti risorse: