Citrix Virtual Apps and Desktops Service

Migrer vers le cloud

Si vous disposez d’une configuration Citrix Virtual Apps and Desktops locale et que vous souhaitez la déplacer vers un déploiement Citrix Virtual Apps and Desktops Service, que vous souhaitez sauvegarder et restaurer votre déploiement Citrix Virtual Apps and Desktops Service, que vous souhaitez déplacer votre déploiement Citrix Virtual Apps and Desktops Service vers une autre région ou que vous avez atteint vos limites de ressources, vous pouvez désormais migrer tout ou partie de votre configuration à l’aide de l’outil de configuration automatisée Citrix.

La vidéo suivante (2 minutes) fournit un aperçu rapide de la configuration automatisée.

Icône vidéo

Pour plus d’informations sur la configuration automatisée, reportez-vous à la section Preuve de concept : Outil de configuration automatisée sur Tech Zone.

Pour un aperçu plus approfondi du déplacement de votre déploiement et de la préparation de votre configuration pour la migration, reportez-vous à Guide de déploiement : Migration de Citrix Virtual Apps and Desktops depuis une version locale vers Citrix Cloud sur Tech Zone.

Premiers pas avec la configuration automatisée

L’outil de configuration automatisée pour Citrix Virtual Apps and Desktops vous permet d’automatiser la migration de votre déploiement Citrix Virtual Apps and Desktops Service depuis :

La configuration automatisée exporte les informations de votre configuration dans un ensemble de fichiers .yml qui peuvent ensuite être éventuellement modifiés (pour préparer votre migration) et importés dans votre déploiement Citrix Virtual Apps and Desktops Service.

Cette section fournit les détails nécessaires à l’exécution des fonctions de la configuration automatisée.

Télécharger l’outil de configuration automatisée

Téléchargez et installez l’outil de configuration automatisée à partir de Téléchargements de Citrix.

Important :

Pour éviter les erreurs de fonctionnalité, vous devez toujours utiliser la dernière version disponible de la configuration automatisée.

Mise à niveau de la configuration automatisée

Lorsque vous exécutez des applets de commande qui accèdent au cloud dans Configuration automatisée, l’outil vous avertit lorsqu’une version plus récente est disponible.

Mise à niveau de Configuration automatique

Vous pouvez vous assurer que vous disposez de la dernière version en suivant les étapes ci-dessous :

  1. Double-cliquez sur l’icône Config automatique. Une fenêtre PowerShell s’affiche.
  2. Exécutez la commande suivante pour vérifier votre numéro de version.

    Get-CvadAcStatus

  3. Vérifiez la version de votre outil par rapport à la version répertoriée dans l’alerte ou sur Téléchargements de Citrix. La dernière version de l’outil se trouve sur cette page.
  4. Téléchargez et installez la dernière version de l’outil. Il n’est pas nécessaire de désinstaller l’ancienne version pour mettre à niveau Configuration automatisée.

Remarque :

L’alerte apparaît chaque fois que vous exécutez une cmdlet qui accède au cloud. Pour plus d’informations sur les applets de commande, voir Applets de commande de l’outil de configuration automatisée.

Conditions préalables à la migration de votre configuration

Les utilisateurs de la configuration automatisée doivent posséder les compétences suivantes :

  • Configuration et administration de Citrix Virtual Apps and Desktops
  • Norme YAML
  • PowerShell

Pour exporter votre configuration à partir de Citrix Virtual Apps and Desktops :

  • Citrix Virtual Apps and Desktops : version actuelle et précédente ou Citrix Virtual Apps and Desktops, XenApp et XenDesktop LTSR : toutes les versions
  • Un Delivery Controller sur site et au moins un VDA local unique
  • Une machine avec .NET Framework 4.7.2 ou version ultérieure
  • Une machine avec le kit de développement logiciel Citrix PowerShell. Ceci est automatiquement installé sur le Delivery Controller. (Pour s’exécuter sur une machine autre que le Delivery Controller local, la machine doit être jointe au domaine et Citrix Studio doit être installé, car Studio installe les composants logiciels enfichables PowerShell appropriés. Le programme d’installation de Studio se trouve sur le support d’installation de Citrix Virtual Apps and Desktops.)

Pour importer votre configuration dans Citrix Virtual Apps and Desktops Service :

  • Une machine avec accès à Citrix Cloud. Il n’est pas nécessaire que ce soit un Delivery Controller ou une machine jointe à un domaine.
  • Citrix Virtual Apps and Desktops Service provisionné.
  • Emplacement de ressources actif, avec Connector installé et joint au même domaine que l’installation locale.
  • La connectivité aux sites accédant à Citrix Cloud doit être autorisée et disponible. Pour plus d’informations, consultez Connectivité du service Virtual Apps and Desktops.

Objets pris en charge pour la migration

La configuration automatisée prend en charge les composants suivants.

  • Balises
  • Administrateur délégué
    • Étendues
    • Rôles
  • Connexions hôte
    • Un pool de ressources unique
    • Étendues d’administration
  • Catalogues de machines
    • Étendues d’administration
    • Machines
    • Accès PC distant, physiques, groupées, provisionnées (sauf MCS), attribuées
  • Groupes de mise à disposition
    • Stratégie d’accès
    • Association des étendues administrateur
    • Stratégie d’accès aux applications
    • Stratégie d’attribution
    • Stratégie de droit/bureau
    • Programmations d’alimentation
    • Attente de session
    • Pré-démarrage de session
    • Programmes de redémarrage
    • Balises
  • Groupes d’applications
    • Association des étendues administrateur
    • Groupes de mise à disposition
    • Utilisateurs et groupes
  • Applications
    • Dossiers d’application
    • Icônes
    • Applications
    • FTA configurées par le broker
    • Balises
  • Stratégies de groupe

Dépendance des composants

Lors de la création d’un site local, les étapes de création doivent être suivies dans un ordre spécifique, en raison des dépendances des éléments précédents. La configuration automatisée fonctionne selon les mêmes principes.

Le processus d’importation est conçu pour effectuer les mises à jour appropriées, effectuer uniquement les mises à jour nécessaires et vérifier que toutes les mises à jour ont été correctement effectuées.

Les composants doivent être importés dans un ordre qui crée des dépendances dans l’ordre dans lequel elles sont nécessaires. La liste suivante identifie les composants sélectionnables dans les commandes Export, Import, Merge, New, Sync et Restore. Ils sont répertoriés dans leur ordre de dépendance. L’importation dans un autre ordre peut entraîner l’échec de l’opération.

  1. Balises
  2. Rôles et étendues d’administration (inclut les étendues et les rôles, n’inclut pas les administrateurs)
  3. Connexions hôte
  4. Catalogues de machines
  5. Groupes de mise à disposition (inclut StoreFront)
  6. Groupes d’applications
  7. Applications (inclut les dossiers d’application)
  8. Stratégies de groupe

Les composants doivent être importés dans un ordre qui crée des dépendances dans l’ordre dans lequel elles sont nécessaires. L’outil de configuration automatisée place les composants dans l’ordre correct lors de l’importation, de la fusion ou de la restauration de plusieurs composants avec une seule exécution de l’applet de commande.

Lors de l’importation de composants uniques avec plusieurs commandes, il est nécessaire de placer les composants afin que les dépendances soient importées dans l’ordre requis.

Des importations individuelles peuvent être effectuées pour des mises à jour après l’importation réussie d’une configuration de site complète.

Détails sur les dépendances

Les composants et leurs dépendances sont répertoriés ici. Les dépendances d’un composant doivent être en place avant qu’il puisse être importé ou fusionné. Si une dépendance est manquante, cela peut entraîner l’échec de la commande d’importation ou de fusion. La section Fixups du fichier journal affiche les dépendances manquantes en cas d’échec d’une importation ou d’une fusion.

  1. Balises
    • Aucune pré-dépendance
  2. Administrateur délégué
    • Aucune pré-dépendance
  3. Connexions hôte
    • Informations de sécurité dans CvadAcSecurity.yml
  4. Catalogues de machines
    • Machines présentes dans Active Directory
    • Connexions hôte
    • Balises
  5. Groupes de mise à disposition
    • Machines présentes dans Active Directory
    • Utilisateurs présents dans Active Directory
    • Catalogues de machines
    • Balises
  6. Groupes d’applications
    • Groupes de mise à disposition
    • Balises
  7. Applications
    • Groupes de mise à disposition
    • Groupes d’applications
    • Balises
  8. Stratégies de groupe
    • Groupes de mise à disposition
    • Balises

Limitations connues

Génération des ID client et de la clé secrète

Les étapes suivantes vous permettent de récupérer l’ID client et de créer l’ID client et la clé secrète nécessaires pour importer votre configuration dans Citrix Cloud. Toutes les applets de commande accédant au cloud nécessitent ces valeurs.

Pour récupérer l’ID client, procédez comme suit :

  1. Connectez-vous à votre compte Citrix Cloud et sélectionnez le client.

    ID client image 1

  2. Cliquez sur le menu hamburger, puis sélectionnez Gestion des identités et des accès dans le menu déroulant.

    ID client image 2

  3. L’ID client se trouve sur la page Gestion des identités et des accès.

    ID client image 35

Pour récupérer l’ID client et la clé secrète :

  1. Sur la page Gestion des identités et des accès, cliquez sur l’onglet Accès aux API.

    ID client image 3

  2. Entrez un nom dans la zone. Ce nom est utilisé pour différencier plusieurs ID client et clés secrètes. Cliquez sur Créer un client pour créer l’ID client et la clé secrète.

    ID client image 4

  3. La boîte de dialogue suivante s’affiche lorsque vous avez réussi à créer l’ID client et la clé secrète. Veillez à copier les deux valeurs dans un emplacement sécurisé ou téléchargez le fichier .csv contenant ces informations.

    ID client image 5

  4. L’ID client et la clé secrète sont créés avec succès.

    ID client image 6

Placez ces valeurs dans un emplacement sécurisé et ne les partagez qu’avec les membres de l’entreprise de confiance qui ont besoin d’accéder à l’outil ou aux API Rest cloud. L’ID client et la clé secrète n’expirent pas. S’ils sont compromis, supprimez-les immédiatement à l’aide de l’icône Corbeille et créez-en de nouveaux.

Remarque :

La clé secrète ne peut pas être récupérée si elle est perdue ou oubliée ; un nouvel ID client et une clé secrète doivent être créés.

Remplissage du fichier d’informations client

L’utilisation du fichier CustomerInfo.yml élimine la nécessité de fournir des paramètres d’informations client lors de l’exécution de chaque applet de commande. Toutes les informations client peuvent être remplacées à l’aide des paramètres de l’applet de commande.

Créez le fichier CustomerInfo.yml à l’aide de l’applet de commande New-CvadAcCustomerInfoFile. New-CvadAcCustomerInfoFile a les paramètres requis suivants.

  • CustomerId : ID client.
  • ClientId : ID client créé sur Citrix Cloud.
  • Secret : secret du client créé sur Citrix Cloud.

New-CvadAcCustomerInfoFile -CustomerId markhof123 -ClientId 6813EEA6-46CC-4F8A-BC71-539F2DAC5984 -Secret TwBLaaaaaaaaaaaaaaaaaw==

