PowerShell : Ninja-Property-Docs-Set

Sujet

Cet article explique comment utiliser Ninja-Property-Docs-Setpour définir 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 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 définit 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, le modèle de document à l’aide du paramètre -TemplateId 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 associé au modèle indiqué.

Seuls les champs disposant d’autorisations d’écriture automatisées 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 [[-TemplateId] <Object>] [[-DocumentName] <Object>] [[-AttributeName] <Object>] [[-AttributeValue] <Object>] [<CommonParameters>]

Exemple

Définition de la valeur d’un champ personnalisé de type texte dans un document

PS C:> Ninja-Property-Docs-Set -TemplateId "12345" -DocumentName "Mon
document d'exemple" -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 avec la plateforme NinjaOne, qui a généralement lieu 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 : 2
Valeur par défaut : Aucune
Accepte les entrées de pipeline : Faux
Accepte 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 : 3
Valeur par défaut : Aucune
Accepte les entrées du pipeline : Faux
Accepte les caractères génériques : Faux

-DocumentName

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

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

-TemplateId

Définissez l’ID du modèle de document associé au document 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

System.String

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

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é à mettre à jour.
Seuls les champs disposant d’autorisations d’écriture automatisées peuvent être mis à jour à l’aide de cette cmdlet. Pour plus d’informations sur les autorisations relatives aux champs personnalisés, consultez la section « Champs personnalisés NinjaOne : prise en main ».
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 supplémentaires

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