PowerShell : Ninja-Property-Docs-Clear-Single

Sujet

Cet article explique comment utiliser Ninja-Property-Docs-Clear-Singlepour effacer la valeur d'un champ personnalisé spécifié dans un seul document.

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-Docs-Clear-Single efface la valeur d’un champ personnalisé spécifié dans un seul document. Vous pouvez spécifier le nom du champ à l’aide du paramètre -AttributeName et le document à l’aide du paramètre -TemplateName. La cmdlet supprimera toute valeur existante du champ personnalisé, le réinitialisant ainsi à un état vide.

Seuls les champs disposant de droits d’écriture automatisés peuvent être réinitialisés à l’aide de cette cmdlet. La valeur du champ personnalisé sera effacée après la prochaine synchronisation réussie avec la plateforme NinjaOne, qui a généralement lieu en quelques minutes. L’appareil exécutant cette cmdlet doit être désigné comme délégué de documentation pour le document contenant le champ personnalisé à effacer.

Syntaxe

Ninja-Property-Docs-Clear-Single [[-TemplateName] <Object>] [[- AttributeName] <Object> [<CommonParameters>]

Exemples

Exemple 1 : effacer un champ personnalisé dans un seul document

PS C: Ninja-Property-Docs-Clear-Single -TemplateName "Mon document d'exemple" -AttributeName "exampleAttribute"

Le champ personnalisé spécifié dans le document est effacé après la prochaine synchronisation réussie avec la plateforme NinjaOne, qui a généralement lieu en quelques minutes.

Paramètres

-AttributeName

Spécifiez le nom du champ personnalisé que vous souhaitez effacer dans le document.

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

-NomDuModèle

Spécifiez le nom du modèle de document contenant le champ personnalisé que vous souhaitez effacer.

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

Entrées

System.String

Cette cmdlet n'accepte pas d'entrée provenant du pipeline. Les paramètres -AttributeName et -TemplateName acceptent des valeurs de type chaîne représentant respectivement le nom du champ personnalisé à effacer et le nom du modèle de document.

Sorties

Aucune

L'appareil exécutant cette cmdlet doit être désigné comme délégué de documentation pour le document «
» contenant le champ personnalisé à effacer.
Des autorisations d'écriture d'automatisation sont requises pour effacer toute valeur de champ personnalisé. Pour plus d'informations sur les autorisations relatives aux champs personnalisés, consultez la section « NinjaOne Custom Fields: Getting Started ».
La valeur du champ personnalisé sera effacée après la prochaine synchronisation réussie avec la plateforme d’
NinjaOne, ce qui se produit généralement en quelques minutes.

Ressources supplémentaires

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