Mettez à jour le fichier CustomerInfo.yml à l’aide de l’applet de commande Set-CvadAcCustomerInfoFile.

Remarque :

L’applet de commande modifie uniquement l’ID client.

Set-CvadAcCustomerInfoFile -ClientId C80487EE-7113-49F8-85DD-2CFE30CC398E

Voici un exemple de fichier CustomerInfo.yml.

---
#  Created/Updated on 2020/01/29 16:46:47
CustomerId: "markhof123"
CustomerId: "markhof123"
ClientId: "6713FEA6-46CC-4F8A-BC71-539F2DDK5384"
Secret: "TwBLaaabbbaaaaaaaaaaw=="
LogFileName: "CitrixLog"
Environment: Production
AltRootUrl: ""
StopOnError: False
AlternateFolder: ""
Locale: "en-us"
Editor: “C:\Program Files\Notepad++\notepad++.exe”
Confirm: True
DisplayLog: True

Remplissage du fichier de mappage de zones

Une zone locale est l’équivalent de l’emplacement des ressources cloud. Contrairement aux autres composants du site, vous ne pouvez pas importer automatiquement la zone locale vers le cloud. Elle doit être mappée manuellement à l’aide du fichier ZoneMapping.yml. Des échecs d’importation peuvent se produire si le nom de la zone n’est pas associé à un nom d’emplacement de ressources existant.

Pour les sites locaux n’ayant qu’une zone et les sites cloud qu’un seul emplacement de ressources, l’outil Configuration automatisée établit l’association correcte, éliminant ainsi la nécessité de gérer manuellement le fichier ZoneMapping.yml.

Pour les sites locaux comportant plusieurs zones ou sites cloud ayant plusieurs emplacements de ressources, le fichier ZoneMapping.yml doit être mis à jour manuellement pour refléter le mappage correct des zones locales aux emplacements de ressources cloud. Cette opération doit être effectuée avant de tenter une opération d’importation dans le cloud.

Le fichier ZoneMapping.yml se trouve sous %HOMEPATH%\Documents\Citrix\AutoConfig. Le contenu du fichier .yml est un dictionnaire avec le nom de la zone comme clé et le nom de l’emplacement de ressources comme valeur.

À titre d’exemple, un site Citrix Virtual Apps and Desktops local avec une zone principale appelée « Zone-1 » et une zone secondaire appelée « Zone-2 » est migré vers un déploiement cloud Citrix Virtual Apps and Desktops avec deux emplacements de ressources cloud nouvellement créés appelés « Cloud-RL-1 » et « Cloud-RL-2 ». Dans ce cas, le fichier ZoneMapping.yml serait configuré comme suit :

---
Zone-1: Cloud-RL-1

Zone-2: Cloud-RL-2

Remarque :

Les deux-points et le nom de l’emplacement de ressources doivent être séparés par un espace. Si des espaces sont utilisés dans le nom de la zone ou de l’emplacement des ressources, placez le nom entre guillemets.

Migration d’une configuration locale vers le cloud

La configuration automatisée vous permet d’automatiser le déplacement de votre configuration locale vers un site cloud.

Processus général de la migration

La migration est le processus d’exportation de données à partir d’une source, suivie de l’importation de ces mêmes données dans une cible. La configuration automatisée effectue ce processus. Pour les clients qui migrent vers le cloud à partir d’un environnement local, la source est leur site local et la cible leur site cloud. Dans sa forme la plus simple, le processus de migration lorsqu’il est utilisé pour la première fois se déroule de la façon suivante, avec des exemples d’applets de commande.

  1. Téléchargez et installez l’outil de configuration automatisée.
  2. Exportez les données locales (Export-CvadAcToFile).
  3. Obtenez les informations de sécurité nécessaires pour accéder à votre site cloud.
  4. Créez le fichier d’informations client contenant les informations de sécurité utilisées par l’outil de configuration automatisée (New-CvadAcCustomerInfoFile).
  5. Importez les données locales dans le cloud (Import-CvadAcToSite, Merge-CvadAcToSite, New-CvadAcToSite).

Les migrations successives sont encore plus simples.

  1. Exportez les données locales (Export-CvadAcToFile).
  2. Importez les données locales dans le cloud (Import-CvadAcToSite, Merge-CvadAcToSite, New-CvadAcToSite).

Les étapes qui précèdent peuvent même être réduites à une seule.

  1. Exportation et importation (Sync-CvadAcSiteToSite).

Exportation de votre configuration locale Citrix Virtual Apps and Desktops

Important :

  • Vous devez inclure votre fichier CustomerInfo.yml avec vos ID client et les informations de clé secrète. Pour savoir comment récupérer vos ID client et de votre clé secrète, reportez-vous à la section Génération des ID client et de la clé secrète. Pour plus d’informations sur l’ajout de ces informations au fichier CustomerInfo.yml, reportez-vous à la section Remplissage du fichier d’informations client.
  • Le fichier ZoneMapping.yml doit inclure des informations qui mappent votre zone locale aux emplacements de ressources dans le cloud. Pour savoir comment mapper vos zones, reportez-vous à la section Remplissage du fichier de mappage de zones.
  • Si vous disposez de connexions hôtes, vous devez entrer les informations correspondantes dans le fichier CvadAcSecurity.yml.
  1. Installer la configuration automatisée.
  2. Double-cliquez sur l’icône Config automatique. Une fenêtre PowerShell s’affiche.
  3. Exécutez la commande suivante pour exporter tous les composants.

    Export-CvadAcToFile

Après avoir exécuté une applet de commande pour la première fois, un dossier d’exportation contenant les journaux et les fichiers de configuration .yml est créé. Le dossier se trouve sous %HOMEPATH%\Documents\Citrix\AutoConfig. Chaque exportation successive crée un sous-dossier. Le dossier parent %HOMEPATH%\Documents\Citrix\AutoConfig contient toujours les fichiers exportés au cours de l’exportation la plus récente.

Remarque :

Si la configuration automatisée n’est pas installée sur le Delivery Controller, exécutez import-module Citrix.AutoConfig.Commands avant d’utiliser l’outil via PowerShell. Cette étape n’est pas nécessaire si vous ouvrez Configuration automatisée à l’aide de l’icône Config automatique.

Si vous rencontrez des erreurs ou des exceptions, consultez la section Fixups du fichier journal.

Importation de votre configuration vers Citrix Virtual Apps and Desktops Service

Important :

  • Vous devez inclure votre fichier CustomerInfo.yml avec vos ID client et les informations de clé secrète. Pour savoir comment récupérer vos ID client et de votre clé secrète, reportez-vous à la section Génération des ID client et de la clé secrète. Pour plus d’informations sur l’ajout de ces informations au fichier CustomerInfo.yml, reportez-vous à la section Remplissage du fichier d’informations client.
  • Le fichier ZoneMapping.yml doit inclure des informations qui mappent votre zone locale aux emplacements de ressources dans le cloud. Pour savoir comment mapper vos zones, reportez-vous à la section Remplissage du fichier de mappage de zones.
  • Si vous disposez de connexions hôtes, vous devez entrer les informations correspondantes dans le fichier CvadAcSecurity.yml.

Exécution d’une importation

  1. Double-cliquez sur l’icône Config automatique. Une fenêtre PowerShell s’affiche.
  2. Exécutez la commande suivante pour importer tous les composants.

    Merge-CvadAcToSite

Comparez l’état attendu avec le nouvel état actuel. Diverses options d’importation contrôlent si les résultats d’importation sont identiques ou un sous-ensemble du site local. Voir Résultats de l’état dérivé par commande pour une explication des options et du résultat.

Après l’exécution de l’applet de commande, un dossier d’exportation contenant les journaux et les fichiers de configuration .yml est créé. Le dossier se trouve sous %HOMEPATH%\Documents\Citrix\AutoConfig.

Si vous rencontrez des erreurs ou des exceptions, consultez la section Fixups du fichier journal.

Remarque :

Si la configuration automatisée n’est pas installée sur le Delivery Controller, exécutez import-module Citrix.AutoConfig.Commands avant d’utiliser l’outil via PowerShell. Cette étape n’est pas nécessaire si vous ouvrez Configuration automatisée à l’aide de l’icône Config automatique.

Pour revenir à votre configuration d’origine de Citrix Virtual Apps and Desktops Service, reportez-vous à la section Sauvegarde de la configuration de votre service Citrix Virtual Apps and Desktops.

Opération d’importation en détail

Le processus d’importation est conçu pour effectuer les mises à jour appropriées, appliquer uniquement les mises à jour nécessaires et vérifier que toutes les mises à jour ont été correctement effectuées. Vous trouverez ci-dessous les étapes de toutes les opérations d’importation.

  1. Consultez le fichier .yml exporté (état attendu).
  2. Consultez le cloud (état actuel).
  3. Sauvegardez l’état du cloud avant importation dans les fichiers .yml (la pré-sauvegarde peut être restaurée si nécessaire).
  4. Évaluez les différences entre l’état attendu et l’état actuel. Cela détermine les mises à jour à effectuer.
  5. Effectuez les mises à jour.
  6. Consultez de nouveau le cloud (nouvel état actuel).
  7. Sauvegardez l’état du cloud post-importation dans les fichiers .yml (la post-sauvegarde peut être restaurée si nécessaire).
  8. Comparez le nouvel état actuel avec l’état attendu.
  9. Générez un rapport des résultats de la comparaison.

Activation des sites

Remarque :

Cette fonctionnalité est disponible uniquement sur les versions 2.0 et ultérieures. Vérifiez votre version en utilisant Get-CvadAcStatus dans la configuration automatisée.

Le Delivery Controller dans les sites locaux et dans le cloud contrôle les ressources telles que la négociation des bureaux, des applications et le redémarrage des machines. Des problèmes se produisent lorsqu’un ensemble commun de ressources est contrôlé par deux sites ou plus. Une telle situation peut se produire lors de la migration d’un site local vers un site cloud. Il est possible pour les Delivery Controller locaux et cloud de gérer le même ensemble de ressources. Avec une telle double gestion, les ressources peuvent devenir indisponibles et ingérables, ce qui peut être difficile à diagnostiquer.

L’activation de site vous permet de contrôler l’endroit où le site actif est contrôlé.

L’activation du site est gérée en utilisant le mode de maintenance du groupe de mise à disposition Les groupes de mise à disposition sont placés en mode maintenance lorsque le site est inactif. Le mode de maintenance est supprimé des groupes de mise à disposition pour les sites actifs.

  • Set-CvadAdSiteActiveStateCloud
  • Set-CvadAdSiteActiveStateOnPrem

Toutes les applets de commande prennent en charge le filtrage IncludeByName et ExcludeByName.

Importation et transfert du contrôle vers le cloud

