PowerShell : Get NinjaProperty

Sujet

Cet article explique comment utiliser Get-NinjaProperty pour récupérer et convertir la valeur d'un champ personnalisé en fonction de son nom et de son type.

Environnement

• NinjaOne 
• Microsoft PowerShell

Description

La cmdlet Get-NinjaProperty récupère la valeur d’un champ personnalisé ou d’un champ de documentation spécifié. Elle vous permet de spécifier le nom du champ, le type de propriété et, éventuellement, le nom d’un document ou d’un modèle. Le type de propriété permet à la cmdlet de traiter et de convertir la valeur brute en un objet PowerShell approprié en fonction du type de champ personnalisé récupéré. 

Lorsqu’un nom de document est fourni, la cmdlet récupère la valeur de la propriété à partir du document unique spécifié plutôt qu’à partir du champ personnalisé de l’appareil. Pour les champs nécessitant des options supplémentaires (tels que les listes déroulantes ou les champs à sélection multiple), la cmdlet récupère ces options et renvoie les noms d’affichage des options sélectionnées plutôt que la valeur brute, à condition que vous ayez spécifié le type approprié.

Les types de propriétés pris en charge sont les suivants : « Apps and Services Dropdown », « Apps and Services
Multiselect », « Attachment », « Checkbox », « Date », « DateTime », « Decimal », « Device Dropdown »,
« Device MultiSelect », « Dropdown », « E-mail », « Entier », « Adresse IP », « Multiligne », « Sélection multiple »,
« Menu déroulant Organisation », « Menu déroulant Emplacement de l’organisation », « Sélection multiple d’
s sur l’emplacement de l’organisation », « Sélection multiple Organisation », « Téléphone », « Sécurisé », « Texte », « Heure », « URL » et
« WYSIWYG ».

Si aucun type de propriété n’est spécifié, la cmdlet renvoie la valeur sous forme de chaîne brute du champ personnalisé, sans aucun traitement ni conversion supplémentaires. Consultez les exemples Ninja-Property-Get pour savoir comment les valeurs sont traitées lorsqu’aucun type n’est spécifié. Seuls les champs disposant d’autorisations de lecture en mode automatisé peuvent être récupérés à l’aide de cette cmdlet.

Syntaxe

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

Exemples

Exemple 1 : champ personnalisé « Apps and Services Dropdown »

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

Lorsqu’une valeur du champ personnalisé « Menu déroulant des applications et services » est récupérée, la cmdlet renvoie un objet personnalisé de type
contenant l’entityId de l’option sélectionnée et le type d’entité que représente l’option
.

Exemple 2 : champ personnalisé à sélection multiple « Applications et services »

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

Lorsqu’une valeur du champ personnalisé « Apps and Services MultiSelect » est récupérée, la cmdlet renvoie un objet personnalisé contenant un tableau d’entityIds correspondant aux options sélectionnées, ainsi que le type d’entité que ces options représentent.

Exemple 3 : champ personnalisé « Pièce jointe »

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

Lorsqu’une valeur de champ personnalisé « Pièce jointe » est récupérée, la cmdlet renvoie un objet personnalisé contenant l’ identifiant de contenu (contentId), l’extension, le type MIME (mimeType), le nom et la taille de la pièce jointe.

Exemple 4 : champ personnalisé de type case à cocher

PS C:> Get-NinjaProperty -Name "deployed" -Type "Checkbox"
True
Lorsqu’une valeur de champ personnalisé de type « Case à cocher » est récupérée, la cmdlet renvoie une valeur booléenne (True ou False), selon que la case est cochée ou non. Si la valeur du champ personnalisé de type « Case à cocher » est nulle, la cmdlet ne renvoie aucun résultat.

Exemple 5 : champ personnalisé « Date »

PS C:> Get-NinjaProperty -Name "deploymentDay" -Type "Date"
Dimanche 1er février 2026

Lorsqu’une valeur de champ personnalisé de type Date est récupérée, la cmdlet renvoie un objet DateTime représentant la valeur de date du champ personnalisé. Cette date est affichée au format spécifique à la culture et correspond au fuseau horaire local de l’appareil.

Exemple 6 : champ personnalisé de date et d’heure

PS C:> Get-NinjaProperty -Name "lastSeen" -Type "DateTime"
Lundi 2 février 2026 13 h 00
Lorsqu’une valeur de champ personnalisé de type DateTime est récupérée, la cmdlet renvoie un objet DateTime
représentant la valeur de date et d’heure du champ personnalisé. Cette date et cette heure s’affichent
au format de date et d’heure spécifique à la culture et correspondent au fuseau horaire local de l’appareil.

Exemple 7 : champ personnalisé de type décimal

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

Lorsqu’une valeur de champ personnalisé de type décimal est récupérée, la cmdlet renvoie une valeur de type décimal.

Exemple 8 : champ personnalisé de liste déroulante « Device »

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

Lorsqu’une valeur du champ personnalisé « Device Dropdown » est récupérée, la cmdlet renvoie un objet personnalisé de type
contenant l’entityId de l’appareil sélectionné et le type d’entité.

Exemple 9 : champ personnalisé « Device MultiSelect »

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

Lorsqu’une valeur du champ personnalisé Device MultiSelect est récupérée, la cmdlet renvoie un objet
personnalisé contenant un tableau d’entityIds correspondant aux périphériques sélectionnés ainsi que le type d’entité.

Exemple 10 : champ personnalisé de type liste déroulante

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

Lorsqu’une valeur de champ personnalisé de type « Dropdown » est récupérée, la cmdlet renvoie le nom d’affichage de l’option sélectionnée dans l’
sous forme de chaîne de caractères.

Exemple 11 : champ personnalisé de type « e-mail »

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

Lorsqu’une valeur de champ personnalisé de type « E-mail » est récupérée, la cmdlet renvoie l’adresse e-mail sous forme de chaîne de caractères
.

Exemple 12 : champ personnalisé de type entier

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

Lorsqu’une valeur de champ personnalisé de type « Integer » est récupérée, la cmdlet renvoie une valeur de type entier.

Exemple 13 : champ personnalisé de type « IPAddress »

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

Lorsqu'une valeur de champ personnalisé de type « Adresse IP » est récupérée, la cmdlet renvoie l'adresse IP sous forme de chaîne de caractères
.

Exemple 14 : champ personnalisé multiligne

PS C:> Get-NinjaProperty -Name "exampleMultiline" -Type "Multiline"
Ligne 1
Ligne 3

Lorsqu’une valeur de champ personnalisé multiligne est récupérée, la cmdlet renvoie la valeur sous forme de chaîne de caractères ou,
, sous forme de tableau de chaînes de caractères s’il y a plusieurs lignes.

Exemple 15 : champ personnalisé à sélection multiple

PS C:> Get-NinjaProperty -Name "exampleMultiselect" -Type "MultiSelect"
Option 1
Valeur 3

Lorsqu’une valeur de champ personnalisé MultiSelect est récupérée, la cmdlet renvoie les noms d’affichage d’
des options sélectionnées sous forme de chaîne de caractères ou de tableau de chaînes de caractères si plusieurs options sont sélectionnées.

Exemple 16 : champ personnalisé « Organisation » (liste déroulante)

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

Lorsqu’une valeur du champ personnalisé « Organisation » (liste déroulante) est récupérée, la cmdlet renvoie un objet personnalisé de type `
` contenant l’`entityId` de l’organisation sélectionnée et le type d’entité.

Exemple 17 : Champ personnalisé « Organisation Location Dropdown »

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

Lorsqu’une valeur du champ personnalisé « Organisation Location Dropdown » est récupérée, la cmdlet renvoie
un objet personnalisé contenant l’entityId de l’emplacement de l’organisation sélectionné et le type d’entité
.

Exemple 18 : champ personnalisé « Sélection multiple d’emplacements d’organisation »

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

