PowerShell : Ninja-Property-Get

Sujet

Cet article explique comment utiliser Ninja-Property-Get pour récupérer la valeur d'un champ personnalisé d'un périphérique spécifié.

Ninja-Property-Get est une cmdlet obsolète. Bien qu'elle puisse encore fonctionner, nous vous recommandons d'utiliser Get-NinjaProperty à la place.

Si vous utilisez le module PowerShell NinjaOne en dehors d’un script d’automatisation, vous devrez peut-être ajuster la stratégie d’exécution de PowerShell. Pour plus d’informations sur les stratégies d’exécution, consultez la documentation de Microsoft : À propos des stratégies d’exécution ( lien externe).

Environnement

NinjaOne
Microsoft PowerShell

Description

La cmdlet Ninja-Property-Get récupère la valeur d’un champ personnalisé spécifié pour un périphérique. Vous pouvez spécifier le nom du champ personnalisé à l’aide du paramètre -Name. La cmdlet renvoie la valeur actuelle du champ personnalisé spécifié pour le périphérique. Seuls les champs disposant d’autorisations de lecture pour l’automatisation peuvent être récupérés à l’aide de cette cmdlet.

Syntaxe

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

Exemples

Exemple 1 : champ personnalisé « Menu déroulant des applications et services »

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

Lors de la récupération de la valeur d’un champ personnalisé « Menu déroulant des applications et services », la cmdlet renvoie une chaîne JSON contenant l’entityId et le type de l’élément sélectionné.

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

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

Lors de la récupération de la valeur d’un champ personnalisé à sélection multiple « Applications et services », la cmdlet renvoie une chaîne JSON contenant un tableau d’entityIds représentant les éléments sélectionnés ainsi que le type de ces éléments.

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

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

Lors de la récupération de la valeur d’un champ personnalisé « Pièce jointe », la cmdlet renvoie une chaîne JSON contenant des détails sur la pièce jointe, notamment contentId, extension, mimeType, name et size.

Exemple 4 : champ personnalisé de type case à cocher

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

Lors de la récupération de la valeur d’un champ personnalisé de type « Case à cocher », la cmdlet renvoie 1 si la case est cochée (vrai) et 0 si elle ne l’est pas (faux). Si aucune valeur n’est sélectionnée, la cmdlet ne renvoie aucun résultat.

Exemple 5 : champ personnalisé de type « Date »

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

Lors de la récupération de la valeur d’un champ personnalisé de type Date, la cmdlet renvoie la valeur de la date sous la forme d’un horodatage Unix représentant le nombre de secondes écoulées depuis le 1er janvier 1970 (UTC).

Exemple 6 : champ personnalisé de type DateTime

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

Lors de la récupération de la valeur d'un champ personnalisé de type DateTime, la cmdlet renvoie la date et l'heure sous la forme d'un horodatage Unix représentant le nombre de secondes écoulées depuis le 1er janvier 1970 (UTC).

Exemple 7 : champ personnalisé de type décimal

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

Lors de la récupération de la valeur d'un champ personnalisé de type décimal, la cmdlet renvoie la valeur décimale sous forme de chaîne de caractères.

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

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

Lors de la récupération de la valeur d’un champ personnalisé de type « Liste déroulante des périphériques », la cmdlet renvoie une chaîne JSON contenant l’identifiant d’entité (entityId) et le type du périphérique sélectionné.

Exemple 9 : champ personnalisé « Device MultiSelect »

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

Lors de la récupération de la valeur d’un champ personnalisé « Device MultiSelect », la cmdlet renvoie une chaîne JSON contenant un tableau d’entityIds représentant les périphériques sélectionnés ainsi que le type de ces périphériques.

Exemple 10 : champ personnalisé de liste déroulante

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

Lors de la récupération de la valeur d’un champ personnalisé de type liste déroulante, la cmdlet renvoie l’identifiant unique (ID) de l’option sélectionnée sous forme de chaîne de caractères. Vous pouvez utiliser Ninja-Property-Options pour récupérer les options valides du champ de liste déroulante et leurs ID correspondants.

Exemple 11 : champ personnalisé « e-mail »

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

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

Exemple 12 : champ personnalisé de type entier

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

Lors de la récupération de la valeur d’un champ personnalisé de type entier, la cmdlet renvoie la valeur entière sous forme de chaîne de caractères.

Exemple 13 : champ personnalisé de type « adresse IP »

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

Lors de la récupération de la valeur d’un champ personnalisé de type « Adresse IP », la cmdlet renvoie l’adresse IP sous forme de chaîne de caractères.

