用于迁移的自动化配置工具 cmdlet

本页列出了该工具支持的所有 cmdlet 和参数，用于迁移用例。

所有 cmdlet 都接受以下类型之一的参数。

• 字符串
• 字符串列表
• 布尔值：$true 或 $false
• SwitchParameter：参数存在表示 $true；参数不存在表示 $false

注意：

SwitchParameter 是 true 或 false 选择的首选方法，但由于历史遗留问题，工具中仍使用布尔值。

下表是所有 cmdlet 的摘要。请参阅每个单独的部分，以了解每个 cmdlet 支持哪些参数。

有关参数及其使用方法的更多信息，请参阅精细迁移参数。

基本命令

本地到云 cmdlet

• Export-CvadAcToFile - 将本地文件导出到 YAML 文件。

  从本地设置导出配置。这是自动化配置的默认导出操作。不会对本地站点配置进行任何修改。导出的文件将放置在目录 %HOMEPATH%\Documents\Citrix\AutoConfig 中一个唯一命名的 Export 子文件夹内。文件夹 %HOMEPATH%\Documents\Citrix\AutoConfig 始终包含最新的导出本地站点配置。

  参数：

  名称	功能描述	必需？	类型
  按组件进行迁移	请参阅按组件迁移		切换参数
  按对象名称筛选	请参阅 按对象名称筛选		字符串列表
  TargetFolder	指定导出目标文件夹。		字符串
  Locale	指定可导出的人类可读文本所使用的语言。		字符串
  Quiet	禁止向控制台记录日志。		开关参数
  AdminAddress	当导出操作未在交付控制器上执行时，请指定交付控制器的 DNS 或 IP 地址。		字符串
  CheckUserAndMachines	验证用户和计算机是否在 Active Directory 中。不在 Active Directory 中的用户和计算机可能导致导入失败。		$true 或 $false
  ZipResults	将备份的 YAML 文件压缩成一个 zip 文件。该文件与备份的 YAML 文件位于同一文件夹中，并与该文件夹同名。		开关参数

  返回：

  • 请参阅 Cmdlet 返回值

有三种将数据导入云端的方法。运行特定的 cmdlet 可能会导致云站点上出现以下三种操作组合之一：

• 添加、更新和删除
• 仅添加和更新
• 仅添加

• Import-CvadAcToSite - 将 YAML 文件导入云端。支持创建、更新和删除操作。

  将所有本地文件导入云端。此命令可确保云端最终状态与本地状态一致。此选项会删除云端中存在的任何更改。导入的站点配置文件源自 %HOMEPATH%\Documents\Citrix\AutoConfig。请谨慎使用。

  参数：

  名称	说明文字	必需？	类型
  按组件进行迁移	请参阅按组件迁移。		切换参数
  按对象名称筛选	请参阅按对象名称筛选。		字符串列表
  用于访问云的参数	请参阅云访问参数。		切换参数
  SourceFolder	此参数用于指定一个替代的根文件夹路径，该路径将取代默认的 %HOMEPATH%\Documents\Citrix\AutoConfig。		字符串
  Locale	指定可以导出的人类可读文本的语言。		字符串
  Quiet	禁止向控制台记录日志。		开关参数
  DisplayLog	在 cmdlet 完成时显示日志文件。设置为 $false 可禁止显示日志。		$true 或 $false
  Merge	设置为 $true 时，仅将组件添加到云站点。不删除组件。设置为 $false 可删除组件。		$true 或 $false
  AddOnly	设置为 $true 时，仅添加新组件，不更新或删除现有组件。设置为 $false 可允许更新和删除。当此参数为 $true 时，将忽略 Merge。		$true 或 $false
  MergePolicies	合并策略设置和筛选器。仅当要导入的策略已存在于云 DDC 中时，才会发生合并。合并策略的结果是，云 DDC 策略除了包含正在导入的任何新设置和筛选器之外，还包含其已有的设置和筛选器。请注意，当设置和筛选器发生冲突时，导入的值优先。		开关参数
  OnErrorAction	请参阅 (/zh-cn/citrix-virtual-apps-desktops/2507-ltsr/upgrade-migrate/auto-config-troubleshoot#onerroraction-parameter) 中有关 [OnErrorAction 参数] 的内容。		字符串

  返回:

  • 请参阅 Cmdlet 返回值

• Merge-CvadAcToSite - 将 YAML 文件导入到云。支持创建和更新操作。

  将本地文件合并到云中，但不删除云中或本地站点中的任何组件。这会保留云中已进行的更改。如果 Citrix Cloud 中存在同名组件，此命令可以修改该组件。这是自动化配置的默认导入操作。合并的站点配置文件源自 %HOMEPATH%\Documents\Citrix\AutoConfig。

  参数:

  名称	功能描述	必需?	类型
  根据组件进行迁移	请参阅 按组件迁移。		开关参数
  按对象名称筛选	请参阅 按对象名称筛选。		字符串列表
  云访问相关参数	请参阅 云访问参数。		开关参数
  SourceFolder	此功能用于指定一个替代的根文件夹，以替换默认的 %HOMEPATH%\Documents\Citrix\AutoConfig 路径。		字符串
  Locale	指定可导出的人类可读文本所使用的语言。		字符串
  Quiet	禁止向控制台记录日志。		开关参数
  DisplayLog	在 cmdlet 完成时显示日志文件。设置为 $false 可抑制日志显示。		$true 或 $false
  Merge	设置为 $true 时，仅将组件添加到云站点。不移除组件。设置为 $false 可移除组件。		$true 或 $false
  AddOnly	设置为 $true 时，仅添加新组件，不更新或删除现有组件。设置为 $false 可允许更新和删除。当此参数为 $true 时，将忽略 Merge。		$true 或 $false
  MergePolicies	合并策略设置和筛选器。仅当要导入的策略已存在于云 DDC 中时才进行合并。合并策略的结果是，云 DDC 策略除了包含任何新导入的设置和筛选器外，还包含其已有的设置和筛选器。请注意，当设置和筛选器发生冲突时，导入的值优先。		开关参数
  OnErrorAction	请参阅 OnErrorAction 参数 以了解更多信息。		字符串

  返回：

  • 请参阅 Cmdlet 返回值

• New-CvadAcToSite - 将 YAML 文件导入到云。支持创建和更新操作。

  将本地站点配置导入到云，但仅添加新组件。现有云站点组件既不更新也不删除。如果您的现有云站点组件必须保持不变，请使用此命令。

  参数：

  名称	功能说明	必需？	类型
  按组件进行迁移	请参阅 按组件迁移。		切换参数
  按对象名称筛选	请参阅 按对象名称筛选。		字符串列表
  云访问相关参数	请参阅云访问参数。		开关参数
  SourceFolder	Identifies a substitute root folder for %HOMEPATH%\Documents\Citrix\AutoConfig.		字符串
  Locale	指定可导出的人类可读文本所使用的语言。		字符串
  Quiet	禁止向控制台记录日志。		开关参数
  DisplayLog	在 cmdlet 完成时显示日志文件。设置为 $false 以禁止显示日志。		$true 或 $false
  OnErrorAction	请参阅 错误处理操作参数。		字符串

  返回：

  • 请参阅 Cmdlet 返回值

• Sync-CvadAcToSite - 一步完成导出和导入。

  同步操作一步完成导出和导入。使用 SourceTargetFolder 参数指定导出/导入目标文件夹。

  参数：

  名称	功能描述	必需？	类型
  根据组件进行迁移	请参阅 按组件迁移		开关参数
  按对象名称筛选	请参阅 按对象名称筛选		字符串列表
  用于访问云的参数	请参阅 云访问参数		开关参数
  SourceTargetFolder	指定导出/导入目标文件夹。		字符串
  Locale	指定可导出的人类可读文本所使用的语言。		字符串
  AdminAddress	当导出未在交付控制器上执行时，指定交付控制器的 DNS 或 IP 地址。		字符串
  Quiet	禁止将日志记录到控制台。		开关参数
  DisplayLog	在 cmdlet 完成时显示日志文件。设置为 $false 可禁止显示日志。		$true 或 $false
  Merge	设置为 $true 时，仅将组件添加到云站点。不删除组件。设置为 $false 可删除组件。		$true 或 $false
  AddOnly	设置为 $true 时，仅添加新组件，不更新或删除现有组件。设置为 $false 可允许更新和删除。当此参数为 $true 时，将忽略 Merge。		$true 或 $false
  MergePolicies	合并策略设置和筛选器。仅当要导入的策略已存在于云 DDC 中时，才会发生合并。合并策略的结果是，云 DDC 策略除了包含正在导入的任何新设置和筛选器之外，还包含其已有的设置和筛选器。请注意，当设置和筛选器发生冲突时，导入的值优先。		开关参数

  返回：

  • 请参阅 Cmdlet 返回值

云到云的 cmdlet

• Backup-CvadAcToFile - 备份云站点中的所有配置。

  将您的云配置导出到 .yml 文件。此备份可用于备份和还原过程，以还原丢失的组件。

  参数：

  名称	详细信息	必需？	类型
  按组件进行迁移	请参阅 按组件迁移		开关参数
  用于访问云的参数	请参阅云访问参数		开关参数
  TargetFolder	指定导出目标文件夹。		字符串
  Locale	用于指定可导出的人类可读文本所使用的语言。		字符串
  Quiet	禁止向控制台记录日志。		开关参数
  DisplayLog	在 cmdlet 完成时显示日志文件。设置为 $false 以禁止日志显示。		$true 或 $false
  ZipResults	将备份的 YAML 文件压缩成一个 zip 文件。该文件与备份的 YAML 文件位于同一文件夹中，并与该文件夹同名。		开关参数

  返回值：

  • 请参阅 Cmdlet 返回值

• Restore-CvadAcToSite - 将备份的 YAML 文件还原到云站点。此云站点可以与源云站点相同，也可以不同。

  将云站点还原到以前的配置。导入的文件源自使用 -RestoreFolder 参数指定的文件夹，该参数标识包含要还原到云站点的 .yml 文件的文件夹。这必须是完全限定的文件夹规范。此 cmdlet 可用于恢复到以前的配置，或用于备份和还原云站点。此命令可以添加、删除和更新您的云站点。

  参数：

  名称	功能描述	必需？	类型
  根据组件进行迁移	请参阅 按组件迁移。		开关参数
  按对象名称筛选	请参阅 按对象名称筛选。		字符串列表
  云访问相关参数	请参阅 云访问参数。		开关参数
  RestoreFolder	标识包含要还原到云站点的 .yml 文件的文件夹。这必须是完全限定的文件夹规范。		字符串
  Locale	指定可导出的人类可读文本所使用的语言。		字符串
  Quiet	禁止向控制台记录日志。		开关参数
  DisplayLog	在 cmdlet 完成时显示日志文件。设置为 $false 可禁止显示日志。		$true 或 $false
  Merge	当设置为 $true 时，仅将组件添加到云站点。不会删除组件。设置为 $false 可删除组件。		$true 或 $false
  AddOnly	当设置为 $true 时，仅添加新组件，不更新或删除现有组件。设置为 $false 可允许更新和删除。当此参数为 $true 时，将忽略 Merge。		$true 或 $false
  MergePolicies	合并策略设置和筛选器。仅当要导入的策略已存在于云 DDC 中时，才会发生合并。合并策略的结果是，云 DDC 策略除了包含任何要导入的新设置和筛选器之外，还包含其已有的设置和筛选器。请注意，当设置和筛选器发生冲突时，导入的值优先。		开关参数
  OnErrorAction	See OnErrorAction parameter.		字符串

  返回：

  • 请参阅 Cmdlet 返回值

• Remove-CvadAcFromSite – 从云中删除组件成员。

  可以重置整个站点或从组件中删除成员项（例如，从目录列表中删除一个计算机目录）。当与 IncludeByName 参数结合使用时，这可用于选择性地删除特定成员。

  参数：

  名称	功能描述	必需？	类型
  按组件进行迁移	请参阅 按组件迁移		开关参数
  按对象名称筛选	请参阅 按对象名称筛选		字符串列表
  用于云访问的参数	请参阅 云访问参数		开关参数
  Quiet	禁止向控制台记录日志。		开关参数
  DisplayLog	在 cmdlet 完成时显示日志文件。设置为 $false 以禁止日志显示。		$true 或 $false

  返回值：

  • 请参阅 Cmdlet 返回值

其他基本 cmdlet

• Compare-CvadAcToSite - 比较本地 .yml 文件与云配置，生成一份由 Import、Merge 或 Restore cmdlet 所做的更改报告。

  参数：

  名称	描述信息	是否必需？	类型
  按组件进行迁移	请参阅按组件迁移。		开关参数
  按对象名称筛选	请参阅按对象名称筛选。		字符串列表
  用于云访问的参数	请参阅云访问参数。		开关参数
  SourceFolder	Identifies a substitute root folder for %HOMEPATH%\Documents\Citrix\AutoConfig.		字符串
  Locale	指定可以导出的、供人类阅读的文本的语言。		字符串
  Quiet	抑制向控制台记录日志。		开关参数
  DisplayLog	在 cmdlet 完成时显示日志文件。设置为 $false 可抑制日志显示。		$true 或 $false
  Merge	当设置为 $true 时，仅将组件添加到云站点。不移除组件。设置为 $false 可移除组件。		$true 或 $false
  AddOnly	当设置为 $true 时，仅添加新组件，不更新或删除现有组件。设置为 $false 可允许更新和删除。当此参数为 $true 时，将忽略 Merge。		$true 或 $false
  OnErrorAction	请参阅 [OnErrorAction 参数] 的相关内容(/zh-cn/citrix-virtual-apps-desktops/2507-ltsr/upgrade-migrate/auto-config-troubleshoot#onerroraction-parameter)。		字符串

  返回:

  • 参阅 Cmdlet 返回值

迁移的细粒度参数

按组件进行迁移

以下组件可以通过支持它们的 cmdlet 进行指定。当未指定任何组件参数时，将自动选择 All 选项。为避免错误，建议您按以下顺序迁移组件：

• All
• Tags
• AdminRoles
• AdminScopes
• HostConnections
• MachineCatalogs
• StoreFronts
• DeliveryGroups
• ApplicationGroups
• ApplicationFolders
• Applications
• GroupPolicies
• UserZonePreference

按对象名称筛选

按组件名称迁移

IncludeByName 和 ExcludeByName 参数允许按名称在 cmdlet 中包含和排除组件成员。在任何受支持的 cmdlet 中，一次只能选择一个组件（例如，交付组）。如果组件成员同时存在于这两个区域中，则排除会覆盖任何其他参数，并且会在日志修复列表中创建一个条目，用于标识被排除的组件和成员名称。

IncludeByName 和 ExcludeByName 接受组件成员名称列表。任何名称都可以包含一个或多个通配符。支持两种类型的通配符。当任何成员名称包含特殊字符时，组件成员名称列表必须用单引号括起来。

• * 匹配任意数量的字符
• ? 匹配单个字符

IncludeByName 和 ExcludeByName 还可以接受一个文件，其中包含成员列表，每个成员可以是显式的或包含通配符。文件中的每一行可以包含一个成员。成员名称的开头和结尾空格会被去除。文件名必须以 @ 符号开头并用单引号括起来（这是 PowerShell 的要求，以防止 @ 被重新解释）。除了与成员名称混合使用外，还可以列出多个文件。

合并所有名称以 DgSite1 开头并包含 Home2 的交付组的一个示例如下所示：

Merge-CvadAcToSite –DeliveryGroups –IncludeByName DgSite1*,*Home2*

按交付组名称

ByDeliveryGroupName 根据应用程序和应用程序组的交付组名称进行筛选。此参数始终是一个包含列表，用于根据其交付组关联来标识要包含的成员。

ByDeliveryGroupName 接受交付组名称列表。任何名称都可以包含一个或多个通配符。支持两种类型的通配符。

• * 匹配任意数量的字符
• ? 匹配单个字符

以下示例合并了引用所有以 EastDg 开头的交付组名称的所有应用程序。

Merge-CvadAcToSite –Applications –ByDeliveryGroupName EastDg*

排除已禁用

ExcludeDisabled 从导入操作中筛选出所有已禁用的应用程序和应用程序组。ExcludeDisabled 默认为 false，这意味着无论其启用状态如何，所有应用程序和应用程序组都将被导入。

按计算机名称

ByMachineName 根据计算机目录和交付组的计算机名称进行筛选。此参数始终是一个包含列表，用于根据其计算机名称关联来标识要包含的成员。

ByMachineName 接受计算机名称列表，其中任何名称都可以包含一个或多个通配符。支持两种类型的通配符。

• * 匹配任意数量的字符
• ? 匹配单个字符

当导出或导入并使用 ByMachineName 且计算机名称筛选器导致计算机目录或交付组中没有计算机时，该计算机目录或交付组将从导出或导入中排除。

注意：

在任何导入类型 cmdlet 中使用 ByMachineName 会导致 MergeMachines 设置为 $true。

合并计算机

当 MergeMachines 设置为 $true 时，它会指示导入操作仅将计算机添加到计算机目录或交付组。计算机不会被删除，从而允许增量添加操作。

MergeMachines 默认为 false，这意味着如果计算机不在计算机目录或交付组的 .yml 文件中，则会被删除。当使用 ByMachineName 时，MergeMachines 设置为 $true，但可以通过将 MergeMachines 设置为 false 来覆盖此设置。

与先决条件相关的 cmdlet

• New-CvadAcCustomerInfoFile - 创建一个客户信息文件。默认情况下，客户信息文件将存储在以下路径： %HOMEPATH%\Documents\Citrix\AutoConfig。

  参数：

  名称	功能描述	必需？	类型
  CustomerId	客户 ID。	x	字符串
  ClientId	在 Citrix Cloud 上创建的客户客户端 ID。使用此参数时，必须指定 CustomerId 和 Secret。	有条件地	字符串
  Secret	在 Citrix Cloud 上创建的客户密钥。使用此参数时，必须指定 CustomerId 和 ClientId。	有条件地	字符串
  Environment	生产、政府生产或日本生产环境。		枚举类型
  LogFileName	将日志文件前缀从 CitrixLog 更改为其他内容。		字符串
  AltRootUrl	仅在 Citrix 的指导下使用。		字符串
  StopOnError	遇到第一个错误时停止操作。		$true 或 $false
  TargetFolder	您应该使用您所指定的文件夹作为主要的根文件夹，而不是使用系统默认的路径，该路径通常是 %HOMEPATH%\Documents\Citrix\AutoConfig。		字符串
  Locale	使用指定的区域设置，而不是从运行该工具的系统派生的区域设置。		字符串
  Editor	使用指定的编辑器在每个 cmdlet 完成时显示日志。Notepad.exe 是默认编辑器。此参数必须包含编辑器的完全限定文件规范，并且编辑器必须将日志文件规范作为其唯一参数。		字符串
  SecurityCsvFileSpec	The fully qualified file specification pointing to the SecurityClient.csv file downloaded from Citrix Identity and Access Management. The CustomerId must be specified when using this parameter.		字符串

  返回：

  • 请参阅 Cmdlet 返回值

• Set-CvadAcCustomerInfoFile - 更新现有客户信息文件。仅更改 cmdlet 指定的参数。CustomerInfo.yml 文件中所有未指定的参数值保持不变。

  参数：

  名称	Description	必需？	类型
  CustomerId	客户 ID。		字符串
  ClientId	在 Citrix Cloud 上创建的客户客户端 ID。		字符串
  Secret	在 Citrix Cloud 上创建的客户密钥。		字符串
  Environment	生产、政府生产或日本生产环境。		枚举类型
  LogFileName	将日志文件前缀从 CitrixLog 更改为其他内容。		字符串
  StopOnError	在首次出现错误时停止操作。		$true 或 $false
  TargetFolder	Use the specified folder as the root folder instead of %HOMEPATH%\Documents\Citrix\AutoConfig.		字符串
  Locale	使用指定的区域设置，而不是从运行该工具的系统派生的区域设置。		字符串
  Editor	使用指定的编辑器在每个 cmdlet 完成时显示日志。Notepad.exe 是默认编辑器。此参数必须包含编辑器的完全限定文件规范，并且编辑器必须将日志文件规范作为其唯一参数。		字符串
  SecurityCsvFileSpec	The fully qualified file specification pointing to the SecurityClient.csv file downloaded from Citrix Identity and Access Management. The CustomerId must be specified when using this parameter.		字符串

  返回值：

  • 请参阅 Cmdlet 返回值

先决条件相关参数

除了 云访问参数 之外，以下参数可与先决条件相关的 cmdlet 一起使用：

• Environment – 生产环境或政府生产环境。
• LogFileName – 将日志文件前缀从 CitrixLog 更改为其他内容。
• StopOnError – 在首次出现错误时停止操作。
• AlternateRootFolder – 请将您所指定的文件夹用作此配置的根文件夹，而不是采用 %HOMEPATH%\Documents\Citrix\AutoConfig 作为默认路径。
• Locale – 使用指定的区域设置，而不是从运行该工具的系统派生的区域设置。
• Editor – 使用指定的编辑器在每个 cmdlet 完成时显示日志。Notepad.exe 是默认编辑器。此参数必须包含编辑器的完全限定文件规范，并且编辑器必须将日志文件规范作为其唯一参数。

支持和故障排除 cmdlet

• New-CvadAcZipInfoForSupport - 将所有日志文件和 .yml 文件打包成一个单独的 zip 文件，以便发送给 Citrix 以获取支持。客户敏感信息（CustomerInfo.yml 和 CvadAcSecurity.yml）不包含在此 zip 文件中。Icon.yml 文件也因其体积过大而被排除。该 zip 文件将放置在 %HOMEPATH%\Documents\Citrix\AutoConfig 中，并根据日期和时间戳命名为 CvadAcSupport_yyyy_mm_dd_hh_mm_ss.zip。此 zip 文件也可以用作备份。

  参数：

  名称	描述信息	必需？	类型
  TargetFolder	指定用于创建和保存 zip 文件的目标文件夹。		字符串
  Quiet	抑制向控制台记录日志。		开关参数

  返回：

  • 带有 zip 文件名和位置的 Zip 文件显示在命令提示符处。

• Get-CvadAcStatus - 用于测试连接性并确保满足所有先决条件。返回有关工具的信息，例如版本号以及与云的连接和连接器状态。

  参数：

  名称	详细说明	必需？	类型
  用于访问云的参数	请参阅 云访问参数		开关参数
  SiteId	标识要连接的站点。		字符串
  AdminAddress	这是用于验证管理员访问级别的本地 Delivery Controller 的 DNS 或 IP 地址。如果未在 Delivery Controller 上运行该工具，则需要此项。		字符串

  返回：

  • 显示每个项目的结果。

• Test-CvadAcConnectionWithSite – 测试与云站点的连接，以验证通信连接是否正常工作。此 cmdlet 使用云访问参数或 CustomerInfo.yml 文件来指定客户连接信息。

  参数：

  名称	描述信息	必需？	类型
  用于云访问的参数	请参阅 云访问参数		开关参数
  Quiet	禁止向控制台记录日志。		开关参数

  返回：

  • 测试结果显示在命令行上。

• Find-CvadAcConnector - 定位现有连接器并确定其运行状态。此 cmdlet 使用 CustomerInfo.yml 文件中的信息或客户 ID 参数来定位客户的连接器。

  参数：

  名称	详细信息	必需？	类型
  CustomerInfoFileSpec	指向客户信息文件的文件规范，用于覆盖默认位置和名称。当提供 CustomerId 参数时，此参数将被忽略。		字符串
  CustomerId	客户 ID。此参数会覆盖 CustomerInfo.yml 文件中的相同值。		字符串

  返回：

  • 结果显示在命令行上。

• Get-CvadAcCustomerSites - 返回所有客户站点的列表。此 cmdlet 使用云访问参数或 CustomerInfo.yml 文件来指定客户连接信息。

  参数：

  • 请参阅云访问参数

  返回：

  • 显示找到的客户站点 ID 列表。

• New-CvadAcTemplateToFile – 为选定组件创建模板文件，允许您手动创建导入文件。

  参数：

  名称	详细描述	必需？	类型
  按组件进行迁移	请参阅 按组件迁移		切换参数
  TargetFolder	指定导出目标文件夹。		字符串

  返回值：

  • 请参阅 Cmdlet 返回值

• Show-CvadAcDocument - 在默认浏览器中显示此文档。

  参数：

  • 无。

  返回值：

  • 在默认 Web 浏览器中显示此网页。

• Find-CvadAcInFile - 文件内查找会搜索组件 YAML 文件，查找与一个或多个可能包含通配符的名称匹配的成员。结果是找到的成员的报告。文件内查找一次只能搜索一个组件。文件内查找会搜索当前文件夹和所有子文件夹中的所有 YAML 文件。使用 FindSourceFolder 限制要搜索的文件数量。

  参数：

  名称	功能说明	必需？	类型
  按组件进行迁移	请参阅按组件迁移。注意：-All 值无效。		开关参数
  IncludeByName	一个列表，指定在将站点活动状态设置为活动时要包括的交付组的名称。名称中支持“*”和“?”通配符。		字符串列表
  Unique	仅报告唯一找到的成员。		开关参数
  IncludeYaml	包含成员特定的 YAML。		开关参数
  FindSourceFolder	查找开始搜索的文件夹。		字符串
  DisplayLog	在 cmdlet 完成时显示日志文件。设置为 $false 以抑制日志显示。		开关参数
  Quiet	禁止向控制台记录日志。		开关参数

  返回：

  • 为指定组件创建包含已找到成员的报告。

站点激活 cmdlet

有关激活站点和这些 cmdlet 用法的更多信息，请参阅激活站点。

• Set-CvadAcSiteActiveStateOnPrem - 将本地站点的状态设置为活动或非活动。

  参数：

  名称	功能描述	必需？	类型
  云访问相关参数	请参阅 云访问参数		开关参数
  SiteActive	存在时，将本地站点设置为活动状态，并从所有交付组中移除维护模式。如果此参数不存在，则所有交付组都将设置为维护模式。		开关参数
  IncludeByName	一个列表，指定在将站点活动状态设置为活动时要包含的交付组名称。名称中支持“*”和“?”通配符。		字符串列表
  ExcludeByName	一个列表，指定在将站点活动状态设置为活动时要排除的交付组名称。名称中支持“*”和“?”通配符。		字符串列表
  Quiet	抑制向控制台记录日志。		开关参数
  DisplayLog	在 cmdlet 完成时显示日志文件。设置为 $false 可抑制日志显示。		$true or $false

  返回值：

  • 请参阅 Cmdlet 返回值

• Set-CvadAcSiteActiveStateCloud - 将云站点状态设置为活动或非活动。

  参数：

  名称	详细说明	必需？	类型
  用于云访问的参数	请参阅 云访问参数		开关参数
  SiteActive	如果存在，则将云站点设置为活动状态，从而从所有交付组中删除维护模式。如果此参数不存在，则所有交付组都将设置为维护模式。		开关参数
  IncludeByName	一个列表，指定在将站点活动状态设置为活动时要包括的交付组的名称。名称中支持“*”和“?”通配符。		字符串列表
  ExcludeByName	一个列表，指定在将站点活动状态设置为活动时要排除的交付组的名称。名称中支持“*”和“?”通配符。		字符串列表
  Quiet	抑制日志输出到控制台。		开关参数
  DisplayLog	在 cmdlet 完成时显示日志文件。设置为 $false 可抑制日志显示。		$true or $false

  返回：

  • 请参阅 Cmdlet 返回值

合并多个本地站点的 cmdlet

有关站点合并以及这些 cmdlet 用法的更多信息，请参阅 将多个站点合并到一个站点。

• New-CvadAcSiteMergingInfo - 创建站点合并前缀/后缀信息集。最初无需了解所有前缀或后缀。它们可以通过 Set-CvadAcSiteMergingInfo 更新，或通过手动编辑 SiteMerging.yml 文件进行更新。 参数：

  名称	详细描述	必需？	类型
  SiteName	用于标识特定站点的所有前缀/后缀集的名称。它可以与实际站点的名称匹配，但不是必须的。	x	字符串
  站点合并参数	请参阅 站点合并参数		开关参数
  Quiet	禁止向控制台记录日志。		开关参数

  返回值：

  • 无

• Set-CvadAcSiteMergingInfo - 更新现有站点合并前缀/后缀信息集。

  参数：

  名称	具体描述	是否必需？	类型
  SiteName	用于标识特定站点的所有前缀/后缀集的名称。它可以与实际站点的名称匹配，但不是必需的。	x	字符串
  站点合并参数	请参阅 站点合并参数		开关参数
  Quiet	禁止将日志记录到控制台。		开关参数

  返回：

  • 无

• Remove-CvadAcSiteMergingInfo - 删除现有的站点合并前缀/后缀信息集。

  参数：

  • SiteName – 标识站点前缀和后缀集。这是一个字符串，是必需的。

  返回：

  • 无

站点合并参数

运行站点合并 cmdlet 时可以使用以下参数。所有列出的参数均为字符串。

• SiteName – 用于标识特定站点的所有前缀/后缀集的名称。它可以与实际站点的名称匹配，但不是必需的。SiteName 是一个必需参数。
• AdminScopedPrefix – 应用于管理员范围的前缀。
• ApplicationPrefix - 应用于应用程序的前缀。
• ApplicationFolderPrefix – 应用于应用程序文件夹的前缀；ApplicationFolderPrefix 可以与 ApplicationFolderRoot 结合使用。
• ApplicationFolderRoot – 应用程序文件夹的新根文件夹。这会创建一个额外的文件夹层次结构。ApplicationFolderRoot 可以与 ApplicationFolderPrefix 结合使用。
• ApplicationGroupPrefix – 应用程序组的前缀。
• ApplicationUserPrefix – 应用于用户看到的应用程序名称的前缀。
• ApplicationAdminPrefix – 应用于管理员看到的应用程序名称的前缀。
• DeliveryGroupPrefix – 应用于交付组的前缀。
• GroupPolicyPrefix – 要应用于策略名称的前缀。
• HostConnectionPrefix – 要应用于主机连接的前缀。
• MachineCatalogPrefix – 要应用于计算机目录的前缀。
• StoreFrontPrefix – 要应用于 StoreFront™ 名称的前缀。
• TagPrefix – 要应用于标签的前缀。
• AdminScopedSuffix – 要应用于管理员范围的后缀。
• ApplicationSuffix - 要应用于应用程序的后缀。
• ApplicationFolderSuffix – 要应用于应用程序文件夹的后缀；ApplicationFolderSuffix 可以与 ApplicationFolderRoot 结合使用。
• ApplicationGroupSuffix – 应用程序组的后缀。
• ApplicationUserSuffix – 要应用于用户看到的应用程序名称的后缀。
• ApplicationAdminSuffix – 要应用于管理员看到的应用程序名称的后缀。
• DeliveryGroupSuffix – 要应用于交付组的后缀。
• GroupPolicySuffix – 要应用于策略名称的后缀。
• HostConnectionSuffix – 要应用于主机连接的后缀。
• MachineCatalogSuffix – 要应用于计算机目录的后缀。
• StoreFrontSuffix – 应用于 StoreFront 名称的后缀。
• TagSuffix – 应用于标签的后缀。
• SiteRootFolder – 用于导出和导入的完全限定文件夹名称；这可以是本地文件夹或文件共享。

Generic parameters

云访问相关参数

所有访问云的 cmdlet 都支持以下额外参数。

注意：

CustomerId、ClientId 和 Secret 可以放在 CustomerInfo.yml 文件中，也可以使用以下参数通过 cmdlet 指定。当它们在两个位置都指定时，cmdlet 参数优先。

• CustomerId – 在 Rest API 中使用的客户 ID，是访问所有 Rest API 所必需的。您的客户 ID 位于 Citrix Cloud 中。
• ClientId – 在 Citrix Cloud 身份和访问管理网站上创建的 clientID。这是获取所有 Rest API 身份验证所需的持有者令牌所必需的。
• Secret – 在 Citrix Cloud 身份和访问管理网站上创建的密钥。这是获取所有 Rest API 身份验证所需的持有者令牌所必需的。
• CustomerInfoFileSpec – 指向客户信息文件的文件规范，用于覆盖默认位置和名称。

迁移模式相关参数

修改云站点配置的 cmdlet (Import、Restore、Merge、New 和 Sync) 支持以下额外参数，以提供更大的灵活性。

• CheckMode – 执行导入操作，但不进行任何更改。所有预期更改都会在导入完成之前报告。您可以使用此命令在导入发生之前测试您的导入。
• BackupFirst – 在修改云配置之前，将云内容备份到 .yml 文件。此功能默认启用。
• Confirm – 如果为 true，则提示用户确认他们是否要更改云站点配置。Remove cmdlet 会显示提示，因为它具有破坏性。如果不需要提示（例如在自动化脚本中运行），请将其设置为 false。Confirm 默认为 true。
• SecurityFileFolder – 这是包含 CustomerInfo.yml 文件的完全限定文件夹，该文件夹可能指向本地文件夹或可能受身份验证控制的网络共享文件夹。该工具不会提示输入凭据；在运行该工具之前，必须获得对受控资源的访问权限。
• SiteName – 指定导入时要使用的站点合并前缀和后缀集。
• SiteActive – 指定导入的站点是处于活动状态还是非活动状态。默认情况下，此参数设置为 $false，表示导入的站点处于非活动状态。

日志显示参数

Export、Import、Sync、Restore、Backup、Compare 和 Remove cmdlet 在操作完成后显示日志文件。您可以通过将 -DisplayLog 参数设置为 $false 来禁止显示。默认情况下，Notepad.exe 用于显示日志文件。您可以在 CustomerInfo.yml 文件中指定不同的编辑器。

Editor: C:\Program Files\Notepad++\notepad++.exe

命令程序返回值

操作结果

所有 cmdlet 都返回以下值。

            public class ActionResult
            {
                public bool                         Overall_Success;
                public Dictionary<string, string>   Individual_Success;
                public object                       CustomResult;
            }

Overall_Success 返回一个布尔值，显示 cmdlet 在所有选定组件中的总体成功情况：true 表示成功，false 表示不成功。

Individual_Success 为每个主要组件返回一个或三个值。组件的结果可以是成功 (Success)、失败 (Failure) 或跳过 (Skipped)。跳过表示该组件未被 cmdlet 选中执行。

CustomResult is cmdlet specific.

自定义结果

Import、Merge、Restore、Sync、Compare、Compare File 和 Remove 将以下自定义结果信息返回到 EvaluationResultData 的单个实例。

注意：

Export 和 Template cmdlet 不返回自定义结果。

                public class EvaluationResultData
                {
                    public Dictionary<string, Dictionary<string, ActionResultValues >> EvaluationResults;
                    public int                  Added;
                    public int                  Updated;
                    public int                  Deleted;
                    public int                  NoChange;
                    public int                  TotalChanged;
                    public EvaluationResults     OverallResult;
                    public string               CloudBackupFolder;
                    public string               SourceBackupFolder;
                }
                Where:
                public enum ActionResultValues
               {
                    Add,
                    Update,
                    Delete,
                    Identical,
                    DoNothing
                }
                public enum EvaluationResults
                {
                    Success,
                    Failure,
                    Skipped
                }

EvaluationResults 显示一个列表，其中每个选定组件有一个条目。键是组件名称，值是每个组件成员的列表以及对该组件成员执行的操作。操作可以是 ActionResultValues 值中的任何一个。

Added、Updated、Deleted 和 NoChange 依次表示已添加、已更新、已删除或未执行操作的组件成员总数。

TotalChanged 是 Added、Updated 和 Deleted 的总和。

OverallResult 是一个布尔值，指示 cmdlet 的结果。True 表示所有组件完全成功，false 表示处理一个或多个组件失败。

CloudBackupFolder 是 cmdlet 执行任何云修改操作之前云站点配置备份的完全限定文件规范。

SourceBackupFolder 是 cmdlet 完成后创建的源文件备份的完全限定文件规范。默认情况下，这些文件位于 %HOMEPATH%\Documents\Citrix\AutoConfig。

PowerShell help

每个 cmdlet 都有 PowerShell 帮助。所有参数都随每个 cmdlet 一起记录，并附有 cmdlet 的简要说明。要访问任何 cmdlet 的帮助，请在 cmdlet 前面键入 Get-Help。

Get-Help Import-CvadAcToSite