Scripts pour les tâches scriptées
Introduction
Cette page vous permet de gérer les scripts que vous pouvez automatiser ou exécuter sur vos agents WEM. Les scripts sont organisés dans les catégories suivantes :
-
Scripts prêts à l'emploi pour les besoins courants d'administration et de dépannage des VDA.
-
Scripts personnalisésScripts créés par l'administrateur pour l'automatisation spécifique à l'environnement et les exigences opérationnelles.
Remarque :
Pour configurer des tâches automatisées à partir d'un script, accédez à Tâches scriptées dans un jeu de configuration.
Ajouter un script personnalisé
La page Tâches scriptées répertorie tous les scripts intégrés et tous les scripts personnalisés créés par vous ou d'autres administrateurs. Vous pouvez ajouter des scripts personnalisés supplémentaires selon vos besoins pour répondre à vos exigences.
Avant de commencer
Avant de créer un script personnalisé dans la console web WEM :
-
Créer le contenu du scriptÉcrivez un script PowerShell en fonction de vos besoins.
-
Valider le contenu du scriptUtilisez l'outil Citrix Environment Tool Hub > Scripted Task Validator pour exécuter le script et examiner les résultats de l'exécution. Si nécessaire, vous pouvez exporter le script pour l'importer ultérieurement dans la console Web WEM.Pour plus d'informations, consultez Valider et exporter une tâche scriptée.
Flux de travail
Pour ajouter un script personnalisé, procédez comme suit :
-
Sur la page Tâches scriptées, cliquez sur l'onglet Personnalisé, puis sur Ajouter un script personnalisé.
-
Dans l'assistant Ajouter un script personnalisé, configurez les paramètres suivants, puis cliquez sur Enregistrer.
-
Nom du script. Spécifiez un nom pour le script.
-
Description. Vous pouvez éventuellement spécifier des informations supplémentaires pour vous aider à identifier le script.
-
Étendue (facultatif). Spécifiez l'étendue à laquelle ce script appartient. Seuls les administrateurs autorisés pour cette étendue peuvent accéder à ce script. Si vous ne spécifiez pas d'étendue, seuls les administrateurs WEM complets peuvent accéder à ce script.
-
Balises. Sélectionnez parmi les balises existantes ou saisissez des balises séparées par des virgules. Une balise ne doit pas dépasser 20 caractères. Les balises sont comme des mots-clés ou des étiquettes. L'utilisation de balises vous permet d'identifier vos scripts de nouvelles manières. Elles agissent également comme des filtres, vous permettant de réorganiser votre affichage des scripts en fonction de critères importants pour vous. Vous pouvez utiliser autant de balises que vous le souhaitez.
-
Type de fichier. Sélectionnez un type de fichier pour le script. Deux types de fichiers sont pris en charge :
-
PowerShell. Fichiers de script PowerShell individuels.
-
ZIP. Plusieurs fichiers regroupés dans un seul fichier zip. Les fichiers zip de plus de 10 Mo ne sont pas pris en charge. Après avoir téléchargé un fichier zip, spécifiez un point d'entrée, indiquant quel fichier exécuter au début du script. Gardez à l'esprit que le fichier de point d'entrée ne doit pas être à plus de trois niveaux de profondeur dans la structure des dossiers.
-
-
Télécharger le fichier. Cliquez sur Parcourir, accédez au fichier, sélectionnez-le, puis cliquez sur Ouvrir. Vous êtes redirigé vers l'assistant Ajouter un script personnalisé.Conseil :Vous pouvez charger un script de deux manières :
-
Sélectionnez un fichier .zip que vous avez déjà placé sur la machine de la console Web.
-
Après avoir exporté un script avec l'outil Scripted Task Validator, le contenu est automatiquement copié dans votre presse-papiers. Sur la page Ajouter un script personnalisé, collez le contenu directement depuis le presse-papiers (<Ctrl+V>). Cette méthode évite de devoir stocker un fichier .zip sur la machine de la console Web.
-
-
Accorder des autorisations. Spécifiez le niveau d'accès que vous souhaitez accorder au script. Assurez-vous de comprendre les autorisations associées à chaque option.
-
Accès complet. Un script auquel est attribué un accès complet dispose d'un accès local étendu. S'il est sélectionné, le script se voit accorder des autorisations comme s'il s'exécutait sous le compte système local.
-
Accès limité (avec accès réseau). Un script auquel est attribué un accès limité (avec accès réseau) n'a pas d'accès local étendu mais peut accéder aux ressources réseau. S'il est sélectionné, le script se voit accorder des autorisations comme s'il s'exécutait sous le compte de service réseau.
-
Accès limité (sans accès réseau). Un script auquel est attribué un accès limité (sans accès réseau) n'a pas d'accès local étendu et ne peut pas accéder aux ressources réseau. S'il est sélectionné, le script se voit accorder des autorisations comme s'il s'exécutait sous le compte de service local.
-
Exécuter en tant qu'utilisateur connecté. S'il est sélectionné, le script s'exécute dans le contexte de la session d'un utilisateur connecté et se voit accorder les mêmes autorisations, que la session utilisateur soit active ou déconnectée.
Pour plus d'informations, consultez la documentation Microsoft<https://docs.microsoft.com/fr-fr/windows/security/identity-protection/access-control/security-identifiers#well-known-sids>. -
-
Dossier de travail. Vous pouvez éventuellement saisir le chemin absolu du dossier local sur le système d'exploitation de l'utilisateur final. Le dossier de travail est le dossier actuel du fichier lorsqu'il démarre. Vous pouvez construire le chemin avec des variables d'environnement (par exemple, %ProgramFiles%). S'il n'est pas spécifié,
PSScriptRootest utilisé comme dossier de travail par défaut. Pour plus d'informations surPSScriptRoot, consultez la documentation Microsoft<https://docs.microsoft.com/fr-fr/powershell/module/microsoft.powershell.core/about/about_automatic_variables?view=powershell-7.1>. -
Cette tâche génère-t-elle des fichiers de sortie. Choisissez si le script que vous ajoutez génère des fichiers de sortie.
-
Chemin de sortie. Saisissez un chemin relatif au dossier où se trouve le fichier. Le chemin doit contenir le nom du fichier et son extension. Exemple :
output\report.txt.
-
Gérer les scripts
Vous pouvez gérer les scripts pour répondre à vos besoins. Les actions disponibles incluent :
Modifier un script
Pour modifier un script, procédez comme suit :
-
Sur la page Tâches scriptées, recherchez le script. Utilisez la zone de recherche ou les balises pour le trouver rapidement si nécessaire.
-
Cliquez sur les points de suspension du script, puis sélectionnez Modifier le script. L'assistant Modifier le script s'affiche.
-
Dans l'onglet Informations sur la tâche, configurez les paramètres selon vos besoins.
-
Dans l'onglet Fichier de script, affichez le contenu du script.
-
Cliquez sur Enregistrer.
Remarque :
Vous ne pouvez pas modifier les scripts intégrés.
Supprimer un script
Pour supprimer un script, procédez comme suit :
-
Sur la page Tâches scriptées, recherchez le script. Utilisez la zone de recherche ou les balises pour le trouver rapidement si nécessaire.
-
Cliquez sur les points de suspension du script, puis sélectionnez Supprimer le script.
Important :
Vous ne pouvez pas supprimer les scripts intégrés.
Cloner un script
Pour cloner un script, procédez comme suit :
-
Sur la page Tâches scriptées, recherchez le script. Utilisez la zone de recherche ou les balises pour le trouver rapidement si nécessaire.
-
Cliquez sur les points de suspension du script, puis sélectionnez Cloner le script.
Remarque :
Lorsque vous clonez un script, vous êtes invité à modifier le nom pour éviter les doublons.
Configurer les tâches scriptées
Pour configurer et automatiser les tâches scriptées, procédez comme suit :
-
Sur la page Tâches scriptées, recherchez le script. Utilisez la zone de recherche ou les balises pour le trouver rapidement si nécessaire.
-
Cliquez sur les points de suspension du script, puis sélectionnez Configurer les tâches.
-
Dans l'assistant Sélectionner l'ensemble de configuration, choisissez l'ensemble de configuration où vous souhaitez créer la tâche.
-
Suivez les étapes décrites dans Créer une tâche scriptée pour terminer la configuration.
Créer une tâche externe à partir d'un script
Utilisez cette action pour créer une tâche externe directement à partir d'un script existant.
Conseil :
Les tâches scriptées fonctionnent au niveau de la machine. Pour exécuter des tâches au niveau de la session utilisateur, créez plutôt des tâches externes.
Pour créer une tâche externe à partir d'un script, procédez comme suit :
-
Sur la page Tâches scriptées, localisez le script. Utilisez la zone de recherche ou les balises pour le trouver rapidement si nécessaire.
-
Cliquez sur les points de suspension du script, puis sélectionnez Créer une tâche externe.
-
Dans l'assistant Sélectionner l'ensemble de configuration, choisissez l'ensemble de configuration où vous souhaitez créer la tâche.
-
Suivez les étapes décrites dans Créer une tâche externe pour terminer la configuration.
Scripts intégrés
Actuellement, nous fournissons les scripts intégrés suivants que vous pouvez utiliser :
Vérification de l'état du cloud
Permet d'exécuter des vérifications qui évaluent l'état des Virtual Delivery Agents (VDA). Les vérifications de l'état des VDA identifient les causes possibles des problèmes courants d'enregistrement des VDA et de lancement de session. La vérification de l'état du cloud s'exécute sous le compte système local sur l'hôte de l'agent.
Gestion des services Windows
La gestion des services Windows offre des fonctionnalités fréquemment utilisées concernant les services Windows, telles que le démarrage, l'arrêt, le redémarrage, la configuration d'un ou plusieurs services Windows.
Redémarrer le service Windows
Ce script vérifie l'état d'un service Windows. Si le service n'est pas en cours d'exécution et que le paramètre
ForceStart est spécifié, le script démarre le service. Indépendamment de l'état actuel, si le service est en cours d'exécution et ne nécessite pas de démarrage forcé, il est redémarré pour s'assurer qu'il fonctionne avec la dernière configuration ou pour récupérer d'un état bloqué.
Paramètres
| nom | Type | par défaut | obligatoire | Remarque |
|---|---|---|---|---|
ServiceNames |
chaîne | BrokerAgent | Faux | Spécifie les noms des services à gérer. S'il n'est pas fourni, la valeur par défaut est BrokerAgent. Si vous devez saisir plus d'un service, séparez les noms de service par une virgule. Tous les espaces seront supprimés. Par exemple, ServiceA, ServiceB. |
ForceStart |
booléen | vrai | Faux | Indique s'il faut démarrer le service s'il est détecté comme étant arrêté. Cela n'affecte pas les services en cours d'exécution. Les services en cours d'exécution sont toujours redémarrés à des fins de maintenance ou de récupération. |
Arrêter le service Windows
Ce script arrête une liste de services Windows spécifiés. Le script vérifie si chaque service est installé et tente d'arrêter le service de force. Le script vérifie ensuite si le service s'est arrêté avec succès et signale l'état.
Paramètres
| nom | Type | par défaut | obligatoire | Remarque |
|---|---|---|---|---|
ServiceNames |
chaîne | BrokerAgent | Faux | Spécifie les noms des services à gérer. S'il n'est pas fourni, la valeur par défaut est BrokerAgent. Si vous devez saisir plusieurs services, séparez les noms de service par une virgule. Tous les espaces seront supprimés. Par exemple, ServiceA, ServiceB. |
Configurer le service Windows
Ce script ajuste les configurations des services Windows, y compris le type de démarrage et les actions de récupération.
Paramètres
| nom | Catégorie | par défaut | obligatoire | Remarque |
|---|---|---|---|---|
ServiceNames |
chaîne | BrokerAgent | Faux | Spécifie les noms des services à gérer. S'il n'est pas fourni, la valeur par défaut est BrokerAgent. Si vous devez saisir plusieurs services, séparez les noms de service par une virgule. Tous les espaces seront supprimés. Par exemple, ServiceA, ServiceB. |
StartupType |
chaîne | nul | Faux | Définit le type de démarrage du service. Les options valides sont Automatique, Manuel ou Désactivé. |
FirstFailureAction |
chaîne | nul | Faux | Définit l'action pour la première défaillance. Par exemple, redémarrer/aucune. |
SecondFailureAction |
chaîne | nul | Faux | Définit l'action pour la deuxième défaillance consécutive. |
SubsequentFailureAction |
chaîne | Nul | Faux | Définit l'action pour toutes les défaillances ultérieures après la deuxième. |
Redémarrage du serveur
Redémarrer la machine
Ce script redémarre la machine locale avec un délai et une option de forçage facultatifs.
Paramètres
| nom | Type | par défaut | obligatoire | Remarque |
|---|---|---|---|---|
Force |
booléen | vrai | Faux | Si spécifié, force un redémarrage immédiat, en ignorant toutes les données non enregistrées ou les sessions utilisateur actives. |
Delay |
entier | 10 | Faux | Spécifie le délai en secondes avant le redémarrage de l'ordinateur. Doit être compris entre 3 et 30 secondes. La valeur par défaut est 10 secondes. |
Gestion du traçage CDF
Démarrer le traçage CDF
Ce script démarre le processus de traçage CDF en utilisant soit un seul fichier CTL, soit une catégorie de fichiers CTL prédéfinie comme entrée. Il trace les modules définis dans les fichiers CTL sélectionnés et s'arrête automatiquement
cdfcontrol.exe après la durée spécifiée par le paramètre RunMinutes.
Paramètres
| Nom | Type | Par défaut | Obligatoire | Remarque |
|---|---|---|---|---|
traceOutputPath |
chaîne | C:\ProgramData\Citrix\WEM\CDFLogs |
Faux | Spécifie le chemin de sortie des rapports CDF. |
category |
chaîne | all |
Faux |
Spécifie les catégories prédéfinies avec lesquelles démarrer la trace. Les valeurs prises en charge sont
|
ctlFilePath |
chaîne | N/A | Faux | Spécifie le fichier ctl avec lequel démarrer la trace. |
RunMinutes |
Entier | 30 | Faux | Spécifie la durée d'exécution de cdfcontrol.exe avant qu'il ne s'arrête et se ferme automatiquement. |
Arrêter le traçage CDF
Ce script arrête le traçage de l'outil CDF.
Nettoyage des journaux CDF
Il est utile de nettoyer les journaux de traçage CDF pour économiser l'espace de stockage. Il devrait fournir une fonction pour supprimer les fichiers CDF dans le répertoire donné.
| nom | Type | par défaut | obligatoire | Remarque |
|---|---|---|---|---|
FileAgeDays |
entier | 3 | Faux | Spécifie le seuil d'âge en jours. Les fichiers et dossiers plus anciens que cette valeur sont supprimés. La valeur par défaut est de 3 jours et ce paramètre est facultatif. Tous les fichiers ou répertoires sont supprimés si le FileAgeDays est inférieur à 1 jour. |
Collecter les journaux d'échec Citrix AOT
Ce script est un outil d'automatisation complet conçu pour la collecte et le traitement des journaux Citrix AOT. Il s'intègre à Citrix CDFControl pour configurer la collecte de traces, appliquer un filtrage (par défaut :
Level=1, Class=Failure) et convertir les fichiers ETL (Event Trace Log) en un format CSV lisible pour l'analyse.
| Nom | Type | Par défaut | Obligatoire | Remarque |
|---|---|---|---|---|
StartTime |
[DateTime] |
EndTime - 30 minutes |
Faux | Spécifie l'heure de début du filtrage des journaux |
EndTime |
[DateTime] |
Date et heure actuelles | Faux | Spécifie l'heure de fin du filtrage des journaux |
Vérifier les paramètres DNS
Ce script est un outil complet de vérification de l'état du DNS conçu pour les environnements Citrix VDA. Il valide la configuration DNS et effectue un dépannage pour identifier les problèmes potentiels liés au DNS qui pourraient affecter les services Citrix.
| Nom | Type | Par défaut | Obligatoire | Remarque |
|---|---|---|---|---|
DomainName |
[string] |
Non applicable | Faux | Spécifie le nom de domaine pour tester la résolution DNS (active le test de résolution de nom DNS) |
FlushDNS |
[switch] |
Faux | Faux | Spécifie s'il faut vider le cache DNS en tant qu'action autonome |
Vérifier la licence RDS
Ce script est un outil complet de validation de licence des services Bureau à distance (RDS) conçu pour vérifier la configuration et l'état des licences RDS sur les ordinateurs locaux. Il est particulièrement utile dans les environnements Citrix VDA, où la conformité des licences RDS est essentielle pour un fonctionnement correct. Utilisez ce script pour garantir la conformité des licences et maintenir un accès utilisateur multi-session ininterrompu.
| Nom | Type | Par défaut | Obligatoire | Remarque |
|---|---|---|---|---|
DomainName |
[string] |
Non applicable | Faux | Spécifie le nom de domaine pour tester la résolution DNS (active le test de résolution de nom DNS) |
FlushDNS |
[switch] |
Faux | Faux | Spécifie s'il faut vider le cache DNS en tant qu'action autonome |
Diagnostiquer la désinscription du VDA
Ce script est un outil de diagnostic complet conçu pour résoudre les problèmes de désinscription des agents de livraison virtuels (VDA) Citrix. Il effectue plusieurs contrôles de santé et procédures de diagnostic pour identifier les causes potentielles des problèmes de désinscription des VDA dans les environnements Citrix.
| Nom | Type | Par défaut | Obligatoire | Remarque |
|---|---|---|---|---|
StartTime |
[DateTime] |
EndTime - 30 minutes |
Faux | Spécifie l'heure de début du filtrage des journaux |
EndTime |
[DateTime] |
Date et heure actuelles | Faux | Spécifie l'heure de fin du filtrage des journaux |
Exécuter le contrôle d'intégrité de Profile Management
Ce script effectue un contrôle d'intégrité complet de votre déploiement Citrix Profile Management. Il analyse les configurations à la recherche de problèmes potentiels et analyse les journaux pour détecter les problèmes critiques, tels que les erreurs de profil temporaire et les écarts de temps importants lors des ouvertures de session.
| Nom | Type | Par défaut | Obligatoire | Remarque |
|---|---|---|---|---|
CtxSessionKey |
[string] | Nul | False | Spécifie la clé de session Citrix utilisée pour rechercher des journaux de session spécifiques. Si elle n'est pas spécifiée, le script analyse les sessions des dernières 24 heures. |
LogonTime |
[string] | Nul | Faux | Spécifie l'heure de connexion pour filtrer les recherches de journaux d'événements. Accepte différents formats de date et d'heure. S'il n'est pas spécifié, le script filtre les journaux d'événements des dernières 24 heures. |
StructuredOutputOnly |
[switch] | Vrai | Faux | Spécifie s'il faut générer des données JSON structurées sans journalisation de la console. |
Parallel |
[switch] | Vrai | Faux | Spécifie s'il faut utiliser le traitement parallèle pour les opérations d'analyse des journaux afin d'améliorer les performances. |
Définir le déclencheur de réinitialisation de profil
Ce script définit un déclencheur pour réinitialiser le profil d'un utilisateur. Lors de la prochaine connexion de l'utilisateur, le profil existant est sauvegardé et un nouveau dossier de profil propre est créé.
| Nom | Type | Par défaut | Obligatoire | Remarque |
|---|---|---|---|---|
CtxSessionKey |
[string] | Nul | Vrai | Spécifie la clé de session Citrix utilisée pour déclencher une réinitialisation de profil lors de la prochaine ouverture de session de l'utilisateur. |
FoldersToRestore |
[string] | Nul | Faux | Spécifie les dossiers à restaurer après une réinitialisation de profil. Si non spécifié, les dossiers connus tels que Téléchargements, Bureau et Images sont restaurés par défaut. |
BackupNameSuffix |
[string] | Nul | Faux | Spécifie le suffixe du nom du dossier de sauvegarde lors d'une réinitialisation de profil. S'il n'est pas spécifié, le suffixe est par défaut upm_%CurrentTimeStamp%. |
Diagnostiquer les problèmes Citrix AOT
Ce script valide la configuration de Citrix Always On Tracing (AOT), diagnostique les problèmes courants et génère un rapport de diagnostic AOT pour faciliter le dépannage. La définition du paramètre
StructuredOutputOnly sur true affiche les résultats dans une vue d'interface utilisateur structurée pour un examen plus facile.
| Nom | Type | Par défaut | Obligatoire | Remarque |
|---|---|---|---|---|
StructuredOutputOnly |
[boolean] | faux | Faux | Si spécifié, le script génère uniquement le rapport de diagnostic JSON brut au lieu du texte formaté lisible par l'homme. |
Collecter les journaux de diagnostic Citrix
Ce script collecte les journaux Citrix Always On Tracing (AOT) et les journaux d'événements Windows du VDA et les enregistre sous forme de fichier ZIP horodaté.
| Nom | Type | Par défaut | Obligatoire | Remarque |
|---|---|---|---|---|
LogType |
[string] | Non applicable | Faux | Contrôle les journaux à collecter. AOTLog collecte uniquement les fichiers AOT ETL, EventLog collecte uniquement les journaux d'événements Windows. Laissez vide pour collecter les deux. |
RestartTelemetryService |
[boolean] | Vrai | Faux | Indique s'il faut arrêter et redémarrer CitrixTelemetryService avant de collecter les journaux AOT, ce qui libère les verrous de fichiers sur les fichiers ETL. Accepte true ou false. La valeur par défaut est true. |
StartTime |
[DateTime] | Il y a 24 heures | Faux | Spécifie l'heure de début de la collecte des journaux. La valeur par défaut est il y a 24 heures. Exemple : 2025-08-01 10:57:15 |
EndTime |
[DateTime] | Heure actuelle | Faux | Spécifie l'heure de fin de la collecte des journaux. La valeur par défaut est l'heure actuelle. Doit être postérieure à StartTime. Exemple : 2025-08-14 11:57:15 |
OutputPath |
[string] | C:\ProgramData\Citrix\WEM\CitrixLogs |
Faux | Répertoire où écrire le fichier zip de sortie. Par défaut, C:\ProgramData\Citrix\WEM\CitrixLogs. |
Collecter les journaux d'événements Windows
Ce script collecte les journaux d'événements Windows de l'agent de livraison virtuel (VDA) et les enregistre sous forme de fichier ZIP horodaté.
| Nom | Type | Par défaut | Obligatoire | Remarque |
|---|---|---|---|---|
LogChannelPrefixes |
[string] | Non applicable | Faux | Préfixes séparés par des virgules à faire correspondre aux noms de canaux ETW. Si fourni, remplace la collecte par défaut des quatre journaux. Exemple : Citrix-HostCore,Microsoft-Windows-AppLocker. |
ProviderPrefixes |
[string] | Non applicable | Faux | Préfixes séparés par des virgules pour correspondre aux noms de fournisseurs/sources d'événements. Le script découvre automatiquement les canaux de journalisation vers lesquels chaque fournisseur écrit via ses LogLinks, il fonctionne donc avec les journaux classiques (Application, Système) et les canaux ETW personnalisés. Lorsqu'il est fourni, il remplace la collecte par défaut des quatre journaux. Exemple : WEM Agent Service,Norskale Agent Service. |
StartTime |
[DateTime] | Il y a 24 heures | Faux | Spécifie l'heure de début de la collecte des journaux d'événements. Par défaut, il y a 24 heures. Exemple : 2025-08-01 10:57:15 |
EndTime |
[DateTime] | Heure actuelle | Faux | Spécifie l'heure de fin de la collecte des journaux d'événements. Par défaut, l'heure actuelle. Doit être postérieure à StartTime. Exemple : 2025-08-14 11:57:15 |
OutputPath |
[string] | C:\ProgramData\Citrix\WEM\CitrixEventLogs |
Faux | Répertoire où écrire le fichier zip de sortie. Par défaut, C:\ProgramData\Citrix\WEM\CitrixEventLogs. |
Collecter les diagnostics Citrix Scout
Ce script exécute ScoutCLI.exe pour collecter les données de diagnostic Citrix à partir du VDA et enregistre la sortie sous forme de fichier ZIP horodaté. Vous pouvez éventuellement exclure des collecteurs spécifiques, tels que MSI ou localdata.
| Nom | Type | Par défaut | Obligatoire | Remarque |
|---|---|---|---|---|
OutputPath |
[string] | C:\ProgramData\Citrix\WEM\CitrixScoutCliLogs |
Faux | Répertoire où écrire le fichier zip de sortie de Scout. Par défaut : C:\ProgramData\Citrix\WEM\CitrixScoutCliLogs. |
Exclude |
[string] | Non applicable | Faux | Liste de collecteurs séparés par des virgules à exclure de la collecte Scout. Valeurs prises en charge : msi, localdata. Laissez vide pour inclure tous les collecteurs. |
Plus d'informations
Pour des exemples d'utilisation des tâches scriptées, consultez :