Exemple 14 : champ personnalisé multiligne

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

Lors de la récupération de la valeur d’un champ personnalisé multiligne, la cmdlet renvoie les différentes lignes de texte sous la forme d’un tableau de chaînes de caractères, chaque chaîne du tableau correspondant à une ligne de texte du champ multiligne. S’il n’y a qu’une seule ligne de texte, la cmdlet renvoie une seule chaîne de caractères.

Exemple 15 : champ personnalisé à sélection multiple

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

Lors de la récupération de la valeur d’un champ personnalisé à sélection multiple, la cmdlet renvoie une chaîne de caractères séparée par des virgules contenant les identifiants uniques (ID) des options sélectionnées. Vous pouvez utiliser Ninja -Property-Options pour récupérer les options valides pour le champ à sélection multiple et leurs ID correspondants.

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

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

Lors de la récupération de la valeur d’un champ personnalisé de liste déroulante « Organisation », la cmdlet renvoie une chaîne JSON contenant l’entityId et le type de l’organisation sélectionnée.

Exemple 17 : champ personnalisé « Liste déroulante des sites de l’organisation »

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

Lors de la récupération de la valeur d’un champ personnalisé de type « Menu déroulant de l’emplacement de l’organisation », la cmdlet renvoie une chaîne JSON contenant l’entityId et le type de l’emplacement de l’organisation sélectionné.

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

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

Lors de la récupération de la valeur d’un champ personnalisé « Sélection multiple d’organisations », la cmdlet renvoie une chaîne JSON contenant un tableau d’entityIds représentant les organisations sélectionnées ainsi que le type de ces dernières.

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

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

Lors de la récupération de la valeur d’un champ personnalisé « Emplacement de l’organisation » à sélection multiple, la cmdlet renvoie une chaîne JSON contenant un tableau d’identifiants d’entité (entityIds) représentant les emplacements d’organisation sélectionnés ainsi que le type de ces emplacements.

Exemple 20 : champ personnalisé « Numéro de téléphone »

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

Lors de la récupération de la valeur d’un champ personnalisé « Téléphone », 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:> Ninja-Property-Get -Name "superSecretPassword"
Hunter42

Lors de la récupération de la valeur d’un champ personnalisé sécurisé, la cmdlet renvoie la valeur sécurisée sous forme de chaîne de caractères.

Exemple 22 : champ personnalisé de type « Text »

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

Lors de la récupération de la valeur d'un champ personnalisé de type Texte, la cmdlet renvoie la valeur textuelle sous forme de chaîne de caractères.

Exemple 23 : champ personnalisé de type « Heure »

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

Lors de la récupération de la valeur d’un champ personnalisé de type « Temps », la cmdlet renvoie le nombre de secondes écoulées depuis minuit UTC (pour le jour en cours).

Exemple 24 : champ personnalisé de type URL

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

Lors de la récupération de la valeur d’un champ personnalisé de type URL, la cmdlet renvoie l’URL sous forme de chaîne de caractères.

Exemple 25 : champ personnalisé 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;Indicateurs de performances du système</div>..."}

Lors de la récupération de la valeur d’un champ personnalisé WYSIWYG, la cmdlet renvoie une chaîne JSON contenant le contenu HTML du champ.

Paramètres

-Nom

Spécifiez le nom du champ personnalisé de l’appareil dont vous souhaitez récupérer la valeur.

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

Entrées

System.String

La cmdlet n'accepte pas d'entrée provenant du pipeline. Le paramètre -Name accepte une valeur de type chaîne représentant le nom du champ personnalisé du périphérique dont vous souhaitez récupérer la valeur.

Sorties

System.String[]

La cmdlet renvoie la valeur du champ personnalisé de périphérique spécifié sous forme de chaîne de caractères. Pour les champs personnalisés multilignes, la cmdlet renvoie un tableau de chaînes de caractères, chaque chaîne du tableau correspondant à une ligne de texte du champ multiligne.

Tous les champs liés à la date et à l’heure sont renvoyés dans le fuseau horaire UTC, mais sont affichés dans l’interface utilisateur Web dans le fuseau horaire local du navigateur qui consulte le champ.
L’appareil exécutant cette cmdlet doit disposer des autorisations nécessaires pour afficher le champ personnalisé spécifié afin d’en récupérer la valeur. Pour plus d’informations sur les autorisations relatives aux champs personnalisés, consultez la section « Champs personnalisés NinjaOne : prise en main ».

Ressources supplémentaires

Pour plus d’informations sur la gestion des actifs et les scripts personnalisés, consultez les ressources suivantes :