Powershell: Obtener NinjaProperty

Tema

En este artículo se explica cómo utilizar Get-NinjaProperty para recuperar y convertir el valor de un campo personalizado en función de su nombre y tipo.

Entorno

• NinjaOne 
• Microsoft Powershell

Descripción

El cmdlet Get-NinjaProperty recupera el valor de un campo personalizado o de documentación especificado. Permite especificar el nombre del campo, el tipo de propiedad y, opcionalmente, el nombre de un documento o plantilla. El tipo de propiedad permite al cmdlet procesar y convertir el valor sin procesar en un objeto de PowerShell adecuado en función del tipo de campo personalizado que se esté recuperando. 

Cuando se proporciona un nombre de documento, el cmdlet recupera el valor de la propiedad del documento único especificado en lugar del campo personalizado del dispositivo. En el caso de los campos que requieren opciones adicionales (como menús desplegables o campos de selección múltiple), el cmdlet recupera estas opciones y devuelve los nombres para mostrar de las opciones seleccionadas en lugar del valor sin procesar, siempre que se haya especificado el tipo adecuado.

Los tipos de propiedad admitidos incluyen: «Aplicaciones y servicios Dropdown», «Aplicaciones y servicios
Multiselect», «Adjuntos», «Casilla de verificación», «Fecha», «FechaTime», «Decimal», «Despliegue de dispositivos»,
«Despliegue de dispositivos MultiSelect», «Despliegue de dispositivos», «Correo electrónico», «Entero», «Dirección de IP», «Multilínea», «Selección múltiple»,
«Menú desplegable de organización», «Menú desplegable de ubicación de organización», «Selección múltiple de ubicación de organización
», «Selección múltiple de organización», «Teléfono», «Seguro», «Texto», «Hora», «URL» y
«WYSIWYG».

Si no se especifica un tipo de propiedad, el cmdlet devolverá el valor de cadena sin procesar del campo personalizado sin ningún procesamiento ni conversión adicionales. Consulte los ejemplos de Ninja-Property-Get para ver cómo se procesan los valores cuando no se especifica un tipo. Solo se pueden recuperar los campos con permisos de lectura de automatización mediante este cmdlet.

Sintaxis

Get-NinjaProperty [-Name] <STRING[]> [[-Tipo] <STRING>] [[-DocumentName] <STRING>] [<COMMONPARAMETERS>]

Ejemplos

Ejemplo 1: Campo personalizado «Aplicaciones y servicios»

PS C:> Get-NinjaProperty -Name "exampleAppsAndServicesDropdown" -Type
"AppsAndServicesDropdown"
entityId type
-------- ----
5 CLIENT_DOCUMENT

Cuando se recupera un valor del campo personalizado «Menú desplegable de aplicaciones y servicios», el cmdlet devuelve un objeto personalizado de tipo
que contiene el entityId de la opción seleccionada y el tipo de entidad que representa la opción
.

Ejemplo 2: Campo personalizado de selección múltiple «Aplicaciones y servicios»

PS C:> Get-NinjaProperty -Name "exampleAppsAndServicesMultiSelect" -Type
"AppsAndServicesMultiSelect"
entityIds type
--------- ----
{6, 5, 4} CLIENT_DOCUMENT

Cuando se recupera el valor de un campo personalizado «Apps and Services MultiSelect», el cmdlet devuelve un objeto personalizado que contiene una matriz de entityIds correspondientes a las opciones seleccionadas y el tipo de entidad que representan dichas opciones.

Ejemplo 3: Campo personalizado «Archivo adjunto»

PS C:> Get-NinjaProperty -Name "deploymentChecklist" -Type "Attachment"
contentId : RgOJqWzVlAxkwBTBSLeb
extension : docx
mimeType : application/vnd.openxmlformatsofficedocument.
wordprocessingml.document
name : Deployment Checklist
size : 27771

Cuando se recupera el valor de un campo personalizado de «Adjuntos», el cmdlet devuelve un objeto personalizado que contiene el contentId, la extensión, el tipo MIME, el nombre y el tamaño del adjunto.

Ejemplo 4: Campo personalizado de casilla de verificación

PS C:> Get-NinjaProperty -Name "desplegado" -Type "Casilla de verificación"
True
Cuando se recupera el valor de un campo personalizado de tipo «Casilla de verificación», el cmdlet devuelve un valor booleano (True o False), dependiendo de si la casilla está marcada o no. Si el valor del campo personalizado de tipo «Casilla de verificación» es nulo, el cmdlet no devuelve ningún resultado.

Ejemplo 5: Campo personalizado de fecha

