Scope Input XML Tags
You use Scope XML tags to request information about the Sentinel LDK system, to specify a license that is to be transferred or detached, or to specify a Feature for the LoginScope function. The table below describes all the XML elements that can be used.
Refer to Using XML Tags to Define Scope for additional information about creating Scope templates using XML tags.
|
Parent Tag |
Child Tag |
Description |
|---|---|---|
|
none - root |
<haspscope> |
Root element for the Scope XML. |
|
<product> |
<id> |
ID of the Base Product. |
|
<license_manager> |
<hostname> |
Name of the computer on which Sentinel License Manager is running. Specify one of the following values: >When the API connects with a client identity to the remote server: The value from the field Public Address for Access With Identity and ACC in the Access from Remote Clients tab on the Admin Control Center Configuration page. >When a client identity is not used: The value that appears in the Computer Name field on the Admin Control Center Diagnostic page for. (Do not specify a DNS alias.) NOTE When using client identities, it is typically not necessary to select with hostname or IP since the identity string already limits a license to a specific host. >Specify ~locahost to refer to any machine other than the local machine. |
|
<license_manager> |
<id> |
Unique ID of the Sentinel License Manager. |
|
<license_manager> |
<ip> |
IP address of the computer on which Sentinel License Manager is running. NOTE When using client identities, it is typically not necessary to select with hostname or IP since the identity string already limits a license to a specific host. When
using the IPv6 protocol, you must use the IPv6 format. For example,
type |
|
<vendor> |
<id> |
ID of vendor related to the Batch Code. |
|
<vendor> |
<code> |
Base-64 encoded Vendor Code. |
|
<hasp> |
<id> |
ID of the Sentinel protection key. |
|
<hasp> |
<version> |
Firmware version of HL key, with optional cmp attribute. |
|
<hasp> |
<type> |
Type of Sentinel protection key. Possible values are: >HASP-HL (Sentinel HL and HASP HL keys) >HASP-SL (SL-Legacy and SL-AdminMode keys) >HASP-SL-AdminMode (SL-AdminMode keys only) >HASP-SL-UserMode (SL-UserMode keys only) |
|
<hasp> |
<configuration> |
Type
of Sentinel protection key. This is used together with the >"hasphl,sentinelhl" - Sentinel HL (HASP configuration) key >"sentinelhl,driverless" - Sentinel HL (Driverless configuration) key >hasphl - HASP HL key >haspsl-adminmode - Sentinel SL AdminMode key >haspsl-usermode - Sentinel SL UserMode key >haspsl-legacy - Sentinel SL Legacy key |
|
<hasp> |
<attached> |
License must have been detached from an SL key. |
| <hasp> | <auto_attached> |
SL license must originate from an automatically-detached license. For details, see Examples for Cloud Licensing. |
| <hasp> | <parentid> |
SL license must originate from a parent with a specific Key ID. For details, see Examples for Cloud Licensing. |
| <hasp> | <familyid> |
SL license must originate from a specific family (that is, from a parent with a specific Key ID or from a license detached from that parent). For details, see Examples for Cloud Licensing. |
| <hasp> | <cloud_originated> |
Whether the license is a cloud-originated license. Possible values are: > For a cloud license: true >For a detached license from a cloud license: true >For an auto-detached license from a cloud license: true >For a license not meeting the above criteria: false For details, see Examples for Cloud Licensing. |
|
<feature> |
<id> Optional
Attribute: |
User-defined unique identifier for a specific Feature stored in a Sentinel protection key, with optional cmp attribute. The identifier is the number passed to the Login function to establish access to the Feature. |
| <feature> | <network_seats_to_consume> |
Number of network seats to consume. Note the following: >Admin Control Center will display a single Session with the specified number of seats. >Login fails if no single Feature within a given Product contains the required number of network seats. If a Feature with unlimited network seats is available, login succeeds. >For execution count licenses: One execution count is consumed for each login regardless of the number of network seats to be consumed. >When the count criteria is Per Login, the seats are consumed for each login scope API call. When the count criteria is Per Process or Per Station, the seats are not consumed more than once. |
| <feature> | <execution_count_to_consume> |
(Requires License Manager from Sentinel LDK 7.5 or later) Number of executions to consume for the single login. For more information, see Consuming Executions. This operation is supported by all license types with exception of the SL Legacy license. |
| <feature> | <execution_count_to_reserve> |
(Requires License Manager from Run-time Environment 8.41 or later) Number of executions to reserve for this login. If the license does not contain the number of executions specified, the status code HASP_FEATURE_INSUFFICIENT_EXECUTION_COUNT is returned. For more information, see Consuming Executions. This operation is supported by SL AdminMode keys and SL UserMode keys. HL keys and SL Legacy keys are not supported. |
| <feature> | <die_at_expiration> |
Whether the current session should be terminated if the expiration date of the current Feature has passed. Possible values are: 0 - Allow the session to continue (default). 1 - Terminate the session. For more information, see Checking the License Expiration Date of a Feature |
| <feature> | <occupy_cloud_session> |
For identity-based licenses: Whether an application that is using the license for a specific client identity should release the license if that license is requested for a session from a different machine. Possible values are: 0 - Do not release the license (default). Return the status code HASP_IDENTITY_SHARING_VIOLATION. 1 - Release the license for the other session. Return the status code HASP_CLOUD_SESSION_OCCUPIED_REMOTELY. (Note: The application must be modified to handle this return code correctly. For details, see: Releasing an Identity-Based License |
|
<session> |
<username> |
Name of the user currently logged into the computer that opened the session. |
|
<session> |
<userid> |
Unique ID number of the user. |
|
<session> |
<hostname> |
Name of the computer from which the session was opened. |
|
<session> |
<apiversion> |
Version of the API library used to open the session. |
|
<session> |
<handle> |
Handle of a login session. |