Vous trouverez ci-dessous une description générale sur la façon d’importer et de transférer le contrôle du site local vers le site cloud.

  1. Exportez et importez le site local dans le cloud. Assurez-vous que le paramètre –SiteActive n’est présent sur aucune des applets de commande d’importation. Le site local est actif et le site cloud inactif. Par défaut, les groupes de mise à disposition de sites cloud sont en mode de maintenance.
  2. Vérifiez le contenu et la configuration du cloud.
  3. Pendant les heures creuses, définir le site local sur inactif. Le paramètre –SiteActive doit être absent. Tous les groupes de mise à disposition sur site sont en mode de maintenance.
    • Set-CvadAcSiteActiveStateOnPrem
  4. Définissez le site cloud sur actif. Le paramètre –SiteActive doit être présent. Aucun groupe de mise à disposition de site cloud n’est en mode de maintenance.
    • Set-CvadAcSiteActiveStateCloud –SiteActive
  5. Vérifiez que le site cloud est actif et que le site local est inactif.

Transfert du contrôle vers le site local

Pour transférer le contrôle du site cloud vers le site local :

  1. Pendant les heures creuses, définissez le site cloud sur inactif. Tous les groupes de mise à disposition de sites cloud sont en mode de maintenance.
    • Set-CvadAcSiteActiveStateCloud
  2. Définissez le site local sur actif. Aucun groupe de mise à disposition local n’est en mode de maintenance.
    • Set-CvadAcSiteActiveStateOnPrem -SiteActive

Migration d’une configuration cloud vers le cloud

La configuration automatisée vous permet d’automatiser le déplacement de votre configuration cloud vers un autre site cloud ou de restaurer votre propre site cloud.

Le déplacement de votre configuration Citrix Virtual Apps and Desktops Service peut être bénéfique pour de nombreuses raisons :

  • Migration d’une région à une autre
  • Synchronisation de votre site de la phase de test ou de pré-production à la production
  • Atteindre les limites de ressources

Sauvegarde de la configuration de votre service Citrix Virtual Apps and Desktops

Remarque :

Avant de commencer, suivez les étapes d’importation dans Conditions préalables à la migration de votre configuration pour migrer votre configuration d’un cloud à un autre.

Important :

  • Vous devez inclure votre fichier CustomerInfo.yml avec vos ID client et les informations de clé secrète. Pour savoir comment récupérer vos ID client et de votre clé secrète, reportez-vous à la section Génération des ID client et de la clé secrète. Pour plus d’informations sur l’ajout de ces informations au fichier CustomerInfo.yml, reportez-vous à la section Remplissage du fichier d’informations client.
  • Le fichier ZoneMapping.yml doit inclure des informations qui mappent vos emplacements de ressources dans le cloud. Pour savoir comment mapper vos zones, reportez-vous à la section Remplissage du fichier de mappage de zones.
  • Si vous disposez de connexions hôtes, vous devez entrer les informations correspondantes dans le fichier CvadAcSecurity.yml.
  1. Installer la configuration automatisée.

    Remarque :

    Pour la migration d’un cloud à un autre, la configuration automatisée peut être installée sur une machine ayant accès à Internet à laquelle l’administrateur a un accès direct.

  2. Double-cliquez sur l’icône Config automatique. Une fenêtre PowerShell s’affiche.
  3. Exécutez la commande suivante pour effectuer une sauvegarde.

    Backup-CvadAcToFile

Après avoir exécuté une applet de commande pour la première fois, un dossier d’exportation contenant les journaux et les fichiers de configuration .yml est créé. Le dossier se trouve sous %HOMEPATH%\Documents\Citrix\AutoConfig.

Si vous rencontrez des erreurs ou des exceptions, consultez la section Fixups du fichier journal.

Restauration de votre configuration dans Citrix Virtual Apps and Desktops Service

Remarque :

Cette section suit la procédure Sauvegarde de la configuration de votre service Citrix Virtual Apps and Desktops et les étapes qui y sont documentées. Suivez ces étapes avant de commencer la restauration.

Exécution d’une restauration

  1. Double-cliquez sur l’icône Config automatique. Une fenêtre PowerShell s’affiche.
  2. Exécutez la commande suivante pour effectuer une restauration.

    Restore-CvadAcToSite -RestoreFolder <folder path of the backup files>

Comparez l’état attendu avec le nouvel état actuel.

Après l’exécution de l’applet de commande, un dossier d’exportation contenant les journaux et les fichiers de configuration .yml est créé. Le dossier se trouve sous %HOMEPATH%\Documents\Citrix\AutoConfig.

Si vous rencontrez des erreurs ou des exceptions, consultez la section Fixups du fichier journal.

Activation des sites

L’activation de site vous permet de contrôler l’endroit où le site actif est contrôlé. Pour plus d’informations sur l’activation de sites, reportez-vous à la section Activation des sites.

Sauvegarde et restauration

Le processus de sauvegarde et de restauration vous protège contre les modifications ou la corruption involontaires de la configuration du site cloud. Alors que la configuration automatisée effectue des sauvegardes à chaque fois qu’une modification est apportée, cette sauvegarde reflète l’état de la configuration du site cloud avant les modifications. Pour vous protéger, vous devez sauvegarder périodiquement la configuration de votre site cloud et l’enregistrer dans un endroit sûr. Si une modification ou une corruption indésirable a lieu, la sauvegarde peut être utilisée pour corriger la modification ou la corruption à un niveau granulaire ou complet de configuration du site.

Sauvegarde

Pour sauvegarder, exécutez l’applet de commande de sauvegarde Backup-CvadAcToFile

Bien que des composants individuels puissent être sélectionnés lors de la sauvegarde, Citrix suggère de sauvegarder tous les composants. Les sauvegardes sont placées dans un dossier nommé de manière unique sous le dossier racine : %CHEMINDEBASE%\Documents\Citrix\AutoConfig/Backup_yyyy_mm_dd_hh_mm_ss

Restaurer

La restauration peut être effectuée à partir de n’importe quelle sauvegarde pour restaurer un ou plusieurs membres de composant, un ou plusieurs composants ou la configuration complète du site cloud.

Restauration des membres d’un composant

La restauration d’un ou de plusieurs membres de composant utilise la fonction IncludeByName. L’applet de commande Restore est appelée avec le paramètre RestoreFrom ainsi que le composant unique sélectionné et la liste d’inclusion.

Pour restaurer deux stratégies de groupe à partir d’une sauvegarde, suivez l’exemple suivant :

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

-GroupPolicies $true -IncludeByName Policy1,Policy2

Restauration de composants entiers

La restauration d’un composant implique la sélection d’un ou de plusieurs paramètres de composant.

Pour restaurer l’ensemble des composants Groupe de mise à disposition et Catalogue de machines, suivez cet exemple :

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

-DeliveryGroups $true -MachineCatalogs $true

Restauration de l’intégralité de la configuration du site cloud

Restaurer la configuration complète du site cloud signifie que vous sélectionnez tous les composants pour la restauration.

Pour restaurer l’intégralité de la configuration du site cloud, suivez l’exemple suivant :

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

Fusion de plusieurs sites en un seul site

Remarque :

Cette fonctionnalité est disponible uniquement sur les versions 2.0 et ultérieures. Vérifiez votre version en utilisant Get-CvadAcStatus dans la configuration automatisée.

La prise en charge multisite fournit une méthode pour fusionner plusieurs sites locaux en un seul site cloud.

La prise en charge multisite ajoute des préfixes et des suffixes uniques aux noms de composants basés sur chaque site local, garantissant ainsi l’unicité des noms après la fusion de plusieurs sites locaux en un seul site cloud.

Des préfixes et des suffixes peuvent être affectés à chacun des composants suivants pour chaque site.

  • AdminScope
  • AdminRole
  • ApplicationAdmin
  • ApplicationFolder
  • ApplicationGroup
  • ApplicationUser
  • DeliveryGroup
  • GroupPolicy
  • HostConnection
  • MachineCatalog
  • StoreFront
  • Tag

Les dossiers d’application prennent en charge l’ajout de préfixe, de suffixe et le changement de racine. Le changement de racine ajoute un dossier de niveau supérieur supplémentaire à la structure de dossiers existante d’une application.

Règles d’ajout de préfixe et de suffixe

  1. Les préfixes et les suffixes ne peuvent contenir aucun des caractères spéciaux suivants : \ , / ; : # . * ? = < > | ( ) " ' { } [ ]
  2. Les préfixes et les suffixes peuvent contenir des espaces de fin mais pas des espaces de début.
  3. Les préfixes et les suffixes doivent être placés entre guillemets pour pouvoir contenir des espaces de fin.
  4. Les préfixes et les suffixes sont appliqués au moment de l’importation, de la fusion et de l’ajout. Les fichiers .yml source ne sont jamais modifiés.
  5. Le processus ajoute automatiquement des préfixes et des suffixes aux noms de composants dépendants le cas échéant. Par exemple, si les noms de catalogue de machines sont préfixés par « East », les groupes de mise à disposition qui les référencent sont également préfixés par « East ».
  6. Si un nom de composant commence déjà par le préfixe ou le suffixe, aucun préfixe ou suffixe n’est ajouté. Les noms de composants ne peuvent pas contenir de préfixes ou de suffixes doubles identiques.
  7. Les préfixes et les suffixes peuvent être utilisés individuellement ou combinés.
  8. L’utilisation d’un préfixe ou d’un suffixe sur un composant est facultative.

Remarque :

L’interface Configuration complète affiche les composants par ordre alphabétique.

Grouper par site

Utilisez un préfixe pour regrouper visuellement les composants d’un seul site. Chaque site est répertorié dans son propre groupe avec préfixe appliqué par ordre alphabétique pour contrôler l’ordre des différents groupes de sites.

Grouper par nom

Utilisez un suffixe pour regrouper visuellement des composants de nom similaire dans plusieurs sites. Les composants de même nom provenant de différents sites alternent visuellement.

Fichier SitePrefixes.yml

Pour les préfixes de site, le processus commence par le fichier SiteMerging.yml qui contient le mappage de préfixe et de suffixe pour un ou plusieurs sites locaux. Vous pouvez gérer le fichier SiteMerging.yml manuellement ou à l’aide des applets de commande disponibles répertoriées dans la section Applets de commande de fusion de sites.

Exportation, importation, fusion et ajout

La fusion ne peut pas commencer tant que vous n’avez pas exporté un site local. Pour exporter un site local, reportez-vous à la section Migration d’une configuration locale vers le cloud.

Dossier cible central pour l’exportation

Les méthodes décrites dans cette section placent plusieurs exportations de sites dans un emplacement central de partage de fichiers. Le fichier SiteMerging.yml, le fichier CustomerInfo.yml et tous les fichiers d’exportation résident dans cet emplacement de partage de fichiers, ce qui vous permet d’effectuer l’importation à partir d’un emplacement indépendant des sites locaux.

Les opérations d’accès au cloud ne font jamais référence aux sites locaux ou à Active Directory, ce qui vous permet d’effectuer des opérations d’accès au cloud depuis n’importe où.

Partage direct de fichiers

Les opérations d’exportation, d’importation, de fusion et de création/ajout fournissent un paramètre pour utiliser un dossier cible ou source autre que le dossier par défaut, %HOMEPATH%\Documents\Citrix\AutoConfig. Les exemples suivants utilisent un partage de fichiers central situé sur \\share.central.net auquel l’administrateur a déjà accès, après avoir fourni des informations d’identification si nécessaire.

Pour effectuer l’exportation vers un dossier cible spécifique au site, utilisez le paramètre –TargetFolder :

Depuis le DDC East :

mkdir \\share.central.net\AutoConfig\SiteEast

Export-CvadAcToFile –TargetFolder \\share.central.net\AutoConfig\SiteEast

Depuis le DDC West :

mkdir \\share.central.net\AutoConfig\SiteWest

Export-CvadAcToFile –TargetFolder \\share.central.net\AutoConfig\SiteWest

Une fois les exportations terminées, créez les fichiers CustomerInfo.yml et SiteMerging.yml et placez-les dans \\share.central.net\AutoConfig.

Remarque :

N’utilisez pas le paramètre SiteRootFolder lors de la création de SitePrefixes.yml si vous utilisez cette méthode de référence de partage de fichiers direct.

Pour importer, fusionner ou ajouter à partir du partage de fichiers direct, vous devez décider de la machine à partir de laquelle vous souhaitez effectuer l’opération d’accès au cloud. Les options sont les suivantes :

  • Un des DDC locaux où l’outil est déjà installé.
  • La machine hébergeant le partage de fichiers.
  • Une autre machine.

La configuration automatisée doit être installée sur la machine accédant au cloud. Ni le SDK PowerShell local, ni le DDC, ni Active Directory ne sont utilisés, de sorte que les exigences d’accès au cloud sont plus simples que les exigences d’exportation.

Pour fusionner le DDC East sur le cloud :

Merge-CvadAcToSite –SiteName East –SourceFolder \\share.central.net\AutoConfig\SiteEast -CustomerInfoFileSpec \\share.central.net\AutoConfig\CustomerInfo.yml

Pour fusionner le DDC West sur le cloud :

Merge-CvadAcToSite –SiteName West –SourceFolder \\share.central.net\AutoConfig\SiteWest -CustomerInfoFileSpec \\share.central.net\AutoConfig\CustomerInfo.yml

Voici un exemple de fichier SitePrefixes.yml basé sur l’exemple précédent.

East:
  SiteRootFolder: "" # Important: leave this empty
  AdminScopePrefix: "East_"
  AdminRolePrefix: "East_"
  ApplicationAdminPrefix: "East_"
  ApplicationFolderPrefix: "" # Note that a new parent root folder is used instead
  ApplicationFolderRoot: "East"
  ApplicationGroupPrefix: "East_"
  ApplicationUserPrefix: "East_"
  DeliveryGroupPrefix: "East_"
  GroupPolicyPrefix: "East_"
  HostConnectionPrefix: "East_"
  MachineCatalogPrefix: "East_"
  StoreFrontPrefix: "East_"
  TagPrefix: "East_"
  AdminScopeSuffix: "_east"
  AdminRoleSuffix: "_east"
  ApplicationAdminSuffix: "_east"
  ApplicationFolderSuffix: "_east"
  ApplicationGroupSuffix: "_east"
  ApplicationUserSuffix: "_east"
  DeliveryGroupSuffix: "_east"
  GroupPolicySuffix: "_east"
  HostConnectionSuffix: "_east"
  MachineCatalogSuffix: "_east"
  StoreFrontSuffix: "_east"
  TagSuffix: "_east"
West:
  SiteRootFolder: "" # Important: leave this empty
  AdminScopePrefix: "Western "
  AdminRolePrefix: "Western "
  ApplicationAdminPrefix: "Western "
  ApplicationFolderPrefix: "" # Note that a new parent root folder is used instead
  ApplicationFolderRoot: "Western"
  ApplicationGroupPrefix: "Western "
  ApplicationUserPrefix: "Western "
  DeliveryGroupPrefix: "Western "
  GroupPolicyPrefix: "Western "
  HostConnectionPrefix: "Western "
  MachineCatalogPrefix: "Western "
  StoreFrontPrefix: "Western "
  TagPrefix: "Western "
  AdminScopeSuffix: ""
  AdminRoleSuffix: ""
  ApplicationAdminSuffix: ""
  ApplicationFolderSuffix: ""
  ApplicationGroupSuffix: ""
  ApplicationUserSuffix: ""
  DeliveryGroupSuffix: ""
  GroupPolicySuffix: ""
  HostConnectionSuffix: ""
  MachineCatalogSuffix: ""
  StoreFrontSuffix: ""
  TagSuffix: ""

Référence de partage de fichiers à l’aide de SiteMerging.yml

Cette méthode utilise le membre SiteRootFolder du jeu de préfixes du site. Bien qu’elle soit plus impliquée que la méthode de partage de fichiers direct, cette méthode réduit les chances de cibler le mauvais dossier lors de l’exportation, de l’importation, de la fusion ou de l’ajout.

Tout d’abord, définissez le SiteRootFolder pour chaque site dans le fichier SiteMerging.yml. Vous devez le faire sur l’emplacement partagé.

Set-CvadAcSitePrefixes –SiteName East –SiteRootFolder \\share.central.net\AutoConfig\SiteEast -SitePrefixesFolder \\share.central.net\AutoConfig

Set-CvadAcSitePrefixes –SiteName West –SiteRootFolder SiteWest -SitePrefixesFolder \\share.central.net\AutoConfig

Dans cet exemple, East est une spécification de dossier complète et West est une spécification de dossier relative.

Pour utiliser un dossier d’exportation cible spécifique au site à l’aide du fichier SiteMerging.yml :

Depuis le DDC East :

mkdir \\share.central.net\AutoConfig\SiteEast

Export-CvadAcToFile -SiteName East -CustomerInfoFileSpec \\share.central.net\AutoConfig\CustomerInfo.yml

Depuis le DDC West :

mkdir \\share.central.net\AutoConfig\SiteWest

Export-CvadAcToFile -SiteName West -CustomerInfoFileSpec \\share.central.net\AutoConfig\CustomerInfo.yml

L’applet de commande d’exportation utilise l’emplacement du dossier CustomerInfo.yml pour localiser le fichier SiteMerging.yml. Dans le cas du dossier East, la spécification SiteRootFolder est complète. Elle est utilisée telle quelle. Dans le cas du dossier West, la spécification SiteRootFolder n’est pas complète. Elle est combinée avec l’emplacement du dossier CustomerInfo.yml pour récupérer un emplacement de dossier complet pour West.

Pour fusionner le DDC East sur le cloud :

Merge-CvadAcToSite –SiteName East -CustomerInfoFileSpec \\share.central.net\AutoConfig\CustomerInfo.yml

Pour fusionner le DDC West sur le cloud :

Merge-CvadAcToSite –SiteName West -CustomerInfoFileSpec \\share.central.net\AutoConfig\CustomerInfo.yml

Voici un exemple de fichier SitePrefixes.yml basé sur l’exemple précédent.

East:
  SiteRootFolder: "\\\share.central.net\AutoConfig\SiteEast"
  AdminScopePrefix: "East_"
  AdminRolePrefix: "East_"
  ApplicationAdminPrefix: "East_"
  ApplicationFolderPrefix: "" # Note that a new parent root folder is used instead
  ApplicationFolderRoot: "East"
  ApplicationGroupPrefix: "East_"
  ApplicationUserPrefix: "East_"
  DeliveryGroupPrefix: "East_"
  GroupPolicyPrefix: "East_"
  HostConnectionPrefix: "East_"
  MachineCatalogPrefix: "East_"
  StoreFrontPrefix: "East_"
  TagPrefix: "East_"
  AdminScopeSuffix: "_east"
  AdminRoleSuffix: "_east"
  ApplicationAdminSuffix: "_east"
  ApplicationFolderSuffix: "_east"
  ApplicationGroupSuffix: "_east"
  ApplicationUserSuffix: "_east"
  DeliveryGroupSuffix: "_east"
  GroupPolicySuffix: "_east"
  HostConnectionSuffix: "_east"
  MachineCatalogSuffix: "_east"
  StoreFrontSuffix: "_east"
  TagSuffix: "_east"
West:
  SiteRootFolder: "\\\share.central.net\AutoConfig\SiteWest"
  AdminScopePrefix: "Western "
  AdminRolePrefix: "Western "
  ApplicationAdminPrefix: "Western "
  ApplicationFolderPrefix: "" # Note that a new parent root folder is used instead
  ApplicationFolderRoot: "Western"
  ApplicationGroupPrefix: "Western "
  ApplicationUserPrefix: "Western "
  DeliveryGroupPrefix: "Western "
  GroupPolicyPrefix: "Western "
  HostConnectionPrefix: "Western "
  MachineCatalogPrefix: "Western "
  StoreFrontPrefix: "Western "
  TagPrefix: "Western "
  AdminScopeSuffix: ""
  AdminRoleSuffix: ""
  ApplicationAdminSuffix: ""
  ApplicationFolderSuffix: ""
  ApplicationGroupSuffix: ""
  ApplicationUserSuffix: ""
  DeliveryGroupSuffix: ""
  GroupPolicySuffix: ""
  HostConnectionSuffix: ""
  MachineCatalogSuffix: ""
  StoreFrontSuffix: ""
  TagSuffix: ""

Si aucune méthode de partage de fichiers central n’est utilisée et que l’importation, la fusion ou l’ajout est effectué à partir de DDC individuels, créez et répliquez le fichier SiteMerging.yml sur chaque DDC en cours de migration vers le cloud. L’emplacement par défaut est %HOMEPATH%\Documents\Citrix\AutoConfig. Vous devez spécifier le paramètre –SiteName pour sélectionner les préfixes de site corrects.

Fusionner les sites

Citrix recommande d’effectuer les opérations cloud par étapes et de procéder à un examen complet de chaque résultat avant d’effectuer la prochaine opération cloud. Par exemple, si vous fusionnez trois sites vers un seul site cloud :

  1. Fusionnez le site initial sur le cloud à l’aide de la valeur SiteName appropriée.
  2. Passez en revue les résultats dans Studio (local ou Web).
  3. Si les résultats sont incorrects, déterminez le problème et sa cause, corrigez-le, puis relancez la fusion. Si nécessaire, supprimez les composants cloud et commencez à partir de zéro en utilisant Remove-CvadAcFromSite pour le composant et les membres sélectionnés. Si les résultats sont corrects, continuez.
  4. Si la fusion initiale est correcte, fusionnez le deuxième site sur le site cloud unique.
  5. Répétez les étapes 2 et 3.
  6. Si la deuxième fusion est correcte, fusionnez le troisième site sur le site cloud unique.
  7. Répétez les étapes 2 et 3.
  8. Examinez les ressources du point de vue de l’utilisateur et vérifiez que la vue est à l’état souhaité.

Supprimer un composant à l’aide du préfixe de site

Vous pouvez supprimer certains composants de site unique à l’aide du préfixe du paramètre –IncludeByName de l’applet de commande Remove-CvadAcFromSite. Dans l’exemple suivant, les groupes de mise à disposition DDC West ne sont pas corrects. Pour supprimer les groupes de mise à disposition uniquement pour le site West :

Remove-CvadAcFromSite –DeliveryGroups –IncludeByName “Western *”

Pour supprimer tous les composants West, exécutez les applets de commande suivantes dans l’ordre indiqué.

Remove-CvadAcFromSite –GroupPolicies –IncludeByName “Western *”

Remove-CvadAcFromSite –Applications –IncludeByName “Western *”

Remove-CvadAcFromSite – ApplicationGroups –IncludeByName “Western *”

Remove-CvadAcFromSite –DeliveryGroups –IncludeByName “Western *”

Remove-CvadAcFromSite –MachineCatalogs –IncludeByName “Western *”

Remove-CvadAcFromSite –HostConnections –IncludeByName “Western *”

Remove-CvadAcFromSite –Tags –IncludeByName “Western *”

Pour supprimer les stratégies de groupe des composants East, utilisez le suffixe :

Remove-CvadAcFromSite –GroupPolicies –IncludeByName “*_east”

Applets de commande de l’outil de configuration automatisée

Applets de commande de la gestion de site

  • Export-CvadAcToFile

    Exporte la configuration à partir de votre configuration locale. Il s’agit de l’opération d’exportation par défaut pour l’outil de configuration automatisée. Aucune modification n’est apportée à la configuration du site local. Les fichiers exportés sont placés dans le répertoire %CHEMINDEBASE%\Documents\Citrix\AutoConfig dans un sous-dossier Export à nom unique. Le dossier %HOMEPATH%\Documents\Citrix\AutoConfig contient toujours la dernière configuration de site local exportée.

    Paramètres :

    • Consultez la section Paramètres de sélection des composants.
    • Consultez la section Filtrage par noms d’objets.
    • TargetFolder - spécifie le dossier de destination de l’exportation.
    • Locale - spécifie la langue du texte lisible qui peut être exporté.
    • Quiet - supprime la journalisation sur la console (disponible uniquement sur version 2.0 ou ultérieure).
    • AdminAddress - spécifie le DNS ou l’adresse IP du Delivery Controller lorsque l’exportation n’est pas exécutée sur le Delivery Controller.
    • CheckUserAndMachines - vérifie si les utilisateurs et les machines sont dans Active Directory. Les utilisateurs et les machines qui ne sont pas dans Active Directory peuvent entraîner des échecs d’importation.

    Renvoie :

  • Import-CvadAcToSite

    Importe tous les fichiers locaux dans le cloud. Cette commande garantit que l’état final du cloud est identique à l’état local. Cette option supprime toutes les modifications qui existent dans le cloud. Les fichiers de configuration de site importés proviennent de %CHEMINDEBASE%\Documents\Citrix\AutoConfig. Utilisez cette commande avec prudence.

    Paramètres :

    • Consultez la section Paramètres de sélection des composants.
    • Consultez la section Filtrage par noms d’objets.
    • Consultez la section Paramètres d’accès au cloud.
    • SourceFolder - identifie un dossier racine de substitution pour %HOMEPATH%\Documents\Citrix\AutoConfig.
    • Locale - spécifie la langue du texte lisible qui peut être exporté.
    • Quiet - supprime la journalisation sur la console (disponible uniquement sur version 2.0 ou ultérieure).
    • DisplayLog - affiche le fichier journal à la fin de l’applet de commande. Définissez sur $false pour supprimer l’affichage du journal.
    • Merge - lorsque cette valeur est définie sur $true, ajoute uniquement des composants au site cloud. Les composants ne sont pas supprimés. Définissez sur $false pour supprimer des composants.
    • AddOnly - lorsque cette option est définie sur $true, ajoute uniquement les nouveaux composants, ne met pas à jour ou ne supprime pas les composants existants. Définissez sur $false pour autoriser les mises à jour et les suppressions. Merge est ignoré lorsque ce paramètre est $true.

    Renvoie :

  • Merge-CvadAcToSite

    Fusionne les fichiers locaux dans le cloud, mais ne supprime aucun composant dans le cloud. Cela préserve les modifications déjà apportées dans le cloud. Si un composant portant le même nom existe dans Citrix Cloud, cette commande peut modifier ce composant. Il s’agit de l’opération d’importation par défaut pour l’outil de configuration automatisée. Les fichiers de configuration de site fusionnés proviennent de %CHEMINDEBASE%\Documents\Citrix\AutoConfig.

    Paramètres :

    • Consultez la section Paramètres de sélection des composants.
    • Consultez la section Filtrage par noms d’objets.
    • Consultez la section Paramètres d’accès au cloud.
    • SourceFolder - identifie un dossier racine de substitution pour %HOMEPATH%\Documents\Citrix\AutoConfig.
    • Locale - spécifie la langue du texte lisible qui peut être exporté.
    • Quiet - supprime la journalisation sur la console (disponible uniquement sur version 2.0 ou ultérieure).
    • DisplayLog - affiche le fichier journal à la fin de l’applet de commande. Définissez sur $false pour supprimer l’affichage du journal.
    • AddOnly - lorsque cette option est définie sur $true, ajoute uniquement les nouveaux composants, ne met pas à jour ou ne supprime pas les composants existants. Définissez sur $false pour autoriser les mises à jour et les suppressions. Merge est ignoré lorsque ce paramètre est $true.

    Renvoie :

  • Restore-CvadAcToSite

    Restaure la configuration précédente du site cloud. Les fichiers importés proviennent du dossier spécifié dans le paramètre -RestoreFolder. Cette commande peut être utilisée pour revenir à votre configuration précédente ou pour sauvegarder et restaurer votre site cloud.

    Paramètres :

    • Consultez la section Paramètres de sélection des composants.
    • Consultez la section Filtrage par noms d’objets.
    • Consultez la section Paramètres d’accès au cloud.
    • RestoreFolder - identifie le dossier contenant les fichiers .yml à restaurer sur le site cloud. La spécification du dossier doit être complète.
    • Locale - spécifie la langue du texte lisible qui peut être exporté.
    • Quiet - supprime la journalisation sur la console (disponible uniquement sur version 2.0 ou ultérieure).
    • DisplayLog - affiche le fichier journal à la fin de l’applet de commande. Définissez sur $false pour supprimer l’affichage du journal.
    • Merge - lorsque cette valeur est définie sur $true, ajoute uniquement des composants au site cloud. Les composants ne sont pas supprimés. Définissez sur $false pour supprimer des composants.
    • AddOnly - lorsque cette option est définie sur $true, ajoute uniquement les nouveaux composants, ne met pas à jour ou ne supprime pas les composants existants. Définissez sur $false pour autoriser les mises à jour et les suppressions. Merge est ignoré lorsque ce paramètre est $true.

    Renvoie :

  • New-CvadAcToSite

    Importe la configuration de site locale dans le cloud, mais ajoute uniquement les nouveaux composants. Les composants de site cloud existants ne sont ni mis à jour ni supprimés. Utilisez cette commande si les composants de site cloud existants doivent rester inchangés.

    Paramètres :

    Renvoie :

  • Sync-CvadAcToSite

    Sync effectue à la fois une exportation et une importation en une seule étape.

    Paramètres :

    • Consultez la section Paramètres de sélection des composants.
    • Consultez la section Filtrage par noms d’objets.
    • Consultez la section Paramètres d’accès au cloud.
    • SourceTargetFolder - spécifie le dossier de destination de l’exportation/importation.
    • Locale - spécifie la langue du texte lisible qui peut être exporté.
    • AdminAddress - spécifie le DNS ou l’adresse IP du Delivery Controller lorsque l’exportation n’est pas exécutée sur le Delivery Controller.
    • Quiet - supprime la journalisation sur la console (disponible uniquement sur version 2.0 ou ultérieure).
    • DisplayLog - affiche le fichier journal à la fin de l’applet de commande. Définissez sur $false pour supprimer l’affichage du journal.
    • Merge - lorsque cette valeur est définie sur $true, ajoute uniquement des composants au site cloud. Les composants ne sont pas supprimés. Définissez sur $false pour supprimer des composants.
    • AddOnly - lorsque cette option est définie sur $true, ajoute uniquement les nouveaux composants, ne met pas à jour ou ne supprime pas les composants existants. Définissez sur $false pour autoriser les mises à jour et les suppressions. Merge est ignoré lorsque ce paramètre est $true.

    Renvoie :

  • Backup-CvadAcToFile

    Exporte votre configuration cloud vers des fichiers .yml. Cette sauvegarde peut être utilisée dans un processus de sauvegarde et de restauration pour restaurer des composants perdus.

    Paramètres :

    • Consultez la section Paramètres de sélection des composants.
    • Consultez la section Paramètres d’accès au cloud.
    • TargetFolder - spécifie le dossier de destination de l’exportation.
    • Locale - spécifie la langue du texte lisible qui peut être exporté.
    • Quiet - supprime la journalisation sur la console (disponible uniquement sur version 2.0 ou ultérieure).
    • DisplayLog - affiche le fichier journal à la fin de l’applet de commande. Définissez sur $false pour supprimer l’affichage du journal.

    Renvoie :

  • Compare-CvadAcToSite

    Compare les fichiers .yml locaux avec la configuration cloud, produisant un rapport sur les modifications apportées par une applet de commande Import, Merge ou Restore.

    Paramètres :

    • Consultez la section Paramètres de sélection des composants.
    • Consultez la section Filtrage par noms d’objets.
    • Consultez la section Paramètres d’accès au cloud.
    • SourceFolder - identifie un dossier racine de substitution pour %HOMEPATH%\Documents\Citrix\AutoConfig.
    • Locale - spécifie la langue du texte lisible qui peut être exporté.
    • Quiet - supprime la journalisation sur la console (disponible uniquement sur version 2.0 ou ultérieure).
    • DisplayLog - affiche le fichier journal à la fin de l’applet de commande. Définissez sur $false pour supprimer l’affichage du journal.
    • Merge - lorsque cette valeur est définie sur $true, ajoute uniquement des composants au site cloud. Les composants ne sont pas supprimés. Définissez sur $false pour supprimer des composants.
    • AddOnly - lorsque cette option est définie sur $true, ajoute uniquement les nouveaux composants, ne met pas à jour ou ne supprime pas les composants existants. Définissez sur $false pour autoriser les mises à jour et les suppressions. Merge est ignoré lorsque ce paramètre est $true.

    Renvoie :

  • Remove-CvadAcFromSite

    Permet de réinitialiser l’intégralité du site ou de supprimer des éléments d’un composant (par exemple, supprimer un catalogue de machines de la liste des catalogues). Cette commande peut être utilisée lorsqu’elle est couplée avec le paramètre IncludeByName pour supprimer sélectivement des membres spécifiques.

    Paramètres :

    Renvoie :

Applets de commande de fichier d’informations client

  • New-CvadAcCustomerInfoFile

    Créez un fichier d’informations client. Par défaut, le fichier d’informations client se trouve sous %HOMEPATH%\Documents\Citrix\AutoConfig.

    Paramètres :

    • CustomerId - ID du client (obligatoire).
    • ClientId - ID client créé sur Citrix Cloud (obligatoire).
    • Secret - clé secrète du client créée sur Citrix Cloud (obligatoire).
    • Environment - environnement Production ou ProductionGov.
    • LogFileName - remplace le préfixe du fichier journal de CitrixLog par autre chose.
    • StopOnError - arrête l’opération lors de la première erreur.
    • AlternateRootFolder - utilise le dossier spécifié comme dossier racine au lieu de %HOMEPATH%\Documents\Citrix\AutoConfig.
    • Locale - utilise les paramètres régionaux spécifiés au lieu des paramètres régionaux dérivés du système sur lequel l’outil est exécuté.
    • Editor - utilise l’éditeur spécifié pour afficher le journal à la fin de chaque applet de commande. Notepad.exe est l’éditeur par défaut. Ce paramètre doit inclure la spécification complète du fichier à l’éditeur et l’éditeur doit prendre la spécification du fichier journal comme seul paramètre.

    Renvoie :

    Exemple :

    New-CvadAcCustomerInfoFile -CustomerId markhof123 -ClientId 6813EEA6-46CC-4F8A-BC71-539F2DAC5984 -Secret TwBLaaaaaaaaaaaaaaaaaw==

  • Set-CvadAcCustomerInfoFile

    Mettez à jour un fichier d’informations client existant. Seuls les paramètres spécifiés de l’applet de commande sont modifiés, toutes les valeurs de paramètre non spécifiées dans le fichier CustomerInfo.yml sont inchangées.

    Paramètres :

    • CustomerId - ID du client (obligatoire).
    • ClientId - ID client créé sur Citrix Cloud (obligatoire).
    • Secret - clé secrète du client créée sur Citrix Cloud (obligatoire).
    • Environment - environnement Production ou ProductionGov.
    • LogFileName - remplace le préfixe du fichier journal de CitrixLog par autre chose.
    • StopOnError - arrête l’opération lors de la première erreur.
    • AlternateRootFolder - utilise le dossier spécifié comme dossier racine au lieu de %HOMEPATH%\Documents\Citrix\AutoConfig.
    • Locale - utilise les paramètres régionaux spécifiés au lieu des paramètres régionaux dérivés du système sur lequel l’outil est exécuté.
    • Editor - utilise l’éditeur spécifié pour afficher le journal à la fin de chaque applet de commande. Notepad.exe est l’éditeur par défaut. Ce paramètre doit inclure la spécification complète du fichier à l’éditeur et l’éditeur doit prendre la spécification du fichier journal comme seul paramètre.

    Renvoie :

Applets de commande d’assistance et de dépannage

  • New-CvadAcTemplateToFile

    Crée un fichier modèle pour les composants sélectionnés, ce qui vous permet de créer manuellement un fichier d’importation.

    Paramètres :

    Renvoie :

  • Show-CvadAcDocument - affiche ce document dans le navigateur par défaut.

    Paramètres :

    • Aucun.

    Renvoie :

    • Affichez cette page Web dans le navigateur Web par défaut.
  • Test-CvadAcConnectionWithSite

    Testez la connexion avec le site cloud pour vérifier que la connexion de communication fonctionne. Cette applet de commande utilise les paramètres d’accès au cloud ou le fichier CustomerInfo.yml pour spécifier les informations de connexion du client.

    Paramètres :

    Renvoie :

    • Les résultats des tests sont affichés sur la ligne de commande.
  • Find-CvadAcConnector

    Localise les connecteurs existants et détermine leur état d’exécution. Cette applet de commande utilise les informations du fichier CustomerInfo.yml ou du paramètre CustomerID pour localiser les connecteurs du client.

    Paramètres :

    • CustomerInfoFileSpec - spécification de fichier pointant vers un fichier d’informations client pour remplacer l’emplacement et le nom par défaut. Ce paramètre est ignoré lorsque le paramètre CustomerId est fourni.
    • CustomerId - ID du client, ce paramètre remplace la même valeur dans le fichier CustomerInfo.yml.

    Renvoie :

    • Les résultats sont affichés sur la ligne de commande.
  • New-CvadAcZipInfoForSupport

    Remarque :

    L’applet de commande New-CvadAcZipInfoForSupport est disponible uniquement sur les versions 2.0 et ultérieures. Vérifiez votre version en utilisant Get-CvadAcStatus dans la configuration automatisée.

    Zippez tous les fichiers journaux et .yml dans un seul fichier zip à envoyer à Citrix pour obtenir de l’assistance. 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.

    Paramètres :

    • AlternateFolder - spécifie un autre dossier dans lequel enregistrer le fichier zip.
    • Quiet - supprime la journalisation sur la console (disponible uniquement sur version 2.0 ou ultérieure).

    Renvoie :

    • Le fichier Zip avec le nom et l’emplacement du fichier zip est affiché sur l’invite de commandes.
  • Get-CvadAcCustomerSites

    Renvoie la liste de tous les sites clients. Cette applet de commande utilise les paramètres d’accès au cloud ou le fichier CustomerInfo.yml pour spécifier les informations de connexion du client.

    Paramètres :

    Renvoie :

    • Affiche la liste des ID de site client trouvés.
  • Get-CvadAcStatus

    Renvoie des informations sur l’outil et l’environnement dans lequel il s’exécute, y compris la version de l’outil, si l’utilisateur dispose des privilèges d’administrateur du site pour l’exportation, si les informations client (ID client et Secret) sont présentées, s’il est possible de communiquer avec le site, et si un ou plusieurs connecteurs sont présents.

    Paramètres :

    • Consultez la section Paramètres d’accès au cloud.
    • SiteId - identifie le site auquel se connecter (facultatif).
    • AdminAddress - est l’adresse DNS ou l’adresse IP du Delivery Controller local utilisé pour vérifier le niveau d’accès des administrateurs. Cette opération est requise si l’outil n’est pas exécuté sur un Delivery Controller.

    Renvoie :

    • Affiche les résultats pour chaque élément.

Applets de commande d’activation de site

Remarque :

Cette fonctionnalité est disponible uniquement sur les versions 2.0 et ultérieures. Vérifiez votre version en utilisant Get-CvadAcStatus dans la configuration automatisée.

  • Set-CvadAcSiteActiveStateOnPrem

    Définit l’état du site local sur actif ou inactif.

    Paramètres :

    • Consultez la section Paramètres d’accès au cloud.
    • SiteActive - lorsque ce paramètre est présent, définit le site local sur actif, supprimant ainsi le mode de maintenance de tous les groupes de mise à disposition. Lorsque ce paramètre n’est pas présent, le mode de maintenance est défini sur tous les groupes de mise à disposition.
    • IncludeByName - liste spécifiant les noms des groupes de mise à disposition à inclure lors de la définition de l’état du site sur actif. Les caractères génériques ‘*’ et ‘?’ sont pris en charge dans les noms.
    • ExcludeByName - liste spécifiant les noms des groupes de mise à disposition à exclure lors de la définition de l’état du site sur actif. Les caractères génériques ‘*’ et ‘?’ sont pris en charge dans les noms.
    • Quiet - supprime la journalisation sur la console.
    • DisplayLog - affiche le fichier journal à la fin de l’applet de commande. Définissez sur $false pour supprimer l’affichage du journal.

    Renvoie :

  • Set-CvadAcSiteActiveStateCloud

    Définit l’état du site cloud sur actif ou inactif.

    Paramètres :

    • Consultez la section Paramètres d’accès au cloud.
    • SiteActive - lorsque ce paramètre est présent, définit le site local sur actif, supprimant ainsi le mode de maintenance de tous les groupes de mise à disposition. Lorsque ce paramètre n’est pas présent, le mode de maintenance est défini sur tous les groupes de mise à disposition.
    • IncludeByName - liste spécifiant les noms des groupes de mise à disposition à inclure lors de la définition de l’état du site sur actif. Les caractères génériques ‘*’ et ‘?’ sont pris en charge dans les noms.
    • ExcludeByName - liste spécifiant les noms des groupes de mise à disposition à exclure lors de la définition de l’état du site sur actif. Les caractères génériques ‘*’ et ‘?’ sont pris en charge dans les noms.
    • Quiet - supprime la journalisation sur la console.
    • DisplayLog - affiche le fichier journal à la fin de l’applet de commande. Définissez sur $false pour supprimer l’affichage du journal.

    Renvoie :

Applets de commande de fusion de sites

Remarque :

Cette fonctionnalité est disponible uniquement sur les versions 2.0 et ultérieures. Vérifiez votre version en utilisant Get-CvadAcStatus dans la configuration automatisée.

Pour plus d’informations sur la fusion de sites et l’utilisation de ces applets de commande, reportez-vous à la section Fusion de plusieurs sites en un seul site.

  • New-CvadAcSiteMergingInfo - crée un jeu d’informations préfixe/suffixe de fusion de site. Il n’est pas nécessaire de connaître tous les préfixes ou suffixes au début. Ils peuvent être mis à jour avec Set-CvadAcSiteMergingInfo ou en modifiant manuellement le fichier SiteMerging.yml.
  • Set-CvadAcSiteMergingInfo - met à jour un jeu d’informations préfixe/suffixe de fusion de site existant.
  • Remove-CvadAcSiteMergingInfo - supprime un jeu d’informations préfixe/suffixe de fusion de site existant.

Paramètres de fusion de sites

  • SiteName - nom utilisé pour identifier l’ensemble de préfixes/suffixes pour un site spécifique. Il peut correspondre au nom du site, mais ce n’est pas obligatoire. SiteName est un paramètre obligatoire. Remarque : Il s’agit du seul paramètre pris en charge pour Remove-CvadAcSiteMergingInfo.
  • Quiet - supprime la journalisation sur la console (disponible uniquement sur version 2.0 ou ultérieure).
  • AdminScopedPrefix - préfixe à appliquer aux étendues administrateur.
  • ApplicationPrefix - préfixe à appliquer aux applications.
  • ApplicationFolderPrefix - préfixe à appliquer aux dossiers d’application ; ApplicationFolderPrefix peut être combiné avec ApplicationFolderRoot.
  • ApplicationFolderRoot - nouveau dossier racine des dossiers d’application. Ce paramètre crée une hiérarchie de dossiers supplémentaire. ApplicationFolderRoot peut être combiné avec ApplicationFolderPrefix.
  • ApplicationGroupPrefix - préfixe pour les groupes d’applications.
  • ApplicationUserPrefix - préfixe à appliquer au nom de l’application que l’utilisateur voit.
  • ApplicationAdminPrefix - préfixe à appliquer au nom de l’application que l’administrateur voit.
  • DeliveryGroupPrefix - préfixe à appliquer aux groupes de mise à disposition.
  • GroupPolicyPrefix - préfixe à appliquer aux noms de stratégie.
  • HostConnectionPrefix - préfixe à appliquer aux connexions hôtes.
  • MachineCatalogPrefix - préfixe à appliquer aux catalogues de machines.
  • StoreFrontPrefix - préfixe à appliquer aux noms StoreFront.
  • TagPrefix - préfixe à appliquer aux balises.
  • AdminScopedSuffix - suffixe à appliquer aux étendues administrateur.
  • ApplicationSuffix - suffixe à appliquer aux applications.
  • ApplicationFolderSuffix - suffixe à appliquer aux dossiers d’application ; ApplicationFolderSuffix peut être combiné avec ApplicationFolderRoot.
  • ApplicationGroupSuffix - suffixe pour les groupes d’applications.
  • ApplicationUserSuffix - suffixe à appliquer au nom de l’application que l’utilisateur voit.
  • ApplicationAdminSuffix - suffixe à appliquer au nom de l’application que l’administrateur voit.
  • DeliveryGroupSuffix - suffixe à appliquer aux groupes de mise à disposition.
  • GroupPolicySuffix - suffixe à appliquer aux noms de stratégie.
  • HostConnectionSuffix - suffixe à appliquer aux connexions hôtes.
  • MachineCatalogSuffix - suffixe à appliquer aux catalogues de machines.
  • StoreFrontSuffix - suffixe à appliquer aux noms StoreFront.
  • TagSuffix - suffixe à appliquer aux balises.
  • SiteRootFolder - nom de dossier complet à utiliser pour les exportations et les importations ; il peut s’agir d’un dossier local ou d’un partage de fichiers.

