Tâches scriptées
Introduction
Conseil :
Les tâches scriptées fonctionnent au niveau de la machine. Pour exécuter des tâches au niveau d’une session utilisateur, utilisez plutôt Tâches externes .
Cette page vous permet d’ajouter des tâches de script que vous personnalisez en fonction de vos besoins uniques en matière de gestion de l’environnement. Vous pouvez ensuite automatiser ces tâches avec Workspace Environment Management (WEM) en les configurant dans le jeu de configuration applicable.
À l’heure actuelle, nous proposons la tâche de script intégrée suivante que vous pouvez utiliser :
- Vérification de l’état du cloud
- Gestion des services Windows
- Redémarrage du serveur
- Gestion du traçage CDF
Vérification de l’état du cloud
Permet d’exécuter des contrôles qui évaluent la santé des Virtual Delivery Agents (VDA). Les vérifications de l’état du VDA identifient les causes possibles des problèmes courants d’enregistrement de VDA et de lancement de session. Le bilan de santé 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 fournit des fonctionnalités courantes concernant le service Windows, telles que le démarrage, l’arrêt, le redémarrage et la configuration d’un ou plusieurs services Windows.
Redémarrage du 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. Quel que soit l’état actuel, si le service est en cours d’exécution et ne nécessite pas de démarrage forcé, il est quand-même redémarré pour s’assurer qu’il fonctionne avec la dernière configuration ou pour sortir d’un état bloqué.
Paramètres
| nom | type | défaut | obligatoire | Remarque |
|---|---|---|---|---|
ServiceNames |
chaîne | BrokerAgent | False | Spécifie le nom du ou des services à gérer. S’il n’est pas spécifié, la valeur par défaut estBrokerAgent. Si vous devez saisir plusieurs services, séparez les noms des services par une virgule. Tous les espaces seront supprimés. Par exemple, ServiceA, ServiceB. |
ForceStart |
booléen | true | False | Indique s’il faut démarrer le service s’il s’avère qu’il ne fonctionne pas. Cela n’affecte pas les services en cours d’exécution, car ils sont toujours redémarrés à des fins de maintenance ou de restauration. |
Arrêter le service Windows
Ce script arrête la liste des services Windows spécifiés. Le script vérifie si chaque service est installé et tente de forcer l’arrêt du service. Le script vérifie ensuite si le service s’est arrêté avec succès et indique l’état.
Paramètres
| nom | type | défaut | obligatoire | Remarque |
|---|---|---|---|---|
ServiceNames |
chaîne | BrokerAgent | False | Spécifie le nom du ou des services à gérer. S’il n’est pas spécifié, la valeur par défaut estBrokerAgent. Si vous devez saisir plusieurs services, séparez les noms des services 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, notamment le type de démarrage et les actions de restauration.
Paramètres
| nom | type | défaut | obligatoire | Remarque |
|---|---|---|---|---|
ServiceNames |
chaîne | null | true | Spécifie le nom du ou des services à gérer. S’il n’est pas spécifié, la valeur par défaut estBrokerAgent. Si vous devez saisir plusieurs services, séparez les noms des services par une virgule. Tous les espaces seront supprimés. Par exemple, ServiceA, ServiceB. |
StartupType |
chaîne | null | False | Définit le type de démarrage du service. Les options valides sont Automatique, Manuel ou Désactivé. |
FirstFailureAction |
chaîne | null | False | Définit l’action à appliquer lors du premier échec. Par exemple, redémarrer/aucune. |
SecondFailureAction |
chaîne | null | False | Définit l’action à appliquer lors d’un deuxième échec consécutif. |
SubsequentFailureAction |
chaîne | null | False | Définit l’action à appliquer lors de tous les échecs consécutifs au deuxième. |
Redémarrage du serveur
Redémarrer la machine
Ce script redémarre la machine locale avec une option facultative de retardement et de forçage.
Paramètres
| nom | type | défaut | obligatoire | Remarque |
|---|---|---|---|---|
Force |
booléen | true | False | Si l’option de forçage est spécifiée, le redémarrage immédiat est forcé, ignorant les données non enregistrées ou les sessions utilisateur actives. |
Delay |
Entier | 10 | False | Spécifie le délai en secondes avant le redémarrage de l’ordinateur. La valeur doit être comprise entre 3 et 30 secondes. Le délai par défaut est 10 secondes. |
Gestion du traçage CDF
Démarrer le traçage CDF
Ce script utilise un fichier CTL ou une catégorie prédéfinie de fichiers CTL en tant qu’entrée pour démarrer le processus de l’outil CDF et commencer à tracer les modèles dans les fichiers CTL.
Paramètres
| nom | type | défaut | obligatoire | Remarque |
|---|---|---|---|---|
traceOutputPath |
chaîne | C:\ProgramData\Citrix\WEM\CDFLogs |
False | Spécifie le chemin de sortie des rapports CDF. |
category
|
chaîne
|
10
|
False
|
Spécifie les catégories prédéfinies avec lesquelles démarrer le traçage. Les valeurs prises en charge sont les suivantes
allalways on tracingdesktop Server os vdadelivery controllerfederated authentication serviceprovisioning serviceuniversal print servercitrix directorcitrix studiosession recording administrationsession recording playercitrix workspace app for windows |
ctlFilePath |
chaîne | null | False | Spécifie le fichier ctlavec lequel démarrer le traçage. |
Arrêter le traçage CDF
Ce script arrête le traçage avec l’outil CDF.
Nettoyage des journaux CDF
Il est utile de nettoyer les journaux de traçage CDF pour réduire l’utilisation de l’espace de stockage. Une fonction permettant de supprimer les fichiers CDF dans le répertoire donné devrait être spécifiée.
| nom | type | défaut | obligatoire | Remarque |
|---|---|---|---|---|
FileAgeDays |
Entier | 3 | False | Spécifie l’âge limite en jours. Les fichiers et dossiers antérieurs à 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 la valeur de FileAgeDays est inférieure à 1 jour. |
Conseil :
- Vous pouvez faire la différence entre les tâches scriptées personnalisées et intégrées : les tâches personnalisées sont marquées par l’étiquette « CUSTOM » et celles intégrées par l’étiquette « CITRIX ».
- Les tâches scriptées intégrées apparaissent toujours au-dessus des tâches personnalisées. Les tâches scriptées personnalisées sont triées par ordre décroissant en fonction de l’heure de la dernière modification.
Grâce à cette fonctionnalité, vous pouvez étendre les capacités de WEM pour répondre à vos besoins de gestion uniques. Par exemple, la tâche scriptée intégrée Vérification de l’état du cloud vous permet d’évaluer la santé des VDA. La tâche est basée sur un script. Vous pouvez écrire votre propre fichier de script. Ensuite, vous ajoutez le fichier de script à WEM en tant que tâche de script afin de pouvoir automatiser la tâche à l’aide de WEM.
Chaque fois qu’une tâche de script est exécutée, un rapport correspondant est généré pour elle. Le rapport inclut des informations sur le moment où la tâche s’exécute, les résultats de l’exécution de la tâche, etc., vous donnant ainsi la possibilité d’auditer les activités liées à la tâche.
Les tâches scriptées fonctionnent au niveau du jeu de configuration. Voici un flux de travail général pour utiliser des tâches scriptées :
-
Sur la page Tâches scriptées, ajoutez une tâche scriptée.
-
Accédez au jeu de configuration pour lequel vous souhaitez activer la tâche de script.
-
Sur la page Paramètres des tâches scriptées de ce jeu de configuration, activez la tâche scriptée. Consultez la section Paramètres des tâches scriptées.
-
Vous pouvez également afficher les rapports relatifs à la tâche de script. Il y a deux façons de procéder :
- Accédez à Surveillance > Rapports et affichez les rapports à cet endroit.
- Accédez à Tâches scriptées ou à la page Paramètres des tâches scriptées d’un jeu de configuration. Recherchez la tâche de script, sélectionnez les points de suspension, puis Afficher les rapports. Vous êtes ensuite redirigé vers la page Surveillance > Rapports, avec les filtres appropriés appliqués automatiquement. Vous pouvez ensuite consulter les rapports associés.
Pour plus d’informations sur les rapports de tâches par script, consultez la section Rapports.
Ajouter une tâche basée sur un script
Pour ajouter une tâche de script, effectuez les opérations suivantes :
-
Sur la page Tâche de script, cliquez sur Ajouter une tâche de script.
-
Dans l’Assistant Ajouter une tâche de script, configurez les paramètres suivants, puis cliquez sur Enregistrer.
-
Nom de la tâche. Spécifiez un nom pour la tâche.
-
Étiquettes. Faites votre choix parmi les balises existantes ou saisissez des balises séparées par des virgules. Un tag ne doit pas comporter plus de 20 caractères. Les balises sont comme des mots-clés ou des étiquettes. L’utilisation de balises vous permet d’identifier vos tâches de nouvelles manières. Ils agissent également comme des filtres, vous permettant de réorganiser votre vue des tâches dans les tâches scriptées en fonction de critères importants pour vous. Vous pouvez utiliser autant de balises que vous le souhaitez.
-
Description. Vous pouvez également spécifier des informations supplémentaires pour vous aider à identifier la tâche.
-
Type de fichier. Sélectionnez un type de fichier pour la tâche. 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 chargé un fichier zip, spécifiez un point d’entrée indiquant le fichier à exécuter au début de la tâche scriptée. N’oubliez pas que le fichier du point d’entrée ne doit pas dépasser trois niveaux de profondeur dans la structure des dossiers.
-
Téléchargez un fichier. Cliquez sur Parcourir, accédez au fichier, sélectionnez-le, puis cliquez sur Ouvrir. Vous revenez à l’assistant Ajouter une tâche scriptée .
-
Accorder des autorisations. Spécifiez le niveau d’accès que vous souhaitez accorder à la tâche scriptée. Assurez-vous de bien comprendre les autorisations associées à chaque option.
- Accès complet. Une tâche de script affectée d’un accès complet dispose d’un accès local étendu. Si cette option est sélectionnée, la tâche scriptée se voit accorder des autorisations comme si elle s’exécutait sous le compte système local.
- Accès limité (avec accès au réseau). Une tâche de script affectée à un accès limité (avec accès réseau) ne dispose pas d’un accès local étendu mais peut accéder aux ressources réseau. Si cette option est sélectionnée, la tâche de script se voit accorder des autorisations comme si elle s’exécutait sous le compte de service réseau.
- Accès limité (sans accès au réseau). Une tâche de script affectée d’un accès limité (sans accès réseau) ne dispose pas d’un accès local étendu et ne peut pas accéder aux ressources réseau. Si cette option est sélectionnée, la tâche de script se voit accorder des autorisations comme si elle s’exécutait sous le compte de service local.
For more information, see the Microsoft documentation https://docs.microsoft.com/en-us/windows/security/identity-protection/access-control/security-identifiers#well-known-sids.
-
-
Dossier de travail. Vous pouvez également saisir le chemin d’accès absolu du dossier local sur le système d’exploitation de l’utilisateur final. Le dossier de travail est le dossier en cours du fichier au démarrage. Vous pouvez créer 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/en-us/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 la tâche que vous ajoutez génère des fichiers de sortie.
-
Chemin de sortie. Entrez un chemin relatif au dossier dans lequel se trouve le fichier. Le chemin d’accès doit contenir le nom du fichier et l’extension du nom de fichier. Exemple :
output\report.txt.
Modification d’une tâche basée sur un script
Pour modifier une tâche de script, effectuez les opérations suivantes :
-
Sur la page Tâches scriptées, localisez la tâche. Si nécessaire, utilisez le champ de recherche pour rechercher rapidement la tâche.
-
Cliquez sur les points de suspension de la tâche, puis sélectionnez Modifier la tâche. L’assistant Modifier la tâche de script s’affiche.
-
Dans l’onglet Infos sur la tâche, configurez les paramètres selon vos besoins.
-
Dans l’onglet Contenu du script, affichez le contenu du script.
-
Cliquez sur Enregistrer.
Remarque :
Vous ne pouvez pas modifier les tâches de script intégrées.
Supprimer une tâche de script
Pour supprimer une tâche de script, effectuez les opérations suivantes :
-
Sur la page Tâches scriptées, localisez la tâche. Si nécessaire, utilisez le champ de recherche pour rechercher rapidement la tâche.
-
Cliquez sur les points de suspension de la tâche, puis sélectionnez Supprimer la tâche.
Important :
- Vous ne pouvez pas supprimer les tâches de script intégrées.
- Pour supprimer une tâche de script actuellement activée pour certains jeux de configuration, désactivez-la d’abord dans ces jeux de configuration.
Cloner une tâche scriptée
Pour cloner une tâche scriptée, effectuez les opérations suivantes :
-
Sur la page Tâches scriptées, localisez la tâche. Si nécessaire, utilisez le champ de recherche ou les balises pour trouver rapidement la tâche.
-
Cliquez sur les points de suspension de la tâche, puis sélectionnez Cloner la tâche.
Remarque :
Lorsque vous clonez une tâche, vous êtes invité à modifier le nom afin d’éviter les doublons.
Option de configuration des paramètres de tâche
Pour atteindre rapidement le réglage de la tâche, effectuez les opérations suivantes :
-
Sur la page Tâches scriptées, localisez la tâche. Si nécessaire, utilisez le champ de recherche ou les balises pour trouver rapidement la tâche.
-
Cliquez sur les points de suspension de la tâche, puis sélectionnez Configurer les paramètres de la tâche.
-
Choisissez un ensemble de configuration dans l’assistant de sélection d’un ensemble de configuration .
-
Cliquez sur Exécuter pour accéder à la tâche filtrée dans la page Paramètres des tâches scriptées, où seule la tâche choisie est filtrée.
Informations supplémentaires
Pour des exemples d’utilisation de tâches scriptées, voir :