Dépannage de la configuration automatisée et informations supplémentaires
Important :
Pour connaître les messages d’erreur courants relatifs à la configuration automatisée et aux solutions correspondantes, consultez la FAQ sur le dépannage de l’article CTX277730 du centre de connaissances.
Erreurs de l’outil de configuration automatisée
Les opérations de l’outil de configuration automatisée peuvent parfois générer des erreurs. Dans ce cas, des défaillances peuvent survenir lors du traitement de composants tels que des catalogues de machines, des groupes de mise à disposition ou des stratégies de groupe, par exemple. L’utilisation des paramètres OnErrorAction et de continuation vous permet de détecter les erreurs en cours de traitement, de les résoudre et de reprendre là où vous vous êtes arrêté.
La valeur par défaut de OnErrorAction est StopCompEnd. Lorsqu’une erreur se produit, l’outil termine le traitement du composant actuel. Aucun composant supplémentaire n’est traité et les erreurs ne se répercutent pas sur les composants dépendants en aval. Une fois les erreurs résolues, vous pouvez réexécuter vos applets de commande en appliquant n’importe quel paramètre de continuation.
Paramètre OnErrorAction
Vous pouvez définir les valeurs du paramètre OnErrorAction sur les commandes de migration afin de contrôler la manière dont l’outil répond aux erreurs détectées lors du traitement des composants.
Ce tableau présente les valeurs du paramètre et leurs descriptions :
| Valeur | Description |
|---|---|
Continue |
Essaie de traiter autant de composants que possible. |
Pause |
S’arrête à la fin du traitement et vous invite à continuer ou à arrêter. |
StopCompEnd |
Essaie de traiter la plus grande partie possible du composant. S’arrête une fois que le composant est terminé. (par défaut) |
StopImmediately |
Le traitement s’arrête lorsqu’une erreur est détectée. |
Applets de commande de migration
Vous pouvez appliquer le paramètre OnErrorAction aux commandes de migration suivantes :
Compare-CvadAcToSiteImport-CvadAcToSiteMerge-CvadAcToSiteNew-CvadAcToSiteRestore-CvadAcToSite
Exemple : Merge-CvadAcToSite -OnErrorAction StopImmediately
Paramètres de reprise
Ces paramètres définissent la manière dont l’outil reprend après une pause ou l’arrêt d’une opération en raison d’une erreur.
Vous pouvez appliquer des paramètres de reprise aux applets de commande de migration qui incluent l’une des valeurs de paramètre OnErrorAction suivantes :
PauseStopCompEndStopImmediately
Ce tableau présente les valeurs du paramètre et leurs descriptions :
| Valeur | Description |
|---|---|
-AllRemaining |
Nécessite un composant de départ. Le traitement commence au niveau du composant de départ et traite tous les composants restants. Plusieurs composants sont traités. |
-Resume |
Utilise le composant de CurrentComponent.txt comme point de départ. Tout ce qui reste est défini sur true. Plusieurs composants sont traités. |
-Repeat |
Utilise le composant de CurrentComponent.txt comme point de départ. Tout ce qui reste est défini sur false. Un seul composant est traité. |
Le dernier composant traité est stocké dans le fichier CurrentComponent.txt du dossier AutoConfig. Il n’est pas recommandé de modifier ce fichier.
Si vous spécifiez -Resume ou -Repeat et que le fichier CurrentComponent.txt est manquant ou non valide, le traitement s’arrête et vous êtes invité à sélectionner un composant.
Configuration de l’action OnErrorAction dans le fichier CustomerInfo.yml
Vous pouvez également définir des valeurs de OnErrorAction dans le fichier CustomerInfo.yml. Définissez les valeurs à l’aide des applets de commande suivantes :
- Pour un nouveau fichier :
New-CvadAcCustomerInfoFile -OnErrorAction Continue | Pause | StopCompEnd | StopImmediately - Pour un fichier existant :
Set-CvadAcCustomerInfoFile -OnErrorAction Continue | Pause | StopCompEnd | StopImmediately
Journaux
L’exécution d’une applet de commande entraîne la création d’un fichier journal et une entrée dans le fichier journal de l’historique principal. Tous les fichiers journaux d’opérations sont placés dans un dossier de sauvegarde. Tous les noms de fichiers journaux commencent par CitrixLog, puis affichent l’opération de configuration automatique ainsi que l’horodatage de l’exécution de l’applet de commande. Les journaux ne sont pas supprimés automatiquement.
Le journal de l’historique principal se trouve dans *%HOMEPATH%\Documents\Citrix\AutoConfig*, dans le fichier History.Log. Chaque exécution de l’applet de commande entraîne une entrée de journal principal contenant la date, l’opération, le résultat, la sauvegarde et les emplacements du fichier journal de l’exécution.
Vous pouvez également utiliser l’applet de commande New-CvadAcZipInfoForSupport pour collecter des journaux à envoyer à Citrix pour obtenir de l’aide. Cette applet de commande compresse tous les fichiers journaux et .yml dans un seul fichier zip. Les informations sensibles du client (CustomerInfo.yml et CvadAcSecurity.yml) ne sont pas incluses dans le zip. Le fichier Icon.yml est également exclu en raison de sa taille. Le fichier zip est placé dans %HOMEPATH%\Documents\Citrix\AutoConfig et nommé CvadAcSupport_yyyy_mm_dd_hh_mm_ss.zip, en fonction de la date et de l’horodatage. Ce fichier zip peut également servir de sauvegarde.
Chaque fichier journal comprend les éléments suivants :
- Nom de l’opération et si le mode de vérification est activé
- Date et heure de début et de fin
- Entrées multiples pour les actions et les notifications de réussite/échec de chaque composant
- Résumé des actions effectuées, y compris les différents dénombrements d’objets créés
- Corrections suggérées, le cas échéant
- Emplacement du dossier de sauvegarde, le cas échéant
- Emplacement du journal principal
- Durée
Fichiers de diagnostic
Les fichiers de diagnostic vous aident à déterminer et à résoudre les problèmes. Les fichiers suivants sont créés lors de l’exécution de leur opération. Ils se trouvent dans le sous-dossier spécifique à l’action sous %HOMEPATH%\Documents\Citrix\AutoConfig. Incluez ces fichiers lorsque vous fournissez des informations à l’équipe d’assistance pour la résolution de problèmes.
Exporter
PoshSdk_yyyy_mm_dd_hh_mm_ss.ps1
Ce fichier compte tous les appels SDK PowerShell de Broker effectués pour exporter la configuration du site vers des fichiers.
Import, Merge, Restore, Sync, Backup, Compare
Transaction_yyyy_mm_dd_hh_mm_ss.txt
Ce fichier documente chaque appel d’API Rest et les informations connexes.
RestApiContent_yyyy_mm_dd_hh_mm_ss.txt
Ce fichier contient tout le contenu de l’API Rest Add, Update et Delete.
Problèmes résultant des dépendances
Les importations et les fusions peuvent échouer en raison de dépendances manquantes. Voici quelques problèmes courants :
- Des filtres de groupe de mise à disposition manquent dans les stratégies de groupe. C’est en général parce que des groupes de mise à disposition n’ont pas été importés.
- Échec de l’importation ou de la fusion des applications. C’est en général parce que des groupes de mise à disposition manquent ou des groupes d’applications n’ont pas été importés.
- Il manque un RestrictToTag dans les groupes d’applications. C’est en général parce que des balises n’ont pas été importées.
- Les connexions d’hôte échouent. C’est en général parce que des informations de sécurité manquent dans le fichier CvadAcSecurity.yml.
- Les catalogues de machines échouent. C’est en général parce que des connexions d’hôte n’ont pas été importées.
- Machines manquantes dans des catalogues de machines et des groupes de mise à disposition. C’est en général parce que des machines n’ont pas été trouvées dans Active Directory.
- Utilisateurs manquants dans des groupes de mise à disposition. C’est en général parce que des utilisateurs sont introuvables dans Active Directory.
Recommandations
- N’exécutez pas plus d’une instance de l’outil de configuration automatisée à la fois. L’exécution de plusieurs instances simultanées produit des résultats imprévisibles sur le site cloud. Si cela se produit, réexécutez une instance de l’outil de configuration automatisée pour amener le site à l’état attendu.
- Ne modifiez pas les données dans Studio pendant l’exécution de la configuration automatique.
- Vérifiez toujours visuellement les résultats de fusion, d’importation ou de restauration dans Studio pour vous assurer que le site cloud répond aux attentes.
Dossiers
Emplacement racine du dossier par défaut
Toutes les opérations de l’outil de configuration automatisée s’effectuent dans le dossier racine ou dans les sous-dossiers qu’il contient. Le dossier racine se trouve sous %HOMEPATH%\Documents\Citrix\AutoConfig.
Exporter
Tous les fichiers exportés sont placés dans deux emplacements de dossier, ce qui offre une facilité d’utilisation et un historique des exportations. Les exportations sont toujours placées dans le dossier racine. Les copies sont placées dans un sous-dossier nommé Export avec la date et l’heure de l’exportation.
Le dossier racine contient toujours la configuration de site locale exportée la plus récente. Chaque sous-dossier Export contient l’exportation effectuée à la date et à l’heure indiquées, ce qui permet de conserver un historique des exportations. Vous pouvez utiliser n’importe quel sous-dossier Export pour configurer le site cloud. L’outil de configuration automatisée ne supprime pas et ne modifie pas les sous-dossiers d’exportation existants.
Import/Merge/Sync/Compare
Les opérations Import, Merge et Compare proviennent toujours de fichiers situés dans le dossier racine. Chaque opération entraîne la création d’un sous-dossier dans lequel les fichiers du dossier racine sont copiés, fournissant ainsi un historique des modifications des fichiers source du site cloud.
Restaurer
L’opération Restore utilise un sous-dossier existant pour configurer le site cloud. Le dossier source est spécifié sur le paramètre -RestoreFolder requis. Contrairement aux autres commandes, aucun nouveau sous-dossier n’est créé car l’opération Restoreutilise un sous-dossier existant. Le dossier de restauration peut être le dossier racine mais doit toujours être spécifié sur le paramètre -RestoreFolder.
Sauvegardes
L’outil de configuration automatisée initialise, met à jour et sauvegarde la configuration d’un site cloud. Au fil du temps, de nombreuses configurations différentes peuvent changer sur le site cloud. Pour faciliter l’utilisation à long terme et préserver l’historique des changements, l’outil de configuration automatisée utilise un schéma de conservation pour sauvegarder cet historique et fournir une méthode pour restaurer les états antérieurs.
Les sauvegardes de configuration de site cloud sont toujours effectuées dans un sous-dossier nommé Backup avec les données et l’heure de la sauvegarde. L’outil de configuration automatisée ne supprime pas et ne modifie pas les sous-dossiers d’exportation existants.
Vous pouvez utiliser les sauvegardes pour restaurer des composants spécifiques ou l’intégralité de votre configuration. Pour restaurer l’ensemble des composants Groupe de mise à disposition et Catalogue de machines, utilisez l’applet de commande :
Restore-CvadAcToSite -RestoreFolder %HOMEPATH%\Documents\Citrix\AutoConfig/Backup_yyyy_mm_dd_hh_mm_ss -DeliveryGroups -MachineCatalogs
Remarque :
Les informations du fichier de sauvegarde de l’applet de commande précédente sont basées sur vos propres sauvegardes.
Pour restaurer l’intégralité de la configuration du site cloud, utilisez l’applet de commande :
Restore-CvadAcToSite -RestoreFolder %HOMEPATH%\Documents\Citrix\AutoConfig/Backup_yyyy_mm_dd_hh_mm_ss
Remarque :
Les informations du fichier de sauvegarde de l’applet de commande précédente sont basées sur vos propres sauvegardes.
Modification du dossier racine par défaut
Les opérations Export, Import, Merge, Sync et Compare peuvent modifier le dossier racine par défaut à l’aide du paramètre –AlternateFolder. La création et la gestion des sous-dossiers par opération restent les mêmes que celles décrites précédemment.
Fichiers copiés dans des sous-dossiers
Tous les fichiers ayant une extension « .yml » sont copiés dans les sous-dossiers d’opération, à l’exception des éléments suivants :
- CustomerInfo.yml
- ZoneMapping.yml
- CvadAcSecurity.yml
Sauvegardes automatisées de site cloud en mode sans échec
Une sauvegarde de la configuration actuelle du site cloud est effectuée avant d’exécuter les opérations qui modifient la configuration. Cela inclut les paramètres Import, Merge, Sync et Restore. La sauvegarde se trouve toujours dans un sous-dossier situé sous le sous-dossier opérationnel.
Dans le cas de Restore, le dossier de sauvegarde est un sous-dossier du dossier spécifié sur le paramètre -RestoreFolder.
Automatisation
Les applets de commande de l’outil configuration automatisée peuvent être exécutées dans des scripts d’automatisation sans intervention de l’administrateur en supprimant les invites et l’affichage des résultats du journal à la fin de l’applet de commande. Vous pouvez également définir des paramètres pour faire de même à l’aide du fichier CustomerInfo.yml.
Ajoutez le paramètre suivant aux applets de commande de modification du cloud pour supprimer l’affichage des invites.
-Confirm $false
Ajoutez le paramètre suivant aux applets de commande pour supprimer l’affichage du journal à la fin de l’applet de commande.
-DisplayLog $false
Ajoutez le paramètre suivant aux applets de commande pour supprimer la journalisation dans la fenêtre de commande PowerShell.
-Quiet
Une autre méthode consiste à placer les paramètres suivants dans le fichier CustomerInfo.yml.
Confirm: False
DisplayLog: False
Exportation à partir d’ordinateurs autres que le Delivery Controller
L’outil de configuration automatisée utilise plusieurs SDK PowerShell Citrix pour exporter la configuration de site local vers des fichiers. Ces SDK sont automatiquement installés sur le Delivery Controller, ce qui permet à l’outil de s’exécuter sur le Delivery Controller sans actions supplémentaires. Lors de l’exécution sur des machines non Delivery Controller, il est nécessaire d’installer l’ensemble de SDK PowerShell Citrix requis par l’outil. Cet ensemble de SDK fait partie de Citrix Studio qui peut être installé à partir du support d’installation Citrix Virtual Apps and Desktops.
Remarque :
L’outil de configuration automatisée ne peut pas être exécuté sur le Cloud Connector.
Migration vers Citrix Cloud Government et Japan Control Plane
Les environnements Citrix Cloud Government et Japan Control Plane utilisent différents points d’accès pour authentifier et allouer des jetons d’accès. Cette exigence unique s’applique à tout outil de configuration automatisée accédant au cloud. Effectuez la procédure suivante pour utiliser la configuration automatisée dans ces environnements.
- Dans le dossier %CHEMINDEBASE%\Documents\Citrix\AutoConfig, modifiez CustomerInfo.yml.
-
Ajoutez l’une des lignes suivantes, en fonction de l’environnement auquel vous souhaitez vous connecter, à CustomerInfo.yml (ou modifiez-la, si elle est déjà présente).
Environment: 'ProductionGov'ou
Environment: 'ProductionJP'
La configuration automatisée peut désormais être utilisée dans ces environnements.
Collecte de données Citrix Cloud
Pour en savoir plus sur les informations collectées par Citrix Cloud, consultez la section Gestion du contenu client et des journaux de Citrix Cloud Services.
Ressources supplémentaires
Forum de discussion
Visitez le Forum de discussion Citrix pour la configuration automatisée.
Vidéo
Regardez Under the Hood of the Automated Configuration Tool for Citrix Virtual Apps and Desktops sur YouTube.
Formation
Le Cloud Learning Center contient des guides vidéo étape par étape sur la création d’un déploiement de services, y compris les tâches décrites dans cet article. Voir Migrating Citrix Virtual Apps and Desktops to Citrix Cloud Learning Path.
Dans cet article
- Erreurs de l’outil de configuration automatisée
- Journaux
- Fichiers de diagnostic
- Problèmes résultant des dépendances
- Recommandations
- Dossiers
- Sauvegardes
- Automatisation
- Exportation à partir d’ordinateurs autres que le Delivery Controller
- Migration vers Citrix Cloud Government et Japan Control Plane
- Collecte de données Citrix Cloud
- Ressources supplémentaires