Tema
En este artículo se explica cómo utilizar Ninja-Property-Docs-Set-Piped para establecer el valor de un campo personalizado específico en un documento mediante la canalización de PowerShell.
Entorno
- NinjaOne
- Microsoft PowerShell
Descripción
Este cmdlet establece el valor de un campo personalizado especificado en un documento mediante la canalización de PowerShell. 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 valor se puede proporcionar a través de la canalización o mediante el parámetro -Value. El cmdlet actualiza el valor del campo personalizado especificado en el documento indicado con el valor proporcionado.
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 correcta con la plataforma NinjaOne, lo que suele ocurrir en unos minutos.
Sintaxis
Ninja-Property-Docs-Set-Piped [[-TemplateId] <Object>] [[-DocumentName] <Object>] [[-AttributeName] <Object>] [[-Value] <Object>] [<CommonParameters>]
Ejemplos
Ejemplo 1: Configuración de un campo personalizado con 199 999 caracteres
$alphabet = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMOPQRSTUVWXYZ1234567890"
$DesiredValue = New-Object System.Collections.Generic.List
for($i = 0; $i -lt 199999; $i++){
$DesiredValue.Add("$($alphabet[(Get-Random -Maximum
$alphabet.Length)])")
}
$CustomFieldValue = "$($DesiredValue -join '')"
PS C:> Ninja-Property-Docs-Set-Piped -TemplateId "5" -DocumentName "Mi
documento de ejemplo" -AttributeName "exampleWYSIWYG" -Value $CustomFieldValueLos comandos en pipeline se pueden utilizar para establecer el valor de un campo personalizado en una cadena larga, como 199 999 caracteres, que es la longitud máxima para un campo personalizado WYSIWYG. En este ejemplo, se genera una cadena aleatoria de 199 999 caracteres y se establece como valor del campo personalizado exampleWYSIWYG en «Mi documento de ejemplo».
Ejemplo 2: Compatibilidad con la cadena de comandos
$alphabet = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMOPQRSTUVWXYZ1234567890"
$DesiredValue = New-Object System.Collections.Generic.List
for($i = 0; $i -lt 199999; $i++){
$DesiredValue.Add("$($alphabet[(Get-Random -Maximum
$alphabet.Length)])")
}
$CustomFieldValue = "$($DesiredValue -join '')"
PS C:> $CustomFieldValue | Ninja-Property-Docs-Set-Piped -TemplateId "5" -
DocumentName "Mi documento de ejemplo" -AttributeName "exampleWYSIWYG"La canalización de PowerShell se puede utilizar para establecer el valor de un campo personalizado canalizando el valor deseado de `
` al cmdlet `Ninja-Property-Docs-Set-Piped`.
Parámetros
-AttributeName
Especifica el nombre del campo personalizado para el que se desea establecer un valor.
Tipo: Objeto
Conjuntos de parámetros: (Todos)
Alias:
Obligatorio: Falso
Posición: 2
Valor predeterminado: Ninguno
Acepta entrada de canalización: Falso
Acepta caracteres comodín: Falso-DocumentName
Especifica el nombre del documento que contiene el campo personalizado al que deseas asignar un valor de «
».
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-TemplateId
Especifica el ID de la plantilla de documento que contiene el campo personalizado para el que deseas establecer un valor
.
Tipo: Objeto
Conjuntos de parámetros: (Todos)
Alias:
Obligatorio: Falso
Posición: 0
Valor por defecto: Ninguno
Acepta entrada del canal: Falso
Acepta caracteres comodín: Falso-Value
Especifica el valor que se va a establecer para el campo personalizado indicado.
Tipo: Objeto
Conjuntos de parámetros: (Todos)
Alias:
Obligatorio: Falso
Posición: 3
Valor por defecto: Ninguno
Acepta entrada de canalización: Verdadero (Por valor)
Acepta caracteres comodín: FalsoEntradas
System.String
El cmdlet acepta entradas de cadena procedentes de la canalización para el parámetro -Value, que representa el valor que se va a establecer para el campo personalizado especificado. Los parámetros -TemplateId, -DocumentName y -AttributeName aceptan valores de cadena que representan el ID de la plantilla del documento, el nombre del documento y el nombre del campo personalizado, respectivamente, para los que se desea establecer un valor.
Salidas
Ninguna
- 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.
- 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:
- 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