Powershell: Ninja-Property-Docs-Get

Tema

En este artículo se explica cómo utilizar Ninja-Property-Docs-Get para recuperar 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-Get recupera 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 devuelve el valor actual del campo personalizado en el documento especificado.

Sintaxis

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

Ejemplo

Recuperar un valor de un documento

PS C:> Ninja-Property-Docs-Get -TemplateId "12345" -DocumentName "Mi
documento de ejemplo" -AttributeName "exampleAttribute"
Línea 1
Línea 3

Se recupera el valor del campo personalizado «exampleAttribute» del documento «Mi documento de ejemplo» y se muestra en la salida. En este ejemplo, el campo personalizado contiene varias líneas de texto.

Parámetros

-AttributeName

Especifica el nombre del campo personalizado que deseas recuperar del 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 recuperar.

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 documento y el campo personalizado que deseas que
recupere.

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 recuperar, el nombre del documento y el ID de la plantilla del documento, respectivamente.

Salidas

System.String[]

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

Solo se pueden recuperar mediante este cmdlet los campos de documento con permisos de lectura para automatización. Para obtener información sobre los permisos de los campos personalizados, consulta «Campos personalizados de NinjaOne: Introducción».

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: