qhold-torque(1)

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

NAME

6       qhold - hold pbs batch jobs
7

SYNOPSIS

9       qhold [-h hold_list] [-t array_range] 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                      The hold type associated with each letter is:
50
51                      u - USER
52
53                      o - OTHER
54
55                      s - SYSTEM
56
57       -t array_range The  array_range argument is an integer id or a range of
58                      integers. Multiple ids or id ranges can be combined in a
59                      comma   delimted   list.   Examples:   -t  1-100  or  -t
60                      1,10,50-100
61
62                      If an array range isn't specified, the command tries  to
63                      operate  on  the  entire  array. The command acts on the
64                      array (or specified range of the array) just as it would
65                      on an individual job.
66

OPERANDS

68       The  qhold  command  accepts one or more job_identifier operands of the
69       form: sequence_number[.server_name][@server]
70

STANDARD ERROR

72       The qhold command will write a diagnostic message to standard error for
73       each error occurrence.
74

EXIT STATUS

76       Upon  successful  processing of all the operands presented to the qhold
77       command, the exit status will be a value of zero.
78
79       If the qhold command fails to process any operand,  the  command  exits
80       with a value greater than zero.
81