submit Struct Reference

submit request structure. More...


Data Fields
int	options
int	options2
char *	jobName
char *	queue
int	numAskedHosts
char **	askedHosts
char *	resReq
int	rLimits [LSF_RLIM_NLIMITS]
char *	hostSpec
int	numProcessors
char *	dependCond
char *	timeEvent
time_t	beginTime
time_t	termTime
int	sigValue
char *	inFile
char *	outFile
char *	errFile
char *	command
char *	newCommand
time_t	chkpntPeriod
char *	chkpntDir
int	nxf
struct xFile *	xf
char *	preExecCmd
char *	mailUser
int	delOptions
int	delOptions2
char *	projectName
int	maxNumProcessors
char *	loginShell
char *	userGroup
char *	exceptList
int	userPriority
char *	rsvId
char *	jobGroup
char *	sla
char *	extsched
int	warningTimePeriod
char *	warningAction
char *	licenseProject
int	options3
int	delOptions3
char *	app
int	jsdlFlag
char *	jsdlDoc
void *	correlator
char *	apsString
char *	postExecCmd
char *	cwd
int	runtimeEstimation
char *	requeueEValues
int	initChkpntPeriod
int	migThreshold
char *	notifyCmd
char *	jobDescription
struct submit_ext *	submitExt
int	options4
int	delOptions4
int	numAskedClusters
char **	askedClusters
char *	outdir
char *	dcTmpls
char *	dcVmActions
char *	networkReq
char *	allocHostFile
char *	subEnvVars
char *	dataSpecFile

Detailed Description

submit request structure.

Field Documentation

int submit::options

<lsf/lsbatch.h> defines the flags in lsb_submit_options constructed from bits.

These flags correspond to some of the options of the bsub command line. Use the bitwise OR to set more than one flag.

int submit::options2

Extended bitwise inclusive OR of some of the flags in lsb_submit_options2.

char* submit::jobName

The job name.

If jobName is NULL, command is used as the job name.

char* submit::queue

Submit the job to this queue.

If queue is NULL, submit the job to a system default queue.

int submit::numAskedHosts

The number of invoker specified candidate hosts for running the job.

If numAskedHosts is 0, all qualified hosts will be considered.

char** submit::askedHosts

The array of names of invoker specified candidate hosts.

The number of hosts is given by numAskedHosts.

char* submit::resReq

The resource requirements of the job.

If resReq is NULL, the batch system will try to obtain resource requirements for command from the remote task lists (see ls_task ). If the task does not appear in the remote task lists, then the default resource requirement is to run on host() of the same type.

int submit::rLimits[LSF_RLIM_NLIMITS]

Limits on the consumption of system resources by all processes belonging to this job.

See getrlimit() for details. If an element of the array is -1, there is no limit for that resource. For the constants used to index the array, see lsb_queueinfo .

char* submit::hostSpec

Specify the host model to use for scaling rLimits[LSF_RLIMIT_CPU] and rLimits[LSF_RLIMIT_RUN].

(See lsb_queueinfo). If hostSpec is NULL, the local host is assumed.

int submit::numProcessors

The initial number of processors needed by a (parallel) job.

The default is 1.

char* submit::dependCond

The job dependency condition.

char* submit::timeEvent

Time event string.

time_t submit::beginTime

Dispatch the job on or after beginTime, where beginTime is the number of seconds since 00:00:00 GMT, Jan.

1, 1970 (See time(), ctime()). If beginTime is 0, start the job as soon as possible.

time_t submit::termTime

The job termination deadline.

If the job is still running at termTime, it will be sent a USR2 signal. If the job does not terminate within 10 minutes after being sent this signal, it will be ended. termTime has the same representation as beginTime. If termTime is 0, allow the job to run until it reaches a resource limit.

int submit::sigValue

Applies to jobs submitted to a queue that has a run window (See lsb_queueinfo).

Send signal sigValue to the job 10 minutes before the run window is going to close. This allows the job to clean up or checkpoint itself, if desired. If the job does not terminate 10 minutes after being sent this signal, it will be suspended.

char* submit::inFile

The path name of the job's standard input file.

If inFile is NULL, use /dev/null as the default.

char* submit::outFile

The path name of the job's standard output file.

If outFile is NULL, the job's output will be mailed to the submitter

char* submit::errFile

The path name of the job's standard error output file.

If errFile is NULL, the standard error output will be merged with the standard output of the job.

char* submit::command

When submitting a job, the command line of the job.

When modifying a job, a mandatory parameter that should be set to jobId in string format.

char* submit::newCommand

New command line for bmod.

time_t submit::chkpntPeriod

The job is checkpointable with a period of chkpntPeriod seconds.

The value 0 disables periodic checkpointing.

char* submit::chkpntDir

The directory where the chk directory for this job checkpoint files will be created.

When a job is checkpointed, its checkpoint files are placed in chkpntDir/chk. chkpntDir can be a relative or absolute path name.

int submit::nxf

The number of files to transfer.

struct xFile* submit::xf

The array of file transfer specifications.

(The xFile structure is defined in <lsf/lsbatch.h>.)

char* submit::preExecCmd

The job pre-execution command.

char* submit::mailUser

The user that results are mailed to.

int submit::delOptions

Delete options in options field.

int submit::delOptions2

Extended delete options in options2 field.

char* submit::projectName

The name of the project the job will be charged to.

int submit::maxNumProcessors

Maximum number of processors required to run the job.

char* submit::loginShell

Specified login shell used to initialize the execution environment for the job (see the -L option of bsub).

char* submit::userGroup

The name of the LSF user group (see lsb.users) to which the job will belong.

(see the -G option of bsub)

char* submit::exceptList

Passes the exception handlers to mbatchd during a job.

(see the -X option of bsub). Specifies execption handlers that tell the system how to respond to an exceptional condition for a job. An action is performed when any one of the following exceptions is detected:

missched - A job has not been scheduled within the time event specified in the -T option.
overrun - A job did not finish in its maximum time (maxtime).
underrun - A job finished before it reaches its minimum running time (mintime).
abend - A job terminated abnormally. Test an exit code that is one value, two or more comma separated values, or a range of values (two values separated by a `-' to indivate a range). If the job exits with one of the tested values, the abend condition is detected.
startfail - A job did not start due to insufficient system resources.
cantrun - A job did not start because a dependency condition (see the -w option of bsub) is invalid, or a startfail exception occurs 20 times in a row and the job is suspended. For jobs submitted with a time event (see the -T option of bsub), the cantrun exception condition can be detected once in each time event.
hostfail - The host running a job becomes unavailable.

When one or more of the above exceptions is detected, you can specify one of the following actions to be taken:

alarm - Triggers an alarm incident (see balarms(1)). The alarm can be viewed, acknowledged and resolved.
setexcept - Causes the exception event event_name to be set. Other jobs waiting on the exception event event_name specified through the -w option can be triggered. event_name is an arbitrary string.
rerun - Causes the job to be rescheduled for execution. Any dependencies associated with the job must be satisfied before re-execution takes place. The rerun action can only be specified for the abend and hostfail exception conditions. The startfail exception condition automatically triggers the rerun action.
kill - Causes the current execution of the job to be terminated. This action can only be specified for the overrun exception condition.