blstat

displays dynamic license information

Synopsis

blstat [-a] [-c token_name] [-G] [-s] [-S] [-D service_domain_name | "service_domain_name ..."] [-Lp ls_project_name | "ls_project_name ..."] [-P][-t token_name | "token_name ..."] [-o alpha | total | avail] [-g "feature_group ..."]
blstat [ -h | -V]

Description

Displays license usage statistics.

By default, shows information about all licenses and all clusters.

Options

-a

Displays each project group’s accumulated value of licenses. The license token dispatching order is based on the sort order, which is based on the scaled accumulate value of each project. The lower the value, the sooner the license token is dispatched to that project.

-c token_name

Displays cross cluster information for tokens, sorted by the value of SCALED_ACUM. The first cluster listed receives tokens first.

Information displayed includes token usage, reserved tokens, free tokens, demand for tokens, accumulated value of tokens, and scaled accumulate value of tokens in each cluster.

-G

Displays dynamic hierarchical license information.

blstat -G also works with the -t option to only display hierarchical information for the specified feature names.

-S

Displays information on the license server associated with license features.

-s

Displays license usage of the LSF and non-LSF workloads. Workload distributions are defined by WORKLOAD_DISTRIBUTION in lsf.licensescheduler. If there are any distribution policy violations, blstat marks these with an asterisk (*) at the beginning of the line.

-D service_domain_name | "service_domain_name ..."

Only shows information about specified service domains. Use spaces to separate multiple names, and enclose them in quotation marks.

-g feature_group ...

When FEATURE_GROUP is configured for a group of license features in lsf.licensescheduler, shows only information about the features configured in the FEATURE_LIST of specified feature groups. You can specify more than one feature group at a time.

When you specify feature names with -t, features in the FEATURE_LIST defined by -t and feature groups are both displayed.

Feature groups listed with -g but not defined in lsf.licensescheduler are ignored.

-Lp ls_project_name | "ls_project_name ..."

Shows project description for specified projects (non-hierarchical). Use spaces to separate multiple names and enclose them in quotation marks.

-o alpha | total | avail

Sorts license feature information alphabetically, by total licenses, or by available licenses.

  • alpha: Features are listed in descending alphabetical order.

  • total: Features are sorted by the descending order of the sum of licenses that are allocated to LSF workload from all the service domains configured to supply licenses to the feature. Licenses borrowed by non-LSF workload are not included in this amount.

  • avail: Features are sorted by descending order of licenses available, including free tokens.

-P

Displays percentage values for INUSE and RESERVE. The percentage value represents the number of tokens this project has used and reserved compared to total number of licenses.

-t token_name | "token_name ..."

Only shows information about specified licenses. Use spaces to separate multiple names, and enclose them in quotation marks.

-h

Prints command usage to stderr and exits.

-V

Prints the release version to stderr and exits.

Output

Information is organized first by license feature, then by service domain. For each combination of license and service domain, License Scheduler displays a line of summary information followed by rows of license project information (one row for each license project configured to use the license).

In each group of statistics, numbers and percentages refer only to licenses of the specified license feature that can be checked out from FLEXnet license server hosts in the specified service domain.

Summary output

FEATURE

The license name. (This appears only once for each feature.)

SERVICE_DOMAIN

The name of the service domain that provided the license.

TOTAL_INUSE

The number of licenses in use by License Scheduler projects. (Licenses in use have been checked out from the FLEXnet license manager.)

TOTAL_RESERVE

The number of licenses reserved for License Scheduler projects. (Licenses that are reserved and have not been checked out from the FLEXnet license manager.)

TOTAL_FREE

The number of free licenses that are available to License Scheduler projects. (Licenses that are not reserved or in use.)

OTHERS

The number of licenses checked out by users who are not submitting their jobs to License Scheduler projects.

By default, these licenses are not being managed by License Scheduler policies.

To enforce license distribution policies for these license features, configure ENABLE_DYNAMIC_RUSAGE=Y in the feature section for those features in lsf.licensescheduler.

Workload output

LSF_USE

The total number of licenses in use by License Scheduler projects in the LSF workload.

LSF_DESERVE

The total number of licenses assigned to License Scheduler projects in the LSF workload.

LSF_FREE

The total number of free licenses available to License Scheduler projects in the LSF workload.

NON_LSF_USE

The total number of licenses in use by projects in the non-LSF workload.

NON_LSF_DESERVE

The total number of licenses assigned to projects in the non-LSF workload.

NON_LSF_FREE

The total number of free licenses available to projects in the non-LSF workload.

Project output

For each project that is configured to use the license, blstat displays the following information.

PROJECT

The License Scheduler project name.

SHARE

The percentage of licenses assigned to the license project by the License Scheduler administrator. This determines how many licenses the project is entitled to when there is competition for licenses. This information is static.

The percentage is calculated to one decimal place using the share assignment in lsf.licensescheduler.

LIMITS

The maximum number of licenses that the hierarchical group member project can use at any one time.

OWN

Numeric value indicating the number of tokens owned by each project.

INUSE

The number of licenses in use by the license project. (Licenses in use have been checked out from the FLEXnet license manager.)

RESERVE

The number of licenses reserved for the license project. (The corresponding job has started to run, but has not yet checked out its license from the FLEXnet license manager.)

FREE

The number of licenses the license project has free. (The license tokens have been allocated to the license project by License Scheduler, but the licenses are not reserved and have not yet been checked out from the FLEXnet license manager.)

DEMAND

Numeric value indicating the number of tokens required by each project.

NON_SHARED

The number of non-shared licenses belonging to the license project. (The license tokens allocated to non-shared distribution are scheduled before the tokens allocated to shared distribution.)

DESCRIPTION

Description of the project.

ACUM_USE

The number of tokens accumulated by each consumer at runtime. It is the number of licenses assigned to a given consumer for a specific feature.

SCALED_ACUM

The number of tokens accumulated by each consumer at runtime divided by the SHARE value. License Scheduler uses this value to schedule the tokens for each project.

Hierarchical output

SHARE_INFO_FOR

The root member and name of the hierarchical group. The project information displayed after this title shows the information specific to this particular hierarchical group. If this root member is itself a member of another hierarchical group, the relationship is displayed as follows:

/root_name/member_name/...

PROJECT/GROUP

The members of the hierarchical group, listed by its group or project name.

Viewing license feature locality

When LOCAL_TO is configured for a feature in lsf.licensescheduler, blstat shows the cluster locality information for the license features. For example, with a group distribution configuration blstat shows the locality of the hspice feature configured for various sites:
blstat
FEATURE: hspice
 SERVICE_DOMAIN: SD3 SD4
 TOTAL_INUSE: 0    TOTAL_RESERVE: 0    TOTAL_FREE: 22   OTHERS: 0
  PROJECT                 SHARE   OWN  INUSE RESERVE FREE   DEMAND 
  Lp1                     50.0 %   3     1    0        0     11
  Lp2                     50.0 %   1     3    0        0     11
FEATURE: hspice@clusterA
 SERVICE_DOMAIN: SD1
 TOTAL_INUSE: 0    TOTAL_RESERVE: 0    TOTAL_FREE: 25   OTHERS: 0
  PROJECT                 SHARE   OWN  INUSE RESERVE FREE   DEMAND 
  Lp1                     50.0 %   4     0    0      12       3
  Lp2                     50.0 %   5     0    0      13       1
FEATURE: hspice@siteB
 SERVICE_DOMAIN: SD2
 TOTAL_INUSE: 0    TOTAL_RESERVE: 0    TOTAL_FREE: 65   OTHERS: 0
  PROJECT                 SHARE   OWN  INUSE RESERVE FREE   DEMAND 
  Lp1                     50.0 %   4     0    0      32       2
  Lp2                     50.0 %   5     0    0      33       6

See also

blhosts, blinfo