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

此文件统计为将站点配置导出到文件而进行的所有 Broker 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 中未找到用户。

建议

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

文件夹

默认文件夹根位置

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

导出

所有导出的文件都放置在两个文件夹位置,以提供易用性和导出历史记录。导出的文件始终放置在根文件夹中。副本放置在名为 Export 的子文件夹中,并带有导出日期和时间。

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

导入/合并/同步/比较

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

还原

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

备份

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

云站点配置备份始终会保存到名为 Backup 的子文件夹中,其中包含备份的日期和时间。Automated Configuration 不会删除或修改现有导出子文件夹。

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

[[CODE_BLOCK_0]]

注意:

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

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

[[CODE_BLOCK_1]]

注意:

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

更改默认根文件夹

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

复制到子文件夹的文件

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

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

自动故障安全云站点备份

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

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

自动化

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

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

[[CODE_BLOCK_2]]

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

[[CODE_BLOCK_3]]

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

[[CODE_BLOCK_4]]

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

[[CODE_BLOCK_5]]

[[CODE_BLOCK_6]]

从 Delivery Controller™ 以外的 PC 导出

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

注意:

Automated Configuration 无法在 Cloud Connector 上运行。

迁移到 Citrix Cloud™ Government 和 Japan Control Plane

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

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

    [[CODE_BLOCK_7]]

    [[CODE_BLOCK_8]]

Automated Configuration 现在可以在这些环境中使用。

Citrix Cloud 数据收集

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

其他资源

讨论论坛

访问 Citrix Automated Configuration 讨论论坛

视频

在 YouTube 上观看 Citrix Virtual Apps and Desktops Automated Configuration 工具幕后揭秘

培训

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

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