ruoyunbai/torque_install
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

1

Browse Source
This commit is contained in:
ruoyunbai
2021-09-29 21:06:16 +08:00
parent b200bb2f20
commit 2bb9621e30
2960 changed files with 642536 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
torque/doc/man8/Makefile.am
+3
View File
@@ -0,0 +1,3 @@
include $(top_srcdir)/buildutils/config.mk
# all work is done in doc/
torque/doc/man8/pbs_mom.8.in
+665
View File
@@ -0,0 +1,665 @@
.\" OpenPBS (Portable Batch System) v2.3 Software License
.\"
.\" Copyright (c) 1999-2000 Veridian Information Solutions, Inc.
.\" All rights reserved.
.\"
.\" ---------------------------------------------------------------------------
.\" For a license to use or redistribute the OpenPBS software under conditions
.\" other than those described below, or to purchase support for this software,
.\" please contact Veridian Systems, PBS Products Department ("Licensor") at:
.\"
.\" www.OpenPBS.org +1 650 967-4675 sales@OpenPBS.org
.\" 877 902-4PBS (US toll-free)
.\" ---------------------------------------------------------------------------
.\"
.\" This license covers use of the OpenPBS v2.3 software (the "Software") at
.\" your site or location, and, for certain users, redistribution of the
.\" Software to other sites and locations. Use and redistribution of
.\" OpenPBS v2.3 in source and binary forms, with or without modification,
.\" are permitted provided that all of the following conditions are met.
.\" After December 31, 2001, only conditions 3-6 must be met:
.\"
.\" 1. Commercial and/or non-commercial use of the Software is permitted
.\" provided a current software registration is on file at www.OpenPBS.org.
.\" If use of this software contributes to a publication, product, or service
.\" proper attribution must be given; see www.OpenPBS.org/credit.html
.\"
.\" 2. Redistribution in any form is only permitted for non-commercial,
.\" non-profit purposes. There can be no charge for the Software or any
.\" software incorporating the Software. Further, there can be no
.\" expectation of revenue generated as a consequence of redistributing
.\" the Software.
.\"
.\" 3. Any Redistribution of source code must retain the above copyright notice
.\" and the acknowledgment contained in paragraph 6, this list of conditions
.\" and the disclaimer contained in paragraph 7.
.\"
.\" 4. Any Redistribution in binary form must reproduce the above copyright
.\" notice and the acknowledgment contained in paragraph 6, this list of
.\" conditions and the disclaimer contained in paragraph 7 in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" 5. Redistributions in any form must be accompanied by information on how to
.\" obtain complete source code for the OpenPBS software and any
.\" modifications and/or additions to the OpenPBS software. The source code
.\" must either be included in the distribution or be available for no more
.\" than the cost of distribution plus a nominal fee, and all modifications
.\" and additions to the Software must be freely redistributable by any party
.\" (including Licensor) without restriction.
.\"
.\" 6. All advertising materials mentioning features or use of the Software must
.\" display the following acknowledgment:
.\"
.\" "This product includes software developed by NASA Ames Research Center,
.\" Lawrence Livermore National Laboratory, and Veridian Information
.\" Solutions, Inc.
.\" Visit www.OpenPBS.org for OpenPBS software support,
.\" products, and information."
.\"
.\" 7. DISCLAIMER OF WARRANTY
.\"
.\" THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. ANY EXPRESS
.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT
.\" ARE EXPRESSLY DISCLAIMED.
.\"
.\" IN NO EVENT SHALL VERIDIAN CORPORATION, ITS AFFILIATED COMPANIES, OR THE
.\" U.S. GOVERNMENT OR ANY OF ITS AGENCIES BE LIABLE FOR ANY DIRECT OR INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
.\" OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
.\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" This license will be governed by the laws of the Commonwealth of Virginia,
.\" without reference to its choice of law rules.
.if \n(Pb .ig Iq
.TH pbs_mom 8B "" Local PBS
.so ../ers/ers.macros
.Iq
.SH NAME
pbs_mom \- start a pbs batch execution mini-server
.SH SYNOPSIS
pbs_mom [\^\-a\ alarm\^] [\^\-C\ chkdirectory\^] [\^\-c\ config\^] [\^\-D\^] [\^\-d\ directory] [\^\-F\^] [\^\-h\ help] [\^\-H\ hostname] [\^\-L\ logfile] [\^\-M\ MOMport\^] [\^\-R\ RPPport\^] [\^\-p\^|\^\-q\^|\^\-r] [\^\-w]
[\^\-x]
.LP
SH DESCRIPTION
The
.B pbs_mom
command starts the operation of a batch \fBM\fPachine \fBO\fPriented
\fBM\fPini\-server, MOM, on the local host.
Typically, this command will be in a local boot file such as
.I /etc/rc.local .
To insure that the pbs_mom
command is not runnable by the general user community, the server
will only execute if its real and effective uid is zero.
.LP
One function of pbs_mom is to place jobs into execution as directed
by the server, establish resource usage limits, monitor the job's usage,
and notify the server when the job completes. If they exist, pbs_mom will
execute a prologue script before executing a job and an epilogue script
after executing the job.
The next function of pbs_mom is to respond to resource monitor requests.
This was done by a separate process in previous versions of PBS but
has now been combined into one process.
The resource monitor function is provided mainly for the PBS scheduler.
It provides information about the status of running jobs, memory available etc.
The next function of pbs_mom is to respond to task manager requests.
This involves communicating with running tasks over a tcp socket
as well as communicating with other MOMs within a job (aka a "sisterhood").
.LP
Pbs_mom will record a diagnostic message in a log file for any
error occurrence. The log files are maintained in the
.I mom_logs
directory below the home directory of the server.
If the log file cannot be opened, the diagnostic message is written
to the system console.
.SH OPTIONS
.IP "\-A alias" 16
Used with \-m (multi-mom option) to give the alias name of this instance
of pbs_mom
.IP "\-a alarm" 16
Specifies the alarm timeout in seconds for computing a resource.
Every time a resource request is processed, an alarm is set for the
given amount of time. If the request has not completed before the
given time, an alarm signal is generated.
The default is 5 seconds.
.IP "\-C chkdirectory" 16
Specifies the path of the directory used to hold checkpoint files.
[Currently this is only valid on Cray systems.]
The default directory is PBS_HOME/spool/checkpoint, see the \-d option.
The directory specified with the \-C option must be owned by root and
accessible (rwx) only by root to protect the security of the checkpoint files.
.IP "\-c config" 16
Specifies an alternative configuration file, see description below.
If this is a relative file name it will be relative to PBS_HOME/mom_priv,
see the \-d option. If the specified file cannot be opened, pbs_mom will abort.
If the \-c option is not supplied, pbs_mom will attempt to open the default
configuration file "config" in PBS_HOME/mom_priv. If this file is not
present, pbs_mom will log the fact and continue.
.IP "\-h help" 16
Displays the help/usage message.
.IP "\-H hostname" 16
Sets the MOM's hostname. This can be useful on multi-homed networks.
.IP "\-D" 16
Debug mode. Do not fork.
.IP "\-d directory" 16
Specifies the path of the directory which is the home of the servers
working files, PBS_HOME.
This option is typically used along with \-M when debugging MOM.
The default directory is given by $PBS_SERVER_HOME
which is typically
.Ty /usr/spool/PBS .
.IP "\-F" 16
Do not fork. Use when running under systemd.
.IP "\-L logfile" 16
Specifies an absolute path name for use as the log file.
If not specified, MOM will
open a file named for the current date in the PBS_HOME/mom_logs
directory, see the
.At \-d
option.
.IP "\-m" 16
Directs the MOM to start in multi-mom mode. In addition to using -m the
\-M, \-R and \-A options need to be used to properly start a MOM in multi-mom mode.
For example
.B pbs_mom -m -M 30002 -R 30003 -A alias-host
will start pbs_mom with the service port on port 30002, the manager port at 30003 and with
the name alias-host.
.IP "\-M port" 16
Specifies the port number on which the mini-server (MOM) will
listen for batch requests.
.IP "\-R port" 16
Specifies the port number on which the mini-server (MOM) will
listen for resource monitor requests, task manager requests and inter-MOM
messages.
.IP "\-p" 16
(Default after version 2.4.0) (Preserve running jobs) -- Specifies the
impact on jobs which were in execution when the mini-server shut-down.
The \-p option tries to preserve any running jobs when the MOM restarts.
The new mini-server will not be the parent of any running jobs, MOM
has lost control of her offspring (not a new situation for a mother).
The MOM will allow the jobs to continue to run and monitor them
indirectly via polling. All recovered jobs will report an exit code
of 0 when they are complete. The \-p option is mutually exclusive with
the \-r, \-P and \-q options.
.IP "\-P" 16
(Terminate all jobs and remove them from the queue) -- Specifies the impact
on jobs which were in execution when the mini-server shut-down.
With the \-P option, it is assumed that either the entire system
has been restarted or the MOM has been down so long that it can no longer
guarantee that the pid of any running process is the same as the recorded job
process pid of a recovering job. Unlike the \-p option no attempt is made to
try and preserve or recover running jobs. All jobs are terminated and removed
from the queue.
The \-q option is mutually exclusive with the \-p, \-q and \-r options.
.IP "\-q" 16
(Requeue all jobs - This is the default behavior in versions prior
to 2.4.0) -- Specifies the impact on jobs which were in execution when
the mini-servershut-down. Do not terminate running processes.
With the \-q option, it is assumed that either the entire system
has been restarted or the MOM has been down so long that it can no longer
guarantee that the pid of any running process is the same as the recorded job
process pid of a recovering job. No attempt is made to kill job processes.
The MOM will mark the jobs as terminated and notify the batch server which
owns the job. Re-runnable jobs will be requeued.
The \-q option is mutually exclusive with the \-p, \-P and \-r options.
.IP "\-r" 16
(Terminate running processes and requeue all jobs) -- Specifies the impact on jobs
which were in execution when the mini-server shut-down. With the \-r option,
MOM will kill any processes belonging to running jobs, mark the jobs as
terminated and notify the batch server that owns the job. Re-runnable jobs are reset
to a queued state so they can be run again.
The \-r option is mutually exclusive with the \-p, \-P and \-q options.
.IP
If the \-r option is used following a reboot,
process IDs (pids) may be reused and
MOM may kill a process that is not a batch session.
.IP "\-S port" 16
Specifies the port number on which the pbs_server is listening for requests.
If pbs_server is started with a \-p option, pbs_mom will need to use the \-S
option and match the port value which was used to start pbs_server.
.IP "\-w" 16
When started with -w, pbs_moms wait until they get their MOM hierarchy file from pbs_server to send their first update, or until 10 minutes pass. This reduces network traffic on startup and can bring up clusters faster.
.IP "\-x" 16
Disables the check for privileged port resource monitor connections. This is
used mainly for testing since the privileged port is the only
mechanism used to prevent any ordinary user from connecting.
.LP
.SH CONFIGURATION FILE
The configuration file may be specified on the command line at
program start with the \-c flag. The use of this file is
to provide several types of run time information to pbs_mom:
static resource names and values, external resources provided
by a program to be run on request via a shell escape, and values
to pass to internal set up functions at initialization
(and re-initialization).
.LP
Each item type is on a single line with the component parts separated by
white space. If the line starts with a hash mark (pound sign, #),
the line is considered to be a comment and is skipped.
.IP "Static Resources"
For static resource names and values, the configuration file contains a
list of resource names/values pairs, one pair per line and separated by
white space. An Example of static resource names and values could be
the number of tape drives of different types and could be specified by
.IP
.Ty "tape3480 4"
.br
.Ty "tape3420 2"
.br
.Ty "tapedat 1"
.br
.Ty "tape8mm 1"
.IP "Shell Commands"
If the first character of the value is an exclamation mark (!),
the entire rest of the line is saved to be executed through the services of
the \fBsystem\fP(3) standard library routine.
.IP
The shell escape provides a means for the resource monitor to yield
arbitrary information to the scheduler. Parameter substitution is
done such that the value of any qualifier sent with the query, as
explained below, replaces a token with a percent sign (%) followed
by the name of the qualifier. For example, here is a configuration file
line which gives a resource name of "escape":
.IP
.Ty "escape !echo %xxx %yyy"
.IP
If a query for "escape" is sent with no qualifiers, the command
executed would be "echo %xxx %yyy". If one qualifier is sent,
"escape[xxx=hi there]", the command executed would be "echo hi there %yyy".
If two qualifiers are sent, "escape[xxx=hi][yyy=there]", the command
executed would be "echo hi there". If a qualifier is sent with
no matching token in the command line, "escape[zzz=snafu]", an error
is reported.
.IP size[fs=<FS>]
Specifies that the available and configured disk space in the <FS> filesystem
is to be reported to the pbs_server and scheduler. NOTE: To request disk space
on a per job basis, specify the file resource as in 'qsub \-l
nodes=1,file=1000kb' For example, the available and configured disk space in
the /localscratch filesystem will be reported:
.IP
.Ty "size[fs=/localscratch]"
.br
.IP "Initialization Value"
An initialization value directive has a name which starts with a
dollar sign ($) and must be known to MOM via an internal table.
The entries in this table now are:
.RS
.IP auto_ideal_load
if jobs are running, sets idea_load based on a simple expression. The expressions
start with the variable 't' (total assigned CPUs) or 'c' (existing CPUs), an
operator (+ \- / *), and followed by a float constant.
.IP
.Ty "$auto_ideal_load t-0.2"
.br
.IP auto_max_load
if jobs are running, sets max_load based on a simple expression. The expressions
start with the variable 't' (total assigned CPUs) or 'c' (existing CPUs), an
operator (+ \- / *), and followed by a float constant.
.IP cputmult
which sets a factor used to adjust cpu time used by a job. This is provided
to allow adjustment of time charged and limits enforced where the job might
run on systems with different cpu performance.
If Mom's system is faster than the reference system, set cputmult to a decimal
value greater than 1.0. If Mom's system is slower, set cputmult to a value
between 1.0 and 0.0.
For example:
.IP
.Ty "$cputmult 1.5
.br
.Ty "$cputmult 0.75
.IP configversion
specifies the version of the config file data, a string.
.IP check_poll_time
specifies the MOM interval in seconds. MOM checks each job for updated
resource usages, exited processes, over-limit conditions, etc. once per
interval. This value should be equal or lower to pbs_server's job_stat_rate.
High values result in stale information reported to pbs_server. Low values
result in increased system usage by MOM. Default is 45 seconds.
.IP down_on_error
causes MOM to report itself as state "down" to pbs_server in the event of a
failed health check. This feature is EXPERIMENTAL and likely to be removed in
the future. See HEALTH CHECK below.
.IP enablemomrestart
enable automatic restarts of MOM. If enabled, MOM will check if its binary has
been updated and restart itself at a safe point when no jobs are running; thus
making upgrades easier. The check is made by comparing the mtime of the
pbs_mom executable. Command-line args, the process name, and the PATH env
variable are preserved across restarts. It is recommended that this not be
enabled in the config file, but enabled when desired with momctl (see RESOURCES
for more information.)
.IP ideal_load
ideal processor load. Represents a low water mark for the load average. Nodes
that are currently busy will consider itself free after falling below ideal_load.
.IP igncput
Ignore cpu time violations on this mom, meaning jobs will not be cancelled due to exceeding their limits for cpu time.
.IP ignmem
Ignore memory violations on this mom, meaning jobs will not be cancelled due to exceeding their memory limits.
.IP ignvmem
If set to true, then pbs_mom will ignore vmem/pvmem limit enforcement.
.IP ignwalltime
If set to true, then pbs_mom will ignore walltime limit enforcement.
.IP job_output_file_mask
Specifies a mask for creating job output and error files. Values can be specified in base 8, 10, or 16; leading 0 implies octal and leading 0x or 0X hexadecimal. A value of "userdefault" will use the user's default umask.
.Ty "$job_output_file_mask 027"
.br
.IP log_directory
Changes the log directory. Default is $TORQUEHOME/mom_logs/. $TORQUEHOME default is /var/spool/torque/ but can be changed in the ./configure script. The value is a string and should be the full path to the desired mom log directory.
.Ty "$log_directory /opt/torque/mom_logs/"
.br
.IP logevent
which sets the mask that determines which event types are logged by pbs_mom.
For example:
.IP
.Ty "$logevent 0x1fff"
.br
.Ty "$logevent 255"
.IP
The first example would set the log event mask to 0x1ff (511) which enables
logging of all events including debug events. The second example would set
the mask to 0x0ff (255) which enables all events except debug events.
.IP log_file_suffix
Optional suffix to append to log file names. If %h is the suffix, pbs_mom appends the hostname for where the log files are stored if it knows it, otherwise it will append the hostname where the mom is running.
.Ty "$log_file_suffix tom = 20100223.tom"
.br
.IP log_keep_days
Specifies how many days to keep log files. pbs_mom deletes log files older than the specified number of days. If not specified, pbs_mom won't delete log files based on their age.
.IP loglevel
specifies the verbosity of logging with higher numbers specifying more verbose
logging. Values may range between 0 and 7.
.IP log_file_max_size
If this is set to a value > 0 then pbs_mom will roll the
current log file to log-file-name.1 when its size is greater than
or equal to the value of log_file_max_size. This value is
interpreted as kilobytes.
.
.IP log_file_roll_depth
If this is set to a value >=1 and log_file_max_size is set
then pbs_mom will continue rolling the log files to
log-file-name.log_file_roll_depth.
.
.IP max_load
maximum processor load. Nodes over this load average are considered busy (see
ideal_load above).
.
.IP memory_pressure_threshold
The option is only available, if pbs_mom is enabled to use cpusets.
If set to a value > 0, a job gets killed if its memory pressure exceeds
this value, and if $memory_pressure_duration is set.
The default is 0 (memory pressure recording is off).
.br
See cpuset(7) for more information about memory pressure.
.IP memory_pressure_duration
The option is only available, if pbs_mom is enabled to use cpusets.
Specifies the number of subsequent MOM intervals a job's memory pressure must be
above $memory_pressure_threshold to get killed.
The default is 0 (jobs are never killed due to memory pressure).
set
.br
See cpuset(7) for more information about memory pressure.
.
.IP node_check_script
specifies the fully qualified pathname of the health check script to run (see
HEALTH CHECK for more information).
.IP node_check_interval
specifies when to run the MOM health check. The check can be either periodic,
event-driver, or both. The value starts with an integer specifying the number
of MOM intervals between subsequent executions of the specified health check.
After the integer is an optional comma-separated list of event names.
Currently supported are "jobstart" and "jobend". This value defaults to 1 with
no events indicating the check is run every MOM interval. (see HEALTH CHECK for
more information)
.IP
.Ty "$node_check_interval 0 #Disabled."
.br
.Ty "$node_check_interval 0,jobstart #Only runs at job starts"
.br
.Ty "$node_check_interval 10,jobstart,jobend"
.IP
.IP nodefile_suffix
Specifies the suffix to append to a host names to denote the data channel network adapter in a multihomed compute node.
.Ty "$nodefile_suffix i"
With the suffix of 'i' and the control channel adapter with the name node01, the data channel would have a hostname of node01i.
.IP nospool_dir_list
If the job's output file should be in one of the paths specified here, then it will be spooled directly in that directory instead of the normal spool directory.
.br
Specified in the format path1, path2, etc.
.Ty $nospool_dir_list /home/mike/*,/var/tmp/spool/
.IP pbsclient
which causes a host name to be added to the list of hosts which will be allowed
to connect to MOM as long as they are using a privilaged port for the purposes
of resource monitor requests.
For example, here are two
configuration file lines which will allow the hosts "fred" and "wilma"
to connect:
.IP
.Ty "$pbsclient fred"
.br
.Ty "$pbsclient wilma"
.IP
Two host name are always allowed to connection to pbs_mom, "localhost" and the
name returned to pbs_mom by the system call gethostname(). These names need
not be specified in the configuration file. The hosts listed as "clients" can
issue Resource Monitor (RM) requests. Other MOM nodes and servers do not need
to be listed as clients.
.IP pbsserver
which defines hostnames running pbs_server that will be allowed to
submit jobs, issue Resource Monitor (RM) requests, and get status updates. MOM
will continually attempt to contact all server hosts for node status and state
updates. Like $PBS_SERVER_HOME/server_name, the hostname may be followed by a
colon and a port number. This parameter replaces the oft-confused $clienthost
parameter from TORQUE 2.0.0p0 and earlier. Note that the hostname in
$PBS_SERVER_HOME/server_name is used if no $pbsserver parameters are found
.IP prologalarm
Specifies maximum duration (in seconds) which the MOM will wait for the job prolog
or job job epilog to complete. This parameter default to 300 seconds (5 minutes)
.IP rcpcmd
Specify the the full path and argument to be used for remote file copies. This overrides
the compile-time default found in configure. This must contain 2 words: the full path to
the command and the switches. The copy command must be able to recursively copy files to
the remote host and accept arguments of the form "user@host:files" For example:
.IP
.Ty "$rcpcmd /usr/bin/rcp \-rp
.br
.Ty "$rcpcmd /usr/bin/scp \-rpB
.IP restricted
which causes a host name to be added to the list of hosts which will be allowed
to connect to MOM without needing to use a privilaged port. These names
allow for wildcard matching. For example, here is a configuration file
line which will allow queries from any host from the domain "ibm.com".
.IP
.Ty "$restricted *.ibm.com"
.IP
The restriction which applies to these connections is that only
internal queries may be made. No resources from a config file
will be found. This is to prevent any shell commands from being
run by a non-root process.
.br
This parameter is generally not required except for some versions of OSX.
.IP remote_checkpoint_dirs
Specifies what server checkpoint directories are remotely mounted. This directive is used to
tell the MOM which directories are shared with the server. Using remote checkpoint directories eliminates the need to copy the checkpoint files back and forth between the MOM and the server. This parameter is available in 2.4.1 and later.
.IP
.Ty "$remote_checkpoint_dirs /var/spool/torque/checkpoint"
.IP remote_reconfig
Enables the ability to remotely reconfigure pbs_mom with a new config file.
Default is disabled. This parameter accepts various forms of true, yes, and 1.
.IP source_login_batch
Specifies whether or not mom will source the /etc/profile, etc. type files for batch jobs. Parameter accepts various forms of true, false, yes, no, 1 and 0. Default is True.
.IP source_login_interactive
Specifies whether or not mom will source the /etc/profile, etc. type files for interactive jobs. Parameter accepts various forms of true, false, yes, no, 1 and 0. Default is True.
.IP spool_as_final_name
If set to true, jobs will spool directly as their output files, with no intermediate locations or steps. This is mostly useful for shared filesystems with fast writing capability.
.IP status_update_time
Specifies (in seconds) how often MOM updates its status information to
pbs_server. This value should correlate with the server's scheduling interval.
High values increase the load of pbs_server and the network. Low values cause
pbs_server to report stale information. Default is 45 seconds.
.IP tmpdir
Sets the directory basename for a per-job temporary directory. Before job
launch, MOM will append the jobid to the tmpdir basename and create the
directory. After the job exit, MOM will recursively delete it. The env
variable TMPDIR will be set for all pro/epilog scripts, the job script, and TM
tasks.
.br
Directory creation and removal is done as the job owner and group, so the owner
must have write permission to create the directory. If the directory already
exists and is owned by the job owner, it will not be deleted after the job. If
the directory already exists and is NOT owned by the job owner, the job start
will be rejected.
.IP timeout
Specifies the number of seconds before TCP messages will time out. TCP messages include job obituaries, and TM requests if RPP is disabled.
Default is 60 seconds.
.IP usecp
specifies which directories should be staged with cp instead of rcp/scp. If a
shared filesystem is available on all hosts in a cluster, this directive is used to
make these filesystems known to MOM. For example, if /home is NFS mounted on
all nodes in a cluster:
.IP
.Ty "$usecp *:/home /home"
.br
.IP varattr
This is similar to a shell escape above, but includes a TTL. The command will
only be run every TTL seconds. A TTL of \-1 will cause the command to be
executed only once. A TTL of 0 will cause the command to be run everytime
varattr is requested. This parameter may be used multiple times, but all
output will be grouped into a single "varattr" attribute in the request and
status output. The command should output data in the form of
.Ty varattrname=va1ue1[+value2]...
.IP
.Ty "$varattr 3600 /path/to/script [<ARGS>]..."
.IP use_smt
This option is only available, if pbs_mom is enabled to use cpusets.
It has only effect, if there are more that one logical processor per physical
core in the system (simultaneous multithreading or hyperthreading is enabled
via BIOS settings).
If set to true, all logical processors of allocated cores are added to the cpuset
of a job. If set to false, only the first logical processor per allocated core
is contained in the cpuset of a job.
The default is true.
.IP wallmult
which sets a factor used to adjust wall time usage by to job to a common
reference system. The factor is used for walltime calculations and limits
the same as cputmult is used for cpu time.
.RE
.LP
The configuration file must be executable and "secure". It must be owned by a user id and
group id less than 10 and not be world writable. Output from this file must be in
the format $VAR=$VAL, i.e.,
.IP
.Ty dataset13=20070104
.br
.Ty dataset22=20070202
.br
.Ty viraltest=abdd3
.LP
.IP xauthpath
Specifies the path to the xauth binary to enable X11 fowarding.
.IP mom_host
Sets the local hostname as used by pbs_mom.
.br
.SH LAYOUT FILE
There is also an optional layout file for creating multiple moms on one box in a specified layout. In the file, each mom on the single box is given its own hostname, cpu indexes, memory nodes (a linux construct), and memory size. This is useful for NUMA systems. Each line in the file specifies one mom. The file follows the following format:
.IP "<hostname> cpus=<X> mem=<Y> memsize=<Z>"
cpus and mem can be comma separated lists, while memsize should be a memory size in the format:
.IP "<number><units>"
For example, a file could contain the following line:
.IP "foohost-1 cpus=1,2 mem=1,2,3,4 memsize=8GB"
This would specify that foohost-1 has cpus 1 and 2, memory nodes 1-4, and a total of 8 GB of memory.
.SH RESOURCES
Resource Monitor queries can be made with momctl's \-q option to retrieve and
set pbs_mom options. Any configured static resource may be retrieved with a
request of the same name. These are resource requests not otherwise documented
in the PBS ERS.
.IP cycle
forces an immediate MOM cycle
.IP status_update_time
retrieve or set the $status_update_time parameter
.IP check_poll_time
retrieve or set the $check_poll_time parameter
.IP configversion
retrieve the config version
.IP jobstartblocktime
retrieve or set the $jobstartblocktime parameter
.IP enablemomrestart
retrieve or set the $enablemomrestart parameter
.IP loglevel
retrieve or set the $loglevel parameter
.IP down_on_error
retrieve or set the EXPERIMENTAL $down_on_error parameter
.IP "diag0 \- diag4"
retrieves various diagnostic information
.IP rcpcmd
retrieve or set the $rcpcmd parameter
.IP version
retrieves the pbs_mom version
.SH HEALTH CHECK
The health check script is executed directly by the pbs_mom daemon under the
root user id. It must be accessible from the compute node and may be a script
or compiled executable program. It may make any needed system calls and execute
any combination of system utilities but should not execute resource manager
client commands. Also, as of TORQUE 1.0.1, the pbs_mom daemon blocks until the
health check is completed and does not possess a built-in timeout.
Consequently, it is advisable to keep the launch script execution time short
and verify that the script will not block even under failure conditions.
.LP
If the script detects a failure, it should return the keyword 'ERROR' to stdout
followed by an error message. The message (up to 256 characters) immediately
following the ERROR string will be assigned to the node attribute 'message' of
the associated node.
.LP
If the script detects a failure when run from "jobstart", then the job will be
rejected. This should probably only be used with advanced schedulers like Moab
so that the job can be routed to another node.
.LP
TORQUE currently ignores ERROR messages by default, but advanced schedulers
like moab can be configured to react appropriately.
.LP
If the experimental $down_on_error MOM setting is enabled, MOM will set itself
to state down and report to pbs_server; and pbs_server will report the node as
"down". Additionally, the experimental "down_on_error" server attribute can be
enabled which has the same effect but moves the decision to pbs_server. It is
redundant to have MOM's $down_on_error and pbs_server's down_on_error features
enabled. See "down_on_error" in pbs_server_attributes(7B).
.LP
.SH FILES
.IP $PBS_SERVER_HOME/server_name
contains the hostname running pbs_server.
.IP $PBS_SERVER_HOME/mom_priv 10
the default directory for configuration files, typically
(/usr/spool/pbs)/mom_priv.
.IP $PBS_SERVER_HOME/mom_logs 10
directory for log files recorded by the server.
.IP $PBS_SERVER_HOME/mom_priv/prologue 10
the administrative script to be run before job execution.
.IP $PBS_SERVER_HOME/mom_priv/epilogue 10
the administrative script to be run after job execution.
.SH SIGNAL HANDLING
pbs_mom handles the following signals:
.IP SIGHUP
causes pbs_mom to re-read its configuration file, close and reopen the log
file, and reinitialize resource structures.
.IP SIGALRM
results in a log file entry. The signal is used to limit the time taken by
certain children processes, such as the prologue and epilogue.
.IP "SIGINT and SIGTERM"
results in pbs_mom exiting without terminating any running jobs.
This is the action for the following signals as well: SIGXCPU, SIGXFSZ,
SIGCPULIM, and SIGSHUTDN.
.IP "SIGUSR1, SIGUSR2"
causes MOM to increase and decrease logging levels, respectively.
.IP "SIGPIPE, SIGINFO"
are ignored.
.IP "SIGBUS, SIGFPE, SIGILL, SIGTRAP, and SIGSYS"
cause a core dump if the PBSCOREDUMP environmental variable is defined.
.LP
All other signals have their default behavior installed.
.SH EXIT STATUS
If the mini-server command fails to begin operation, the
server exits with a value greater than zero.
.SH SEE ALSO
pbs_server(8B), pbs_scheduler_basl(8B), pbs_scheduler_tcl(8B),
the PBS External Reference Specification, and the PBS Administrator's Guide.
.\" turn off any extra indent left by the Sh macro
torque/doc/man8/pbs_sched_basl.8.in
+515
View File
@@ -0,0 +1,515 @@
.\" OpenPBS (Portable Batch System) v2.3 Software License
.\"
.\" Copyright (c) 1999-2000 Veridian Information Solutions, Inc.
.\" All rights reserved.
.\"
.\" ---------------------------------------------------------------------------
.\" For a license to use or redistribute the OpenPBS software under conditions
.\" other than those described below, or to purchase support for this software,
.\" please contact Veridian Systems, PBS Products Department ("Licensor") at:
.\"
.\" www.OpenPBS.org +1 650 967-4675 sales@OpenPBS.org
.\" 877 902-4PBS (US toll-free)
.\" ---------------------------------------------------------------------------
.\"
.\" This license covers use of the OpenPBS v2.3 software (the "Software") at
.\" your site or location, and, for certain users, redistribution of the
.\" Software to other sites and locations. Use and redistribution of
.\" OpenPBS v2.3 in source and binary forms, with or without modification,
.\" are permitted provided that all of the following conditions are met.
.\" After December 31, 2001, only conditions 3-6 must be met:
.\"
.\" 1. Commercial and/or non-commercial use of the Software is permitted
.\" provided a current software registration is on file at www.OpenPBS.org.
.\" If use of this software contributes to a publication, product, or service
.\" proper attribution must be given; see www.OpenPBS.org/credit.html
.\"
.\" 2. Redistribution in any form is only permitted for non-commercial,
.\" non-profit purposes. There can be no charge for the Software or any
.\" software incorporating the Software. Further, there can be no
.\" expectation of revenue generated as a consequence of redistributing
.\" the Software.
.\"
.\" 3. Any Redistribution of source code must retain the above copyright notice
.\" and the acknowledgment contained in paragraph 6, this list of conditions
.\" and the disclaimer contained in paragraph 7.
.\"
.\" 4. Any Redistribution in binary form must reproduce the above copyright
.\" notice and the acknowledgment contained in paragraph 6, this list of
.\" conditions and the disclaimer contained in paragraph 7 in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" 5. Redistributions in any form must be accompanied by information on how to
.\" obtain complete source code for the OpenPBS software and any
.\" modifications and/or additions to the OpenPBS software. The source code
.\" must either be included in the distribution or be available for no more
.\" than the cost of distribution plus a nominal fee, and all modifications
.\" and additions to the Software must be freely redistributable by any party
.\" (including Licensor) without restriction.
.\"
.\" 6. All advertising materials mentioning features or use of the Software must
.\" display the following acknowledgment:
.\"
.\" "This product includes software developed by NASA Ames Research Center,
.\" Lawrence Livermore National Laboratory, and Veridian Information
.\" Solutions, Inc.
.\" Visit www.OpenPBS.org for OpenPBS software support,
.\" products, and information."
.\"
.\" 7. DISCLAIMER OF WARRANTY
.\"
.\" THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. ANY EXPRESS
.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT
.\" ARE EXPRESSLY DISCLAIMED.
.\"
.\" IN NO EVENT SHALL VERIDIAN CORPORATION, ITS AFFILIATED COMPANIES, OR THE
.\" U.S. GOVERNMENT OR ANY OF ITS AGENCIES BE LIABLE FOR ANY DIRECT OR INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
.\" OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
.\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" This license will be governed by the laws of the Commonwealth of Virginia,
.\" without reference to its choice of law rules.
.de BP
.ie '\\n(.z'' .bp \\$1
.el \!.BP \\$1
..
.if \n(Pb .ig Iq
.TH pbs_scheduler_basl 8B "" Local PBS
.so ../ers/ers.macros
.Iq
.SH NAME
pbs_sched_basl \- pbs BASL scheduler
.SH SYNOPSIS
pbs_sched\ [\^\-d home\^] [\^\-L logfile\^] [\^\-p print_file\^]
[\^\-a alarm\^] [\^\-S port\^] [\^\-c configfile\^]
.SH DESCRIPTION
The
.B pbs_sched
command starts the operation of a batch scheduler on the local host.
It runs in conjunction with the PBS server. It queries the
server about the state of PBS and communicates with
.B pbs_mom
to get information about the status of running jobs, memory available etc.
It then makes decisions as to what jobs to run.
.LP
Typically, this command will be in a local boot file such as
.I /etc/rc.local .
.LP
pbs_sched must be executed with root permission.
.SH OPTIONS
.IP "\-d home"
Specifies the name of the PBS home directory, PBS_HOME.
If not specified, the value
of $PBS_SERVER_HOME as defined at compile time is used. Also see the \-L
option.
.IP "\-L logfile" 5
Specifies an absolute path name of the file to use as the log file.
If not specified, the scheduler will
open a file named for the current date in the PBS_HOME/sched_logs directory.
See the \-d option.
.IP "\-p print_file" 5
This specifies the "print" file. Any output from the scheduler code which is
written to standard out or standard error will be written to this file.
If this option is not given, the file used will be
$PBS_HOME/sched_priv/sched_out. See the \-d option.
.IP "\-a alarm" 5
This specifies the time in seconds to wait for a schedule run to finish. If a
scheduling iteration takes too long to finish, an alarm signal is sent, and
the scheduler is restarted. If a core file does not exist in the current
directory, abort() is called and a core file is generated. The default for
alarm is 180 seconds.
.IP "\-S port" 5
Specifies a port on which to talk to the server. This option is not
required. It merely overides the default PBS scheduler port.
.IP "\-c configfile" 5
Specify a configuration file, see description below. If this is a relative
file name it will be relative to PBS_HOME/sched_priv, see the \-d option.
If the \-c option is not supplied, pbs_sched will not attempt to open a
configuration file. In BASL, this config file is almost always needed because
it is where the list of servers, nodes, and host resource queries are specified by the administrator.
.LP
.SH USAGE
This version of the scheduler requires knowledge of the BASL language. The
site must first write a function called
.I sched_main()
(and all functions supporting it) using BASL constructs, and then translate the
functions into C using the BASL compiler
.I "basl2c",
which would also attach a
main program to the resulting code. This main program performs general
initialization and housekeeping chores such as setting up local socket to
communicate with the server running on the same machine, cd-ing to the priv
directory, opening log files, opening configuration file (if any), setting up
locks, forking the child to become a daemon, initializing a scheduling cycle
(i.e. get node attributes that are static in nature), setting up the signal
handlers, executing global initialization assignment statements specified by
the scheduler writer, and finally sitting on a loop waiting for a scheduling
command from the server. When the server sends the scheduler an appropriate
scheduling command
.Sc "SCH_SCHEDULE_NEW, SCH_SCHEDULE_TERM, SCH_SCHEDULE_TIME, SCH_SCHEDULE_RECYC, SCH_SCHEDULE_CMD, SCH_SCHEDULE_FIRST",
information about server(s), jobs, queues, and execution host(s) are obtained,
and then
.I sched_main()
is called.
.SH SCHEDULING LANGUAGE
The BAtch Scheduling Language (BASL) is a C-like procedural language. It
provides a number
of constructs and predefined functions that facilitate dealing with
scheduling issues. Information about a PBS server, the queues that it owns,
jobs residing on each queue, and the computational nodes where jobs can be run,
are accessed via the BASL data types Server, Que, Job, CNode, Set Server,
Set Que, Set Job, and Set CNode.
.LP
The following
simple sched_main() will cause the server to run all queued jobs on the
local server:
.IP
.Ty
.nf
sched_main()
{
Server s;
Que q;
Job j;
Set Que queues;
Set Job jobs;
s = AllServersLocalHostGet(); // get local server
queues = ServerQueuesGet(s);
foreach( q in queues ) {
jobs = QueJobsGet(q);
foreach( j in jobs ) {
JobAction(j, SYNCRUN, NULLSTR);
}
}
}
.fi
.LP
For a more complete discussion of the Batch Scheduler Language, see
.B "basl2c(1B)".
.SH CONFIGURATION FILE
A configuration file may be specified with the \-c option.
This file is used to specify the (1) hosts which are allowed to
connect to pbs_sched, (2) the list of server hosts for which the scheduler
writer wishes the system to periodically check for status, queues, and jobs
info, (3) list of execution hosts for which the scheduler writer wants the
system to periodically check for information like state, property, and so on,
and (4) various queries to send to each execution host.
.IP "(1) specifying client hosts:" 6
The hosts allowed to connect to pbs_sched are specified in the configuration
file in a manner identical to that used in pbs_mom. There is one line per
host using the syntax:
.sp
.Ty "$clienthost hostname"
.sp
where
.Ty clienthost
and
.Ty hostname
are separated by white space.
Two host names are always allowed to connection to pbs_sched: "localhost"
and the name returned to pbs_sched by the system call gethostname(). These
names need not be specified in the configuration file.
.IP "(2) specifying list of servers:" 6
The list of servers is specified in a one host per line manner, using the
syntax:
.sp
.Ty "$serverhost hostname port_number"
.br
or
where
.Ty $server_host,
.Ty hostname,
and
.Ty port_number
are separated by white space.
.sp
If
.Ty port_number
is 0, then the default PBS server port will be used.
.sp
Regardless of what has been specified in the file, the list of servers
will always include the local server \- one running on the same host where
the scheduler is running.
.sp
Within the BASL code, access to data of the list of servers is done by calling
.I AllServersGet(),
or
.I AllServersLocalHostGet()
which returns the local server on the list.
.IP "(3) specifying the list of execution hosts:" 6
The list of execution hosts (nodes), whose MOMs are to be queried from the
scheduler, is specified in a one host per line manner,
using the syntax:
.sp
.Ty "$momhost hostname port_number"
.sp
where
.Ty $momhost,
.Ty hostname,
and
.Ty port_number
are separated by white space.
.sp
If
.Ty port_number
is 0, then the default PBS MOM port will be used.
.sp
The BASL function
.I AllNodesGet()
, or
.I ServerNodesGet(AllServersLocalHostGet())
is available for getting the list of nodes known to the local system.
.IP "(4) specifying the list of host resources:"
For specifying the list of host resource queries to send to each execution
host's MOM, the following syntax is used:
.sp
.Ty "$node node_name CNode..Get host_resource
.sp
.Ty node_name
should be the same hostname string that was specified in a
.Ty $momhost
line. A
.Ty node_name
value of "*" (wildcard) means to match any node.
.sp
Please consult section 9 of the PBS ERS (Resource Monitor/Resources) for a
list of possible values to
.Ty host_resource
parameter.
.sp
.Ty CNode..Get
refers to the actual function name that is called from the
scheduler code to obtain the return values to host resource queries.
The list of
.Ty CNode..Get
function names that can appear in the configuration file are:
.BP
.ft 3
.nf
STATIC:
================================
CNodePropertiesGet
CNodeVendorGet
CNodeNumCpusGet
CNodeOsGet
CNodeMemTotalGet[type]
CNodeNetworkBwGet[type]
CNodeSwapSpaceTotalGet[name]
CNodeDiskSpaceTotalGet[name]
CNodeDiskInBwGet[name]
CNodeDiskOutBwGet[name]
CNodeTapeSpaceTotalGet[name]
CNodeTapeInBwGet[name]
CNodeTapeOutBwGet[name]
CNodeSrfsSpaceTotalGet[name]
CNodeSrfsInBwGet[name]
CNodeSrfsOutBwGet[name]
DYNAMIC:
================================
CNodeIdletimeGet
CNodeLoadAveGet
CNodeMemAvailGet[type]
CNodeSwapSpaceAvailGet[name]
CNodeSwapInBwGet[name]
CNodeSwapOutBwGet[name]
CNodeDiskSpaceReservedGet[name]
CNodeDiskSpaceAvailGet[name]
CNodeTapeSpaceAvailGet[name]
CNodeSrfsSpaceReservedGet[name]
CNodeSrfsSpaceAvailGet[name]
CNodeCpuPercentIdleGet
CNodeCpuPercentSysGet
CNodeCpuPercentUserGet
CNodeCpuPercentGuestGet
.fi
.ft 1
.sp
STATIC function names return values that are obtained only during the first
scheduling cycle, or when the scheduler is instructed to reconfig; whereas,
DYNAMIC function names return attribute values that are taken at every
subsequent scheduling cycle.
.sp
.B name
and
.B type
are arbitrarily defined. For example, you can choose to have
.B name
defined as
"$FASTDIR" for the CNodeSrfs* calls, and a sample configuration file entry
would look like:
.sp
.nf
$node unicos8 CNodeSrfsSpaceAvailGet[$FASTDIR]
quota[type=ares_avail,dir=$FASTDIR]
.fi
.sp
So in a BASL code, if you call CNodeSrfsSpaceAvailGet(node, "$FASTDIR"), then
it will return the value to the query "quota[type=ares_avail,dir=$FASTDIR]"
(3rd parameter) as sent to the node's MOM.
.sp
By default, the scheduler has already internally defined the following
mappings, which can be overriden in the configuration file:
.sp
.Ty
.nf
keyword node_name CNode..Get host_resource
======= ========= ================ =============
$node * CNodeOsGet arch
$node * CNodeLoadAveGet loadave
$node * CNodeIdletimeGet idletime
.fi
.ft 1
.sp
The above means that for all declared nodes (via $momhost), the host queries
.Ty arch,
.Ty loadave,
and
.Ty idletime
will be sent to each node's MOM. The value to
.Ty arch
is obtained internally by the system during the first scheduling cycle because
it falls under STATIC category, while values to
.Ty loadave
and
.Ty idletime
are taken at every scheduling iteration because they fall under the DYNAMIC
category. Access to
the return values is done by calling
.Ar "CNodeOsGet(node)",
.Ar "CNodeLoadAveGet(node)",
and
.Ar "CNodeIdletimeGet(node)",
respectively.
The following are some sample $node arguments that you may put in the
configuration file.
.BP
.Ty
.nf
node_name CNode..Get host res
================== ========================= ==========
<sunos4_nodename> CNodeIdletimeGet idletime
<sunos4_nodename> CNodeLoadAveGet loadave
<sunos4_nodename> CNodeMemTotalGet[real] physmem
<sunos4_nodename> CNodeMemTotalGet[virtual] totmem
<sunos4_nodename> CNodeMemAvailGet[virtual] availmem
<irix5_nodename> CNodeNumCpusGet ncpus
<irix5_nodename> CNodeMemTotalGet[real] physmem
<irix5_nodename> CNodeMemTotalGet[virtual] totmem
<irix5_nodename> CNodeIdletimeGet idletime
<irix5_nodename> CNodeLoadAveGet loadave
<irix5_nodename> CNodeMemAvailGet[virtual] availmem
<linux_nodename> CNodeNumCpusGet ncpus
<linux_nodename> CNodeMemTotalGet[real] physmem
<linux_nodename> CNodeMemTotalGet[virtual] totmem
<linux_nodename> CNodeIdletimeGet idletime
<linux_nodename> CNodeLoadAveGet loadave
<linux_nodename> CNodeMemAvailGet[virtual] availmem
<solaris5_nodename> CNodeIdletimeGet idletime
<solaris5_nodename> CNodeLoadAveGet loadave
<solaris5_nodename> CNodeNumCpusGet ncpus
<solaris5_nodename> CNodeMemTotalGet[real] physmem
<aix4_nodename> CNodeIdletimeGet idletime
<aix4_nodename> CNodeLoadAveGet loadave
<aix4_nodename> CNodeMemTotalGet[virtual] totmem
<aix4_nodename> CNodeMemAvailGet[virtual] availmem
<unicos8_nodename> CNodeIdletimeGet idletime
<unicos8_nodename> CNodeLoadAveGet loadave
<unicos8_nodename> CNodeNumCpusGet ncpus
<unicos8_nodename> CNodeMemTotalGet[real] physme
<unicos8_nodename> CNodeMemAvailGet[virtual] availmem
<unicos8_nodename> CNodeSwapSpaceTotalGet[primary] swaptotal
<unicos8_nodename> CNodeSwapSpaceAvailGet[primary] swapavail
<unicos8_nodename> CNodeSwapInBwGet[primary] swapinrate
<unicos8_nodename> CNodeSwapOutBwGet[primary] swapoutrate
<unicos8_nodename> CNodePercentIdleGet cpuidle
<unicos8_nodename> CNodePercentSysGet cpuunix
<unicos8_nodename> CNodePercentGuestGet cpuguest
<unicos8_nodename> CNodePercentUsrGet cpuuser
<unicos8_nodename> CNodeSrfsSpaceAvailGet[$FASTDIR] quota[type
=ares_avail,
dir=$FASTDIR]
<unicos8_nodename> CNodeSrfsSpaceAvailGet[$BIGDIR] quota[type
=ares_avail,
dir=$BIGDIR]
<unicos8_nodename> CNodeSrfsSpaceAvailGet[$WRKDIR] quota[type
=ares_avail,
dir=$WRKDIR]
<sp2_nodename> CNodeLoadAveGet loadave
.fi
.ft 1
.sp
Suppose you have an execution host that is of irix5 os type, then the
<irix5_node_name> entries will be consulted by the scheduler. The
initial scheduling cycle would involve sending the STATIC
queries
.Ty "ncpus",
.Ty "physmem",
.Ty "totmem"
to the execution host's MOM, and access to return values of the queries is done
via
.Ty "CNodeNumCpusGet(node)",
.Ty "CNodeMemTotalGet(node, ""real"")",
.Ty "CNodeMemTotalGet(node, ""virtual"")"
respectively, where node is the CNode representation of the execution host.
The subsequent scheduling cycles will only send DYNAMIC queries
.Ty "idletime",
.Ty "loadave",
and
.Ty "availmem",
and access to the return values of the queries is done via
.Ty "CNodeIdleTimeGet(node)",
.Ty "CNodeLoadAveGet(node)",
.Ty "CNodeMemAvailGet(node, ""virtual"")".
respectively.
.RE
.LP
"Later" entries in the config file take precedence.
.LP
The configuration file must be "secure". It must be owned by a user id and
group id less than 10 and not be world writable.
.sp
On receipt of a SIGHUP signal, the scheduler will close and reopen
its log file and reread its configuration file (if any).
.LP
.SH FILES
.IP $PBS_SERVER_HOME/sched_priv 10
the default directory for configuration files, typically
(/usr/spool/pbs)/sched_priv.
.LP
.SH Signal Handling
A C based scheduler will handle the following signals:
.IP SIGHUP
The server will close and reopen its log file and reread the config file
if one exists.
.IP SIGALRM
If the site supplied scheduling module exceeds the time limit, the Alarm
will cause the scheduler to attempt to core dump and restart itself.
.IP "SIGINT and SIGTERM"
Will result in an orderly shutdown of the scheduler.
.LP
All other signals have the default action installed.
.SH "EXIT STATUS"
Upon normal termination, an exit status of zero is returned.
.SH "SEE ALSO"
basl2c(1B), pbs_sched_tcl(8B), pbs_server(8B), and pbs_mom(8B).
.br
PBS Internal Design Specification
.\" turn off any extra indent left by the Sh macro
.RE
torque/doc/man8/pbs_sched_cc.8.in
+211
View File
@@ -0,0 +1,211 @@
.\" OpenPBS (Portable Batch System) v2.3 Software License
.\"
.\" Copyright (c) 1999-2000 Veridian Information Solutions, Inc.
.\" All rights reserved.
.\"
.\" ---------------------------------------------------------------------------
.\" For a license to use or redistribute the OpenPBS software under conditions
.\" other than those described below, or to purchase support for this software,
.\" please contact Veridian Systems, PBS Products Department ("Licensor") at:
.\"
.\" www.OpenPBS.org +1 650 967-4675 sales@OpenPBS.org
.\" 877 902-4PBS (US toll-free)
.\" ---------------------------------------------------------------------------
.\"
.\" This license covers use of the OpenPBS v2.3 software (the "Software") at
.\" your site or location, and, for certain users, redistribution of the
.\" Software to other sites and locations. Use and redistribution of
.\" OpenPBS v2.3 in source and binary forms, with or without modification,
.\" are permitted provided that all of the following conditions are met.
.\" After December 31, 2001, only conditions 3-6 must be met:
.\"
.\" 1. Commercial and/or non-commercial use of the Software is permitted
.\" provided a current software registration is on file at www.OpenPBS.org.
.\" If use of this software contributes to a publication, product, or service
.\" proper attribution must be given; see www.OpenPBS.org/credit.html
.\"
.\" 2. Redistribution in any form is only permitted for non-commercial,
.\" non-profit purposes. There can be no charge for the Software or any
.\" software incorporating the Software. Further, there can be no
.\" expectation of revenue generated as a consequence of redistributing
.\" the Software.
.\"
.\" 3. Any Redistribution of source code must retain the above copyright notice
.\" and the acknowledgment contained in paragraph 6, this list of conditions
.\" and the disclaimer contained in paragraph 7.
.\"
.\" 4. Any Redistribution in binary form must reproduce the above copyright
.\" notice and the acknowledgment contained in paragraph 6, this list of
.\" conditions and the disclaimer contained in paragraph 7 in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" 5. Redistributions in any form must be accompanied by information on how to
.\" obtain complete source code for the OpenPBS software and any
.\" modifications and/or additions to the OpenPBS software. The source code
.\" must either be included in the distribution or be available for no more
.\" than the cost of distribution plus a nominal fee, and all modifications
.\" and additions to the Software must be freely redistributable by any party
.\" (including Licensor) without restriction.
.\"
.\" 6. All advertising materials mentioning features or use of the Software must
.\" display the following acknowledgment:
.\"
.\" "This product includes software developed by NASA Ames Research Center,
.\" Lawrence Livermore National Laboratory, and Veridian Information
.\" Solutions, Inc.
.\" Visit www.OpenPBS.org for OpenPBS software support,
.\" products, and information."
.\"
.\" 7. DISCLAIMER OF WARRANTY
.\"
.\" THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. ANY EXPRESS
.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT
.\" ARE EXPRESSLY DISCLAIMED.
.\"
.\" IN NO EVENT SHALL VERIDIAN CORPORATION, ITS AFFILIATED COMPANIES, OR THE
.\" U.S. GOVERNMENT OR ANY OF ITS AGENCIES BE LIABLE FOR ANY DIRECT OR INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
.\" OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
.\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" This license will be governed by the laws of the Commonwealth of Virginia,
.\" without reference to its choice of law rules.
.if \n(Pb .ig Iq
.TH pbs_sched 8B "" Local PBS
.so ../ers/ers.macros
.Iq
.SH NAME
pbs_sched_cc \- pbs C scheduler
.SH SYNOPSIS
pbs_sched [\^\-a\ alarm\^] [\^\-d\ home\^]
[\^\-L\ logfile\^] [\^\-p\ file\^] [\^\-S\ port\^] [\^\-R\ port\^] [\^\-c\ file\^]
.SH DESCRIPTION
The
.B pbs_sched
program runs in conjunction with the PBS server. It queries the
server about the state of PBS and communicates with
.B pbs_resmon
to get information about the status of running jobs, memory available etc.
It then makes decisions as to what jobs to run.
.LP
pbs_sched must be executed with root permission.
.SH OPTIONS
.IP "\-a alarm" 15
This specifies the time in seconds to wait for a schedule run to finish.
If a script takes too long to finish, an alarm signal is sent, and
the scheduler is restarted. If a core file does not exist in the
current directory,
.B abort()
is called and a core file is generated. The default for
.I alarm
is 180 seconds.
.IP "\-d home" 15
This specifies the PBS home directory, PBS_HOME.
The current working directory of the scheduler is PBS_HOME/sched_priv.
If this option is not given, PBS_HOME defaults to $PBS_SERVER_HOME as defined
during the PBS build procedure.
.IP "\-L logfile" 15
Specifies an absolute path name of the file to use as the log file.
If not specified, the scheduler will
open a file named for the current date in the PBS_HOME/sched_logs
directory (see the \-d option).
.IP "\-p file" 15
This specifies the "print" file. Any output from the C
code which is written to standard out or standard error will be
written to this file.
If this option is not given, the file used will be
.I PBS_HOME/sched_priv/sched_out .
See the
.At \-d
option.
.IP "\-S port" 15
This specifies the port to use. If this option is not given,
the default port for the PBS scheduler is used.
.IP "\-R port" 15
This specifies the resource monitor port to use. If this option is not given,
the default port for the PBS mom is used. NOTE: this option only makes the
mom port available to the scheduler writer. It doesn't force them to use it.
.IP "\-c file" 15
Specify a configuration file, see description below.
If this is a relative file name it will be relative to PBS_HOME/sched_priv,
see the \-d option. If the \-c option is not supplied, pbs_sched will not
attempt to open a configuration file.
.LP
The options that specify file names may be absolute or relative.
If they are relative, their root directory will be PBS_HOME/sched_priv.
.LP
.SH USAGE
This version of the scheduler requires knowledge of the C
language and the PBS API. Source code is provided for a main program for
the scheduler. The site must supply the heart of the program.
When invoked, the main program performs general initialization
and housekeeping chores. Then a locally supplied function,
.I schedinit()
is called to perform site specific initialization.
.LP
In the main loop, a locally supplied function,
.I schedule()
is called to make the scheduling decisions and perform any required
actions.
Information about jobs and queues is obtained from the Server through
the standard PBS API as found in libifl.a.
Information about the execution host(s) is obtained from the Resource Monitor.
Routines to communicate with the Resource Monitor are found in libnet.a.
.LP
If the processing takes more than the allotted time, the scheduler
will restart itself. The default amount of time is three minutes. This
can be changed with the \-a option.
.LP
On receipt of a SIGHUP signal, the scheduler will close and reopen
its log file and reread its configuration file (if any).
.SH CONFIGURATION FILE
A configuration file may be specified with the \-c option.
This file may be used to specify the hosts (servers) which are allowed to
connect to pbs_sched. The hosts are specified in the configuration file
in a manor identical to that used in pbs_mom.
.IP clienthost
One or more servers, one per line, may be specified:
.IP
.Ty "$clienthost hostname"
+.IP restricted
Allows connections from non-priviledged ports on the named hosts. Typically
only used with Mac OSX:
.IP
.Ty "$restricted hostname"
.IP
Two host names are always allowed to connection to pbs_sched, "localhost"
and the name returned to pbs_sched by the system call gethostname(). These
names need not be specified in the configuration file.
.LP
The configuration file must be "secure". It must be owned by a user id and
group id less than 10 and not be world writable.
.LP
.SH FILES
.IP $PBS_SERVER_HOME/sched_priv 10
the default directory for configuration files, typically
(/usr/spool/pbs)/sched_priv.
.LP
.SH Signal Handling
A C based scheduler will handle the following signals:
.IP SIGHUP
The server will close and reopen its log file and reread the config file
if one exists.
.IP SIGALRM
If the site supplied scheduling module exceeds the time limit, the Alarm
will cause the scheduler to attempt to core dump and restart itself.
.IP "SIGINT and SIGTERM"
Will result in an orderly shutdown of the scheduler.
.LP
All other signals have the default action installed.
.SH "EXIT STATUS"
Upon normal termination, an exit status of zero is returned.
.SH "SEE ALSO"
pbs_sched_tcl(8B), pbs_server(8B), and pbs_mom(8B).
.br
PBS Internal Design Specification
.\" turn off any extra indent left by the Sh macro
.RE
torque/doc/man8/pbs_sched_tcl.8.in
+519
View File
@@ -0,0 +1,519 @@
.\" OpenPBS (Portable Batch System) v2.3 Software License
.\"
.\" Copyright (c) 1999-2000 Veridian Information Solutions, Inc.
.\" All rights reserved.
.\"
.\" ---------------------------------------------------------------------------
.\" For a license to use or redistribute the OpenPBS software under conditions
.\" other than those described below, or to purchase support for this software,
.\" please contact Veridian Systems, PBS Products Department ("Licensor") at:
.\"
.\" www.OpenPBS.org +1 650 967-4675 sales@OpenPBS.org
.\" 877 902-4PBS (US toll-free)
.\" ---------------------------------------------------------------------------
.\"
.\" This license covers use of the OpenPBS v2.3 software (the "Software") at
.\" your site or location, and, for certain users, redistribution of the
.\" Software to other sites and locations. Use and redistribution of
.\" OpenPBS v2.3 in source and binary forms, with or without modification,
.\" are permitted provided that all of the following conditions are met.
.\" After December 31, 2001, only conditions 3-6 must be met:
.\"
.\" 1. Commercial and/or non-commercial use of the Software is permitted
.\" provided a current software registration is on file at www.OpenPBS.org.
.\" If use of this software contributes to a publication, product, or service
.\" proper attribution must be given; see www.OpenPBS.org/credit.html
.\"
.\" 2. Redistribution in any form is only permitted for non-commercial,
.\" non-profit purposes. There can be no charge for the Software or any
.\" software incorporating the Software. Further, there can be no
.\" expectation of revenue generated as a consequence of redistributing
.\" the Software.
.\"
.\" 3. Any Redistribution of source code must retain the above copyright notice
.\" and the acknowledgment contained in paragraph 6, this list of conditions
.\" and the disclaimer contained in paragraph 7.
.\"
.\" 4. Any Redistribution in binary form must reproduce the above copyright
.\" notice and the acknowledgment contained in paragraph 6, this list of
.\" conditions and the disclaimer contained in paragraph 7 in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" 5. Redistributions in any form must be accompanied by information on how to
.\" obtain complete source code for the OpenPBS software and any
.\" modifications and/or additions to the OpenPBS software. The source code
.\" must either be included in the distribution or be available for no more
.\" than the cost of distribution plus a nominal fee, and all modifications
.\" and additions to the Software must be freely redistributable by any party
.\" (including Licensor) without restriction.
.\"
.\" 6. All advertising materials mentioning features or use of the Software must
.\" display the following acknowledgment:
.\"
.\" "This product includes software developed by NASA Ames Research Center,
.\" Lawrence Livermore National Laboratory, and Veridian Information
.\" Solutions, Inc.
.\" Visit www.OpenPBS.org for OpenPBS software support,
.\" products, and information."
.\"
.\" 7. DISCLAIMER OF WARRANTY
.\"
.\" THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. ANY EXPRESS
.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT
.\" ARE EXPRESSLY DISCLAIMED.
.\"
.\" IN NO EVENT SHALL VERIDIAN CORPORATION, ITS AFFILIATED COMPANIES, OR THE
.\" U.S. GOVERNMENT OR ANY OF ITS AGENCIES BE LIABLE FOR ANY DIRECT OR INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
.\" OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
.\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" This license will be governed by the laws of the Commonwealth of Virginia,
.\" without reference to its choice of law rules.
.if \n(Pb .ig Iq
.TH pbs_sched 8B "" Local PBS
.so ../ers/ers.macros
.Iq
.SH NAME
pbs_sched_tcl \- pbs Tcl scheduler
.SH SYNOPSIS
pbs_sched [\^\-a\ alarm\^] [\^\-b\ file\^] [\^\-d\ home\^] [\^\-i\ file\^]
[\^\-L\ logfile\^] [\^\-p\ file\^] [\^\-S\ port\^] [\^\-t\ file\^]
[\^\-v\^] [\^\-c\ file\^]
.SH DESCRIPTION
The
.B pbs_sched
program runs in conjunction with the PBS server. It queries the
server about the state of PBS and communicates with
.B pbs_mom
to get information about the status of running jobs, memory available etc.
It then makes decisions as to what jobs to run.
.LP
pbs_sched must be executed with root permission.
.SH OPTIONS
.IP "\-a alarm" 15
This specifies the time in seconds to wait for a schedule run to finish.
If a script takes too long to finish, an alarm signal is sent, and
the scheduler is restarted. If a core file does not exist in the
current directory,
.B abort()
is called and a core file is generated. The default for
.I alarm
is 180 seconds.
.IP "\-b file" 15
This specifies the "body" file. The file given is read into memory
once at program start or after the program receives a SIGHUP
and executed each time the scheduler is awakened by the server.
If this option is not given, the file "sched_tcl" in the directory
PBS_HOME/sched_priv is read for the body
code.
.IP "\-d home" 15
This specifies the PBS home directory, PBS_HOME.
The current working directory of the scheduler is PBS_HOME/sched_priv.
If this option is not given, PBS_HOME defaults to $PBS_SERVER_HOME as defined
during the PBS build procedure.
.IP "\-i file" 15
This specifies the "initialize" file. The file given is executed
once before the main processing loop is entered. If this option
is not given, no initialization code is executed.
.IP "\-L logfile" 15
Specifies an absolute path name of the file to use as the log file.
If not specified, the scheduler will
open a file named for the current date in the PBS_HOME/sched_logs
directory (see the \-d option).
.IP "\-p file" 15
This specifies the "print" file. Any output from the Tcl
code which is written to standard out or standard error will be
written to this file.
If this option is not given, the file used will be
.I PBS_HOME/sched_priv/sched_out.
See the
.At \-d
option.
.IP "\-S port" 15
This specifies the port to use. If this option is not given,
the default port for the PBS scheduler is used.
.IP "\-t file" 15
This specifies the "terminator" file. If a QUIT command is sent
from the server, this code is executed before the scheduler exits.
If this option is not given, no special termination handling is done.
.IP "\-v" 15
This puts the scheduler into "verbose" mode.
Any errors will be shown no matter what this may be set to, but
some "uninteresting" events may be logged by using this flag.
An example is a message each time the server contacts the scheduler.
.IP "\-c file" 15
Specify a configuration file, see description below.
If this is a relative file name it will be relative to PBS_HOME/sched_priv,
see the \-d option. If the \-c option is not supplied, pbs_sched will not
attempt to open a configuration file.
.LP
The options that specify file names may be absolute or relative.
If they are relative, their root directory will be PBS_HOME/sched_priv.
.LP
.SH USAGE
This version of the scheduler requires knowledge of the Tcl
language. A set of functions to communicate with the PBS
server and resource monitor have been added to those normally
available with Tcl. All these calls will set the Tcl variable
"pbs_errno" to a value to indicate if an error occured.
In all cases, the value "0" means no error. If a call to
a Resource Monitor function is made, any error value will
come from the system supplied
.B errno
variable. If the function call communicates with the PBS
Server, any error value will come from the error number returned
by the server.
.IP "openrm host ?port?" 6
Creates a connection to the PBS Resource Monitor on
.I host
using
.I port
as the port number or the standard port for the resource monitor
if it is not given. A connection handle is returned.
If the open is successful, this will be a non-negative integer.
If not, an error occurred.
.IP "closerm connection" 6
The parameter
.I connection
is a handle to a resource monitor which was previously returned from
.B openrm.
This connection is closed. Nothing is returned.
.LP
.IP "downrm connection" 6
Sends a command to the connected resource monitor to shutdown.
Nothing is returned.
.LP
.IP "configrm connection filename" 6
Sends a command to the connected resource monitor to read the configuration
file given by
.I filename.
If this is successful, a "0" is returned, otherwise, "\-1" is returned.
.LP
.IP "addreq connection request" 6
A resource request is sent to the connected resource monitor.
If this is successful, a "0" is returned, otherwise, "\-1" is returned.
.LP
.IP "getreq connection" 6
One resource request response from the connected resource monitor is
returned. If an error occurred or there are no more responses, an
empty string is returned.
.LP
.IP "allreq request" 6
A resource request is sent to all connected resource monitors.
The number of streams acted upon is returned.
.LP
.IP "flushreq" 6
All resource requests previously sent to all connected resource monitors
are flushed out to the network. Nothing is returned.
.LP
.IP "activereq" 6
The connection number of the next stream with something to read is returned.
If there is nothing to read from any of the connections, a negative
number is returned.
.LP
.IP "fullresp flag" 6
Evaluates
.I flag
as a boolean value and sets
the response mode used by
.B getreq
to
.B full
if
.I flag
evaluates to "true".
The full return from a resource monitor includes the original request
followed by an equal sign followed by the response. The default
situation is only to return the response following the equal sign.
If a script needs to "see" the entire line, this function may be used.
.LP
.IP "pbsstatserv" 6
The server is sent a status request for information about the server
itself.
If the request succeeds, a list with three elements is returned,
otherwise an empty string is returned.
The first element is the server's name. The second is a list of attributes.
The third is the "text" associated with the server (usually blank).
.LP
.IP "pbsstatjob" 6
The server is sent a status request for information about the all
jobs resident within the server.
If the request succeeds, a list is returned, otherwise an empty string
is returned.
The list contains an entry for each job. Each element is a list
with three elements. The first is the job's jobid. The second
is a list of attributes. The attribute names which specify
resources will have a name of the form "Resource_List:name" where
"name" is the resource name.
The third is the "text" associated with the job (usually blank).
.LP
.IP "pbsstatque" 6
The server is sent a status request for information about all
queues resident within the server.
If the request succeeds, a list is returned, otherwise an empty string
is returned.
The list contains an entry for each queue. Each element is a list
with three elements. This first is the queue's name. The second
is a list of attributes similar to
.B pbsstatjob.
The third is the "text" associated with the queue (usually blank).
.LP
.IP "pbsstatnode" 6
The server is sent a status request for information about all
nodes defined within the server.
If the request succeeds, a list is returned, otherwise an empty string
is returned.
The list contains an entry for each node. Each element is a list
with three elements. This first is the nodes's name. The second
is a list of attributes similar to
.B pbsstatjob.
The third is the "text" associated with the node (usually blank).
.LP
.IP "pbsselstat" 6
The server is sent a status request for information about the all runnable
jobs resident within the server.
If the request succeeds, a list similar to
.B pbsstatjob
is returned, otherwise an empty string is returned.
.LP
.IP "pbsrunjob jobid ?location?" 6
Run the job given by
.I jobid
at the location given by
.I location.
If
.I location
is not given, the default location is used.
If this is successful, a "0" is returned, otherwise, "\-1" is returned.
.LP
.IP "pbsasyrunjob jobid ?location?" 6
Run the job given by
.I jobid
at the location given by
.I location
without waiting for a positive response that the job
has actually started.
If
.I location
is not given, the default location is used.
If this is successful, a "0" is returned, otherwise, "\-1" is returned.
.LP
.IP "pbsrerunjob jobid" 6
Re-runs the job given by
.I jobid.
If this is successful, a "0" is returned, otherwise, "\-1" is returned.
.LP
.IP "pbsdeljob jobid" 6
Delete the job given by
.I jobid.
If this is successful, a "0" is returned, otherwise, "\-1" is returned.
.LP
.IP "pbsholdjob jobid" 6
Place a hold on the job given by
.I jobid.
If this is successful, a "0" is returned, otherwise, "\-1" is returned.
.LP
.IP "pbsmovejob jobid ?location?" 6
Move the job given by
.I jobid
to the location given by
.I location.
If
.I location
is not given, the default location is used.
If this is successful, a "0" is returned, otherwise, "\-1" is returned.
.LP
.IP "pbsqenable queue" 6
Set the "enabled" attribute for the queue given by
.I queue
to true.
If this is successful, a "0" is returned, otherwise, "\-1" is returned.
.LP
.IP "pbsqdisable queue" 6
Set the "enabled" attribute for the queue given by
.I queue
to false.
If this is successful, a "0" is returned, otherwise, "\-1" is returned.
.LP
.IP "pbsqstart queue" 6
Set the "started" attribute for the queue given by
.I queue
to true.
If this is successful, a "0" is returned, otherwise, "\-1" is returned.
.LP
.IP "pbsqstop queue" 6
Set the "started" attribute for the queue given by
.I queue
to false.
If this is successful, a "0" is returned, otherwise, "\-1" is returned.
.LP
.IP "pbsalterjob jobid attribute_list" 6
Alter the attributes for a job specified by
.I jobid.
The parameter
.I attribute_list
is the list of attributes to be altered. There can be more than one.
Each attribute consists of a list of three elements. The first
is the name, the second the resource and the third is the new value.
If the alter is successful, a "0" is returned, otherwise, "\-1" is returned.
.LP
.IP "pbsrescquery resource_list" 6
Obtain information about the resources specified by
.I resource_list.
This will be a list of strings. If the request succeeds, a list
with the same number of elements as
.I resource_list
is returned. Each element in this list will be a list with four
numbers. The numbers specify
.I available,
.I allocated,
.I reserved,
and
.I down
in that order.
.LP
.IP "pbsrescreserve resource_id resource_list" 6
Make (or extend) a reservation for the resources specified by
.I resource_list
which will be given as a list of strings. The parameter
.I resource_id
is a number which provides a unique identifier for a reservation
being tracked by the server. If
.I resource_id
is given as "0", a new reservation is created. In this case,
a new identifier is generated and returned by the function.
If an old identifier is used, that same number will be returned.
The Tcl variable "pbs_errno" will be set to indicate the success
or failure of the reservation.
.LP
.IP "pbsrescrelease resource_id" 6
The reservation specified by
.I resource_id
is released.
.LP
The two following commands are not normally used by the scheduler.
They are included here because there could be a need for a scheduler
to contact a server other than the one which it normally communicates
with. Also, these commands are used by the Tcl tools.
.LP
.IP "pbsconnect ?server?" 6
Make a connection to the named server or the default server if
a parameter is not given.
Only one connection to a server is allowed at any one time.
.LP
.IP pbsdisconnect 6
Disconnect from the currently connected server.
.LP
The above Tcl functions use PBS interface library calls for communication
with the server and the PBS resource monitor library to communicate
with pbs_mom.
.LP
.IP "datetime ?day? ?time?" 6
The number of arguments used determine the type of
date to be calculated. With no arguments, the current POSIX
date is returned. This is an integer in seconds.
.sp
With one argument there are two possible formats. The first is a 12
(or more) character string specifying a complete date in
the following format:
.Cs
YYMMDDhhmmss
.Ce
All characters must be digits. The year (YY) is given by the first
two (or more) characters and is the number of years since 1900.
The month (MM) is the number of the month [01-12].
The day (DD) is the day of the month [01-32]. The hour (hh) is the hour
of the day [00-23]. The minute (mm) is minutes after the hour [00-59].
The second (ss) is seconds after the minute [00-59]. The POSIX date
for the given date/time is returned.
.sp
The second option with one argument is a relative time. The format
for this is
.Cs
HH:MM:SS
.Ce
With hours (HH), minutes (MM) and seconds (SS) being separated by
colons ":". The number returned in this case will be the number of seconds
in the interval specified, not an absolute POSIX date.
.sp
With two arguments a relative date is calculated. The first argument
specifies a day of the week and must be one of the following strings:
"Sun", "Mon", "Tue", "Wed", "Thr", "Fri", or "Sat". The second
argument is a relative time as given above. The POSIX date
calculated will be the day of the week given which follows the
current day, and the time given in the second argument. For example,
if the current day was Monday, and the two arguments were
"Fri" and "04:30:00", the date calculated would be the POSIX date
for the Friday following the current Monday, at four-thirty in the
morning. If the day specified and the current day are the same,
the current day is used, not the day one week later.
.LP
.IP "strftime format time"
This function calls the POSIX function
.I strftime().
It requires two arguments. The first
is a format string. The format conventions are the same as those
for the POSIX function strftime(). The second argument is POSIX
calendar time in second as returned by
.I datetime.
It returns a string based on the format given. This gives the ability to
extract information about a time, or format it for printing.
.LP
The Tcl interpreter is started at program initialization and after
a reset (the receipt of a SIGHUP signal). It is not deleted between
scheduling runs so variables which are set in one can be accessed later.
.LP
The "initialize" and "terminator" files are run with no supplied
connection to the server. This means that none of the above functions
which talk to the server will work unless
.B pbsconnect
is called first. The "body" file is run with a connection to
the server already established.
.SH CONFIGURATION FILE
A configuration file may be specified with the \-c option.
This file may be used to specify the hosts (servers) which are allowed to
connect to pbs_sched. The hosts are specified in the configuration file
in a manor identical to that used in pbs_mom. There is one line per
host with the syntax:
.br
.Ty "$clienthost hostname"
.br
where clienthost and hostname are separated by white space.
.LP
Two host names are always allowed to connection to pbs_sched, "localhost"
and the name returned to pbs_sched by the system call gethostname(). These
names need not be specified in the configuration file.
.LP
The configuration file must be "secure". It must be owned by a user id and
group id less than 10 and not be world writable.
.LP
.SH FILES
.IP $PBS_SERVER_HOME/sched_priv 10
the default directory for configuration files, typically
(/usr/spool/pbs)/sched_priv.
.LP
.SH Signal Handling
A C based scheduler will handle the following signals:
.IP SIGHUP
The server will close and reopen its log file and reread the config file
if one exists.
.IP SIGALRM
If the site supplied scheduling module exceeds the time limit, the Alarm
will cause the scheduler to attempt to core dump and restart itself.
.IP "SIGINT and SIGTERM"
Will result in an orderly shutdown of the scheduler.
.LP
All other signals have the default action installed.
.SH "EXIT STATUS"
Upon normal termination, an exit status of zero is returned.
.SH "SEE ALSO"
pbs_scheduler_cc(8B), pbs_scheduler_rule(8B), pbs_server(8B), and pbs_mom(8B).
.br
PBS Internal Design Specification
.\" turn off any extra indent left by the Sh macro
.RE
torque/doc/man8/pbs_server.8.in
+228
View File
@@ -0,0 +1,228 @@
.\" OpenPBS (Portable Batch System) v2.3 Software License
.\"
.\" Copyright (c) 1999-2000 Veridian Information Solutions, Inc.
.\" All rights reserved.
.\"
.\" ---------------------------------------------------------------------------
.\" For a license to use or redistribute the OpenPBS software under conditions
.\" other than those described below, or to purchase support for this software,
.\" please contact Veridian Systems, PBS Products Department ("Licensor") at:
.\"
.\" www.OpenPBS.org +1 650 967-4675 sales@OpenPBS.org
.\" 877 902-4PBS (US toll-free)
.\" ---------------------------------------------------------------------------
.\"
.\" This license covers use of the OpenPBS v2.3 software (the "Software") at
.\" your site or location, and, for certain users, redistribution of the
.\" Software to other sites and locations. Use and redistribution of
.\" OpenPBS v2.3 in source and binary forms, with or without modification,
.\" are permitted provided that all of the following conditions are met.
.\" After December 31, 2001, only conditions 3-6 must be met:
.\"
.\" 1. Commercial and/or non-commercial use of the Software is permitted
.\" provided a current software registration is on file at www.OpenPBS.org.
.\" If use of this software contributes to a publication, product, or service
.\" proper attribution must be given; see www.OpenPBS.org/credit.html
.\"
.\" 2. Redistribution in any form is only permitted for non-commercial,
.\" non-profit purposes. There can be no charge for the Software or any
.\" software incorporating the Software. Further, there can be no
.\" expectation of revenue generated as a consequence of redistributing
.\" the Software.
.\"
.\" 3. Any Redistribution of source code must retain the above copyright notice
.\" and the acknowledgment contained in paragraph 6, this list of conditions
.\" and the disclaimer contained in paragraph 7.
.\"
.\" 4. Any Redistribution in binary form must reproduce the above copyright
.\" notice and the acknowledgment contained in paragraph 6, this list of
.\" conditions and the disclaimer contained in paragraph 7 in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" 5. Redistributions in any form must be accompanied by information on how to
.\" obtain complete source code for the OpenPBS software and any
.\" modifications and/or additions to the OpenPBS software. The source code
.\" must either be included in the distribution or be available for no more
.\" than the cost of distribution plus a nominal fee, and all modifications
.\" and additions to the Software must be freely redistributable by any party
.\" (including Licensor) without restriction.
.\"
.\" 6. All advertising materials mentioning features or use of the Software must
.\" display the following acknowledgment:
.\"
.\" "This product includes software developed by NASA Ames Research Center,
.\" Lawrence Livermore National Laboratory, and Veridian Information
.\" Solutions, Inc.
.\" Visit www.OpenPBS.org for OpenPBS software support,
.\" products, and information."
.\"
.\" 7. DISCLAIMER OF WARRANTY
.\"
.\" THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. ANY EXPRESS
.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT
.\" ARE EXPRESSLY DISCLAIMED.
.\"
.\" IN NO EVENT SHALL VERIDIAN CORPORATION, ITS AFFILIATED COMPANIES, OR THE
.\" U.S. GOVERNMENT OR ANY OF ITS AGENCIES BE LIABLE FOR ANY DIRECT OR INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
.\" OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
.\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" This license will be governed by the laws of the Commonwealth of Virginia,
.\" without reference to its choice of law rules.
.if \n(Pb .ig Iq
.TH pbs_server 8B "" Local PBS
.so ../ers/ers.macros
.Iq
.SH NAME
pbs_server \- start a pbs batch server
.SH SYNOPSIS
pbs_server\ [\-a active] [\-c] [\-d\ config_path\^]\ [\-e] [\-F] [\-f] [\-h] [\-l location\^]
[\-p\ port\^] [\-t type\^] [\-v] [\^\-A\ acctfile\^] [\^\-D] [\-H\ hostname\^]
[\^\-L\ logfile\^] [\-M\ mom_port\^] [\-n\ don't send hierarchy\^] [\-R\ momRPP_port] [\-S\ scheduler_port\^]
[\-\-about] [\-\-ha] [\-\-help] [\-\-version]
.SH DESCRIPTION
The
.B pbs_server
command starts the operation of a batch server on the local host.
Typically, this command will be in a local boot file such as
.I /etc/rc.local .
If the batch server is already in execution,
.B pbs_server
will exit with an error.
To insure that the
.B pbs_server
command is not runnable by the general user community, the server
will only execute if its real and effective uid is zero.
.LP
The server will record a diagnostic message in a log file for any
error occurrence. The log files are maintained in the server_logs
directory below the home directory of the server.
If the log file cannot be opened, the diagnostic message is written
to the system console.
.SH OPTIONS
.IP "\-a active" 15
Specifies if scheduling is active or not. This sets the server attribute scheduling. If the option argument
is "true" ("True", "t", "T", or "1"), the server is \fBactive\fP and the PBS job scheduler will be called.
If the argument is "false" ("False", "f", "F", or "0), the server is \fBidle\fP, and the scheduler will not be called and no jobs will be run.
If this option is not specified, the server will retain the prior value of the scheduling attribute.
.IP "\-c" 15
Wait 10 minutes before contacting moms. Any mom reporting in does not get pinged
if starting
.B pbs_server
before moms.
.IP "\-d config_path" 15
Specifies the path of the directory which is home to the servers
configuration files, PBS_HOME. A host may have multiple servers. Each server
must have a different configuration directory.
The default configuration directory is given by the symbol $PBS_SERVER_HOME
which is typically
.Ty /usr/spool/PBS .
.IP "\-e" 15
Accept status update from any mom. Adds node to nodes file.
.IP "\-F" 15
Do not fork. Use when running under systemd.
.IP "\-f" 15
Force overwrite of server database.
.IP "\-h" 15
Print help information.
.IP "\-l location"
Specifies where to find the scheduler (for example, Moab) when it does not reside on the same host as Torque.
Example: pbs_server -1 <other_host>:<other_port>
.IP "\-p port" 15
Specifies the port number on which the server will
listen for batch requests.
If multiple servers are running on a
single host, each must have its own unique port number.
This option is for use in testing with multiple batch systems on a single host.
.IP "\-t type"
If the job is rerunnable or restartable, and -t create is specified, the server will discard any existing configuration files, queues, and jobs, and initialize configuration files
to the default values. The server is idled.
If -t is not specified, job states will remain the same.
.IP "\-v" 15
Shows version.
.IP "\-A acctfile"
Specifies an absolute path name of the file to use as the accounting file.
If not specified, the file is named for the current date in the
PBS_HOME/server_priv/accounting directory.
.IP "\-D"
Debug mode. Do not fork.
.IP "\-H hostname"
Causes the server to start under a different hostname as obtained from
gethostname(2). Useful for servers with multiple network interfaces to support
connections from clients over an interface that has a hostname assigned
that differs from the one that is returned by gethostname(2).
.IP "\-L logfile"
Specifies an absolute path name of the file to use as the log file.
If not specified, the file is one named for the current date in the
PBS_HOME/server_logs directory, see the
.At \-d
option.
.IP "\-M mom_port"
Specifies the host name and/or port number on which the server should connect
the job executor, MOM. The option argument,
.Ar mom_conn ,
is one of the forms: host_name, [:]port_number, or host_name:port_number.
If host_name not specified, the local host is assumed. If port_number is not
specified, the default port is assumed. See the \-M option for pbs_mom(8).
.IP "\-n don't send heirarchy"
Directs pbs_server to not send the hierarchy to all the MOMs on startup. Instead, the hierarchy is only sent if a MOM requests it. This flag works only in conjunction with the local MOM hierarchy feature.
.IP "\-R mom_RPPport"
Specifies the port number on which the the server should query the up/down
status of Mom. See the \-R option for pbs_mom(8).
.IP "\-S scheduler_port" 15
Specifies the port number to which the server should connect when
contacting the Scheduler. By default pbs_server looks for the scheduler
on the loopback address at port 15004. The -S option changes the default to the value
given in the option argument. The option argument,
.Ar scheduler_conn ,
is of the same syntax as under the \-M option.
.IP "\-\-about" 15
Shows information about
.B pbs_server.
.IP "\-\-ha" 15
Enables high availability mode.
.IP "\-\-help" 15
Prints help information.
.IP "\-\-version" 15
Shows version and commit information.
.LP
.SH FILES
.IP $PBS_SERVER_HOME/server_priv 15
default directory for configuration files, typically
/usr/spool/pbs/server_priv
.IP $PBS_SERVER_HOME/server_logs 15
directory for log files recorded by the server.
.SH Signal Handling
On receipt of the following signals, the server performs the defined action:
.IP SIGHUP
The current server log and accounting log are closed and reopened. This
allows for the prior log to be renamed and a new log started from the time
of the signal.
.IP SIGINT
Causes an orderly shutdown of pbs_server.
.IP "SIGUSR1, SIGUSR2"
Causes server to increase and decrease logging levels, respectively.
.IP SIGTERM
Causes an orderly shutdown of pbs_server.
.IP SIGSHUTDN
On systems (Unicos) where SIGSHUTDN is defined, it also causes an orderly
shutdown of the server.
.IP "SIGPIPE"
This signal is ignored.
.LP
All other signals have their default behavior installed.
.SH EXIT STATUS
If the server command fails to begin batch operation, the
server exits with a value greater than zero.
.SH SEE ALSO
qsub (1B), pbs_connect(3B),
pbs_mom(8B), pbs_sched_basl(8B), pbs_sched_tcl(8B),
pbsnodes(8B), qdisable(8B), qenable(8B), qmgr(1B), qrun(8B), qstart(8B),
qstop(8B), qterm(8B), and the PBS External Reference Specification.
.\" turn off any extra indent left by the Sh macro
.RE
torque/doc/man8/pbsnodes.8.in
+152
View File
@@ -0,0 +1,152 @@
.\" OpenPBS (Portable Batch System) v2.3 Software License
.\"
.\" Copyright (c) 1999-2000 Veridian Information Solutions, Inc.
.\" All rights reserved.
.\"
.\" ---------------------------------------------------------------------------
.\" For a license to use or redistribute the OpenPBS software under conditions
.\" other than those described below, or to purchase support for this software,
.\" please contact Veridian Systems, PBS Products Department ("Licensor") at:
.\"
.\" www.OpenPBS.org +1 650 967-4675 sales@OpenPBS.org
.\" 877 902-4PBS (US toll-free)
.\" ---------------------------------------------------------------------------
.\"
.\" This license covers use of the OpenPBS v2.3 software (the "Software") at
.\" your site or location, and, for certain users, redistribution of the
.\" Software to other sites and locations. Use and redistribution of
.\" OpenPBS v2.3 in source and binary forms, with or without modification,
.\" are permitted provided that all of the following conditions are met.
.\" After December 31, 2001, only conditions 3-6 must be met:
.\"
.\" 1. Commercial and/or non-commercial use of the Software is permitted
.\" provided a current software registration is on file at www.OpenPBS.org.
.\" If use of this software contributes to a publication, product, or service
.\" proper attribution must be given; see www.OpenPBS.org/credit.html
.\"
.\" 2. Redistribution in any form is only permitted for non-commercial,
.\" non-profit purposes. There can be no charge for the Software or any
.\" software incorporating the Software. Further, there can be no
.\" expectation of revenue generated as a consequence of redistributing
.\" the Software.
.\"
.\" 3. Any Redistribution of source code must retain the above copyright notice
.\" and the acknowledgment contained in paragraph 6, this list of conditions
.\" and the disclaimer contained in paragraph 7.
.\"
.\" 4. Any Redistribution in binary form must reproduce the above copyright
.\" notice and the acknowledgment contained in paragraph 6, this list of
.\" conditions and the disclaimer contained in paragraph 7 in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" 5. Redistributions in any form must be accompanied by information on how to
.\" obtain complete source code for the OpenPBS software and any
.\" modifications and/or additions to the OpenPBS software. The source code
.\" must either be included in the distribution or be available for no more
.\" than the cost of distribution plus a nominal fee, and all modifications
.\" and additions to the Software must be freely redistributable by any party
.\" (including Licensor) without restriction.
.\"
.\" 6. All advertising materials mentioning features or use of the Software must
.\" display the following acknowledgment:
.\"
.\" "This product includes software developed by NASA Ames Research Center,
.\" Lawrence Livermore National Laboratory, and Veridian Information
.\" Solutions, Inc.
.\" Visit www.OpenPBS.org for OpenPBS software support,
.\" products, and information."
.\"
.\" 7. DISCLAIMER OF WARRANTY
.\"
.\" THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. ANY EXPRESS
.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT
.\" ARE EXPRESSLY DISCLAIMED.
.\"
.\" IN NO EVENT SHALL VERIDIAN CORPORATION, ITS AFFILIATED COMPANIES, OR THE
.\" U.S. GOVERNMENT OR ANY OF ITS AGENCIES BE LIABLE FOR ANY DIRECT OR INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
.\" OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
.\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" This license will be governed by the laws of the Commonwealth of Virginia,
.\" without reference to its choice of law rules.
.if \n(Pb .ig Iq
.TH pbsnodes 8B "" Local PBS
.so ../ers/ers.macros
.Iq
.SH NAME
pbsnodes \- pbs node manipulation
.SH SYNOPSIS
pbsnodes [\^\-{a|x|xml|\-xml}\^] [\-q] [\-s server] [node|:property]
.br
pbsnodes \-l [\-q] [\-s server] [state] [nodename|:property ...]
.br
pbsnodes [\^\-{c|d|o|r}\^] [\-q] [\-s server] [\-n] [\-N "note"] [\-A "append note"] [node|:property]
.SH DESCRIPTION
The
.B pbsnodes
command is used to mark nodes down, free or offline.
It can also be used to list nodes and their state.
Node information is obtained by sending a request to the
PBS job server. Sets of nodes can be operated on at once
by specifying a node property prefixed by a colon.
.br
Nodes do not exist in a single state, but actually have a set of states. For
example, a node can be simultaneously "busy" and "offline". The "free" state
is the absence of all other states and so is never combined with other states.
.LP
In order to execute pbsnodes with other than the
.B \-a
or
.B \-l
options, the user must have PBS Manager or Operator privilege.
.SH OPTIONS
.IP "\-A" 15
Append a note attribute to existing note attributes. The -N note option will overwrite exiting note attributes. -A
will append a new note attribute to the existing note attributes delimited by a ',' and a space.
.IP "\-a" 15
All attributes of a node or all nodes are listed. This is the default
if no flag is given.
.IP "\-x \-xml \-\-xml" 15
Same as \-a, but the output has an XML-like format.
.IP "\-c" 15
Clear OFFLINE from listed nodes.
.IP "\-d" 15
Print MOM diagnosis on the listed nodes. Not yet implemented.
Use momctl instead.
.IP "\-o" 15
Add the OFFLINE state.
This is different from being marked DOWN.
OFFLINE prevents new jobs from running on the specified nodes.
This gives the administrator a tool to hold a node out
of service without changing anything else.
The OFFLINE state will never be set or cleared automatically
by pbs_server; it is purely for the manager or operator.
.IP "\-p" 15
Purge the node record from pbs_server. Not yet implemented.
.IP "\-r" 15
Reset the listed nodes by clearing OFFLINE and adding DOWN state.
pbs_server will ping the node and, if they communicate correctly, free the node.
.IP "\-l" 15
List node names and their state. If no state is specified, only nodes in the
DOWN, OFFLINE, or UNKNOWN states are listed. Specifying a state string acts as
an output filter. Valid state strings are "free", "offline", "down", "reserve",
"job-exclusive", "job-sharing", "busy", "time-shared", or "state-unknown".
.IP "\-N" 15
Specify a "note" attribute. This allows an administrator to add an
arbitrary annotation to the listed nodes. To clear a note, use
\-N "" or \-N n.
.IP "\-n" 15
Show the "note" attribute for nodes that are DOWN, OFFLINE, or UNKNOWN.
This option requires \-l.
.IP "\-q" 15
Supress all error messages.
.IP "\-s" 15
Specify the PBS server's hostname or IP address.
.SH SEE ALSO
pbs_server(8B) and the PBS External Reference Specification
torque/doc/man8/qdisable.8.in
+144
View File
@@ -0,0 +1,144 @@
.\" OpenPBS (Portable Batch System) v2.3 Software License
.\"
.\" Copyright (c) 1999-2000 Veridian Information Solutions, Inc.
.\" All rights reserved.
.\"
.\" ---------------------------------------------------------------------------
.\" For a license to use or redistribute the OpenPBS software under conditions
.\" other than those described below, or to purchase support for this software,
.\" please contact Veridian Systems, PBS Products Department ("Licensor") at:
.\"
.\" www.OpenPBS.org +1 650 967-4675 sales@OpenPBS.org
.\" 877 902-4PBS (US toll-free)
.\" ---------------------------------------------------------------------------
.\"
.\" This license covers use of the OpenPBS v2.3 software (the "Software") at
.\" your site or location, and, for certain users, redistribution of the
.\" Software to other sites and locations. Use and redistribution of
.\" OpenPBS v2.3 in source and binary forms, with or without modification,
.\" are permitted provided that all of the following conditions are met.
.\" After December 31, 2001, only conditions 3-6 must be met:
.\"
.\" 1. Commercial and/or non-commercial use of the Software is permitted
.\" provided a current software registration is on file at www.OpenPBS.org.
.\" If use of this software contributes to a publication, product, or service
.\" proper attribution must be given; see www.OpenPBS.org/credit.html
.\"
.\" 2. Redistribution in any form is only permitted for non-commercial,
.\" non-profit purposes. There can be no charge for the Software or any
.\" software incorporating the Software. Further, there can be no
.\" expectation of revenue generated as a consequence of redistributing
.\" the Software.
.\"
.\" 3. Any Redistribution of source code must retain the above copyright notice
.\" and the acknowledgment contained in paragraph 6, this list of conditions
.\" and the disclaimer contained in paragraph 7.
.\"
.\" 4. Any Redistribution in binary form must reproduce the above copyright
.\" notice and the acknowledgment contained in paragraph 6, this list of
.\" conditions and the disclaimer contained in paragraph 7 in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" 5. Redistributions in any form must be accompanied by information on how to
.\" obtain complete source code for the OpenPBS software and any
.\" modifications and/or additions to the OpenPBS software. The source code
.\" must either be included in the distribution or be available for no more
.\" than the cost of distribution plus a nominal fee, and all modifications
.\" and additions to the Software must be freely redistributable by any party
.\" (including Licensor) without restriction.
.\"
.\" 6. All advertising materials mentioning features or use of the Software must
.\" display the following acknowledgment:
.\"
.\" "This product includes software developed by NASA Ames Research Center,
.\" Lawrence Livermore National Laboratory, and Veridian Information
.\" Solutions, Inc.
.\" Visit www.OpenPBS.org for OpenPBS software support,
.\" products, and information."
.\"
.\" 7. DISCLAIMER OF WARRANTY
.\"
.\" THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. ANY EXPRESS
.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT
.\" ARE EXPRESSLY DISCLAIMED.
.\"
.\" IN NO EVENT SHALL VERIDIAN CORPORATION, ITS AFFILIATED COMPANIES, OR THE
.\" U.S. GOVERNMENT OR ANY OF ITS AGENCIES BE LIABLE FOR ANY DIRECT OR INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
.\" OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
.\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" This license will be governed by the laws of the Commonwealth of Virginia,
.\" without reference to its choice of law rules.
.if \n(Pb .ig Iq
.TH qdisable 8B "" Local PBS
.so ../ers/ers.macros
.Iq
.SH NAME
qdisable \- disable input to a pbs destination
.SH SYNOPSIS
qdisable destination ...
.SH DESCRIPTION
The
.B qdisable
command directs that a destination should no longer accept batch jobs.
.if !\n(Pb .ig Ig
.LP
The qdisable command sends a
.I "Manage"
request to the batch server specified by
.Ar destination .
The
.At enabled
queue attribute is set to FALSE.
If the batch request is accepted, the server will no longer accept
.Ig
.if \n(Pb .ig Ig
If the command is accepted, the destination will no longer accept
.Ig
.I "Queue Job"
requests which specified the disabled queue. Jobs which already reside
in the queue will continue to be processed. This allows a queue to be
"drained."
.LP
In order to execute qdisable, the user must have PBS Operation or Manager
privilege.
.SH OPERANDS
The qdisable command accepts one or more
.Ar destination
operands. The operands are one of three forms:
.RS 5
.Ty queue
.br
.Ty @server
.br
.Ty queue@server
.RE
If
.Ty queue
is specified, the request is to disable that queue at the default server.
If the
.Ty @server
form is given, the request is to disable all the queues at that server.
If a full destination identifier,
.Ty queue@server ,
is given, the request is to disable the named queue at the named server.
.SH STANDARD ERROR
The qdisable
command will write a diagnostic message to standard error for
each error occurrence.
.SH EXIT STATUS
Upon successful processing of all the operands presented to the
qdisable
command, the exit status will be a value of zero.
.LP
If the qdisable command fails to process any operand, the
command exits with a value greater than zero.
.SH SEE ALSO
pbs_server(8B), qmgr(1B), and qenable(8B)
.\" turn off any extra indent left by the Sh macro
.RE
torque/doc/man8/qenable.8.in
+142
View File
@@ -0,0 +1,142 @@
.\" OpenPBS (Portable Batch System) v2.3 Software License
.\"
.\" Copyright (c) 1999-2000 Veridian Information Solutions, Inc.
.\" All rights reserved.
.\"
.\" ---------------------------------------------------------------------------
.\" For a license to use or redistribute the OpenPBS software under conditions
.\" other than those described below, or to purchase support for this software,
.\" please contact Veridian Systems, PBS Products Department ("Licensor") at:
.\"
.\" www.OpenPBS.org +1 650 967-4675 sales@OpenPBS.org
.\" 877 902-4PBS (US toll-free)
.\" ---------------------------------------------------------------------------
.\"
.\" This license covers use of the OpenPBS v2.3 software (the "Software") at
.\" your site or location, and, for certain users, redistribution of the
.\" Software to other sites and locations. Use and redistribution of
.\" OpenPBS v2.3 in source and binary forms, with or without modification,
.\" are permitted provided that all of the following conditions are met.
.\" After December 31, 2001, only conditions 3-6 must be met:
.\"
.\" 1. Commercial and/or non-commercial use of the Software is permitted
.\" provided a current software registration is on file at www.OpenPBS.org.
.\" If use of this software contributes to a publication, product, or service
.\" proper attribution must be given; see www.OpenPBS.org/credit.html
.\"
.\" 2. Redistribution in any form is only permitted for non-commercial,
.\" non-profit purposes. There can be no charge for the Software or any
.\" software incorporating the Software. Further, there can be no
.\" expectation of revenue generated as a consequence of redistributing
.\" the Software.
.\"
.\" 3. Any Redistribution of source code must retain the above copyright notice
.\" and the acknowledgment contained in paragraph 6, this list of conditions
.\" and the disclaimer contained in paragraph 7.
.\"
.\" 4. Any Redistribution in binary form must reproduce the above copyright
.\" notice and the acknowledgment contained in paragraph 6, this list of
.\" conditions and the disclaimer contained in paragraph 7 in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" 5. Redistributions in any form must be accompanied by information on how to
.\" obtain complete source code for the OpenPBS software and any
.\" modifications and/or additions to the OpenPBS software. The source code
.\" must either be included in the distribution or be available for no more
.\" than the cost of distribution plus a nominal fee, and all modifications
.\" and additions to the Software must be freely redistributable by any party
.\" (including Licensor) without restriction.
.\"
.\" 6. All advertising materials mentioning features or use of the Software must
.\" display the following acknowledgment:
.\"
.\" "This product includes software developed by NASA Ames Research Center,
.\" Lawrence Livermore National Laboratory, and Veridian Information
.\" Solutions, Inc.
.\" Visit www.OpenPBS.org for OpenPBS software support,
.\" products, and information."
.\"
.\" 7. DISCLAIMER OF WARRANTY
.\"
.\" THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. ANY EXPRESS
.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT
.\" ARE EXPRESSLY DISCLAIMED.
.\"
.\" IN NO EVENT SHALL VERIDIAN CORPORATION, ITS AFFILIATED COMPANIES, OR THE
.\" U.S. GOVERNMENT OR ANY OF ITS AGENCIES BE LIABLE FOR ANY DIRECT OR INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
.\" OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
.\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" This license will be governed by the laws of the Commonwealth of Virginia,
.\" without reference to its choice of law rules.
.if \n(Pb .ig Iq
.TH qenable 8B "" Local PBS
.so ../ers/ers.macros
.Iq
.SH NAME
qenable \- enable input to a pbs destination
.SH SYNOPSIS
qenable destination ...
.SH DESCRIPTION
The
.B qenable
command directs that a destination should accept batch jobs.
.LP
The qenable command sends a
.I "Manage"
request to the batch server specified by
.Ar destination .
.if !\n(Pb .ig Ig
The
.At enabled
queue attribute is set to TRUE.
If the request is accepted, that server will accept
.Ig
.if \n(Pb .ig Ig
If the command is accepted, the destination will accept
.Ig
.I "Queue Job"
requests which specified the queue.
.LP
In order to execute qenable, the user must have PBS Operation or Manager
privilege.
.SH OPERANDS
The qenable command accepts one or more
.Ar destination
operands. The operands are one of three forms:
.RS 5
.Ty queue
.br
.Ty @server
.br
.Ty queue@server
.RE
If
.Ty queue
is specified, the request is to enable that queue at the default server.
If the
.Ty @server
form is given, the request is to enable all the queues at that server.
If a full destination identifier,
.Ty queue@server ,
is given, the request is to enable the named queue at the named server.
.SH STANDARD ERROR
The qenable
command will write a diagnostic message to standard error for
each error occurrence.
.SH EXIT STATUS
Upon successful processing of all the operands presented to the
qenable
command, the exit status will be a value of zero.
.LP
If the qenable command fails to process any operand, the
command exits with a value greater than zero.
.SH SEE ALSO
pbs_server(8B), qdisable(8B), and qmgr(1B)
.\" turn off any extra indent left by the Sh macro
.RE
torque/doc/man8/qrun.8.in
+132
View File
@@ -0,0 +1,132 @@
.\" OpenPBS (Portable Batch System) v2.3 Software License
.\"
.\" Copyright (c) 1999-2000 Veridian Information Solutions, Inc.
.\" All rights reserved.
.\"
.\" ---------------------------------------------------------------------------
.\" For a license to use or redistribute the OpenPBS software under conditions
.\" other than those described below, or to purchase support for this software,
.\" please contact Veridian Systems, PBS Products Department ("Licensor") at:
.\"
.\" www.OpenPBS.org +1 650 967-4675 sales@OpenPBS.org
.\" 877 902-4PBS (US toll-free)
.\" ---------------------------------------------------------------------------
.\"
.\" This license covers use of the OpenPBS v2.3 software (the "Software") at
.\" your site or location, and, for certain users, redistribution of the
.\" Software to other sites and locations. Use and redistribution of
.\" OpenPBS v2.3 in source and binary forms, with or without modification,
.\" are permitted provided that all of the following conditions are met.
.\" After December 31, 2001, only conditions 3-6 must be met:
.\"
.\" 1. Commercial and/or non-commercial use of the Software is permitted
.\" provided a current software registration is on file at www.OpenPBS.org.
.\" If use of this software contributes to a publication, product, or service
.\" proper attribution must be given; see www.OpenPBS.org/credit.html
.\"
.\" 2. Redistribution in any form is only permitted for non-commercial,
.\" non-profit purposes. There can be no charge for the Software or any
.\" software incorporating the Software. Further, there can be no
.\" expectation of revenue generated as a consequence of redistributing
.\" the Software.
.\"
.\" 3. Any Redistribution of source code must retain the above copyright notice
.\" and the acknowledgment contained in paragraph 6, this list of conditions
.\" and the disclaimer contained in paragraph 7.
.\"
.\" 4. Any Redistribution in binary form must reproduce the above copyright
.\" notice and the acknowledgment contained in paragraph 6, this list of
.\" conditions and the disclaimer contained in paragraph 7 in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" 5. Redistributions in any form must be accompanied by information on how to
.\" obtain complete source code for the OpenPBS software and any
.\" modifications and/or additions to the OpenPBS software. The source code
.\" must either be included in the distribution or be available for no more
.\" than the cost of distribution plus a nominal fee, and all modifications
.\" and additions to the Software must be freely redistributable by any party
.\" (including Licensor) without restriction.
.\"
.\" 6. All advertising materials mentioning features or use of the Software must
.\" display the following acknowledgment:
.\"
.\" "This product includes software developed by NASA Ames Research Center,
.\" Lawrence Livermore National Laboratory, and Veridian Information
.\" Solutions, Inc.
.\" Visit www.OpenPBS.org for OpenPBS software support,
.\" products, and information."
.\"
.\" 7. DISCLAIMER OF WARRANTY
.\"
.\" THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. ANY EXPRESS
.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT
.\" ARE EXPRESSLY DISCLAIMED.
.\"
.\" IN NO EVENT SHALL VERIDIAN CORPORATION, ITS AFFILIATED COMPANIES, OR THE
.\" U.S. GOVERNMENT OR ANY OF ITS AGENCIES BE LIABLE FOR ANY DIRECT OR INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
.\" OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
.\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" This license will be governed by the laws of the Commonwealth of Virginia,
.\" without reference to its choice of law rules.
.if \n(Pb .ig Iq
.TH qrun 8B "" Local PBS
.so ../ers/ers.macros
.Iq
.SH NAME
qrun \- run a pbs batch job
.SH SYNOPSIS
qrun [\^\-a] [\^\-H\ host\^] job_identifier ...
.SH DESCRIPTION
The
.B qrun
command is used to force a batch server to initiate the execution
of a batch job.
The job is run regardless of scheduling position, resource requirements,
or state.
.LP
In order to execute qrun, the user must have PBS Operation or Manager
privilege.
.SH OPTIONS
.IP "\-a" 15
Specifies the job(s) is to be run asynchronously.
.IP "\-H host" 15
Specifies the host within the cluster on which the job(s) are to be run.
The
.Ar host
argument is the name of a host that is a member of the cluster of hosts
managed by the server.
If the option is not specified, the server will select the "worst possible"
host on which to execute the job.
.LP
.SH OPERANDS
The qrun command accepts one or more
.Ar job_identifier
operands of the form:
.br
.Ty "\ \ \ \ sequence_number[.server_name][@server]"
.br
.if !\n(Pb .ig Ig
See the description under "Job Identifier" in section \*(Ji in the ERS.
.Ig
.SH STANDARD ERROR
The
qrun
command will write a diagnostic message to standard error for
each error occurrence.
.SH EXIT STATUS
Upon successful processing of all the operands presented to the
qrun
command, the exit status will be a value of zero.
.LP
If the qrun command fails to process any operand, the
command exits with a value greater than zero.
.SH SEE ALSO
pbs_server(8B), pbs_sched(8B), qmgr(1B)
.\" turn off any extra indent left by the Sh macro
.RE
torque/doc/man8/qstart.8.in
+140
View File
@@ -0,0 +1,140 @@
.\" OpenPBS (Portable Batch System) v2.3 Software License
.\"
.\" Copyright (c) 1999-2000 Veridian Information Solutions, Inc.
.\" All rights reserved.
.\"
.\" ---------------------------------------------------------------------------
.\" For a license to use or redistribute the OpenPBS software under conditions
.\" other than those described below, or to purchase support for this software,
.\" please contact Veridian Systems, PBS Products Department ("Licensor") at:
.\"
.\" www.OpenPBS.org +1 650 967-4675 sales@OpenPBS.org
.\" 877 902-4PBS (US toll-free)
.\" ---------------------------------------------------------------------------
.\"
.\" This license covers use of the OpenPBS v2.3 software (the "Software") at
.\" your site or location, and, for certain users, redistribution of the
.\" Software to other sites and locations. Use and redistribution of
.\" OpenPBS v2.3 in source and binary forms, with or without modification,
.\" are permitted provided that all of the following conditions are met.
.\" After December 31, 2001, only conditions 3-6 must be met:
.\"
.\" 1. Commercial and/or non-commercial use of the Software is permitted
.\" provided a current software registration is on file at www.OpenPBS.org.
.\" If use of this software contributes to a publication, product, or service
.\" proper attribution must be given; see www.OpenPBS.org/credit.html
.\"
.\" 2. Redistribution in any form is only permitted for non-commercial,
.\" non-profit purposes. There can be no charge for the Software or any
.\" software incorporating the Software. Further, there can be no
.\" expectation of revenue generated as a consequence of redistributing
.\" the Software.
.\"
.\" 3. Any Redistribution of source code must retain the above copyright notice
.\" and the acknowledgment contained in paragraph 6, this list of conditions
.\" and the disclaimer contained in paragraph 7.
.\"
.\" 4. Any Redistribution in binary form must reproduce the above copyright
.\" notice and the acknowledgment contained in paragraph 6, this list of
.\" conditions and the disclaimer contained in paragraph 7 in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" 5. Redistributions in any form must be accompanied by information on how to
.\" obtain complete source code for the OpenPBS software and any
.\" modifications and/or additions to the OpenPBS software. The source code
.\" must either be included in the distribution or be available for no more
.\" than the cost of distribution plus a nominal fee, and all modifications
.\" and additions to the Software must be freely redistributable by any party
.\" (including Licensor) without restriction.
.\"
.\" 6. All advertising materials mentioning features or use of the Software must
.\" display the following acknowledgment:
.\"
.\" "This product includes software developed by NASA Ames Research Center,
.\" Lawrence Livermore National Laboratory, and Veridian Information
.\" Solutions, Inc.
.\" Visit www.OpenPBS.org for OpenPBS software support,
.\" products, and information."
.\"
.\" 7. DISCLAIMER OF WARRANTY
.\"
.\" THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. ANY EXPRESS
.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT
.\" ARE EXPRESSLY DISCLAIMED.
.\"
.\" IN NO EVENT SHALL VERIDIAN CORPORATION, ITS AFFILIATED COMPANIES, OR THE
.\" U.S. GOVERNMENT OR ANY OF ITS AGENCIES BE LIABLE FOR ANY DIRECT OR INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
.\" OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
.\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" This license will be governed by the laws of the Commonwealth of Virginia,
.\" without reference to its choice of law rules.
.if \n(Pb .ig Iq
.TH qstart 8B "" Local PBS
.so ../ers/ers.macros
.Iq
.SH NAME
qstart \- start pbs batch job processing at a destination
.SH SYNOPSIS
qstart destination ...
.SH DESCRIPTION
The
.B qstart
command directs that a destination should process batch jobs.
If the destination is an execution queue, the server will begin
to schedule jobs that reside in the queue for execution. If the
destination is a routing queue, the server will begin to route
jobs from that queue.
.LP
.if !\n(Pb .ig Ig
The qstart command sends a
.I "Manage"
request to the batch server specified by
.Ar destination .
The
.At started
queue attribute is set to TRUE.
.Ig
.LP
In order to execute qstart, the user must have PBS Operation or Manager
privilege.
.SH OPERANDS
The qstart command accepts one or more
.Ar destination
operands. The operands are one of three forms:
.RS 5
.Ty queue
.br
.Ty @server
.br
.Ty queue@server
.RE
If
.Ty queue
is specified, the request is to start that queue at the default server.
If the
.Ty @server
form is given, the request is to start all queues at that server.
If a full destination identifier,
.Ty queue@server ,
is given, the request is to start the named queue at the named server.
.SH STANDARD ERROR
The qstart
command will write a diagnostic message to standard error for
each error occurrence.
.SH EXIT STATUS
Upon successful processing of all the operands presented to the
qstart
command, the exit status will be a value of zero.
.LP
If the qstart command fails to process any operand, the
command exits with a value greater than zero.
.SH SEE ALSO
pbs_server(8B), qstop(8B), and qmgr(1B)
.\" turn off any extra indent left by the Sh macro
.RE
torque/doc/man8/qstop.8.in
+140
View File
@@ -0,0 +1,140 @@
.\" OpenPBS (Portable Batch System) v2.3 Software License
.\"
.\" Copyright (c) 1999-2000 Veridian Information Solutions, Inc.
.\" All rights reserved.
.\"
.\" ---------------------------------------------------------------------------
.\" For a license to use or redistribute the OpenPBS software under conditions
.\" other than those described below, or to purchase support for this software,
.\" please contact Veridian Systems, PBS Products Department ("Licensor") at:
.\"
.\" www.OpenPBS.org +1 650 967-4675 sales@OpenPBS.org
.\" 877 902-4PBS (US toll-free)
.\" ---------------------------------------------------------------------------
.\"
.\" This license covers use of the OpenPBS v2.3 software (the "Software") at
.\" your site or location, and, for certain users, redistribution of the
.\" Software to other sites and locations. Use and redistribution of
.\" OpenPBS v2.3 in source and binary forms, with or without modification,
.\" are permitted provided that all of the following conditions are met.
.\" After December 31, 2001, only conditions 3-6 must be met:
.\"
.\" 1. Commercial and/or non-commercial use of the Software is permitted
.\" provided a current software registration is on file at www.OpenPBS.org.
.\" If use of this software contributes to a publication, product, or service
.\" proper attribution must be given; see www.OpenPBS.org/credit.html
.\"
.\" 2. Redistribution in any form is only permitted for non-commercial,
.\" non-profit purposes. There can be no charge for the Software or any
.\" software incorporating the Software. Further, there can be no
.\" expectation of revenue generated as a consequence of redistributing
.\" the Software.
.\"
.\" 3. Any Redistribution of source code must retain the above copyright notice
.\" and the acknowledgment contained in paragraph 6, this list of conditions
.\" and the disclaimer contained in paragraph 7.
.\"
.\" 4. Any Redistribution in binary form must reproduce the above copyright
.\" notice and the acknowledgment contained in paragraph 6, this list of
.\" conditions and the disclaimer contained in paragraph 7 in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" 5. Redistributions in any form must be accompanied by information on how to
.\" obtain complete source code for the OpenPBS software and any
.\" modifications and/or additions to the OpenPBS software. The source code
.\" must either be included in the distribution or be available for no more
.\" than the cost of distribution plus a nominal fee, and all modifications
.\" and additions to the Software must be freely redistributable by any party
.\" (including Licensor) without restriction.
.\"
.\" 6. All advertising materials mentioning features or use of the Software must
.\" display the following acknowledgment:
.\"
.\" "This product includes software developed by NASA Ames Research Center,
.\" Lawrence Livermore National Laboratory, and Veridian Information
.\" Solutions, Inc.
.\" Visit www.OpenPBS.org for OpenPBS software support,
.\" products, and information."
.\"
.\" 7. DISCLAIMER OF WARRANTY
.\"
.\" THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. ANY EXPRESS
.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT
.\" ARE EXPRESSLY DISCLAIMED.
.\"
.\" IN NO EVENT SHALL VERIDIAN CORPORATION, ITS AFFILIATED COMPANIES, OR THE
.\" U.S. GOVERNMENT OR ANY OF ITS AGENCIES BE LIABLE FOR ANY DIRECT OR INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
.\" OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
.\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" This license will be governed by the laws of the Commonwealth of Virginia,
.\" without reference to its choice of law rules.
.if \n(Pb .ig Iq
.TH qstop 8B "" Local PBS
.so ../ers/ers.macros
.Iq
.SH NAME
qstop \- stop pbs batch job processing at a destination
.SH SYNOPSIS
qstop destination ...
.SH DESCRIPTION
The
.B qstop
command directs that a destination should stop processing batch jobs.
If the destination is a execution queue, the server will cease
scheduling jobs that reside in the queue for execution. If the
destination is a routing queue, the server will cease routing
jobs from that queue.
.LP
.if !\n(Pb .ig Ig
The qstop command sends a
.I "Manage"
request to the batch server specified by
.Ar destination .
The
.At started
queue attribute is set to FALSE.
.Ig
.LP
In order to execute qstop, the user must have PBS Operation or Manager
privilege.
.SH OPERANDS
The qstop command accepts one or more
.Ar destination
operands. The operands are one of three forms:
.RS 5
.Ty queue
.br
.Ty @server
.br
.Ty queue@server
.RE
If
.Ty queue
is specified, the request is to stop that queue at the default server.
If the
.Ty @server
form is given, the request is to stop all the queues at that server.
If a full destination identifier,
.Ty queue@server ,
is given, the request is to stop the named queue at the named server.
.SH STANDARD ERROR
The qstop
command will write a diagnostic message to standard error for
each error occurrence.
.SH EXIT STATUS
Upon successful processing of all the operands presented to the
qstop
command, the exit status will be a value of zero.
.LP
If the qstop command fails to process any operand, the
command exits with a value greater than zero.
.SH SEE ALSO
pbs_server(8B), qstart(8B), and qmgr(1B)
.\" turn off any extra indent left by the Sh macro
.RE
torque/doc/man8/qterm.8.in
+153
View File
@@ -0,0 +1,153 @@
.\" OpenPBS (Portable Batch System) v2.3 Software License
.\"
.\" Copyright (c) 1999-2000 Veridian Information Solutions, Inc.
.\" All rights reserved.
.\"
.\" ---------------------------------------------------------------------------
.\" For a license to use or redistribute the OpenPBS software under conditions
.\" other than those described below, or to purchase support for this software,
.\" please contact Veridian Systems, PBS Products Department ("Licensor") at:
.\"
.\" www.OpenPBS.org +1 650 967-4675 sales@OpenPBS.org
.\" 877 902-4PBS (US toll-free)
.\" ---------------------------------------------------------------------------
.\"
.\" This license covers use of the OpenPBS v2.3 software (the "Software") at
.\" your site or location, and, for certain users, redistribution of the
.\" Software to other sites and locations. Use and redistribution of
.\" OpenPBS v2.3 in source and binary forms, with or without modification,
.\" are permitted provided that all of the following conditions are met.
.\" After December 31, 2001, only conditions 3-6 must be met:
.\"
.\" 1. Commercial and/or non-commercial use of the Software is permitted
.\" provided a current software registration is on file at www.OpenPBS.org.
.\" If use of this software contributes to a publication, product, or service
.\" proper attribution must be given; see www.OpenPBS.org/credit.html
.\"
.\" 2. Redistribution in any form is only permitted for non-commercial,
.\" non-profit purposes. There can be no charge for the Software or any
.\" software incorporating the Software. Further, there can be no
.\" expectation of revenue generated as a consequence of redistributing
.\" the Software.
.\"
.\" 3. Any Redistribution of source code must retain the above copyright notice
.\" and the acknowledgment contained in paragraph 6, this list of conditions
.\" and the disclaimer contained in paragraph 7.
.\"
.\" 4. Any Redistribution in binary form must reproduce the above copyright
.\" notice and the acknowledgment contained in paragraph 6, this list of
.\" conditions and the disclaimer contained in paragraph 7 in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" 5. Redistributions in any form must be accompanied by information on how to
.\" obtain complete source code for the OpenPBS software and any
.\" modifications and/or additions to the OpenPBS software. The source code
.\" must either be included in the distribution or be available for no more
.\" than the cost of distribution plus a nominal fee, and all modifications
.\" and additions to the Software must be freely redistributable by any party
.\" (including Licensor) without restriction.
.\"
.\" 6. All advertising materials mentioning features or use of the Software must
.\" display the following acknowledgment:
.\"
.\" "This product includes software developed by NASA Ames Research Center,
.\" Lawrence Livermore National Laboratory, and Veridian Information
.\" Solutions, Inc.
.\" Visit www.OpenPBS.org for OpenPBS software support,
.\" products, and information."
.\"
.\" 7. DISCLAIMER OF WARRANTY
.\"
.\" THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. ANY EXPRESS
.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT
.\" ARE EXPRESSLY DISCLAIMED.
.\"
.\" IN NO EVENT SHALL VERIDIAN CORPORATION, ITS AFFILIATED COMPANIES, OR THE
.\" U.S. GOVERNMENT OR ANY OF ITS AGENCIES BE LIABLE FOR ANY DIRECT OR INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
.\" OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
.\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" This license will be governed by the laws of the Commonwealth of Virginia,
.\" without reference to its choice of law rules.
.if \n(Pb .ig Iq
.TH qterm 8B "" Local PBS
.so ../ers/ers.macros
.Iq
.SH NAME
qterm \- terminate processing by a PBS batch server
.SH SYNOPSIS
qterm [\^\-t\ type\^] [server...]
.SH DESCRIPTION
The
.B qterm
command terminates a PBS batch server.
.if !\n(Pb .ig Ig
The command sends a
.I "Server Shutdown"
batch request to the server.
.Ig
When a server receives a
.if \n(Pb .ig Ig
terminate command,
.Ig
.if !\n(Pb .ig Ig
Shutdown request,
.Ig
the server will go into a
.I terminating
state.
While in this state, the server will not allow new jobs to be started or enqueued.
By default, qterm will request a "quick" shutdown of the PBS server.
Other ways of shutting down the server (specified with the \-t argument),
and their impact on running jobs, are described below.
The qterm command will not exit until the server has completed its shutdown
procedure.
.LP
In order to execute qterm, the user must have PBS Operation or Manager
privilege.
.SH OPTIONS
.IP "\-t type" 10
Specifies the type of shut down. The type are:
.RS
.IP quick\
This option is used when you wish that running jobs be left running when
the server shuts down. The
server will cleanly shutdown and can be restarted when desired. Upon restart
of the server, jobs that continue to run are shown as running; jobs that
terminated during the server's absence will be placed into the exiting state.
.if !\n(Pb .ig Ig
The value passed in the
.I Shutdown
request is
.SC SHUT_NOW .
.Ig
.RE
.LP
.SH OPERANDS
The
.Ar server
operand specifies which servers are to shutdown.
If no servers are given, then the default server will be terminated.
.SH STANDARD ERROR
The
qterm
command will write a diagnostic message to standard error for
each error occurrence.
.SH EXIT STATUS
Upon successful processing of all the operands presented to the
qterm
command, the exit status will be a value of zero.
.LP
If the qterm command fails to process any operand, the
command exits with a value greater than zero.
.SH SEE ALSO
pbs_server(8B), qmgr(1B),
pbs_resources_aix4(7B), pbs_resources_irix5(7B),
pbs_resources_sp2(7B), pbs_resources_sunos4(7B), and pbs_resources_unicos8(7B)
.\" turn off any extra indent left by the Sh macrO
.RE