PowerShell : Ninja-Property-Docs-Définir-Single-Piped

Sujet

Cet article explique comment utiliser Ninja-Property-Docs-Set-Single-Piped pour définir la valeur d'un champ personnalisé spécifié dans un seul document à l'aide du pipeline PowerShell.

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

Cette cmdlet définit la valeur d’un champ personnalisé spécifié dans un document unique à l’aide du pipeline PowerShell. Vous pouvez spécifier le nom du champ à l’aide du paramètre -AttributeName et le modèle de document à l’aide du paramètre TemplateName. La valeur peut être fournie via le pipeline ou à l’aide du paramètre -Value. La cmdlet met à jour la valeur du champ personnalisé spécifié dans le document unique associé au modèle spécifié avec la valeur fournie.

Seuls les champs disposant de droits d’écriture automatisés 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-Piped [[-TemplateName] <Object>] [[- AttributeName] <Object>] [[-Value] <Object>] [<CommonParameters>]

Exemple

Définition d’un champ personnalisé comportant 199 999 caractères

$alphabet = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMOPQRSTUVWXYZ1234567890"
$DesiredValue = New-Object System.Collections.Generic.List
for($i = 0; $i -lt 199999; $i++){
$DesiredValue.Add("$($alphabet[(Get-Random -Maximum
$alphabet.Length)])")
}
$CustomFieldValue = "$($DesiredValue -join '')"
PS C:> $CustomFieldValue | Ninja-Property-Docs-Set-Single-Piped -
TemplateName "My Example Document" -AttributeName "exampleWYSIWYG"

Les commandes en pipeline peuvent être utilisées pour définir la valeur d’un champ personnalisé sur une longue chaîne de caractères, par exemple 199 999 caractères, ce qui correspond à la longueur maximale autorisée pour un champ personnalisé WYSIWYG. Dans cet exemple, une chaîne aléatoire de 199 999 caractères est générée et définie comme valeur du champ personnalisé exampleWYSIWYG dans « My Example Document ».

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
Accepte les entrées de pipeline : Faux
Accepte les caractères génériques : Faux

-TemplateName

Indiquez le nom du modèle de document dans lequel vous souhaitez définir la valeur d'
u du champ personnalisé spécifié.

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

-Value

Définissez la valeur à attribuer au champ personnalisé spécifié.

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

Entrées

System.String

La cmdlet accepte une entrée de type chaîne provenant du pipeline, qui est utilisée comme valeur à attribuer au champ personnalisé spécifié. Les paramètres -TemplateName et -AttributeName acceptent des valeurs de type chaîne représentant respectivement le nom du modèle de document et le nom du champ personnalisé pour lesquels vous souhaitez définir une valeur.

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 « NinjaOne Custom Fields : Getting Started ».
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 :