Citrix虚拟应用和桌面服务

自动化配置工具cmdlets

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

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

  • 字符串
  • 字符串列表
  • 布尔:真正的美元美元的假
  • SwitchParameter:参数的存在方式真正的美元;没有参数意味着美元的假

注意:

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

下表是所有cmdlet的摘要。请参阅每一节以了解每个cmdlet支持哪些参数。

类别 Cmdlet 描述
本地到云迁移 Export-cvadactofile. 导出本地文件到YAML文件。
Import-CvadAcToSite 将YAML文件导入云。支持创建、更新和删除操作。
Merge-CvadAcToSite 将YAML文件导入云。支持创建和更新操作。
New-CvadAcToSite 将YAML文件导入云。支持创建和更新操作。
Sync-CvadAcToSite 一步导出和导入。
粒状迁移对于组件,在上面的命令中使用参数。例子:MachineCatalogs标签.对于组件名,使用上面的命令的参数。例子:IncludeByNameExcludeByName 有选择地迁移组件或组件名称
云到云cmdlets Backup-CvadAcToFile 从您的云站点备份所有配置。
Restore-CvadAcToSite 将备份yaml文件恢复到云站点。该云站点可以与源云站点相同或不同。
Remove-CvadAcFromSite 从云中删除组件成员。
粒状迁移对于组件,在上面的命令中使用参数。例子:MachineCatalogs标签.对于组件名,使用上面的命令的参数。例子:IncludeByNameExcludeByName 有选择地迁移组件或组件名称
其他基本cmdlets Compare-CvadAcToSite 将内部部署与云配置进行比较。
Prerequisites-related cmdlets New-CvadAcCustomerInfoFile 创建一个客户信息文件。
Set-CvadAcCustomerInfoFile 更新现有的客户信息文件。
支持和故障排除cmdlet New-CvadAcZipInfoForSupport 将所有日志和.yml文件压缩到一个zip文件中,发送到Citrix以获得支持。
Get-CvadAcStatus 用于测试连接性,并确保满足所有先决条件。返回有关工具的信息,如版本号、与云的连接和连接器状态。
Test-CvadAcConnectionWithSite 测试与云站点的连接。
Find-CvadAcConnector 定位现有连接器并确定其运行状态。
get-cvadaccustomersites 返回所有客户站点的列表。
new-cvdatemplattofile 为选定的组件创建模板文件。
Show-CvadAcDocument 在默认浏览器中显示此文档。
Find-CvadAcInFile Find in file搜索组件YAML文件,寻找匹配一个或多个可能包含通配符的名称的成员。
网站激活cmdlets Set-CvadAcSiteActiveStateOnPrem 将内部站点状态设置为活动或不活动。
Set-CvadAcSiteActiveStateCloud 将云站点状态设置为活动或非活动。
合并多个内部站点cmdlet New-CvadAcSiteMergingInfo 创建一个站点合并前缀/后缀信息集。
Set-CvadAcSiteMergingInfo 更新现有的站点合并前缀/后缀信息集。
Remove-CvadAcSiteMergingInfo 移除现有的站点合并前缀/后缀信息集。

有关参数的更多信息以及如何使用它们,请参阅颗粒迁移参数

基本cmdlets.

本地到云cmdlet

  • Export-cvadactofile.- 将内部部署文件导出到Yaml文件。

    从本地设置导出配置。这是自动化配置的默认导出操作。现场配置不作任何修改。导出的文件放在该目录中% HOMEPATH % \ \ Citrix \ AutoConfig文档在一个唯一的命名出口子文件夹。的文件夹% HOMEPATH % \ \ Citrix \ AutoConfig文档始终包含最新导出的内部部署网站配置。

    参数:

    的名字 描述 需要吗? 类型
    由组件迁移 看到由组件迁移 SwitchParameters
    按对象名称过滤 看到按对象名称过滤 字符串列表
    TargetFolder 指定导出目标文件夹。 字符串
    语言环境 指定可导出的人类可读文本的语言。 字符串
    安静的 禁止登录控制台。 SwitchParameter
    AdminAddress. 指定未在交付控制器上运行导出时交付控制器的DNS或IP地址。 字符串
    CheckUserAndMachines 验证用户和计算机是否在Active Directory中。不在Active Directory中的用户和计算机可能导致导入失败。 真正的美元美元的假
    ZipResults 将备份YAML文件压缩成一个zip文件。该文件与备份的YAML文件在同一个文件夹中,且与文件夹名称相同。 SwitchParameter

    返回:

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

  • 添加、更新和删除
  • 只添加和更新
  • 只添加
