Dépanner la configuration automatisée et informations supplémentaires

Important :

Pour les messages d’erreur courants liés à la configuration automatisée et les solutions correspondantes, consultez la FAQ de dépannage dans l’article du centre de connaissances CTX277730.

Erreurs de l’outil de configuration automatisée

Les opérations de l’outil de configuration automatisée peuvent parfois produire des erreurs. Dans ce cas, des échecs peuvent se produire lors du traitement de composants tels que les catalogues de machines, les groupes de mise à disposition ou les stratégies de groupe, par exemple. L’utilisation de OnErrorAction et des paramètres de continuation vous permet d’intercepter les erreurs en cours de traitement, de les résoudre et de reprendre là où vous vous étiez 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 sont pas reportées sur les composants dépendants en aval. Après avoir résolu les erreurs, vous pouvez réexécuter vos cmdlets avec n’importe quel paramètre de continuation appliqué.

Paramètre OnErrorAction

Vous pouvez définir les valeurs du paramètre OnErrorAction sur les commandes de migration pour contrôler la façon dont l’outil réagit aux erreurs qu’il rencontre lors du traitement des composants.

Ce tableau présente les valeurs des paramètres et leurs descriptions :

Cmdlets de migration

Vous pouvez appliquer le paramètre OnErrorAction aux commandes de migration suivantes :

• Compare-CvadAcToSite
• Import-CvadAcToSite
• Merge-CvadAcToSite
• New-CvadAcToSite
• Restore-CvadAcToSite

Exemple : Merge-CvadAcToSite -OnErrorAction StopImmediately

Paramètres de reprise

Ces paramètres définissent comment l’outil reprend après qu’une opération se soit mise en pause ou arrêtée en raison d’une erreur.

Vous pouvez appliquer des paramètres de reprise aux cmdlets de migration qui incluent l’une des valeurs de paramètre OnErrorAction suivantes :

• Pause
• StopCompEnd
• StopImmediately

Ce tableau présente les valeurs des paramètres et leurs descriptions :

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 CurrentComponent.txt est manquant ou invalide, le traitement s’arrête et vous êtes invité à sélectionner un composant.

Définition de OnErrorAction dans le fichier CustomerInfo.yml

Vous pouvez également définir les valeurs OnErrorAction dans le fichier CustomerInfo.yml. Définissez les valeurs à l’aide des cmdlets 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 de n’importe quelle cmdlet entraîne la création d’un fichier journal et une entrée dans le fichier journal d’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 la date et l’heure d’exécution de la cmdlet. Les journaux ne sont pas supprimés automatiquement.

Le journal d’historique principal se trouve dans *%HOMEPATH%\Documents\Citrix\AutoConfig*, dans le fichier nommé History.Log. Chaque exécution de cmdlet génère une entrée de journal principale contenant la date, l’opération, le résultat, la sauvegarde et les emplacements des fichiers journaux de l’exécution.

Vous pouvez également utiliser la cmdlet New-CvadAcZipInfoForSupport pour collecter les journaux à envoyer à Citrix pour le support. Cette cmdlet 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 fichier 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’heure. Ce fichier zip peut également servir de sauvegarde.

Chaque fichier journal comprend les éléments suivants :

• Le nom de l’opération et si le mode de vérification est activé
• La date et l’heure de début et de fin
• Plusieurs entrées pour les actions de chaque composant et les notifications de succès/échec
• Résumé des actions entreprises, y compris les différents décomptes d’objets créés
• Correctifs suggérés 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 à identifier et à résoudre les problèmes. Les fichiers suivants sont créés lorsque leur opération est exécutée. Ils se trouvent dans le sous-dossier spécifique à l’action sous %HOMEPATH%\Documents\Citrix\AutoConfig. Incluez ces fichiers lorsque vous fournissez des informations pour le support de résolution de problèmes.

Exportation

PoshSdk_yyyy_mm_dd_hh_mm_ss.ps1

Ce fichier compte tous les appels du SDK PowerShell du Broker effectués pour exporter la configuration du site vers des fichiers.

Importation, Fusion, Restauration, Synchronisation, Sauvegarde, Comparaison

Transaction_yyyy_mm_dd_hh_mm_ss.txt

Ce fichier documente chaque appel d’API Rest et les informations associées.

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 :

1. Les stratégies de groupe ne contiennent pas de filtres de groupe de mise à disposition. Les causes habituelles sont des groupes de mise à disposition qui n’ont pas été importés.
2. Les applications ne peuvent pas être importées ou fusionnées. La cause habituelle est l’absence de groupes de mise à disposition ou de groupes d’applications qui n’ont pas été importés.
3. Les groupes d’applications ne contiennent pas de RestrictToTag. Les causes habituelles sont des balises qui n’ont pas été importées.
4. Les connexions d’hôte échouent. La cause habituelle est l’absence d’informations de sécurité dans le fichier CvadAcSecurity.yml.
5. Les catalogues de machines échouent. La cause habituelle est que les connexions d’hôte n’ont pas été importées.
6. Machines manquantes dans les catalogues de machines et les groupes de mise à disposition. La cause habituelle est que les machines n’ont pas été trouvées dans Active Directory.
7. Utilisateurs manquants dans les groupes de mise à disposition. La cause habituelle est que les utilisateurs n’ont pas été trouvés dans Active Directory.

Recommandations

• N’exécutez pas plus d’une instance 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 configuration automatisée pour ramener le site à l’état attendu.
• Ne travaillez pas et ne modifiez pas de données dans Studio pendant l’exécution de la configuration automatisée.
• Vérifiez toujours visuellement les résultats de la fusion, de l’importation ou de la 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 se déroulent dans le dossier racine ou dans ses sous-dossiers. Le dossier racine se trouve dans %HOMEPATH%\Documents\Citrix\AutoConfig.

Exportation

Tous les fichiers exportés sont placés à deux emplacements de dossier, offrant une facilité d’utilisation et un historique des exportations. Les exportations sont toujours placées dans le dossier racine. Des 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 sur site exportée la plus récente. Chaque sous-dossier Export contient l’exportation effectuée à la date et à l’heure indiquées, ce qui maintient un historique des exportations. Vous pouvez utiliser n’importe quel sous-dossier Export pour configurer le site cloud. La configuration automatisée ne supprime ni ne modifie les sous-dossiers d’exportation existants.

Importation/Fusion/Synchronisation/Comparaison

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 vers lequel les fichiers du dossier racine sont copiés, fournissant un historique des fichiers sources modifiés 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 Restore utilise un sous-dossier existant. Le dossier de restauration peut être le dossier racine, mais il doit toujours être spécifié sur le paramètre -RestoreFolder.

Sauvegardes

La configuration automatisée initialise, met à jour et sauvegarde une configuration de 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 les modifications de l’historique, la configuration automatisée utilise un schéma de conservation pour enregistrer cet historique des modifications et fournir une méthode de restauration des états antérieurs.

Les sauvegardes de configuration du site cloud sont toujours effectuées dans un sous-dossier nommé Backup avec la date et l’heure de la sauvegarde. La configuration automatisée ne supprime ni ne modifie 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’intégralité du groupe de mise à disposition et des composants du catalogue de machines, utilisez la cmdlet :

Restore-CvadAcToSite -RestoreFolder %HOMEPATH%\Documents\Citrix\AutoConfig/Backup_yyyy_mm_dd_hh_mm_ss -DeliveryGroups -MachineCatalogs

Remarque :

Les informations du fichier de sauvegarde dans la cmdlet précédente sont basées sur vos propres sauvegardes.

Pour restaurer l’intégralité de la configuration du site cloud, utilisez la cmdlet :

Restore-CvadAcToSite -RestoreFolder %HOMEPATH%\Documents\Citrix\AutoConfig/Backup_yyyy_mm_dd_hh_mm_ss

Remarque :

Les informations du fichier de sauvegarde dans la cmdlet 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 suivants :

• CustomerInfo.yml
• ZoneMapping.yml
• CvadAcSecurity.yml

Sauvegardes automatiques de site cloud à sécurité intégrée

Une sauvegarde de la configuration actuelle du site cloud est effectuée avant d’exécuter des 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 sous le sous-dossier opérationnel.

Dans le cas de Restore, le dossier de sauvegarde est un sous-dossier du dossier spécifié dans le paramètre -RestoreFolder.

Automatisation

Les cmdlets de l’outil de 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 la cmdlet. 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 cmdlets de modification du cloud pour supprimer l’affichage des invites.

-Confirm $false

Ajoutez le paramètre suivant aux cmdlets pour supprimer l’affichage du journal à la fin de la cmdlet.

-DisplayLog $false

Ajoutez le paramètre suivant aux cmdlets pour supprimer la journalisation dans la fenêtre de commande PowerShell.

-Quiet

Autre méthode, les paramètres suivants peuvent être placés dans le fichier CustomerInfo.yml.

Confirm: False

DisplayLog: False

Exportation depuis des PC autres que le Delivery Controller™

L’outil de configuration automatisée utilise plusieurs SDK PowerShell Citrix pour exporter la configuration du site sur site 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 autres que le Delivery Controller, il est nécessaire d’installer l’ensemble des 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 de Citrix Virtual Apps and Desktops™.

Remarque :

La configuration automatisée ne peut pas être exécutée 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. Suivez les étapes suivantes pour utiliser la configuration automatisée dans ces environnements.

1. Dans le dossier %HOMEPATH%\Documents\Citrix\AutoConfig, modifiez CustomerInfo.yml.

2. 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 plus d’informations sur les données collectées par Citrix Cloud, consultez Gestion du contenu client et des journaux des services Citrix Cloud.

Ressources supplémentaires

Forum de discussion

Visitez le forum de discussion Citrix sur la configuration automatisée.

Vidéo

Regardez Les coulisses de l’outil de configuration automatisée pour Citrix Virtual Apps and Desktops sur YouTube.

Formation

Le Cloud Learning Center contient des guides vidéo étape par étape pour la création d’un déploiement de service, y compris les tâches décrites dans cet article. Consultez Parcours d’apprentissage pour la migration de Citrix Virtual Apps and Desktops vers Citrix Cloud.