PoC Guide: Automated Configuration Tool

Vue d’ensemble

L’ outil de configuration automatisée facilite la migration et l’exportation des configurations vers Citrix Desktops-as-a-Service (DaaS). Ce guide de validation de concept illustre les instructions étape par étape sur l’utilisation de cet outil.

Les administrateurs peuvent facilement tester et explorer les fonctionnalités et avantages de Citrix DaaS, tout en exécutant simultanément des environnements locaux existants et même faciliter les déplacements entre les régions cloud, sauvegarder les configurations existantes et d’autres cas d’utilisation. Le lien de téléchargement de la configuration automatisée contient également des informations supplémentaires et une documentation détaillée sur lesdits cas d’utilisation et personnalisations.

Qu’est-ce que l’outil de configuration automatisée pour Citrix Virtual Apps and Desktops ?

Cet outil est conçu pour aider à automatiser la migration de la configuration CVAD (stratégies, applications, catalogues, rôles d’administrateur, étendues et autres) d’un ou de plusieurs sites locaux vers Citrix DaaS hébergé sur Citrix Cloud. Il peut également être utilisé pour migrer des informations entre différentes régions Cloud ou locataires.

La migration peut être effectuée par étapes en exécutant l’outil plusieurs fois, ce qui permet aux administrateurs d’atteindre facilement l’état de configuration souhaité. Une vidéo de 2 minutes fournit une présentation rapide de l’outil de configuration automatisée :

 

Pourquoi utiliser cet outil ?

Les administrateurs informatiques chargés d’environnements volumineux ou complexes trouvent souvent les migrations comme un processus fastidieux. Ils finissent souvent par écrire leurs propres outils pour accomplir cette tâche avec succès car elle tend à être spécifique à leurs cas d’utilisation.

Citrix souhaite faciliter ce processus en fournissant un outil qui traite les cas d’utilisation grâce à l’automatisation. Les administrateurs peuvent facilement tester les configurations actuelles dans Citrix Cloud et profiter des avantages offerts par Citrix DaaS tout en préservant leurs environnements actuels. Ces avantages incluent une réduction de la surcharge administrative lorsque Citrix gère une partie du plan dorsal et du plan de contrôle, des mises à jour automatiques et personnalisables des composants Citrix Cloud, etc.

Comment cet outil est-il implémenté ?

Citrix utilise la configuration standard du secteur comme code pour fournir un mécanisme permettant d’automatiser les processus de migration. Cet outil découvre et exporte un ou plusieurs sites locaux sous la forme d’un ensemble de fichiers de configuration, que les administrateurs peuvent éventuellement modifier. La configuration de ces fichiers peut ensuite être importée dans Citrix DaaS.

Ce code ne se limite pas aux migrations, il est l’avenir de la création de la configuration pour les sites Citrix et, par conséquent, applicable à de nombreux cas d’utilisation différents. La reprise après sinistre, la synchronisation de développement/teste/intermédiaire vers le site de production, les déplacements géographiques (GEO) et plusieurs autres scénarios sont pris en charge. Pour les administrateurs utilisant des fournisseurs de cloud public, cela peut aider à créer automatiquement une combinaison d’objets (parallèlement aux modèles Microsoft Azure ARM et AWS CloudFormation).

L’outil permet également aux administrateurs de fusionner plusieurs sites locaux en un seul site, tout en évitant les collisions de noms. Les administrateurs peuvent contrôler si les ressources sur site ou dans le cloud sont contrôlées. Les fichiers peuvent désormais être placés dans un partage de fichiers réseau sécurisé qui nécessite une authentification lors de l’utilisation du paramètre SecurityFileFolder qui pointe vers le fichier CvadacSecurity.yml .

Conditions préalables

Environnement local

  • Environnement local Citrix Virtual Apps and Desktops (CVAD) avec au moins un VDA enregistré.
  • Environnement sur site CVAD s’exécutant sur l’une des versions suivantes : toutes les versions LTSR (Long Term Service Release) avec leur dernière CU (7.6, 7.15, 1912) ; Ou l’une des deux dernières versions actuelles (CR) correspondantes (par exemple : 2003, 2006).
  • La machine jointe au domaine sur laquelle vous prévoyez d’exécuter les commandes de l’outil de configuration automatisée doit exécuter la version .NET 4.7.2 ou supérieure.
  • Machine dotée du kit SDK Citrix PowerShell, qui est automatiquement installé sur le DDC. Remarque : Si vous exécutez l’outil sur une autre machine, il doit être joint au domaine et Studio doit disposer des composants logiciels enfichables PowerShell corrects installés. Ce programme d’installation se trouve sur le support d’installation ISO du produitcorrespondant, disponible sur le site Web Téléchargements Citrix > Citrix Virtual Apps and Desktops .
  • Téléchargez l’outil de configuration automatisée MSI sur le site officiel des téléchargements

Composants liés au cloud

Remarque : Si vous effectuez une migration entre des sites cloud (migration cloud vers le cloud), consultez la documentation officielle pour connaître les étapes détaillées.

  • Licences Citrix DaaS ou Workspace Premium Plus valides.
  • L’administrateur doit être en mesure de se connecter au portail Cloud et d’obtenir : le nom de l’emplacement de la ressource, l’ ID client, le secret client (ID de l’application et clé secrète)
  • L’ emplacement de ressource Citrix Cloud existant possède au moins un Cloud Connector, qui est marqué comme vert (sain) et fait partie du même domaine que la configuration locale. Remarque : Citrix recommande d’avoir deux ou plusieurs Cloud Connector (pour la redondance et la haute disponibilité). Pour plus d’informations sur la configuration de vos Cloud Connector, consultez ce guide.

Ce guide de validation de concept montre comment

  1. Remplir les conditions préalables sur site
  2. Exportez la configuration de votre site sur site dans des fichiers YAML (.yml)
  3. Compléter les conditions préalables du cloud
  4. Remplissez les conditions requises pour importer la configuration du site lors de l’utilisation de différentes méthodes de provisionnement (Machine Creation Services (MCS) pour les catalogues groupés et statiques)
  5. Importer la configuration de votre site dans le Cloud (en modifiant les fichiers requis)
  6. Conseils de dépannage et où trouver plus d’informations

Prérequis complets pour l’exportation à partir d’un site local

Ces étapes doivent être exécutées dans votre DDC ou sur la machine jointe au domaine sur laquelle vous souhaitez exécuter l’outil de configuration automatisée.

  1. Téléchargez le dernier outil de configuration automatisée MSI sur votre DDC sur site ou sur une machine associée à un domaine. Remarque : reportez-vous à la section Prérequis pour plus de détails sur la façon de l’exécuter à partir d’une autre machine. L’outil peut être téléchargé ici. Remarque : reportez-vous à la section Prérequis pour plus de détails sur la façon de l’exécuter à partir d’une autre machine.
  2. Exécutez le MSI sur votre DDC local, en cliquant avec le bouton droit sur le programme d’installation AutoConfig_PowerShell_x64.msi et en cliquant sur Installer. Pre-requisites
  3. Lisez le Contrat de licence et cochez la case si vous acceptez les termes. Cliquez ensuite sur Install : Pre-requisites
  4. Les fichiers sont copiés et la barre de progression continue de se déplacer jusqu’à ce que l’installation soit terminée. Pre-requisites

  5. Après l’exécution du MSI, une fenêtre indiquant l’achèvement réussi apparaît. Cliquez sur Terminer pour fermer la fenêtre de configuration MSI. Pre-requisites
  • Remarque : En cas d’exécution réussie, le MSI crée la structure de dossiers correspondante, située dans C:\Users\<username>\Documents\Citrix\AutoConfig, ainsi qu’une icône de bureau appelée Auto Config, qui lance une invite de commande PowerShell. Cet outil est celui utilisé lors des étapes suivantes.

Exporter la configuration de votre site local

À l’aide d’une commande PowerShell export, vous pouvez exporter votre configuration locale existante et obtenir les fichiers .yml nécessaires. Ces fichiers sont utilisés pour importer la configuration souhaitée dans Citrix Cloud.

  1. Après avoir exécuté le programme d’installation MSI à l’étape précédente, vous obtenez un raccourci Auto Config créé automatiquement sur le Bureau. Cliquez avec le bouton droit sur ce raccourci et cliquez sur Exécuter en tant qu’administrateur
  2. Exécutez la commande Export-CvadAcToFile. Cette commande exporte les stratégies, les catalogues provisionnés manuellement et les groupes de mise à disposition. Il exporte également des applications, des dossiers d’applications, des icônes, des mappages de zones, des balises, des rôles et des étendues d’administration, ainsi que d’autres éléments. Remarque : Pour les catalogues de machines et les groupes de mise à disposition MCS, reportez-vous à la section Procédure requise pour l’importation de la configuration du site à l’aide de différentes méthodes de provisionnement de ce guide. Exporter la configuration

  3. Une fois l’outil terminé, l’ état général affiche la valeur True et le processus d’exportation est terminé (les lignes de sortie affichées correspondent à l’illustration suivante). Remarque : S’il y a des erreurs, des fichiers de diagnostic sont créés dans les sous-dossiers spécifiques à l’action (Export, Import, Merge, Restore, Sync, Backup, Compare), qui se trouvent sous %HOMEPATH%\Documents\Citrix\AutoConfig. Reportez-vous à la section Conseils de dépannage si vous rencontrez des erreurs. Exporter la configuration

  4. Les fichiers .yml résultants se trouvent désormais dans le Documents\Citrix\AutoConfig chemin de l’utilisateur actuel : Exportation de la configuration
  • Remarque : Voir l’image suivante pour un exemple du contenu d’un fichier .yml (Application.yml)

Exporter la configuration

  • Remarque : si nécessaire, copiez les fichiers .yml sur la machine que vous souhaitez utiliser pour importer des paramètres dans votre environnement Citrix Cloud. L’exportation et l’importation peuvent se faire à partir de la même machine.

Compléter les conditions préalables dans le Cloud

Accédez à votre emplacement des ressources et assurez-vous que vos Cloud Connector sont tous deux verts (Disponible). Remarque : si vous avez besoin d’instructions sur la façon de configurer vos Cloud Connector, consultez ce guide.

  1. Pour vérifier l’état de santé de vos Cloud Connector, connectez-vous d’abord à votre portail cloud avec vos informations d’identification d’administrateur Citrix (ou vos informations d’identification Azure AD, le cas échéant). Prérequis pour le cloud

  2. Si vous disposez de plusieurs ID d’ organisation (ID organisation ), sélectionnez votre locataire correspondant. Prérequis pour le cloud

  3. Lors de l’ouverture de session, allez dans le menu hamburger dans le coin supérieur gauche, puis cliquez sur Emplacements des ressources : prérequis cloud

  4. Accédez à la vignette Cloud Connector sous votre emplacement de ressource. Prérequis pour le cloud

  • Remarque : Le ou les Cloud Connector doivent apparaître en vert, indiquant un état sain, comme indiqué sur l’image suivante. Citrix recommande d’avoir plus d’un Cloud Connector par emplacement de ressource, à des fins de redondance.

Prérequis pour le cloud

Conditions requises pour l’importation de la configuration du site à l’aide de différentes méthodes de provisioning

Traiter les catalogues de machines Provisioning Services (PVS), les groupes et stratégies de mise à disposition et d’applications

Aucune étape supplémentaire n’est requise pour importer vos catalogues PVS et leurs applications correspondantes pour le moment. Suivez les étapes mentionnées dans la section Importer la configuration de votre site dans le cloud de ce guide.

Gestion des services de création de machines (MCS) : catalogues de machines VDI multisession (aléatoires) et RDS groupés

Remarque : Une section distincte est disponible avec des instructions pour les machines virtuelles assignées statiques. Reportez-vous aux étapes mentionnées dans la section MCS Static Assigned VDI de ce guide.

Les commandes d’importation et d’exportation sont désormais prises en charge pour cette tâche. L’image de référence et la configuration dans Catalogues avec données utilisateur : Discard peuvent être migrées. Toutefois, les machines virtuelles de ces catalogues ne sont pas migrées, car le site à partir duquel vous importez est responsable de la gestion du cycle de vie de la machine virtuelle.

Lorsque les machines sont mises sous tension, leur état peut changer, ce qui affecte les données d’importation pour la synchronisation des machines virtuelles. Par conséquent, lors de la migration de ces catalogues à l’aide de l’outil, il crée des métadonnées de catalogue et lance la création d’une image principale. Cependant, aucune machine n’est importée.

Considérations importantes :

  • Le processus d’importation du catalogue MCS peut prendre quelques heures en fonction de la taille de l’image principale. Par conséquent, la commande d’importation de l’outil ne fait que démarrer la création du catalogue MCS et n’attend pas sa fin.
  • Une fois l’importation terminée, la progression de la création du catalogue peut être surveillée via Studio dans le déploiement cloud.
  • Une fois l’image principale créée, vous pouvez approvisionner des machines. Tenez compte de la capacité existante de votre hyperviseur, étant donné que votre consommation provient de votre utilisation sur site.
  • Tous les autres objets (y compris le groupe de mise à disposition, les applications, les stratégies et tout ce qui utilise le catalogue) peuvent être importés, sans avoir à attendre la création de l’image principale. Les mêmes commandes disponibles dans l’outil peuvent être utilisées pour migrer les catalogues et tous les autres objets.
  • Lorsque la création du catalogue est terminée, des machines peuvent être ajoutées au catalogue importé, puis les utilisateurs peuvent lancer leurs ressources.

Remarque : Après ces considérations, suivez la section Importer la configuration de votre site dans le cloud de ce guide pour fusionner votre configuration selon vos besoins.

Traitement des services de création de machines (MCS) : Machines assignées statiques

Remarque : Une section distincte est disponible avec des instructions pour les machines groupées et RDS. Reportez-vous aux étapes mentionnées sur les machines VDI et RDS groupées MCS

Les commandes d’importation et d’exportation sont désormais prises en charge pour cette tâche. Ce processus importe certains détails de bas niveau qui sont stockés dans la base de données et doivent donc être exécutés à partir d’une machine ayant accès à la basede données. Le processus d’importation d’outils migre la configuration, l’image principale et les machines également. C’est une opération rapide puisqu’aucune image n’est créée.

Considérations importantes :

  • Les VDA doivent être pointés vers les Cloud Connector pour qu’ils puissent s’enregistrer auprès de Citrix Cloud.
  • Reportez-vous à la documentation Activating sites pour activer votre site Cloud et ainsi contrôler le calendrier de redémarrage, la gestion de l’alimentation, etc., via Citrix Cloud.
  • Une fois la migration terminée, si vous souhaitez supprimer le catalogue correspondant de votre site sur site, vous devez sélectionner l’option permettant de quitter la machine virtuelle et le compte AD. Sinon, les deux enregistrements seront supprimés et le site Cloud pointera vers la machine virtuelle supprimée.

Remarque : Après ces considérations, suivez la section Importer la configuration de votre site dans le cloud de ce guide pour fusionner votre configuration selon vos besoins.

Importer la configuration de votre site dans le Cloud

Au cours de cette étape, vous obtenez les détails de connexion client, créez manuellement vos mappages de zone et importez la configuration vers votre locataire Cloud. Remarque : Pour MCS, suivez d’abord les sous-sections correspondantes dans la section Importer la configuration de votre site dans le cloud de ce guide.

Obtention des détails de connexion client

Les administrateurs doivent modifier le fichier CustomerInfo.yml et y ajouter les valeurs CustomerName, CustomerID et SecretKey correspondantes. Ces valeurs peuvent être obtenues et générées à partir du portail Cloud, comme indiqué dans les étapes suivantes.

  1. Tout d’abord, ouvrez votre fichier CustomerInfo.yml à l’aide d’une application d’éditeur de texte, telle que le Bloc-notes. La capture d’écran suivante montre les valeurs de CustomerInfo.yml fichier qui doivent être modifiées (soulignées en rouge) : Importation de la configuration

  2. Sur votre portail Cloud, cliquez à nouveau sur le menu hamburger et accédez à Gestion des identités et des accès : Importation de la configuration

  3. Accédez à l’onglet Accès à l’API et copiez la valeur de l’ ID client, qui se trouve à côté du texte customer ID, comme indiqué sur la capture d’écran suivante (rectangle rouge) : Importation de la configuration

  4. Collez la valeur récupérée entre les guillemets qui suivent le champ CustomerID de votre CustomerInfo.yml fichier, entre les “” (guillemets) : Importation de la configuration

  5. De retour sur votre portail Cloud, accédez au portail Identity and Access et à l’onglet API Access . Entrez le nom que vous souhaitez utiliser pour identifier cette clé API dans la zone Nommez votre client sécurisé . Cliquez ensuite sur le bouton Créer un client. Remarque : Cette action génère le Client ID et le Secret Key. Importation de la configuration

  6. Copiez le les valeurs ID et Secret et, une par une (collez-les sur le fichier CustomerInfo.ymlcomme indiqué à l’étape suivante). Cliquez ensuite sur Télécharger pour enregistrer le fichier pour référence ultérieure. Importation de la configuration

  7. Collez les Secret valeurs ID et dans les champs correspondants du CustomerInfo.yml fichier : Importation de la configuration

Mettre à jour manuellement le fichier de mappage de zones (Zonemapping.yml)

Les zones locales ne peuvent pas être migrées automatiquement vers un emplacement de ressources cloud, elles doivent donc être mappées à l’aide du fichier ZoneMapping.yml. Remarque : Les échecs de migration se produisent si la zone n’est pas mappée avec un emplacement de ressource homonyme (un emplacement de ressource portant exactement le même nom).

  1. De retour dans le même répertoire où résident vos fichiers .yml (Documents\Citrix\AutoConfig), ouvrez ZoneMapping.yml à l’aide du Bloc-notes ou à l’aide de votre éditeur de texte préféré. Remarque : la valeur Primary doit être remplacée par le nom de la zone correspondante à partir de laquelle vous souhaitez migrer les objets (dans votre environnement local). Mapping de zone

  2. Vous pouvez trouver ce nom sous votre console Citrix Studio locale > Configuration > Zones. Remarque : si votre zone est nommée Primary dans votre environnement sur site, il n’est pas nécessaire de modifier cette valeur dans le ZoneMapping.yml fichier : Cartographie de zone

  3. Toujours dans le fichier ZoneMapping.yml, la valeur Name_Of_Your_Resource_Zone doit être remplacée par votre nom d’emplacement de ressource Cloud. Cette valeur peut être trouvée sur votre portail cloud sous le menu Hamburger > Resource Locations : Zone Mapping

  4. Copiez le nom de votre emplacement de ressources (illustré My Resource Location sur la capture d’écran suivante) : Cartographie de zone

  5. Collez cette valeur dans le ZoneMapping.yml fichier au lieu de la Name_Of_Your_Resouce_Zone valeur : Zone Mapping

  • Remarque : plusieurs zones de votre environnement local peuvent également être mappées à un seul emplacement de ressource dans le cloud. Cependant, il doit toujours y avoir une ligne dans le fichier pour chaque zone de l’environnement local. Pour plusieurs zones locales et un emplacement de ressource, le format de ce fichier se présente comme suit :

Mapping de zone

Lors du mappage de zones à différents emplacements de ressources, le fichier doit ressembler à ceci :

Mapping de zone

Mettez à jour manuellement le fichier CVADACSecurity.yml

Les connexions hôtes et leurs hyperviseurs associés peuvent être migrés vers Citrix DaaS. L’ajout des connexions hôtes nécessite des informations de sécurité pour l’hyperviseur spécifique. Ces informations doivent être ajoutées manuellement dans le fichier CVADACSecurity.yml . Remarque Pour cet exemple, nous utilisons Citrix Hypervisor. Pour plus d’informations sur les informations de sécurité requises pour les autres types d’hyperviseurs, visitez le site de documentation des produits Citrix DaaS .

  1. De retour dans le même répertoire où résident vos fichiers .yml (Documents\Citrix\AutoConfig), ouvrez CvadAcSecurity.yml à l’aide du Bloc-notes ou à l’aide de votre éditeur de texte préféré. Sécurité de l'hyperviseur

  2. Dans le CvadAcSecurity.yml fichier, entrez le username et password pour votre connexion à l’hyperviseur, puis enregistrez le fichier. Sécurité de l'hyperviseur