Cmdlet 添加 更新 删除
进口 X X X
合并 X X
X
  • Import-CvadAcToSite—将YAML文件导入云。支持创建、更新和删除操作。

    将所有本地文件导入到云。该命令确保云终端状态与本地状态相同。此选项将删除云中存在的任何更改。导入的站点配置文件来源于% HOMEPATH % \ \ Citrix \ AutoConfig文档谨慎使用。

    参数:

    的名字 描述 需要吗? 类型
    由组件迁移 看到由组件迁移 SwitchParameters
    按对象名称过滤 看到按对象名称过滤 字符串列表
    Cloud-accessing参数 看到Cloud-accessing参数 SwitchParameters
    SourceFolder 的替代根文件夹% HOMEPATH % \ \ Citrix \ AutoConfig文档 字符串
    语言环境 指定可导出的人类可读文本的语言。 字符串
    安静的 禁止登录控制台。 SwitchParameter
    DisplayLog 在cmdlet完成时显示日志文件。设置为美元的假抑制日志显示。 真正的美元美元的假
    合并 当设置为真正的美元,只向云站点添加组件。组件未被移除。设置为美元的假删除组件。 真正的美元美元的假
    插件 当设置为真正的美元,只添加新组件,不更新或删除现有组件。设置为美元的假允许更新和删除。合并当参数为?时忽略真正的美元 真正的美元美元的假
    MergePolicies 合并策略设置和过滤器。只有当导入的策略在云DDC中已经存在时才会发生合并。合并策略的结果是,云DDC策略包含它已经拥有的设置和过滤器,以及任何正在导入的新设置和过滤器。请注意,当设置和筛选发生冲突时,导入的值优先。 SwitchParameter

    返回:

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

    将本地文件合并到云,但没有删除云中或本地站点中的任何组件。这保留了云中已经做过的更改。如果“Citrix Cloud”中存在同名组件,该命令可以修改该组件。这是自动化配置的默认导入操作。合并的站点配置文件来自% HOMEPATH % \ \ Citrix \ AutoConfig文档

    参数:

    的名字 描述 需要吗? 类型
    由组件迁移 看到由组件迁移 SwitchParameters
    按对象名称过滤 看到按对象名称过滤 字符串列表
    Cloud-accessing参数 看到Cloud-accessing参数 SwitchParameters
    SourceFolder 的替代根文件夹% HOMEPATH % \ \ Citrix \ AutoConfig文档 字符串
    语言环境 指定可导出的人类可读文本的语言。 字符串
    安静的 禁止登录控制台。 SwitchParameter
    DisplayLog 在cmdlet完成时显示日志文件。设置为美元的假抑制日志显示。 真正的美元美元的假
    合并 当设置为真正的美元,只向云站点添加组件。组件未被移除。设置为美元的假删除组件。 真正的美元美元的假
    插件 当设置为真正的美元,只添加新组件,不更新或删除现有组件。设置为美元的假允许更新和删除。合并当参数为?时忽略真正的美元 真正的美元美元的假
    MergePolicies 合并策略设置和过滤器。只有当导入的策略在云DDC中已经存在时才会发生合并。合并策略的结果是,云DDC策略包含它已经拥有的设置和过滤器,以及任何正在导入的新设置和过滤器。请注意,当设置和筛选发生冲突时,导入的值优先。 SwitchParameter

    返回:

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

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

    参数:

    的名字 描述 需要吗? 类型
    由组件迁移 看到由组件迁移 SwitchParameters
    按对象名称过滤 看到按对象名称过滤 字符串列表
    Cloud-accessing参数 看到Cloud-accessing参数 SwitchParameters
    SourceFolder 的替代根文件夹% HOMEPATH % \ \ Citrix \ AutoConfig文档 字符串
    语言环境 指定可导出的人类可读文本的语言。 字符串
    安静的 禁止登录控制台。 SwitchParameter
    DisplayLog 在cmdlet完成时显示日志文件。设置为美元的假抑制日志显示。 真正的美元美元的假

    返回:

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

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

    参数:

    的名字 描述 需要吗? 类型
    由组件迁移 看到由组件迁移 SwitchParameters
    按对象名称过滤 看到按对象名称过滤 字符串列表
    Cloud-accessing参数 看到Cloud-accessing参数 SwitchParameters
    SourceTargetFolder 指定导出/导入目标文件夹。 字符串
    语言环境 指定可导出的人类可读文本的语言。 字符串
    AdminAddress. 指定未在交付控制器上执行导出时交付控制器的DNS或IP地址。 字符串
    安静的 禁止登录控制台。 SwitchParameter
    DisplayLog 在cmdlet完成时显示日志文件。设置为美元的假抑制日志显示。 真正的美元美元的假
    合并 当设置为真正的美元,只向云站点添加组件。组件未被移除。设置为美元的假删除组件。 真正的美元美元的假
    插件 当设置为真正的美元,只添加新组件,不更新或删除现有组件。设置为美元的假允许更新和删除。合并当参数为?时忽略真正的美元 真正的美元美元的假
    MergePolicies 合并策略设置和过滤器。只有当导入的策略在云DDC中已经存在时才会发生合并。合并策略的结果是,云DDC策略包含它已经拥有的设置和过滤器,以及任何正在导入的新设置和过滤器。请注意,当设置和筛选发生冲突时,导入的值优先。 SwitchParameter

    返回:

