自动化配置的故障排除和相关附加信息

重要：

有关自动化配置中常见的错误消息和相应的解决方案，请参阅知识中心文章 CTX277730 中的 故障排除常见问题。

自动化配置工具错误

自动化配置工具操作有时会产生错误。发生这种情况时，例如在处理计算机目录、交付组或组策略等组件时，可能会出现故障。使用 OnErrorAction 和延续参数可让您在处理过程中捕获错误、解决错误并从中断处继续。

默认的 OnErrorAction 值为 StopCompEnd。发生错误时，工具会完成当前组件的处理。不会处理其他组件，并且错误不会传递到下游的依赖组件。解决任何错误后，您可以重新运行应用了任何延续参数的 cmdlet。

OnErrorAction parameter

您可以在迁移命令上定义 OnErrorAction 参数值，以控制工具如何响应在处理组件时发现的错误。

本表展示了参数值及其对应的描述：

迁移命令小程序

您可以将 OnErrorAction 参数应用于以下迁移命令：

• Compare-CvadAcToSite
• Import-CvadAcToSite
• Merge-CvadAcToSite
• New-CvadAcToSite
• Restore-CvadAcToSite

示例：Merge-CvadAcToSite -OnErrorAction StopImmediately

恢复操作参数

这些参数定义了工具在操作因错误暂停或停止后如何恢复。

您可以将恢复参数应用于包含以下 OnErrorAction 参数值之一的迁移 cmdlet：

• Pause
• StopCompEnd
• StopImmediately

此表列出了参数值及其对应的说明：

最后处理的组件存储在 AutoConfig 文件夹中的 CurrentComponent.txt 文件中。不建议编辑此文件。 如果指定 -Resume 或 -Repeat，并且 CurrentComponent.txt 缺失或无效，则处理将停止，并提示您选择一个组件。

Setting the OnErrorAction in the CustomerInfo.yml file

您还可以在 CustomerInfo.yml 文件中设置 OnErrorAction 值。使用以下 cmdlet 设置这些值：

• 对于新文件：New-CvadAcCustomerInfoFile -OnErrorAction Continue | Pause | StopCompEnd | StopImmediately
• 对于现有文件：Set-CvadAcCustomerInfoFile -OnErrorAction Continue | Pause | StopCompEnd | StopImmediately

日志

运行任何 cmdlet 都会创建日志文件并在主历史日志文件中生成一个条目。所有操作日志文件都放置在备份文件夹中。所有日志文件名都以 CitrixLog 开头，然后显示自动配置操作以及 cmdlet 执行的日期和时间戳。日志不会自动删除。

主历史日志位于 *%HOMEPATH%\Documents\Citrix\AutoConfig* 中，文件名为 History.Log。每次 cmdlet 执行都会生成一个主日志条目，其中包含执行的日期、操作、结果、备份和日志文件位置。

您还可以使用 New-CvadAcZipInfoForSupport cmdlet 收集日志，以便发送给 Citrix 以获取支持。此 cmdlet 会将所有日志和 .yml 文件压缩到一个 zip 文件中。客户敏感信息（CustomerInfo.yml 和 CvadAcSecurity.yml）不包含在此 zip 文件中。Icon.yml 文件也因其大小而被排除。该 zip 文件将放置在 %HOMEPATH%\Documents\Citrix\AutoConfig 中，并根据日期和时间戳命名为 CvadAcSupport_yyyy_mm_dd_hh_mm_ss.zip。此 zip 文件还可以用作备份。

每个日志文件都包含以下内容：

• 操作的名称以及检查模式是否已启用
• 开始和结束日期及时间
• 每个组件操作的多个条目以及成功/失败通知
• 所采取操作的摘要，包括创建对象的各种计数
• 在适用的情况下建议的修复措施
• 适用的备份文件夹位置
• 主日志位置
• 持续时间

诊断文件

诊断文件可帮助您确定和解决问题。运行操作时会创建以下文件。它们位于 %HOMEPATH%\Documents\Citrix\AutoConfig 下特定于操作的子文件夹中。在提供问题解决支持信息时，请包含这些文件。

导出

PoshSdk_yyyy_mm_dd_hh_mm_ss.ps1

此文件统计为将站点配置导出到文件而进行的所有 Broker PowerShell SDK 调用。

导入、合并、还原、同步、备份、比较

Transaction_yyyy_mm_dd_hh_mm_ss.txt

此文件记录每个 Rest API 调用和相关信息。

RestApiContent_yyyy_mm_dd_hh_mm_ss.txt

此文件包含所有 Add、Update 和 Delete Rest API 内容。

由于依赖项而产生的问题

导入和合并可能会因缺少依赖项而失败。一些常见问题包括：

1. 组策略缺少交付组筛选器。导致此问题的常见原因是交付组尚未导入。
2. 应用程序导入或合并失败。常见原因是缺少未导入的交付组或应用程序组。
3. 应用程序组缺少 RestrictToTag。常见原因是未导入标签。
4. 主机连接失败。常见原因是 CvadAcSecurity.yml 文件中缺少安全信息。
5. 计算机目录失败。常见原因是未导入主机连接。
6. 计算机目录和交付组中缺少计算机。常见原因是未在 Active Directory 中找到计算机。
7. 交付组中缺少用户。常见原因是未在 Active Directory 中找到用户。

推荐事项

• 请勿同时运行多个自动化配置实例。同时运行多个实例会在云站点中产生不可预测的结果。如果发生这种情况，请重新运行一个自动化配置实例，使站点恢复到预期状态。
• 在运行自动化配置时，请勿在 Studio 中操作或更改数据。
• 始终在 Studio 中目视验证合并、导入或还原结果，以确保云站点符合预期。

文件夹

默认文件夹根位置

所有自动化配置工具操作都在根文件夹或其内部的子文件夹中进行。根文件夹位于 %HOMEPATH%\Documents\Citrix\AutoConfig。

导出

所有导出的文件都放置在两个文件夹位置，以方便使用并提供导出历史记录。导出的文件始终放置在根文件夹中。副本放置在名为 Export 的子文件夹中，其中包含导出日期和时间。

根文件夹始终包含最新的导出的本地站点配置。每个 Export 子文件夹都包含在指定日期和时间完成的导出，这维护了导出历史记录。您可以使用任何 Export 子文件夹来配置云站点。自动化配置不会删除或修改现有的导出子文件夹。

导入/合并/同步/比较

Import、Merge 和 Compare 操作始终源自根文件夹中的文件。每个操作都会创建一个子文件夹，根文件夹中的文件将复制到该子文件夹中，从而提供云站点更改源文件的历史记录。

还原

Restore 操作使用现有子文件夹配置云站点。源文件夹在必需的 -RestoreFolder 参数上指定。与其他命令不同，不会创建新的子文件夹，因为 Restore 操作使用现有子文件夹。还原文件夹可以是根文件夹，但仍必须在 -RestoreFolder 参数上指定。

备份

自动配置会初始化、更新和备份云站点配置。随着时间的推移，云站点上可能会更改许多不同的配置。为了便于长期使用和保留历史更改，自动配置使用一种保留方案来保存此更改历史记录，并提供一种还原早期状态的方法。

云站点配置备份始终在名为 Backup 的子文件夹中进行，其中包含备份的日期和时间。自动配置不会删除或修改现有的导出子文件夹。

您可以使用备份来还原特定组件或整个配置。要还原整个交付组和计算机目录组件，请使用以下 cmdlet：

Restore-CvadAcToSite -RestoreFolder %HOMEPATH%\Documents\Citrix\AutoConfig/Backup_yyyy_mm_dd_hh_mm_ss -DeliveryGroups -MachineCatalogs

注意：

上述 cmdlet 中的备份文件信息基于您自己的备份。

要还原整个云站点配置，请使用以下 cmdlet：

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

注意：

上述 cmdlet 中的备份文件信息基于您自己的备份。

更改默认根文件夹

Export、Import、Merge、Sync 和 Compare 操作可以使用 –AlternateFolder 参数更改默认根文件夹。每个操作子文件夹的创建和管理与之前描述的相同。

复制到子文件夹的文件

所有具有“.yml”扩展名的文件都将复制到操作子文件夹，但以下文件除外：

• 客户信息.yml
• 区域映射.yml
• CvadAcSecurity.yml

自动故障安全云站点备份

在运行更改配置的操作之前，会创建当前云站点配置的备份。这包括 Import、Merge、Sync 和 Restore 参数。备份始终位于操作子文件夹下的子文件夹中。

对于 Restore，备份文件夹是 -RestoreFolder 参数上指定的文件夹的子文件夹。

自动化

自动化配置工具 cmdlet 可以在自动化脚本中运行，无需管理员干预，方法是抑制提示和在 cmdlet 完成时显示日志结果。您还可以使用 CustomerInfo.yml 文件设置参数以实现相同目的。

将以下参数添加到云修改 cmdlet 以抑制提示的显示。

-Confirm $false

将以下参数添加到 cmdlet 以抑制在 cmdlet 完成时显示日志。

-DisplayLog $false

将以下参数添加到 cmdlet 以禁止向 PowerShell 命令窗口记录日志。

-Quiet

作为另一种方法，可以将以下参数放置在 CustomerInfo.yml 文件中。

Confirm: False

DisplayLog: False

从 交付控制器™ 以外的个人电脑导出

自动化配置工具使用多个 Citrix PowerShell SDK 将本地站点配置导出到文件。这些 SDK 会自动安装在交付控制器上，使工具无需额外操作即可在交付控制器上运行。在非交付控制器计算机上运行时，需要安装工具所需的 Citrix PowerShell SDK 集。此 SDK 集是 Citrix Studio 的一部分，可以从 Citrix Virtual Apps and Desktops™ 安装介质安装。

注意：

自动化配置无法在 Cloud Connector 上运行。

迁移到 Citrix Cloud™ 政府版 和 日本控制平面

Citrix Cloud Government 和 Japan Control Plane 环境使用不同的访问点来验证和分配访问令牌。此独特要求适用于任何访问云的自动化配置工具。请执行以下步骤以在这些环境中使用自动化配置。

1. In the %HOMEPATH%\Documents\Citrix\AutoConfig folder, edit CustomerInfo.yml.

2. 根据您要连接的环境，将以下行之一添加到 CustomerInfo.yml（如果已存在，则进行更改）。

   Environment: 'ProductionGov'

   或

   Environment: 'ProductionJP'

自动化配置现在可以在这些环境中使用了。

Citrix 云数据收集

有关 Citrix 云收集的信息，请参阅 Citrix 云服务客户内容和日志处理。

更多参考资料

讨论论坛

访问 Citrix 自动化配置讨论论坛。

视频

在 YouTube 上观看 Citrix 虚拟应用和桌面自动化配置工具幕后揭秘。

培训

云学习中心包含构建服务部署的分步视频指南，其中包括本文中描述的任务。请参阅 将 Citrix Virtual Apps and Desktops 迁移到 Citrix Cloud 学习路径。