Knowledge Center Contents Previous Next |
lsb_openjobinfo_a_ext()
Returns the name and number of jobs and hosts in the master batch daemon with additional host group information.
DESCRIPTION
lsb_openjobinfo_a_ext() is run from lsb_openjobinfo_a() using the same parameters and provides the same information as lsb_openjobinfo_a(), but with additional host group information.
SYNOPSIS
#include <lsf/lsbatch.h> struct jobInfoHeadExt * lsb_openjobinfo_a_ext (LS_LONG_INT jobId, char *jobName, char *userName, char *queueName, char *hostName, int options)PARAMETERS
lsb_openjobinfo_a_ext() 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.
jobId
Passes information about jobs with the given job ID. If jobId is 0, lsb_openjobinfo_a_ext() 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_a_ext() 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_ext() 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 following flags constructed from bits. Use the bitwise OR to set more than one flag.
ALL_JOB
Information about all jobs, including unfinished jobs (pending, running or suspended) and recently finished jobs. LSF remembers jobs finished within the preceding period. This period is set by the parameter CLEAN_PERIOD in the lsb.params file. The default is 3600 seconds (1 hour). (See lsb.params). The command line equivalent is bjobs -a.
CUR_JOB
Information about all unfinished jobs.
DONE_JOB
Information about recently finished jobs.
PEND_JOB
Information about pending jobs.
SUSP_JOB
Information about suspended jobs.
LAST_JOB
Information about the last submitted job.
If options is 0, default to CUR_JOB.
RETURN VALUES
struct jobInfoHeadExt *
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.
integer:-1
The function failed.
ERRORS
If the function fails, lsberrno is set to indicate the error.
SEE ALSO
Related APIs
lsb_openjobinfo() - Opens a job information connection to the master batch daemon
lsb_openjobinfo_a() - Returns the name and number of jobs and hosts in the master batch daemon
lsb_closejobinfo() - Closes a job information connection to the master batch daemon
lsb_readjobinfo() - Returns the next job information record in master batch daemon
lsb_readframejob() - Returns frame job information from the master batch daemon
Equivalent line command
bjobs
Files
${LSF_ENVDIR-/etc}/lsf.conf
lsb.params
Platform Computing Inc.
www.platform.com |
Knowledge Center Contents Previous Next |