Citrix Virtual Apps and Desktops 服务

自动配置工具 cmdlet

此页面列出了自动配置支持的所有 cmdlet 和参数。

所有 cmdlet 都采用具有以下类型之一的参数。

  • 字符串
  • 字符串列表
  • 布尔值:$true$false
  • SwitchParameter:存在参数表示 $true;缺少参数表示 $false

注意:

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

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

类别 cmdlet 说明
本地到云迁移 Export-CvadAcToFile 将本地文件导出为 YAML 文件。
  Import-CvadAcToSite 将 YAML 文件导入云中。支持创建、更新和删除操作。
  Merge-CvadAcToSite 将 YAML 文件导入云中。支持创建和更新操作。
  New-CvadAcToSite 将 YAML 文件导入云中。支持创建和更新操作。
  Sync-CvadAcToSite 在一个步骤中完成导出和导入操作。
  粒度迁移 对于组件,请在上面的命令中使用参数。示例:MachineCatalogsTags。对于组件名称,请在上面的命令中使用参数。示例:IncludeByNameExcludeByName 有选择地仅迁移组件或组件名称
云到云 cmdlet Backup-CvadAcToFile 备份云站点中的所有配置。
  Restore-CvadAcToSite 将备份 YAML 文件还原到云站点。此云站点可以与源云站点相同,也可以不同。
  Remove-CvadAcFromSite 从云中删除组件成员。
  粒度迁移 对于组件,请在上面的命令中使用参数。示例:MachineCatalogsTags。对于组件名称,请在上面的命令中使用参数。示例:IncludeByNameExcludeByName 有选择地仅迁移组件或组件名称
其他基本 cmdlet Compare-CvadAcToSite 将本地 .yml 文件与云配置进行比较。
与必备条件有关的 cmdlet New-CvadAcCustomerInfoFile 创建客户信息文件。
  Set-CvadAcCustomerInfoFile 更新现有的客户信息文件。
支持和故障排除 cmdlet New-CvadAcZipInfoForSupport 将所有日志和 .yml 文件压缩到单个 zip 文件中,以发送给 Citrix 以获得支持。
  Get-CvadAcStatus 用于测试连接并确保满足所有必备条件。返回有关该工具的信息,例如版本号、与云的连接以及连接器状态。
  Test-CvadAcConnectionWithSite 测试与云站点的连接。
  Find-CvadAcConnector 查找现有连接器并确定其运行状态。
  Get-CvadAcCustomerSites 返回所有客户站点的列表。
  New-CvadAcTemplateToFile 为选定组件创建模板文件。
  Show-CvadAcDocument 在默认浏览器中显示此文档。
  Find-CvadAcInFile 在文件中查找将搜索组件 YAML 文件中与可能包含通配符的一个或多个名称匹配的成员。
站点激活 cmdlet Set-CvadAcSiteActiveStateOnPrem 将本地站点状态设置为活动或非活动状态。
  Set-CvadAcSiteActiveStateCloud 将云站点状态设置为活动或非活动状态。
合并多个本地站点 cmdlet New-CvadAcSiteMergingInfo 创建一个合并前缀/后缀信息集的站点。
  Set-CvadAcSiteMergingInfo 更新现有站点合并前缀/后缀信息集。
  Remove-CvadAcSiteMergingInfo 删除现有站点合并前缀/后缀信息集。

有关参数及其使用方法的详细信息,请参阅粒度迁移参数

基本 cmdlet

本地到云 cmdlet

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

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

    参数:

    名称 说明 必需? 类型
    按组件迁移 请参阅按组件迁移   SwitchParameters
    按对象名称过滤 请参阅按对象名称过滤   字符串列表
    TargetFolder 指定导出目标文件夹。   字符串
    Locale 指定可以导出的人类可读文本的语言。   字符串
    Quiet 禁止登录控制台。   SwitchParameter
    AdminAddress 在 Delivery Controller 上未运行导出时,指定 Delivery Controller 的 DNS 或 IP 地址。   字符串
    CheckUserAndMachines 验证用户和计算机是否在 Active Directory 中。不在 Active Directory 中的用户和计算机可能会导致导入失败。   $true$false
    ZipResults 将备份 YAML 文件压缩到单个 zip 文件中。该文件与备份的 YAML 文件位于同一文件夹中,并且与文件夹具有相同的名称。   SwitchParameter

    返回结果:

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

  • 添加、更新和删除
  • 仅添加和更新
  • 仅添加
