TORQUE Administrator's Manual - Appendix J: qsub wrapper

TORQUE Resource Manager

Appendix J: Job Submission Filter (aka 'qsub Wrapper')*

When a submit filter exists, TORQUE will send the command file (or contents of STDIN if piped to qsub) to that script/executable and allow it to modify the submitted request based on specific site policies. The resulting file is then handed back to qsub and processing continues. This script should read the original submission request from STDIN and report the resulting request to STDOUT as in the following example:

#!/bin/sh

# add default memory constraints to all requests
# that did not specify it in user's script or on command line

echo "#PBS -l mem=16MB"

while read i
  do
    echo $i
  done

Command line arguments passed to qsub are passed as arguments to the submit filter (filter won’t see them in STDIN) in the same order and may be used as needed. It should be noted that as of TORQUE 2.2.0 extended attributes are not passed to the filter. Exit status of -1 will cause qsub to reject the submission with a message stating that it failed due to administrative policies.

The submit filter must be executable, must be available on each of the nodes where users may submit jobs, and by default, must be located at /usr/local/sbin/torque_submitfilter. As of TORQUE 2.2.0, the build process will set the path to “${libexecdir}/qsub_filter”. At run time, if the file does not exist at this new preferred path then qsub will fall back to the old hard-coded path. If needed, the submit filter location can be customized by setting the SUBMITFILTER parameter inside the torque.cfg file, as in the following example:

torque.cfg

SUBMITFILTER /opt/torque/submit.pl
...

*Initial development courtesy of Oak Ridge National Laboratories