Lorsqu’une valeur du champ personnalisé « Organization MultiSelect » est récupérée, la cmdlet renvoie un objet personnalisé de type «
» contenant un tableau d’« entityIds » correspondant aux organisations sélectionnées et d’entités de type «
».

Exemple 19 : champ personnalisé « Emplacement de l’organisation » à sélection multiple

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

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

Lorsqu’une valeur du champ personnalisé « Organisation Location MultiSelect » est récupérée, la cmdlet
renvoie un objet personnalisé contenant un tableau d’entityIds pour les emplacements de l’organisation
sélectionnés ainsi que le type d’entité.

Exemple 20 : champ personnalisé « Téléphone »

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

Lorsqu’une valeur de champ personnalisé « Phone » est récupérée, la cmdlet renvoie le numéro de téléphone sous forme de chaîne de caractères.

Exemple 21 : champ personnalisé sécurisé

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

Lorsqu'une valeur de champ personnalisé de type « Secure » est récupérée, la cmdlet renvoie la valeur sous forme de chaîne de caractères.

Exemple 22 : champ personnalisé de type « Text »

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

Lorsqu’une valeur de champ personnalisé de type « Text » est récupérée, la cmdlet renvoie cette valeur sous forme de chaîne de caractères.

Exemple 23 : champ personnalisé de type « Time »

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

Lorsqu'une valeur de champ personnalisé de type « Time » est récupérée, la cmdlet renvoie un objet DateTime
représentant la valeur temporelle du champ personnalisé. Cette heure est affichée au format horaire spécifique à la culture
et correspond au fuseau horaire local de l'appareil.

Exemple 24 : champ personnalisé « URL »

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

Lorsqu’une valeur de champ personnalisé de type URL est récupérée, la cmdlet renvoie l’URL sous forme de chaîne de caractères.

Exemple 25 : champ personnalisé WYSIWYG

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

Lorsqu'une valeur de champ personnalisé WYSIWYG est récupérée, la cmdlet renvoie un objet personnalisé
contenant la valeur sous forme de chaîne HTML du champ personnalisé.

Paramètres

-DocumentName

Spécifie le nom du document à partir duquel récupérer la valeur du champ personnalisé de documentation spécifié.

Type : Chaîne de caractères
Ensembles de paramètres : (Tous)
Alias :
Obligatoire : Faux
Position : 2
Valeur par défaut : Aucune
Accepte les entrées de pipeline : Faux
Accepte les caractères génériques : Faux

-Name

Spécifiez le nom de l'appareil ou du champ personnalisé de documentation dont vous souhaitez récupérer la valeur à l'aide de l'
.

Type : Chaîne de caractères[]
Jeux de paramètres : (Tous)
Alias :
Obligatoire : Vrai
Position : 0
Valeur par défaut : Aucune
Accepte les entrées du pipeline : Vrai (par valeur)
Accepte les caractères génériques : Faux

-Type

Le type du champ personnalisé, qui détermine la manière dont la valeur récupérée est traitée et convertie
.
Les types pris en charge sont les suivants : « Menu déroulant Applications et services », « Sélection multiple Applications et services »,
« Pièce jointe », « Case à cocher », « Date », « Date et heure », « Décimal », « Menu déroulant Appareil », « Sélection multiple d'
s sur l'appareil », « Menu déroulant », « E-mail », « Entier », « Adresse IP », « Multiligne », « Sélection multiple »,
« Menu déroulant Organisation », « Menu déroulant Emplacement de l’organisation », « Sélection multiple d’
s sur l’emplacement de l’organisation », « Sélection multiple Organisation », « Téléphone », « Sécurisé », « Texte », « Heure », « URL » et
« WYSIWYG ».

Type : Chaîne de caractères
Jeux de paramètres : (Tous)
Alias :
Obligatoire : Faux
Position : 1
Valeur par défaut : Aucune
Accepte les entrées du pipeline : Faux
Accepte les caractères génériques : Faux