PowerShell : Set-NinjaTag

Sujet

Cet article explique comment utiliser Set-NinjaTag pour attribuer une balise système spécifique à l'appareil actuel.

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 Set-NinjaTag attribue une ou plusieurs balises système spécifiées à l'appareil actuel. Les balises système sont des balises prédéfinies dans la plateforme NinjaOne qui peuvent être utilisées pour classer et gérer les appareils. La cmdlet ajoute la ou les balises spécifiées à l'appareil actuel sans affecter les balises existantes.

Cette cmdlet doit être exécutée dans un script d’automatisation Ninja pour modifier les balises système attribuées. Les modifications apportées à l’attribution des balises sont appliquées après la prochaine synchronisation réussie avec la plateforme NinjaOne, qui a généralement lieu en quelques minutes.

Syntaxe

Set-NinjaTag [-Name] <String[]> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

Exemples

Exemple 1 : attribution à partir d’un script d’automatisation

PS C:> Set-NinjaTag -Name "IIS"

Attribue la balise système « IIS » au périphérique actuel.

Exemple 2 : attribution à partir d’un terminal actif

PS C:> Set-NinjaTag -Name "IIS"
Set-NinjaTag : L'accès aux balises n'est possible qu'à partir d'un script d'automatisation
À la ligne : 1, caractère : 1
+ Set-NinjaTag -Name "IIS"
+ ~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : FromStdErr: (:) [Write-Error],
WriteErrorException
+ FullyQualifiedErrorId :
Microsoft.PowerShell.Commands.WriteErrorException,Set-NinjaTag

Les balises ne peuvent être définies qu’à partir d’un script d’automatisation ; par conséquent, un message d’erreur est renvoyé lorsque l’on tente d’exécuter la cmdlet dans une session de terminal active.

Paramètres

-Confirm

Demande une confirmation avant d'exécuter la cmdlet.

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

-Force

Si le paramètre « confirm » n'est pas spécifié et que la cmdlet demanderait une confirmation, ce paramètre force la cmdlet à s'exécuter sans demander de confirmation.

Type : SwitchParameter
Ensembles de paramètres : (Tous)
Alias :
Obligatoire : Faux
Position : Nommé
Valeur par défaut : Aucune
Accepte l'entrée du pipeline : Faux
Accepte les caractères génériques : Faux

-Name

Spécifie le nom de la ou des balises système à attribuer au périphérique actuel.

Type : String[]
Jeux de paramètres : (Tous)
Alias :
Obligatoire : True
Position : 0
Valeur par défaut : Aucune
Accepte l'entrée du pipeline : True (ByValue)
Accepte les caractères génériques : False

-WhatIf

Affiche ce qui se passerait si la cmdlet était exécutée. La cmdlet n’est pas exécutée.

Type : SwitchParameter
Ensembles de paramètres : (Tous)
Alias : wi
Obligatoire : Faux
Position : Nommée
Valeur par défaut : Aucune
Accepte les entrées de pipeline : Faux
Accepte les caractères génériques : Faux

Paramètres communs

Cette applet de commande prend en charge les paramètres communs suivants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction et -WarningVariable. Pour plus d'informations sur les paramètres communs, consultez le document Microsoft about_CommonParameters ( lien externe).

Entrées

System.String[]

La cmdlet accepte un tableau de chaînes de caractères représentant le ou les noms des balises système à attribuer au périphérique actuel.

Sorties

Aucune

Cette cmdlet doit être exécutée dans un script d'automatisation Ninja pour modifier les balises système attribuées.
Les modifications d’attribution des balises sont appliquées après la prochaine synchronisation réussie avec la plateforme NinjaOne, qui a généralement lieu en quelques minutes.

Ressources supplémentaires

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