License Manager

注意：要仅显示特定设备上存在的功能，请从下面的 SmartDocs 栏中选择一个或多个过滤器。

StageNow - 2.10

概述

License Manager (LicenseMgr) 可用来管理设备上的软件许可证，允许设备上的管理员或应用程序控制需要许可的软件的可用性。根据设备上的许可证，可将软件组件设置为可用、不可用或功能受限。如果一个组件需要许可，那么即缺少有效的许可证将会限制或阻止它的功能。不需要许可的软件组件不受此 CSP 影响。

获取许可证

软件许可证从 Zebra 软件许可证服务器获取，它们以软件许可证文件的形式颁发，通过使用许可功能名与特定的软件组件关联。软件许可证文件只能用于启用与它关联的许可功能名。一个组件可能有多个功能，每个功能都通过单独的许可功能名进行控制。或者，一个组件可以通过一个许可功能名来控制它的所有功能。

从 Zebra 软件许可证服务器获取的软件许可证可能是单个设备许可证，每个软件许可证文件都与特定的设备序列号绑定。在这种情况下，必须为每个匹配的设备应用正确的软件许可证文件。Zebra 软件许可证服务器还提供了企业许可证，它们颁发给企业拥有的所有设备。在这种情况下，同一软件许可证文件可以应用到企业拥有的每一台设备。

许可证验证

软件许可证文件从 Zebra 软件许可证服务器中获得，可存储在本地或在线存储，通过 LicenseMgr 引用。但是，服务器不负责验证此类文件是否与特定的许可功能匹配。如果有效的软件许可证文件被错误应用到预期功能之外的许可功能，该功能将不能被启用，并且也不会产生错误。

为防止出现这种情况，Zebra 建议使用验证方法参数来验证许可功能名是否与软件计可证文件中包含的功能名匹配。这会导致在出现不匹配时在结果 XML 中返回错误。

主要功能

  • 在设备中应用/吊销软件许可证
  • 使用（传统）Symbol 或 Zebra 方法执行许可操作
  • 对标准和自定义功能执行许可操作
  • 验证设备上的许可证
  • 指定一个激活 ID
  • 选择是否嵌入或引用许可证
  • 指定设备本地和基于 Web 的许可证文件
  • 指定内部部署的许可证管理服务器的 URL
  • 启用/禁用 Zebra 许可证管理 UI 应用程序

许可证选项

用于指定在设备上执行许可证操作的方法。“传统”Symbol 操作对设备上存储的许可证文件执行。Zebra 操作适用于基于服务器的许可证存储。

参数名称：LicenseChoice

选项 名称 说明需要
0 do_nothing 此值（或 XML 中缺少此参数）会导致不更改设备设置；之前的任何设置将被保留。

MX：7.1+
1 symbol 执行（传统）Symbol 许可证操作。

MX：7.1+
2 zebra 执行 Zebra 许可证操作。

MX：7.1+

Zebra 许可证操作

用于指定要对设备上的激活 ID (AID) 执行的操作。此参数仅适用于 Zebra 品牌的设备。要使用选项 6，请使用“激活 ID 刷新”参数指定 39 个字符的激活 ID。对于传统 Symbol 品牌的设备，使用“许可证操作”参数。注意：选项 4 和 5 以编程方式在设备上使用，不适合用于人机交互。

在以下条件下显示：许可证源为“Zebra 云”，Zebra 许可证操作为“激活 AID”，许可证选项为“执行 Zebra 许可证操作”并且许可证选项为“使用本地许可证证服务器选项”

参数名称：LicenseActionZebra

选项 名称 说明需要
1 activate 在 Zebra 设备上激活 AID。

MX：7.1+
2 return 留作将来使用。在 Zebra 设备上停用 AID，将其返回到一般使用。

MX：7.1+
3 reset 留作将来使用。在 Zebra 设备上停用所有 AID，将它们返回到一般使用。

MX：7.1+
4 acquirefeature 在设备上以编程方式使用，无人机交互。

MX：7.1+
5 returnallfeatures 留作将来使用。在设备上以编程方式使用，无人机交互。

MX：7.1+
6 refreshAID 导致设备在购买许可证更新后联系许可服务器更新设备许可证。

MX：7.2+

许可证操作

用于在传统 Symbol 设备上应用或删除软件许可证。在设备上应用相关软件组件（需要许可）的软件许可证将使得该软件组件的特定功能在该设备上可用。从设备中删除某个软件组件的软件许可证，将使得相关软件许可证的受控功能在该设备上不可用，或使其功能受限。注意：许可证删除操作只是将许可证从私有存储中删除；许可证文件仍存在于设备上，必须单独删除。

在以下条件下显示：许可证选项设置为“Symbol”

参数名称：LicenseAction

选项 名称 说明需要
1 apply 在 Symbol 设备上应用软件许可证。

MX：4.3+
2 remove 从 Symbol 设备中吊销软件许可证。

MX：4.3+

许可证源

控制是使用基于云的还是本地 Zebra 许可服务器。当选择 Zebra 云（选项 1）时，使用“许可证云 URL”参数指定服务器位置。

在以下条件下显示：Zebra 许可证操作是“激活 AID”和许可证选项是“执行 Zebra 操作”

参数名称：LicenseSource

选项 名称 说明需要
1 Zebra 云 表示使用 Zebra 许可云选项之一。

MX：7.2+
2 LLS 表示使用本地许可服务器。

MX：7.2+

许可证云 URL

用于指定设备上基于 Zebra 服务器的许可的来源。

在以下条件下显示：许可证源为“Zebra 云”，Zebra 许可证操作为“激活 AID”，许可证选项为“执行 Zebra 许可证操作”

参数名称：LicenseCloudURL

选项 名称 说明需要
1 选择基于云的 Zebra 许可测试服务器。

MX：7.2+
2 选择基于云的 Zebra 许可生产服务器。

MX：7.2+
3 自定义 URL 许可证 允许指定内部部署许可证服务器或中继服务器的自定义 URL。

MX：7.2+

许可证服务器 URL

用于指定包含 Zebra 许可证激活 ID 的内部部署服务器或指向外部许可服务器的中继服务器的 URL（和可选端口号）。仅当设备不能访问管理它们的组织外部的网络时，此参数才必需。

参数值输入规则：

  • 包含有效 URL（可选端口号）的字符串
  • 必须至少包含 1 个字符

示例：http://InternalLicenseServer.lan:8080

在以下条件下显示：许可证源是“为云许可服务指定自定义 URL”，许可证选项是“Zebra”

参数名称：URL

需要：

  • MX：7.1+

验证方法

控制在标准或自定义功能名参数中指定的许可功能名是否与软件许可证文件的内容匹配。Zebra 建议使用此参数防止许可证功能不匹配。

软件许可证文件从 Zebra 软件许可证服务器中获得，可存储在本地或在线存储，通过 LicenseMgr 引用。服务器不负责验证此类文件是否与特定的许可功能匹配。如果有效的软件许可证文件被错误应用到预期功能之外的许可功能，该功能将不能被启用，并且也不会产生错误。使用“验证方法”参数可防止出现此情况，它将验证许可功能名是否与软件许可证文件中包含的功能名匹配，否则将在结果 XML 中生成错误。

在以下条件下显示：许可证操作是“Symbol”，许可证选项为“Symbol”

参数名称：VerifyMethod

选项 名称 说明需要
0 不验证功能名称 此值（或 XML 中缺少此参数）导致不会更改验证方法；任何以前选择的设置都将保留。

MX：4.3+
1 根据标准功能名称验证 验证在指定的软件许可证文件中包含的许可功能名是否与指定的标准许可功能名匹配。

MX：4.3+
2 根据自定义功能名称验证 验证在指定的软件许可证文件中包含的许可功能名是否与指定的自定义许可功能名匹配。

MX：4.3+

服务器友好名称

用于指定本地许可服务器的“友好”名称，帮助轻松识别。

参数值输入规则：

  • 至少一个字符的字符串

在以下条件下显示：许可证源为“Zebra 云”，Zebra 许可证操作为“激活 AID”，许可证选项为“执行 Zebra 许可证操作”并且许可证选项为“使用本地许可证证服务器选项”

参数名称：ServerFriendlyName

需要：

  • MX：7.2+

刷新激活 ID

用于指定要在设备上刷新的许可证代码。此参数与“刷新 ID　Zebra 许可证操作”配合使用，导致设备在购买许可证更新后联系许可服务器更新设备许可证。

参数值输入规则：

  • 必须是　39　个字符的字符串，其中包含一个有效的激活 ID 代码

在以下条件下显示：Zebra 许可证操作是“刷新 ID”，许可证选项是“执行 Zebra 许可证操作”

参数名称：ActivationIDRefresh

需要：

  • MX：7.2+

激活　ID

用于手动指定由　Zebra 许可系统提供的 39 个字符的代码，用于在设备上激活许可证。

参数值输入规则：

  • 包含 39 个字符的许可证代码的字符串
  • 必须至少包含一个字符

在以下条件下显示：Zebra 许可证操作是“激活 AID”和许可证选项是“执行 Zebra 操作”

参数名称：ActivationID

需要：

  • MX：7.1+

激活数量

用于指定要在设备上激活的许可证副本数量。

在以下条件下显示：Zebra 许可证操作是“激活 AID”和许可证选项是“执行 Zebra 操作”

参数名称：ActivationQuantity

需要：

  • MX：7.1+

标准功能名

用于指定用来验证软件许可证文件的标准许可功能名。

注意：目前，存在一个定义的标准功能名，这是 SimulScan OCR/OMR 的功能名。选择它就无需输入许可功能名的确切（自定义）值。要验证其他功能，请使用“验证自定义名称”并指定许可功能名以匹配正在使用的软件许可证文件。

在以下条件下显示：许可证操作是“Symbol”，许可证选项为“Symbol”

参数名称：VerifyStandardFeatureName

选项 名称 说明需要
1 SIMULDC1_0_0 验证软件许可证文件中包含的 SimulScan OCR/OMR 许可功能名是否与 SimulScan 软件组件的标准许可功能名匹配。

MX：4.3+

自定义功能名

用于指定自定义许可功能名，它必须与从 Zebra 软件许可证服务器获得的软件许可证文件中包含的许可功能名匹配。

注意：必须使用此选项来验证标准许可功能名列表中不包含的任何许可功能名。必须确切输入从 Zebra 软件许可证服务器获取的许可功能名，大小写不必须相同，并且没有额外的空格或其他字符。

参数值输入规则：

  • 包含有效自定义许可功能名的字符串，该功能名包含在从 Zebra 软件许可证服务器中获取的软件许可证文件中

在以下条件下显示：验证方法是“对比自定义功能名验证”，并且许可证选项是“Symbol”

参数名称：VerifyCustomFeatureName

需要：

  • MX：4.3+

返回激活 ID

用于手动指定由　Zebra 许可系统提供的 39 个字符的代码，用于从设备上收回许可证。收回的许可证将返回给组织，以分配到别处。

参数值输入规则：

  • 包含 39 个字符的许可证代码的字符串
  • 必须至少包含一个字符

在以下条件下显示：Zebra 许可证操作是“返回 AID”，并且许可证选项是“执行 Zebra 操作”

参数名称：ActivationIDReturn

需要：

  • MX：7.1+

返回激活数量

用于指定要从设备收回的许可证副本数量。

在以下条件下显示：Zebra 许可证操作是“返回 AID”，并且许可证选项是“执行 Zebra 操作”

参数名称：ActivationQuantityReturn

需要：

  • MX：7.1+

许可证方法

用于指定提供软件许可证的方法。

嵌入值（选项 1）表示软件许可证文件的内容将被嵌入到请求 XML　中。要使用此选项，对于从　Zebra 软件许可证服务器获取的软件许可证文件中使用　Base64　编码的内容，必须由　MDM　代理进行另一次　Base64　编码，然后才能嵌入到此请求　XML 文档中。注意：尽管这会增加数据大小，但是此选项提供了“独立”请求 XML 的优势。

参考值表示将通过路径和文件名引用软件许可证文件，它必须在设备文件系统中。注意：此选项要求将软件许可证文件传输到设备文件系统中，然后再提交请求 XML，并且需要指定设备中软件许可证文件的确切路径和文件名。如果在企业重置后应该应用许可证，那么许可证文件必须存储在一个保留位置，如 /enterprise 目录。

注意：无论采用哪种方法提供软件许可证文件（嵌入或引用），提供的软件许可证文件都必须包含从 Zebra 软件许可证服务器中获取的有效内容。尝试应用包含无效内容的软件许可证文件，将导致在结果 XML 中出现错误。此外，如果软件许可证文件是单个设备许可证，该软件许可证文件中嵌入的设备序列号必须与要应用许可证的设备的序列号相匹配。尝试应用不匹配的许可证将会在结果 XML 中生成错误。

在以下条件下显示：许可证操作是“Symbol”，许可证选项为“Symbol”

参数名称：LicenseMethod

选项 名称 说明需要
1 embed 将许可证文件中的许可证 blob 嵌入到 XML 中。

MX：4.3+
2 reference 引用已经在设备上的许可证文件。

MX：4.3+

许可证文件 'Blob'

用于指定软件许可证文件，其内容将被嵌入到 XML 中。内容采用 Base64 编码，这会将内容大小增加 33%。在请求 XML 中编码的软件许可证将被提取，并应用到设备。

参数值输入规则：

  • 最小长度为 2 个字符的字符串（保存 1 字节内容所需的最小值）
  • 数据必须采用 Base64 编码（4 个字符保存 3 字节的内容）

在以下条件下显示：许可证操作是“应用”，许可证方法是“嵌入”并且许可证选项是“Symbol”

参数名称：LicenseBlob

需要：

  • MX：4.3+

选择删除方法

控制选择许可功能名的方法，它标识要从设备中删除的软件许可证。

在以下条件下显示：许可证操作是“删除”，许可证选项为“Symbol”

参数名称：SelectMethod

选项 名称 说明需要
1 standard 表示使用标准许可功能名来标识要从设备中删除的软件许可证。

MX：4.3+
2 custom 控制使用自定义许可功能名来标识要从设备中删除的软件许可证。

MX：4.3+

删除标准功能

用于指定用来标识要从设备中删除的软件许可证的所需标准许可功能名。

在以下条件下显示：选择方法是“标准”并且许可证选项为“Symbol”

参数名称：SelectStandardFeatureName

选项 名称 说明需要
SIMULDC1_0_0 SimulScan OCR/OMR 导致 SimulScan 软件组件的软件许可证从设备中删除。

MX：+

删除自定义功能

用于指定用来标识要从设备中删除的软件许可证的自定义许可功能名。为确保正确删除，请指定在应用到设备的原始软件许可证文件中包含的确切许可功能名，包括字母大小写、空格等。

参数值输入规则：

  • 包含有效自定义许可功能名的字符串，该功能名包含在从 Zebra 软件许可证服务器中获取的软件许可证文件中

在以下条件下显示：选择方法是“自定义”并且许可证选项为“Symbol”

参数名称：SelectCustomFeatureName

需要：

  • MX：4.3+

要获取的功能

此参数不适用于用户交互。

用于以编程方式指定要启用的功能的名称。

参数值输入规则：

  • 1-40 字符的字符串，完全匹配要获取的功能

在以下条件下显示：Zebra 许可证操作是“获取功能”，许可证选项是“执行 Zebra 许可证操作”

参数名称：FeatureToAcquire

需要：

  • MX：7.1+

获取功能版本

此参数不适用于用户交互。

用于以编程方式指定要使用“要获取的功能”参数获取的功能的版本号。

参数值输入规则：

  • 1 到 10 位数的整数或小数值

在以下条件下显示：Zebra 许可证操作是“获取功能”，许可证选项是“执行 Zebra 许可证操作”

参数名称：AcquireFeatureVersion

需要：

  • MX：7.1+

获取功能计数

由设备上的许可应用程序用来获取功能可使用的次数。此功能以编程方式使用，不适合人机交互。

参数值输入规则：

  • 必须是一个正整数（默认值 = 1）

在以下条件下显示：Zebra 许可证操作是“获取功能”，许可证选项是“执行 Zebra 许可证操作”

参数名称：AcquireFeatureCount

需要：

  • MX：7.2+

示例

显示所有已应用的软件许可证

请求 XML

在以下查询中，请求有关设备上已应用的所有软件许可证的信息：

<wap-provisioningdoc><characteristic-query type="LicenseMgr"/></wap-provisioningdoc>

成功（单 SimulScan 许可证）

<wap-provisioningdoc><characteristic type="LicenseMgr" version="4.3" ><characteristic type="ExistingLicense"><parm name="SelectCustomFeatureName" value="SIMULDC1_0_0"/><parm name="CompanyName" value="CompanyName1"/><parm name="LicenseType" value="serial"/></characteristic></characteristic></wap-provisioningdoc>

如果已应用额外的软件许可证，则会在成功结果 XML 中返回附加信息。在没有应用软件许可证的设备上提交相同的请求 XML 时，将会返回类似如下内容的失败结果 XML：

失败结果 XML

<wap-provisioningdoc><characteristic type="LicenseMgr" version="4.3" ><characteristic-error type="ExistingLicense" desc="Feature is not licensed" /></characteristic></wap-provisioningdoc>

显示特定软件许可证信息

以下查询仅适用于 SimulScan 软件组件的软件许可证。

请求 XML

<wap-provisioningdoc><characteristic type="LicenseMgr" ><characteristic-query type="ExistingLicense"><parm name="SelectStandardFeatureName" value="SIMULDC1_0_0"/></characteristic-query></characteristic></wap-provisioningdoc>

成功（单 SimulScan 许可证）

<wap-provisioningdoc><characteristic type="LicenseMgr" version="4.3" ><characteristic type="ExistingLicense"><parm name="SelectCustomFeatureName" value="SIMULDC1_0_0"/><parm name="CompanyName" value="CompanyName1"/><parm name="LicenseType" value="serial"/></characteristic></characteristic></wap-provisioningdoc>

故障

<wap-provisioningdoc><characteristic type="LicenseMgr" version="4.3" ><characteristic-error type="ExistingLicense" desc="Feature is not licensed" /></characteristic></wap-provisioningdoc>

执行激活 ID 操作

<wap-provisioningdoc><characteristic type="LicenseMgr" version="5.1" ><parm name="LicenseChoice" value="zebra"/><characteristic type="LicenseZebra"><parm name="LicenseActionZebra" value="activate"/><characteristic type="NewLicenseZebra"><characteristic type="LicenseSourceURL"><parm name="LicenseSource" value="fno_cloud_uat"/></characteristic><parm name="ActivationID" value="9f55-3413-9430-45de-b8ff-0fa2-b75d-203b"/><parm name="ActivationQuantity" value="1"/></characteristic></characteristic></characteristic></wap-provisioningdoc>

返回激活 ID

<wap-provisioningdoc><characteristic type="LicenseMgr" version="5.1" ><parm name="LicenseChoice" value="zebra"/><characteristic type="LicenseZebra"><parm name="LicenseActionZebra" value="return"/><characteristic type="ExistingLicenseZebra"><parm name="ActivationIDReturn" value="9f55-3413-9430-45de-b8ff-0fa2-b75d-203b"/><parm name="ActivationQuantityReturn" value="0"/></characteristic></characteristic></characteristic></wap-provisioningdoc>

返回所有激活 ID

<wap-provisioningdoc><characteristic type="LicenseMgr" version="5.1" ><parm name="LicenseChoice" value="zebra"/><characteristic type="LicenseZebra"><parm name="LicenseActionZebra" value="reset"/></characteristic></characteristic></wap-provisioningdoc>

选择 Zebra 许可证服务器作为许可证源

<wap-provisioningdoc><characteristic type="LicenseMgr" version="5.1" ><parm name="LicenseChoice" value="zebra"/><characteristic type="LicenseZebra"><parm name="LicenseActionZebra" value="activate"/><characteristic type="NewLicenseZebra"><characteristic type="LicenseSourceURL"><parm name="LicenseSource" value="fno_cloud_production"/></characteristic><parm name="ActivationID" value="9f55-3413-9430-45de-b8ff-0fa2-b75d-203b"/><parm name="ActivationQuantity" value="1"/></characteristic></characteristic></characteristic></wap-provisioningdoc>