Powershell: Ninja-Property-Docs-Establecer-Single

Tema

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

Entorno

• NinjaOne
• Microsoft Powershell

Descripción

El cmdlet Ninja-Property-Docs-Set-Single establece el valor de un campo personalizado especificado en un único documento. Se puede especificar el nombre del campo mediante el parámetro -AttributeName, la plantilla de documento mediante el parámetro -TemplateName y el valor que se va a establecer mediante el parámetro -AttributeValue. El cmdlet actualiza el valor del campo personalizado especificado en el único 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 contenga el campo personalizado que se va a actualizar. El campo personalizado especificado en el documento se actualiza después de la siguiente sincronización correcta con la plataforma NinjaOne, lo que suele producirse en unos pocos minutos.

Sintaxis

Ninja-Property-Docs-Set-Single [[-TemplateName] <OBJECT>] [[-AttributeName] <OBJECT>] [[-AttributeValue] <OBJECT>] [<COMMONPARAMETERS>]

Ejemplo

Establecer el valor del campo personalizado en un único documento

PS C:> Ninja-Property-Docs-Set-Single -TemplateName "Mi documento de ejemplo" -
AttributeName "exampleTextField" -AttributeValue "Nuevo valor"

El campo personalizado especificado en el documento se actualiza a «Nuevo valor» después de la siguiente sincronización correcta de
con la plataforma NinjaOne, lo que suele producirse 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: (Todo)
Alias:
Requerido: Falso
Posición: 1
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 va a actualizar (por ejemplo, texto, menú desplegable, selección múltiple)

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

-TemplateName

Introduce el nombre de la plantilla de documento asociada al documento único que contiene el campo personalizado que deseas configurar.

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

Entradas

Sistema.String

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

Salidas

Ninguno

Recursos adicionales

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

• 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