Knowledge Center         Contents    Previous  Next    
Platform Computing Corp.

lsblib

Application Programming Interface (API) library functions for batch jobs

LSBLIB functions allow application programs to get information about the hosts, queues, users, jobs and configuration of the batch system. Application programs can also submit jobs and control hosts, queues and jobs. Finally, application programs can read batch log files and write batch error messages.

LSBLIB contains the following functions:

lsb_chkpntjob()

Checkpoint a job

lsb_closejobinfo()

Close the job information connection with mbatchd

lsb_geteventrec()

Get an event record from a log file

lsb_hostcontrol()

Enable or disable a host, restart or shutdown a slave batch daemon

lsb_hostgrpinfo()

Get membership of batch host groups

lsb_hostinfo()

Get information about job server hosts

lsb_sharedresourceinfo()

Get information about shared resource used for scheduling

lsb_hostpartinfo()

Get information about host partitions

lsb_init()

Initialize LSBLIB and get the configuration environment

lsb_mig()

Migrate a job from one host to another

lsb_movejob()

Move a job in a queue

lsb_openjobinfo()

Open a job information connection with the mbatchd

lsb_parameterinfo()

Get information about the batch cluster

lsb_peekjob()

Retrieve the name of a job's output file

lsb_pendreason()

Explain why a job is pending

lsb_perror()

Print a batch error message on stderr

lsb_queuecontrol()

Dynamically change the status of a batch job queue

lsb_queueinfo()

Get information about batch queues

lsb_readjobinfo()

Get the next job information record from the connection with mbatchd

lsb_reconfig()

Reconfigure the batch cluster

lsb_signaljob()

Send a signal to a job

lsb_submit()

Submit a job to the batch system

lsb_suspreason()

Explain why a job was suspended

lsb_switchjob()

Switch a job to another queue

lsb_sysmsg()

Return an batch error message

lsb_usergrpinfo()

Get membership of batch user groups

lsb_userinfo()

Get information about users and user groups

NOTES

All LSBLIB APIs require that the batch header file <lsf/lsbatch.h> be included.

Many LSBLIB APIs return a pointer to an array or structure. These data structures are in static storage or on the heap. The next time the API is called, the storage is overwritten or freed.

Any program using LSBLIB APIs that change the state of the batch system (that is, except for APIs that just get information about the system) must be setuid to root if LSF_AUTH is not defined in the lsf.conf file.

On systems which have both System V and BSD programming interfaces, LSBLIB typically requires the BSD programming interface. On System V-based versions of UNIX, for example SGI IRIX, it is normally necessary to link applications using LSBLIB with the BSD compatibility library.

On AFS systems, the following needs to be added to the end of your linkage specifications when linking with LSBLIB (assuming your AFS library path is /usr/afsws):

For HP-UX and Solaris,

-lc -L/usr/afsws/lib -L/usr/afsws/lib/afs -lsys -lrx -llwp /usr/afsws/lib/afs/util.a

For other platforms,

-lc -L/usr/afsws/lib -L/usr/afsws/lib/afs -lsys -lrx -llwp

FILES

${LSF_ENVDIR-/etc}/lsf.conf

$LSF_CONFDIR/lsf.shared

$LSF_CONFDIR/lsf.cluster.cluster_name

$LSF_CONFDIR/lsf.task

$LSF_CONFDIR/lsf.task.cluster_name

$LSB_CONFDIR/cluster/lsb.hosts

$LSB_CONFDIR/cluster/lsb.params

$LSB_CONFDIR/cluster/lsb.queues

$LSB_CONFDIR/cluster/lsb.users

SEE ALSO

lsb_chkpntjob(), lsb_closejobinfo(), lsb_hostgrpinfo(), lsb_usergrpinfo(), lsb_hostcontrol(), lsb_hostinfo(), lsb_sharedresourceinfo(), lsb_hostpartinfo(), lsb_init(), lsb_mig(), lsb_movejob(), lsb_openjobinfo(), lsb_parameterinfo(), lsb_peekjob(), lsb_pendreason(), lsb_perror(), lsb_queuecontrol(), lsb_queueinfo(), lsb_readjobinfo(), lsb_reconfig(), lsb_signaljob(), lsb_submit(), lsb_suspreason(), lsb_switchjob(), lsb_sysmsg(), lsb_userinfo(), lsb.queues, lim, res, mbatchd


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