featureInfo—Feature Information 
NOTE Since v9.2.0, the macro for obtaining Feature Information is SNTL_QUERY_FEATURE_INFO_VERSION(v). Here, v represents the query version. Specify version under the double quotes, such as "1.0". The earlier macro SNTL_QUERY_FEATURE_INFO is deprecated hereafter.
NOTE From RMS v9.5, query version 1.1 has been introduced to support license hard limit up to 4,294,967,294. This is applicable to license version 20 and above.
Query
<?xml version="1.0" encoding="UTF-8"?>
<sentinelQuery query="featureInfo" version="1.1"/>Scope
<?xml version="1.0" encoding="UTF-8"?>
<sentinelScope>
<feature index="0">
<name>F1</name>
<version>V1</version>
</feature>
</sentinelScope>| Element | Description |
|
feature index |
Used to specify a particular client. |
|
name |
The feature name identifier for the license code. |
|
version |
Version of the feature. |
Description
Retrieves feature information based on the scope XML.
>Both the feature name and feature version are mandatory if feature name and feature version are included in the license. If only feature name is included, then only feature name is necessary.
>If feature version is included in the license, then specify it along with feature name under scope to obtain feature information. Otherwise, it can be skipped.
>Feature index alone is sufficient to obtain a feature's information. Otherwise, you can specify feature name and/or feature version under scope xml. Also, when all the three elements (feature index, feature name, and feature version) are passed, feature index is ignored.
Obtaining a List of Features
If information about all licensed features is desired, index should be used in a loop. The status code, SNTL_NO_MORE_FEATURES, is returned when the query runs out of features to describe.
Output
<?xml version="1.0" encoding="UTF-8"?>
<sentinelInfo>
<feature>
<featureName>F1</featureName>
<featureVersion>V1</featureVersion>
<licType>0</licType>
<trialDaysCount>0</trialDaysCount>
<numLicenses>5</numLicenses>
<totalResv>0</totalResv>
<licFromResv>0</licFromResv>
<qlicFromResv>0</qlicFromResv>
<licFromFreePool>0</licFromFreePool>
<qlicFromFreePool>0</qlicFromFreePool>
<isNodeLocked>2</isNodeLocked>
<sharingCrit>0</sharingCrit>
<lockingCrit>0</lockingCrit>
<holdingCrit>0</holdingCrit>
<numSubnets>0</numSubnets>
<siteLicenseInfo>*.*.*.*</siteLicenseInfo>
<holdTime>0</holdTime>
<vendorInfo>string</vendorInfo>
<clLockInfo>string</clLockInfo>
<keyLifeTime>300</keyLifeTime>
<sharingLimit>0</sharingLimit>
<softNumLicenses>2097150</softNumLicenses>
<isStandalone>0</isStandalone>
<checkTimeTamper>0</checkTimeTamper>
<isAdditive>1</isAdditive>
<isRedundant>0</isRedundant>
<majorityRule>0</majorityRule>
<numServers>1</numServers>
<isCommuter>0</isCommuter>
<logEncryptLevel>1</logEncryptLevel>
<avgQueueTime>-1</avgQueueTime>
<queueLength>0</queueLength>
<totLicReqd>0</totLicReqd>
<commutedKeys>0</commutedKeys>
<commuterKeysLeft>0</commuterKeysLeft>
<serverLockingInfo>$$$0$$$</serverLockingInfo>
<commuterMaxCheckoutDays>0</commuterMaxCheckoutDays>
<commutedFromServer>string</commutedFromServer>
<gracePeriodFlag>0</gracePeriodFlag>
<gracePeriodCalendarDays>0</gracePeriodCalendarDays>
<gracePeriodElapsedHours>0</gracePeriodElapsedHours>
<localRequestLockCritFlag>0</localRequestLockCritFlag>
<localRequestLockCritRequired>4</localRequestLockCritRequired>
<localRequestLockCritFloat>0</localRequestLockCritFloat>
<localRequestLockCritMinNum>1</localRequestLockCritMinNum>
<isGraceLicense>1</isGraceLicense>
<licenseVersion>152043520</licenseVersion>
<plainVendorInfo>string</plainVendorInfo>
<trialElapsedHours>0</trialElapsedHours>
<trialExecutionCount>0</trialExecutionCount>
<trialCalendarPeriodLeft>0</trialCalendarPeriodLeft>
<trialElapsedPeriodLeft>0</trialElapsedPeriodLeft>
<trialExecutionsLeft>0</trialExecutionsLeft>
<trialCurrentStatus>0</trialCurrentStatus>
<vmDetection>0</vmDetection>
<birthTime>1451644800</birthTime>
<deathTime>1483210800</deathTime>
<eid>string</eid>
<pid>0</pid>
<fid>0</fid>
<aid>string</aid>
<cloudUsageFlag>0</cloudUsageFlag>
<licSource>0</licSource>
<trialDays>0</trialDays>
<trialSeconds>0</trialSeconds>
<trialDaysLeft>0</trialDaysLeft>
<trialSecondsLeft>0</trialSecondsLeft>
<activationBirthTime>0</activationBirthTime>
<activationExpiryTime>0</activationExpiryTime>
<userAccountLimit>0</userAccountLimit>
</feature>
</sentinelInfo>| Element | Description | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Feature Information | |||||||||||||||||||||||||||
| featureName | The name of the feature. | ||||||||||||||||||||||||||
| featureVersion | The version of the feature. | ||||||||||||||||||||||||||
| License Type Information | |||||||||||||||||||||||||||
| licType |
Contains any of the following information regarding the license type: 0 - Normal 1 - Trial |
||||||||||||||||||||||||||
| isStandalone |
Contains any of the following information regarding the license type: 0 - Network license 1- Standalone license 2 - Repository license 3 -Cloud LM license |
||||||||||||||||||||||||||
| isAdditive |
Contains any of the following information regarding the license type: 0 - Additive license 1 - Exclusive license 2 - Aggregate license |
||||||||||||||||||||||||||
| Number of Licenses Information | |||||||||||||||||||||||||||
| numLicenses | Total hard limit for this feature. From RMS 9.5 onwards, query v1.1 supports license hard limit up to 4,294,967,294. This is applicable to license version 20 (or above). | ||||||||||||||||||||||||||
| softNumLicenses | Total soft limit (for alerts) on the number of concurrent users of this feature. From RMS 9.5 onwards, query v1.1 supports soft limit up to 4,294,967,294. This is applicable to license version 20 (or above). | ||||||||||||||||||||||||||
| userAccountLimit |
Applicable to SCL Add-on for RMS only for Connected (Cloud LM) mode with version 23 and later licenses. Stores the maximum number of named users that can consume this license. |
||||||||||||||||||||||||||
| License Lifetime Information | |||||||||||||||||||||||||||
| keyLifeTime | Total license lifetime (in seconds) for this feature . | ||||||||||||||||||||||||||
| License Locking Information | |||||||||||||||||||||||||||
| isNodeLocked |
Contains any of the following value regarding the locking scheme of the feature: 0 - Client-server-locked 1 - Server-locked 2 - Unlocked 3 - Client-locked |
||||||||||||||||||||||||||
| lockingCrit |
Contains the server-locking criteria details only. It can be any of the following values (Or and ORed value representing any of the criteria combinations):
|
||||||||||||||||||||||||||
| serverLockingInfo |
Contains the locking information (lock selector and locking code) of the License Manager. If multiple locking codes of a License Manager are specified, the values (referred to as primary code and secondary code) are separated using $$$.
Example: <isNodeLocked>1</isNodeLocked> <lockingCrit>8204</lockingCrit> <serverLockingInfo>200C-*1HWSP9RYD5EXMJ8$$$200C-*15A63TVMEL3H3QX$$$</serverLockingInfo>
Here: >isNodeLocked value 1 means the license is server-locked. >lockingCrit value 8204 means that the locking code is a combination of disk ID, Host Name, and UUID. >In the serverLockingInfo, •200C denotes the same information as the lockingCrit value (that license is locked to disk ID, Host Name, and UUID). •*1HWSP9RYD5EXMJ8 and *15A63TVMEL3H3QX are the primary code and secondary code, respectively. |
||||||||||||||||||||||||||
| clLockInfo |
Contains the locking information (lock selector and locking code) of all the clients specified in the license. The locking information of each client is separated using a space. Licenses-per-node restrictions, if specified, are also returned in parentheses against each client’s locking information. Example: <isNodeLocked>3</isNodeLocked> <lockingCrit>0</lockingCrit> <serverLockingInfo>$$$0$$$</serverLockingInfo> <clLockInfo>800-*136J2SBQPJ8FYD9 C-*1M36NDHU4F4PPHL(1#)</clLockInfo>
Here: >isNodeLocked value 3 means the license is client-locked. >lockingCrit value 0 means that the license is not locked to any criteria on the License Manager. >serverLockingInfo value 0 means that the locking information of the License Manager is not obtained. >In the clLockInfo, •800 denotes that license is locked to client 1 using the hard disk serial number and *136J2SBQPJ8FYD9 is the corresponding locking code. •C denotes that license is locked to client 2 using the disk ID and host name, and *1M36NDHU4F4PPHL is the locking code. 1# denotes the licenses-per-node restrictions meaning that this client can run only 1 instance at a time. |
||||||||||||||||||||||||||
| License Sharing Information | |||||||||||||||||||||||||||
| sharingCrit |
Contains the license sharing criteria, which can be one of the following values: 0 - No sharing 1 - License sharing on the basis of a common user name. 2 - License sharing on the basis of the system where the licensed feature is being run. 3 - License sharing on the basis of the X-display ID of a UNIX system. 4 - License sharing on the basis of a custom license sharing mechanism you implemented, which is set using the SNTL_ATTR_APPCONTEXT_VENDOR_DEFINED_SHARINGID application context attribute. |
||||||||||||||||||||||||||
| sharingLimit | The limit on how many copies of the licensed application can share the same license. | ||||||||||||||||||||||||||
| License Holding Information | |||||||||||||||||||||||||||
| holdingCrit |
Contains the license holding criteria, which can be one of the following values: 0 - No held licenses. 1 - The client application specifies the hold time. 2 - The license code specifies the hold time. |
||||||||||||||||||||||||||
| holdTime | The hold time specified for licenses issued for this feature. | ||||||||||||||||||||||||||
| Site Information | |||||||||||||||||||||||||||
| numSubnets | The number of subnets provided for the site. | ||||||||||||||||||||||||||
| siteLicenseInfo | A space-separated list of subnet wildcard specifications. | ||||||||||||||||||||||||||
| Time Tampering Information | |||||||||||||||||||||||||||
| checkTimeTamper |
Contains the clock tampering detection policy which can be one of the following values: 0 - Detection of time tampering is allowed 1 - Time tampering is not detected |
||||||||||||||||||||||||||
| Group Reservation Information | |||||||||||||||||||||||||||
| totalResv | The number of licenses reserved using group reservations. From RMS 9.5 onwards, query v1.1 supports license hard limit up to 4,294,967,294. This is applicable to license version 20 (or above). | ||||||||||||||||||||||||||
| licFromResv | The number of reserved licenses issued to clients. From RMS 9.5 onwards, query v1.1 supports license hard limit up to 4,294,967,294. This is applicable to license version 20 (or above). | ||||||||||||||||||||||||||
| qlicFromResv | The number of reserved licenses issued to queued clients. | ||||||||||||||||||||||||||
| licFromFreePool | The number of unreserved licenses issued to clients. From RMS 9.5 onwards, query v1.1 supports license hard limit up to 4,294,967,294. This is applicable to license version 20 (or above). | ||||||||||||||||||||||||||
| qlicFromFreePool | The number of unreserved licenses issued to queued clients. | ||||||||||||||||||||||||||
| License Manager Redundancy Information | |||||||||||||||||||||||||||
| isRedundant |
Contains any of the following values about the License Manager redundancy setting: 0 - The license is non-redundant 1 - The license is redundant |
||||||||||||||||||||||||||
| majorityRule |
Contains any of the following values about the applicability of the majority rule (on or off): 0 - No majority 1 - Majority |
||||||||||||||||||||||||||
| numServers |
The number of redundant License Managers forming the pool. |
||||||||||||||||||||||||||
| Commuter Information | |||||||||||||||||||||||||||
| isCommuter |
Whether license commute action is allowed or not. Contains any of the following value: 0 - The commute action is not allowed. 1 - The commute action is allowed. 2 - The license is commuted for use in standalone mode. |
||||||||||||||||||||||||||
| commuterMaxCheckoutDays | The maximum number of days a commuter license can be checked out for. | ||||||||||||||||||||||||||
| commutedFromServer |
The License Manager from which the commuted license is obtained. To obtain information about the commuter license installed on the local system, set no-net as the contact server. |
||||||||||||||||||||||||||
| commutedKeys | The number of commuter keys that have been checked out. From RMS 9.5 onwards, query v1.1 supports license hard limit up to 4,294,967,294. This is applicable to license version 20 (or above). | ||||||||||||||||||||||||||
| commuterKeysLeft | The number of commuter keys left. From RMS 9.5 onwards, query v1.1 supports license hard limit up to 4,294,967,294. This is applicable to license version 20 (or above). | ||||||||||||||||||||||||||
| Usage Log Information | |||||||||||||||||||||||||||
| logEncryptLevel |
Contains any of the following values about the encryption level in the network license for the License Manager’s usage log file: 0 - The system administrator is allowed to set the encryption level. 1 - Transaction data will be logged for this license code with no encryption. 2 - Transaction data will be readable by the customer, but tampering with or deleting an entry can be detected. 3 - Transaction data will be readable by the customer except for license usage data (which will be encrypted), but tampering with or deleting an entry can be detected. 4 - All transaction data for the license code will be encrypted. Tampering with or deleting an entry will not be prevented, but can be detected. |
||||||||||||||||||||||||||
| License Queuing Information | |||||||||||||||||||||||||||
| avgQueueTime | Average time the past or present clients are in the queue. (Not implemented.) | ||||||||||||||||||||||||||
| queueLength | Length of the queue. | ||||||||||||||||||||||||||
| totLicReqd | Required number of licenses for all queued clients. | ||||||||||||||||||||||||||
| Local License Locking-Related Information* | |||||||||||||||||||||||||||
| localRequestLockCritFlag |
Contains the flag value that defines whether the local license request locking criteria is used or not for the commuter, repository, and grace license: 0 - Local license request criteria is not used 1 - Local license request criteria is used |
||||||||||||||||||||||||||
| localRequestLockCritRequired | The ORed decimal value of necessary criteria that must be met for making the licenses available to a local client. | ||||||||||||||||||||||||||
| localRequestLockCritFloat | The ORed decimal value of desired criteria that must be met for making the licenses available to a local client. | ||||||||||||||||||||||||||
| localRequestLockCritMinNum | The minimum number of locking license criteria that must be met for making the licenses available to a local client. | ||||||||||||||||||||||||||
| Grace Information | |||||||||||||||||||||||||||
| gracePeriodFlag |
Contains the flag value that defines whether grace period for a license is available or not: 0 - When the grace period is not allowed 1 - When the standard grace period is provided |
||||||||||||||||||||||||||
| gracePeriodCalendarDays | The number of days the grace period will last for. | ||||||||||||||||||||||||||
| gracePeriodElapsedHours | The number of hours the grace period will last for. | ||||||||||||||||||||||||||
| isGraceLicense |
Contains the value that determines the current state of the license, whether the license is being used in network or on a local system with grace period enabled: 0 - When the license is on the local system with grace period enabled. 1 - When the license is a network license. |
||||||||||||||||||||||||||
| Vendor Data | |||||||||||||||||||||||||||
| vendorInfo | The vendor-defined information string. | ||||||||||||||||||||||||||
| plainVendorInfo | The public vendor information included in the license. | ||||||||||||||||||||||||||
| License Version Information | |||||||||||||||||||||||||||
| licenseVersion |
Contains the Sentinel RMS license version. The possible values are: >4294967295 - License version not defined >0 - License version earlier than 7.0 >117440512 - RMS SDK v7.0 license - License v7 >117637120 - RMS SDK v7.3.0 license - License v8 >117637121 - RMS SDK v7.3.0.1 license - License v9 >134217728 - RMS SDK v8.0.0 license - License v10 >135266304 - RMS SDK v8.1.0 license - License v11 >136511488 - RMS SDK v8.2.3 license - License v12 >138412032 - RMS SDK v8.4.0 license - License v13 >139460608 - RMS SDK v8.5.0 license - License v14 >140509184 - RMS SDK v8.6.0 license - License v15 >150994944 - RMS SDK v9.0.0 license - License v16 >152043520 - RMS SDK v9.1.0 license - License v17 >153092096 - RMS SDK v9.2.0 license - License v18 >155254784 - RMS SDK v9.4.1 license - License v19 >156237824 - RMS SDK v9.5.0 license - License v20 > 158334976 - RMS SDK v9.7.0 license - License v21 > 268435456 - RMS SDK v10.0.0 license - License v22 >270532608 - RMS SDK v10.2.0 license - License v23 |
||||||||||||||||||||||||||
| License Validity Information | |||||||||||||||||||||||||||
| birthTime |
>For On-premises mode, this is the license start date in time_t. >For Lease mode, this represents the start time of the lease period (and not of the license). |
||||||||||||||||||||||||||
| deathTime |
>For On-premises mode, this is the license expiration date in time_t. >For Lease mode, this represents the expiration time of the lease period (and not of the license). |
||||||||||||||||||||||||||
| activationBirthTime |
activationBirthTime and activationExpiryTime denote the duration of the complete license. These do not denote the lease time period (lease time period is denoted by attributes birthTime and deathTime). For example, activationBirthTime (2021-06-16T11:13:00Z) and activationExpiryTime (2022-06-15T11:13:00Z) denote the license duration of one year. The lease period duration—denoted by the birthTime (2021-06-17T07:52:00Z) and deathTime (2021-09-15T08:07:00Z values—is three months. The activationBirthTime and activationExpiryTime attributes are filled only for lease licenses. These attributes are applicable for v17 and above licenses. Currently, for on-premises modes, licenses generated using Sentinel EMS, activationBirthTime and activationExpiryTime values are not filled. |
||||||||||||||||||||||||||
| activationExpiryTime | |||||||||||||||||||||||||||
| Trial License-Related Information | |||||||||||||||||||||||||||
| trialDays | The number of trial days set. Valid only if trial days is enforced. | ||||||||||||||||||||||||||
| trialSeconds | The number of trial hours set, converted into seconds. Valid only if trial hours is enforced. | ||||||||||||||||||||||||||
| trialDaysLeft | The remaining number of trial days. Valid only if trial days is enforced. | ||||||||||||||||||||||||||
| trialSecondsLeft | The remaining number of trial hours (in seconds). Valid only if trial hours is enforced. | ||||||||||||||||||||||||||
| trialCurrentStatus |
Contains any of the following values about the status of the trial license at the given time: >0 - The license has never been requested and therefore the trial period has not yet begun. >1 - License is requested at least once, but some trial usage is still left. >2 - Usage limit of trial license is exhausted. |
||||||||||||||||||||||||||
| trialDaysCount |
Obsolete. Instead see "trialDays." |
||||||||||||||||||||||||||
| trialElapsedHours | Obsolete. Instead see "trialSeconds." | ||||||||||||||||||||||||||
| trialCalendarPeriodLeft | Obsolete. Instead see "trialDaysLeft." | ||||||||||||||||||||||||||
| trialElapsedPeriodLeft | Obsolete. Instead see "trialSecondsLeft." | ||||||||||||||||||||||||||
| trialExecutionCount | The number of executions count set. However, this is not supported as of now. | ||||||||||||||||||||||||||
| trialExecutionsLeft | The remaining number of executions. However, this is not supported as of now. | ||||||||||||||||||||||||||
| VM-Related Information | |||||||||||||||||||||||||||
| vmDetection |
Contains any of the following values about the VM detection policy: 0 - license requests are allowed. 1- license requests are not allowed. |
||||||||||||||||||||||||||
| Sentinel EMS-Related Information | |||||||||||||||||||||||||||
| eid | Entitlement ID (EID) used to identify entitlements. | ||||||||||||||||||||||||||
| fid | Feature ID. This field is applicable to the Lease mode. | ||||||||||||||||||||||||||
|
pid |
Reserved for future use. | ||||||||||||||||||||||||||
| aid |
Authorization ID. It is a unique identifier auto-generated for each licensed feature in an entitlement. It is used for tracking the usage associated with a feature-entitlement combination. This field is applicable to v16 (and later) Sentinel RMS licenses activated using Sentinel EMS. NOTE This field is not the same as the Activation ID of Sentinel EMS. The field may be renamed in the upcoming releases. |
||||||||||||||||||||||||||
| cloudUsageFlag |
This field is applicable for all deployment modes. It decides whether the Cloud-based usage data is being generated or not. The possible values are: >0 - The Cloud-based usage data is not generated. >1 - The Cloud-based usage data is being generated. |
||||||||||||||||||||||||||
| licSource |
This field decides whether the license is applicable to the Lease mode or not. > 1 - License is supported for the Lease mode. >0 - License is not supported for the Lease mode. |
||||||||||||||||||||||||||
* The locking criteria for obtaining licenses on a local system, for example the grace, repository, and commuter licenses.
NOTE To obtain information about the commuter license installed on the local system, set no-net as the contact server.