Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
pbs_terminate(3B)		      PBS		     pbs_terminate(3B)

NAME
       pbs_terminate - terminate a pbs batch server

SYNOPSIS
       #include	<pbs_error.h>
       #include	<pbs_ifl.h>

       int pbs_terminate(int connect, int manner, char *extend)

DESCRIPTION
       Issue  a	 batch	request	to shut	down a batch server.  This request re-
       quires the privilege level usually reserved for batch operators and ad-
       ministrators.

       A  Server  Shutdown  batch  request is generated	and sent to the	server
       over the	connection specified by	connect	which is the return  value  of
       pbs_connect().

       The parameter, manner, specifies	the manner in which the	server is shut
       down.  The available manners are	defined	in pbs_ifl.h as:

	 #define SHUT_IMMEDIATE	0
		Shutdown is to be immediate, runnings jobs  are	 checkpointed,
		requeued, or deleted as	required.

	 #define SHUT_DELAY 1
		Jobs  which  can be checkpointed are checkpointed, terminated,
		and requeued.  Jobs which cannot be checkpointed but  are  re-
		runnable are terminated	and requeued.  Shutdown	is delayed un-
		til the	remaining running jobs complete.  No new jobs will  be
		started	by the server.

       The  server  will not respond to	the batch request until	the server has
       completed its termination procedure.

       The parameter, extend, is reserved for  implementation  defined	exten-
       sions.

       This call requires PBS Operator or Manager privilege.

SEE ALSO
       qterm(8B) and pbs_connect(3B)

DIAGNOSTICS
       When  the  batch	request	generated by pbs_terminate() function has been
       completed successfully by a batch server, the  routine  will  return  0
       (zero).	 Otherwise, a non zero error is	returned.  The error number is
       also set	in pbs_errno.

Local							     pbs_terminate(3B)

NAME | SYNOPSIS | DESCRIPTION | SEE ALSO | DIAGNOSTICS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=pbs_terminate&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help