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

FreeBSD Manual Pages

  
 
  

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

NAME
       pbs_holdjob - place a hold on a pbs batch job

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

       int pbs_holdjob(int connect, char *job_id, char *hold_type,
       char *extend)

DESCRIPTION
       Issue a batch request to	place a	hold upon a job.

       A  Hold	Job batch request is generated and sent	to the server over the
       connection specified by connect which is	the return value  of  pbs_con-
       nect().

       The  argument, job_id, identifies which job is to be held, it is	speci-
       fied in the form: sequence_number.server

       The parameter, hold_type, contains the type of hold to be applied.  The
       possible	values are defined in pbs_ifl.h	as:

	      #define USER_HOLD	"u"
		     Available	to  the	 owner of the job, the batch operator,
		     and the batch administrator.

	      #define OTHER_HOLD "o"
		     Available to the batch operator and the batch administra-
		     tor.

	      #define SYSTEM_HOLD "s"
		     Available only to the batch administrator.

       If  hold_type  is  either  a  null  pointer or points to	a null string,
       USER_HOLD will be applied.

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

SEE ALSO
       qhold(1B), pbs_connect(3B), pbs_alterjob(3B), and pbs_rlsjob(3B)

DIAGNOSTICS
       When  the  batch	 request generated by pbs_holdjob () 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_holdjob(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_holdjob&sektion=3b&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help