lsb_openjobinfo_a

Provides the name and number of jobs and hosts in the master batch daemon.

lsb_openjobinfo_a provides more information on pending, running and suspended jobs than lsb_openjobinfo. Use lsb_openjobinfo_a to create a connection to the master batch daemon. Next, use lsb_readjobinfo to read job records. Close the connection using lsb_closejobinfo.

lsb_openjobinfo_a passes information about jobs based on the value of jobId,jobName, userName, queueName, or hostName. Only one parameter can be chosen. The other parameters must be NULL or 0.

#include <lsf/lsbatch.h>

struct jobInfoHead *lsb_openjobinfo_a(LS_LONG_INT jobId, char *jobName, char *userName, char *queueName, char *hostName, int options)

Parameters:

	jobId	Passes information about jobs with the given job ID. If jobId is 0, lsb_openjobinfo looks to another parameter to return information about jobs. If information about a member of a job array is to be passed, use the array form jobID[ i ] where jobID is the job array name, and i is the index value.
	*jobName	Passes information about jobs with the given job name. If jobName is NULL, lsb_openjobinfo looks to another parameter to return information about jobs.
	*userName	Passes information about jobs submitted by the named user or user group, or by all users if userName is all. If userName is NULL, lsb_openjobinfo_a assumes the user is invoking this call.
	*queueName	Passes information about jobs belonging to the named queue. If queueName is NULL, jobs in all queues of the batch system will be considered.
	*hostName	Passes information about jobs on the named host, host group or cluster name. If hostName is NULL, jobs on all hosts of the batch system will be considered.
	options	<lsf/lsbatch.h> defines the flags shown in def_lsb_openjobinfo_a constructed from bits. Use the bitwise OR to set more than one flag.

Data Structures:

: jobInfoHead

Define Statements:

: defs_lsb_openjobinfo_a

Returns:: struct jobInfoHead *
On success, returns an array of data type struct jobInfoHeadExt *, which represents the name and number of jobs and hosts in the master batch daemon with the host group information.
NULL
The function failed.

Errors:

: If the function fails, lsberrno is set to indicate the error.

Equivalent line command:

: bjobs

Files:

: ${LSF_ENVDIR:-/etc}/lsf.conf
$LSB_CONFDIR/cluster_name/configdir/lsb.params

See also: