Citrix DaaS

自动配置故障排除及其他信息

重要提示:

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

自动配置工具错误

自动配置工具操作有时会产生错误。发生这种情况时,例如,在处理计算机目录、交付组或组策略等组件时可能会出现故障。使用 OnErrorAction 和延续参数允许您在处理过程中发现错误,解决错误,然后从上次中断的地方继续操作。

默认 OnErrorAction 值为 StopCompEnd。出现错误时,该工具将完成对当前组件的处理。不处理任何其他组件,错误不会延续到下游的依赖组件。解决任何错误后,可以在应用任何延续参数的情况下重新运行 cmdlet。

OnErrorAction 参数

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

下表显示了参数值及其说明:

说明
Continue 尝试处理尽可能多的所有组件。
Pause 处理结束时暂停,提示您继续或停止。
StopCompEnd 尝试处理尽可能多的组件。组件完成后停止。(默认)
StopImmediately 发现错误后,处理就会停止。

迁移 cmdlet

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

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

示例:Merge-CvadAcToSite -OnErrorAction StopImmediately

恢复参数

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

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

  • Pause
  • StopCompEnd
  • StopImmediately

下表显示了参数值及其说明:

说明
-AllRemaining 需要起始组件。处理从起始组件开始,并处理所有剩余组件。处理多个组件。
-Resume 使用 CurrentComponent.txt 中的组件作为起点。所有剩余的都设置为 true。处理多个组件。
-Repeat 使用 CurrentComponent.txt 中的组件作为起点。所有剩余的都设置为 false。只处理一个组件。

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

在 CustomerInfo.yml 文件中设置 OnErrorAction

您也可以在 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

此文件将计算进行的所有代理 PowerShell SDK 调用数量,以将站点配置导出到文件。

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

Transaction_yyyy_mm_dd_hh_mm_ss.txt

此文件记录了每个 REST API 调用及相关信息。

RestApiContent_yyyy_mm_dd_hh_mm_ss.txt

此文件包含所有 AddUpdateDelete REST API 内容。

依赖关系引起的问题

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

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

建议

  • 一次不要运行多个自动配置实例。运行多个并发实例会导致在云站点中产生不可预知的结果。如果出现这种情况,请重新运行一个自动配置实例,使站点恢复到预期状态。
  • 运行自动配置时,请勿在“完整配置”的“管理”选项卡中使用或更改数据。
  • 务必在“完整配置”中直观地验证合并、导入或还原结果,以确保云站点符合预期。

文件夹

默认文件夹根位置

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

导出

所有导出的文件均位于这两个文件夹位置,以方便使用并提供导出历史记录。导出的内容始终位于根文件夹中。副本位于名为 Export 的子文件夹中,并显示了导出日期和时间。

根文件夹包含的永远都是导出的最新本地站点配置。每个 Export 子文件夹都包含在指定日期和时间完成的导出,并保留导出的历史记录。您可以使用任何 Export 子文件夹来配置云站点。自动配置不会删除或修改现有的导出子文件夹。

导入/合并/同步/比较

ImportMergeCompare 操作始终源自位于根文件夹中的文件。每个操作都会创建一个用于将根文件夹中的文件复制到的子文件夹,从而提供云站点更改源文件的历史记录。

Restore(还原)

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 中的备份文件信息基于您自己的备份。

更改默认根文件夹

ExportImportMergeSyncCompare 操作可以通过使用 –AlternateFolder 参数来更改默认根文件夹。每个操作子文件夹的创建和管理与之前所述的方式相同。

复制到子文件夹中的文件

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

  • CustomerInfo.yml
  • ZoneMapping.yml
  • CvadAcSecurity.yml

自动防故障云站点备份

在运行更改配置的操作之前,先备份当前云站点配置。此配置包括 ImportMergeSyncRestore 参数。备份始终位于操作子文件夹下方的子文件夹中。

如果使用 Restore,则备份文件夹是通过 -RestoreFolder 参数指定的文件夹的子文件夹。

自动化

自动配置工具 cmdlet 可以在没有管理员干预的情况下在自动化脚本中运行,方法是在 cmdlet 完成时抑制提示和显示日志结果。此外,您也可以通过使用 CustomerInfo.yml 文件来设置参数以执行相同的操作。

将以下参数添加到云修改 cmdlet 以禁止显示提示。

-Confirm $false

将以下参数添加到 cmdlet 中,以禁止在 cmdlet 完成运行时显示日志。

-DisplayLog $false

请将以下参数添加到 cmdlet 中以禁止记录到 PowerShell 命令窗口。

-Quiet

另一种方法是将以下参数置于 CustomerInfo.yml 文件中。

Confirm: False

DisplayLog: False

从 Delivery Controller 以外的 PC 导出

自动配置工具使用多个 Citrix PowerShell SDK 将本地站点配置导出到文件中。这些 SDK 将自动安装在 Delivery Controller 上,从而无需执行额外操作即可在 Delivery Controller 上运行该工具。在非 Delivery Controller 计算机上运行时,需要安装该工具所需的 Citrix PowerShell SDK 集。此 SDK 集是 Citrix Studio 的一部分,后者可通过 Citrix Virtual Apps and Desktops 安装介质进行安装。

注意:

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

转向 Citrix Cloud Government 和 Japan Control Plane

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

  1. %HOMEPATH%\Documents\Citrix\AutoConfig 文件夹中,编辑 CustomerInfo.yml。
  2. 根据要连接到的环境,将以下行之一添加到 CustomerInfo.yml 中(或进行更改,如果已存在)。

    Environment: 'ProductionGov'

    或者

    Environment: 'ProductionJP'

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

Citrix Cloud 数据收集

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

其他资源

论坛

访问针对自动配置的 Citrix Discussions 论坛

视频

观看 YouTube 上的 Under the Hood of the Automated Configuration Tool for Citrix Virtual Apps and Desktops(适用于 Citrix Virtual Apps and Desktops 的自动配置工具的高级选项)。

培训

Cloud Learning Center 包含构建服务部署的分步视频指南,其中包括本文中介绍的任务。请参阅将 Citrix Virtual Apps and Desktops 迁移到 Citrix Cloud 学习路径

自动配置故障排除及其他信息