torque-docs/qhold(1)

1qhold(1B)                             PBS                            qhold(1B)
2
3
4

NAME

6       qhold - hold pbs batch jobs
7

SYNOPSIS

9       qhold [-h hold_list] job_identifier ...
10

DESCRIPTION

12       The  qhold  command requests that a server place one or more holds on a
13       job.  A job that has a hold is not eligible for execution.   There  are
14       three  supported  holds: USER, OTHER (also known as operator), and SYS‐
15       TEM.
16
17       A user may place a USER hold upon any job the user  owns.   An  "opera‐
18       tor",  who is a user with "operator privilege," may place ether an USER
19       or an OTHER hold on any job.  The batch  administrator  may  place  any
20       hold on any job.
21
22       If  no  -h  option  is given, the USER hold will be applied to the jobs
23       described by the job_identifier operand list.
24
25       If the job identified by job_identifier is  in  the  queued,  held,  or
26       waiting  states, then all that occurs is that the hold type is added to
27       the job.  The job is then placed into held state if it  resides  in  an
28       execution queue.
29
30       If the job is in running state, then the following additional action is
31       taken to interrupt the execution of the job.  If checkpoint  /  restart
32       is  supported  by  the  host system, requesting a hold on a running job
33       will (1) cause the job to be checkpointed, (2) the  resources  assigned
34       to  the  job  will  be  released, and (3) the job is placed in the held
35       state in the execution queue.
36
37       If checkpoint / restart is not supported, qhold will only set  the  the
38       requested  hold  attribute.  This will have no effect unless the job is
39       rerun with the qrerun command.
40
41       The qhold command sends a Hold Job  batch  request  to  the  server  as
42       described in the general section.
43

OPTIONS

45       -h hold_list   Defines the types of holds to be placed on the job.
46
47                      The  hold_list argument is a string consisting of one or
48                      more of the letters "u", "o", or "s"in  any  combination
49                      or  the  character  "n".   The hold type associated with
50                      each letter is:
51
52                      u - USER
53
54                      o - OTHER
55
56                      s - SYSTEM
57
58                      n - None
59

OPERANDS

61       The qhold command accepts one or more job_identifier  operands  of  the
62       form: sequence_number[.server_name][@server]
63

STANDARD ERROR

65       The qhold command will write a diagnostic message to standard error for
66       each error occurrence.
67

EXIT STATUS

69       Upon successful processing of all the operands presented to  the  qhold
70       command, the exit status will be a value of zero.
71
72       If  the  qhold  command fails to process any operand, the command exits
73       with a value greater than zero.
74