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

NAME

6       pbs_deljob - delete a pbs batch job
7

SYNOPSIS

9       #include <pbs_error.h>
10       #include <pbs_ifl.h>
11
12       int pbs_deljob(int connect, char *job_id, char *extend)
13

DESCRIPTION

15       Issue  a batch request to delete a batch job.  If the batch job is run‐
16       ning, the execution server will send the  SIGTERM  signal  followed  by
17       SIGKILL .
18
19       A Delete Job batch request is generated and sent to the server over the
20       connection specified by connect which is the return value  of  pbs_con‐
21       nect().
22
23       The  argument,  job_id,  identifies  which  job is to be deleted, it is
24       specified in the form: sequence_number.server
25
26       The argument, extend, is overloaded to  serve  two  purposes.   If  the
27       pointer extend points to a string of the form:
28       deldelay=nnnn,
29       it  is  used  to provide control over the delay between sending SIGTERM
30       and SIGKILL signals to a running job.  The characters  nnnn  specify  a
31       unsigned  decimal integer time delay in seconds.  If extend is the null
32       pointer or points to  a  null  string,  the  administrator  established
33       default time delay is used.
34
35       If  extend points to a string other than the above, it is taken as text
36       to be appended to the message mailed to to the job owner.   This  mail‐
37       ing occurs if the job is deleted by a user other than the job owner.
38

SEE ALSO

40       qdel(1B) and pbs_connect(3B)
41

DIAGNOSTICS

43       When  the batch request generated by the pbs_deljob() function has been
44       completed successfully by a batch server, the  routine  will  return  0
45       (zero).   Otherwise, a non zero error is returned.  The error number is
46       also set in pbs_errno.
47
48
49
50
51
52Local                                                           pbs_deljob(3B)