PowerShell : Ninja-Property-Docs-Set-Piped

Sujet

Cet article explique comment utiliser Ninja-Property-Docs-Set-Piped pour définir la valeur d'un champ personnalisé spécifié dans un 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 à l’aide du pipeline PowerShell. 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 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 indiqué avec la valeur fournie.

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-Piped [[-TemplateId] <Object>] [[-DocumentName] <Object>] [[-AttributeName] <Object>] [[-Value] <Object>] [<CommonParameters>]

Exemples

Exemple 1 : définition d’un champ personnalisé de 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:> Ninja-Property-Docs-Set-Piped -TemplateId "5" -DocumentName "My
Example Document" -AttributeName "exampleWYSIWYG" -Value $CustomFieldValue

Les commandes Piped permettent de 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 le document « My Example Document ».

Exemple 2 : Prise en charge des pipelines

$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-Piped -TemplateId "5" -
DocumentName "My Example Document" -AttributeName "exampleWYSIWYG"

Le pipeline PowerShell peut être utilisé pour définir la valeur d’un champ personnalisé en transmettant la valeur souhaitée de `
` à la cmdlet `Ninja-Property-Docs-Set-Piped`.

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

-DocumentName

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

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

Spécifiez l’ID du modèle de document contenant le champ personnalisé pour lequel vous souhaitez définir une valeur d’
.

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

Spécifiez la valeur à attribuer au champ personnalisé indiqué.

Type : Objet
Ensembles de paramètres : (Tous)
Alias :
Obligatoire : Faux
Position : 3
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 pour le paramètre -Value, qui représente la valeur à définir pour le champ personnalisé spécifié. Les paramètres -TemplateId, -DocumentName et -AttributeName acceptent des valeurs de type chaîne représentant respectivement l'ID du modèle de document, le nom du 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 :