Paramètres de sélection des composants

Les composants suivants peuvent être spécifiés avec les applets de commande appropriées. Pour les versions 1.x de l’outil, insérez $true à la fin de chaque paramètre. Pour les versions 2.x ou ultérieures de l’outil, spécifiez uniquement le paramètre. Si All est sélectionné, les autres paramètres sont ignorés. L’option All est automatiquement sélectionnée lorsqu’aucun paramètre de composant n’est spécifié.

  • All
  • Tags
  • AdminRolesScopes
  • MachineCatalogs
  • DeliveryGroups
  • ApplicationGroups
  • Applications
  • GroupPolicies

Filtrage par noms d’objets

Inclure et exclure par nom

Les paramètres IncludeByName et ExcludeByName permettent d’inclure et d’exclure des membres de composants dans les applets de commande par nom. Il n’est possible de choisir qu’un seul composant (par exemple, les groupes de mise à disposition) à la fois dans les applets de commande prises en charge. Si un membre de composant se trouve dans les deux zones, l’exclusion a priorité sur tout autre paramètre et une entrée est ajoutée à la liste de correction du journal, identifiant le nom du membre (et du composant) qui a été exclu.

IncludeByName et ExcludeByName acceptent une liste des noms de membres de composants. Les noms peuvent contenir un ou plusieurs caractères génériques. Deux types de caractères génériques sont pris en charge. La liste des noms de membres de composants doit être placée entre guillemets simples lorsqu’un nom contient des caractères spéciaux.

  • * correspond à n’importe quel nombre de caractères
  • ? Correspond à un seul caractère

IncludeByName et ExcludeByName peuvent également accepter un fichier contenant une liste de membres où chaque membre peut être explicite ou contenir des caractères génériques. Chaque ligne du fichier peut contenir un membre. Les espaces de début et de fin sont retirés du nom du membre. Le nom de fichier doit être précédé du signe @ et être entouré de guillemets simples (une exigence PowerShell pour que le @ ne soit pas réinterprété). Plusieurs fichiers peuvent être répertoriés en plus d’être mélangés avec des noms de membres.

Exemple de fusion de tous les groupes de mise à disposition dont les noms commencent par DgSite1 et contiennent Home2 :

Merge-CvadAcToSite –DeliveryGroups $true –IncludeByName DgSite1*,*Home2*

Par nom du groupe de mise à disposition

ByDeliveryGroupName filtre par nom du groupe de mise à disposition pour les applications et les groupes d’applications. Ce paramètre est toujours une liste d’inclusion identifiant les membres à inclure en fonction de leur association de groupe de mise à disposition.

ByDeliveryGroupName accepte une liste des noms de groupe de mise à disposition. Les noms peuvent contenir un ou plusieurs caractères génériques. Deux types de caractères génériques sont pris en charge.

  • * correspond à n’importe quel nombre de caractères
  • ? correspond à un seul caractère

L’exemple suivant fusionne toutes les applications qui font référence à tous les noms de groupe de mise à disposition commençant par EastDg.

Merge-CvadAcToSite –Applications –ByDeliveryGroupName EastDg*

Exclude Disabled

ExcludeDisabled filtre des opérations d’importation toutes les applications et les groupes d’applications qui sont désactivés. ExcludeDisabled est false par défaut, ce qui signifie que toutes les applications et tous les groupes d’applications sont importés quel que soit leur état activé.

Par nom de machine

Remarque :

Cette fonctionnalité est disponible uniquement sur les versions 2.0 et ultérieures. Vérifiez votre version en utilisant Get-CvadAcStatus dans la configuration automatisée.

ByMachineName filtre par le nom de la machine pour les catalogues de machines et les groupes de mise à disposition. Ce paramètre est toujours une liste d’inclusion identifiant les membres à inclure en fonction de leur association de nom de machine.

ByMachineName accepte une liste de noms de machines où les noms peuvent contenir un ou plusieurs caractères génériques. Deux types de caractères génériques sont pris en charge.

  • * correspond à n’importe quel nombre de caractères
  • ? correspond à un seul caractère

Lors de l’exportation ou de l’importation, si l’utilisation de ByMachineName et d’un filtre de nom de machine ne renvoie aucune machine dans le catalogue de machines ou le groupe de mise à disposition, le catalogue de machines ou le groupe de mise à disposition est exclu de l’exportation ou de l’importation.

Remarque :

Si ByMachineName est utilisé dans une applet de commande de tout type d’importation, AddMachinesOnly est défini sur $true.

Ajouter des machines uniquement

AddMachinesOnly, si défini sur $true, indique à l’opération d’importation d’ajouter des machines uniquement au catalogue de machines ou au groupe de mise à disposition. Les machines ne sont pas retirées, ce qui permet des ajouts incrémentiels.

AddMachineOnly se règle sur false par défaut, ce qui signifie que les machines sont supprimées si elles ne sont pas présentes dans le fichier .yml du catalogue de machines ou du groupe de mise à disposition. AddMachinesOnly est défini sur $true lorsque ByMachineName est utilisé mais peut être remplacé en définissant AddMachinesOnly sur false.

Paramètres de migration

Les applets de commande modifiant la configuration du site cloud (Import, Restore, Merge, New et Sync) prennent en charge les paramètres supplémentaires suivants pour offrir une plus grande flexibilité.

  • CheckMode - Effectue l’opération d’importation mais n’apporte aucune modification. Toutes les modifications attendues sont signalées avant la fin de l’importation. Vous pouvez utiliser cette commande pour tester votre importation avant de l’effectuer.
  • BackupFirst - Sauvegarde le contenu du cloud dans des fichiers .yml avant de modifier la configuration du cloud. Cette option est activée par défaut.
  • Confirm - Lorsque la valeur est true, invite les utilisateurs à confirmer qu’ils souhaitent apporter des modifications à la configuration du site cloud. L’applet de commande Remove affiche une invite en raison de sa nature destructrice. Définissez la valeur false si aucune invite n’est souhaitée, comme pour l’exécution dans des scripts automatisés. Confirm est true par défaut.

Remarque :

Les applets de commande SecurityFileFolder, SiteName et SiteActive sont disponibles uniquement sur les versions 2.0 et ultérieures. Vérifiez votre version en utilisant Get-CvadAcStatus dans la configuration automatisée.

  • SecurityFileFolder - dossier complet contenant le fichier CvadSecurity.yml qui peut pointer vers un dossier local ou un dossier de partage réseau sous contrôle d’authentification. L’outil ne demande pas d’informations d’identification ; l’accès à la ressource contrôlée doit être obtenu avant d’exécuter l’outil.
  • SiteName - spécifie le préfixe et le suffixe de fusion de sites à utiliser lors de l’importation. Consultez Fusion de plusieurs sites en un seul site pour de plus amples informations.
  • SiteActive - indique si le site importé est actif ou inactif. Par défaut, ce paramètre est défini sur $false, ce qui signifie que le site importé est inactif.

Paramètres d’accès au cloud

Toutes les applets de commande accédant au cloud prennent en charge les paramètres supplémentaires suivants.

Remarque :

CustomerID, ClientID et Secret peuvent être placés dans le fichier CustomerInfo.yml ou spécifiés avec l’applet de commande à l’aide des paramètres précédents. Lorsqu’ils sont spécifiés aux deux emplacements, les paramètres de l’applet de commande ont priorité.

  • CustomerId - ID client utilisé dans les API REST, requis pour accéder à toutes les API REST. Votre ID client se trouve dans Citrix Cloud.
  • ClientId - ID client créé sur le site Web Gestion des identités et des accès de Citrix Cloud. Ceci est nécessaire pour obtenir le jeton de porteur requis pour l’authentification de toutes les API Rest.
  • Secret - clé secrète créée sur le site Web Gestion des identités et des accès de Citrix Cloud. Ceci est nécessaire pour obtenir le jeton de porteur requis pour l’authentification de toutes les API Rest.
  • CustomerInfoFileSpec - spécification de fichier pointant vers un fichier d’informations client pour remplacer l’emplacement et le nom par défaut.

Paramètres d’affichage du journal

Les applets de commande Export, Import, Sync, Restore, Backup, Compare et Remove affichent le fichier du journal lorsque l’opération se termine. Vous pouvez supprimer l’affichage en définissant le paramètre -DisplayLog sur $false. Notepad.exe est utilisé par défaut pour afficher le fichier journal. Vous pouvez spécifier un éditeur différent dans le fichier CustomerInfo.yml.

Editor: C:\Program Files\Notepad++\notepad++.exe

Résultats de l’état dérivé par commande

L’état dérivé peut entraîner l’une de ces trois combinaisons d’actions sur le site cloud :

  • Ajouter, mettre à jour et supprimer
  • Ajouter et mettre à jour uniquement
  • Ajouter uniquement

Le tableau suivant montre l’état dérivé de chaque applet de commande et les paramètres facultatifs qui peuvent modifier le comportement de l’état dérivé de l’applet de commande.

Commande Ajouter, mettre à jour, supprimer Ajouter, mettre à jour Ajouter
Importer -Merge $false Valeur par défaut -AddOnly $true
Merge S.O. Valeur par défaut -AddOnly $true
New S.O. S.O. Valeur par défaut
Synchroniser -Merge $false Valeur par défaut -AddOnly $true
Restaurer -Merge $false Valeur par défaut -AddOnly $true

Valeurs de retour de l’applet de commande

ActionResult

Toutes les applets de commande renvoient la valeur suivante.

public class ActionResult
{
    public bool                         Overall_Success;
    public Dictionary<string, string>   Individual_Success;
    public object                       CustomResult;
}

Overall_Success renvoie un seul booléen indiquant le succès global de l’applet de commande sur tous les composants sélectionnés : true signifie succès et false signifie échec.

Individual_Success renvoie une ou trois valeurs pour chaque composant principal. Le résultat d’un composant peut être Success, Failure ou Skipped. Skipped indique que le composant n’a pas été sélectionné pour l’exécution par l’applet de commande.

CustomResult est spécifique à l’applet de commande.

CustomResult

Import, Merge, Restore, Sync, Compare, Compare File et Remove renvoient les informations de résultat personnalisées suivantes à une seule instance de EvaluationResultData.

Remarque :