PS C:> Get-NinjaProperty -Nombre «deploymentDay» -Tipo «Fecha»
Domingo, 1 de Febrero de 2026

Cuando se recupera el valor de un campo personalizado de tipo «Fecha», el cmdlet devuelve un objeto DateTime que representa el valor de fecha del campo personalizado. Esta fecha se muestra en el formato específico de la cultura y corresponde a la zona horaria local del dispositivo.

Ejemplo 6: Campo personalizado de Fecha y Hora

PS C:> Get-NinjaProperty -Name "lastSeen" -Type "DateTime"
Lunes, 2 de febrero de 2026 13:00:00
Cuando se recupera el valor de un campo personalizado de tipo «DateTime», el cmdlet devuelve un objeto «DateTime»
que representa el valor de fecha y hora del campo personalizado. Esta fecha y hora se muestran en
el formato de fecha y hora específico de la configuración regional y corresponden a la zona horaria local del dispositivo.

Ejemplo 7: Campo personalizado de tipo Decimal

PS C:> Get-NinjaProperty -Name "pi" -Tipo "Decimal"
3.14

Cuando se recupera el valor de un campo personalizado de tipo «Decimal», el cmdlet devuelve un valor de tipo decimal.

Ejemplo 8: Campo personalizado del despliegue de dispositivos

PS C:> Get-NinjaProperty -Name "exampleDeviceDropdown" -Type
"DeviceDropdown"
entityIds type
--------- ----
{160} NODE

Cuando se recupera el valor de un campo personalizado «Despliegue de dispositivos», el cmdlet devuelve un objeto personalizado
que contiene el entityId del dispositivo seleccionado y el tipo de entidad.

Ejemplo 9: Campo personalizado «Device MultiSelect»

Cuando se recupera el valor de un campo personalizado de selección múltiple de dispositivos, el cmdlet devuelve un objeto
personalizado que contiene una matriz de entityIds correspondientes a los dispositivos seleccionados y el tipo de entidad.

Ejemplo 10: Campo personalizado de menú desplegable

PS C:> Get-NinjaProperty -Name "favoriteBand" -Tipo "Dropdown"
Mötley Crüe

Cuando se recupera el valor de un campo personalizado de menú desplegable, el cmdlet devuelve el nombre de la pantalla de la opción seleccionada de
como una cadena.

Ejemplo 11: Campo personalizado de correo electrónico

PS C:> Get-NinjaProperty -Name "supportEmail" -Tipo "Correo electrónico"
[email protected]

Cuando se recupera el valor de un campo personalizado de correo electrónico, el cmdlet devuelve la dirección de correo electrónico como una cadena
.

Ejemplo 12: Campo personalizado de tipo entero

PS C:> Get-NinjaProperty -Name "favoriteNumber" -Type "Entero"
42

Cuando se recupera el valor de un campo personalizado de tipo entero, el cmdlet devuelve un valor de tipo entero.

Ejemplo 13: Campo personalizado de dirección de IP

PS C:> Get-NinjaProperty -Nombre "primaryDNS" -Tipo "IPAddress"
1.1.1.1

Cuando se recupera el valor de un campo personalizado de tipo «Dirección de IP», el cmdlet devuelve la dirección de IP como una cadena de tipo «
».

Ejemplo 14: Campo personalizado de múltiples líneas

PS C:> Get-NinjaProperty -Name "exampleMultiline" -Tipo "Multiline"
Línea 1
Línea 3

Cuando se recupera el valor de un campo personalizado multilínea, el cmdlet devuelve el valor como una cadena o,
, como una matriz de cadenas si hay más de una línea.

Ejemplo 15: Campo personalizado de selección múltiple

PS C:> Get-NinjaProperty -Name "exampleMultiselect" -Type "MultiSelect"
Opción 1
Valor 3

Cuando se recupera el valor de un campo personalizado de selección múltiple, el cmdlet devuelve los nombres de la pantalla de
las opciones seleccionadas como una cadena o una matriz de cadenas si se ha seleccionado más de una opción.

Ejemplo 16: Campo personalizado de menú desplegable de organización

PS C:> Get-NinjaProperty -Name "exampleOrganizationDropdown" -Type
OrganizationDropdown"
entityId type
-------- ----
8 CLIENT

Cuando se recupera el valor de un campo personalizado de menú desplegable de organización, el cmdlet devuelve un objeto personalizado de tipo `
` que contiene el `entityId` de la organización seleccionada y el tipo de entidad.

Ejemplo 17: Campo personalizado «Lista desplegable de ubicaciones de la organización»

PS C:> Get-NinjaProperty -Name "exampleOrganizationLocationDropdown" -Type
"OrganizationLocationDropdown"
entityId type
-------- ----
8 CLIENT_LOCATION