cmdlet 添加 更新 删除
导入 X X X
Merge X X  
New X    
  • Import-CvadAcToSite - 将 YAML 文件导入云中。支持创建、更新和删除操作。

    将所有本地文件导入到云端。此命令可确保云端状态与本地状态相同。此选项将删除云中存在的所有更改。导入的站点配置文件来自 %HOMEPATH%\Documents\Citrix\AutoConfig请小心使用。

    参数:

    名称 说明 必需? 类型
    按组件迁移 请参阅按组件迁移   SwitchParameters
    按对象名称过滤 请参阅按对象名称过滤   字符串列表
    云访问参数 请参阅云访问参数   SwitchParameters
    SourceFolder 标识 %HOMEPATH%\Documents\Citrix\AutoConfig 的替代根文件夹。   字符串
    Locale 指定可以导出的人类可读文本的语言。   字符串
    Quiet 禁止登录控制台。   SwitchParameter
    DisplayLog 在 cmdlet 完成时显示日志文件。设置为 $false 将禁止日志显示。   $true$false
    Merge 设置为 $true 时,仅向云站点添加组件。组件不会被删除。设置为 $false 将删除组件。   $true$false
    AddOnly 设置为 $true 时,仅添加新组件,不会更新或删除现有组件。设置为 $false 将允许更新和删除。当此参数为 $true 时,将忽略 Merge   $true$false
    MergePolicies 合并策略设置和过滤器。仅当正在导入的策略已存在于云 DDC 中时,才会进行合并。合并策略的结果是,云 DDC 策略包含已有的设置和过滤器以及正在导入的所有新设置和过滤器。请注意,当发生设置和过滤器冲突时,导入的值优先。   SwitchParameter

    返回结果:

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

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

    参数:

    名称 说明 必需? 类型
    按组件迁移 请参阅按组件迁移   SwitchParameters
    按对象名称过滤 请参阅按对象名称过滤   字符串列表
    云访问参数 请参阅云访问参数   SwitchParameters
    SourceFolder 标识 %HOMEPATH%\Documents\Citrix\AutoConfig 的替代根文件夹。   字符串
    Locale 指定可以导出的人类可读文本的语言。   字符串
    Quiet 禁止登录控制台。   SwitchParameter
    DisplayLog 在 cmdlet 完成时显示日志文件。设置为 $false 将禁止日志显示。   $true$false
    Merge 设置为 $true 时,仅向云站点添加组件。组件不会被删除。设置为 $false 将删除组件。   $true$false
    AddOnly 设置为 $true 时,仅添加新组件,不会更新或删除现有组件。设置为 $false 将允许更新和删除。当此参数为 $true 时,将忽略 Merge   $true$false
    MergePolicies 合并策略设置和过滤器。仅当正在导入的策略已存在于云 DDC 中时,才会进行合并。合并策略的结果是,云 DDC 策略包含已有的设置和过滤器以及正在导入的所有新设置和过滤器。请注意,当发生设置和过滤器冲突时,导入的值优先。   SwitchParameter

    返回结果:

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

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

    参数:

    名称 说明 必需? 类型
    按组件迁移 请参阅按组件迁移   SwitchParameters
    按对象名称过滤 请参阅按对象名称过滤   字符串列表
    云访问参数 请参阅云访问参数   SwitchParameters
    SourceFolder 标识 %HOMEPATH%\Documents\Citrix\AutoConfig 的替代根文件夹。   字符串
    Locale 指定可以导出的人类可读文本的语言。   字符串
    Quiet 禁止登录控制台。   SwitchParameter
    DisplayLog 在 cmdlet 完成时显示日志文件。设置为 $false 将禁止日志显示。   $true$false

    返回结果:

  • Sync-CvadAcToSite - 在一个步骤中完成导出和导入操作。

    Sync 在一个步骤中同时执行导出和导入。使用 SourceTargetFolder 参数指定导出/导入目标文件夹。

    参数:

    名称 说明 必需? 类型
    按组件迁移 请参阅按组件迁移   SwitchParameters
    按对象名称过滤 请参阅按对象名称过滤   字符串列表
    云访问参数 请参阅云访问参数   SwitchParameters
    SourceTargetFolder 指定导出/导入目标文件夹。   字符串
    Locale 指定可以导出的人类可读文本的语言。   字符串
    AdminAddress 在 Delivery Controller 上未运行导出时,指定 Delivery Controller 的 DNS 或 IP 地址。   字符串
    Quiet 禁止登录控制台。   SwitchParameter
    DisplayLog 在 cmdlet 完成时显示日志文件。设置为 $false 将禁止日志显示。   $true$false
    Merge 设置为 $true 时,仅向云站点添加组件。组件不会被删除。设置为 $false 将删除组件。   $true$false
    AddOnly 设置为 $true 时,仅添加新组件,不会更新或删除现有组件。设置为 $false 将允许更新和删除。当此参数为 $true 时,将忽略 Merge   $true$false
    MergePolicies 合并策略设置和过滤器。仅当正在导入的策略已存在于云 DDC 中时,才会进行合并。合并策略的结果是,云 DDC 策略包含已有的设置和过滤器以及正在导入的所有新设置和过滤器。请注意,当发生设置和过滤器冲突时,导入的值优先。   SwitchParameter

    返回结果:

云到云 cmdlet

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

    将云配置导出到 .yml 文件。此备份可以在备份和还原过程中用来恢复丢失的组件。

    参数:

    名称 说明 必需? 类型
    按组件迁移 请参阅按组件迁移   SwitchParameters
    云访问参数 请参阅云访问参数   SwitchParameters
    TargetFolder 指定导出目标文件夹。   字符串
    Locale 指定可以导出的人类可读文本的语言。   字符串
    Quiet 禁止登录控制台。   SwitchParameter
    DisplayLog 在 cmdlet 完成时显示日志文件。设置为 $false 将禁止日志显示。   $true$false
    ZipResults 将备份 YAML 文件压缩到单个 zip 文件中。该文件与备份的 YAML 文件位于同一文件夹中,并且与文件夹具有相同的名称。   SwitchParameter

    返回结果:

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

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

    参数:

    名称 说明 必需? 类型
    按组件迁移 请参阅按组件迁移   SwitchParameters
    按对象名称过滤 请参阅按对象名称过滤   字符串列表
    云访问参数 请参阅云访问参数   SwitchParameters
    RestoreFolder 标识包含要还原到云站点的 .yml 文件的文件夹。这必须是完全限定的文件夹规范。   字符串
    Locale 指定可以导出的人类可读文本的语言。   字符串
    Quiet 禁止登录控制台。   SwitchParameter
    DisplayLog 在 cmdlet 完成时显示日志文件。设置为 $false 将禁止日志显示。   $true$false
    Merge 设置为 $true 时,仅向云站点添加组件。组件不会被删除。设置为 $false 将删除组件。   $true$false
    AddOnly 设置为 $true 时,仅添加新组件,不会更新或删除现有组件。设置为 $false 将允许更新和删除。当此参数为 $true 时,将忽略 Merge   $true$false
    MergePolicies 合并策略设置和过滤器。仅当正在导入的策略已存在于云 DDC 中时,才会进行合并。合并策略的结果是,云 DDC 策略包含已有的设置和过滤器以及正在导入的所有新设置和过滤器。请注意,当发生设置和过滤器冲突时,导入的值优先。   SwitchParameter

    返回结果:

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

    可以重置整个站点或删除组件中的成员项(例如,从目录列表中删除一个计算机目录)。当与 IncludeByName 参数结合使用以选择性地删除特定成员时,可以使用此命令。

    参数:

    名称 说明 必需? 类型
    按组件迁移 请参阅按组件迁移   SwitchParameters
    按对象名称过滤 请参阅按对象名称过滤   字符串列表
    云访问参数 请参阅云访问参数   SwitchParameters
    Quiet 禁止登录控制台。   SwitchParameter
    DisplayLog 在 cmdlet 完成时显示日志文件。设置为 $false 将禁止日志显示。   $true$false

    返回结果:

其他基本 cmdlet

  • Compare-CvadAcToSite - 将本地 .yml 文件与云配置进行比较,生成 ImportMergeRestore cmdlet 所做的更改的报告。

    参数:

    名称 说明 必需? 类型
    按组件迁移 请参阅按组件迁移   SwitchParameters
    按对象名称过滤 请参阅按对象名称过滤   字符串列表
    云访问参数 请参阅云访问参数   SwitchParameters
    SourceFolder 标识 %HOMEPATH%\Documents\Citrix\AutoConfig 的替代根文件夹。   字符串
    Locale 指定可以导出的人类可读文本的语言。   字符串
    Quiet 禁止登录控制台。   SwitchParameter
    DisplayLog 在 cmdlet 完成时显示日志文件。设置为 $false 将禁止日志显示。   $true$false
    Merge 设置为 $true 时,仅向云站点添加组件。组件不会被删除。设置为 $false 将删除组件。   $true$false
    AddOnly 设置为 $true 时,仅添加新组件,不会更新或删除现有组件。设置为 $false 将允许更新和删除。当此参数为 $true 时,将忽略 Merge   $true$false

    返回结果:

粒度迁移参数

按组件迁移

以下组件可以使用支持这些组件的 cmdlet 来指定。未指定组件参数时,All 选项将自动选择。

  • All
  • Tags
  • AdminRolesScopes
  • MachineCatalogs
  • StoreFronts
  • DeliveryGroups
  • ApplicationGroups
  • Applications
  • GroupPolicies

按对象名称过滤

按组件名称迁移

IncludeByNameExcludeByName 参数允许按名称在 cmdlet 中包含和排除组件成员。在任何受支持的 cmdlet 中,一次只能选择一个组件(例如,交付组)。如果组件成员在这两个区域中,排除操作将覆盖任何其他参数,并且日志修复列表中将新增一个条目,以标识排除的组件和成员名称。

IncludeByNameExcludeByName 将获取组件成员名称的列表。任何名称都可以包含一个或多个通配符。支持两种类型的通配符。当任何成员名称包含特殊字符时,组件成员名称列表必须用单引号引起。

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

IncludeByNameExcludeByName 也可以获取包含成员列表的文件,其中每个成员都可以是直接显示的或包含通配符。该文件中的每一行都可以包含一个成员。前导空格和尾随空格将自动从成员名称中去掉。文件名前面必须带有 @ 符号,并且用单引号括起来(这是 PowerShell 的要求,因此不会重新解释 @)。除了与成员名称混用之外,还可以列出多个文件。

将写入合并名称以 DgSite1 开头且包含 Home2 的所有交付组的一个示例:

Merge-CvadAcToSite –DeliveryGroups $true –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 在 Citrix Cloud 上创建的客户的密钥。使用此参数时,必须指定 CustomerId 和 ClientId。 有条件地 字符串
    Environment Production、ProductionGov 或 ProductionJP 环境。   枚举
    LogFileName 将日志文件前缀从 CitrixLog 更改为其他内容。   字符串
    AltRootUrl 只能在 Citrix 的指导下使用。   字符串
    StopOnError 第一次出现错误时停止操作。   $true$false
    TargetFolder 使用指定的文件夹作为根文件夹,代替 %HOMEPATH%\Documents\Citrix\AutoConfig   字符串
    Locale 使用指定的本地设置,而非从运行该工具的系统派生的区域设置。   字符串
    Editor 使用指定的编辑器在每个 cmdlet 完成时显示日志。Notepad.exe 为默认编辑器。此参数必须在编辑器中包含完全限定的文件规范,编辑器必须将日志文件规范作为其唯一的参数。   字符串
    SecurityCsvFileSpec 指向从 Citrix Identity and Access Management 下载的 SecurityClient.csv 文件的完全限定文件规范。使用此参数时必须指定 CustomerId。   字符串

    返回结果:

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

    参数:

    名称 说明 必需? 类型
    CustomerId 客户的 ID。   字符串
    ClientId 在 Citrix Cloud 上创建的客户的客户端 ID。   字符串
    Secret 在 Citrix Cloud 上创建的客户的密钥。   字符串
    Environment Production、ProductionGov 或 ProductionJP 环境。   枚举
    LogFileName 将日志文件前缀从 CitrixLog 更改为其他内容。   字符串
    StopOnError 第一次出现错误时停止操作。   $true$false
    TargetFolder 使用指定的文件夹作为根文件夹,代替 %HOMEPATH%\Documents\Citrix\AutoConfig   字符串
    Locale 使用指定的本地设置,而非从运行该工具的系统派生的区域设置。   字符串
    Editor 使用指定的编辑器在每个 cmdlet 完成时显示日志。Notepad.exe 为默认编辑器。此参数必须在编辑器中包含完全限定的文件规范,编辑器必须将日志文件规范作为其唯一的参数。   字符串
    SecurityCsvFileSpec 指向从 Citrix Identity and Access Management 下载的 SecurityClient.csv 文件的完全限定文件规范。使用此参数时必须指定 CustomerId。   字符串

    返回结果:

与必备条件有关的参数

除了云访问参数外,以下参数还可以与必备条件相关的 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 禁止登录控制台。   SwitchParameter

    返回结果:

    • 命令提示符下会显示带有 zip 文件名和位置的 zip 文件。
  • Get-CvadAcStatus - 用于测试连接并确保满足所有必备条件。返回有关该工具的信息,例如版本号、与云的连接以及连接器状态。

    参数:

    名称 说明 必需? 类型
    云访问参数 请参阅云访问参数   SwitchParameters
    SiteId 标识要连接到的站点。   字符串
    AdminAddress 这是用于验证管理员访问级别的本地 Delivery Controller 的 DNS 或 IP 地址。如果该工具不在 Delivery Controller 上运行,则此操作是必需的。   字符串

    返回结果:

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

    参数:

    名称 说明 必需? 类型
    云访问参数 请参阅云访问参数   SwitchParameters
    Quiet 禁止登录控制台。   SwitchParameter

    返回结果:

    • 测试结果将显示在命令行上。
  • Find-CvadAcConnector - 查找现有连接器并确定其运行状态。此 cmdlet 使用 CustomerInfo.yml 文件中的信息或客户 ID 参数来查找客户的连接器。

    参数:

    名称 说明 必需? 类型
    CustomerInfoFileSpec 指向客户信息文件以覆盖默认位置和名称的文件规范。提供了 CustomerId 参数时,此参数将被忽略。   字符串
    CustomerId 客户的 ID。此参数将覆盖 CustomerInfo.yml 文件中的相同值。   字符串

    返回结果:

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

    参数:

    返回结果:

    • 显示找到的客户地点 ID 的列表。
  • New-CvadAcTemplateToFile - 为选定组件创建模板文件,以便手动创建导入文件。

    参数:

    名称 说明 必需? 类型
    按组件迁移 请参阅按组件迁移   SwitchParameters
    TargetFolder 指定导出目标文件夹。   字符串

    返回结果:

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

    参数:

    • 无。

    返回结果:

    • 在默认的 Web 浏览器中显示此 Web 页面。
  • Find-CvadAcInFile - 在文件中查找将搜索组件 YAML 文件中与可能包含通配符的一个或多个名称匹配的成员。结果是找到的成员的报告。在文件中查找一次只能搜索一个组件。在文件中查找将搜索当前文件夹及所有子文件夹中的所有 YAML 文件。请使用 FindSourceFolder 限制要搜索的文件数量。

    参数:

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

    返回:

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

站点激活 cmdlet

有关激活站点和使用这些 cmdlet 的详细信息,请参阅激活站点

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

    参数:

    名称 说明 必需? 类型
    云访问参数 请参阅云访问参数   SwitchParameters
    SiteActive 如果存在,则将本地站点设置为主动从所有交付组中删除维护模式。此参数不存在时,将在所有交付组上设置维护模式。   SwitchParameter
    IncludeByName 一个列表,用于指定在将站点活动状态设置为活动时要包括的交付组名称。支持在名称中使用“*”和“?”通配符。   字符串列表
    ExcludeByName 一个列表,用于指定在将站点活动状态设置为活动时要排除的交付组名称。支持在名称中使用“*”和“?”通配符。   字符串列表
    Quiet 禁止登录控制台。   SwitchParameter
    DisplayLog 在 cmdlet 完成时显示日志文件。设置为 $false 将禁止日志显示。   $true or $false

    返回结果:

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

    参数:

    名称 说明 必需? 类型
    云访问参数 请参阅云访问参数   SwitchParameters
    SiteActive 如果存在,则将本地站点设置为主动从所有交付组中删除维护模式。此参数不存在时,将在所有交付组上设置维护模式。   SwitchParameter
    IncludeByName 一个列表,用于指定在将站点活动状态设置为活动时要包括的交付组名称。支持在名称中使用“*”和“?”通配符。   字符串列表
    ExcludeByName 一个列表,用于指定在将站点活动状态设置为活动时要排除的交付组名称。支持在名称中使用“*”和“?”通配符。   字符串列表
    Quiet 禁止登录控制台。   SwitchParameter
    DisplayLog 在 cmdlet 完成时显示日志文件。设置为 $false 将禁止日志显示。   $true or $false

    返回结果:

