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 de la session utilisateur, utilisez plutôt Tâches externes .
Cette page vous permet d’ajouter des tâches scriptées 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 l’ensemble de configuration applicable.
Actuellement, nous vous proposons la tâche scriptée intégrée suivante que vous pouvez utiliser :
Vérification de l’état du cloud
Vous permet d’exécuter des contrôles qui évaluent l’état des agents de distribution virtuelle (VDA). Les contrôles de santé VDA identifient les causes possibles des problèmes courants d’enregistrement VDA et de lancement de session. Cloud Health Check 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 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 actuellement 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 redémarré pour garantir qu’il fonctionne sur la dernière configuration ou pour récupérer d’un état bloqué.
Paramètres
| nom | taper | défaut | obligatoire | Remarque La |
|---|---|---|---|---|
ServiceNames |
Chaîne | CourtierAgent | FAUX | Spécifie le nom du ou des services à gérer. Si non fourni, la valeur par défaut est BrokerAgent. Si vous devez saisir plusieurs services, séparez les noms de services par une virgule. Tous les espaces seraient coupés. Par exemple, ServiceA, ServiceB. |
ForceStart |
boolean | vrai | FAUX | Indique si le service doit être démarré s’il n’est pas en cours d’exécution. 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 de forcer l’arrêt du service. Le script vérifie ensuite si le service s’est arrêté avec succès et signale l’état.
Paramètres
| nom | taper | défaut | obligatoire | Remarque La |
|---|---|---|---|---|
ServiceNames |
Chaîne | CourtierAgent | FAUX | Spécifie le nom du ou des services à gérer. Si non fourni, la valeur par défaut est BrokerAgent. Si vous devez saisir plusieurs services, séparez les noms de services par une virgule. Tous les espaces seraient coupés. Par exemple, ServiceA, ServiceB. |
Configurer le service Windows
Ce script ajuste les configurations du service Windows, y compris le type de démarrage et les actions de récupération.
Paramètres
| nom | taper | défaut | obligatoire | Remarque La |
|---|---|---|---|---|
ServiceNames |
Chaîne | nul | vrai | Spécifie le nom du ou des services à gérer. Si non fourni, la valeur par défaut est BrokerAgent. Si vous devez saisir plusieurs services, séparez les noms de services par une virgule. Tous les espaces seraient coupé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 le premier échec. Par exemple, redémarrer/aucun. |
SecondFailureAction |
Chaîne | nul | FAUX | Définit l’action pour le deuxième échec consécutif. |
SubsequentFailureAction |
Chaîne | nul | FAUX | Définit l’action pour tous les échecs ultérieurs après le deuxième. |
Redémarrage du serveur
Machine de redémarrage
Ce script redémarre la machine locale avec une option de délai et de force facultative.
Paramètres
| nom | taper | défaut | obligatoire | Remarque La |
|---|---|---|---|---|
Force |
boolean | vrai | FAUX | Si spécifié, forcez un redémarrage immédiat, en ignorant 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 durer 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 prend soit un fichier CTL, soit une catégorie prédéfinie de fichiers CTL en entrée pour démarrer le processus de l’outil CDF et commencer à tracer les modèles dans les fichiers CTL.
Paramètres
| nom | taper | défaut | obligatoire | Remarque La |
|---|---|---|---|---|
traceOutputPath |
Chaîne | C:\ProgramData\Citrix\WEM\CDFLogs |
FAUX | Spécifie le chemin de sortie des rapports CDF. |
category
|
Chaîne
|
10
|
FAUX
|
Spécifie les catégories prédéfinies avec lesquelles démarrer la trace. Les valeurs prises en charge sont
toustoujours en cours de traçageSystème d'exploitation du serveur de bureau vdacontrôleur de livraisonservice d'authentification fédéréeservice d'approvisionnementserveur d'impression universeldirecteur citrixcitrix studioadministration de l'enregistrement de sessionlecteur d'enregistrement de sessionapplication Citrix Workspace pour Windows |
ctlFilePath |
Chaîne | nul | FAUX | Spécifie le fichier ctl avec lequel démarrer la trace. |
Arrêtez le traçage du 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 la consommation de stockage. Il devrait fournir une fonction pour supprimer les fichiers CDF sous le répertoire donné.
| nom | taper | défaut | obligatoire | Remarque La |
|---|---|---|---|---|
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éalisateurs sont supprimés si FileAgeDays est inférieur à 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 avec l’étiquette « PERSONNALISÉE » et les tâches intégrées avec 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 en fonction de vos besoins de gestion uniques. Par exemple, la tâche scriptée intégrée Cloud Health Check vous permet d’évaluer l’état de 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 scriptée afin de pouvoir automatiser la tâche à l’aide de WEM.
Chaque fois qu’une tâche scriptée s’exécute, un rapport correspondant est généré pour celle-ci. 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 et bien plus encore, vous donnant ainsi la possibilité d’auditer les activités liées à la tâche.
Les tâches scriptées fonctionnent au niveau d’un ensemble de configuration. Un flux de travail général pour utiliser des tâches scriptées est le suivant :
-
Sur la page Tâches scriptées , ajoutez une tâche scriptée.
-
Accédez à l’ensemble de configuration pour lequel vous souhaitez activer la tâche scriptée.
-
Sur la page Paramètres de tâche scriptée de cet ensemble de configuration, activez la tâche scriptée. Voir Paramètres des tâches scriptées.
-
Vous pouvez également afficher les rapports liés à la tâche scriptée. Il y a deux façons de procéder :
- Accédez à Surveillance > Rapports et affichez les rapports à cet endroit.
- Accédez à la page Tâches scriptées ou Paramètres des tâches scriptées d’un ensemble de configuration. Localisez la tâche scriptée, sélectionnez les points de suspension, puis sélectionnez Afficher les rapports. Vous êtes ensuite redirigé vers la page Surveillance > Rapports , avec les filtres pertinents appliqués automatiquement. Vous pouvez ensuite voir les rapports associés.
Pour plus d’informations sur les rapports de tâches scriptées, voir Rapports.
Ajouter une tâche basée sur un script
Pour ajouter une tâche scriptée, procédez comme suit :
-
Sur la page Tâche scriptée , cliquez sur Ajouter une tâche scriptée.
-
Dans l’assistant Ajouter une tâche scriptée , configurez les paramètres suivants, puis cliquez sur Enregistrer.
-
Nom de la tâche. Spécifiez un nom pour la tâche.
-
Étiquettes. Sélectionnez parmi les balises existantes ou saisissez des balises séparées par des virgules. Une balise ne doit pas comporter plus de 20 caractères. Les tags 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 qui sont importants pour vous. Vous pouvez utiliser autant de balises que vous le souhaitez.
-
Description. Si vous le souhaitez, spécifiez 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.
- CODE POSTAL. Plusieurs fichiers regroupés dans un seul fichier zip. Les fichiers ZIP supérieurs à 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 de la tâche scriptée. Gardez à l’esprit que le fichier de point d’entrée ne doit pas se trouver à plus de trois niveaux de profondeur dans la structure du dossier.
-
Télécharger le fichier. Cliquez sur Parcourir, accédez au fichier, sélectionnez-le, puis cliquez sur Ouvrir. Vous êtes renvoyé à l’assistant Ajouter une tâche scriptée .
-
Accorder les autorisations. Spécifiez le niveau d’accès que vous souhaitez accorder à la tâche scriptée. Assurez-vous de comprendre les autorisations associées à chaque option.
- Accès complet. Une tâche scriptée à laquelle est attribué un accès complet dispose d’un accès local étendu. Si cette option est sélectionnée, la tâche scriptée reçoit des autorisations comme si elle s’exécutait sous le compte système local.
- Accès limité (avec accès réseau). Une tâche scriptée 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 scriptée reçoit des autorisations comme si elle s’exécutait sous le compte de service réseau.
- Accès limité (sans accès réseau). Une tâche scriptée 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 scriptée reçoit des autorisations comme si elle s’exécutait sous le compte de service local.
Pour plus d’informations, consultez la documentation Microsoft https://docs.microsoft.com/en-us/windows/security/identity-protection/access-control/security-identifiers#well-known-sids.
-
-
Dossier de travail. Si vous le souhaitez, saisissez 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 au démarrage. Vous pouvez construire le chemin avec des variables d’environnement (par exemple, %ProgramFiles%). Si non 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. Tapez un chemin relatif au dossier où réside le fichier. Le chemin doit contenir le nom du fichier et l’extension du nom de fichier. Exemple :
sortie\report.txt.
Modifier une tâche scriptée
Pour modifier une tâche scriptée, procédez comme suit :
-
Sur la page Tâches scriptées , recherchez 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 scriptée apparaît.
-
Dans l’onglet Informations 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 scriptées intégrées.
Supprimer une tâche scriptée
Pour supprimer une tâche scriptée, procédez comme suit :
-
Sur la page Tâches scriptées , recherchez 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 scriptées intégrées.
- Pour supprimer une tâche scriptée actuellement activée pour certains ensembles de configuration, désactivez-la d’abord dans ces ensembles de configuration.
Cloner une tâche scriptée
Pour cloner une tâche scriptée, procédez comme suit :
-
Sur la page Tâches scriptées , recherchez 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 :
Lors du clonage d’une tâche, vous êtes invité à modifier le nom pour éviter les doublons.
Option de configuration des paramètres de tâche
Pour accéder rapidement au paramètre de la tâche, procédez comme suit :
-
Sur la page Tâches scriptées , recherchez 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 Sélectionner l’ensemble de configuration .
-
Cliquez sur Aller pour atteindre 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 :