Les applets de commande Export et Template ne renvoient pas de résultat personnalisé.

    public class EvaluationResultData
    {
        public Dictionary<string, Dictionary<string, ActionResultValues >> EvaluationResults;
        public int                  Added;
        public int                  Updated;
        public int                  Deleted;
        public int                  NoChange;
        public int                  TotalChanged;
        public EvaluationResults     OverallResult;
        public string               CloudBackupFolder;
        public string               SourceBackupFolder;
    }
    Where:
    public enum ActionResultValues
    {
        Add,
        Update,
        Delete,
        Identical,
        DoNothing
    }
    public enum EvaluationResults
    {
        Success,
        Failure,
        Skipped
    }

EvaluationResults affiche une liste avec une entrée par composant sélectionné. La clé est le nom du composant et la valeur est une liste de chaque membre de composant et de l’action effectuée sur ce membre. Les actions peuvent être l’une des valeurs ActionResultValues.

Added, Updated, Deleted et NoChange indiquent le nombre total de membres de composants ajoutés, mis à jour, supprimés ou sur lesquels aucune action n’a été effectuée, dans cet ordre.

TotalChanged est la somme de Added, Updated et Deleted.

OverallResult est un booléen unique indiquant le résultat de l’applet de commande. True indique le succès total de tous les composants et false indique l’échec du traitement d’un ou de plusieurs composants.

CloudBackupFolder est la spécification de fichier complète de la sauvegarde de la configuration du site cloud avant que l’applet de commande effectue des actions de modification du cloud.

SourceBackupFolder est la spécification de fichier complète de la sauvegarde du fichier source effectuée après la fin de l’applet de commande. Par défaut, ces fichiers se trouvent sous %HOMEPATH%\Documents\Citrix\AutoConfig.

Aide

  • Get-Help - L’aide de PowerShell est disponible pour chaque applet de commande. Tous les paramètres sont documentés avec chaque applet de commande et une brève explication de l’applet de commande est également proposée. Pour accéder à l’aide d’une applet de commande, tapez Get-Help devant l’applet de commande. Par exemple, Get-Help Import-CvadAcToSite.

Informations supplémentaires

Importation d’autres objets lorsque vous disposez de catalogues de machines Machine Creation Services

Actuellement, l’outil de configuration automatisée ne prend pas en charge l’importation automatisée de catalogues de machines MCS ou de leurs groupes de mise à disposition correspondants. Toutefois, vous pouvez toujours importer d’autres options de configuration telles que des applications et des stratégies à l’aide de l’outil de configuration automatisée. Vous devez créer le catalogue de machines et le groupe de mise à disposition en utilisant le même nom que la configuration locale. Suivez les étapes de préparation de votre environnement avant de procéder à l’importation des paramètres de l’application :

  1. Dans votre portail Citrix Cloud, cliquez sur le menu hamburger et accédez à Mes services > Virtual Apps and Desktops Service > Gérer. Créez votre catalogue de machines MCS comme vous le feriez normalement. Veillez à nommer votre catalogue exactement de la même manière que votre catalogue local existant.

  2. Créez le groupe de mise à disposition correspondant pour le nouveau catalogue. Assurez-vous de le nommer exactement comme le groupe de mise à disposition local correspondant.

  3. Dans l’interface Citrix Studio de votre environnement local, dans le nœud Applications, vérifiez que les applications appartiennent aux groupes de mise à disposition correspondants en sélectionnant l’application, en cliquant avec le bouton droit de la souris sur l’application et en accédant à Propriétés.

  4. Cliquez sur Groupes pour confirmer les groupes auxquels appartient l’application :

    ID client image 8

  5. Dans PowerShell, exécutez la commande Merge et utilisez l’indicateur byDeliveryGroupName, qui filtre les applications par nom de groupe de mise à disposition.

    Merge-CvadAcToSite –Applications $true –ByDeliveryGroupName <DG_name>

    ID client image 9

  6. Tapez Oui pour continuer.

    ID client image 10

  7. Dans Gérer > Configuration complète, sélectionnez Applications dans le volet gauche. Actualisez l’écran pour vous assurer que les applications sont répertoriées comme prévu. Sélectionnez les applications et sélectionnez Propriétés de l’application > Groupes pour vérifier.

Importation de stratégies liées à MCS

Si vous devez importer des stratégies associées à vos catalogues ou groupes MCS, suivez les instructions suivantes :

  1. Exécutez la commande Merge-CvadAcToSite -GroupPolicies $true dans PowerShell et tapez yes pour continuer.

    ID client image 13

    L’exécution réussie affiche une sortie similaire à la capture d’écran précédente (Added values, Valeurs ajoutées). La capture d’écran suivante montre le résultat d’une ligne pour laquelle il n’y a pas eu de modifications (No Change, Pas de changement).

    ID client image 14

  2. Actualisez l’écran Gérer > Configuration complète et sélectionnez Stratégies dans le volet gauche.

  3. Vérifiez l’onglet Assigned to dans Policies et comparez-le avec votre affectation de stratégie locale.

Migration vers Citrix Cloud Government

L’environnement Citrix Cloud Government utilise 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 les environnements Citrix Cloud Government.

  1. Dans le dossier %CHEMINDEBASE%\Documents\Citrix\AutoConfig, modifiez CustomerInfo.yml.
  2. Ajoutez la ligne suivante à CustomerInfo.yml (ou modifiez-la, si elle est déjà présente)

    Environment: "ProductionGov"

La configuration automatisée peut désormais être utilisée sur les environnements Citrix Cloud Government.

Connexions hôte

Les connexions hôtes et les hyperviseurs associés peuvent être exportés et importés à l’aide de la configuration automatisée.

L’ajout d’un hyperviseur à une connexion hôte nécessite des informations de sécurité spécifiques au type d’hyperviseur. Ces informations ne peuvent pas être exportées à partir du site local pour des raisons de sécurité. Vous devez fournir les informations manuellement afin que l’outil de configuration automatisée puisse importer avec succès les connexions hôte et les hyperviseurs sur le site cloud.

Le processus d’exportation crée le fichier HostSecurity.yml sous %HOMEPATH%\Documents\Citrix\AutoConfig contenant des espaces réservés pour chaque élément de sécurité nécessaire au type d’hyperviseur spécifique. Vous devez mettre à jour le fichier HostSecurity.yml avant l’importation dans le site cloud. Les mises à jour de l’administrateur sont conservées pour plusieurs exportations avec de nouveaux espaces réservés de sécurité ajoutés au besoin. Les éléments de sécurité ne sont jamais supprimés.

Remarque :

Assurez-vous de placer entre doubles guillemets toutes les valeurs entrées dans le fichier HostSecurity.yml.

---

HostConn1:
ConnectionType: XenServer
UserName: root
PasswordKey: rootPassword
HostCon2:
ConnectionType: AWS
ApiKey: 78AB6083-EF60-4D26-B2L5-BZ35X00DA5CH
SecretKey: TwBLaaaaaaaaaaaaaaaaaw==
Region: East

Informations de sécurité par hyperviseur

La liste suivante répertorie les informations de sécurité requises pour chaque type d’hyperviseur.

  • XenServer, Hyper-V, VMware
    • Nom d’utilisateur
    • Mot de passe en texte clair
  • Microsoft Azure
    • ID d’abonnement
    • ID de l’application
    • Secret d’application
  • Amazon Web Services
    • ID du compte de service
    • Secret d’application
    • Région

Considérations de sécurité particulières

Toutes les informations de sécurité sont saisies sous forme de texte clair. Si le texte clair n’est pas recommandé, les connexions hôtes et les hyperviseurs associés peuvent être créés manuellement à l’aide de l’interface Gérer > Configuration complète du service. Les noms de connexions hôte et d’hyperviseur doivent correspondre exactement à leurs homologues locaux afin que les catalogues de machines qui utilisent les connexions hôtes soient importés avec succès.

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.

Collecte de données Citrix Cloud

Pour en savoir plus sur les informations collectées par Citrix Cloud, reportez-vous à la section Gestion du contenu client et des journaux de Citrix Cloud Services.

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 -RestoreFrom %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 -RestoreFrom %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
  • HostSecurity.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 -RestoreFrom.

Journalisation

L’exécution d’une applet de commande entraîne la création d’un fichier journal et d’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 sous %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.

Détails de la journalisation

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 énumère 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 :

  1. 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.
  2. É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.
  3. 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.
  4. 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.
  5. Les catalogues de machines échouent. C’est en général parce que des connexions d’hôte n’ont pas été importées.
  6. 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.
  7. Utilisateurs manquants dans des groupes de mise à disposition. C’est en général parce que des utilisateurs sont introuvables dans Active Directory.

Problèmes courants

Le site cloud est vide

Un site vide indique qu’une opération d’importation/fusion/restauration réussie n’est pas terminée. Si une opération a été tentée, vérifiez les journaux de l’opération.

Le site cloud contient plus d’éléments que prévu

Cela peut se produire si des améliorations ont été apportées à la configuration du site cloud et qu’une opération Merge a été exécutée. Cela peut également se produire si la configuration du site cloud comportait d’anciennes valeurs et qu’une opération d’importation/fusion/restauration a rencontré des problèmes. Essayez de relancer l’opération.

Le site cloud contient moins d’éléments que prévu

Cela peut se produire si des améliorations ont été apportées à la configuration du site cloud et avec une opération Import avec le paramètre Merge défini sur $false, entraînant un état dérivé identique. L’état d’origine est sauvegardé dans le dossier Automated Fail-Safe Site Backup associé à l’opération d’importation. Pour corriger ce problème :

  1. Restaurez les sauvegardes automatisées de site cloud en mode sans échec à l’aide de l’opération Restore en définissant le paramètre RestoreFolder sur le dossier Automated Fail-Safe Site Backup.

  2. Utilisez l’opération Merge au lieu de l’opération Import.

Modifications de site cloud après la perte d’une importation

Cela peut se produire si une opération Import a été effectuée avec le paramètre –Merge défini sur $false, ce qui entraîne une importation d’état dérivé identique. L’état d’origine est sauvegardé dans le dossier Automated Fail-Safe Site Backup associé à l’opération d’importation. Pour corriger ce problème :

  1. Restaurez les sauvegardes automatisées de site cloud en mode sans échec à l’aide de l’opération Restore en définissant le paramètre RestoreFolder sur le dossier Automated Fail-Safe Site Backup.

  2. Utilisez l’opération Merge au lieu de l’opération Import.

Le site cloud ne correspond pas au site local actuel

Cela peut se produire lorsqu’une opération Merge a été effectuée, entraînant un état dérivé fusionné au lieu d’une opération Import avec le paramètre Merge défini sur $false entraînant un état dérivé identique. Répétez l’opération Import avec le paramètre Merge défini sur $false.

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 fonctionne pas dans Configuration complète lors de l’exécution de l’outil de configuration automatisée. Les modifications apportées à Configuration complète lors de l’exécution de l’outil de configuration automatisée peuvent produire 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.
  • Vérifiez toujours visuellement les résultats de fusion/importation/restauration dans Configuration complète pour vous assurer que le site cloud répond aux attentes.

Ressources