| [ Platform Documentation ] | [ Title ] | [ Contents ] | [ Previous ] | [ Next ] | [ Index ] |
[ Top ]
Environment Variables Set for Job Execution
LSF transfers most environment variables between submission and execution hosts. In addition to environment variables inherited from the user environment, LSF also sets several other environment variables for batch jobs:
-
LSB_ERRORFILE: Name of the error file specified with a
bsub-e - LSB_JOBID: Batch job ID assigned by LSF.
- LSB_JOBINDEX: Index of the job that belongs to a job array.
-
LSB_CHKPNT_DIR: This variable is set each time a checkpointed job is submitted. The value of the variable is chkpnt_dir
/job_Id, a subdirectory of the checkpoint directory that is specified when the job is submitted. The subdirectory is identified by the job ID of the submitted job. -
LSB_HOSTS: The list of hosts that are used to run the batch job.
For sequential jobs, this is only one host name. For parallel jobs, this includes multiple host names.
- LSB_QUEUE: The name of the queue the job is dispatched from.
- LSB_JOBNAME: Name of the job.
- LSB_RESTART: Set to `Y' if the job is a restarted job or if the job has been migrated. Otherwise this variable is not defined.
- LSB_EXIT_PRE_ABORT: Set to an integer value representing an exit status. A pre-execution command should exit with this value if it wants the job to be aborted instead of requeued or executed.
- LSB_EXIT_REQUEUE: Set to the REQUEUE_EXIT_VALUES parameter of the queue. This variable is not defined if REQUEUE_EXIT_VALUES is not configured for the queue.
- LSB_JOB_STARTER: Set to the value of the job starter if a job starter is defined for the queue.
-
LSB_INTERACTIVE: Set to `Y' if the job is submitted with the
-Ioption. Otherwise, it is undefined. - LS_JOBPID: Set to the process ID of the job.
- LS_SUBCWD: This is the directory on the submission when the job was submitted. This is different from PWD only if the directory is not shared across machines or when the execution account is different from the submission account as a result of account mapping.
[ Top ]
Environment Variable Reference
BSUB_BLOCK
If set, tells NIOS that it is running in batch mode.
Undefined
If you submit a job with the -K option of bsub, which is synchronous
execution, then BSUB_BLOCK is set. Synchronous execution means you have
to wait for the job to finish before you can continue.
Set internally
The -K option of bsub
BSUB_QUIET
BSUB_QUIET=any_value
Controls the printing of information about job submissions. If set, bsub will not
print any information about job submission. For example, it will not print
<Job is submitted to default queue <normal>, nor
<Waiting for dispatch>.
Undefined
From the command line
BSUB_QUIET=1
BSUB_QUIET2
BSUB_QUIET2=any_value
Suppresses the printing of information about job completion when a job is
submitted with the bsub -K option.
If set, bsub will not print information about job completion to stdout. For
example, when this variable is set, the message <<Job is finished>> will not be
written to stdout.
If BSUB_QUIET and BSUB_QUIET2 are both set, no job messages will be
printed to stdout.
Undefined
From the command line
BSUB_QUIET2=1
BSUB_STDERR
BSUB_STDERR=y
Redirects LSF messages for bsub to stderr.
By default, when this parameter is not set, LSF messages for bsub are printed
to stdout.
When this parameter is set, LSF messages for bsub are redirected to stderr.
Undefined
From the command line on UNIX. For example, in csh:
setenv BSUB_STDERR Y
From the Control Panel on Windows, as an environment variable
CLEARCASE_ROOT
CLEARCASE_ROOT=path
The path to the Rational ClearCase view.
If you want to submit a batch job from a ClearCase view, then
CLEARCASE_ROOT must be defined. You should submit these jobs with csub
rather than bsub. csub is used only with Rational ClearCase.
For interactive jobs, set LSF_JOB_STARTER to the ClearCase job starter.
In the job starter, or from the command line
CLEARCASE_ROOT=/view/myview
ClearCase, job starter, LSF_JOB_STARTER
LM_LICENSE_FILE
LM_LICENSE_FILE=file_name
The path to where the license file is found. The file name is the name of the license file.
/usr/share/flexlm/licenses/license.dat
A FLEXlm variable read by the lmgrd daemon.
From the command line
See lsf.conf under LSF_LICENSE_FILE
LS_EXEC_T
LS_EXEC_T=START|END|CHKPNT|JOB_CONTROLS
Indicates execution type for a job. LS_EXEC_T is set to:
- START or END for a job when the job begins executing or when it completes execution
- CHKPNT when the job is checkpointed
- JOB_CONTROLS when a control action is initiated
Set by sbatchd during job execution
LS_JOBPID
The process ID of the job.
During job execution, sbatchd sets LS_JOBPID to be the same as the process
ID assigned by the operating system.
LS_SUBCWD
The current working directory (cwd) of the submission host where the remote
task command was executed.
The way this parameter is set by LSF is as follows:
- LSF looks for the PWD environment variable. If it finds it, sets LS_SUBCWD to PWD.
- If the PWD environment variable does not exist, LSF looks for the CWD environment variable. If it finds CWD, sets LS_SUBCWD to CWD.
-
If the CWD environment variable does not exist, LSF calls the
getwd()system function to retrieve the current working directory path name. LSF sets LS_SUBCWD to the value that is returned.
Set by sbatchd
LSB_CHKPNT_DIR
LSB_CHKPNT_DIR=checkpoint_dir/job_ID
The directory containing files related to the submitted checkpointable job.
The value of checkpoint_dir is the directory you specified through the -k
option of bsub when submitting the checkpointable job.
The value of job_ID is the job ID of the checkpointable job.
Set by LSF, based on the directory you specified when submitting a
checkpointable job with the -k option of bsub.
LSB_DEBUG
This parameter can be set from the command line or from lsf.conf. See
lsf.conf under LSB_DEBUG.
LSB_DEBUG_CMD
This parameter can be set from the command line or from lsf.conf. See
lsf.conf under LSB_DEBUG_CMD.
LSB_DEBUG_MBD
This parameter can be set from the command line with badmin mbddebug or
from lsf.conf.
See lsf.conf under LSB_DEBUG_MBD.
LSB_DEBUG_NQS
This parameter can be set from the command line or from lsf.conf. See
lsf.conf under LSB_DEBUG_NQS.
LSB_DEBUG_SBD
This parameter can be set from the command line with badmin sbddebug or
from lsf.conf.
See lsf.conf under LSB_DEBUG_SBD.
LSB_DEBUG_SCH
This parameter can be set from the command line or from lsf.conf. See
lsf.conf under LSB_DEBUG_SCH.
LSB_DEFAULTPROJECT
LSB_DEFAULTPROJECT=project_name
The name of the project to which resources consumed by a job will be charged.
Undefined
If the LSF administrator defines a default project in the lsb.params
configuration file, the system uses this as the default project. You can change
the default project by setting LSB_DEFAULTPROJECT or by specifying a project
name with the -P option of bsub.
If you submit a job without the -P option of bsub, but you defined
LSB_DEFAULTPROJECT, then the job belongs to the project specified in
LSB_DEFAULTPROJECT.
If you submit a job with the -P option of bsub, the job belongs to the project
specified through the -P option.
From the command line, or through the -P option of bsub
LSB_DEFAULTPROJECT=engineering
See lsb.params under DEFAULT_PROJECT, the -P option of bsub.
LSB_DEFAULTQUEUE
LSB_DEFAULTQUEUE=queue_name
Defines the default LSF queue.
mbatchd decides which is the default queue. You can override the default by
defining LSB_DEFAULTQUEUE.
If the LSF administrator defines a default queue in the lsb.params
configuration file, then the system uses this as the default queue. Provided you
have permission, you can change the default queue by setting
LSB_DEFAULTQUEUE to a valid queue (see bqueues for a list of valid queues).
From the command line
See lsb.params under DEFAULT_QUEUE.
LSB_ECHKPNT_METHOD
This parameter can be set as an environment variable and/or in lsf.conf. See
lsf.conf under LSB_ECHKPNT_METHOD.
LSB_ECHKPNT_METHOD_DIR
This parameter can be set as an environment variable and/or in lsf.conf. See
lsf.conf under LSB_ECHKPNT_METHOD_DIR.
LSB_ECHKPNT_KEEP_OUTPUT
This parameter can be set as an environment variable and/or in lsf.conf. See
lsf.conf under LSB_ECHKPNT_KEEP_OUTPUT.
LSB_ERESTART_USRCMD
LSB_ERESTART_USRCMD=command
Original command used to start the job.
This environment variable is set by erestart to pass the job's original start
command to a custom erestart method erestart.method_name. The
value of this variable is extracted from the job file of the checkpointed job.
If a job starter is defined for the queue to which the job was submitted, the job
starter is also included in LSB_ERESTART_USRCMD. For example, if the job
starter is /bin/sh -c "%USRCMD" in lsb.queues, and the job name is myapp
-d, LSB_ERESTART_USRCMD will be set to:
/bin/sh -c "myapp -d"
Set by erestart as an environment variable before a job is restarted
LSB_ECHKPNT_METHOD, erestart, echkpnt
LSB_EXECHOSTS
A list of hosts on which a batch job will run.
Set by sbatchd
MultiCluster
LSB_EXIT_PRE_ABORT
The queue-level or job-level pre_exec_command can exit with this value if the
job is to be aborted instead of being requeued or executed
Set by sbatchd
See lsb.queues, or the -E option of bsub.
LSB_EXIT_REQUEUE
LSB_EXIT_REQUEUE="exit_value1 exit_value2..."
Contains a list of exit values found in the queue's REQUEUE_EXIT_VALUES
parameter defined in lsb.queues.
Any positive integers
Undefined
If LSB_EXIT_REQUEUE is defined, a job will be requeued if it exits with one of the specified values.
LSB_EXIT_REQUEUE is undefined if the parameter REQUEUE_EXIT_VALUES is undefined.
Set by the system based on the value of the parameter
REQUEUE_EXIT_VALUES in lsb.queues
LSB_EXIT_REQUEUE="7 31"
See lsb.queues under REQUEUE_EXIT_VALUES.
LSB_FRAMES
LSB_FRAMES=start_number,end_number,step
Determines the number of frames to be processed by a frame job.
The values of start_number, end_number, and step are positive integers. Use commas to separate the values.
Undefined
When the job is running, LSB_FRAMES will be set to the relative frames with the format LSB_FRAMES=start_number,end_number,step.
From the start_number, end_number, and step, the frame job can know how many frames it will process.
Set by sbatchd
LSB_FRAMES=10,20,1
LSB_HOSTS
LSB_HOSTS="host_name..."
A list of hosts selected by LSF Batch to run the batch job.
If a job is run on a single processor, the system sets LSB_HOSTS to the name of the host used.
For parallel jobs, the system sets LSB_HOSTS to the names of all the hosts used.
Set by sbatchd when the job is submitted. LSB_HOSTS is set only when the
list of host names is less than 4096 bytes.
See LSB_MCPU_HOSTS.
LSB_INTERACTIVE
LSB_INTERACTIVE=Y
Indicates an interactive job. When you submit an interactive job using bsub -I,
the system sets LSB_INTERACTIVE to Y.
LSB_INTERACTIVE=Y (if the job is interactive)
Undefined (if the job is not interactive)
Set by sbatchd
LSB_JOB_STARTER
LSB_JOB_STARTER=binary
Specifies an executable program that has the actual job as an argument.
Undefined
-
Interactive Jobs
If you want to run an interactive job that requires some preliminary setup, LSF provides a job starter function at the command level. A command-level job starter allows you to specify an executable file that will run prior to the actual job, doing any necessary setup and running the job when the setup is complete.
If the environment variable LSB_JOB_STARTER is properly defined,
sbatchdwill invoke the job starter (rather than the job itself), supplying your commands as arguments. -
Batch Jobs
A job starter can also be defined at the queue level using the JOB_STARTER parameter, although this can only be done by the LSF administrator.
From the command line
See lsb.queues under JOB_STARTER.
-
UNIX
The job starter is invoked from within a Bourne shell, making the command-line equivalent:
/bin/sh -c "$LSB_JOB_STARTER command [argument...]"
where
command [argument...]are the command line arguments you specified inlsrun,lsgrun, orch.If you define LSB_JOB_STARTER as follows:
% setenv LSB_JOB_STARTER "/bin/csh -c"
and run a simple C-shell job:
% lsrun "'a.out; echo hi'"
then the following will be invoked to correctly start the job:
/bin/sh -c "/bin/csh -c 'a.out; echo hi'"
-
Windows
RES runs the job starter, passing it your commands as arguments:
LSB_JOB_STARTER command [argument...]
If you define LSB_JOB_STARTER as follows:
set LSB_JOB_STARTER=C:\cmd.exe /C
and run a simple DOS shell job:
C:\> lsrun dir /p
then the following will be invoked to correctly start the job:
C:\cmd.exe /C dir /p
See lsb.queues under JOB_STARTER.
LSB_JOBEXIT_INFO
LSB_JOBEXIT_INFO="SIGNALsignal_value signal_name"
Contains information about signal that caused a job to exit.
Applies to post-execution commands. Post-execution commands are set with
POST_EXEC in lsb.queues.
When the post-execution command is run, the environment variable LSB_JOBEXIT_INFO is set if the job is signalled internally. If the job ends successfully, or the job is killed or signalled externally, LSB_JOBEXIT_INFO is not set.
LSB_JOBEXIT_INFO="SIGNAL -1 SIG_CHKPNT" LSB_JOBEXIT_INFO="SIGNAL -14 SIG_TERM_USER" LSB_JOBEXIT_INFO="SIGNAL -23 SIG_KILL_REQUEUE"
Undefined
Set by sbatchd
LSB_JOBEXIT_STAT
LSB_JOBEXIT_STAT=exit_status
Indicates a job's exit status.
Applies to post-execution commands. Post-execution commands are set with
POST_EXEC in lsb.queues.
When the post-execution command is run, the environment variable LSB_JOBEXIT_STAT is set to the exit status of the job. Refer to the man page for the wait(2) command for the format of this exit status.
The post-execution command is also run if a job is requeued because the job's execution environment fails to be set up, or if the job exits with one of the queue's REQUEUE_EXIT_VALUES. The LSB_JOBPEND environment variable is set if the job is requeued. If the job's execution environment could not be set up, LSB_JOBEXIT_STAT is set to 0.
Any positive integer
Set by sbatchd
LSB_JOBFILENAME
LSB_JOBFILENAME=file_name
The path to the batch job file.
Specifies the path to the batch executable job file that invokes the batch job.
The batch executable job file is a /bin/sh script on UNIX systems or a .BAT
command script on Windows systems.
LSB_JOBID
LSB_JOBID=job_ID
The job ID assigned by the Batch system. This is the ID of the job assigned by
LSF, as shown by bjobs.
Any positive integer
Set by sbatchd, defined by mbatchd
LSB_JOBINDEX
LSB_JOBINDEX=index
Contains the job array index.
Any integer greater than zero but less than the maximum job array size.
LSB_JOBINDEX is set when each job array element is dispatched. Its value corresponds to the job array index. LSB_JOBINDEX is set for all jobs. For non- array jobs, LSB_JOBINDEX is set to zero (0).
Set during job execution based on bsub options.
You can use LSB_JOBINDEX in a shell script to select the job command to be performed based on the job array index.
For example:
if [$LSB_JOBINDEX -eq 1]; then cmd1 fi if [$LSB_JOBINDEX -eq 2]; then cmd2 fi
LSB_JOBINDEX_STEP, LSB_REMOTEINDEX
LSB_JOBINDEX_STEP
LSB_JOBINDEX_STEP=step
Step at which single elements of the job array are defined.
Any integer greater than zero but less than the maximum job array size
1
LSB_JOBINDEX_STEP is set when a job array is dispatched. Its value corresponds to the step of the job array index. This variable is set only for job arrays.
Set during job execution based on bsub options.
The following is an example of an array where a step of 2 is used:
array[1-10:2] elements:1 3 5 7 9
If this job array is dispatched, then LSB_JOBINDEX_STEP=2
LSB_JOBNAME
LSB_JOBNAME=job_name
The name of the job defined by the user at submission time.
The job's command line
The name of a job can be specified explicitly when you submit a job. The name
does not have to be unique. If you do not specify a job name, the job name
defaults to the actual batch command as specified on the bsub command line.
Set by sbatchd
When you submit a job using the -J option of bsub, for example:
% bsub -J "myjob" job
sbatchd sets LSB_JOBNAME to the job name that you specified:
LSB_JOBNAME=myjob
LSB_JOBPEND
Set if the job is requeued.
Set by sbatchd for POST_EXEC only
LSB_JOBEXIT_STAT, REQUEUE_EXIT_VALUES, POST_EXEC.
LSB_JOBPGIDS
A list of the current process group IDs of the job.
The process group IDs are assigned by the operating system, and
LSB_JOBPGIDS is set by sbatchd.
LSB_JOBPIDS
A list of the current process IDs of the job.
The process IDs are assigned by the operating system, and LSB_JOBPIDS is set
by sbatchd.
LSB_MAILSIZE
LSB_MAILSIZE=value
Gives an estimate of the size of the batch job output when the output is sent by email. It is not necessary to configure LSB_MAILSIZE_LIMIT.
LSF sets LSB_MAILSIZE to the size in KB of the job output, allowing the custom mail program to intercept output that is larger than desired.
LSB_MAILSIZE is not recognized by the LSF default mail program. To prevent large job output files from interfering with your mail system, use LSB_MAILSIZE_LIMIT to explicitly set the maximum size in KB of the email containing the job information.
-
A positive integer
If the output is being sent by email, LSB_MAILSIZE is set to the estimated mail size in kilobytes.
-
-1
If the output fails or cannot be read, LSB_MAILSIZE is set to -1 and the output is sent by email using LSB_MAILPROG if specified in
lsf.conf. -
Undefined
If you use the
-oor-eoptions ofbsub, the output is redirected to an output file. Because the output is not sent by email in this case, LSB_MAILSIZE is not used and LSB_MAILPROG is not called.If the
-Noption is used with the-ooption ofbsub, LSB_MAILSIZE is not set.
Set by sbatchd when the custom mail program specified by LSB_MAILPROG
in lsf.conf is called.
LSB_MCPU_HOSTS
LSB_MCPU_HOSTS="host_nameA num_processors1 host_nameB num_processors2..."
Contains a list of the hosts and the number of CPUs used to run a job.
num_processors1, num_processors2,... refer to the number of CPUs used
on host_nameA, host_nameB,..., respectively
Undefined
The environment variables LSB_HOSTS and LSB_MCPU_HOSTS both contain
the same information, but the information is presented in different formats. If
you look at the usage example, you see that LSB_MCPU_HOSTS uses a shorter
format than LSB_HOSTS. As a general rule, sbatchd sets both these variables.
However, for some parallel jobs, LSB_HOSTS is not set.
For parallel jobs, several CPUs are used, and the length of LSB_HOSTS can
become very long. sbatchd needs to spend a lot of time parsing the string. If
the size of LSB_HOSTS exceeds 4096 bytes, LSB_HOSTS is ignored, and
sbatchd sets only LSB_MCPU_HOSTS.
If you want to verify the hosts and CPUs used for your dispatched job, check the value of LSB_HOSTS for single CPU jobs
Check the value of LSB_MCPU_HOSTS for parallel jobs.
Set by sbatchd at job submission
When the you submit a job with the -m and -n options of bsub, for example,
% bsub -m "hostA hostB" -n 6 job
sbatchd sets the environment variables LSB_HOSTS and LSB_MCPU_HOSTS
as follows:
LSB_HOSTS= "hostA hostA hostA hostB hostB hostB" LSB_MCPU_HOSTS="hostA 3 hostB 3"
Both variables are set in order to maintain compatibility with older versions.
LSB_NQS_PORT
This parameter can be defined in lsf.conf or in the services database such
as /etc/services.
See lsf.conf under LSB_NQS_PORT for more details.
LSB_OLD_JOBID
LSB_OLD_JOBID=job_ID
The job ID of a job at the time it was checkpointed.
When a job is restarted, it is assigned a new job ID and LSB_JOBID is replaced with the new job ID. LSB_OLD_JOBID identifies the original ID of a job before it is restarted.
Any positive integer
Set by sbatchd, defined by mbatchd
LSB_OUTPUT_TARGETFAILED
LSB_OUTPUT_TARGETFAILED=Y
Indicates that LSF cannot access the output file specified for a job submitted
the bsub -o option.
Set to Y if the output file cannot be accessed; otherwise, it is undefined.
Set by sbatchd during job execution
LSB_QUEUE
The name of the queue from which the job is dispatched.
Set by sbatchd
LSB_REMOTEINDEX
LSB_REMOTEINDEX=index
The job array index of a remote MultiCluster job. LSB_REMOTEINDEX is set only if the job is an element of a job array.
Any integer greater than zero, but less than the maximum job array size
Set by sbatchd
LSB_JOBINDEX, MAX_JOB_ARRAY_SIZE in lsb.params
LSB_REMOTEJID
LSB_REMOTEJID=job_ID
The job ID of a remote MultiCluster job.
Set by sbatchd, defined by mbatchd
LSB_RESTART
LSB_RESTART=Y
Indicates that a job has been restarted or migrated.
Set to Y if the job has been restarted or migrated; otherwise, it is undefined.
If a batch job is submitted with the -r option of bsub, and is restarted because
of host failure, then LSB_RESTART is set to Y. If a checkpointable job is
submitted with the -k option of bsub, then LSB_RESTART is set to Y when the
job is restarted. If bmig is used to migrate a job, then LSB_RESTART is set to Y
when the migrated job is restarted.
If the job is not a restarted job, then LSB_RESTART is not set.
Set by sbatchd during job execution
LSB_RESTART_PGID, LSB_RESTART_PID
LSB_RESTART_PGID
LSB_RESTART_PGID=pgid
The process group ID of the checkpointed job when the job is restarted.
When a checkpointed job is restarted, the operating system assigns a new group process ID to the job. Batch sets LSB_RESTART_PGID to the new group process ID.
Set by Batch during restart of a checkpointed job.
LSB_RESTART_PID
LSB_RESTART_PID=pid
The process ID of the checkpointed job when the job is restarted.
When a checkpointed job is restarted, the operating system assigns a new process ID to the job. Batch sets LSB_RESTART_PID to the new process ID.
Defined by Batch during restart of a checkpointed job
LSB_SUB_CLUSTER
Name of submission cluster (MultiCluster only)
Set on the submission environment and passed to the execution cluster environment. The parameter will ONLY be valid in Multi Cluster environment.
LSB_SUB_COMMAND_LINE
The job command line.
Set by esub before a job is submitted.
LSB_SUB_EXTSCHED_PARAM
Value of external scheduling options specified by bsub -extsched, or queue-
level MANDATORY_EXTSCHED or DEFAULT_EXTSCHED.
Set by esub before a job is submitted.
LSB_SUB_JOB_WARNING_ACTION
Value of job warning action specified by bsub -wa.
Set by esub before a job is submitted.
LSB_SUB_JOB_WARNING_TIME_PERIOD
Value of job warning time period specified by bsub -wt.
Set by esub before a job is submitted.
LSB_SUB_PARM_FILE
LSB_SUB_PARM_FILE=file_name
Indicates to esub the file in which the job submission parameters are written
Points to a file in which the job submission parameters are written. The
submission parameters are a set of name-value pairs on separate lines in the
format "option_name=value". A typical use of this file is to control job
submission options.
Set by LSF on the submission host before running esub. Not defined when
esub is invoked in interactive remote execution.
LSB_SUSP_REASONS
LSB_SUSP_REASONS=integer
An integer representing suspend reasons. Suspend reasons are defined in
lsbatch.h.
This parameter is set when a job goes to system-suspended (SSUSP) or user- suspended status (USUSP). It indicates the exact reason why the job was suspended.
To determine the exact reason, you can test the value of LSB_SUSP_REASONS
against the symbols defined in lsbatch.h.
Undefined
Set by sbatchd
LSB_SUSP_SUBREASONS
LSB_SUSP_SUBREASONS=integer
An integer representing load indices. Load index values are defined in lsf.h.
Load Index
Value
R15S
0
R1M
1
R15M
2
UT
3
PG
4
IO
5
LS
6
IT
7
TMP
8
SWP
9
MEM
10
When a value of the symbol SUSP_LOAD_REASON is set in LSB_SUSP_REASONS, it means the job is suspended by load, and LSB_SUSP_SUBREASONS set to one of the load index values.
You can use LSB_SUSP_SUBREASONS to determine which load index caused the job to be suspended.
LSB_SUSP_REASONS and LSB_SUSP_SUBREASONS can be used together in job control to determine the exact load threshold that caused a job to be suspended.
Undefined
Set by sbatchd
LSF_CMD_LOGDIR
This parameter can be set from the command line or from lsf.conf.
See lsf.conf under LSF_CMD_LOGDIR.
LSF_DEBUG_CMD
This parameter can be set from the command line or from lsf.conf.
See lsf.conf under LSB_DEBUG_MBD.
LSF_DEBUG_LIM
This parameter can be set from the command line or from lsf.conf.
See lsf.conf under LSF_DEBUG_LIM.
LSF_DEBUG_RES
This parameter can be set from the command line or from lsf.conf.
See lsf.conf under LSF_DEBUG_RES.
LSF_EAUTH_AUX_DATA
LSF_EAUTH_AUX_DATA=path/file_name
The full path to the temporary file on the local file system that is used for storing auxiliary authentication information.
Credentials are passed between invocations of eauth and the daemons
through the file defined by LSF_EAUTH_AUX_DATA.
To allow daemons to call eauth to authenticate each other, you must define
LSF_AUTH_DAEMONS.
Set internally by eauth
LSF_AUTH_DAEMONS, LSF_EAUTH_AUX_PASS
LSF_EAUTH_AUX_PASS
LSF_EAUTH_AUX_PASS=yes
Grants permission.
LSF_EAUTH_AUX_PASS is passed to eauth -c when
LSF_EAUTH_CLIENT=user, and it tells eauth that it has permission to forward
auxiliary authentication data.
To allow daemons to call eauth to authenticate each other, you must define
LSF_AUTH_DAEMONS.
Set internally
SUN HPC
LSF_EAUTH_AUX_DATA, LSF_EAUTH_CLIENT
LSF_EAUTH_CLIENT
A string that specifies the daemon or user that is calling eauth -c.
Sets the context for the call to eauth, and allows the eauth writer to perform
daemon authentication.
Set internally by the LSF libraries, or by the daemon calling eauth -c.
LSF_EAUTH_SERVER
Specifies the daemon or user that is calling eauth -s
Sets the context for the call to eauth, and allows the eauth writer to perform
daemon authentication.
Set internally by the LSF libraries, or by the daemon calling eauth -s
LSF_EAUTH_UID
LSF_EAUTH_UID=user_ID
Specifies the user ID under which eauth -s must run.
Set by the LSF daemon which executes eauth.
See LSF_EAUTH_USER in lsf.sudoers.
LSF_INTERACTIVE_STDERR
This parameter can be defined in lsf.conf.
See lsf.conf under LSF_INTERACTIVE_STDERR for more details.
LSF_JOB_STARTER
LSF_JOB_STARTER=binary
Specifies an executable program that has the actual job as an argument.
Undefined
Interactive Jobs
If you want to run an interactive job that requires some preliminary setup, LSF provides a job starter function at the command level. A command-level job starter allows you to specify an executable file that will run prior to the actual job, doing any necessary setup and running the job when the setup is complete.
If LSF_JOB_STARTER is properly defined, RES will invoke the job starter (rather than the job itself), supplying your commands as arguments.
Batch Jobs
A job starter can also be defined at the queue level using the JOB_STARTER parameter, although this can only be done by the LSF administrator.
From the command line
-
UNIX
The job starter is invoked from within a Bourne shell, making the command-line equivalent:
/bin/sh -c "$LSF_JOB_STARTER command [argument...]"
where
command [argument...]are the command line arguments you specified inlsrun,lsgrun, orch.If you define LSF_JOB_STARTER as follows:
% setenv LSF_JOB_STARTER "/bin/csh -c"
and run a simple C-shell job:
% lsrun "'a.out; echo hi'"
The following will be invoked to correctly start the job:
/bin/sh -c "/bin/csh -c 'a.out; echo hi'"
-
Windows
RES runs the job starter, passing it your commands as arguments:
LSF_JOB_STARTER
command [argument...]If you define LSF_JOB_STARTER as follows:
set LSF_JOB_STARTER=C:\cmd.exe /C
and run a simple DOS shell job:
C:\> lsrun dir /p
then the following will be invoked to correctly start the job:
C:\cmd.exe /C dir /p
See lsb.queues under JOB_STARTER.
LSF_LIM_DEBUG
This parameter can be set from the command line or from lsf.conf.
See lsf.conf under LSF_LIM_DEBUG.
LSF_LOGDIR
This parameter can be set from the command line or from lsf.conf.
See lsf.conf under LSF_LOGDIR.
LSF_MASTER
Specifies whether ELIM has been started on the master host.
LIM communicates with ELIM through two environment variables: LSF_MASTER and LSF_RESOURCES.
LSF_MASTER is set to Y when LIM starts ELIM on the master host. It is set to N
or is undefined otherwise.
LSF_MASTER can be used to test whether the ELIM should report on cluster- wide resources that only need to be collected on the master host.
Set by LIM when ELIM is started
LSF_NIOS_DEBUG
This parameter can be set from the command line or from lsf.conf. See
lsf.conf under LSF_NIOS_DEBUG.
LSF_NIOS_DIE_CMD
LSF_NIOS_DIE_CMD=command
If set, the command defined by LSF_NIOS_DIE_CMD is executed before NIOS exits.
Undefined
From the command line
LSF_NIOS_IGNORE_SIGWINDOW
LSF_NIOS_IGNORE_SIGWINDOW=any_value
If defined, the NIOS will ignore the SIGWINDOW signal.
Undefined
When the signal SIGWINDOW is defined, some tasks appear to die when they receive the SIGWINDOW while doing I/O. By defining LSF_NIOS_IGNORE_SIGWINDOW, these tasks are given the chance to ignore the signal.
From the command line
LSF_NIOS_PEND_TIMEOUT
LSF_NIOS_PEND_TIMEOUT=minutes
Applies only to interactive batch jobs.
Maximum amount of time that an interactive batch job can remain pending.
If this parameter is defined, and an interactive batch job is pending for longer than the specified time, the interactive batch job is terminated.
Any integer greater than zero
Undefined
LSF_RESOURCES
LSF_RESOURCES=dynamic_shared_resource_name...
Space-separated list of customized dynamic shared resources that the ELIM is responsible for collecting.
A resource name is only put in the list if the host on which the ELIM is running shares an instance of that resource.
LIM communicates with the ELIM through two environment variables: LSF_MASTER and LSF_RESOURCES.
LSF_MASTER is set to Y when LIM starts ELIM on the master host. It is set to N
or is undefined otherwise.
LSF_RESOURCES is set to a space-separated string of dynamic shared resources for which the ELIM on that host is responsible for collecting. LSF_RESOURCES gets passed to ELIM from LIM.
By LIM when ELIM is invoked
LSF_RESOURCES="resource1 resource2 resource3"
LSF_USE_HOSTEQUIV
Used for authentication purposes. If LSF_USE_HOSTEQUIV is defined, LSF will
trust all hosts configured in the LSF cluster that are defined in hosts.equiv,
or in .rhosts in the user's home directory.
Undefined
If LSF_USE_HOSTEQUIV is not defined, all normal users in the cluster can execute remote jobs on any host. If LSF_ROOT_REX is set, root can also execute remote jobs with the same permission test as for normal users.
LSF_ROOT_REX, LSF_AUTH in lsf.conf
LSF_USER_DOMAIN
LSF_USER_DOMAIN = domain_name |.
Set during LSF installation or setup. If you modify this parameter in an existing cluster, you probably have to modify passwords and configuration files also.
Windows or mixed UNIX-Windows clusters only.
Enables default user mapping, and specifies the LSF user domain. The period
(.) specifies local accounts, not domain accounts.
- a user name specified without a domain is interpreted (on a Windows host) as belonging to the LSF user domain
- a user name specified with the domain name of the LSF user domain is invalid
- in a mixed cluster, this parameter defines a 2-way, 1:1 user map between UNIX user accounts and Windows user accounts belonging to the specified domain, as long as the accounts have the same user name. This means jobs submitted by the Windows user account can run on a UNIX host, and jobs submitted by the UNIX account can run on any Windows host that is available to the Windows user account.
If this parameter is undefined, the default user mapping is not enabled. You can still configure user mapping at the user or system level. User account mapping is required to run cross-platform jobs in a UNIX-Windows mixed cluster.
lsf.conf
- If you upgrade from LSF 4.0.1 or earlier, the default is the existing LSF user domain.
- For a new, Windows-only cluster, this parameter is undefined (no LSF user domain, no default user mapping).
- For a new, mixed UNIX-Windows cluster, the default is the domain that the Windows installation account belongs to. This can be modified during LSF installation.
[ Top ]
| [ Platform Documentation ] | [ Title ] | [ Contents ] | [ Previous ] | [ Next ] | [ Index ] |
|
Date Modified: February 24, 2004
Platform Computing: www.platform.com Platform Support: support@platform.com Platform Information Development: doc@platform.com Copyright © 1994-2004 Platform Computing Corporation. All rights reserved. |