Powershell: Ninja-Property-Docs-Set

Tema

En este artículo se explica cómo utilizar Ninja-Property-Docs-Setpara establecer el valor de un campo personalizado específico en un documento.

Entorno

• NinjaOne
• Microsoft PowerShell

Descripción

El cmdlet Ninja-Property-Docs-Set establece el valor de un campo personalizado especificado en un documento. Puedes especificar el nombre del campo mediante el parámetro -AttributeName, el documento mediante el parámetro -DocumentName, la plantilla del documento mediante el parámetro -TemplateId y el valor que se va a establecer mediante el parámetro -AttributeValue. El cmdlet actualiza el valor del campo personalizado especificado en el documento asociado a la plantilla indicada.

Solo se pueden actualizar mediante este cmdlet los campos con permisos de escritura de automatización. El dispositivo que ejecute este cmdlet debe estar asignado como delegado de documentación para el documento que contiene el campo personalizado que se va a actualizar. El campo personalizado especificado en el documento se actualiza tras la siguiente sincronización satisfactoria con la plataforma NinjaOne, lo que suele ocurrir en unos minutos.

Sintaxis

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

Ejemplo

Establecer el valor de un campo personalizado de texto en un documento

PS C:> Ninja-Property-Docs-Set -TemplateId "12345" -DocumentName "Mi
documento de ejemplo" -AttributeName "exampleTextField" -AttributeValue "Nuevo
valor"

El campo personalizado especificado en el documento se actualiza a «Nuevo valor» tras la siguiente sincronización correcta con la plataforma NinjaOne, lo que suele ocurrir en unos minutos.

Parámetros

-AttributeName

Especifica el nombre del campo personalizado para el que deseas establecer un valor.

Tipo: Objeto
Conjuntos de parámetros: (Todos)
Alias:
Obligatorio: Falso
Posición: 2
Valor por defecto: Ninguno
Acepta entrada de canalización: Falso
Acepta caracteres comodín: Falso

-ValorDelAtributo

Define el valor que deseas establecer para el campo personalizado especificado. El valor proporcionado debe ser compatible con el tipo del campo personalizado que se está actualizando (por ejemplo, texto, menú desplegable, selección múltiple).

Tipo: Objeto
Conjuntos de parámetros: (Todos)
Alias:
Obligatorio: Falso
Posición: 3
Valor por defecto: Ninguno
Acepta entrada de canalización: Falso
Acepta caracteres comodín: Falso

-DocumentName

Especifica el nombre del documento que contiene el campo personalizado que deseas configurar.

Tipo: Objeto
Conjuntos de parámetros: (Todos)
Alias:
Obligatorio: Falso
Posición: 1
Valor por defecto: Ninguno
Acepta entrada del pipeline: Falso
Acepta caracteres comodín: Falso

-TemplateId

Define el ID de la plantilla de documento asociada al documento que contiene el campo personalizado «
» que deseas configurar.

Tipo: Objeto
Conjuntos de parámetros: (Todos)
Alias:
Obligatorio: Falso
Posición: 0
Valor por defecto: Ninguno
Acepta entrada del pipeline: Falso
Acepta caracteres comodín: Falso

Entradas

System.String

Este cmdlet no acepta entradas de la canalización. Los parámetros -TemplateId, -DocumentName, -AttributeName y -AttributeValue aceptan valores de cadena que representan el ID de la plantilla de documento, el nombre del documento, el nombre del campo personalizado y el valor que se va a establecer para el campo personalizado, respectivamente.

Salidas

Ninguna

Recursos adicionales

Para obtener más información sobre la gestión de activos y la creación de scripts personalizados, consulta los siguientes recursos:

• NinjaOne: Índice de comandos y artículos de PowerShell 
• Interfaz de línea de comandos (CLI) 
• Asignación de dispositivos como delegados de documentación
• Lectura o escritura en la documentación: automatización, CLI y API
• Interfaz de línea de comandos (CLI): campos y funcionalidades compatibles
• Campos personalizados de NinjaOne: primeros pasos