PoC 指南:自动配置工具

概述

自动配置工具 有助于将配置迁移和导出到 Citrix 桌面即服务 (DaaS )。本概念验证指南说明了有关如何使用此工具的分步说明。

管理员可以轻松测试和探索 Citrix DaaS 的功能和优势,同时运行现有的本地环境,甚至可以方便地在云区域之间移动、备份现有配置和其他使用案例。 自动配置下载链接 还包含有关上述 用例自定义的其他信息和详细文档

Citrix Virtual Apps and Desktops 的自动配置工具是什么

此工具旨在帮助自动将 CVAD 配置(策略、应用程序、目录、管理员角色、范围等)从一个或多个本地站点迁移到 Citrix Cloud 上托管的 Citrix DaaS。它还可用于在 不同的云区域租户之间迁移信息。

通过多次运行该工具,可以分阶段执行迁移,从而使管理员能够轻松实现所需的配置状态。有一段 2 分钟的视频提供了 自动配置工具的快速浏览

 

为什么要使用这个工具

负责大型或复杂环境的 IT 管理员通常会发现迁移是一个繁琐的过程。他们最终经常编写自己的工具来成功完成此任务,因为它往往是特定于他们的使用案例。

Citrix 希望通过提供一种通过自动化解决使用案例的工具来帮助简化此过程。管理员可以轻松测试 Citrix Cloud 中的当前配置,并利用 Citrix DaaS 提供的优势,同时保持其当前环境完好无损。这些好处包括减少 Citrix 管理部分后端和控制平面时的管理过载、自动和可定制的 Citrix Cloud 组件更新等。

这个工具是如何实施的

Citrix 使用行业标准配置作为代码提供一种机制来帮助自动执行迁移过程。此工具可发现一个或多个本地站点并将其导出为 配置文件的集合,管理员可以选择对其进行编辑。然后,可以将这些文件的配置导入到 Citrix DaaS 中。

此代码不仅限于迁移,而是为 Citrix 站点创建配置的未来,因此适用于 许多不同的使用案例。支持灾难恢复、开发/测试/暂存到生产站点同步、地理 (GEO) 移动以及其他几种方案。对于使用公有云提供商的管理员,这可以帮助自动创建对象组合(与 Microsoft Azure ARM 模板和 AWS CloudFormation 并行)。

该工具还允许管理员 将多个本地站点合并为一个站点,同时避免名称冲突。管理员可以控制本地还是云控制资源。现在可以将文件放置在安全的网络文件共享中,在使用指向 CvadAcSecurity.yml 文件的 SecurityFileFolder 参数时,该共享需要进行身份验证。

必备条件

本地环境

  • Citrix Virtual Apps and Desktops (CVAD) 本地环境至少有一个已注册的 VDA
  • CVAD 本地环境运行在以下版本之一上:任何具有最新 CU (7.6、7.15、1912)的长期服务版本 (LTSR ) 版本;或相应的最新两个最新 版本 (CR) 版本之一(例如:2003、2006)。
  • 计划运行 自动配置工具命令 的已加入域的计算机必须运行 .NET 4.7.2 或更高版本
  • 带有 Citrix PowerShell SDK的计算机,该软件开发工具包会自动安装在 DDC 上。注意: 如果在其他计算机上运行该工具,则必须加入域,而 Studio 必须安装正确的 PowerShell 管理单元 。可以在相应版本的 产品 ISO 安装介质上找到此安装程序,该介质可从 **Citrix 下载 > Citrix Virtual Apps and Desktops ** 网站获取。
  • 官方下载网站下载自动配置工具 MSI

与云相关的组件

注意: 如果在云站点之间迁移(云到云迁移),请参阅 官方文档 了解详细步骤。

  • 有效的 Citrix DaaSWorkspace Premium Plus 许可证。
  • 管理员必须能够登录 云门户 并获取: 资源位置名称客户 ID客户端密钥应用程序 ID密钥
  • 现有 Citrix Cloud 资源位置 至少有 一个 Cloud Connector,该连接器标记为绿色(正常),并且与本地设置属于同一域。注意: Citrix 建议使用两个或多个 Cloud Connector(用于冗余和高可用性)。有关如何设置Cloud Connector的信息,请参阅 本指南

本概念验证指南演示了如何

  1. 完成本地先决条件
  2. 将本地站点配置导出到 YAML (.yml) 文件中
  3. 完成云的先决条件
  4. 使用不同的置备方法(池和静态目录的 Machine Creation Services (MCS))时,完成导入站点配置的必要条件
  5. 将站点配置导入云端(通过编辑所需的文件)
  6. 故障排除提示以及在哪里可以找到更

完成从本地站点导出的先决条件

这些步骤必须在您的 DDC 或要运行 自动配置 工具的已加入域的计算机中运行。

  1. 将最新的 自动配置工具 MSI 下载到 本地 DDC 或已加入域的计算机。注意: 有关如何从其他计算机运行它的更多详细信息,请参阅 前提条件部分 。该工具可以从 这里下载。 注意: 有关如何从其他计算机运行它的更多详细信息,请参阅 前提条件部分
  2. 右键单击 AutoConfig_PowerShell_x64.msi 安装程序,然后单击安装,在本地 DDC 上运行 MSI必备条件
  3. 阅读 许可协议 ,如果您接受条款,请选中复选框。然后单击“安装先决条件
  4. 文件将被复制,进度条会继续移动,直到安装完成。必备条件

  5. MSI 运行后,弹出一个表示成功完成的窗口。单击“完成”关闭 MSI 设置 窗口。必备条件
  • 注意:成功执行后, MSI 将创建相应的文件夹结构(位于 C:\Users\<username>\Documents\Citrix\AutoConfig 中),还创建一个名为自动配置的桌面图标,该图标将启动 PowerShell 命令提示符。此工具是后续步骤中使用的工具。

导出本地站点配置

使用 export PowerShell 命令,您可以导出现有的本地配置并获取必要的 .yml 文件。这些文件用于将所需配置导入 Citrix Cloud

  1. 在上一步中运行 MSI 安装程序后,您将获得在桌面上自动创建的自动 配置 快捷方式。右键单击此快捷方式,然 后单击以管理员
  2. 运行 Export-CvadAcToFile 命令。此命令导出策略、手动设置的目录和交付组。它还会导出应用程序、应用程序文件夹、图标、区域映射、标签、管理员角色和作用域以及其他项目。注意: 对于 MCS 计算机目录和交付组,请参阅本指南中 使用不同置备方法导入站点配置的必要条件部分 中的步骤。 导出配置

  3. 工具完成运行后, 总体状态 将显示为 True ,导出过程已完成(显示的输出行与下图相匹配)。注意: 如果出现任何错误,诊断文件将在特定于操作的子文件夹 (Export, Import, Merge, Restore, Sync, Backup, Compare) 中创建,可在 %HOMEPATH%\Documents\Citrix\AutoConfig 下面找到。如果遇到任何错误,请参阅“故障排除提示”部分导出配置

  4. 生成的 .yml 文件现在位于当前用户的 Documents\Citrix\AutoConfig 路径中: 导出配置
  • 注意: 有关 .yml 文件中内容的示例,请参阅下图 (Application.yml)

导出配置

  • 注意: 如有必要,请将 .yml 文件复制到要用于将设置导入 Citrix Cloud 环境的计算机。导出和导入可以在同一台计算机上完成。

云中的完成先决条件

转到资源位置,确保您的 Cloud Connector 都显示为绿色(可用)。注意: 如果您需要有关如何设置 Cloud Connector的说明,请参阅 本指南

  1. 要验证 Cloud Connector的运行状况,请首先使用 Citrix 管理员凭据(或您的 Azure AD 凭据,如果适用)登录 云门户云先决条件

  2. 如果您有多个 组织 ID (组织 ID),请选择相应的租户。 云先决条件

  3. 登录后,转到左上角的 汉堡菜单 ,然后单击 资源位置云先决条件

  4. 访问 资源位置 下的 Cloud Connector磁贴。 云先决条件

  • 注意: 如下图所 示,Cloud Connector 必须显示绿色,表示“正常”状态。出于冗余目的,Citrix 建议每个 资源位置 有多个 Cloud Connector

云先决条件

使用不同的配置方法导入站点配置的必备

处理 Provisioning Services (PVS) 计算机目录、交付和应用程序组和策略

此时无需额外步骤即可导入 PVS 目录 及其相应的应用程序。请按照本指南中“将 站点配置导入云端”部分中提到的步骤进行操作。

处理 Machine Creation Services (MCS):池 VDI 多会话(随机)和 RDS 计算机目录

注意: 有一个单独的部分提供了有关静态分配的虚拟机的说明。请参阅本指南中“MCS 静态分配 VDI”部分中提及的步骤。

此任务现在支持导入和导出命令。黄金映像和“包含 用户数据的目录:丢弃”中的配置都可以迁移。但是,不会迁移这些目录中的虚拟机,因为要从中导入的站点负责维护虚拟机的生命周期。

计算机开启后,其状态可能会发生变化,从而影响虚拟机同步的导入数据。因此,使用该工具迁移这些目录时,它会创建目录元数据并启动主映像创建。但是,导入的计算机为零。

重要注意事项:

  • 根据主映像的大小,MCS 目录导入过程可能需要几个小时。因此,工具中的导入命令仅启动 MCS 目录创建,不会等待其完成。
  • 导入完成后,可以通过云部署中的 Studio 监视目录创建进度。
  • 创建主映像后,您可以置备计算机。请考虑虚拟机管理程序的现有容量,因为您的消耗量来自本地使用。
  • 可以导入所有其他对象(包括交付组、应用程序、策略以及使用该目录的所有对象),而不必等待主映像的创建。工具中可用的相同命令可用于迁移目录和所有其他对象。
  • 目录创建完成后,可以将计算机添加到导入的目录中,然后用户可以启动其资源。

注意: 在考虑了这些问题之后,请按照本指南中的将 站点配置导入云部分 进行操作,以根据需要合并您的配置。

处理 Machine Creation Services (MCS):静态分配的计算机

注意: 另有一个单独的部分,其中包含有关池和 RDS 计算机的说明。请参阅 MCS 池 VDI 和 RDS 计算机上提到的步骤

此任务现在支持导入和导出命令。此过程会导入一些存储在数据库中的低级详细信息, 因此需要从具有数据库访问权限的计算机上运行。工具导入过程还会迁移配置、主映像和计算机。这是一个快速的操作,因为没有创建任何图像。

重要注意事项:

  • VDA 需要 指向Cloud Connector,才能在 Citrix Cloud中注册。
  • 请参阅 激活站点 文档以激活您的云站点,从而通过 Citrix Cloud 控制重启计划、电源管理等。
  • 迁移完成后,如果要从 本地站点删除相应的目录,则 必须 选择 退出虚拟机和 AD 帐户的选项。否则,这两条记录都将被删除,并且云站点将指向已删除的虚拟机。

注意: 在考虑了这些问题之后,请按照本指南中的将 站点配置导入云部分 进行操作,以根据需要合并您的配置。

将站点配置导入云

在此步骤中,您将获取 客户连接详细信息、手动创建 区域映射, 然后将 配置导入 到云租户。 注意: 对于 MCS,请先按照本指南中“将 站点配置导入云端”部分中的相应小节 进行操作。

获取客户连接详情

管理员必须编辑 CustomerInfo.yml 文件并将相应的 CustomerNameCustomerIdSecretKey 值添加到文件中。可以从 云门户获取和生成这些值,如以下步骤所示。

  1. 首先,使用文本编辑器应用程序(例如记事本)打开 CustomerInfo.yml 文件。以下屏幕截图显示了必须编辑的 CustomerInfo.yml 文件值(下划线为红色): 导入配置

  2. Cloud 门户 上,再次单击 汉堡菜单 ,然后转到 身份和访问管理导入配置

  3. 转到“API 访问”选项卡并复制“客户 ID”值,该值可以在 customer ID 文本旁边找到,如以下屏幕截图(红色矩形)所示: 导入配置

  4. 将检索到的 CustomerInfo.yml 文件中的 CustomerId 字段后面的引号之间的值粘贴到 “” (引号) 之间: 导入配置

  5. 返回 云门户,转到 身份和访问管理 门户和 API 访问 选项卡。在“命名 您的安全客户端”框中输入要用来标识此 API 密钥的名称 。然后单击“创建客户端”按钮。注意: 此操作将生成 Client IDSecret Key导入配置

  6. 逐个复制 IDSecret 值(将它们粘贴到 CustomerInfo.yml 文件中,如以下步骤所示)。然后单击“下载”保存文件以供以后参考。 导入配置

  7. IDSecret 值粘贴到 CustomerInfo.yml 文件的相应字段中: 导入配置

手动更新区域映射文件 (ZoneMapping.yml)

本地区域 无法自动迁移到 云资源位置,因此必须使用 ZoneMapping.yml 文件对其进行映射。注意: 如果区域未映射到同名资源位置(具有 完全相同名称的资源位置),则会发生迁移失败。

  1. 返回到 .yml 文件所在的同一目录位于 (Documents\Citrix\AutoConfig) 中,使用记事本或您首选的文本编辑器打开 ZoneMapping.yml注意: Primary 值必须替换为要从中迁移对象的对应区域的名称(在本地环境中)。 区域映射

  2. 您可以在 本地 Citrix Studio 控制台 > 配置 > 区域下找到此名称。注意: 如果您的区域 Primary 在本地环境中命名,则无需更改 ZoneMapping.yml 文件中的此值: 区域映射

  3. 仍然在 ZoneMapping.yml 文件中,Name_Of_Your_Resource_Zone 值必须替换为云资源位置名称。此值可以在 云门户 的“汉堡”菜单 >“资源位置区域映射”下找到

  4. 复制您的 资源位置名称 (如 My Resource Location 以下屏幕截图所示): 区域映射

  5. 将此值而不是值粘贴到 ZoneMapping.yml 文件上: 区域映射 `Name_Of_Your_Resouce_Zone`

  • 注意: 本地环境中的多个区域也可以映射到云中的 一个资源位置 。但是,对于 本地环境 中的 每个区域,文件中始终必须有一行。对于 本地多个区域一个资源位置,此文件的格式如下所示:

