¿Ya eres cliente de NinjaOne? Inicia sesión para ver más guías y las últimas actualizaciones.

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.

Si utilizas el módulo NinjaOne para PowerShell fuera de un script de automatización, es posible que tengas que ajustar la política de ejecución de PowerShell. Para obtener más información sobre las políticas de ejecución, consulta la documentación de Microsoft: Acerca de las políticas de ejecución ( enlace externo).

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. Puede especificar el nombre del campo mediante el parámetro -AttributeName, la plantilla del 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 documento único 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 tras la siguiente sincronización satisfactoria con la plataforma NinjaOne, lo que suele ocurrir en unos minutos.

Sintaxis

Ninja-Property-Docs-Set-Single [[-TemplateName] <Object>] [[-AttributeName] <Object>] [[-AttributeValue] <Object>] [<CommonParameters>]

Ejemplo

Establecer el valor de un 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» tras la siguiente sincronización correcta de
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: 1
Valor por defecto: Ninguno
Acepta entrada de canalización: Falso
Acepta caracteres comodín: Falso
-AttributeValue

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: (Todos)
Alias:
Obligatorio: Falso
Posición: 2
Valor por defecto: Ninguno
Acepta entrada del canal: Falso
Acepta caracteres comodín: Falso
-NombreDePlantilla

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:
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 -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

Ninguna

  • El dispositivo que ejecute este cmdlet debe estar asignado como delegado de documentación para el documento de
    que contenga el campo personalizado que se va a actualizar.
  • Solo se pueden actualizar mediante este cmdlet los campos con permisos de escritura de automatización. Para obtener información sobre los permisos de los campos personalizados, consulta «Campos personalizados de NinjaOne: Introducción».
  • El campo personalizado especificado en el documento se actualiza tras la siguiente sincronización correcta con la plataforma NinjaOne, lo que suele producirse en unos minutos.

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:

FAQ

Próximos pasos