Citrix Virtual Apps and Desktops

SDK 和 API

此版本提供多种 SDK 和 API。要访问 SDK 和 API,请转到 Build anything with Citrix(使用 Citrix 进行构建)。从该位置,请选择 Citrix Workspace 以访问 Citrix Virtual Apps and Desktops 及其相关组件的编程信息。

注意:

Citrix Virtual Apps and Desktops SDK 和 Citrix 组策略 SDK 可以作为模块或管理单元进行安装。请仅使用管理单元安装多个组件 SDK(例如 Citrix Licensing、Citrix Provisioning 和 StoreFront)。

本产品支持 PowerShell 版本 3 至 5。

Citrix Virtual Apps and Desktops SDK

安装 Delivery Controller 或 Studio 时,此 SDK 会自动作为 PowerShell 模块安装。这使您无需添加管理单元即可使用此 SDK 的 cmdlet。(如果选择将此 SDK 作为管理单元安装,下面将提供说明。)

权限

必须使用拥有 Citrix 管理员权限的身份运行 shell 或脚本。尽管在 Controller 上,本地管理员组的成员自动拥有完全管理权限以允许安装 Citrix Virtual Apps 或 Citrix Virtual Desktops,但 Citrix 建议,对于常规操作,应创建具有相应权限的 Citrix 管理员,而不要使用本地管理员帐户。

访问并运行 cmdlet

  1. 在 PowerShell 中启动 shell:打开 Studio,选择 PowerShell 选项卡,然后单击启动 PowerShell
  2. 要在脚本内使用 SDK cmdlet,应在 PowerShell 中设置执行策略。有关 PowerShell 执行策略的信息,请参阅 Microsoft 文档。
  3. 如果要使用管理单元(而非模块),请使用 Add-PSSnapin(或 asnp)cmdlet 添加管理单元。

    V1 和 V2 表示管理单元的版本。XenDesktop 5 单元属于版本 1。Citrix Virtual Apps and Desktops 以及早期版本的 XenDesktop 7 管理单元属于版本 2。例如,要安装 Citrix Virtual Apps and Desktops 管理单元,请键入 Add-PSSnapin Citrix.ADIdentity.Admin.V2。要导入所有 cmdlet,请键入:Add-PSSnapin Citrix.*.Admin.V*

现在,您可以使用 cmdlet 和帮助文件。

Group Policy SDK

通过 Citrix 组策略 SDK,您可以显示并配置组策略设置和过滤器。此 SDK 使用 PowerShell 提供程序创建与计算机和用户的设置及过滤器相对应的虚拟驱动器。提供程序显示为 New-PSDrive 的扩展。

要使用组策略 SDK,必须安装 Studio 或 Citrix Virtual Apps and Desktops SDK。

Citrix 组策略 PowerShell 提供程序可作为模块或管理单元使用。

  • 不需要额外的工作即可使用该模块。
  • 要添加管理单元,请键入 Add-PSSnapin citrix.common.grouppolicy

要访问帮助,请键入:help New-PSDrive -path localgpo:/

要创建虚拟驱动器并加载该驱动器以及设置,请键入:New-PSDrive <Standard Parameters> [-PSProvider] CitrixGroupPolicy -Controller <string>,其中 Controller 字符串为要连接到并从中加载设置的站点中的 Controller 的完全限定域名。

Citrix Virtual Apps and Desktops REST API

使用 Citrix Virtual Apps and Desktops REST API,您可以在 Citrix Virtual Apps and Desktops 部署中自动管理资源。

Citrix Virtual Apps and Desktops REST API 位于 https://developer.cloud.com/citrixworkspace/citrix-daas-rest-apis/docs/citrix-virtual-apps-and-desktops-apis。相应地标记了不适用于 Citrix Virtual Apps and Desktops 的 API。请按照此处的指导配置对 API 服务的访问权限,并使用 API 来管理和优化您的资源。

Monitor Service OData

监视 API 允许使用版本为 3 或 4 的 OData API 访问 Monitor Service 数据。可以根据从 Monitor Service 数据中查询的数据创建自定义监视和报告控制板。OData V.4 基于 ASP.NET Web API,并且支持聚合查询。

有关详细信息,请参阅 Monitor Service OData API

SDK 和 API