Values Returned for Clone Protection
This topic describes the values that are returned for clone protection by the AdminApi.adminGet method when you retrieve all Product data for a specific Vendor ID or all data for a specific Key ID.
Clone protection information is returned by the AdminApi.adminGet method using the following tags:
<cloneprotection>status</cloneprotection>
<cloneprotection_physical>physicalScheme</cloneprotection_physical>
<cloneprotection_virtual>virtualScheme </cloneprotection_virtual>
where:
>status is 0 for disabled, or 2 for enabled
>physicalScheme is Disable, PMType1, PMType2, PMType3, PMType4, or FQDN.
>virtualScheme is Disable, VMType1, or FQDN.
For information about clone protection schemes, see the Sentinel LDK Software Protection and Licensing Guide.
The values returned for clone protection depend on a number of factors.
For licenses created in Sentinel LDK v.6.4 or earlier – clone protection is always enabled. Therefore:
| Tag | Returned Value |
|---|---|
<clone_protection>
|
2 |
<cloneprotection_physical>
|
PMType1 |
<cloneprotection_virtual>
|
VMType1 |
For licenses created in Sentinel LDK v.7.0 – clone protection can be enabled or disabled. Therefore:
| Tag | Returned Value When Clone Protection Is: | |
|---|---|---|
| Enabled | Disabled | |
<clone_protection>
|
2 | 0 |
<cloneprotection_physical>
|
PMType1 | Disable |
<cloneprotection_virtual>
|
VMType1 | Disable |
For licenses created in Sentinel LDK v.7.1 or later – clone protection can be set using either of two methods.
>Returned value when clone protection was set using the <clone_protection> tag - same as Sentinel LDK v.7.0 (above).
>Returned value when clone protection was set using the <clone_protection_ex> tag:
<cloneprotection_physical> returns the value assigned using the <physical_machine> tag (Disable, PMType1, PMType2, or FQDN).
<cloneprotection_virtual> returns the value assigned using the <virtual_machine> tag (Disable,VMType1, or FQDN).
<clone_protection> returns a value that depends on the type of machine where the license resides:
•On a physical machine: Returned value is 0 for Disable, or 2 for PMType1, PMType2, or FQDN.
•On a virtual machine: Returned value is 0 for Disable, or 2 for VMType1 or FQDN.
Example for a license created in Sentinel LDK v.7.1
Given that clone protection was set using the following tags:
<clone_protection_ex>
<physical_machine>PMType2</physical_machine>
<virtual_machine>Disable</virtual_machine>
</clone_protection_ex>
>When the license resides on a physical machine, the retrieved values are:
<cloneprotection>2</cloneprotection> <cloneprotection_physical>PMTyp2</cloneprotection_physical>
<cloneprotection_virtual>Disable</cloneprotection_virtual>
>When the license resides on a virtual machine, the retrieved values are:
<cloneprotection>0</cloneprotection> <cloneprotection_physical>PMTyp2</cloneprotection_physical>
<cloneprotection_virtual>Disable</cloneprotection_virtual>
For licenses created for Android (in Sentinel LDK v.7.3 or later)– clone protection can be enabled or disabled. Therefore:
| Tag | Returned Value When Clone Protection Is: | |
|---|---|---|
| Enabled | Disabled | |
<clone_protection>
|
2 | 0 |
<cloneprotection_physical>
|
PMType3 | Disable |
<cloneprotection_virtual>
|
Disable | Disable |