Using and Administering

Configuration File Keywords and LoadLeveler Variables

The following tables contain a brief description of the keywords you can use in the configuration file. The term configuration file keywords refers to keywords, user-defined variables, and LoadLeveler variables. A summary table is provided for each of the three types of configuration file keywords.

Keywords

The following table serves only as a reference. For more information on a specific keyword, see the section and page number referenced in the "For Details" column.
Configuration File Keyword Brief Description For Details
ACCT Turns the accounting function on (or off). Step 9: Define Job Accounting
ACCT_VALIDATION The module called to perform account validation. Step 9: Define Job Accounting
ACTION_ON_MAX_REJECT Specifies whether a job is cancelled or put in User Hold or System Hold status when the job exceeds the MAX_JOB_REJECT value. Step 17: Specify Additional Configuration File Keywords
ADMIN_FILE Points to the administration file containing user, class, and machine list stanzas. Step 11: Specify Where Files and Directories are Located
AFS_GETNEWTOKEN A filter which can be used to renew an AFS token. Step 17: Specify Additional Configuration File Keywords
ARCH The standard architecture of the system. Step 3: Define LoadLeveler Machine Characteristics
BIN The directory where LoadLeveler binaries are kept. Step 11: Specify Where Files and Directories are Located
CENTRAL_MANAGER_ HEARTBEAT_INTERVAL The amount of time in seconds that defines how frequently primary and alternate central manager communicate with each other. Step 10: Specify Alternate Central Managers
CENTRAL_MANAGER_TIMEOUT The number of heartbeat intervals that an alternate central manager will wait before declaring that the primary central manager is not operating. Step 10: Specify Alternate Central Managers
CLASS The class of jobs that can run on the machine. Step 3: Define LoadLeveler Machine Characteristics
CLIENT_TIMEOUT The maximum time, in seconds, that a daemon waits for a response over TCP/IP from a process . Step 13: Define Network Characteristics
COLLECTOR_DGRAM_PORT The port number used when connecting to a daemon. Step 13: Define Network Characteristics
CONTINUE Continue expression. Determines if a job should continue. Step 8: Manage a Job's Status Using Control Expressions
CUSTOM_METRIC A machine's relative priority to run jobs. Step 2: Define LoadLeveler Cluster Characteristics
CUSTOM_METRIC_COMMAND An executable whose exit code is value is assigned to CUSTOM_METRIC. Step 2: Define LoadLeveler Cluster Characteristics
DCE_ADMIN_GROUP Specifies the DCE group containing the DCE ids of those users who will have administrator authority for the current cluster. Step 16: Configuring LoadLeveler to use DCE Security Services
DCE_AUTHENTICATION_PAIR A pair of installation supplied programs that are used to authenticate DCE security credentials. Step 17: Specify Additional Configuration File Keywords
DCE_ENABLEMENT Activates the exploitation of DCE security. Step 16: Configuring LoadLeveler to use DCE Security Services
DCE_SERVICES_GROUP Specifies the DCE group containing all of the principal names of the LoadLeveler daemons that are authorized to run in the current cluster. Step 16: Configuring LoadLeveler to use DCE Security Services
DRAIN_ON_SWITCH_TABLE_ERROR Specifies that the startd should be drained when the switch table fails to unload. Step 17: Specify Additional Configuration File Keywords
EXECUTE The local directory to store the executable checkpoints of jobs submitted by other machines. Step 11: Specify Where Files and Directories are Located
FLOATING_RESOURCES Specifies which consumable resources are available collectively on all of the machines in the LoadLeveler cluster. Step 4: Define Consumable Resources
GLOBAL_HISTORY The directory containing the global history files. Step 9: Define Job Accounting
GSMONITOR Location of the gsmonitor executable (LoadL_gsmonitor). The gsmonitor Daemon
GSMONITOR_RUNS_HERE When true, specifies that you want to start the gsmonitor daemon (you must have PSSP Groups Service). The gsmonitor Daemon
HISTORY The pathname of the history file for local LoadLeveler jobs. Step 11: Specify Where Files and Directories are Located
JOB_ACCT_Q_POLICY The amount of time in seconds that determines how often the startd daemon updates the schedd daemon with accounting data of running jobs. Chapter 7, Gathering Job Accounting Data
JOB_EPILOG Pathname of the epilog program. Writing Prolog and Epilog Programs
JOB_LIMIT_POLICY The amount of time in seconds that LoadLeveler checks to see if job_cpu_limit has been exceeded. Chapter 7, Gathering Job Accounting Data
JOB_PROLOG Pathname of the prolog program. Writing Prolog and Epilog Programs
JOB_USER_EPILOG Pathname of the user epilog program. Writing Prolog and Epilog Programs
JOB_USER_PROLOG Pathname of the user prolog program. Writing Prolog and Epilog Programs
KBDD KBDD expression. Location of kbdd executable (Loadl_kbdd). LoadLeveler Daemons
KILL Kill expression. Determines if vacated jobs should be killed. Step 8: Manage a Job's Status Using Control Expressions
LIB The directory where LoadLeveler libraries are kept. Step 11: Specify Where Files and Directories are Located
LOADL_ADMIN List of LoadLeveler administrators. Step 1: Define LoadLeveler Administrators
LOCAL_CONFIG Pathname of the optional local configuration file containing information specific to a node in the LoadLeveler network. Step 11: Specify Where Files and Directories are Located
LOG Local directory for storing log files. Step 11: Specify Where Files and Directories are Located
MACHINE_AUTHENTICATE Specifies whether machine validation is performed. Step 2: Define LoadLeveler Cluster Characteristics
MACHINE_UPDATE_INTERVAL The time, in seconds, during which machines must report to the central manager. Step 17: Specify Additional Configuration File Keywords
MACHPRIO Machine priority expression Step 7: Prioritize the Order of Executing Machines Maintained by the Negotiator
MAIL Name of a local mail program used to override default mail notification. Using Your Own Mail Program
MASTER Location of the master executable (LoadL_master). LoadLeveler Daemons
MASTER_DGRAM_PORT The port number used when connecting to the daemon. Step 13: Define Network Characteristics
MASTER_STREAM_PORT The port number to used when connecting to the daemon. Step 13: Define Network Characteristics
MAX_CKPT_INTERVAL The maximum number of seconds between checkpoints for running jobs. Step 14: Enable Checkpointing
MAX_JOB_REJECT The number of times a job is rejected before it is cancelled or put in User Hold or System Hold status. Step 17: Specify Additional Configuration File Keywords
MAX_STARTERS The maximum number of jobs that can run simultaneously. Step 5: Specify How Many Jobs a Machine Can Run
MIN_CKPT_INTERVAL The minimum number of seconds between checkpoints for running jobs. Step 14: Enable Checkpointing
NEGOTIATOR Location of the negotiator executable (LoadL_negotiator). LoadLeveler Daemons
NEGOTIATOR_INTERVAL The time interval, in seconds, at which the negotiator daemon updates the status of jobs in the LoadLeveler cluster and negotiates with machines that are available to run jobs. Step 17: Specify Additional Configuration File Keywords
NEGOTIATOR_CYCLE_DELAY The time, in seconds, the negotiator delays between periods when it attempts to schedule jobs. This time is used by the negotiator daemon to respond to queries, reorder job queues, collect information about changes in the states of jobs, etc. Delaying the scheduling of jobs might improve the overall performance of the negotiator by preventing it from spending excessive time attempting to schedule jobs. Step 17: Specify Additional Configuration File Keywords
NEGOTIATOR_LOADAVG_ INCREMENT The factor added to the startd machine's load average to compenstate for the increased load caused by starting another machine. Step 17: Specify Additional Configuration File Keywords
NEGOTIATOR_PARALLEL_ DEFER The length of time that a job is given to accumulate processors. Step 17: Specify Additional Configuration File Keywords
NEGOTIATOR_PARALLEL_ HOLD The length of time a job attempts to collect machines before releasing them. Step 17: Specify Additional Configuration File Keywords
NEGOTIATOR_RECALCULATE_ SYSPRIO_INTERVAL The amount of time in seconds between calculation of the SYSPRIO values for waiting jobs. Step 17: Specify Additional Configuration File Keywords
NEGOTIATOR_REJECT_DEFER The amount of time in seconds the negotiator waits before it considers scheduling a job to a machine that recently rejected the job. Step 17: Specify Additional Configuration File Keywords
NEGOTIATOR_REMOVE_COMPLETED The amount of time the negotiator keeps information on completed and removed jobs. Step 17: Specify Additional Configuration File Keywords
NEGOTIATOR_RESCAN_QUEUE The amont of time the negotiator waits to rescan the job queue for machines that temporarily have non-runnable jobs. Step 17: Specify Additional Configuration File Keywords
NEGOTIATOR_STREAM_PORT The port number used when connecting to the daemon. Step 13: Define Network Characteristics
NQS_DIR The directory where NQS commands reside. Step 11: Specify Where Files and Directories are Located
OBITUARY_LOG_LENGTH The number of lines from the ned of the file that are appended to the Master_Log. Step 17: Specify Additional Configuration File Keywords
POLLING_FREQUENCY The frequency in seconds the startd daemon uses to evaluate the load on the local machine and to decide whether to suspend, resume, or abort jobs. Step 17: Specify Additional Configuration File Keywords
POLLS_PER_UPDATE The frequency, in POLLING_FREQUENCY intervals, with which the startd daemon updates the central manager. Step 17: Specify Additional Configuration File Keywords
PROCESS_TRACKING When true ensures that when a job is terminated, no processes created by the job will continue running. Step 15: Specify Process Tracking
PROCESS_TRACKING_EXTENSION The directory containing the kernel extension binary LoadL_pt_ke. Step 15: Specify Process Tracking
PUBLISH_OBITUARIES When true, specifies that the master daemon sends mail to the administrator(s) when any daemon it manages dies abnormally. Step 17: Specify Additional Configuration File Keywords
RELEASEDIR The directory where all the LoadLeveler software resides. Step 11: Specify Where Files and Directories are Located
RESOURCES Specifies quantities of the consumable resources "consumed" by each task of a job step. Step 4: Define Consumable Resources
RESTARTS_PER_HOUR The number of times the master daemon attempts to restart a daemon that dies abnormally. Step 17: Specify Additional Configuration File Keywords
SCHEDD Location of the schedd executable (LoadL_schedd). LoadLeveler Daemons
SCHEDD_INTERVAL Specifies the interval, in seconds, at which the schedd daemon checks the local job queue. Step 17: Specify Additional Configuration File Keywords
SCHEDD_RUNS_HERE Specifies whether this daemon will run on the host. Step 3: Define LoadLeveler Machine Characteristics
SCHEDD_SUBMIT_AFFINITY Specifies whether the llsubmit command submits a job to the machine where the command was invoked provided the schedd daemon is running on the machine. Step 3: Define LoadLeveler Machine Characteristics
SCHEDD_STREAM_PORT The port number used when connecting to the daemon. Step 13: Define Network Characteristics
SCHEDULE_BY_RESOURCES Specifies which consumable resources are considered by the LoadLeveler schedulers. Step 4: Define Consumable Resources
SCHEDULER_API When YES, disables the native LoadLeveler scheduling algorithm. Step 2: Define LoadLeveler Cluster Characteristics
SCHEDULER_TYPE Specifies the LoadLeveler Backfill scheduling algorithm. Step 2: Define LoadLeveler Cluster Characteristics
SPOOL The local directory where LoadLeveler keeps the local job queue and checkpoint files. Step 11: Specify Where Files and Directories are Located
START Start expression. Determines if a machine can run a job. Step 8: Manage a Job's Status Using Control Expressions
STARTD Location of the startd executable (LoadL_startd). LoadLeveler Daemons
STARTER Location of the starter executable (LoadL_starter). LoadLeveler Daemons
STARTD_RUNS_HERE Specifies whether this daemon will run on the host. Step 3: Define LoadLeveler Machine Characteristics
START_DAEMONS Specifies whether to start the daemons on the machine. Step 3: Define LoadLeveler Machine Characteristics
STARTD_DGRAM_PORT The port number used when connecting to the daemon. Step 13: Define Network Characteristics
STARTD_STREAM_PORT The port number used when connecting to the daemon. Step 13: Define Network Characteristics
SUBMIT_FILTER The program you want to run to filter a job script when the job is submitted. Filtering a Job Script
SUSPEND Suspend expresson. Determines if a job should be suspended. Step 8: Manage a Job's Status Using Control Expressions
SYSPRIO System priority expression. Step 6: Prioritize the Queue Maintained by the Negotiator
TRUNC_GSMONITOR_LOG_ON_OPEN When true, specifies that the log file is restarted with every invocation of the daemon. Step 12: Record and Control Log Files
TRUNC_KBDD_LOG_ON_OPEN When true, specifies the log file is restarted with every invocation of the daemon. Step 12: Record and Control Log Files
TRUNC_MASTER_LOG_ON_OPEN When true, specifies the log file is re started with every invocation of the daemon. Step 12: Record and Control Log Files
TRUNC_NEGOTIATOR_LOG_ON_OPEN When true, specifies the log file is restarted with every invocation of the daemon. Step 12: Record and Control Log Files
TRUNC_SCHEDD_LOG_ON_OPEN When true, specifies the log file is restarted with every invocation of the daemon. Step 12: Record and Control Log Files
TRUNC_STARTD_LOG_ON_OPEN When true, specifies the log file is restarted with every invocation of the daemon. Step 12: Record and Control Log Files
TRUNC_STARTER_LOG_ON_OPEN When true, specifies the log file is restarted with every invocation of the daemon. Step 12: Record and Control Log Files
VACATE The vacate expression. Determines whether suspended jobs should be vacated. Step 8: Manage a Job's Status Using Control Expressions
WALLCLOCK_ENFORCE When true, specifies that the wall_clock_limit on the job will be enforced. The WALLCLOCK_ENFORCE keyword is only valid when the External Scheduler is enabled. ***
X_RUNS_HERE When true, specifies that you want to start the keyboard daemon. Step 3: Define LoadLeveler Machine Characteristics

