概念证明:自动配置工具

概述

自动配置工具 便于将配置迁移和导出到 Citrix Virtual Apps and Desktops 服务 (CVADS)。本概念验证指南说明了有关如何使用此工具的分步说明。

管理员可以轻松测试和探索 Citrix Virtual Apps and Desktops 服务 (CVADS) 的功能和优势,同时运行现有的本地环境,甚至可以促进在云区域之间移动、备份现有配置和其他使用案例。自动配置下载链接 还包含有关使案自定义设置中的其他信息详细的文档

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

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

通过多次运行该工具,可以分阶段执行迁移,从而使管理员能够轻松实现所需的配置状态。

为什么要使用这个工具?

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

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

这个工具是如何实施的?

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

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

必备条件

本地环境

  • 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 管理单元 。此安装程序可以在相应版本的 Product ISO 安装介质上找到,该安装程序可从 Citrix 下载 > Citrix Virtual Apps and Desktops 网站获取。
  • 官方下载网站 下载自动配置工具 MSI。

与云相关的组件

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

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

  1. 完成本地先决条件
  2. 将本地站点配置导出到 YAML (.yml) 文件中
  3. 完成云的先决条件
  4. 使用不同的置备方法(预配服务 (PVS) 和计算机创建 Provisioning Services (MCS))时,完成导入站点配置的必要条件
  5. 将站点配置导入云端(通过编辑所需的文件)
  6. 故障排除提示以及在哪里可以找到更

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

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

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

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

导出本地站点配置

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

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

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

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

导出配置

  • 注意: 如有必要,请将 .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 目录 及其相应的应用程序需要额外的步骤。在继续导入 用程序设置之前,请按照以下说明准备环境。

注意: 执行这些操作后,请按照本指南 将站点配置导入云部分中提到的步骤进行操作。

  1. 以管理员身份运行 PowerShell
  2. 键入以下命令, Export-CvadAcToFile<!--NeedCopy--> 然后按键盘上的 Return(Enter)置备方法 PVS

  3. 成功完成的商品将以绿色 OK<!--NeedCopy--> 显示。该工具运行完成后,会显示如下屏幕: 置备方法 PVS

  4. 访问 C:\Users\<username>\Documents\Citrix\AutoConfig<!--NeedCopy--> 文件夹并打开 CvadAcSecurity.yml<!--NeedCopy--> 文件,您必须对其进行编辑才能使 PVS 正常工作。注意:用户名 ” 和 “ 密码 ” 字段指的是 PVS 站点服务器 凭据。请务必将登录指定为 DOMAIN\Username<!--NeedCopy--> ,添加密码,然后在准备就绪后保存文件。 置备方法 PVS

处理计算机创建服务 (MCS):池(随机)和 RDS 计算机目录

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

目前,此工具不支持以自动方式导入 MCS 计算机目录或其相应的交付组。但是,您仍然可以使用此工具自动导入其他配置,例如应用程序、策略和其他配置。

您必须手动创建主机连接、计算机目录、交付组和电源方案。目录和交付组名称必须与本地设置匹配。创建这些资源后,您可以使用自动配置工具自动执行应用程序、应用程序组、应用程序文件夹、标记创建和策略。

在继续导入应用程序设置之前,请按照以下步骤准备环境:

  1. 在您选择的 Hypervisor 或云提供商上,根据环境中的可用容量,根据需要创建任意数量的虚拟机。请注意,虚拟机管理程序容量在本地环境和云环境之间共享,因此您可以根据可用资源创建尽可能多的计算机。

  2. 云门户 中,像平常一样创建您的主机连接注意: 如果需要,请参阅 本指南 以获取有关如何设置主机连接的信息。

  3. 仍然在 Cloud Studio 中,像平常一样创建 MCS 计算机目录 ,并将其命名 方式与现有本地目录的命名方式完全相同 。选择所需的操作系统类型、主映像、存储、许可、网络和帐户设置。重要提示: 确认本地和 CVADS 目录上的名称匹配。请注意,您可以创建的计算机数量取决于可用的虚拟机管理程序资源。 注意: 如果需要,请参阅 本指南 以获取有关如何设置目录的信息。

  4. 接下来,在 Cloud Studio中,为新目录创建相应的 交付组 ,并确保您也将其命名为相应的 内部部署交付组注意: 有关如何创建计算 机目录交付组的更多详细信息,请参阅 [此 guide/zh-cn/tech-zone/learn/poc-guides/cvads.html)。

  5. 接下来,如果你有任何 电源方案 ,它们必须手动应用于计算机。
  6. 您可以继续导入其余的设置。请参阅本指南 MCS 静态分配的 VDI 部分中提到的步骤。

