License Manager Redundancy API

The License Manager redundancy allows the total number of licenses to remain available to the enterprise even if one or more License Managers fail. If a License Manager fails, the license tokens it is serving will be taken over by the next-available License Manager. For information on setting up and using redundant License Managers, refer to the Sentinel RMS SDK Developer Guide and the Sentinel RMS SDK System Administrator Guide.

NOTE   The following API function have been deprecated since the 8.1.x release: VLSaddFeatureExt, VLSaddFeatureToFileExt, VLSchangeDistbCrit, and VLSsetBorrowingStatus. These functions do not perform any operation and return the VLS_NOT_SUPPORTED error code.

Given below is the list of the API functions:

Function Description

VLSaddFeature

Dynamically adds licensing information about a feature into the License Manager’s internal tables. If licensing information for this feature and version already exists in the License Manager’s tables, it may be overwritten with the new information.

Feature is not permanently added to the License Manager, but only until the License Manager is shut down and restarted.

VLSaddFeatureToFile

Dynamically adds licensing information to the License Manager’s internal tables and normal or redundant license file.

VLSaddServerToPool

Sends a request to add a new License Manager into the pool. This API will actually modify the license redundant file in order to add the given License Manager to the pool.

VLSdelServerFromPool

Removes a License Manager’s name from the pool. This API will actually modify the license redundant file in order to delete the given License Manager from the pool.

VLSdiscoverExt

Returns the License Manager characteristic information, which has the keys for a particular specified feature and version. The client can decide a License Manager preference based on some criteria.

VLSdiscoverExt2 Returns the License Manager characteristic information, which has the keys for a particular specified feature and version. The client can decide a License Manager preference based on some criteria. Introduced in RMS v9.5, this API supports license hard limit up to 4,294,967,294.

VLSgetDistbCrit

Returns the current token distribution status for the given license feature and version.

VLSgetDistbCritToFile

Requests the License Manager provide current token distribution status for the given license feature and version or for all features or versions (wild card characters are acceptable). Writes the distribution to a file.

VLSgetLeaderServerName

Returns the current leader License Manager’s name by contacting any License Manager. So a License Manager’s name must be set before a call is made to this function.

VLSgetLicSharingServerList

Returns the names of the License Managers which are sharing tokens for a given feature name and version. The server_name_list will contain License Manager names (hostNames or IP addresses).

VLSgetPoolServerList

Returns a list of redundant License Managers and their status.

VLSsetServerLogState

Turns logging on/off for the given event.