Powershell: Ninja-Property-Docs-Get-Single

Tema

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

Entorno

• NinjaOne
• Microsoft Powershell

Descripción

El cmdlet Ninja-Property-Docs-Get-Single recupera 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 devuelve el valor actual del campo personalizado en el documento único especificado.

Solo se pueden recuperar mediante este cmdlet los campos de documento con permisos de lectura de automatización.

Sintaxis

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

Ejemplo

Recuperar un valor de un documento único

PS C:> Ninja-Property-Docs-Get-Single -TemplateName "My Example Document" -
AttributeName "exampleAttribute"
Mötley Crüe

Se recupera el valor del campo personalizado «exampleAttribute» del documento individual «My Example Document» y se muestra en la salida.

Parámetros

-AttributeName

Especifica el nombre del campo personalizado que deseas recuperar del documento.

Tipo: Objeto
Conjuntos de parámetros: (Todo)
Alias:
Requerido: Falso
Posición: 1
Valor predeterminado: Ninguno
Acepta entrada de canalización: Falso
Acepta caracteres comodín: Falso

-NombreDePlantilla

Especifica el nombre del documento único que contiene el Campo personalizado que deseas recuperar.

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

Entradas

Sistema.String

Este cmdlet no acepta entradas del canal. Los parámetros -AttributeName y -
TemplateName aceptan valores de cadena que representan el nombre del campo personalizado que se va a recuperar
y el nombre del documento único, respectivamente.

Salidas

Sistema.String[]

El cmdlet devuelve el valor del campo personalizado especificado en el documento único indicado como una cadena o una matriz de cadenas si hay más de una línea.

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