Powershell: Ninja-Property-Docs-Clear

Tema

En este artículo se explica cómo utilizar Ninja-Property-Docs-Clear para borrar el valor de un campo personalizado específico de un 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-Clear borra 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 y la plantilla del documento mediante el parámetro -TemplateId. El cmdlet eliminará cualquier valor existente del campo personalizado, restableciéndolo efectivamente a un estado vacío.

Solo se pueden restablecer mediante este cmdlet los campos con permisos de escritura de automatización. El valor del campo personalizado se borrará tras la próxima sincronización correcta con la plataforma NinjaOne, lo que suele ocurrir en unos minutos. 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 borrar.

Sintaxis

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

El campo de texto se borra tras la siguiente sincronización correcta con la plataforma NinjaOne, lo que suele ocurrir en unos minutos.

Ejemplos

Ejemplo 1: Borrar un campo personalizado en un documento

PS C:> Ninja-Property-Docs-Clear -TemplateId "12345" -DocumentName "Mi
documento de ejemplo" -AttributeName "exampleAttribute"

El campo personalizado especificado en el documento se borra 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 que deseas borrar en el documento.

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

-DocumentName

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

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

Especifica el ID de la plantilla de documento que contiene el documento y el campo personalizado que deseas que
borre.

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

Entradas

System.String

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

Salidas

System.Object

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 borrar.
Se requieren permisos de escritura de automatización para borrar cualquier valor de campo personalizado. Para obtener información sobre los permisos de los campos personalizados, consulta «Campos personalizados de NinjaOne: Introducción».
El valor del campo personalizado se borrará tras la próxima 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: