Guide PoC : Outil de configuration automatique - Sauvegarde et restauration sur site

Vue d’ensemble

L’outil de configuration automatique Citrix (ACT) migre les charges de travail et facilite les tâches d’administration quotidiennes de Citrix, à la fois sur site et dans le cloud. La fonctionnalité de sauvegarde et de restauration ACT permet aux administrateurs Citrix de créer une sauvegarde du site Citrix dans des fichiers de configuration (.yaml), qui contiennent l’état actuel du site. Considérez cela comme un instantané de votre site Citrix, plutôt que comme une sauvegarde incrémentielle. ACT génère des fichiers de configuration pour chacun des composants Citrix (catalogues de machines, groupes de mise à disposition, applications et connexions hôtes). La fonctionnalité de sauvegarde et de restauration ACT n’est disponible que dans le cadre de la console Citrix Web Studio. L’article Installer Web Studio détaille les étapes nécessaires à l’installation et à la configuration de la console Citrix Web Studio.

Studio Web

Processus de sauvegarde et de restauration

Lorsque vous sélectionnez l’onglet Sauvegarde + Restauration dans Citrix Web Studio , vous êtes invité à télécharger et à installer l’outil de configuration automatique. Le processus de sauvegarde et de restauration s’effectue à l’aide du SDK PowerShell de l’ACT.

Télécharger ACT 1

Téléchargez le fichier .msi et installez l’outil de configuration automatique. Il est suggéré de l’installer sur un serveur Citrix Delivery Controller.

Télécharger ACT 2

Après avoir installé l’outil de configuration automatique, vérifiez l’installation en l’affichant dans la section « Programmes et fonctionnalités ».

Panneau de commande ACT

Une icône d’accès direct nommée Auto Config est créée pour l’outil de configuration automatique sur le bureau.

Accès direct à ACT

Création d’une sauvegarde et d’une restauration

Avant de commencer à utiliser l’outil, familiarisons-nous avec les principales applets de commande de base de l’outil de configuration d’automatisation :

  • Backup-CvadAcToFile  : sauvegarde toutes les configurations depuis votre site Citrix.
  • Restore-CvadActoSite: restaure les fichiers YAML de sauvegarde sur le site Citrix. Cela peut faire référence au même site Citrix ou à un site différent.

Sur la base de ces applets de commande, vous pouvez effectuer une restauration complète ou une sélection précise du composant souhaité en ajoutant un commutateur pointant vers le fichier de ressource/de configuration spécifique (.yml) tel que -includebyname (nous expliquerons cela plus tard et fournirons des exemples).

La sauvegarde de votre site est un processus simple. Comme indiqué, l’outil de configuration automatique exporte un « instantané » de votre site dans des fichiers de configuration. Les fichiers ACT se trouvent dans le dossier %HOMEPATH% \ Documents \ Citrix \ AutoConfig

Vous trouverez ci-dessous une capture d’écran affichant le contenu d’un dossier de sauvegarde. Un dossier unique est créé pour chaque sauvegarde avec la date et l’heure de fin de la sauvegarde. Chaque dossier de sauvegarde contient des fichiers de configuration qui peuvent être utilisés pour la restauration.

Télécharger ACT 3

Exemple de sauvegarde et de restauration

Cet exemple explique les processus suivants pour commencer à utiliser l’outil de configuration automatique :

  1. Création de la structure de dossiers de base %HOMEPATH% \ Documents \ Citrix \ AutoConfig
  2. Modification du fichier CustomerInfo.yml pour On-Premises
  3. Création d’une sauvegarde
  4. Restauration à partir d’une sauvegarde

Création de la structure des dossiers

L’ACT nécessite une structure de dossiers pour localiser les fichiers .yml générés lors de la sauvegarde. Tout d’abord, nous devons « exporter » la configuration initiale.

  • Lancez ACT et exécutez la commande Export-CvadAcToFile

Exportation ACT 1

ACT crée la structure des dossiers et y crée les fichiers de configuration. Vous trouverez ci-dessous une capture d’écran affichant les résultats.

ACT Export 2

Modification du fichier de configuration pour une utilisation sur site

  • Ouvrez le fichier CustomerInfo.yml depuis C:\Users %username% \ Documents \ Citrix \ AutoConfig
  • Trouvez la variable « Environnement » et remplacez la valeur « Production » par « OnPrem »

Remarque :

N’oubliez pas que le paramètre « OnPrem » fait la distinction entre majuscules et minuscules. Veillez à mettre le « O » et le « P » en majuscules, sinon vous serez invité à vous connecter à Citrix Cloud.

ACT Export 3

Création d’une sauvegarde

Une fois que la structure des dossiers est prête, vous pouvez continuer à exécuter l’applet de commande « Backup ». Comme mentionné précédemment, pour créer une sauvegarde, vous devez exécuter la commande suivante : Backup-CvadAcToFile

Sauvegarde de configuration ACT 1

Sauvegarde de configuration ACT 2

Restauration à partir d’une sauvegarde

Les fichiers importés proviennent du dossier spécifié à l’aide du paramètre -RestoreFolder. Ce paramètre reconnaît le dossier qui contient les fichiers .yml pour restaurer le site. Il doit s’agir d’un chemin de dossier complet. Cette applet de commande peut également être utilisée pour revenir à la configuration précédente ou pour sauvegarder et restaurer votre site Citrix. Cette commande permet d’ajouter, de supprimer et de mettre à jour votre site Citrix Cloud.

Remarque :

Le nom du commutateur correspond au contenu de chaque fichier .yaml, ce qui vous permet de restaurer des composants tels que les catalogues de machines, les groupes de mise à disposition, les applications et les politiques.

Voici quelques exemples de granularité de restauration et les commandes correspondantes :

  • Restaurer vers une sauvegarde spécifique
    • Restaurer - CvadactoSite - Restaurer le dossier %HOMEPATH% \ Documents \ Citrix \ AutoConfig/ Backup_YYYY_MM_DD_HH_MM_SS

Restore Granular pour des composants spécifiques

  • Restaurer un catalogue de machines spécifique
    • Restore-CvadactoSite -RestoreFolder %HOMEPATH% \ Documents \ Citrix \ AutoConfig/Backup_YYYY_MM_DD_HH_MM_SS -MachineCatalog -IncludeByName « nom du catalogue »
  • Restaurer un groupe de mise à disposition spécifique
    • Restore-CvadactoSite -RestoreFolder %HOMEPATH% \ Documents \ Citrix \ AutoConfig/Backup_YYYY_MM_DD_HH_MM_SS -DeliveryGroups -IncludeByName « nom du groupe de mise à disposition »

Exécution de la restauration

Lancez ACT et entrez la commande « Restaurer » en fonction de ce que vous souhaitez restaurer, soit une restauration complète, soit par composant.

Nous restaurons un seul groupe de mise à disposition dans cet exemple pour montrer à quel point la syntaxe des commandes peut être détaillée et granulaire. Restore-CvadactoSite - Restore le dossier C:\Users\amiringectxadminaz\Documents\Citrix\AutoConfig\Backup_2023_04_14_10_50_31 - DeliveryGroups - IncludeByName « VDI-MANUAL »

Décrivons cette commande pour bien comprendre son fonctionnement. Cela fournit des conseils sur l’utilisation d’autres commutateurs :

  • Restore-CvadActoSite : il s’agit de la commande ou instruction de restauration de base.
  • -RestoreFolder : suivi du nom du dossier. Il appelle le chemin/l’emplacement spécifique des fichiers que nous voulons restaurer.
  • -DeliveryGroups : commutateur utilisé pour spécifier le composant Citrix à migrer.
  • -IncludeByName : Spécifiez une seule ressource à migrer à l’aide de cette commande (ajoutez suffix/préfixe pour restaurer plusieurs ressources portant des noms similaires).

Une demande rapide vous demandant de « confirmer » si vous souhaitez continuer.

  • Tapez OUI pour continuer.

Restauration d'ACT

L’ACT lance le processus en contactant le dossier de sauvegarde que vous avez spécifié dans la commande, suivi du composant spécifique (groupe de mise à disposition, dans cet exemple). ACT lit et extrait les informations existantes dans le fichier DeliveryGroups.yml, comme illustré ci-dessous :

Groupe de mise en œuvre ACT 1

Groupe de mise en œuvre ACT 2

Résultat final

Une fois qu’ACT a terminé d’exécuter le processus de restauration, il génère un fichier journal contenant les détails de ce qui a été fait et une liste de recommandations en cas de problème. Ci-dessous, vous pouvez voir le contenu du fichier journal.

Fichier journal ACT 1

Fichier journal ACT 2

Depuis la console Citrix Web Studio, cliquez sur le bouton Actualiser dans le coin supérieur droit pour actualiser la console et afficher les composants restaurés.

  • Cliquez sur « Actualiser » sur la console Citrix Web Studio.
  • Le processus de restauration est terminé.

Studio Web ACT 2

Résumé

Ce guide vous a expliqué comment configurer la structure des dossiers ACT, modifier la configuration sur site, créer une sauvegarde et effectuer une restauration. Pour en savoir plus sur les applets de commande Citrix Automated Configuration Tool, consultez la documentation produit de l’ Automated Configuration Tool

Guide PoC : Outil de configuration automatique - Sauvegarde et restauration sur site