← Back to branch summary

~ubuntu-branches/ubuntu/utopic/gridengine/utopic

« back to all changes in this revision

Viewing changes to doc/htmlman/htmlman3/drmaa_control.html

  • Committer: Bazaar Package Importer
  • Author(s): Mark Hymers
  • Date: 2008-06-25 22:36:13 UTC
  • Revision ID: james.westby@ubuntu.com-20080625223613-tvd9xlhuoct9kyhm
Tags: upstream-6.2~beta2
Import upstream version 6.2~beta2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/htmlman/htmlman3/drmaa_control.html
 
1
<HTML>
 
2
<BODY BGCOLOR=white>
 
3
<PRE>
 
4
<!-- Manpage converted by man2html 3.0.1 -->
 
5
NAME
 
6
     drmaa_job_ps, drmaa_control, - Monitor and control jobs
 
7
 
 
8
SYNOPSIS
 
9
     #include "drmaa.h"
 
10
 
 
11
     int drmaa_job_ps(
 
12
          const char *job_id,
 
13
          int *remote_ps,
 
14
          char *error_diagnosis,
 
15
          size_t error_diag_len
 
16
     );
 
17
 
 
18
     int drmaa_control(
 
19
          const char *jobid,
 
20
          int action,
 
21
          char *error_diagnosis,
 
22
          size_t error_diag_len
 
23
     );
 
24
 
 
25
DESCRIPTION
 
26
     The drmaa_job_ps() function returns the status of  the  Grid
 
27
     Engine  job <I>job</I>_<I>id</I> into the integer pointed to by <I>remote</I>_<I>ps</I>.
 
28
     Possible return values are
 
29
 
 
30
          DRMAA_PS_UNDETERMINED        job status cannot be determined
 
31
          DRMAA_PS_QUEUED_ACTIVE       job is queued and active
 
32
          DRMAA_PS_SYSTEM_ON_HOLD      job is queued and in system hold
 
33
          DRMAA_PS_USER_ON_HOLD        job is queued and in user hold
 
34
          DRMAA_PS_USER_SYSTEM_ON_HOLD job is queued and in user and system hold
 
35
          DRMAA_PS_RUNNING             job is running
 
36
          DRMAA_PS_SYSTEM_SUSPENDED    job is system suspended
 
37
          DRMAA_PS_USER_SUSPENDED      job is user suspended
 
38
          DRMAA_PS_DONE                job finished normally
 
39
          DRMAA_PS_FAILED              job finished, but failed
 
40
 
 
41
     Jobs' user hold and user suspend states  can  be  controlled
 
42
     via  <B><A HREF="../htmlman3/drmaa_control.html">drmaa_control(3)</A></B>.  For affecting system hold and system
 
43
     suspend states the appropriate Grid Engine  interfaces  must
 
44
     be used.
 
45
 
 
46
  drmaa_control()
 
47
     The drmaa_control() function applies control  operations  on
 
48
     Grid  Engine  jobs.  <I>jobid</I> may contain either an Grid Engine
 
49
     jobid or `DRMAA_JOB_IDS_SESSION_ALL' to refer  to  all  jobs
 
50
     submitted    during   the   DRMAA   session   opened   using
 
51
     <B><A HREF="../htmlman3/drmaa_init.html">drmaa_init(3)</A></B>.  Legal values for <I>action</I> and  their  meanings
 
52
     are:
 
53
 
 
54
          DRMAA_CONTROL_SUSPEND        suspend the job
 
55
          DRMAA_CONTROL_RESUME         resume the job,
 
56
          DRMAA_CONTROL_HOLD           put the job on-hold
 
57
          DRMAA_CONTROL_RELEASE        release the hold on the job
 
58
          DRMAA_CONTROL_TERMINATE      kill the job
 
59
 
 
60
     The DRMAA suspend/resume operations are  equivalent  to  the
 
61
     use  of  `-s  &lt;jobid&gt;'  and  `-us &lt;jobid&gt;' options with Grid
 
62
     Engine  <B><A HREF="../htmlman1/qmod.html">qmod(1)</A></B>.   The  DRMAA  hold/release  operations  are
 
63
     equivalent  to  the use of Grid Engine <B><A HREF="../htmlman1/qhold.html">qhold(1)</A></B> and <B><A HREF="../htmlman1/qrls.html">qrls(1)</A></B>.
 
64
     The DRMAA terminate operation is equivalent to  the  use  of
 
65
     Grid Engine <B><A HREF="../htmlman1/qdel.html">qdel(1)</A></B>.  Only user hold and user suspend can be
 
