Powershell: Ninja-Property-Get

Tema

En este artículo se explica cómo utilizar Ninja-Property-Get para recuperar el valor de un campo personalizado específico de un dispositivo.

Ninja-Property-Get es un cmdlet obsoleto. Aunque es posible que siga funcionando, recomendamos utilizar Get-NinjaProperty en su lugar.

Si utilizas el módulo de PowerShell de NinjaOne 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: sobre políticas de ejecución ( enlace externo).

Entorno

NinjaOne
Microsoft PowerShell

Descripción

El cmdlet Ninja-Property-Get recupera el valor de un campo personalizado especificado del dispositivo. Puedes especificar el nombre del campo personalizado mediante el parámetro -Name. El cmdlet devuelve el valor actual del campo personalizado especificado para el dispositivo. Solo se pueden recuperar mediante este cmdlet los campos con permisos de lectura de automatización.

Sintaxis

Ninja-Property-Get [[-Name] <Object>] [<CommonParameters>]

Ejemplos

Ejemplo 1: Campo personalizado del menú desplegable «Aplicaciones y servicios»

PS C:> Ninja-Property-Get -Name "exampleAppsAndServicesDropdown"
{"entityId":5,"type":"CLIENT_DOCUMENT"}

Al recuperar el valor de un campo personalizado del menú desplegable «Aplicaciones y servicios», el cmdlet devuelve una cadena JSON que contiene el entityId y el tipo del elemento seleccionado.

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

PS C:> Ninja-Property-Get -Name "exampleAppsAndServicesMultiselect"
{"entityIds":[6,5,4],"type":"CLIENT_DOCUMENT"}

Al recuperar el valor de un campo personalizado de selección múltiple de «Aplicaciones y servicios», el cmdlet devuelve una cadena JSON que contiene una matriz de entityIds que representan los elementos seleccionados y el tipo de dichos elementos.

Ejemplo 3: Campo personalizado «Archivo adjunto»

 PS C:> Ninja-Property-Get -Name "deploymentChecklist"
{"contentId":"RgOJqWzVlAxkwBTBSLeb","extension":"docx","mimeType":"applicati
on/vnd.openxmlformatsofficedocument.
wordprocessingml.document","name":"Deployment
Checklist","size":27771}

Al recuperar el valor de un campo personalizado de archivo adjunto, el cmdlet devuelve una cadena JSON que contiene detalles sobre el archivo adjunto, incluidos contentId, extension, mimeType, name y size.

Ejemplo 4: Campo personalizado de casilla de selección

 PS C:> Ninja-Property-Get -Name "deployed"
1

Al recuperar el valor de un campo personalizado de tipo «Casilla de selección», el cmdlet devuelve 1 si la casilla está marcada (verdadero) y 0 si no lo está (falso). Si no se selecciona ningún valor, el cmdlet no devuelve ningún resultado.

Ejemplo 5: Campo personalizado de fecha

 PS C:> Ninja-Property-Get -Name "deploymentDay"
1769976000

Al recuperar el valor de un campo personalizado de tipo «Fecha», el cmdlet devuelve el valor de la fecha como una marca de tiempo Unix que representa el número de segundos transcurridos desde el 1 de enero de 1970 (UTC).

Ejemplo 6: Campo personalizado de fecha y hora

 PS C:> Ninja-Property-Get -Name "lastSeen"
1770904800

Al recuperar el valor de un campo personalizado de tipo «DateTime», el cmdlet devuelve el valor de fecha y hora como una marca de tiempo Unix que representa el número de segundos transcurridos desde el 1 de enero de 1970 (UTC).

Ejemplo 7: Campo personalizado de tipo «Decimal»

PS C:> Ninja-Property-Get -Name "pi"
3,14

Al recuperar el valor de un campo personalizado de tipo decimal, el cmdlet devuelve el valor decimal como una cadena de caracteres.

Ejemplo 8: Campo personalizado de menú desplegable de dispositivos

PS C:> Ninja-Property-Get -Name "exampleDeviceDropdown"
{"entityId":1226,"type":"NODE"}

Al recuperar el valor de un campo personalizado de menú desplegable de dispositivos, el cmdlet devuelve una cadena JSON que contiene el «entityId» y el «type» del dispositivo seleccionado.

Ejemplo 9: Campo personalizado «Selección múltiple de dispositivos»

PS C:> Ninja-Property-Get -Name "exampleDeviceMultiselect"
{"entityIds":[1226,1131],"type":"NODE"}

Al recuperar el valor de un campo personalizado «Selección múltiple de dispositivos», el cmdlet devuelve una cadena JSON que contiene una matriz de entityIds que representan los dispositivos seleccionados y el tipo de los dispositivos seleccionados.

Ejemplo 10: Campo personalizado de menú desplegable

PS C:> Ninja-Property-Get -Name "favoriteBand"
2a100199-4067-4332-8f4d-451e14b94a76

Al recuperar el valor de un campo personalizado de menú desplegable, el cmdlet devuelve el identificador único (ID) de la opción seleccionada como una cadena. Puedes utilizar Ninja-Property-Options para recuperar las opciones válidas para el campo de menú desplegable y sus ID correspondientes.

Ejemplo 11: Campo personalizado «Email»

PS C:> Ninja-Property-Get -Name "supportEmail"
[email protected]

Al recuperar el valor de un campo personalizado de correo electrónico, el cmdlet devuelve la dirección de correo electrónico como una cadena de caracteres.

Ejemplo 12: Campo personalizado de tipo entero

 PS C:> Ninja-Property-Get -Name "favoriteNumber"
42

Al recuperar el valor de un campo personalizado de tipo entero, el cmdlet devuelve el valor entero como una cadena de caracteres.

Ejemplo 13: Campo personalizado de dirección IP

PS C:> Ninja-Property-Get -Name "primaryDNS"
1.1.1.1

Al recuperar el valor de un campo personalizado de dirección IP, el cmdlet devuelve la dirección IP como una cadena de caracteres.

Ejemplo 14: Campo personalizado de varias líneas

PS C:> Ninja-Property-Get -Name "exampleMultiline"
Línea 1
Línea 3

Al recuperar el valor de un campo personalizado multilínea, el cmdlet devuelve las distintas líneas de texto como una matriz de cadenas, en la que cada cadena de la matriz se corresponde con una línea de texto del campo multilínea. Si solo hay una línea de texto, el cmdlet devuelve una única cadena.

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

PS C:> Ninja-Property-Get -Name "exampleMultiselect"
834d0865-1c70-492b-ac11-73854fd0294d, 154d90cf-3d4a-4e43-8b79-232ccd5b74a6

Al recuperar el valor de un campo personalizado de selección múltiple, el cmdlet devuelve una cadena separada por comas con los identificadores únicos (ID) de las opciones seleccionadas. Puedes utilizar Ninja -Property-Options para recuperar las opciones válidas para el campo de selección múltiple y sus ID correspondientes.

Ejemplo 16: Campo personalizado de menú desplegable «Organización»

PS C:> Ninja-Property-Get -Name "exampleOrganizationDropdown"
{"entityId":8,"type":"CLIENT"}

Al recuperar el valor de un campo personalizado de menú desplegable de organización, el cmdlet devuelve una cadena JSON que contiene el «entityId» y el «type» de la organización seleccionada.

Ejemplo 17: Campo personalizado de menú desplegable de ubicación de la organización

PS C:> Ninja-Property-Get -Name "exampleOrganizationLocationDropdown"
{"entityId":8,"type":"CLIENT_LOCATION"}

Al recuperar el valor de un campo personalizado de menú desplegable de ubicación de la organización, el cmdlet devuelve una cadena JSON que contiene el entityId y el tipo de la ubicación de la organización seleccionada.

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

PS C:> Ninja-Property-Get -Name "exampleOrganizationMultiSelect"
{"entityIds":[8,13],"type":"CLIENT"}

Al recuperar el valor de un campo personalizado de selección múltiple de organizaciones, el cmdlet devuelve una cadena JSON que contiene una matriz de entityIds que representan las organizaciones seleccionadas y el tipo de las mismas.

Ejemplo 19: Campo personalizado «Selección múltiple de ubicaciones de la organización»

PS C:> Ninja-Property-Get -Name "exampleOrganizationLocationMultiSelect"
{"entityIds":[8,1],"type":"CLIENT_LOCATION"}

Al recuperar el valor de un campo personalizado «Ubicación de la organización» de selección múltiple, el cmdlet devuelve una cadena JSON que contiene una matriz de entityIds que representan las ubicaciones de las organizaciones seleccionadas y el tipo de dichas ubicaciones.

Ejemplo 20: Campo personalizado «Teléfono»

PS C:> Ninja-Property-Get -Name "supportNumber"
+18008675309

Al recuperar el valor de un campo personalizado de «Teléfono», el cmdlet devuelve el número de teléfono como una cadena.

Ejemplo 21: Campo personalizado seguro

PS C:> Ninja-Property-Get -Name "superSecretPassword"
Hunter42

Al recuperar el valor de un campo personalizado «Seguro», el cmdlet devuelve el valor seguro como una cadena de caracteres.

Ejemplo 22: Campo personalizado de texto

PS C:> Ninja-Property-Get -Name "exampleText"
My Text

Al recuperar el valor de un campo personalizado de texto, el cmdlet devuelve el valor de texto como una cadena.

Ejemplo 23: Campo personalizado de hora

 PS C:> Ninja-Property-Get -Name "updateTime"
 79200

Al recuperar el valor de un campo personalizado de tipo «Tiempo», el cmdlet devuelve el número de segundos transcurridos desde la medianoche UTC (del día actual).

Ejemplo 24: Campo personalizado «URL»

PS C:> Ninja-Property-Get -Name "exampleUrl"
https://www.google.com

Al recuperar 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:> Ninja-Property-Get -Name "systemPerformance"
{"html":"<div> <div class='card flex-grow-1'>n <div class='card-titlebox'>
n <div class='card-title'><i class='fa-solid fa-gauge-high'>
</i>&nbsp;&nbsp;Métricas de rendimiento del sistema</div>..."}

Al recuperar el valor de un campo personalizado WYSIWYG, el cmdlet devuelve una cadena JSON que contiene el contenido HTML del campo.

Parámetros

-Nombre

Especifica el nombre del campo personalizado del dispositivo cuyo valor se desea recuperar.

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

Entradas

System.String

El cmdlet no acepta entradas de la canalización. El parámetro -Name acepta un valor de cadena que representa el nombre del campo personalizado del dispositivo cuyo valor se desea recuperar.

Salidas

System.String[]

El cmdlet devuelve el valor del campo personalizado del dispositivo especificado como una cadena. En el caso de los campos personalizados multilínea, el cmdlet devuelve una matriz de cadenas, en la que cada cadena de la matriz se corresponde con una línea de texto del campo multilínea.

Todos los campos relacionados con la fecha y la hora se devuelven en la zona horaria UTC, pero se muestran en la interfaz de usuario web en la zona horaria local del navegador desde el que se visualiza el campo.
El dispositivo que ejecute este cmdlet debe tener permiso para ver el campo personalizado especificado a fin de poder recuperar su valor. 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: