Powershell: Ninja-Property-Get

Argomento

Questo articolo spiega come utilizzare Ninja-Property-Get per recuperare il valore di un campo personalizzato specificato di un dispositivo.

Ninja-Property-Get è un cmdlet obsoleto. Sebbene possa ancora funzionare, si consiglia di utilizzare invece Get-NinjaProperty.

Se si utilizza il modulo PowerShell di NinjaOne al di fuori di uno script di automazione, potrebbe essere necessario modificare la politica di esecuzione di PowerShell. Per ulteriori informazioni sulle politiche di esecuzione, consultare la documentazione di Microsoft: Informazioni sulle politiche di esecuzione ( link esterno).

Ambiente

NinjaOne
Microsoft PowerShell

Descrizione

Il cmdlet Ninja-Property-Get recupera il valore di un campo personalizzato specificato del dispositivo. È possibile specificare il nome del campo personalizzato utilizzando il parametro -Name. Il cmdlet restituisce il valore corrente del campo personalizzato specificato per il dispositivo. Con questo cmdlet è possibile recuperare solo i campi con autorizzazioni di lettura per l'automazione.

Sintassi

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

Esempi

Esempio 1: Campo personalizzato "Menu a discesa App e servizi"

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

Quando si recupera il valore di un campo personalizzato "Menu a tendina App e servizi", il cmdlet restituisce una stringa JSON contenente l’entityId e il tipo dell’elemento selezionato.

Esempio 2: Campo personalizzato "Selezione multipla di app e servizi"

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

Quando si recupera il valore di un campo personalizzato a selezione multipla "App e servizi", il cmdlet restituisce una stringa JSON contenente un array di entityId che rappresentano gli elementi selezionati e il tipo degli elementi selezionati.

Esempio 3: Campo personalizzato "Allegato"

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

Quando si recupera il valore di un campo personalizzato "Allegato", il cmdlet restituisce una stringa JSON contenente i dettagli relativi all’allegato, tra cui contentId, extension, mimeType, name e size.

Esempio 4: Campo personalizzato "Casella di controllo"

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

Quando si recupera il valore di un campo personalizzato "Casella di controllo", il cmdlet restituisce 1 se la casella di controllo è selezionata (vero) e 0 se non è selezionata (falso). Se non viene selezionato alcun valore, il cmdlet non restituisce alcun risultato.

Esempio 5: Campo personalizzato "Data"

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

Quando si recupera il valore di un campo personalizzato di tipo "Data", il cmdlet restituisce il valore della data come timestamp Unix, che rappresenta il numero di secondi trascorsi dal 1° gennaio 1970 (UTC).

Esempio 6: Campo personalizzato "DateTime"

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

Quando si recupera il valore di un campo personalizzato di tipo "DateTime", il cmdlet restituisce il valore di data e ora sotto forma di timestamp Unix che rappresenta il numero di secondi trascorsi dal 1° gennaio 1970 (UTC).

Esempio 7: Campo personalizzato Decimal

PS C:> Ninja-Property-Get -Name "pi"
3.14

Quando si recupera il valore di un campo personalizzato di tipo Decimal, il cmdlet restituisce il valore decimale sotto forma di stringa.

Esempio 8: campo personalizzato a menu a tendina "Device"

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

Quando si recupera il valore di un campo personalizzato "Menu a discesa dei dispositivi", il cmdlet restituisce una stringa JSON contenente l’entityId e il tipo del dispositivo selezionato.

Esempio 9: Campo personalizzato "Selezione multipla dei dispositivi"

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

Quando si recupera il valore di un campo personalizzato "Selezione multipla dei dispositivi", il cmdlet restituisce una stringa JSON contenente un array di entityId che rappresentano i dispositivi selezionati e il tipo dei dispositivi selezionati.

Esempio 10: Campo personalizzato a menu a tendina

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

Quando si recupera il valore di un campo personalizzato a menu a tendina, il cmdlet restituisce l’identificatore univoco (ID) dell’opzione selezionata sotto forma di stringa. È possibile utilizzare Ninja-Property-Options per recuperare le opzioni valide per il campo a menu a tendina e i relativi ID.

Esempio 11: Campo personalizzato "Email"

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

Quando si recupera il valore di un campo personalizzato "Email", il cmdlet restituisce l'indirizzo e-mail come stringa.

Esempio 12: Campo personalizzato di tipo "Integer"

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

Quando si recupera il valore di un campo personalizzato di tipo "Integer", il cmdlet restituisce il valore intero come stringa.

Esempio 13: campo personalizzato "Indirizzo IP"

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

Quando si recupera il valore di un campo personalizzato di tipo "Indirizzo IP", il cmdlet restituisce l'indirizzo IP come stringa.

Esempio 14: campo personalizzato multilinea

