PowerShell : Ninja-Property-Options

Sujet

Cet article explique comment utiliser Ninja-Property-Options pour récupérer les valeurs valides d'un champ personnalisé de type liste déroulante ou sélection multiple pour un appareil.

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

Environnement

NinjaOne
Microsoft PowerShell

Description

La cmdlet Ninja-Property-Options récupère les valeurs valides d’un champ personnalisé de type liste déroulante ou sélection multiple pour un périphérique. Vous pouvez spécifier le nom du champ personnalisé à l’aide du paramètre -Name. La cmdlet renvoie une liste d’options valides au format <guid>=<name>, où <guid> est l’identifiant unique de l’option et <name> est le nom d’affichage de l’option. Seuls les champs disposant d’autorisations de lecture pour l’automatisation permettent de récupérer leurs options à l’aide de cette cmdlet.

Syntaxe

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

Exemples

Exemple 1 : un champ personnalisé de type liste déroulante

PS C:> Ninja-Property-Options -Name "exampleDropdown"
2a100199-4067-4332-8f4d-451e14b94a76=Mötley Crüe
9eccdedf-aefb-4d4b-92c3-e0fe03c305e2=Valeur 1
cd7ec878-766d-4794-baa2-4328af9f06ce=101010101

Lorsqu'un champ personnalisé de type liste déroulante est spécifié, la cmdlet renvoie les options valides pour ce champ au format <guid>=<name>, où <guid> est l'identifiant unique de l'option et <name> est le nom d'affichage de l'option.

Exemple 2 : un champ personnalisé à sélection multiple

PS C:> Ninja-Property-Options -Name "exampleMultiSelect"
154d90cf-3d4a-4e43-8b79-232ccd5b74a6=Valeur 3
21aa863a-ddf1-4f5c-8811-4e98c45da96b=Mötley Crüe
834d0865-1c70-492b-ac11-73854fd0294d=Option 1

Lorsqu'un champ personnalisé à sélection multiple est spécifié, la cmdlet renvoie les options valides pour ce champ au format <guid>=<nom>, où <guid> est l'identifiant unique de l'option et <nom> est le nom d'affichage de l'option.

Exemple 3 : un champ personnalisé sans options

PS C:> Ninja-Property-Options -Name "exampleTextField"

Lorsqu’un champ personnalisé ne comportant pas d’options, tel qu’un champ de texte, est spécifié, la cmdlet ne renvoie aucun résultat.

Paramètres

-Name

Spécifie le nom du champ personnalisé pour lequel vous souhaitez récupérer les options valides.

Type : Objet
Ensembles 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é pour lequel vous souhaitez récupérer les options valides.

Sorties

System.String[]

La cmdlet renvoie les options valides pour le champ personnalisé spécifié au format <guid>= <name> sous forme de chaîne de caractères ou de tableau de chaînes de caractères si plusieurs options sont disponibles.

Cette cmdlet s'applique uniquement aux champs personnalisés de type liste déroulante et sélection multiple. Si un autre type de champ personnalisé est spécifié, aucune sortie ne sera renvoyée.
Seuls les champs disposant d’autorisations de lecture pour l’automatisation permettent de récupérer leurs options à l’aide de cette cmdlet. Pour plus d’informations sur les autorisations relatives aux champs personnalisés, consultez la documentation « NinjaOne Custom Fields : Getting Started ».

Ressources supplémentaires

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