Cuando se recupera el valor de un campo personalizado de menú desplegable de ubicación de la organización, el cmdlet devuelve
un objeto personalizado que contiene el entityId de la ubicación de la organización seleccionada y el
tipo de entidad.

Ejemplo 18: Campo personalizado «Selección múltiple de organización»

PS C:> Get-NinjaProperty -Name "exampleOrganizationMultiSelect" -Type
"OrganizationMultiSelect"
entityIds type
--------- ----
{8, 13} CLIENTE

Cuando se recupera el valor del campo personalizado de selección múltiple de organizaciones, el cmdlet devuelve un objeto personalizado de tipo
que contiene una matriz de entityIds correspondientes a las organizaciones seleccionadas y el tipo de entidad
.

Ejemplo 19: Campo personalizado «Organization Location MultiSelect»

PS C:> Get-NinjaProperty -Name "exampleOrganizationLocationMultiSelect" -
Tipo "OrganizationLocationMultiSelect"

entityIds tipo
--------- ----
{8, 1} CLIENT_LOCATION

Cuando se recupera el valor del campo personalizado de selección múltiple de ubicaciones de una organización, el cmdlet
devuelve un objeto personalizado que contiene una matriz de entityIds para las ubicaciones
de la organización seleccionada y el tipo de entidad.

Ejemplo 20: Campo personalizado «Teléfono»

PS C:> Get-NinjaProperty -Name "supportNumber" -Tipo "Teléfono"
+18008675309

Cuando se recupera el valor de un campo personalizado de tipo «Phone», el cmdlet devuelve el número de teléfono como una cadena de caracteres.

Ejemplo 21: Campo personalizado seguro

PS C:> Get-NinjaProperty -Name "superSecretPassword" -Type "Campo seguro"
Hunter42

Cuando se recupera el valor de un campo personalizado de tipo «Secure», el cmdlet devuelve el valor como una cadena.

Ejemplo 22: Campo personalizado de texto

PS C:> Get-NinjaProperty -Name "exampleTextField" -Type "Texto"
My Texto

Cuando se recupera el valor de un campo personalizado de tipo «Texto», el cmdlet devuelve el valor como una cadena.

Ejemplo 23: Campo personalizado de tipo «Time»

PS C:> Get-NinjaProperty -Name "updateTime" -Type "Time"
9:00:00 a. m.

Cuando se recupera el valor de un campo personalizado de tipo «Hora», el cmdlet devuelve un objeto DateTime
que representa el valor de hora del campo personalizado. Esta hora se muestra en el formato de hora específico de la cultura
y corresponde a la zona horaria local del dispositivo.

Ejemplo 24: Campo personalizado «URL»

PS C:> Get-NinjaProperty -Name "exampleUrl" -Tipo "URL"
https://www.ninjaone.com

Cuando se recupera el valor de un campo personalizado de URL, el cmdlet devuelve la URL como una cadena de caracteres.

Ejemplo 25: Campo personalizado WYSIWYG

PS C:> Get-NinjaProperty -Nombre "systemPerformance" -Tipo "WYSIWYG"
html
----
<DIV> <DIV class='card flex-grow-1'>...</DIV>

Cuando se recupera el valor de un campo personalizado WYSIWYG, el cmdlet devuelve un objeto personalizado
que contiene el valor de cadena del campo personalizado.

Parámetros

-DocumentName

Especifica el nombre del documento del que se va a recuperar el valor del campo personalizado de documentación especificado.

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

-Nombre

Especifica el nombre del dispositivo o del campo personalizado de documentación cuyo valor deseas recuperar
.

Tipo: Cadena[]
Conjuntos de parámetros: (Todo)
Alias:
Obligatorio: Sí
Posición: 0
Valor predeterminado: Ninguno
Acepta entrada de canalización: Sí (Por valor)
Acepta caracteres comodín: No

-Tipo

El tipo de campo personalizado, que determina cómo se procesa y
se convierte el valor recuperado.
Los tipos admitidos incluyen: «Menú desplegable de aplicaciones y servicios», «Selección múltiple de aplicaciones y servicios»,
«Adjuntos», «Casilla de verificación», «Fecha», «Fecha y hora», «Decimal», «Menú desplegable de dispositivos», «Selección múltiple de dispositivos
», «Menú desplegable»,
«Menú desplegable de ubicación de organización», «Menú desplegable de ubicación de organización », «Selección múltiple de ubicación de organización », «Selección múltiple de organización», «Teléfono», «Seguro», «Texto», «Hora», «URL» y
«WYSIWYG».

Tipo: Cadena
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