区域映射

区域 映射到不同的 资源位置时,文件必须如下所示:

区域映射

手动更新 CvadAcSecurity.yml 文件

主机连接 及其关联的虚拟机管理程序可以迁移到 Citrix DaaS。添加 主机连接 需要特定虚拟机管理程序的安全信息。这些信息需要手动添加到 CvadAcSecurity.yml 文件中。注意 在本示例中,我们使用的是 Citrix Hypervisor。有关其他虚拟机管理程序类型所需的安全信息的信息,请访问 Citrix DaaS 产品文档网站。

  1. 返回到 .yml 文件所在的同一目录位于 (Documents\Citrix\AutoConfig) 中,使用记事本或您首选的文本编辑器打开 CvadAcSecurity.yml虚拟机管理程序安全

  2. CvadAcSecurity.yml 文件中,为虚拟机管理程序连接输入 usernamepassword,然后保存文件。 虚拟机管理程序安全

合并配置

  1. 返回 迁移工具 PowerShell 控制台,运行以下命令: Merge-CvadAcToSite 将现有云配置(如果存在)与从本地站点导出的配置合并。 合并配置

  2. 当每个任务成功运行时,输出将显示为绿色,因为导入了 .yml 文件并将相应的组件添加到云站点: 合并配置

  3. 生成的文件显示在以下目录中: <This PC>\Documents\Citrix\AutoConfig\Import_<YYYY_MM_DD_HH_mm_ss> 合并配置

  4. 在同一个文件夹中,您可以找到一个 Backup_YYYY_MM_DD_HH_mm_ss 文件夹。注意: 将此文件夹复制到安全的地方,因为它是配置的备份。

  5. Backup 文件夹包含以下文件,如果需要,这些文件有助于还原更改: 合并配置

验证在 Cloud Studio 中创建的配置

  1. 通过云控制台 > 我的服务 > Citrix DaaS >“管理”选项卡访问您的 Citrix DaaS 管理选项卡)。 验证配置

  2. 刷新以确保计 算机目录交付组策略、标记应用程序现在按预期显示。注意:根据您导入的内容,结果因为它们特定于您自己的唯一配置而有所不同。查看每个部分 ,确保列出了预期的商品。

  • 计算机目录列出示例:

验证配置

如果一切看起来都符合预期,则您的 Citrix DaaS 迁移已完成。

故障排除提示

故障排除的一般信息:

  • 请参阅 自动配置工具故障排除常见问题解答文章
  • 在通过 Citrix 打开支持票证之前,请通过运行 New-CvadAcZipInfoForSupport 将所有日志和 *.yml 文件收集到单个 zip 中。不包括客户安全信息。将 zip 文件转发到以下位置 %HOMEPATH%\Documents\Citrix\AutoConfig\CvadAcSupport_yyyy_mm_dd_hh_mm_ss.zipNew-CvadAcZipInfoForSupport
  • 运行任何 cmdlet 都会在 主历史日志文件中创建一个日志文件和条目。这些条目包含执行的日期、操作、结果、备份和日志文件位置。此日志提供了潜在的解决方案和常见错误的修复。
  • 主历史记录日志位于 %HOMEPATH%\Documents\Citrix\AutoConfig 中,在名为 History.Log 的文件中。* 所有操作日志文件都放在备份文件夹中。
  • 所有日志文件名以 CitrixLog 开头,然后显示 cmdlet 执行的 auto-config 操作以及 datetimestamp
  • 日志 不会 自动删除。
  • 可以使用 -quiet 参数禁止控制台日志记录

相关详细信息:

  1. 您也可以通过 支持论坛联系我们

  2. 阅读 自动配置工具文档

  3. 从直接下载 网站链接下载新版本

  4. 观看我们的 8 月 19 日点播网络研讨会录像 -“为什么 Citrix Cloud 迁移比以往任何时候都容易”。我们分享了有关该工具的更多信息,并与 Citrix 专家小组一起主持了 现场问答环节

  5. 有关更多信息和 官方文档 ,请参阅 Citrix DaaS 迁移到云部分。

  6. 如果在查询之前列出的信息后,您仍需要帮助,请与 Citrix 代表、客户成功经理或支持联系。