lic.LicCheckThreshold

This job checks for one module whether the usage of its license has reached the warning threshold and returns the current and the maximum usage count.

The vendor does not document this job. The description is based on measurements against enaio® server 12.0. The job also exists on 10.10 (krn.EnumJobs lists it); only a license of type C with no seat in use was checked there.

1. Input Parameters

Name Type Required Description

Name	Type	Required	Description
`Flags`	INT	Yes	Pass `0`. Whether the parameter is actually required was not tested.
`Modules`	STRING	Yes	Short label of one module. Unlike lic.CheckLicense, the job treats a space-separated list as one single name.

Flags

INT

Yes

Pass 0. Whether the parameter is actually required was not tested.

Modules

STRING

Yes

Short label of one module. Unlike lic.CheckLicense, the job treats a space-separated list as one single name.

Without Modules, the call is rejected with -1043332470 ("A required parameter was not specified: Modules.").

2. Output Parameters

Name Type Dependency Description

Name	Type	Dependency	Description
`Modules`	STRING	only for a known module label	`<label>:<current>:<max>`, e.g. `LIS:0:5`. Empty if the module has no license entry.
`Exceeded`	STRING	only for a known module label	Label of the module if its usage has reached the warning threshold; empty otherwise.

Modules

STRING

only for a known module label

<label>:<current>:<max>, e.g. LIS:0:5. Empty if the module has no license entry.

Exceeded

STRING

only for a known module label

Label of the module if its usage has reached the warning threshold; empty otherwise.

3. Return Value

(INT): 0 = Job successful, otherwise error code.

The job also returns 0 for an unknown module label and when the warning threshold is reached. The finding is carried by the output parameters and the error stack (see Diagnostic Entries with Return Value 0).

4. Observed Behaviour

Measured against enaio® server 12.0; the first row also on a second 12.0 installation and on 10.10:

Module Output Error stack

Module	Output	Error stack
License of type `C`, no seat in use	`Modules` = `LIS:0:5` (12.0) or `LIS:0:10` (10.10), `Exceeded` empty	no entries
License of type `N` with 1 seat, in use	`Modules` = `ASS:1:1`, `Exceeded` = `ASS`	`-2115959887` `Threshold of 90% reached for module ASS, current count 1, max count 1.` `-2115960338` `No e-mail can be sent to the administrator, because this feature is switched off in the configuration.`
Module without a license entry	`Modules` and `Exceeded` empty	no entries
Unknown label	no output parameters	`1105265171` `Requested resource <X> is unknown.`

License of type C, no seat in use

Modules = LIS:0:5 (12.0) or LIS:0:10 (10.10), Exceeded empty

no entries

License of type N with 1 seat, in use

Modules = ASS:1:1, Exceeded = ASS

-2115959887 Threshold of 90% reached for module ASS, current count 1, max count 1.
-2115960338 No e-mail can be sent to the administrator, because this feature is switched off in the configuration.

Module without a license entry

Modules and Exceeded empty

no entries

Unknown label

no output parameters

1105265171 Requested resource <X> is unknown.

In the measurement the warning threshold was 90 % of the maximum count. Whether it is configurable is not known.

When a module reaches the warning threshold, the server tries to notify the administrator by e-mail. On the measured system this feature was switched off (-2115960338). When it is switched on, the call has a side effect: a call for a fully used module can trigger an e-mail.

The job is called during normal operation: the job statistics of krn.NameSpaceGetJobsInfo showed 213 calls on the measured system. Whether the server itself or the clients call it has not been examined.