云到云cmdlets

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

    将云配置导出到.yml文件。此备份可用于备份和恢复过程,以恢复丢失的组件。

    参数:

    的名字 描述 需要吗? 类型
    由组件迁移 看到由组件迁移 SwitchParameters
    Cloud-accessing参数 看到Cloud-accessing参数 SwitchParameters
    TargetFolder 指定导出目标文件夹。 字符串
    语言环境 指定可导出的人类可读文本的语言。 字符串
    安静的 禁止登录控制台。 SwitchParameter
    DisplayLog 在cmdlet完成时显示日志文件。设置为美元的假抑制日志显示。 真正的美元美元的假
    ZipResults 将备份YAML文件压缩成一个zip文件。该文件与备份的YAML文件在同一个文件夹中,且与文件夹名称相同。 SwitchParameter

    返回:

  • Restore-CvadAcToSite—将备份的YAML文件恢复到云站点。该云站点可以与源云站点相同或不同。

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

    参数:

    的名字 描述 需要吗? 类型
    由组件迁移 看到由组件迁移 SwitchParameters
    按对象名称过滤 看到按对象名称过滤 字符串列表
    Cloud-accessing参数 看到Cloud-accessing参数 SwitchParameters
    恢复食品店 标识包含要还原到云站点的.yml文件的文件夹。这必须是一个完全限定的文件夹规范。 字符串
    语言环境 指定可导出的人类可读文本的语言。 字符串
    安静的 禁止登录控制台。 SwitchParameter
    DisplayLog 在cmdlet完成时显示日志文件。设置为美元的假抑制日志显示。 真正的美元美元的假
    合并 当设置为真正的美元,只向云站点添加组件。组件未被移除。设置为美元的假删除组件。 真正的美元美元的假
    插件 当设置为真正的美元,只添加新组件,不更新或删除现有组件。设置为美元的假允许更新和删除。合并当参数为?时忽略真正的美元 真正的美元美元的假
    MergePolicies 合并策略设置和过滤器。只有当导入的策略在云DDC中已经存在时才会发生合并。合并策略的结果是,云DDC策略包含它已经拥有的设置和过滤器,以及任何正在导入的新设置和过滤器。请注意,当设置和筛选发生冲突时,导入的值优先。 SwitchParameter

    返回:

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

    可以重置整个站点或从组件中删除成员项(例如,从目录列表中删除一个机器目录)。当与IncludeByName参数来有选择地删除特定成员。

    参数:

    的名字 描述 需要吗? 类型
    由组件迁移 看到由组件迁移 SwitchParameters
    按对象名称过滤 看到按对象名称过滤 字符串列表
    Cloud-accessing参数 看到Cloud-accessing参数 SwitchParameters
    安静的 禁止登录控制台。 SwitchParameter
    DisplayLog 在cmdlet完成时显示日志文件。设置为美元的假抑制日志显示。 真正的美元美元的假

    返回:

其他基本cmdlets

  • Compare-CvadAcToSite-将本地的.yml文件与云配置进行比较,生成由进口合并,或恢复cmdlet。

    参数:

    的名字 描述 需要吗? 类型
    由组件迁移 看到由组件迁移 SwitchParameters
    按对象名称过滤 看到按对象名称过滤 字符串列表
    Cloud-accessing参数 看到Cloud-accessing参数 SwitchParameters
    SourceFolder 的替代根文件夹% HOMEPATH % \ \ Citrix \ AutoConfig文档 字符串
    语言环境 指定可导出的人类可读文本的语言。 字符串
    安静的 禁止登录控制台。 SwitchParameter
    DisplayLog 在cmdlet完成时显示日志文件。设置为美元的假抑制日志显示。 真正的美元美元的假
    合并 当设置为真正的美元,只向云站点添加组件。组件未被移除。设置为美元的假删除组件。 真正的美元美元的假
    插件 当设置为真正的美元,只添加新组件,不更新或删除现有组件。设置为美元的假允许更新和删除。合并当参数为?时忽略真正的美元 真正的美元美元的假

    返回:

颗粒迁移参数

由组件迁移

下面的组件可以由支持它们的cmdlet指定。的所有未指定组件参数时会自动选择选项。

  • 所有
  • 标签
  • AdminRolesScopes
  • MachineCatalogs
  • 店面
  • 送货组
  • ApplicationGroups
  • 应用程序
  • GroupPolicies

按对象名称过滤

按组件名称迁移

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

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

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

IncludeByNameExcludeByName还可以获取包含成员列表的文件,其中每个成员可以是显式的或包含通配符。文件中的每一行可以包含一个成员。从成员名中去掉前导和尾随空格。文件名必须以@符号开头,并由单引号包围(PowerShell的要求,这样@就不会被重新解释)。除了与成员名混合之外,还可以列出多个文件。

合并名称以。开头的所有交付组的示例DgSite1并包含我震动会写:

Merge-CvadAcToSite -DeliveryGroups $true -IncludeByName DgSite1*,*Home2*

按交付组名称

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

ByDeliveryGroupName获取传递组名称的列表。任何名称都可以包含一个或多个通配符。支持两种通配符。

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

以下示例合并引用所有传递组名称的所有应用程序EastDg

Merge-CvadAcToSite -Applications -ByDeliveryGroupName EastDg*

排除残疾

ExcludeDisabled从导入操作中过滤所有禁用的应用程序和应用程序组。ExcludeDisabled默认为,即导入所有应用程序和应用程序组,而不管它们的启用状态如何。

机器的名字

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

ByMachineName获取任何名称可以包含一个或多个通配符的机器名称列表。支持两种通配符。

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

当出口或进口和使用ByMachineName如果机器名称筛选器导致机器目录或交付组中没有机器,则机器目录或交付组将被排除在导出或导入之外。

注意:

使用ByMachineName在任何导入类型中,cmdlet会导致MergeMachines被设置为真正的美元

合并的机器

MergeMachines,当设置为真正的美元,指示导入操作只将机器添加到机器目录或交付组。机器不被移除,允许增量的附加操作。

MergeMachines默认值为false,意味着如果机器目录或交付组.yml文件中不存在机器,则会删除它们。MergeMachines被设定为真正的美元ByMachineName使用,但可以通过设置MergeMachines为假。

  • New-CvadAcCustomerInfoFile- 创建客户信息文件。默认情况下,客户信息文件位于% HOMEPATH % \ \ Citrix \ AutoConfig文档

    参数:

    的名字 描述 需要吗? 类型
    CustomerId 客户的ID。 x 字符串
    ClientId. 在Citrix Cloud上创建的客户端ID。使用此参数时必须指定CustomerId和Secret。 有条件地 字符串
    秘密 在Citrix Cloud上创建的客户密钥。使用此参数时,必须指定CustomerId和ClientId。 有条件地 字符串
    环境 生产、ProductionGov或ProductionJP环境。 枚举
    LogFileName 将日志文件的前缀从CitrixLog更改为其他内容。 字符串
    AltRootUrl 请在思杰的指导下使用。 字符串
    StopOnError 在第一次出错时停止操作。 真正的美元美元的假
    TargetFolder 使用指定的文件夹作为根文件夹而不是% HOMEPATH % \ \ Citrix \ AutoConfig文档 字符串
    语言环境 使用指定的本地语言环境,而不是从运行工具的系统派生的语言环境。 字符串
    编辑器 使用指定的编辑器在每个cmdlet完成时显示日志。Notepad.exe是默认编辑器。此参数必须包括编辑器的完全限定文件规范,并且编辑器必须将日志文件规范作为其唯一参数。 字符串
    SecurityCsvFileSpec 完全限定的文件规范指向从Citrix Identity and Access Management下载的SecurityClient.csv文件。使用此参数时必须指定CustomerId。 字符串

    返回:

  • Set-CvadAcCustomerInfoFile—更新已有的客户信息文件。只更改cmdlet指定的参数。CustomerInfo中所有未指定的参数值。Yml文件没有改变。

    参数:

    的名字 描述 需要吗? 类型
    CustomerId 客户的ID。 字符串
    ClientId. 在Citrix Cloud上创建的客户端ID。 字符串
    秘密 在Citrix Cloud上创建的客户密钥。 字符串
    环境 生产、ProductionGov或ProductionJP环境。 枚举
    LogFileName 将日志文件的前缀从CitrixLog更改为其他内容。 字符串
    StopOnError 在第一次出错时停止操作。 真正的美元美元的假
    TargetFolder 使用指定的文件夹作为根文件夹而不是% HOMEPATH % \ \ Citrix \ AutoConfig文档 字符串
    语言环境 使用指定的本地语言环境,而不是从运行工具的系统派生的语言环境。 字符串
    编辑器 使用指定的编辑器在每个cmdlet完成时显示日志。Notepad.exe是默认编辑器。此参数必须包括编辑器的完全限定文件规范,并且编辑器必须将日志文件规范作为其唯一参数。 字符串
    SecurityCsvFileSpec 完全限定的文件规范指向从Citrix Identity and Access Management下载的SecurityClient.csv文件。使用此参数时必须指定CustomerId。 字符串

    返回:

随着云访问参数,以下参数可以与先决条件相关的cmdlet一起使用:

  • 环境- Production或ProductionGov环境。
  • LogFileName—将日志文件的前缀“CitrixLog”修改为其他内容。
  • StopOnError—在第一次出现错误时停止操作。
  • AlternateRootFolder- 使用指定的文件夹作为根文件夹而不是% HOMEPATH % \ \ Citrix \ AutoConfig文档
  • 语言环境- 使用指定的本地而不是从系统派生的语言环境,该工具运行开启。
  • 编辑器-使用指定的编辑器在每个cmdlet完成时显示日志。Notepad.exe是默认编辑器。此参数必须包括编辑器的完全限定文件规范,并且编辑器必须将日志文件规范作为其唯一参数。

支持和故障排除cmdlet

  • New-CvadAcZipInfoForSupport-将所有日志和。yml文件压缩成一个zip文件发送给Citrix以获得支持。客户敏感信息(CustomerInfo。yml和CvadAcSecurity.yml)不包括在zip中。图标。Yml文件也由于其大小而被排除在外。zip文件被放置在% HOMEPATH % \ \ Citrix \ AutoConfig文档和命名CvadAcSupport_yyyy_mm_dd_hh_mm_ss.zip,基于日期和时间戳。这个zip文件也可以作为备份。

    参数:

    的名字 描述 需要吗? 类型
    TargetFolder 指定要创建并保存zip文件的目标文件夹。 字符串
    安静的 禁止登录控制台。 SwitchParameter

    返回:

    • 带有zip文件名和位置的zip文件显示在命令提示符上。
  • Get-CvadAcStatus—用于测试连通性,确保满足所有先决条件。返回有关工具的信息,如版本号、与云的连接和连接器状态。

    参数:

    的名字 描述 需要吗? 类型
    Cloud-accessing参数 看到Cloud-accessing参数 SwitchParameters
    SiteId 标识要连接的站点。 字符串
    AdminAddress. 这是内部交付控制器的DNS或IP地址,用于验证管理员的访问级别。如果工具没有在交付控制器上运行,则需要这样做。 字符串

    返回:

    • 显示每个项目的结果。
  • Test-CvadAcConnectionWithSite—测试与云站点的连接,检查通信是否正常。这个cmdlet使用云访问参数或CustomerInfo。Yml文件来指定客户连接信息。

    参数:

    的名字 描述 需要吗? 类型
    Cloud-accessing参数 看到Cloud-accessing参数 SwitchParameters
    安静的 禁止登录控制台。 SwitchParameter

    返回:

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

    参数:

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

    返回:

    • 结果显示在命令行上。
  • get-cvadaccustomersites-返回所有客户站点的列表。这个cmdlet使用云访问参数或CustomerInfo。Yml文件来指定客户连接信息。

    参数:

    返回:

    • 显示找到的客户站点id列表。
  • new-cvdatemplattofile—为所选组件创建模板文件,允许用户手动创建导入文件。

    参数:

    的名字 描述 需要吗? 类型
    由组件迁移 看到由组件迁移 SwitchParameters
    TargetFolder 指定导出目标文件夹。 字符串

    返回:

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

    参数:

    • 没有任何。

    返回:

    • 在默认网页浏览器中显示此网页。
  • Find-CvadAcInFile- Find in file搜索组件YAML文件,寻找匹配一个或多个可能包含通配符的名称的成员。结果是发现成员的报告。Find in file一次只能搜索一个组件。Find in file搜索当前文件夹和所有子文件夹中的所有YAML文件。使用FindSourceFolder限制要搜索的文件数量。

    参数:

    的名字 描述 需要吗? 类型
    由组件迁移 看到由组件迁移.注意:-值无效。 SwitchParameters
    IncludeByName 指定在将站点活动状态设置为活动时要包括的传递组的名称的列表。' * '和' ?名称中支持通配符。 字符串列表
    独特的 仅报告独特找到的成员。 SwitchParameter
    IncludeYaml 包括成员特定的yaml。 SwitchParameter
    FindSourceFolder “find”文件夹开始搜索。 字符串
    DisplayLog 在cmdlet完成时显示日志文件。设置为美元的假抑制日志显示。 SwitchParameter
    安静的 禁止登录控制台。 SwitchParameter

    返回:

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

网站激活cmdlets

有关激活站点和使用这些cmdlet的更多信息,请参阅激活网站

  • Set-CvadAcSiteActiveStateOnPrem- 将内部部署站点状态设置为活动或非活动状态。

    参数:

    的名字 描述 需要吗? 类型
    Cloud-accessing参数 看到Cloud-accessing参数 SwitchParameters
    SiteActive 当存在时,将现场设置为主动从所有交付组移除维护模式。不设置该参数时,所有下发组设置维护模式。 SwitchParameter
    IncludeByName 指定在将站点活动状态设置为活动时要包括的传递组的名称的列表。' * '和' ?名称中支持通配符。 字符串列表
    ExcludeByName 当将站点活动状态设置为活动时,指定要排除的传递组的名称的列表。' * '和' ?名称中支持通配符。 字符串列表
    安静的 禁止登录控制台。 SwitchParameter
    DisplayLog 在cmdlet完成时显示日志文件。设置为美元的假抑制日志显示。 真或假美元

    返回:

  • Set-CvadAcSiteActiveStateCloud—将云站点的状态设置为active或inactive。

    参数:

    的名字 描述 需要吗? 类型
    Cloud-accessing参数 看到Cloud-accessing参数 SwitchParameters
    SiteActive 当存在时,将现场设置为主动从所有交付组移除维护模式。不设置该参数时,所有下发组设置维护模式。 SwitchParameter
    IncludeByName 指定在将站点活动状态设置为活动时要包括的传递组的名称的列表。' * '和' ?名称中支持通配符。 字符串列表
    ExcludeByName 当将站点活动状态设置为活动时,指定要排除的传递组的名称的列表。' * '和' ?名称中支持通配符。 字符串列表
    安静的 禁止登录控制台。 SwitchParameter
    DisplayLog 在cmdlet完成时显示日志文件。设置为美元的假抑制日志显示。 真或假美元

    返回:

合并多个内部站点cmdlet

有关站点合并和使用这些cmdlet的更多信息,请参见将多个站点合并为一个站点

  • New-CvadAcSiteMergingInfo-创建站点合并前缀/后缀信息集。没有必要一开始就知道所有的前缀或后缀。它们可以被更新Set-CvadAcSiteMergingInfo或者手动编辑SiteMerging。yml文件。参数:

    的名字 描述 需要吗? 类型
    SiteName 用于标识特定站点的前缀/后缀集的名称。它可以匹配实际站点的名称,但不需要。 x 字符串
    网站合并参数 看到网站合并参数 SwitchParameters
    安静的 禁止登录控制台。 SwitchParameter

    返回:

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

    参数:

    的名字 描述 需要吗? 类型
    SiteName 用于标识特定站点的前缀/后缀集的名称。它可以匹配实际站点的名称,但不需要。 x 字符串
    网站合并参数 看到网站合并参数 SwitchParameters
    安静的 禁止登录控制台。 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接口使用的客户ID,需要访问所有Rest接口。您的客户ID在Citrix Cloud中找到。
  • ClientId.—“Citrix云身份与访问管理”网站上创建的“clientID”。这是获取所有Rest api身份验证所需的承载令牌所必需的。
  • 秘密—在Citrix云身份与访问管理网站上创建的密钥。这是获取所有Rest api身份验证所需的承载令牌所必需的。
  • CustomerInfoFileSpec—文件规范指向客户信息文件,以覆盖默认位置和名称。

迁移模式参数

Cmdlets修改云站点配置(进口恢复合并,同步)支持以下额外参数,以提供进一步的灵活性。

  • CheckMode—执行导入操作,但执行make没有的变化。在导入完成之前报告所有预期的更改。您可以使用此命令在导入之前测试它。
  • BackupFirst—修改云配置前,需要将云内容备份到。yml文件中。这在默认情况下是启用的。
  • 确认—当为true时,提示用户确认他们想要更改云站点配置。的删除由于Cmdlet的破坏性,它显示了一个提示。如果不需要提示符,例如在自动化脚本中运行,则设置为false。确认默认值为true。
  • SecurityFileFolder—这是包含CustomerInfo的完全限定文件夹。Yml文件,该文件可能指向在身份验证控制下的本地文件夹或网络共享文件夹。该工具不会提示您输入凭据;在运行工具之前,必须获得对受控资源的访问权限。
  • SiteName—指定导入时使用的站点合并前缀和后缀。
  • SiteActive—导入的站点是激活的还是未激活的。缺省情况下,该参数为美元的假说明导入的站点处于非活动状态。

日志显示参数

出口进口同步恢复备份比较,删除Cmdlets在操作完成时显示日志文件。可以通过设置抑制显示-displaylog.参数美元的假.默认使用“Notepad.exe”显示日志文件。您可以在CustomerInfo中指定一个不同的编辑器。yml文件。

编辑:C:\Program Files\ notepad++ \ notepad++ . exe

Cmdlet返回值

ActionResult

所有cmdlet返回以下值。

public class ActionResult {public bool Overall_Success;public Dictionary Individual_Success;公共对象CustomResult;}

Overall_Success返回一个布尔值,显示cmdlet在所有选定组件上的总体成功:true表示成功,false表示不成功。

Individual_Success为每个主组件返回一个或三个值。组件的结果可以是“成功”、“失败”或“跳过”。跳过表示该组件没有被cmdlet选择执行。

CustomResult是cmdlet具体。

CustomResult

进口合并恢复同步比较比较文件,删除的单个实例返回以下自定义结果信息EvaluationResultData

注意:

出口模板cmdlet不返回自定义结果。

公共类EvaluationResultData {公共字典<字符串,字典<串,ActionResultValues >> EvaluationResults;公共int补充;公共INT更新;公共int删除;公共int nochange;公共互换;公众评估事项总体探讨;public string cloudbackupfolder;public string sourcebackupfolder;其中:public enum actionResultvalues {添加,更新,删除,相同,onothing}公共枚举评估事务{成功,失败,跳过}

EvaluationResults显示每个选定组件带有一个条目的列表。键是组件名,值是每个组件成员和对该组件成员采取的操作的列表。动作可以是ActionResultValues值。

添加更新删除,NoChange指示按此顺序添加、更新、删除或未采取操作的组件成员的总数。

TotalChanged添加更新,删除

总体培训是单个布尔值,指示cmdlet的结果。TRUE表示所有组件和FALSS跨所有组件的总成功指示处理一个或多个组件的故障。

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

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

PowerShell帮助

每个cmdlet都可以使用PowerShell帮助。每个cmdlet都记录了所有参数,并简要说明了cmdlet。要访问任何cmdlet的帮助,输入得到帮助在cmdlet的前面。

得到帮助Import-CvadAcToSite