Knowledge Center         Contents    Previous  Next    
Platform Computing Corp.

lsb_userinfo()

Returns the maximum number of job slots that a user can use simultaneously on any host and in the whole local LSF cluster.

DESCRIPTION

lsb_userinfo() gets the maximum number of job slots that a user can use simultaneously on any host and in the whole local LSF cluster, as well as the current number of job slots used by running and suspended jobs or reserved for pending jobs. The maximum numbers of job slots are defined in the LSF configuration file lsb.users (see lsb.users). The reserved user name default, defined in the lsb.users configuration file, matches users not listed in the lsb.users file who have no jobs started in the system.

The returned array will be overwritten by the next call.

SYNOPSIS

#include <lsf/lsbatch.h>
struct userInfoEnt *lsb_userinfo(char **users, int *numUsers)

struct userInfoEnt {
    char *user;    int procJobLimit;
    int maxJobs;
    int numStartJobs;
    int numJobs;
    int numPEND;
    int numRUN;
    int numSSUSP;
    int numUSUSP;
    int numRESERVE; 
    int maxPendJobs; 
}; 

PARAMETERS

**users

An array of user names.

*numUsers

The number of user names.

To get information about all users, set *numUsers = 0; *numUsers will be updated to the actual number of users when this call returns. To get information on the invoker, set users = NULL, *numUsers = 1.

The userInfoEnt structures contain the following fields:

user

The name of the user or user group.

procJobLimit

The maximum number of job slots the user or user group can use on each processor. The job slots can be used by started jobs or reserved for PEND jobs.

maxJobs

The maximum number of job slots that the user or user group can use simultaneously in the local LSF cluster. The job slots can be used by started jobs or reserved for PEND jobs.

numStartJobs

The current number of job slots used by running and suspended jobs belonging to the user or user group.

numJobs

The total number of job slots in the LSF cluster for the jobs submitted by the user or user group.

numPEND

The number of job slots the user or user group has for pending jobs.

numRUN

The number of job slots the user or user group has for running jobs.

numSSUSP

The number of job slots for the jobs belonging to the user or user group that have been suspended by the system.

numUSUSP

The number of job slots for the jobs belonging to the user or user group that have been suspended by the user or the LSF system administrator.

numRESERVE

The number of job slots reserved for the pending jobs belonging to the user or user group.

maxPendJobs

The maximum number of pending jobs allowed.

RETURN VALUES

array:userInfoEnt

The function was successful, and *numUsers is set to the number of userInfoEnt structures returned.

character:NULL

Function failed.

ERRORS

If the function fails, lsberrno is set to indicate the error. If lsberrno is LSBE_BAD_USER, (*users)[*numUsers] is not a user known to the LSF system. Otherwise, if *numUsers is less than its original value, *numUsers is the actual number of users found.

SEE ALSO

Related API

lsb_hostinfo() - Get information about job server hosts

lsb_queueinfo() - Get information about job queues

Equivalent line command

busers

Files

$LSB_CONFDIR/cluster_name/lsb.users


Platform Computing Inc.
www.platform.com
Knowledge Center         Contents    Previous  Next