PowerShell : Ninja-Property-Docs-Set-Single

Rubrique

Cet article explique comment utiliser Ninja-Property-Docs-Set-Single pour définir 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 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-Docs-Set-Single définit la valeur d’un champ personnalisé spécifié dans un document unique. Vous pouvez spécifier le nom du champ à l’aide du paramètre -AttributeName, le modèle de document à l’aide du paramètre -TemplateName et la valeur à définir à l’aide du paramètre -AttributeValue. La cmdlet met à jour la valeur du champ personnalisé spécifié dans le document unique associé au modèle indiqué.

Seuls les champs disposant de droits d’écriture par automatisation peuvent être mis à jour à l’aide de cette cmdlet. L’appareil exécutant cette cmdlet doit être désigné comme délégué de documentation pour le document contenant le champ personnalisé à mettre à jour. Le champ personnalisé spécifié dans le document est mis à jour après la prochaine synchronisation réussie avec la plateforme NinjaOne, qui a généralement lieu en quelques minutes.

Syntaxe

Ninja-Property-Docs-Set-Single [[-TemplateName] <OBJECT>] [[-AttributeName] <OBJECT>] [[-AttributeValue] <OBJECT>] [<COMMONPARAMETERS>]

Exemple

Définition de la valeur du champ personnalisé dans un document unique

PS C:> Ninja-Property-Docs-Set-Single -TemplateName "My Example Document" -
AttributeName "exampleTextField" -AttributeValue "Nouvelle valeur"

Le champ personnalisé spécifié dans le document est mis à jour avec la valeur « Nouvelle valeur » après la prochaine synchronisation réussie d'
avec la plateforme NinjaOne, ce qui se produit généralement en quelques minutes.

Paramètres

-AttributeName

Spécifiez le nom du champ personnalisé pour lequel vous souhaitez définir une valeur.

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

-AttributeValue

Définissez la valeur que vous souhaitez attribuer au champ personnalisé spécifié. La valeur fournie doit être compatible avec le type du champ personnalisé mis à jour (par exemple, texte, liste déroulante, sélection multiple)

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

-TemplateName

Saisissez le nom du modèle de document associé au document unique contenant le champ personnalisé que vous souhaitez définir.

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

Le Système.String

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

Sorties

Aucun

L'appareil exécutant cette cmdlet doit être attribué comme délégué de documentation pour le document
contenant le champ personnalisé à mettre à jour.
Seuls les champs disposant de droits d’écriture automatisés peuvent être mis à jour à l’aide de cette cmdlet. Pour plus d’informations sur les autorisations relatives aux champs personnalisés, consultez la section « NinjaOne Custom Fields: Premiers pas ».
Le champ personnalisé spécifié dans le document est mis à jour 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 :