User-Defined Keywords

The following table serves only as a reference. These keywords are described in more detail in User-Defined Variables.
Keyword Brief Description
BackgroundLoad Defines the variable BackgroundLoad and assigns to it a floating point constant. This might be used as a noise factor indicating no activity.
CPU_Busy Defines the variable CPU_Busy and reassigns to it at each evaluation the Boolean value True or False, depending on whether the Berkeley one-minute load average is equal to or greater than the saturation level of 1.5.
CPU_Idle Defines the variable CPU_Idle and reassigns to it at each evaluation the Boolean value True or False, depending on whether the Berkeley one-minute load average is equal or less than 0.7.
HighLoad Is a keyword that the user can define to use as a saturation level at which no further jobs should be started.
HOUR Defines the variable HOUR and assigns to it a constant integer value.
JobLoad Defines the variable JobLoad which defines the load on the machine caused by running the job.
KeyboardBusy Defines the variable KeyboardBusy and reassigns to it at each evaluation the Boolean value True or False, depending on whether the keyboard and mouse have been idle for fifteen minutes.
LowLoad Defines the variable LowLoad and assigns to it the value of BackgroundLoad. This might be used as a restart level at which jobs can be started again and assumes only running 1 job on the machine.
mail Specifies a local program you want to use in place of the LoadLeveler default mail notification method.
MINUTE Defines the variable MINUTE and assigns to it a constant integer value.
StateTimer Defines the variable StateTimer and reassigns to it at each evaluation the number of seconds since the current state was entered.

LoadLeveler Variables

The following table serves only as a reference. For more information on a specific keyword, see the section and page number referenced in the "For Details" column.
Keyword Brief Description For Details
Arch Standard architecture of the system. LoadLeveler Variables
ClassSysprio Job priority for the class. Step 6: Prioritize the Queue Maintained by the Negotiator
Cpus Number of CPU's installed. LoadLeveler Variables
ConsumableCpus Number of ConsumableCpus currently available on the machine, if defined in SCHEDULE_BY_RESOURCES. If not, then it is the same as Cpus. LoadLeveler Variables
ConsumableMemory Amount of ConsumableMemory currently available on the machine, if defined in SCHEDULE_BY_RESOURCES. If not, then it is the same as Memory. LoadLeveler Variables
ConsumableVirtualMemory Amount of ConsumableVirtualMemory currently available on the machine, if defined in SCHEDULE_BY_RESOURCES. If not, then it is the same as VirtualMemory. LoadLeveler Variables
CurrentTime The UNIX date that includes the current system time, in seconds, since January 1, 1970. LoadLeveler Variables
CustomMetric The relative machine priority. LoadLeveler Variables
Disk Free disk in megabytes on the filesystem where checkpoints are stored. LoadLeveler Variables
domain or domainname Dynamically indicates the domain name of the current host machine where the program is running. LoadLeveler Variables
EnteredCurrentState Value of CurrentTime when the current state was entered. LoadLeveler Variables
GroupQueuedJobs The number of jobs either running or queued for the LoadLeveler group. Step 6: Prioritize the Queue Maintained by the Negotiator
GroupRunningJobs The number of jobs currently running for the LoadLeveler group. Step 6: Prioritize the Queue Maintained by the Negotiator
GroupSysprio The job priority for the group. Step 6: Prioritize the Queue Maintained by the Negotiator
GroupTotalJobs The total number of jobs associated with the LoadLeveler group. Step 6: Prioritize the Queue Maintained by the Negotiator
host or hostname Dynamically indicates the name of the host machine where the program is running. LoadLeveler Variables
KeyboardIdle Number of seconds since the keyboard or mouse was last used. LoadLeveler Variables
LoadAvg Berkeley one-minute load average. LoadLeveler Variables
Machine Name of the current machine. LoadLeveler Variables
MasterMachPrio A value that is 1 for master nodes and is 0 otherwise. LoadLeveler Variables
Memory Physical memory installed on the machine in megabytes. LoadLeveler Variables
OpSys Indicates the operating system on the host where the program is running. LoadLeveler Variables
QDate Difference in seconds between when the negotiator starts up and when the job is submitted. LoadLeveler Variables
Speed The relative machine speed. LoadLeveler Variables
State State of the startd. Can be None, Busy, Running, Idle, Suspend, Flush, or Drain. LoadLeveler Variables
tilde Dynamically defines the pathname of the LoadLeveler home directory. LoadLeveler Variables
tm_hour Number of hours since midnight (0-23). LoadLeveler Variables
tm_isdst Daylight Savings Time flag: positive when in effect, zero when not in effect, negative when information is unavailable. LoadLeveler Variables
tm_mday Number of the day of the month (1-31). LoadLeveler Variables
tm_min Number of minutes after the hour (0-59). LoadLeveler Variables
tm_mon Number of months since January (0-11). LoadLeveler Variables
tm_sec Number of seconds after the minute (0-59). LoadLeveler Variables
tm_wday Number of days since Sunday (0-6). LoadLeveler Variables
tm_yday Number of days since January 1 (0-365). LoadLeveler Variables
tm_year Number of years since 1900 (0-9999). LoadLeveler Variables
tm4_year The integer representation of the current year. LoadLeveler Variables
UserPrio User defined priority of a job. Step 6: Prioritize the Queue Maintained by the Negotiator
UserQueuedJobs The number of jobs either running or queued for the user. Step 6: Prioritize the Queue Maintained by the Negotiator
UserRunningJobs The number of jobs currently running for the user. Step 6: Prioritize the Queue Maintained by the Negotiator
UserSysprio The priority of the user who submitted the job. Step 6: Prioritize the Queue Maintained by the Negotiator
UserTotalJobs The total number of jobs associated with the this user. Step 6: Prioritize the Queue Maintained by the Negotiator
VirtualMemory The size of the available swap space on the machine in kilobytes. LoadLeveler Variables


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]