Powershell: Opciones de Ninja-Property-Docs

Tema

En este artículo se explica cómo utilizar Ninja-Property-Docs-Optionspara recuperar valores válidos para un campo personalizado de menú desplegable o de selección múltiple en 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

Este cmdlet recupera los valores válidos para un campo personalizado de menú desplegable o de selección múltiple 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 una lista de opciones válidas en el formato <guid>=<name>, donde <guid> es el identificador único de la opción y <name> es el nombre que se muestra de la opción. Solo se pueden recuperar las opciones de los campos de documento que tengan permisos de lectura de automatización mediante este cmdlet.

Sintaxis

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

Ejemplos

Ejemplo 1: Un campo personalizado desplegable

PS C:> Ninja-Property-Docs-Options -TemplateId "5" -DocumentName "Mi
documento de ejemplo" -AttributeName "exampleDropdown"
09d9ef8e-3cdf-4fb2-baf6-9b78b46643a9=Opción de ejemplo 3
1ff0944e-2bc8-4681-909b-688e77db1cae=Opción de ejemplo 2
61010919-654f-4448-ba15-48a160d42f44=Chino simplificado
bd182518-e0ca-4a50-9afb-f9542c1e7d08=Mötley Crüe
c2444bd4-2e75-4acf-944d-b73afd66b27f=Ejemplo de opción 1

Cuando se especifica un campo personalizado de lista desplegable, el cmdlet devuelve las opciones válidas para el campo de lista desplegable
en el formato <guid>=<name>, donde <guid> es el identificador único de la opción
y <name> es el nombre que se muestra de la opción.

Ejemplo 2: Un campo personalizado de selección múltiple

PS C:> Ninja-Property-Docs-Options -TemplateId "5" -DocumentName "Mi
documento de ejemplo" -AttributeName "exampleMultiSelect"
1e6bcc4a-0272-414e-a77c-4109ef79f86e=Opción 1
3e08d167-e830-41e7-ae8f-1128e22b00a9=Opción 3
4f4f73ba-0d69-4518-a78b-9ca554471b8e=Opción 2
680e655d-0b66-4dba-a96e-dcee77ddd1e4=Chino simplificado

Cuando se especifica un campo personalizado de selección múltiple, el cmdlet devuelve las opciones válidas para el campo de selección múltiple
en el formato <guid>=<name>, donde <guid> es el identificador único de la opción
y <name> es el nombre que se muestra de la opción.

Ejemplo 3: Un campo personalizado sin opciones

PS C:> Ninja-Property-Docs-Options -TemplateId "5" -DocumentName "Mi
documento de ejemplo" -AttributeName "exampleTextField"

Cuando se especifica un campo personalizado que no tiene opciones, como un campo de texto, el cmdlet no devuelve ningún resultado.

Parámetros

-AttributeName

Especifica el nombre del campo personalizado para el que se desean recuperar las opciones válidas.

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 para el que deseas recuperar opciones válidas
.

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

-TemplateId

Especifica el nombre de la plantilla de documento que contiene el campo personalizado para el que deseas recuperar las opciones válidas de
.

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

El cmdlet no acepta entradas de la canalización. Los parámetros -TemplateId, -DocumentName y -AttributeName aceptan valores de cadena que representan el ID de la plantilla de documento, el nombre del documento y el nombre del campo personalizado, respectivamente, para los que desea recuperar opciones válidas.

Salidas

System.String[]

El cmdlet devuelve las opciones válidas para el campo personalizado especificado en el documento indicado en el formato <guid>=<name> como una cadena o una matriz de cadenas si hay más de una opción disponible.

Este cmdlet solo es aplicable a campos personalizados de tipo lista desplegable y selección múltiple. Si se especifica un tipo de campo personalizado
diferente, no se devolverá ningún resultado.
Solo se pueden recuperar las opciones de los campos de documento con permisos de lectura de automatización mediante este cmdlet. 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: