集成 Citrix Virtual Apps and Desktops 服务

部署 Citrix Virtual Apps and Desktops 服务 (CVAD) 集成,以便从 Citrix Workspace 中搜索和执行自助操作。用户可以检查出现故障的关联计算机的状态。执行重启、断开连接和注销等操作。管理员还可以为有故障的计算机启用维护模式。

此模板仅支持有故障的计算机,以防止集成在每次同步时处理潜在的大量数据。有关在同步中包括所有计算机的详细信息,请参见 修改端点以搜索所有计算机

有关微应用的更多信息,请参阅 使用 Citrix Virtual Apps and Desktops 服务微应用

检查必备项

要设置此集成,您必须启用带微应用和 Citrix Virtual Apps and Desktops 服务的 Citrix Workspace。此集成与本地 CVAD 不兼容。但是,如果您使用 Citrix Virtual Apps and Desktops 服务进行代理,则此集成模板支持本地 VDA。

以下是您在 Citrix Workspace 微应用中输入的值:

  • 基本 URLhttps://{customerID}.xendesktop.net/citrix/orchestration/api/techpreview/{customerID}/{siteID}/。请参阅 确定基本 URL
  • 站点 ID:您需要微应用的租户站点 ID 才能与 Citrix Virtual Apps and Desktops 服务 API 进行交互。请参阅 收集您的站点 ID
  • 客户 ID:在 Rest API 中使用的客户 ID,是访问所有 Rest API 所必需的。您的客户 ID 位于 Citrix Cloud 中。
  • 令牌 URLhttps://api-us.cloud.com/cctrustoauth2/{customerID}/tokens/clients。请参阅 API 代理
  • 客户端 ID:在 Citrix Cloud 身份和访问管理网站上创建的客户端 ID。获取对所有 Rest API 进行身份验证所需的持有者令牌时,需要此信息。请参阅 生成客户端 ID 和客户端密钥
  • 客户端密钥:在 Citrix Cloud 身份和访问管理网站上创建的私有密钥。获取对所有 Rest API 进行身份验证所需的持有者令牌时,需要此信息。

权限

从身份和访问管理创建安全客户端时,生成安全客户端时使用的帐户必须具有以下 Citrix Virtual Apps and Desktops 服务权限:

  • 只读管理员,全部 -从 Citrix Virtual Apps and Desktops 服务提取数据。
  • 会话管理员,全部 -执行注销和重新启动操作。
  • 技术支持管理员,全部 -启用和禁用维护模式。

安全客户端凭据继承登录用户的权限。如果在创建安全客户端时登录的用户的权限发生变化,那么这些新权限也适用于集成。

为数据筛选器配置 UPN 属性

用户主体名称 (UPN) 属性在 Active Directory 中用作登录的用户标识符。无论您可以在构建操作页面时选择用户电子邮件作为变量来提取数据,现在都可以使用 UPN 属性。如果您的Citrix Virtual Apps and Desktops 服务集成是使用用户电子邮件设置的,如果要使用 UPN 属性启用,请按照此过程进行操作。

更新 UPN 属性快速指南

以下是您需要在 Citrix Virtual Apps and Desktops 服务集成中更新数据筛选器的实例:

  • 我的桌面微应用 > 虚拟桌面页面 > 表组件 > 表属性选项卡 > 数据筛选器
  • 我的会话微应用 > 会话列表页面 > 两个表组件 > 表属性选项卡 > 数据筛选器
  • 我的会话微应用 > 会话详情页面 > 页面详细信息 > 数据过滤器

更新 UPN 属性

如果要使用 UPN 属性启用,请更新 Citrix Virtual Apps and Desktops 服务集成中的表组件数据筛选器。此示例显示了替换上面列出的第一个实例。

  1. 微应用集成页面中,选择 Citrix Virtual Apps and Desktops 服务集成,然后选择我的桌面微应用程序。
  2. 从左侧导航栏中选择 “ 面”,然后选择 “ 虚拟桌 面” 页面。
  3. 在页面生成器中,选择 组件。在 数据筛 选器下的 表属性选项卡中,选择 编辑筛选器

    UPN 条件

  4. 在带有 machines_socated_u 的行的 条件表中,选择值类型为 用户电子邮 件,然后从菜单中选择 用户主体名称 (UPN)
  5. 选择“保存”以完成。
  6. 现在对其他实例重复此过程,根据需要替换值类型。

    UPN 过滤器

API 代理

Citrix 在多个区域提供 API 代理。选择距离 Citrix Cloud 实例所在区域最近的代理:

  • 生产(美国) https://api-us.cloud.com/cctrustoauth2/{CUSTOMER_ID}/tokens/clients
  • 生产(欧盟) https://api-eu.cloud.com/cctrustoauth2/{CUSTOMER_ID}/tokens/clients
  • 生产 (AP-S) https://api-ap-s.cloud.com/cctrustoauth2/{CUSTOMER_ID}/tokens/clients

生成客户端 ID 和客户端密钥

需要客户端 ID 和客户端密钥(安全客户端)才能获取所有 Rest API 的身份验证所需的持有者令牌。在 Citrix Cloud 身份和访问管理页面上创建这些内容。有关详细信息,请参阅生成客户 ID、客户端 ID 和密钥

收集您的站点 ID

Citrix Virtual Apps and Desktops 服务租户站点 ID 允许微应用程序与 Citrix Virtual Apps and Desktops 服务 API 进行交互。使用 PowerShell 框架收集响应,或使用 REST API 客户端调用此值。下面为您介绍了这两个过程。选择一个。

使用 PowerShell 收集站点 ID

你可以使用 PowerShell 找到你的站点 ID。你需要你的 CustomerID、客户端 ID 和客户端密钥。

  1. 访问此处提供的 PowerShell 脚本: https://github.com/philwiffen/get-cvads-siteid/blob/main/Get-CVADS-SiteID.ps1
  2. 下载并编辑脚本,或将其内容粘贴到代码编辑器中。
  3. 在脚本顶部附近的 PowerShell 变量旁边的引号之间输入您的 CustomerID、客户端 ID 和客户端密钥。例如:

    • $customerID = "companycustomerid"
    • $clientID = "f539b28c-6f93-93c2-b526-49c48289f62e"
    • $clientSecret = "FDFLG3fgGKDKD=="
  4. 在 PowerShell 中运行脚本。
  5. 复制并保存站点 ID 响应以供以后使用。

    响应示例: c396f2fa-7824-41bc-9eed-db4d19ad1968

使用 REST API 客户端收集站点 ID

设置 REST API 请求并从响应中收集 Id 值。

  1. 打开任何 REST API 客户端。例如:https://insomnia.rest/download/core/
  2. 调用此端点,将 {customerID} 替换为您的客户 ID:

    curl --request GET \
    —url
    https://{customerID}.xendesktop.net/citrix/orchestration/api/techpreview/me
    
  3. 选择 OAuth2 作为身份验证方法。
  4. 对于访问令牌 URL,请使用 https://api-us.cloud.com/cctrustoauth2/{customerID}/tokens/clients
  5. 使用您在上一过程中生成的客户端 ID 和客户端密码。
  6. 将凭证更改为 In Request Body
  7. 选择 获取令牌
  8. 选择 求 URL 旁边的发送。
  9. 响应会列出您的网站。如果有多个站点,则必须为此集成选择正确的站点。例如:

    {
    "UserId": "34234234234234234",
    "DisplayName": "name",
    "ExpiryTime": "11:58:20 AM",
    "RefreshExpirationTime": "10:58:20 PM",
    "VerifiedEmail": "user@citrix.com",
    "Customers": [
    {
    "Id": "customerID",
    "Name": null,
    "Sites": [
    {
    "Id": "siteID"(这是您需要收集的值)
    "Name": "Site Name"
    }
    ]
    }
    ]
    }
    
  10. 收集并保存值 Id

确定基本 URL

集成需要为 Citrix Virtual Apps and Desktops 服务 API 终端节点配置基本 URL。此 URL 对每个租户都是唯一的。

格式如下:https://{customerID}.xendesktop.net/citrix/orchestration/api/techpreview/{customerID}/{siteID}/

  • 使用 Citrix Cloud 的客户 ID 替换 {customerID} 两次。
  • {siteID} 替换为您在上一过程中收集的站点 ID。

将集成添加到 Citrix Workspace 微应用

将 Citrix Virtual Apps and Desktops 服务集成添加到 Citrix Workspace 微应用。身份验证选项已预先选择。确保在完成此过程时选择了这些选项。这样可以提供现成的微应用,以及可以在 Workspace 内使用的预配置通知和操作。

请按照以下步骤进行操作:

  1. 微应用集成页面中,选择添加新集成,然后选择从 Citrix 提供的模板添加新集成
  2. 选择 Citrix Virtual Apps and Desktops 服务磁贴。
  3. 输入集成的集成名称
  4. 输入连接器参数
    • 输入实例 基本 URLhttps://{customerID}.xendesktop.net/citrix/orchestration/api/techpreview/{customerID}/{siteID}/
    • 从 图标 库中选择集成的图标,或将其保留为默认图标。

    CVAD 配置 1

  5. 服务身份验证下,从身份验证方法菜单中选择 OAuth 2.0,然后填写身份验证详细信息。身份验证选项已预先选择。确保在完成此过程时选择了这些选项。使用 OAuth 2.0 安全协议为委派访问生成请求/授权令牌。建议您始终使用 OAuth 2.0 作为服务身份验证方法(如果可用)。OAuth 2.0 可确保您的集成符合您配置的微应用的最大安全合规性。

    1. 授权类型流程菜单中选择客户端凭据
    2. 授权类型值字段中输入 client_credentials
    3. 令牌授权菜单中选择请求正文
    4. 令牌内容类型菜单中选择 URL 编码表单。
    5. 确认令牌 URL 字段。此值已预填充:https://api-us.cloud.com/cctrustoauth2/{customerID}/tokens/clients
    6. 输入您的客户端 ID。客户端 ID 是表示授权服务器唯一的客户端注册信息的字符串。
    7. 输入您的客户端密钥。客户端密钥是随客户端 ID 发出的唯一字符串。

    CVAD 配置 2

  6. 请求速率限制字段中,输入 120
  7. (可选)启用日志记录开关以保留 24 小时的日志记录以供支持。
  8. 选择 保存 以继续。

    CVAD 配置 3

微应用集成页面将打开,其中包含您添加的集成及其微应用。现在,您可以设置和运行第一个数据同步。有关同步规则、不符合其计划的同步以及否决规则的完整信息,请参阅 同步数据

有关 API 端点和表实体的更多详细信息,请参阅Citrix Virtual Apps and Desktops 服务连接器规格

同步所有计算机

此集成模板旨在仅支持有故障的计算机。这样可以防止集成在每次同步时处理潜在的大量数据。

您可以进行以下更改以访问所有计算机。但是,同步性能会降低,您必须相应地调整同步计划。

要同步所有计算机:

  1. 必须删除管理模式微应用中的错误机器通知,或者禁止每次同步自动运行。
  2. 修改终端节点以搜索所有计算机。

管理模式微应用更改中出现错误的机器通知

执行以下步骤可防止管理模式微应用的订阅者在每次执行同步时接收每台同步计算机的通知。

  1. 微应用集成 页面中,选择 Citrix Virtual Apps and Desktops 服务集成。
  2. 选择 管理模式 微应用。“通知 ” 视图应该已经可见,但如果不可见,请选择 “ 通知”。
  3. 选择处于 故障状态的计算机通知上的 省略号选项,然后选择 删除 以完全删除通知,或者编辑通知。

    • 如果您删除了通知,请继续下一部分:修改终端节点以搜索所有计算机。
    • 如果您编辑了通知,请禁用 集成数据更改后自动运行此事件 切换,然后选择 保存

修改端点以搜索所有计算机

计算机端点的完全同步和增量同步中删除 SearchFilter

  1. 微应用集成 页面中,选择 Citrix Virtual Apps and Desktops 服务集成旁边的菜单,然后选择 编辑。此时将打开“数据加载”屏幕。如果您在配置屏幕中,请从左侧导航栏中选择数据加载
  2. 选择计算机端点旁边的菜单,然后选择编辑或选择端点本身的名称:计算机

    CVAD 端点

  3. 编辑数据端点屏幕中,在完全同步下,选择 BODY 选项卡,然后删除 SearchFilter,仅在 BODY 中保留 {}
  4. 向下滚动,然后在增量同步下选择 BODY 选项卡,然后再次删除 SearchFilter,仅在 BODY 中保留 {}

    搜索过滤器

  5. 选择屏幕底部的应用并确认完成。

记得调整同步。有关详细信息,请参阅同步数据

使用 CVAD 微应用

Citrix Virtual Apps and Desktops 服务集成附带开箱即用的微应用。从这些微应用开始,并根据您的需求定制它们。

我的桌面: 搜索有问题的 Citrix Virtual Desktops,然后从 Citrix Workspace 执行自助操作,例如重新启动。

通知或页面 用例工作流
虚拟桌面详情页面 提供包含桌面详细信息以及重新启动桌面强制重启桌面的选项的页面。
“Virtual Desktops”页 提供与用户关联的错误 Citrix Virtual Desktops 的可搜索列表以及指向虚拟桌面详细信息页面的链接。

我的会话: 搜索 Citrix Virtual 会话,然后从 Citrix Workspace 执行自助操作,例如注销和断开连接。

通知或页面 用例工作流
“会话列表” 页面 提供与用户关联的虚拟桌面会话的可搜索列表,以及指向会话详细信息页面的链接。
会话详情页面 提供一个包含虚拟桌面会话和计算机详细信息的页面,以及注销会话断开连接会话的选项。

Virtual Desktops(管理模式): 启用 Citrix Workspace CVAD 管理员查找有故障的计算机、查看其详细信息、将计算机置于维护模式以及重新启动计算机。

通知或页面 用例工作流
处于故障状态的计算机通知 当计算机有报告故障状态的新记录时,所有订阅者都会收到一条通知,其中包含重新启动桌面按钮,该按钮链接到虚拟桌面详细信息页面。
Virtual Desktops 列表页 提供错误 Citrix Virtual Desktops 的可搜索列表,其中包含指向虚拟桌面详细信息页面的链接。您可以按计算机或用户进行搜索。
虚拟桌面详情页面 提供一个包含桌面详细信息的页面,以及重新启动桌面强制重启桌面启用维护模式禁用维护模式的选项。
集成 Citrix Virtual Apps and Desktops 服务