合并多个本地站点 cmdlet

有关这些 cmdlet 的站点合并和使用的详细信息,请参阅将多个站点合并到一个站点中

  • New-CvadAcSiteMergingInfo - 创建一个合并前缀/后缀信息集的站点。开始时没有必要知晓所有前缀或后缀。可以通过 Set-CvadAcSiteMergingInfo 或手动编辑 SiteMerging.yml 文件来对其进行更新。 参数:

    名称 说明 必需? 类型
    SiteName 用于标识特定站点的前缀/后缀集的名称。它可以与实际站点的名称匹配,但不需要匹配。 x 字符串
    站点合并参数 请参阅站点合并参数   SwitchParameters
    Quiet 禁止登录控制台。   SwitchParameter

    返回结果:

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

    参数:

    名称 说明 必需? 类型
    SiteName 用于标识特定站点的前缀/后缀集的名称。它可以与实际站点的名称匹配,但不需要匹配。 x 字符串
    站点合并参数 请参阅站点合并参数   SwitchParameters
    Quiet 禁止登录控制台。   SwitchParameter

    返回结果:

  • 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 - 用于导出和导入的完全限定文件夹名称;可以是本地文件夹或文件共享。

泛型参数

云访问参数

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

注意:

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

  • CustomerId - 已在 REST API 中使用且访问所有 REST API 所需的客户 ID。您的客户 ID 位于 Citrix Cloud 中。
  • ClientId - 在 Citrix Cloud 身份识别和访问管理网站上创建的客户端 ID。获取对所有 Rest API 进行身份验证所需的持有者令牌时,需要此信息。
  • Secret - 在 Citrix Cloud 身份识别和访问管理网站上创建的密钥。获取对所有 Rest API 进行身份验证所需的持有者令牌时,需要此信息。
  • CustomerInfoFileSpec - 指向客户信息文件以覆盖默认位置和名称的文件规范。

迁移模式参数

修改云站点配置(ImportRestoreMergeNewSync)的 Cmdlet 还额外支持以下参数,以提高灵活性。

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

日志显示参数

ExportImportSyncRestoreBackupCompareRemove cmdlet 会在该操作完成时显示日志文件。您可以通过将 -DisplayLog 参数设置为 $false 以禁止显示日志。默认情况下,将使用 Notepad.exe 来显示日志文件。您可以在 CustomerInfo.yml 文件中指定不同的编辑器。

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

Cmdlet 返回值

ActionResult

所有 cmdlet 都将返回以下值。

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

Overall_Success 将返回一个布尔值,以显示所有选定组件中的 cmdlet 是否均成功:true 表示成功,false 表示不成功。

Individual_Success 将返回每个主组件的一个或三个值。组件的结果可以是“成功”、“失败”或“已跳过”。“已跳过”表示未选择以供 cmdlet 执行的组件。

CustomResult 特定于 cmdlet。

CustomResult

ImportMergeRestoreSyncCompareCompare FileRemove 将返回 EvaluationResultData 单个实例的以下自定义结果信息。

注意:

ExportTemplate 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 的任何一个值。

AddedUpdatedDeletedNoChange 指示按该顺序添加、更新、删除或未执行任何操作的组件成员总数。

TotalChangedAddedUpdatedDeleted 的总和。

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

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

SourceBackupFolder 是在 cmdlet 完成执行后进行的源文件备份的完全限定文件规范。默认情况下,这些文件位于 %HOMEPATH%\Documents\Citrix\AutoConfig 中。

PowerShell 帮助

我们为每个 cmdlet 均提供了 PowerShell 帮助。所有参数均与每个 cmdlet 以及相应 cmdlet 的简要说明一起记录。要访问任何 cmdlet 的帮助,请在 cmdlet 前面键入 Get-Help

Get-Help Import-CvadAcToSite

自动配置工具 cmdlet