INCLUDE

This option applies to concurrent licenses held in license files and trusted storage.

INCLUDE feature[:keyword=value] type {name | group_name}

Includes a user or predefined group of users in the list of who is allowed to use licenses for this feature. Any user who is not in an INCLUDE or INCLUDEALL statement is not allowed to use that feature. EXCLUDE supersedes INCLUDE; conflicts between the EXCLUDE list and the INCLUDE list are resolved by the EXCLUDE taking precedence.

INCLUDE Terms

Term	Definition
feature	Name of the feature or package being affected.
keyword=value	Feature name modifier to denote a group of licenses. See Specifying Features for details. For examples of using the modifiers EXPDATE and ENTITLEMENT, see Using the EXPDATE Modifier and Using the ENTITLEMENT Modifier, respectively.
type	One of USER, HOST, DISPLAY, INTERNET, PROJECT, GROUP, or HOST_GROUP. See Specifying License Restrictions Using Type for details.
name	Name of an item of type type for which license usage is included.
group_name	Name of the group for which license usage is included. Group names are case sensitive.

To include user bob in the list of users able to use feature f1:

INCLUDE f1 USER bob

The include list is created from all the INCLUDEALL and INCLUDE lines in the options file.

Note:INCLUDE is required for USER_BASED or HOST_BASED features. The license administrator specifies which users are allowed to use the product, via INCLUDE, and the license limits the number of users that are INCLUDEd. In a USER_BASED or HOST_BASED license model, users (or predefined groups of users) who are not listed with the INCLUDE keyword cannot check out a license.

Using the EXPDATE Modifier

When using EXPDATE as a modifer for INCLUDE or EXCLUDE in the options file, add at least one pooling component keyword in the FEATURE or INCREMENT line.

Consider the following two INCREMENT lines

INCREMENT f1 demo 1.0 31-dec-2017 5 SIGN=”<...>”

INCREMENT f1 demo 1.0 30-nov-2017 5 SIGN=”<...>”

And the following options file line

INCLUDE f1:EXPDATE=30-nov-2017 USER bob

Because both instances of f1 are in the same license pool, the above options file line includes them both.

In order to include just the earlier expiring license, ensure each increment line is in a separate pool using a pooling keyword, such as VENDOR_STRING, for example:

INCREMENT f1 demo 1.0 31-dec-2017 5 VENDOR_STRING=”31-dec-2017” SIGN=”<...>”

INCREMENT f1 demo 1.0 30-nov-2017 5 VENDOR_STRING=”30-nov-2017” SIGN=”<...>”

With this example, the vendor daemon needs to be built with vendor variables ls_compare_vendor_on_increment = ls_compare_vendor_on_upgrade = 1 in order to turn on pooling with the vendor string. It should also be noted that feature version is a pooling keyword; the vendor string is needed here because these increment lines are for the same feature version.

For a list of pooling keywords, see {Hyperlink}FEATURE and INCREMENT Lines{Default ¹ Font} on page {Hyperlink}1{Default ¹ Font}.

Using the ENTITLEMENT Modifier

The ENTITLEMENT modifier enables the license administrator to differentiate between features that have identical names but belong to different products. In combination with the INCLUDE option, the license administrator can allow or restrict the concurrent checkout of a feature when the license originates from trusted storage. (For allowing/restricting the checkout of activatable features, use the option INCLUDE_ENTITLEMENT or EXCLUDE_ENTITLEMENT.)

To use the ENTITLEMENT modifier, you must set the variable ls_entitlement_based_pooling in lsvendor.c to 1 (default). This enables pooling based on the entitlement ID. For more information, see the Programming Reference for License File–Based Licensing, chapter Customizing the Vendor Daemon.

Example

Consider the following scenario. Licenses are available for the following features—which have identical names—of two products:

•

Product EZCALC-N:

•

Entitlement ID: ENTL-ADD-1

•

Hybrid licenses: 3

•

Feature(s):  INCREMENT ADD demo 1.0 permanent 1 SIGN="XXX"            INCREMENT SUBTRACT demo 1.0 permanent 1 SIGN="XXX"            INCREMENT MULTIPLY demo 1.0 permanent 1 SIGN="XXX"

•

Product EZCALC-S:

•

Entitlement ID: ENTL-ADD-2

•

Hybrid licenses: 3

•

Feature(s):  INCREMENT ADD demo 1.0 permanent 1 SIGN="XXX"            INCREMENT SUBTRACT demo 1.0 permanent 1 SIGN="XXX"            INCREMENT MULTIPLY demo 1.0 permanent 1 SIGN="XXX"

The license administrator wants to allow/restrict access as follows:

•

Only the user Joanna should be allowed to check out feature ADD from EZCALC-N (entitlement ID ENTL-ADD-1).

•

Other users should be allowed to check out features SUBTRACT and MULTIPLY from EZCALC-N (entitlement ID ENTL-ADD-1), but not feature ADD.

•

There should be no restrictions to checking out features from EZCALC-S.

To restrict access as outlined, the license administrator adds the following line to the options file:

INCLUDE ADD:ENTITLEMENT=ENTL-ADD-1 USER Joanna