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

NAME

6       pbs_terminate - terminate a pbs batch server
7

SYNOPSIS

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

DESCRIPTION

15       Issue  a  batch  request  to  shut  down  a batch server.  This request
16       requires the privilege level usually reserved for batch  operators  and
17       administrators.
18
19       A  Server  Shutdown  batch  request is generated and sent to the server
20       over the connection specified by connect which is the return  value  of
21       pbs_connect().
22
23       The parameter, manner, specifies the manner in which the server is shut
24       down.  The available manners are defined in pbs_ifl.h as:
25
26         #define SHUT_IMMEDIATE 0
27                Shutdown is to be immediate, runnings jobs  are  checkpointed,
28                requeued, or deleted as required.
29
30         #define SHUT_DELAY 1
31                Jobs  which  can be checkpointed are checkpointed, terminated,
32                and requeued.  Jobs  which  cannot  be  checkpointed  but  are
33                rerunnable  are  terminated and requeued.  Shutdown is delayed
34                until the remaining running jobs complete.  No new  jobs  will
35                be started by the server.
36
37       The  server  will not respond to the batch request until the server has
38       completed its termination procedure.
39
40       The parameter, extend, is reserved for  implementation  defined  exten‐
41       sions.
42
43       This call requires PBS Operator or Manager privilege.
44

SEE ALSO

46       qterm(8B) and pbs_connect(3B)
47

DIAGNOSTICS

49       When  the  batch request generated by pbs_terminate() function has been
50       completed successfully by a batch server, the  routine  will  return  0
51       (zero).   Otherwise, a non zero error is returned.  The error number is
52       also set in pbs_errno.
53
54
55
56
57Local                                                        pbs_terminate(3B)