产品文档
Licensing
Current Release 11.17.2 build 48000 11.17.2 build 47000 11.17.2 build 46000 11.17.2 build 45000 11.17.2 build 44000 11.17.2 build 43000 11.17.2 build 42000 11.17.2 build 41000 11.17.2 build 40000 11.17.2 build 39000 11.17.2 build 37000 11.17.2 build 36000 11.17.2 build 35000 11.16.6 11.16.3 11.15
查看 PDF

Citrix Licensing 遥测数据元素

July 18, 2024
投稿者: 
C

许可证服务器数据元素

元数据字段

字段 说明 示例
ClientTool 此字段未被使用。 不适用
UploadUser 此字段未被使用。 不适用
UTCDate 报告生成时间，采用 UTC 格式。 2022-10-10T06:11:14Z
日期 报告生成时间，采用本地时间格式。 10/10/2022 02:11:14
产品 上载的名称。 LicenseServerCompliance
ProductVersion 这是上载的版本。 2.0
ProductUTCDeployDate 表示安装许可证服务器的时间。 2022-08-16T00:00:00Z
SiteID 此字段未被使用。 不适用
SiteName 此字段未被使用。 不适用
组件 此字段未被使用。 不适用
UI 此字段确保上载的文件的完整性。 8826d6ac8e1c8e68e471ae90c2bacbe1854f8281a6f5ae40cc7b74114e026abc

许可证服务器和许可证使用信息

字段名称 说明 示例值
许可证服务器信息    
GUID 在安装期间创建并在升级期间保留的唯一标识符。此字段用于标识哪些上载来自同一服务器。 a5ae17c9-8a4a-4318-938f-a8c6da2aa2ef
HardwareId 此字段是许可证服务器实例的唯一标识符。 E824249098A96BF0
FQDN 许可证服务器计算机和域名。发送此值是为了帮助识别报告体验中的许可证服务器。用于将呼叫总部的许可证服务器与后端办公系统中的许可证分配记录配对。 CITRIX-12T5MRV4
InstallUTC 此值表示安装许可证服务器的时间。 2016-10-12T00:00:00Z
ProductVersion 标识许可证服务器版本。 11.16.6.0 Build 35000
SGPClockErrorCode 用于指示许可证服务器为何进入补充宽限期的错误代码。 0
SGPMaxDays 补充宽限期内剩余的最大天数。 15
     
清单    
功能    
ID 此值表示与许可证使用关联的产品代码 CAG_AAC_CCU
UDBinFileCreatedUTC 用于跟踪用户或设备许可证的文件的创建时间的时间戳。 2016-11-09T00:55:56Z
UDReportGenerationUTC 生成用户或设备报告时的时间戳。 2016-11-09T00:55:56Z
UDAdminUsersReleased udadmin 发布的用户数量。 3
UDAdminDevicesReleased udadmin 发布的设备数量。 3
SADate 此字段用于构建许可证随时间推移的使用情况视图。 有关示例，请参阅下一部分中的 SADate。
SADate    
id 通过 SADate 元素的 ID 属性捕获 SA 日期。 2022.1231
DateSampleStartUTC 采集样本的开始时间。 2016-11-08T01:08:13Z
DateSampleStopUTC 采集样本的结束时间。 2016-11-09T00:55:56Z
CountUsedMax 此值表示此客户使用的最大许可证数量。 6
CCUDevices 列出使用 Citrix 并发许可证的设备 ID。这有助于随着时间的推移提高许可证的使用率。  
活动 如果值为“1”，则表示它在当前清单中。如果值为“0”，它将仅出现在历史记录中，不再是当前清单的一部分，因为它已被删除或过期。 1
许可证持有人 Licensees（许可证持有人）字段有三个子字段，即“CountTotal”、“Users”（用户）和“Devices”（设备）。 有关示例，请参阅下一部分中的许可证持有人。
CountInstalled 安装的许可证数量。 1203
池   有关示例，请参阅下一部分中的池。
CCUDevices    
DevId 指定唯一的并发设备标识符。这仅适用于并发许可证。 C39A925064A3
许可证持有人    
CountTotal 采集样本时使用的许可证总数。总数为用户和设备的总和。 3
用户 分配了用户许可证的特定用户数，计入总数内。这仅适用于用户/设备许可证。 有关示例，请参阅下一部分中的用户。
设备 分配了设备许可证的特定设备数，计入总数内。这仅适用于用户/设备许可证。 有关示例，请参阅下一部分中的设备。
用户    
timeLastLogin 来自某个用户的上次登录时间事件。 2022-07-12T10:00:00
ID 分配了用户许可证的特定用户数，计入总数内。 user@domain.com 或 user
设备    
timeLastLogin 来自此设备的上次登录时间事件。 2022-07-12T10:00:00
DevId 指定分配了设备许可证的唯一设备标识符，计入总数内。 C39A925064A3
名称 设备的友好名称。 User1Desktop
池    
序列 此信息使 Citrix 能够确定该产品授权给哪些用户。 OR10:13
DateExpiration 影响池中的许可证计数的最新过期日期。 12/1/2020。
DateIssued 许可证文件的发布日期。先到期的许可证文件的颁发日期。 1-Dec-03
VendorStr 表示许可信息，告知产品必须以哪个版本和模式运行。 <![CDATA[;LT=Retail;GP=2;PSL=10;CL=ENT,ADV,STD,AST;SA=1;ODP=0]]>。
CountInstalled 为给定功能在池中安装的许可证数量。 100
CountOverdraft 使用的许可证数量超过安装的数量。 0
UsageSamples 有关示例，请参阅下一部分中的样本。
DateStart 许可证的生效日期。 31-Dec-2014
示例    
时间戳 样本收集的时间戳。 2016-11-09T00:55:56Z
CountInUse 在特定时间戳使用的许可证数量。 3
透支 使用的许可证数量超过安装的数量。 0
已安装 在特定时间戳安装的许可证数量。 100
     
StartupCounts 数据元素    
LPE 与许可证服务器通信的每台服务器的产品、版本和版本信息。左起示例 - Apps and Desktops Premium - 2012。 <ID><![CDATA[XDT_PLT_2020.1201]]></ID>
计数 连接到许可证服务器的 LPE 总数。 2
     
SupplementalGracePeriod    
ID 此字段表示以下补充宽限期详细信息关联的产品代码。 XDT_ENT_UD
SADate 此字段表示触发补充宽限期的 CSS 日期。 2019.1201
SGPErrorCode 触发补充宽限期的错误代码。 -4
LicCount 触发补充宽限期的许可证数量。 100
DateTriggerUTC 为 ID 和 SADate 触发补充宽限期的 UTC 日期。 2022-07-19T14:35:59Z
DateTriggerLocal 为 ID 和 SADate 触发补充宽限期的本地日期。 2022-07-19T10:35:59

Citrix Virtual Apps and Desktops 数据元素

元数据字段

字段 说明 示例
ClientTool 此字段未被使用。 不适用
UploadUser 此字段未被使用。 不适用
UTCDate 报告生成时间，采用 UTC 格式。 2022-06-30T15:31:34Z
日期 指示载捆绑包的创建日期。 06/30/2022 11:31:34
产品 识别上载捆绑包 LicenseServer.OnPremUsage
ProductVersion 清单架构版本。 1.0
ProductDeployUTCDate 表示安装许可证服务器的时间。 2022-03-21T00:00:00Z
GUID 在安装期间创建并在升级期间保留的唯一标识符。此字段用于标识哪些上载来自同一服务器。 a5ae17c9-8a4a-4318-938f-a8c6da2aa2ef
UploadType 指示许可证上载是手动还是自动进行。 自动
Ccid 指示 Citrix Cloud 客户 ID；仅适用于注册的许可服务器。 xaxddaily1
OrgID 指示组织 ID，安装的许可证与之关联；仅适用于注册的许可证服务器。 23456123
TotalFiles 上载捆绑报中的文件总数。 6
SerialNumbers → Serial → ID 表示与已安装的许可证关联的产品代码。 XDS_ADV_CCS
SerialNumbers → Serial → SADate 表示与已安装的许可证关联的 CSS 日期。 2023.1201
SerialNumbers → Serial → SN 此信息使我们能够确定该产品授权给哪些用户。 eval1
File → Name 上载的文件的名称。 ue_lt_1683864965.zip
File → UI 用于指示文件完整性的哈希值。 4d14a58f98b1ae2e9d965b2980b67853cfcac7c76e655952bd056ad6dc7a80ae
File → EventStartTS 指示捆绑包数据的开始时间。 1697417241680
File → EventEndTS 指示捆绑包数据的结束时间。 1697430741834
File → OfferingType → Name 指示产品。 Broker
FilesUI 用于指示捆绑包完整性的哈希值 4d14a58f98b1ae2e9d965b2980b67853cfcac7c76e655952bd056ad6dc7a80ff
ManifestUI 用于指示清单完整性的哈希值。 4d14a58f98b1ae2e9d965b2980b67853cfcac7c76e655952bd056ad6dc7a8345

标题

字段 说明 示例
ver 许可证使用事件的版本。 1.0
id 使用事件的唯一标识符。 d4ce7919-5d80-44de-a8fa-102923fe0ead
type CAS 用于识别云使用事件的事件类型。 Cloud.Licensing
st 在 Broker 中生成事件时的时间戳。 2011-08-12T20:17:46.384Z
prod 使用事件的原始产品和部署。 XenDesktop.Broker
prodVer DaaS 或 Citrix Virtual Apps and Desktops 产品版本 7.25.0.0
user 指定用于识别启动会话的用户的唯一用户 ID。 fullName: User-Steven
    samName: CTXLAB\User-Steven
    upn:User-Steven@ctxlabs.onmicrosoft.com
    userLicenseId: User-Steven@CTXLABS04
    userSid: S-1-5-21-3711855558-820010554-2448362978-22222
tenant -> id Citrix Cloud 帐户的客户 ID。对于本地环境，值始终为“CitrixOnPremises”。 joj1mh0598tj
dvc -> dvcId 指定用于识别启动会话的设备的唯一设备 ID。 AE18C4D5
dvc -> dvcName 设备的友好名称。 Steven’s PC

有效负载

字段 说明 示例
appProtectionKeyLoggingRequired 表示会话是否在启用了按键记录保护的情况下启动。 False
appProtectionScreenCaptureRequired 表示会话是否在启用了屏幕捕获保护的情况下启动。 False
cspTenantCustomerId CSP 租户的 Citrix Cloud 帐户的客户 ID。如果客户 ID 不可用（例如，在本地部署中），此字段将留空。 6c2vtxgxyftt
isAnonymousUser 表示是否启动了未经身份验证的会话。 False
licenseActivityTimeStamp 生成有效负载时的时间戳。 2011-08-12T20:17:46.384Z
licenseActivityType 许可事件类型。此字段指示许可事件类型是用于分配还是发布操作。 连接
licenseModel 部署的许可模式。 UserDevice
productEdition 部署的产品版本。 Premium 或 Advanced
productId 部署中的产品的产品 ID。 CAVDS
协议 用于启动会话的协议。 HDX
sessionKey 会话的唯一标识符。 uq390c5fc3-86eb-4df3-bd9a-f4a8fed2c9e2
sessionSupport 会话支持类型。 SingleSession
sessionType 会话类型 应用程序
ver 有效负载版本。 1.3
workerSid 用于会话的 VDA 的唯一标识符。 S-1-5-21-3711855558-820010554-2448362978-27640
isWindows365 表示会话是否对 Windows 365 启动 True
entitlementType 客户的许可证权利类型 生产
siteId 站点的唯一标识符 a35647d0-901c-4477-87e0-dcd781d455f4
desktopGroupId 桌面或交付组的唯一标识符 e9d859dc-1bfc-4b3e-bad3-41806bb4e694
clientType Citrix Workspace 应用程序类型 Windows
clientVersion Citrix Workspace 应用程序版本 23.5.1.83
workerCloudType 用于 VDA 预配的公有云类型。 Azure
enabledFeatures 表示为会话启用的功能。例如，在启用了 AppProtectionScreenCaptureRequired 和 SessionRecording 的会话中，此字段的值为 66。 66
isEvents 许可证服务器中的严重故障 无法创建 ST 数据库。
heartBeatTime 发送到 CIS 或 CAS 的许可证服务器检测信号时间 1689058813

下表指定了 enabledFeatures 下分配给不同功能的数量：

功能 enabledFeature 数量
AppProtectionKeyLoggingRequired 1
AppProtectionScreenCaptureRequired 2
AnonymousUser 4
Windows 365 8
SaaS 32
SessionRecording 64
WEM 128

Citrix Secure Private Access 数据元素

管理员有效负载 v1.0

事件标题

字段 说明 示例
ver 标题版本。硬编码：”ver”: “1.0” 1.0
id 唯一事件 ID (GUID) 1fced2a0-52e7-4c48-bf4e-6f2e06136e11
type
事件类型名称。硬编码 admin
“type”: “admin”
st UTC 格式的时间戳 2011-08-12T20:17:46.384Z
prod
产品名称。硬编码。
“prod”: “AccessSecurity.OnPrem”		 AccessSecurity.OnPrem
prodVer 产品版本 2402
user




用于识别登录的管理员的唯一 ID。




{
“fullName”: “Username”,”fullName”: “Username”,
“samName”: “用户的 SAM 帐户名称”,
“upn”: “用户的 UPN 名称”,
“userSid”: “用户的 SID”
}

事件有效负载

字段 说明 示例
actualtemplatecode
有效负载模板版本。
Hardcoded:”actualtemplatecode”: “1.0”		 1.0
adminLoginType
管理员的 RBAC
type: enum
values: fulladmin/readonly/helpdesk
clientType 管理员的登录位置。管理员控制台/Director/公共 API 等未从客户端收到用户代理时，将发送其他对象。 AdminConsole/CitrixMonitor/其他
tenantName 多租户部署（服务提供商）的租户名称或单租户的站点名称。 SPASite1
enabledFeatures 表示为会话启用的功能。 1

配置有效负载 v1.0

事件标题

字段 说明 示例
ver 标题版本。硬编码：”ver”: “1.0” 1.0
id 唯一事件 ID (GUID) 1fced2a0-52e7-4c48-bf4e-6f2e06136e11
type
事件类型名称。硬编码 配置
“type”: “config”
st UTC 格式的时间戳 2011-08-12T20:17:46.384Z
prod
产品名称。硬编码 AccessSecurity.OnPrem
“prod”: “AccessSecurity.OnPrem”
prodVer 产品版本 2405

事件有效负载

字段 说明 示例
actualtemplatecode
有效负载模板版本。硬编码。
“actualtemplatecode”: “1.0”		 1.0
appsPublished















已发布的内部和外部应用程序列表。包括 Web/SaaS 和 TCP/UDP 应用程序。















[
{
“name”:”jira”,
“type”: “web”,
“internal”: true
},
{
“name”:”Office 365”,
“type”: “saas”,
“internal”: false
},
{
“name”:”eng_printer”,
“type”: “tcp”,
“internal”: true
}
]

用户有效负载 v1.5

事件标题

字段 说明 示例
ver 标题版本。硬编码：”ver”: “1.0” 1.0
id 唯一事件 ID (GUID) 1fced2a0-52e7-4c48-bf4e-6f2e06136e11
type
事件类型名称 user
“type”: “user”
st UTC 格式的时间戳 2011-08-12T20:17:46.384Z
prod
产品名称。硬编码
“prod”: “AccessSecurity.OnPrem”		 AccessSecurity.OnPrem
prodVer 产品版本 2402
user




用于识别用户的唯一 ID。




{
“fullName”: “Username”, (可选)
“samName”: “用户的 SAM 帐户名称”,
“upn”: “用户的 UPN 名称”,
“userSid”: “用户的 SID”
}
dvc


PII 数据，如果已启用，则必须对这些值进行加密。
dvcId - 用于识别从中启动应用程序的设备的唯一设备 ID。
dvcName - 设备的友好名称。
{
“dvcId”: “AE18C4D5”,
“dvcName”: “用户的 PC”
}

事件有效负载

字段 说明 示例
actualtemplatecode
有效负载模板版本。
Hardcoded:”actualtemplatecode”: “1.5”		 1.5
transportProtocolType 连接类型：TCP 或 EDP 或 0（适用于 Web\SaaS） tcp
ngsRecordType 应用程序类型：websaas 或 tcpudp websaas
tenantName 多租户部署（服务提供商）的租户名称或单租户的站点名称。 SPAOPDEVSite
SPAOPDEVSite








用户为了执行事件而访问的应用程序列表。








{
“published” : {
“internal” : [“issues.citrite.net”],
“external” :[“citrixsys.splunk.com”, “www.office365.com”]
},
“unpublished” : {
“internal” : [],
“external” : [“www.okta.com”, “www.cloudcentral.com”]
}
}
clientInfo 此字段表示客户端是否为 Citrix Enterprise Browser、Citrix Secure Access、Citrix Workspace 应用程序、RfWeb 以及版本。 {“name”: “ceb”, “version”: “21.4.0”}
platformType 此字段显示代理操作系统类型。 Win/MacOS/iOS/Android
enabledFeatures 表示为会话启用的功能。 1

用户有效负载 v1.0

事件标题

字段 说明 示例
ver 标题版本。硬编码：”ver”: “1.0” 1.0
id 唯一事件 ID (GUID) 1fced2a0-52e7-4c48-bf4e-6f2e06136e11
type
事件类型名称。硬编码
“type”: “PolicyDocument.Download”		 PolicyDocument.Download
st UTC 格式的时间戳 2011-08-12T20:17:46.384Z
prod
产品名称。硬编码。 AccessSecurity.OnPrem
“prod”: “AccessSecurity.OnPrem”
prodVer 产品版本 2402
$schema
对架构的引用，硬编码 https://cas.citrix.com/schemas/event.json
“$schema”: "https://cas.citrix.com/schemas/event.json"
tenant



组织（客户）身份信息
“tenant”: {
“id”: “”
}
Secure Private Access 插件不跟踪客户 ID 或组织 ID。此字段必须为空。		 “tenant”: {
“id”: “”
}

user


用户识别映射信息，仅限 UPN。
“UPN”: <用户名 (可以选择进行编码)>
如果启用了加密功能，则进行编码（请参阅“启用了事件有效负载的功能”）。
 
“user”: {
“UPN”: "User UPN name"
}

事件有效负载

字段 说明 示例
actualtemplatecode
有效负载模板版本。
Hardcoded:”actualtemplatecode”: “1.0”		 1.0
ngsUsername
UPN 格式的用户名（明文/编码）。
如果启用了加密功能，则进行编码（请参阅“启用了事件有效负载的功能”）		 User UPN name
Encoded UPN name
ngsProductName
产品名称。硬编码。 AccessSecurity.OnPrem
“ngsProductName”: “AccessSecurity.OnPrem”
transportProtocolType 连接类型：TCP 或 UDP 或 0（适用于 Web\SaaS） tcp
ngsRecordType 应用程序类型：websaas 或 tcpudp websaas
tenantName 多租户部署（服务提供商）的租户名称或单租户的站点名称。 SPAOPDEVSite
enabledFeatures 表示为会话启用的功能。目前未使用。 1
Citrix Licensing 遥测数据元素
July 18, 2024
投稿者: 
C
July 18, 2024
投稿者: 
C

在本文中

站点反馈 | Your privacy choices footer link您的隐私选择 | 隐私和法律条款 | Cookie 首选项 | 同意设置 | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.