处理计算机创建服务 (MCS):静态分配的计算机

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

目前,静态分配的计算机目录无法像迁移到 CVADS 云帐户那样迁移。您可以使用此工具自动导入其他配置,例如应用程序和策略。

手动创建托管连接、计算机目录(作为这些计算机的非置备目录)和交付组,所有这些都与本地等效项完全相同。请注意,电源方案不适用于未配置的目录。创建后,您可以使用自动配置工具自动执行应用程序、应用程序组、应用程序文件夹、标记创建和策略。

在继续使用此工具导入应用程 设置和其他对象之前,请按照以下步骤准备环境。

  1. 云门户 中,单击汉堡菜单 > 我的服务 > Virtual Apps and Desktops 服务 > 管理选项卡,然后在左侧展开配置节点,然后单击托管,像往常一样创建主机连接注意: 如果需要,请参阅 本指南 以获取有关如何设置主机连接的信息。

  2. 仍然在 Cloud Studio 中将 MCS 计算机目录 创建为非预配的物理目录。目录的命名 方式与 现有本地目录的命名方式 全相同。选择所需的操作系统类型、主映像、存储、许可、网络和帐户设置。重要提示: 确认本地和 CVADS 目录上的名称匹配。 注意: 如果需要,请参阅 本指南 以获取有关如何设置目录的信息。

  3. 接下来,在 Cloud Studio中,为新目录创建相应的 交付组 ,并确保您也将其命名为相应的 内部部署交付组注意: 有关如何创建计算 机目录交付组的更多详细信息,请参阅 [此 guide/zh-cn/tech-zone/learn/poc-guides/cvads.html)。

  4. 按照本节中的说明,按照有关如何导入应用程序、组、文件夹和标记的说明进行操作
  5. 一旦所有对象都存在,请确保更新 ListofDDCS 注册表项并将其指向 Citrix Cloud Connector FQDN 或 IP 地址。这可以在注册表中手动完成,也可以通过组策略完成,目的是让计算机根据 Cloud Connector 进行注册。

处理计算机创建服务 (MCS):导入应用程序、应用程序组、文件夹和标记

注意: 在继续导入这些设置之前,必须首先遵循有关池和 RDS 计算机目录以及静态分配的说明。根据您的需要,请参阅MCS 汇集和 RDS VDIMCS 静态分配的 VDI上提到的步骤。应用于目录、应用程序、应用程序文件夹和应用程序组的标记将迁移,但应用于计算机的标记可能无法正确迁移

  1. 在本地环境的 Citrix Studio中,在 “ 应用程序 ” 节点下,确认所需的应用程序属于匹配的 交付组。选择所需的应用程序,然后右键单击该应用程序以转到 属性 ,如下所示: 置备方法 MCS

  2. 单击 “ 群组 ” 节点以确认有问题的应用程序所属的群组: 置备方法 MCS

  3. 返回 PowerShell 控制台,运行 合并命令并 使用 byDeliveryGroupName 标志,该标志按交 付组 名称筛选 用程序。完整的语法示例: Merge-CvadAcToSite –Applications $true –ByDeliveryGroupName <DG_name><!--NeedCopy--> 置备方法 MCS

  4. 按键盘上的 Return(Enter) 运行命令并键入 yes<!--NeedCopy--> 以继续。 置备方法 MCS

  5. 成功执行和完成后,输出将类似于以下内容: 置备方法 MCS

  6. Cloud Studio 控制台上,转到 “应用程 ” 节点并刷新以确保应用按预期列出。选择应用程序,然后转到应用 程序属性 > 组 进行仔细检查。

  • 运行迁移工具之前,应用程序文件夹在 Cloud Studio

置备方法 MCS

  • 运行迁移工具后,Cloud Studio 中的应用程序文件夹

置备方法 MCS

处理机器创建服务 (MCS):导入与 MCS 相关的策略

注意: 策略可应用于已标记的计算机。

执行之前的操作后,如果需要导入与 MCS 计算机目录交付组关联的策略,请按照以下说明操作:

  1. PowerShell 控制台中运行 Merge-CvadAcToSite -GroupPolicies $true<!--NeedCopy--> 命令并键入 yes<!--NeedCopy--> 以继续,如以下屏幕截图所示,然后按键盘上的 Return (Enter) 键: MCS 的策略

  2. 成功执行会显示类似的输出(Added<!--NeedCopy--> 值)。以下屏幕截图还显示了没有更改的行的结果 (No Change)<!--NeedCopy--> MCS 的策略

  3. 执行后,刷新 Cloud Studio 窗口并访问左侧的 “ 策略 ” 节点。 MCS 的策略

  4. 选中 分配给 的策略选项卡,并将其与本地策略分配进行比较,如以下示例所示:

  • 本地 Studio:

MCS 的策略

  • 云 Studio:

MCS 的策略

将站点配置导入云

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

获取客户连接详情

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

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

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

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

  4. CustomerInfo.yml<!--NeedCopy--> 文件中 CustomerID 字段 后面的 引号之 间,在 “”<!--NeedCopy--> (引号)之间粘贴检索到的值: 导入配置

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

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

  7. ID<!--NeedCopy--> Secret<!--NeedCopy--> 值粘贴到 CustomerInfo.yml<!--NeedCopy--> 文件中的相应字段中: 导入配置

手动创建区域映射文件 (zonemApping.yml)

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

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

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

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

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

  5. 将此值粘贴到 ZoneMapping.yml<!--NeedCopy--> 文件中,而不是 Name_Of_Your_Resouce_Zone<!--NeedCopy--> 值: 区域映射

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

区域映射

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

区域映射

合并配置

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

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

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

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

  5. Backup<!--NeedCopy--> 文件夹包含以下文件,如果需要,这些文件有助于恢复更改: 合并配置

验证在 Cloud Studio 中创建的配置

  1. 通过 云控制台 > 我的服务 > Virtual Apps and Desktops 服务 > 管理选项卡)访问 Virtual Apps and Desktops 服务管理选项卡)。 验证配置

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

  • 计算机目录列出示例:

验证配置

如果一切都像预期一样,那么 CVADS 迁移已完成。

故障排除提示

故障排除的一般信息:

  • 运行任何 cmdlet 都会在 主历史日志文件中创建一个日志文件和条目。这些条目包含执行的日期、操作、结果、备份和日志文件位置。此日志提供了潜在的解决方案和常见错误的修复。
  • 主历史记录日志位于 %HOMEPATH%\Documents\Citrix\AutoConfig<!--NeedCopy--> 中,在名为 History.Log<!--NeedCopy--> 的文件中。* 所有操作日志文件都放在备份文件夹中。
  • 所有日志文件名以 CitrixLog<!--NeedCopy--> 开头,然后显示 cmdlet 执行的 auto-config<!--NeedCopy--> 操作以及 datetimestamp
  • 日志 不会 自动删除。

相关详细信息:

  1. 请参阅 自动配置工具疑难解答 FAQ

  2. 也可以通过 支持论坛 进行访问。

  3. 查看我们的 8 月 19 日点播网络研讨会录音 - “为什么 Citrix Cloud 迁移比以往任何时候都轻松”在那里我们分享了有关该工具的更多信息,并与 Citrix 专家小组主持了 实时问答会议

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