Tema
En este artículo se explica cómo utilizar Ninja-Property-Docs-Clear-Singlepara borrar el valor de un campo personalizado específico en un único documento.
Entorno
- NinjaOne
- Microsoft PowerShell
Descripción
El cmdlet Ninja-Property-Docs-Clear-Single borra el valor de un campo personalizado especificado en un único documento. Puedes especificar el nombre del campo mediante el parámetro -AttributeName y el documento mediante el parámetro -TemplateName. El cmdlet eliminará cualquier valor existente del campo personalizado, restableciéndolo efectivamente a un estado vacío.
Solo se pueden restablecer los campos con permisos de escritura de automatización mediante este cmdlet. El valor del campo personalizado se borrará tras la siguiente 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-Single [[-TemplateName] <Object>] [[- AttributeName] <Object> [<CommonParameters>]
Ejemplos
Ejemplo 1: Borrar un campo personalizado en un único documento
PS C: Ninja-Property-Docs-Clear-Single -TemplateName "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: 1
Valor por defecto: Ninguno
Acepta entrada de canalización: Falso
Acepta caracteres comodín: Falso-NombreDePlantilla
Especifica el nombre de la plantilla del documento que contiene el campo personalizado que deseas borrar.
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: FalsoEntradas
System.String
Este cmdlet no acepta entradas de la canalización. Los parámetros -AttributeName y -TemplateName aceptan valores de cadena que representan el nombre del campo personalizado que se va a borrar y el nombre de la plantilla de documento, respectivamente.
Salidas
Ninguna
- 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 «
» de 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:
- 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