207 lines
7.5 KiB
Groff
207 lines
7.5 KiB
Groff
.\" 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 qhold 1B "" Local PBS
|
|
.so ../ers/ers.macros
|
|
.Iq
|
|
.SH NAME
|
|
qhold \- hold pbs batch jobs
|
|
.SH SYNOPSIS
|
|
qhold
|
|
[\-h hold_list] [\-t array_range]
|
|
job_identifier ...
|
|
.SH DESCRIPTION
|
|
The
|
|
.B qhold
|
|
command requests that a server place one or more holds on
|
|
a job. A job that has a hold is not eligible for execution.
|
|
There are three supported holds:
|
|
.Av USER ,
|
|
.Av OTHER
|
|
(also known as operator), and
|
|
.Av SYSTEM .
|
|
.LP
|
|
A user may place a
|
|
.Av USER
|
|
hold upon any job the user owns.
|
|
An "operator", who is a user with "operator privilege," may place ether an
|
|
.Av USER
|
|
or an
|
|
.Av OTHER
|
|
hold on any job. The batch administrator may place any hold on any job.
|
|
.LP
|
|
If no
|
|
.Ar "\-h"
|
|
option is given, the
|
|
USER
|
|
hold will be applied to the jobs described by the
|
|
.Ar job_identifier
|
|
operand list.
|
|
.LP
|
|
If the job identified by
|
|
.Ar job_identifier
|
|
is in the
|
|
.BR queued ,
|
|
.BR held ,
|
|
or
|
|
.B waiting
|
|
states, then all that occurs is that the hold type is added to the job.
|
|
The job is then placed into
|
|
.B held
|
|
state if it resides in an execution queue.
|
|
.LP
|
|
If the job is in
|
|
.B running
|
|
state, then the following additional action is taken to interrupt the
|
|
execution of the job.
|
|
.if !\n(Pb .ig Ig
|
|
.SM
|
|
This is an extension to POSIX.2d.
|
|
.NL
|
|
.Ig
|
|
If checkpoint / restart is supported by the host system, requesting a hold
|
|
on a running job will (1) cause the job to be checkpointed, (2) the
|
|
resources assigned to the job will be released, and (3) the job is
|
|
placed in the
|
|
.B held
|
|
state in the execution queue.
|
|
.LP
|
|
If checkpoint / restart is not supported, qhold will only set the
|
|
the requested hold attribute. This will have no effect unless the job
|
|
is rerun with the
|
|
.B qrerun
|
|
command.
|
|
.LP
|
|
The qhold command sends a
|
|
.I "Hold Job"
|
|
batch request to the server as described in the general section.
|
|
.SH OPTIONS
|
|
.IP "\-h hold_list" 15
|
|
Defines the types of holds to be placed on the job.
|
|
.IP
|
|
The
|
|
.Ar hold_list
|
|
argument is a string consisting of one or more of the letters "\fBu\fP",
|
|
"\fBo\fP", or "\fBs\fP" in any combination.
|
|
The hold type associated with each letter is:
|
|
.RS
|
|
.IP "u \- " 4
|
|
.Av USER
|
|
.IP "o \- " 4
|
|
.Av OTHER
|
|
.IP "s \- " 4
|
|
.Av SYSTEM
|
|
.RE
|
|
.if !\n(Pb .ig Ig
|
|
.IP
|
|
Repetition of characters is permitted.
|
|
.Ig
|
|
.IP "\-t array_range" 15
|
|
The array_range argument is an integer id or a range of integers. Multiple ids
|
|
or id ranges can be combined in a comma delimted list. Examples: -t 1-100 or
|
|
-t 1,10,50-100
|
|
.IP
|
|
If an array range isn't specified, the command tries to operate on the entire
|
|
array. The command acts on the array (or specified range of the array) just as
|
|
it would on an individual job.
|
|
.LP
|
|
.SH OPERANDS
|
|
The qhold command accepts one or more
|
|
.Ar job_identifier
|
|
operands of the form:
|
|
.DS
|
|
.Ty sequence_number[.server_name][@server]
|
|
.DE
|
|
.if !\n(Pb .ig Ig
|
|
See the description under "Job Identifier" in section \*(Ji in this ERS.
|
|
.Ig
|
|
.LP
|
|
.SH STANDARD ERROR
|
|
The qhold 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
|
|
qhold command, the exit status will be a value of zero.
|
|
.LP
|
|
If the qhold command fails to process any operand, the
|
|
command exits with a value greater than zero.
|
|
.SH SEE ALSO
|
|
qrls(1B), qalter(1B), qsub(1B), pbs_alterjob(3B), pbs_holdjob(3B),
|
|
pbs_rlsjob(3B), pbs_job_attributes(7B), pbs_resources_unicos8(7B)
|
|
\" turn off any extra indent left by the Sh macro
|
|
.RE
|