blstat

displays dynamic license information

Synopsis

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

Description

Displays license usage statistics for Platform License Scheduler.

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

Options (cluster mode and project mode)

-S

Displays information on the license servers 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 information about features configured in the FEATURE_LIST of specified feature groups. You can specify more than one feature group.

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

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

-lslic

Displays how many lsf_license_scheduler licenses have been checked out (TOTAL_CHECKOUT), the current total in use (PEAK_INUSE) and the Platform License Scheduler status (STATUS).

-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 license tokens. 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.

Options (project mode only)

-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.

  • FREE: Allocated to the cluster but not used.

  • AVAIL: If the feature is configured as dynamic, AVAIL=reserve + free – preempted. If it is not dynamic, AVAIL= in use + reserve + free – preempted.

  • NEED: Total number of tokens required by pending jobs (rusage).

-G

Displays dynamic hierarchical license information.

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

-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.

Output

Information is organized first by license feature, then by service domain. For each combination of license and service domain, Platform License Scheduler displays a line of summary information followed by rows of license project or cluster information.

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.

Cluster mode 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_TOKENS

The number of licenses from this service domain reserved for Platform License Scheduler jobs.

TOTAL_ALLOC

The number of licenses from this service domain allocated to clusters by Platform License Scheduler.

In most cases TOTAL_ALLOC is equal to TOTAL_USE, however, when there are licenses counted under OTHERS or when tokens are reclaimed, TOTAL_ALLOC may be less than TOTAL_TOKENS.

TOTAL_USE

The number of licenses in use by Platform License Scheduler projects, determined by totalling all INUSE, RESERVE, and OVER values.

OTHERS

The number of licenses checked out by applications outside of Platform License Scheduler.

Cluster output (cluster mode)

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

CLUSTER

The cluster name.

SHARE

The percentage of licenses assigned to the license project by the Platform License Scheduler administrator. This determines how many licenses the project is entitled to when there is competition for licenses. This information is static, and for a LAN service domain is always 100%.

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

ALLOC

The number of licenses currently allocated to the cluster by the bld.

INUSE

The number of licenses checked out by jobs in the cluster.

RESERVE

The number of licenses reserved in the service domain for jobs running in the cluster. This is determined as the difference between the job rusage and the number of checked out licenses attributed to the job by License Scheduler.

If the same license is available from both LAN and WAN service domains in cluster mode, Platform License Scheduler expects jobs to try to obtain the license from the LAN first. It is the responsibility of the administrator to ensure that applications bahave in this manner, using the FlexNet environment variable LM_LICENSE_FILE.

OVER

The amount of license checkouts exceeding rusage, summed over all jobs.

PEAK

The maximum of INUSE+RESERVE+OVER observed over the past 5 minutes (by default), The observation period is set by PEAK_INUSE_PERIOD in either the Parameters or Feature section.

PEAK is used in scheduling to estimate the cluster’s capacity to use licenses in this service domain.

BUFFER

The optional allocation buffer configured in the Feature section ALLOC_BUFFER parameter for WAN service domains. When defined, dynamic license token allocation is enabled.

FREE

The number of licenses the cluster has free. (The license tokens have been allocated to the license project by Platform 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 cluster.

Project mode 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 Platform License Scheduler projects. (Licenses in use have been checked out from the FlexNet license manager.)

TOTAL_RESERVE

The number of licenses reserved for Platform 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 Platform 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 Platform License Scheduler projects.

By default, in project mode these licenses are not being managed by Platform 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. (Project mode only.)

Workload output (both modes)

LSF_USE

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

LSF_DESERVE

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

LSF_FREE

The total number of free licenses available to Platform 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 (project mode)

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

PROJECT

The Platform License Scheduler project name.

SHARE

The percentage of licenses assigned to the license project by the Platform 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 project 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 Platform 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. Platform License Scheduler uses this value to schedule the tokens for each project.

Project group output (project mode)

SHARE_INFO_FOR

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

/root_name/member_name/...

PROJECT/GROUP

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

-lslic output

TOTAL_CHECKOUT

The total number of Platform License Scheduler licenses checked out.

PEAK_INUSE

The number of Platform License Scheduler licenses currently in use.

STATUS

Platform License Scheduler status.

Viewing license feature locality

In project mode, when LOCAL_TO is configured for a feature in lsf.licensescheduler, blstat shows the cluster locality information for the license features.

Sample output

For example, for a cluster mode feature:

blstat -t f1000
FEATURE: f1000           q 
 SERVICE_DOMAIN: Lan12
 TOTAL_TOKENS: 1000 TOTAL_ALLOC: 967  TOTAL_USE: 655  OTHERS: 25  
  CLUSTER     SHARE   ALLOC INUSE RESERVE OVER  PEAK  BUFFER FREE  DEMAND
  cluster1    66.7 %  647   0     655     0     658   100    0     7452 
  interactive 33.3 %  320   0     0       0     0     -      320   0    
 SERVICE_DOMAIN: Lan99
 TOTAL_TOKENS: 2000 TOTAL_ALLOC: 2000 TOTAL_USE: 0    OTHERS: 0   
  CLUSTER     SHARE   ALLOC INUSE RESERVE OVER  PEAK  BUFFER FREE  DEMAND
  cluster_linux 25.0 %  500   0     0       0     0     100    500   0    
  cluster_sparc 25.0 %  500   0     0       0     0     100    500   0    
  cluster_aix 25.0 %  500   0     0       0     0     -      500   0      
  cluster2 25.0 %  500   0     0       0     0     -      500   0 
For example, for a project mode feature 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