66
     controlled via <B><A HREF="../htmlman3/drmaa_control.html">drmaa_control(3)</A></B>.  For affecting system  hold
 
67
     and system suspend states the appropriate Grid Engine inter-
 
68
     faces must be used.
 
69
 
 
70
ENVIRONMENTAL VARIABLES
 
71
     SGE_ROOT       Specifies the location  of  the  Grid  Engine
 
72
                    standard configuration files.
 
73
 
 
74
     SGE_CELL       If set, specifies  the  default  Grid  Engine
 
75
                    cell  to  be  used.  To address a Grid Engine
 
76
                    cell Grid Engine uses (in the order  of  pre-
 
77
                    cedence):
 
78
 
 
79
                         The name of the cell  specified  in  the
 
80
                         environment  variable SGE_CELL, if it is
 
81
                         set.
 
82
 
 
83
                         The  name  of  the  default  cell,  i.e.
 
84
                         default.
 
85
 
 
86
 
 
87
     SGE_DEBUG_LEVEL
 
88
                    If  set,  specifies  that  debug  information
 
89
                    should  be written to stderr. In addition the
 
90
                    level of detail in which debug information is
 
91
                    generated is defined.
 
92
 
 
93
     SGE_QMASTER_PORT
 
94
                    If set,  specifies  the  tcp  port  on  which
 
95
                    <B><A HREF="../htmlman8/sge_qmaster.html">sge_qmaster(8)</A></B> is expected to listen for com-
 
96
                    munication requests.  Most installations will
 
97
                    use  a  services  map entry instead to define
 
98
                    that port.
 
99
 
 
100
RETURN VALUES
 
101
     Upon    successful    completion,    drmaa_job_ps(),     and
 
102
     drmaa_control()  return  DRMAA_ERRNO_SUCCESS.  Other  values
 
103
     indicate an error. Up to <I>error</I>_<I>diag</I>_<I>len</I> characters of  error
 
104
     related  diagnosis  information  is  then  provided  in  the
 
105
     buffer, <I>error</I>_<I>diagnosis</I>.
 
106
 
 
107
ERRORS
 
108
     The drmaa_job_ps(), and drmaa_control() will fail if:
 
109
 
 
110
  DRMAA_ERRNO_INTERNAL_ERROR
 
111
     Unexpected  or  internal  DRMAA  error,  like  system   call
 
112
     failure, etc.
 
113
 
 
114
  DRMAA_ERRNO_DRM_COMMUNICATION_FAILURE
 
115
     Could not contact DRM system for this request.
 
116
 
 
117
  DRMAA_ERRNO_AUTH_FAILURE
 
118
     The specified request was not processed successfully due  to
 
119
     authorization failure.
 
120
 
 
121
  DRMAA_ERRNO_INVALID_ARGUMENT
 
122
     The input value for an argument is invalid.
 
123
 
 
124
  DRMAA_ERRNO_NO_ACTIVE_SESSION
 
125
     Failed because there is no active session.
 
126
 
 
127
  DRMAA_ERRNO_NO_MEMORY
 
128
     Failed allocating memory.
 
129
 
 
130
  DRMAA_ERRNO_INVALID_JOB
 
131
     The specified job does not exist.
 
132
 
 
133
     The drmaa_control() will fail if:
 
134
 
 
135
  DRMAA_ERRNO_RESUME_INCONSISTENT_STATE
 
136
     The job is not suspended. The resume  request  will  not  be
 
137
     processed.
 
138
 
 
139
  DRMAA_ERRNO_SUSPEND_INCONSISTENT_STATE
 
140
     The job is not running and thus cannot be suspended.
 
141
 
 
142
  DRMAA_ERRNO_HOLD_INCONSISTENT_STATE
 
143
     The job cannot be moved to a hold state.
 
144
 
 
145
  DRMAA_ERRNO_RELEASE_INCONSISTENT_STATE
 
146
     The job is not in a hold state.
 
147
 
 
148
SEE ALSO
 
149
     <B><A HREF="../htmlman3/drmaa_submit.html">drmaa_submit(3)</A></B>and <B><A HREF="../htmlman3/drmaa_wait.html">drmaa_wait(3)</A></B>.
 
150
 
 
151
 
 
152
 
 
153
 
 
154
 
 
155
 
 
156
 
 
157
 
 
158
 
 
159
 
 
160
 
 
161
 
 
162
</PRE>
 
163
<HR>
 
164
<ADDRESS>
 
165
Man(1) output converted with
 
166
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 
167
</ADDRESS>
 
168
</BODY>
 
169
</HTML>