SGE_SHEPHERD(8)       Grid Engine Administrative Commands      SGE_SHEPHERD(8)



NNAAMMEE
       sge_shepherd - Grid Engine single job controlling agent

SSYYNNOOPPSSIISS
       ssggee__sshheepphheerrdd

DDEESSCCRRIIPPTTIIOONN
       _s_g_e___s_h_e_p_h_e_r_d  provides  the  parent  process functionality for a single
       Grid Engine job.  The parent functionality is necessary on UNIX systems
       to  retrieve  resource usage information (see _g_e_t_r_u_s_a_g_e(2)) after a job
       has finished. In addition, the _s_g_e___s_h_e_p_h_e_r_d  forwards  signals  to  the
       job,  such as the signals for suspension, enabling, termination and the
       Grid Engine checkpointing signal (see _s_g_e___c_k_p_t(1) for details).

       The _s_g_e___s_h_e_p_h_e_r_d receives information about the job to be started  from
       the  _s_g_e___e_x_e_c_d(8).   During the execution of the job it actually starts
       up to 5 child processes. First a prolog script is run if  this  feature
       is  enabled  by the pprroolloogg parameter in the cluster configuration. (See
       _s_g_e___c_o_n_f(5).)  Next a parallel environment startup procedure is run  if
       the job is a parallel job. (See _s_g_e___p_e(5) for more information.)  After
       that, the job itself is run, followed by a parallel  environment  shut-
       down  procedure  for  parallel  jobs,  and  finally an epilog script if
       requested by the eeppiilloogg parameter in  the  cluster  configuration.  The
       prolog  and  epilog scripts as well as the parallel environment startup
       and shutdown procedures are to be provided by the Grid Engine  adminis-
       trator  and  are  intended for site-specific actions to be taken before
       and after execution of the actual user job.

       After the  job  has  finished  and  the  epilog  script  is  processed,
       _s_g_e___s_h_e_p_h_e_r_d  retrieves resource usage statistics about the job, places
       them in a job specific subdirectory of the _s_g_e___e_x_e_c_d(8) spool directory
       for reporting through _s_g_e___e_x_e_c_d(8) and finishes.

       _s_g_e___s_h_e_p_h_e_r_d  also  places  an exit status file in the spool directory.
       This exit status can be viewed with qacct -j JobId (see  _q_a_c_c_t(1));  it
       is not the exit status of _s_g_e___s_h_e_p_h_e_r_d itself but of one of the methods
       executed by _s_g_e___s_h_e_p_h_e_r_d_.  This exit status can have several  meanings,
       depending  on in which method an error occurred (if any).  The possible
       methods are: prolog, parallel start, job, parallel stop,  epilog,  sus-
       pend, restart, terminate, clean, migrate, and checkpoint.

       The following exit values are returned:

       0      All methods: Operation was executed successfully.

       99     Job script, prolog and epilog: When _F_O_R_B_I_D___R_E_S_C_H_E_D_U_L_E is not set
              in the configuration (see _s_g_e___c_o_n_f(5)), the job  gets  requeued.
              Otherwise see "Other".

       100    Job  script,  prolog and epilog: When _F_O_R_B_I_D___A_P_P_E_R_R_O_R is not set
              in the configuration (see _s_g_e___c_o_n_f(5)), the job  gets  requeued.
              Otherwise see "Other".

       Other  Job script: This is the exit status of the job itself. No action
              is taken upon this exit status because the meaning of this  exit
              status is not known.
              Prolog,  epilog  and  parallel  start: The queue is set to error
              state and the job is requeued.
              Parallel stop: The queue is set to error state, but the  job  is
              not requeued. It is assumed that the job itself ran successfully
              and only the clean up script failed.
              Suspend, restart, terminate, clean, and migrate: Always success-
              ful.
              Checkpoint: Success, except for kernel checkpointing: checkpoint
              was not successful, did not happen (but migration will happen by
              Grid Engine).

RREESSTTRRIICCTTIIOONNSS
       _s_g_e___s_h_e_p_h_e_r_d  should not be invoked manually, but only by _s_g_e___e_x_e_c_d(8).

FFIILLEESS
       ssggeeppaasssswwdd  ccoonnttaaiinnss  aa  lliisstt  ooff  uusseerr  nnaammeess   aanndd   tthheeiirr ccoorrrreessppoonndd--
       iinngg eennccrryypptteedd WWiinnddoowwss ppaasssswwoorrddss.. IIff aavvaaiillaabbllee,, tthhee ppaasssswwoorrdd  ffiillee  wwiillll
       bbee   uusseedd   bbyy  ssggee__sshheepphheerrdd.. TToo  cchhaannggee  tthhee  ccoonntteennttss  ooff  tthhiiss  ffiillee
       pplleeaassee  uussee  tthhee  ssggeeppaasssswwdd  ccoommmmaanndd.. IItt iiss nnoott aaddvviisseedd ttoo  cchhaannggee tthhaatt
       ffiillee mmaannuuaallllyy..
       _<_e_x_e_c_d___s_p_o_o_l_>_/_j_o_b___d_i_r_/_<_j_o_b___i_d_>     job specific directory

SSEEEE AALLSSOO
       _s_g_e___i_n_t_r_o(1), _s_g_e___c_o_n_f(5), _s_g_e___e_x_e_c_d(8).

CCOOPPYYRRIIGGHHTT
       See _s_g_e___i_n_t_r_o(1) for a full statement of rights and permissions.



GE 6.0                   $Date: 2007/06/05 16:59:41 $          SGE_SHEPHERD(8)
