PowerShell : Ninja-Property-Docs-Clear

Rubrique

Cet article explique comment utiliser Ninja-Property-Docs-Clear pour effacer la valeur d'un champ personnalisé spécifié dans un 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 efface la valeur d’un champ personnalisé spécifié dans un document. Vous pouvez spécifier le nom du champ à l’aide du paramètre -AttributeName, le document à l’aide du paramètre -DocumentName et le modèle de document à l’aide du paramètre -TemplateId. La cmdlet supprimera toute valeur existante du champ personnalisé, le réinitialisant ainsi à un état vide.

Seuls les champs disposant d’autorisations d’écriture par automatisation 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, ce qui se produit généralement en quelques minutes. L’appareil exécutant cette cmdlet doit être désigné, en tant que délégué de documentation (
), pour le document contenant le champ personnalisé à effacer.

Syntaxe

Ninja-Property-Docs-Effacer [[-TemplateId] <OBJECT>] [[-DocumentName] <OBJECT>] [[-AttributeName] <OBJECT>] [<COMMONPARAMETERS>]

Le champ de texte est effacé après la prochaine synchronisation réussie avec la plateforme NinjaOne, qui a généralement lieu en quelques minutes.

Exemples

Exemple 1 : effacer un champ personnalisé dans un document

PS C:> Ninja-Property-Docs-Clear -TemplateId "12345" -DocumentName "My
Example Document" -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 : 2
Valeur par défaut : Aucune
Accepte les entrées de pipeline : Faux
Accepte les caractères génériques : Faux

-DocumentName

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

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

-TemplateId

Spécifiez l’ID du modèle de document contenant le document et le champ personnalisé que vous souhaitez effacer à l’aide de l
.

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, -DocumentName et -TemplateId acceptent des valeurs de type chaîne représentant respectivement le nom du champ personnalisé à effacer, le nom du document et l'ID du modèle de document.

Sorties

Le Système.Object

L'appareil exécutant cette cmdlet doit être attribué 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 du champ personnalisé. Pour plus d'informations sur les autorisations relatives aux champs personnalisés, consultez la section « Champs personnalisés NinjaOne : prise en main ».
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.

Ressources complémentaires

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