Powershell: Ninja-Property-Docs-Set

Argomento

Questo articolo spiega come utilizzare Ninja-Property-Docs-Setper impostare il valore di un campo personalizzato specificato in un documento.

Ambiente

• NinjaOne
• Microsoft PowerShell

Descrizione

Il cmdlet Ninja-Property-Docs-Set imposta 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, il modello di documento utilizzando il parametro -TemplateId e il valore da impostare utilizzando il parametro -AttributeValue. Il cmdlet aggiorna il valore del campo personalizzato specificato nel documento associato al modello specificato.

Solo i campi con autorizzazioni di scrittura per l’automazione possono essere aggiornati utilizzando questo cmdlet. Il dispositivo che esegue questo cmdlet deve essere assegnato come delegato alla documentazione per il documento contenente il campo personalizzato da aggiornare. Il campo personalizzato specificato nel documento viene aggiornato dopo la successiva sincronizzazione riuscita con la piattaforma NinjaOne, che in genere avviene entro pochi minuti.

Sintassi

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

Esempio

Impostazione del valore di un campo personalizzato di tipo testo in un documento

PS C:> Ninja-Property-Docs-Set -TemplateId "12345" -DocumentName "My
Example Document" -AttributeName "exampleTextField" -AttributeValue "New
Value"

Il campo personalizzato specificato nel documento viene aggiornato a "New Value" 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 per il quale si desidera impostare un valore.

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

-AttributeValue

Definire il valore che si desidera impostare per il campo personalizzato specificato. Il valore fornito deve essere compatibile con il tipo del campo personalizzato che si sta aggiornando (ad es. testo, menu a tendina, selezione multipla).

Tipo: Oggetto
Set di parametri: (Tutti)
Alias:
Obbligatorio: Falso
Posizione: 3
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 impostare.

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

-TemplateId

Definire l’ID del modello di documento associato al documento contenente il campo personalizzato
che si desidera impostare.

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

Input

System.String

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

Uscite

Nessuno

Risorse aggiuntive

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

• NinjaOne: Indice dei comandi e degli articoli di PowerShell 
• Interfaccia della riga di comando (CLI) 
• Assegnazione dei dispositivi come delegati alla documentazione
• Lettura o scrittura nella documentazione: automazione, CLI e API
• Interfaccia della riga di comando (CLI): campi e funzionalità supportati
• Campi personalizzati di NinjaOne: Guida introduttiva