Fusionner la configuration

  1. De nouveau dans la console PowerShell de l’outil de migration, exécutez la commande suivante : Merge-CvadAcToSite pour fusionner la configuration Cloud existante (le cas échéant) avec la configuration exportée à partir du site local. Configuration de fusion

  2. Lorsque chaque tâche s’exécute correctement, la sortie apparaît en vert au fur et à mesure que les fichiers .yml sont importés et que les composants correspondants sont ajoutés au site cloud : Configuration de la fusion

  3. Les fichiers résultants s’affichent dans le répertoire suivant : <This PC>\Documents\Citrix\AutoConfig\Import_<YYYY_MM_DD_HH_mm_ss> Configuration de la fusion

  4. Dans ce même dossier, vous pouvez trouver un dossier Backup_YYYY_MM_DD_HH_mm_ss. Remarque : Copiez ce dossier dans un endroit sûr car il s’agit d’une sauvegarde de la configuration.

  5. Le Backup dossier contient les fichiers suivants, qui sont utiles pour annuler les modifications, si nécessaire : Configuration de fusion

Vérifier la configuration créée dans Cloud Studio

  1. Accédez à votre onglet Gestion Citrix DaaS via la console Cloud > Mes services > Citrix DaaS > onglet Gérer). Vérification de la configuration

  2. Actualisez pour vous assurer que les catalogues de machines, lesgroupes de mise à disposition, les stratégies, les balises et les applications s’affichent désormais comme prévu. Remarque : en fonction de ce que vous importez, les résultats varient car ils sont spécifiques à votre propre configuration unique. Vérifiez chaque section pour vous assurer que les éléments attendus sont répertoriés.

  • Exemple de liste des catalogues de machines :

Vérification de la configuration

Si tout se passe comme prévu, votre migration Citrix DaaS est terminée.

Conseils de dépannage

Informations générales pour le dépannage :

  • Consultez l’ article FAQ sur le dépannage de l’outil de configuration automatisée.
  • Avant d’ouvrir un ticket d’assistance auprès de Citrix, rassemblez tous les journaux et *.yml fichiers dans un seul fichier zip en exécutant New-CvadAcZipInfoForSupport. Aucune information de sécurité client n’est incluse. Transférez le fichier zip à l’emplacement suivant %HOMEPATH%\Documents\Citrix\AutoConfig\CvadAcSupport_yyyy_mm_dd_hh_mm_ss.zipNew-CvadAcZipInfoForSupport.
  • L’exécution d’une applet de commande crée un fichier journal et une entrée dans le fichier journal de l’historique maître. Les entrées contiennent la date, l’opération, le résultat, la sauvegarde et les emplacements du fichier journal de l’exécution. Ce journal fournit des solutions potentielles et des correctifs aux erreurs courantes.
  • Le journal d’historique principal se trouve dans %HOMEPATH%\Documents\Citrix\AutoConfig, dans le fichier nommé History.Log.* 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 auto-config ainsi que la date et l’ horodatage de l’exécution de l’applet de commande.
  • Les journaux ne suppriment pas automatiquement.
  • La journalisation de la console peut être supprimée à l’aide du -quiet paramètre

Informations supplémentaires :

  1. Vous pouvez également nous contacter via le forum d’assistance

  2. Lisez la documentation de l’outil de configuration automatisée

  3. Téléchargez les nouvelles versions à partir du lien direct du site Web Downloads

  4. Découvrez l’ enregistrement de notre webinaire à la demande du 19 août   : « Pourquoi la migration vers Citrix Cloud est plus facile que jamais ». Nous avons partagé plus d’informations sur l’outil et avons organisé une session de questions-réponses en direct avec un panel d’experts Citrix.

  5. Reportez-vous à la section Migration vers le cloud de Citrix DaaS pour plus d’informations et pour consulter la documentation officielle.

  6. Si, après avoir consulté les informations répertoriées précédemment, vous avez toujours besoin d’assistance, contactez vos représentants Citrix, Customer Success Manager ou Support.

PoC Guide: Automated Configuration Tool