drmaa_submit(3)                Grid Engine DRMAA               drmaa_submit(3)



[1mNAME[0m
       drmaa_run_job,        drmaa_run_bulk_jobs,       drmaa_get_next_job_id,
       drmaa_get_num_job_ids, drmaa_release_job_ids - Job submission


[1mSYNOPSIS[0m
       [1m#include "drmaa.h"[0m

       [1mint drmaa_run_job([0m
              [1mchar *job_id,[0m
              [1msize_t job_id_len,[0m
              [1mdrmaa_job_template_t *jt,[0m
              [1mchar *error_diagnosis,[0m
              [1msize_t error_diag_len[0m
       [1m);[0m

       [1mint drmaa_run_bulk_jobs([0m
              [1mdrmaa_job_ids_t **jobids,[0m
              [1mdrmaa_job_template_t *jt,[0m
              [1mint start,[0m
              [1mint end,[0m
              [1mint incr,[0m
              [1mchar *error_diagnosis,[0m
              [1msize_t error_diag_len[0m
       [1m);[0m

       [1mint drmaa_get_next_job_id([0m
              [1mdrmaa_job_ids_t* values,[0m
              [1mchar *value,[0m
              [1mint value_len[0m
       [1m);[0m

       [1mint drmaa_get_num_job_ids([0m
              [1mdrmaa_job_ids_t* values,[0m
              [1mint *size[0m
       [1m);[0m

       [1mvoid drmaa_release_job_ids([0m
              [1mdrmaa_job_ids_t* values[0m
       [1m);[0m


[1mDESCRIPTION[0m
       drmaa_run_job() submits an Grid Engine job with attributes  defined  in
       the  DRMAA  job  template, [4mjt[24m. On success up to [4mjob_id_len[24m bytes of the
       job identifier are returned into the buffer, [4mjob_id[24m.

   [1mdrmaa_run_bulk_jobs()[0m
       The drmaa_run_bulk_jobs() submits a Grid Engine array job very much  as
       if  the [4mqsub[24m(1) option `-t [4mstart[24m-[4mend[24m:[4mincr[24m' had been used along with the
       additional attributes defined in the DRMAA job template, [4mjt[24m.  The  same
       constraints  regarding  value ranges are also in effect for the parame-
       ters [4mstart[24m, [4mend[24m, and [4mincr[24m as for [4mqsub[24m(5) -t. On success a DRMAA job  id
       string  vector  containing  job  identifiers for each array job task is
       returned into [4mjobids[24m.  The job identifiers in the job id string  vector
       can be extracted using [4mdrmaa_get_next_job_id[24m(3).  The number of identi-
       fiers  in  the  job  id  string  vector   can   be   determined   using
       [4mdrmaa_get_num_job_ids[24m(3).  Note that this function is only available in
       the 1.0 implementation.  The caller is responsible  for  releasing  the
       job     id     string     vector    returned    into    [4mjobids[24m    using
       [4mdrmaa_release_job_ids[24m(3).


   [1mdrmaa_get_next_job_id()[0m
       Each time drmaa_get_next_job_id() is called it returns into the buffer,
       [4mvalue[24m,  up to [4mvalue_len[24m bytes of the next entry stored in the DRMAA job
       id string vector, [4mvalues[24m.  Once the job ids list  has  been  exhausted,
       DRMAA_ERRNO_NO_MORE_ELEMENTS is returned.


   [1mdrmaa_get_num_job_ids()[0m
       The  drmaa_get_num_job_ids() returns into [4msize[24m the number of entries in
       the DRMAA job ids string vector.  This function is  only  available  in
       the 1.0 implementation.


   [1mdrmaa_release_job_ids()[0m
       The drmaa_release_attr_job_id() function releases all resources associ-
       ated with the DRMAA job id string vector, [4mvalues[24m. This operation has no
       effect on the actual Grid Engine array job tasks.


[1mENVIRONMENTAL VARIABLES[0m
       [1mGE_ROOT        [22mSpecifies  the location of the Grid Engine standard con-
                      figuration files.

       [1mGE_CELL        [22mIf set, specifies the default Grid  Engine  cell  to  be
                      used. To address a Grid Engine cell Grid Engine uses (in
                      the order of precedence):

                             The name of the cell specified in the environment
                             variable GE_CELL, if it is set.

                             The name of the default cell, i.e. [1mdefault[22m.


       [1mGE_DEBUG_LEVEL [22mIf set, specifies that debug information should be writ-
                      ten to stderr. In addition the level of detail in  which
                      debug information is generated is defined.

       [1mGE_QMASTER_PORT[0m
                      If set, specifies the tcp port on which [4mge_qmaster[24m(8) is
                      expected to listen  for  communication  requests.   Most
                      installations  will  use a services map entry instead to
                      define that port.

[1mRETURN VALUES[0m
       Upon successful completion, drmaa_run_job(), drmaa_run_bulk_jobs(), and
       drmaa_get_next_job_id()  return DRMAA_ERRNO_SUCCESS. Other values indi-
       cate an error.  Up to [4merror_diag_len[24m characters of error related  diag-
       nosis information is then provided in the buffer [4merror_diagnosis[24m.


[1mERRORS[0m
       The drmaa_run_job(), drmaa_run_bulk_jobs(), and drmaa_get_next_job_id()
       will fail if:

   [1mDRMAA_ERRNO_INTERNAL_ERROR[0m
       Unexpected or internal DRMAA error, like system call failure, etc.

   [1mDRMAA_ERRNO_DRM_COMMUNICATION_FAILURE[0m
       Could not contact DRM system for this request.

   [1mDRMAA_ERRNO_AUTH_FAILURE[0m
       The specified request is not processed successfully due  to  authoriza-
       tion failure.

   [1mDRMAA_ERRNO_INVALID_ARGUMENT[0m
       The input value for an argument is invalid.

   [1mDRMAA_ERRNO_NO_ACTIVE_SESSION[0m
       Failed because there is no active session.

   [1mDRMAA_ERRNO_NO_MEMORY[0m
       Failed allocating memory.

       The drmaa_run_job() and drmaa_run_bulk_jobs() functions will fail if:

   [1mDRMAA_ERRNO_TRY_LATER[0m
       The DRM system indicated that it is too busy to accept the job. A retry
       may succeed, however.

   [1mDRMAA_ERRNO_DENIED_BY_DRM[0m
       The DRM system rejected the job. The job will never be accepted due  to
       DRM configuration or job template settings.

       The drmaa_get_next_job_id() will fail if:

   [1mDRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE[0m
       When there are no more entries in the vector.


[1mSEE ALSO[0m
       [4mdrmaa_attributes[24m(3), [4mdrmaa_jobtemplate[24m(3).



GE 6.2u2                 $Date: 2008/07/08 09:10:05 $          drmaa_submit(3)
