Powershell: Ottenere NinjaProperty

Argomento

Questo articolo spiega come utilizzare Get-NinjaProperty per recuperare e convertire il valore di un campo personalizzato in base al suo nome e al suo tipo.

Ambiente

• NinjaOne 
• Microsoft PowerShell

Descrizione

Il cmdlet Get-NinjaProperty recupera il valore di un campo personalizzato o di un campo di documentazione specificato. Consente di specificare il nome del campo, il tipo di proprietà e, facoltativamente, il nome di un documento o di un modello. Il tipo di proprietà consente al cmdlet di elaborare e convertire il valore grezzo in un oggetto PowerShell appropriato in base al tipo di campo personalizzato che si sta recuperando. 

Quando viene fornito il nome di un documento, il cmdlet recupera il valore della proprietà dal singolo documento specificato anziché dal campo personalizzato del dispositivo. Per i campi che richiedono opzioni aggiuntive (come menu a discesa o campi a selezione multipla), il cmdlet recupera tali opzioni e restituisce i nomi visualizzati delle opzioni selezionate anziché il valore grezzo, a condizione che sia stato specificato il tipo appropriato.

I tipi di proprietà supportati includono: "Menu a tendina App e servizi", "
nzione a selezione multipla App e servizi", "Allegato", "Casella di controllo", "Data", "Data e ora", "Decimale", "Menu a tendina dispositivo",
"Selezione multipla dispositivo", "Menu a tendina", "Email", "Integer", "IP Address", "MultiLine", "MultiSelect",
"Organization Dropdown", "Organization Location Dropdown", "Organization Location
MultiSelect", "Organization MultiSelect", "Phone", "Secure", "Text", "Time", "URL" e
"WYSIWYG".

Se non viene specificato un tipo di proprietà, il cmdlet restituirà il valore della stringa grezza del campo personalizzato senza alcuna elaborazione o conversione aggiuntiva. Vedere gli esempi di Ninja-Property-Get per capire come vengono elaborati i valori quando non viene specificato un tipo. Solo i campi con autorizzazioni di lettura per l’automazione possono essere recuperati utilizzando questo cmdlet.

Sintassi

Get-NinjaProperty [-Name] <String[]> [[-Type] <String>] [[-DocumentName] <String>] [<CommonParameters>]

Esempi

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

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

Quando viene recuperato il valore di un campo personalizzato del menu a discesa "App e servizi", il cmdlet restituisce un oggetto personalizzato di tipo
contenente l’entityId dell’opzione selezionata e il tipo di entità rappresentata dall’opzione
.

Esempio 2: Campo personalizzato a selezione multipla "Apps and Services"

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

Quando viene recuperato il valore di un campo personalizzato "Apps and Services MultiSelect", il cmdlet restituisce un oggetto personalizzato contenente un array di entityIds per le opzioni selezionate e il tipo di entità che le opzioni rappresentano.

Esempio 3: Campo personalizzato "Allegato"

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

Quando viene recuperato il valore di un campo personalizzato "Allegato", il cmdlet restituisce un oggetto personalizzato contenente l'ID contenuto, l'estensione, il tipo MIME, il nome e la dimensione dell'allegato.

Esempio 4: Campo personalizzato "Casella di controllo"

PS C:> Get-NinjaProperty -Name "deployed" -Type "Checkbox"
True
Quando viene recuperato il valore di un campo personalizzato di tipo "Casella di controllo", il cmdlet restituisce un valore booleano True o False, a seconda che la casella di controllo sia selezionata o meno. Se il valore del campo personalizzato di tipo "Casella di controllo" è nullo, il cmdlet non restituisce alcun risultato.

Esempio 5: Campo personalizzato "Data"

PS C:> Get-NinjaProperty -Name "deploymentDay" -Type "Date"
Domenica 1 febbraio 2026

Quando viene recuperato il valore di un campo personalizzato di tipo "Data", il cmdlet restituisce un oggetto DateTime che rappresenta il valore della data del campo personalizzato. Questa data viene visualizzata nel formato specifico della cultura e nel fuso orario locale del dispositivo.

Esempio 6: Campo personalizzato "Data e ora"

PS C:> Get-NinjaProperty -Name "lastSeen" -Type "DateTime"
Lunedì 2 febbraio 2026 13:00:00
Quando viene recuperato il valore di un campo personalizzato di tipo "DateTime", il cmdlet restituisce un oggetto DateTime
che rappresenta il valore di data e ora del campo personalizzato. Questa data e ora vengono visualizzate in
nel formato di data e ora specifico della cultura e nel fuso orario locale del dispositivo.

Esempio 7: Campo personalizzato di tipo Decimal

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

Quando viene recuperato il valore di un campo personalizzato di tipo Decimal, il cmdlet restituisce un valore di tipo decimale.

Esempio 8: Campo personalizzato a menu a tendina del dispositivo

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

Quando viene recuperato il valore di un campo personalizzato "Device Dropdown", il cmdlet restituisce un oggetto personalizzato
contenente l’entityId del dispositivo selezionato e il tipo di entità.

Esempio 9: Campo personalizzato "Device MultiSelect"

PS C:> Get-NinjaProperty -Name "exampleDeviceMultiselect" -Type
"DeviceMultiSelect"
entityIds type
--------- ----
{160, 188} NODE

Quando viene recuperato il valore di un campo personalizzato Device MultiSelect, il cmdlet restituisce un oggetto personalizzato di tipo
contenente un array di entityIds relativi ai dispositivi selezionati e il tipo di entità.

Esempio 10: Campo personalizzato a menu a tendina

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

Quando viene recuperato il valore di un campo personalizzato a menu a tendina, il cmdlet restituisce il nome visualizzato dell’opzione selezionata in
sotto forma di stringa.

Esempio 11: Campo personalizzato "Email"

PS C:> Get-NinjaProperty -Name "supportEmail" -Type "Email"
[email protected]

Quando viene recuperato il valore di un campo personalizzato di tipo Email, il cmdlet restituisce l'indirizzo e-mail come stringa
.

Esempio 12: Campo personalizzato di tipo intero

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

Quando viene recuperato il valore di un campo personalizzato di tipo "Integer", il cmdlet restituisce un valore di tipo intero.

Esempio 13: Campo personalizzato di tipo "IPAddress"

PS C:> Get-NinjaProperty -Name "primaryDNS" -Type "IPAddress"
1.1.1.1

Quando viene recuperato 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:> Get-NinjaProperty -Name "exampleMultiline" -Type "Multiline"
Riga 1
Riga 3

Quando viene recuperato il valore di un campo personalizzato multilinea, il cmdlet restituisce il valore come stringa oppure,
, come array di stringhe se è presente più di una riga.

Esempio 15: Campo personalizzato a selezione multipla

PS C:> Get-NinjaProperty -Name "exampleMultiselect" -Type "MultiSelect"
Opzione 1
Valore 3

Quando viene recuperato il valore di un campo personalizzato MultiSelect, il cmdlet restituisce i nomi visualizzati delle opzioni selezionate (
) come stringa o come array di stringhe se è stata selezionata più di un'opzione.

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

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

Quando viene recuperato il valore di un campo personalizzato "Menu a tendina dell’organizzazione", il cmdlet restituisce un oggetto personalizzato di tipo
contenente l’entityId dell’organizzazione selezionata e il tipo di entità.

Esempio 17: Campo personalizzato "Menu a tendina della sede dell’organizzazione"

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

Quando viene recuperato il valore di un campo personalizzato "Selezione a cascata della sede dell'organizzazione", il cmdlet restituisce
un oggetto personalizzato contenente l'entityId della sede dell'organizzazione selezionata e il
tipo di entità.

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

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

Quando viene recuperato il valore di un campo personalizzato "Organization MultiSelect", il cmdlet restituisce un oggetto personalizzato di tipo "
" contenente un array di "entityIds" relativi alle organizzazioni selezionate e il tipo di entità "
".

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

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

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

Quando viene recuperato il valore di un campo personalizzato "Selezione multipla delle sedi dell’organizzazione", il cmdlet
restituisce un oggetto personalizzato contenente un array di entityIds per le sedi dell’organizzazione
selezionate e il tipo di entità.

Esempio 20: Campo personalizzato "Telefono"

PS C:> Get-NinjaProperty -Name "supportNumber" -Type "Phone"
+18008675309

Quando viene recuperato il valore di un campo personalizzato di tipo "Phone", il cmdlet restituisce il numero di telefono come stringa.

Esempio 21: Campo personalizzato protetto

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

Quando viene recuperato il valore di un campo personalizzato di tipo "Secure", il cmdlet restituisce il valore come stringa.

Esempio 22: Campo personalizzato di tipo "Text"

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

Quando viene recuperato il valore di un campo personalizzato di tipo "Text", il cmdlet restituisce il valore come stringa.

Esempio 23: Campo personalizzato "Time"

PS C:> Get-NinjaProperty -Name "updateTime" -Type "Time"
9:00:00 AM

Quando viene recuperato il valore di un campo personalizzato di tipo "Time", il cmdlet restituisce un oggetto DateTime
che rappresenta il valore temporale del campo personalizzato. L'ora viene visualizzata nel formato specifico della cultura
ed è espressa nel fuso orario locale del dispositivo.

Esempio 24: Campo personalizzato URL

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

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

Esempio 25: Campo personalizzato WYSIWYG

PS C:> Get-NinjaProperty -Name "systemPerformance" -Type "WYSIWYG"
html
----
<div> <div class='card flex-grow-1'>...

Quando viene recuperato il valore di un campo personalizzato WYSIWYG, il cmdlet restituisce un oggetto personalizzato
contenente il valore della stringa HTML del campo personalizzato.

Parametri

-DocumentName

Specificare il nome del documento da cui recuperare il valore del campo personalizzato della documentazione specificato.

Tipo: Stringa
Set di parametri: (Tutti)
Alias:
Obbligatorio: False
Posizione: 2
Valore predefinito: Nessuno
Accetta input dalla pipeline: False
Accetta caratteri jolly: False

-Name

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

Tipo: String[]
Set di parametri: (Tutti)
Alias:
Obbligatorio: True
Posizione: 0
Valore predefinito: Nessuno
Accetta input dalla pipeline: True (ByValue)
Accetta caratteri jolly: False

-Tipo

Il tipo di campo personalizzato, che determina come il valore recuperato viene elaborato e convertito
.
I tipi supportati includono: "Menu a tendina App e servizi", "Selezione multipla App e servizi",
"Allegato", "Casella di controllo", "Data", "Data e ora", "Decimale", "Menu a tendina Dispositivo", "
e multipla Dispositivo", "Menu a tendina", "Email", "Integer", "IP Address", "MultiLine", "MultiSelect",
"Organization Dropdown", "Organization Location Dropdown", "Organization Location
MultiSelect", "Organization MultiSelect", "Phone", "Secure", "Text", "Time", "URL" e
"WYSIWYG".

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