PS C:> Ninja-Property-Get -Name "exampleMultiline"
Riga 1
Riga 3

Quando si recupera il valore di un campo personalizzato multilinea, il cmdlet restituisce le più linee di testo come un array di stringhe, in cui ogni stringa nell’array corrisponde a una riga di testo nel campo multilinea. Se è presente una sola riga di testo, il cmdlet restituisce una singola stringa.

Esempio 15: Campo personalizzato a selezione multipla

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

Quando si recupera il valore di un campo personalizzato a selezione multipla, il cmdlet restituisce una stringa separata da virgole contenente gli identificatori univoci (ID) delle opzioni selezionate. È possibile utilizzare Ninja -Property-Options per recuperare le opzioni valide per il campo a selezione multipla e i relativi ID.

Esempio 16: Campo personalizzato a menu a tendina "Organizzazione"

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

Quando si recupera il valore di un campo personalizzato a menu a tendina "Organizzazione", il cmdlet restituisce una stringa JSON contenente l’entityId e il tipo dell’organizzazione selezionata.

Esempio 17: Campo personalizzato "Selezione a cascata della sede dell’organizzazione"

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

Quando si recupera il valore di un campo personalizzato "Menu a tendina della sede dell’organizzazione", il cmdlet restituisce una stringa JSON contenente l’entityId e il tipo della sede dell’organizzazione selezionata.

Esempio 18: Campo personalizzato "Selezione multipla dell’organizzazione"

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

Quando si recupera il valore di un campo personalizzato "Selezione multipla delle organizzazioni", il cmdlet restituisce una stringa JSON contenente un array di entityId che rappresentano le organizzazioni selezionate e il tipo delle organizzazioni selezionate.

Esempio 19: Campo personalizzato "Selezione multipla della sede dell’organizzazione"

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

Quando si recupera il valore di un campo personalizzato "Selezione multipla della sede dell’organizzazione", il cmdlet restituisce una stringa JSON contenente un array di entityIds che rappresentano le sedi delle organizzazioni selezionate e il tipo delle sedi delle organizzazioni selezionate.

Esempio 20: Campo personalizzato "Numero di telefono"

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

Quando si recupera il valore di un campo personalizzato "Telefono", il cmdlet restituisce il numero di telefono come stringa.

Esempio 21: Campo personalizzato protetto

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

Quando si recupera il valore di un campo personalizzato protetto, il cmdlet restituisce il valore protetto come stringa.

Esempio 22: Campo personalizzato di tipo "Testo"

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

Quando si recupera il valore di un campo personalizzato di tipo "Testo", il cmdlet restituisce il valore del testo come stringa.

Esempio 23: Campo personalizzato di tipo "Ora"

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

Quando si recupera il valore di un campo personalizzato di tipo "Tempo", il cmdlet restituisce il numero di secondi trascorsi dalla mezzanotte UTC (del giorno corrente).

Esempio 24: Campo personalizzato "URL"

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

Quando si recupera il valore di un campo personalizzato di tipo URL, il cmdlet restituisce l’URL come stringa.

Esempio 25: Campo personalizzato 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;Metriche sulle prestazioni del sistema</div>..."}

Quando si recupera il valore di un campo personalizzato WYSIWYG, il cmdlet restituisce una stringa JSON contenente il contenuto HTML del campo.

Parametri

-Nome

Specificare il nome del campo personalizzato del dispositivo di cui si desidera recuperare il valore.

Tipo: Oggetto
Set di parametri: (Tutti)
Alias:
Obbligatorio: Falso
Posizione: 0
Valore predefinito: Nessuno
Accetta input dalla pipeline: Falso
Accetta caratteri jolly: Falso

Input

System.String

Il cmdlet non accetta input dalla pipeline. Il parametro -Name accetta un valore stringa che rappresenta il nome del campo personalizzato del dispositivo di cui si desidera recuperare il valore.

Uscite

System.String[]

Il cmdlet restituisce il valore del campo personalizzato del dispositivo specificato come stringa. Per i campi personalizzati multilinea, il cmdlet restituisce un array di stringhe, in cui ogni stringa dell'array corrisponde a una riga di testo nel campo multilinea.

Tutti i campi relativi a data e ora vengono restituiti nel fuso orario UTC, ma vengono visualizzati nell’interfaccia utente web nel fuso orario locale del browser che visualizza il campo.
Il dispositivo che esegue questo cmdlet deve disporre dell’autorizzazione per visualizzare il campo personalizzato specificato al fine di recuperarne il valore. Per informazioni sulle autorizzazioni relative ai campi personalizzati, consultare NinjaOne Custom Fields: Getting Started.

Risorse aggiuntive

Per ulteriori informazioni sulla gestione delle risorse e sugli script personalizzati, consultare le seguenti risorse: