drmaa_jobtemplate(3)           Grid Engine DRMAA          drmaa_jobtemplate(3)



[1mNAME[0m
       drmaa_allocate_job_template,                 drmaa_delete_job_template,
       drmaa_set_attribute,  drmaa_get_attribute,  drmaa_set_vector_attribute,
       drmaa_get_vector_attribute,                  drmaa_get_next_attr_value,
       drmaa_get_num_attr_values,  drmaa_release_attr_values  -  Grid   Engine
       DRMAA job template handling


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

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

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

       [1mint drmaa_set_attribute([0m
              [1mdrmaa_job_template_t *jt,[0m
              [1mconst char *name,[0m
              [1mconst char *value,[0m
              [1mchar *error_diagnosis,[0m
              [1msize_t error_diag_len[0m
       [1m);[0m

       [1mint drmaa_get_attribute([0m
              [1mdrmaa_job_template_t *jt,[0m
              [1mconst char *name,[0m
              [1mchar *value,[0m
              [1msize_t value_len,[0m
              [1mchar *error_diagnosis,[0m
              [1msize_t error_diag_len[0m
       [1m);[0m

       [1mint drmaa_set_vector_attribute([0m
              [1mdrmaa_job_template_t *jt,[0m
              [1mconst char *name,[0m
              [1mconst char *value[],[0m
              [1mchar *error_diagnosis,[0m
              [1msize_t error_diag_len[0m
       [1m);[0m

       [1mint drmaa_get_vector_attribute([0m
              [1mdrmaa_job_template_t *jt,[0m
              [1mconst char *name,[0m
              [1mdrmaa_attr_values_t **values,[0m
              [1mchar *error_diagnosis,[0m
              [1msize_t error_diag_len[0m
       [1m);[0m

       [1mint drmaa_get_next_attr_value([0m
              [1mdrmaa_attr_values_t* values,[0m
              [1mchar *value,[0m
              [1mint value_len[0m
       [1m);[0m

       [1mint drmaa_get_num_attr_values([0m
              [1mdrmaa_attr_values_t* values,[0m
              [1mint *size[0m
       [1m);[0m

       [1mvoid drmaa_release_attr_values([0m
              [1mdrmaa_attr_values_t* values[0m
       [1m);[0m


[1mDESCRIPTION[0m
       The  drmaa_allocate_job_template()  function  allocates a new DRMAA job
       template into [4mjt[24m. DRMAA job templates describe specifics of  jobs  that
       are submitted using [4mdrmaa_run_job[24m(3) and [4mdrmaa_run_bulk_jobs[24m(3).

   [1mdrmaa_delete_job_template()[0m
       The drmaa_delete_job_template() function releases all resources associ-
       ated with the DRMAA job template [4mjt[24m. Jobs that were submitted using the
       job template are not affected.


   [1mdrmaa_set_attribute()[0m
       The  drmaa_set_attribute() function stores the [4mvalue[24m under [4mname[24m for the
       given DRMAA job template,  [4mjt[24m  .  Only  non-vector  attributes  may  be
       passed.


   [1mdrmaa_get_attribute()[0m
       The  drmaa_get_attribute()  function returns into [4mvalue[24m up to [4mvalue_len[0m
       bytes from the string stored for the non-vector attribute, [4mname[24m, in the
       DRMAA job template, [4mjt[24m.


   [1mdrmaa_set_vector_attribute()[0m
       The  drmaa_set_vector_attribute()  function stores the strings in [4mvalue[0m
       under [4mname[24m in the list of vector attributes for  the  given  DRMAA  job
       template,  [4mjt[24m . Only vector attributes may be passed. The [4mvalue[24m pointer
       array must be [4mNULL[24m terminated.


   [1mdrmaa_get_vector_attribute()[0m
       The drmaa_get_vector_attribute() function returns into [4mvalues[24m  a  DRMAA
       attribute string vector containing all string values stored in the vec-
       tor attribute, [4mname[24m.  The values in the DRMAA values string vector  can
       be extracted using [4mdrmaa_get_next_attr_value[24m(3).  The caller is respon-
       sible for releasing the DRMAA values string vector returned into [4mvalues[0m
       using [4mdrmaa_release_attr_values[24m(3).


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


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


   [1mdrmaa_release_attr_values()[0m
       The drmaa_release_attr_values() function releases all resources associ-
       ated with the DRMAA values string vector, [4mvalues[24m.


[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_allocate_job_template(),
       drmaa_delete_job_template(),                     drmaa_set_attribute(),
       drmaa_get_attribute(),   drmaa_set_vector_attribute(),   drmaa_get_vec-
       tor_attribute(),       and      drmaa_get_next_attr_value()      return
       DRMAA_ERRNO_SUCCESS.  Other  values   indicate   an   error.    Up   to
       [4merror_diag_len[24m  characters  of  error  related diagnosis information is
       then provided in the buffer [4merror_diagnosis[24m.


[1mERRORS[0m
       The     drmaa_allocate_job_template(),     drmaa_delete_job_template(),
       drmaa_set_attribute(),       drmaa_get_attribute(),      drmaa_set_vec-
       tor_attribute(),           drmaa_get_vector_attribute(),            and
       drmaa_get_next_attr_value() functions 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_set_attribute() and  drmaa_set_vector_attribute()  will  fail
       if:

   [1mDRMAA_ERRNO_INVALID_ATTRIBUTE_FORMAT[0m
       The format for the attribute value is invalid.

   [1mDRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE[0m
       The value for the attribute is invalid.

   [1mDRMAA_ERRNO_CONFLICTING_ATTRIBUTE_VALUES[0m
       The  value  of  this  attribute  is  conflicting  with a previously set
       attributes.

       The drmaa_get_attribute() and  drmaa_get_vector_attribute()  will  fail
       if:

   [1mDRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE[0m
       The specified attribute is not set in the DRMAA job template.

       The drmaa_get_next_attr_value() will fail if:

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


[1mSEE ALSO[0m
       [4mdrmaa_submit[24m(3)and [4mdrmaa_attributes[24m(3).



GE 6.2u2                 $Date: 2008/07/08 09:10:04 $     drmaa_jobtemplate(3)
