1SGE_TYPES(1)               Grid Engine User Commands              SGE_TYPES(1)
2
3
4

NAME

6       sge_types - Grid Engine type descriptions
7

DESCRIPTION

9       The  Grid Engine user interface consists of several programs and files.
10       Some command-line switches and several file attributes are  types.  The
11       syntax for these types is explained in this page.
12

OBJECT TYPES

14       These types are used for defining Grid Engine configuration:
15
16   calendar_name
17       A calendar name is the name of a Grid Engine calendar described in cal‐
18       endar_conf(5).
19
20       calendar_name := object_name
21
22   ckpt_name
23       A "ckpt_name" is the name of  a  Grid  Engine  checkpointing  interface
24       described in checkpoint(5).
25
26       ckpt_name := object_name
27
28   complex_name
29       A  complex  name  is  the  name  of  a  Grid  Engine resource attribute
30       described in complex(5).
31
32       complex_name := object_name
33
34   host_identifier
35       A host identifier can be either a host name or a host group name.
36
37       host_identifier := host_name | hostgroup_name
38
39   hostgroup_name
40       A host group name is the name of a Grid Engine host group described  in
41       hostgroup(5).   Note, to allow host group names easily be differed from
42       host names a "@" prefix is used.
43
44       hostgroup_name := @object_name
45
46   host_name
47       A host name is the official name of a host  node.  Host  names  with  a
48       domain  specification  such  as  "gridmaster.sun.com" are called fully-
49       qualified host names, whereas host names like "gridmaster"  are  called
50       short   host  names.  Note,  there  are  the  install  time  parameters
51       default_domain and ignore_fqdn (see bootstrap(5)) which affect how Grid
52       Engine deals with host names in general.
53
54   memory_specifier
55       Memory  specifiers  are  positive decimal, hexadecimal or octal integer
56       constants  which  may  be  followed by a multiplier letter. Valid  mul‐
57       tiplier  letters  are k, K, m, M,  g  and  G, where  k  means  multiply
58       the  value by 1000, K multiply by 1024, m multiply by 1000*1000, M mul‐
59       tiply   by   1024*1024,  g multiply by 1000*1000*1000 and G multiply by
60       1024*1024*1024.  If no  multiplier  is  present,  the  value  is   just
61       counted  in bytes.
62
63   pe_name
64       A "pe_name" is the name of a Grid Engine parallel environment described
65       in sge_pe(5).
66
67       pe_name := object_name
68
69   project_name
70       A project name is the name  of  a  Grid  Engine  project  described  in
71       project(5).
72
73       project_name := object_name
74
75   queue_name
76       A  queue  name  is  the  name  of  a  Grid  Engine  queue  described in
77       queue_conf(5).
78
79       queue_name  := object_name
80
81   time_specifier
82       A time specifier either consists of a positive decimal, hexadecimal  or
83       octal integer constant, in which case the value is interpreted to be in
84       seconds, or is built by 3 decimal integer numbers  separated  by  colon
85       signs  where  the first number counts the hours, the second the minutes
86       and the third the seconds. If a number is zero it can be left  out  but
87       the separating colon must remain (e.g. 1:0:1 = 1::1 means 1 hours and 1
88       second).
89
90   user_name
91       A user name can be the name of a login(1) user or of  the  Grid  Engine
92       user object described in user(5).
93
94       user_name := object_name
95
96   userset_name
97       A user set name is the name of an Grid Engine access list or department
98       described in access_list(5).
99
100       userset_name := object_name
101
102   object_name
103       An object name is a sequence of  up  to  512  ASCII  string  characters
104       except  "\n",  "\t", "\r", " ", "/", ":", "´", "\", "[", "]", "{", "}",
105       "|", "(", ")", "@", "%", "," or the " character itself.
106

MATCHING TYPES

108       These types are used for matching Grid Engine configuration:
109
110   expression
111       A wildcard expression is a regular boolean expression that consists  of
112       one  or  more  patterns  joined  by boolean operators.  When a wildcard
113       expression is used, the following definition applies:
114
115       expression= ["!"] ["("] valExp [")"] [ AND_OR expression ]*
116       valExp  = pattern | expression
117       AND_OR  = "&" | "|"
118
119       where:
120
121       "!"       not operator -- negate the following pattern or expression
122       "&"       and operator -- logically and with the following expression
123       "|"       or operator -- logically or with the following expression
124       "("       open bracket -- begin an inner expression.
125       ")"       close bracket -- end an inner expression.
126       "pattern" see the pattern definition that's follow
127
128       The expression itself should be put inside quotes ('"') to ensure  that
129       clients receive the complete expression.
130
131       e.g.
132              "(lx*|sol*)&*64*" any string beginning with either "lx" or
133                                "sol" and containing "64"
134              "rh_3*&!rh_3.1"   any string beginning with "rh_3", except
135                                "rh_3.1"
136
137   pattern
138       When patterns are used the following definitions apply:
139
140       "*"     matches any character and any number of characters
141               (between 0 and inv).
142       "?"     matches any character. It must be a character other that the empty
143               string
144       "."     is the character ".". It has no other meaning
145       "\"     escape character. "\\" = "\", "\*" = "*", "\?" = "?"
146       "[...]" specifies an array or a range of allowed
147               characters for one character at a specific position.
148               Character ranges may be specified using the a-z notation.
149               The caret symbol (^) is not interpreted as a logical
150               not; it is interpreted literally.
151
152       For more details please see
153       fnmatch(5)
154
155
156       The  pattern  itself  should  be put inside quotes ('"') to ensure that
157       clients receive the complete pattern.
158
159   range
160       The task range specifier has the form
161
162       n[-m[:s]][,n[-m[:s]], ...]  or n[-m[:s]][ n[-m[:s]] ...]
163
164       and thus consists of a comma or blank separated list  of  range  speci‐
165       fiers  n[-m[:s]].  The  ranges are concatenated to the complete task id
166       range. Each range may be a single number, a simple range of the form n-
167       m or a range with a step size.
168
169   wc_host
170       A  wildcard host specification (wc_host) is a wildcard expression which
171       might match one or more hosts used in the cluster.  The first character
172       of  that  string  never  begins with an at-character ('@'), even if the
173       expression begins with a wildcard character.
174
175       e.g.
176              *            all hosts
177              a*           all host beginning with an 'a'
178
179   wc_hostgroup
180       A wildcard hostgroup specification (wc_hostgroup) is a wildcard expres‐
181       sion  which might match one or more hostgroups.  The first character of
182       that string is always an at-character ('@').
183
184       More information concerning hostgroups can be found in hostgroup(5)
185
186       e.g.
187              @*           all hostgroups in the cluster
188              @solaris     the @solaris hostgroup
189
190   wc_job
191       The wildcard job specification is a placeholder for job ids, job  names
192       include job name pattern. A job id always references one job, while the
193       names and pattern might reference multiple jobs.
194
195       wc_job := job-id | job-name | pattern
196
197   wc_job_range
198       The wildcard job range specification allows to reference specific array
199       tasks for one or multiple jobs. The job is referenced via wc_job and in
200       addition gets a range specifier for the array tasks.
201
202       wc_job_range := wc_job [ -t range]
203
204   wc_job_list
205       The wildcard job list specification allows to reference  multiple  jobs
206       with one command.
207
208       wc_job_list := wc_job [ , wc_job , ...]
209
210   wc_job_range_list
211       The  wildcard job range list (wc_job_range_list) is specified by one of
212       the following forms:
213
214           wc_job[ -t range][{, }wc_job[ -t range]{, }...]
215
216       If present, the task_range restricts the effect of the  qmod  operation
217       to  the array job task range specified as suffix to the job id (see the
218       -t option to qsub(1) for further details on array jobs).
219
220   wc_qdomain
221       wc_qdomain := wc_cqueue "@" wc_hostgroup
222
223       A wildcard expression queue domain  specification  (wc_qdomain)  starts
224       with  a  wildcard expression cluster queue name (wc_cqueue) followed by
225       an at-character '@' and a wildcard expression  hostgroup  specification
226       (wc_hostgroup).
227
228       wc_qdomain  are  used to address a group of queue instances.  All queue
229       instances residing on a hosts which is part of matching hostgroups will
230       be  addressed. Please note, that wc_hostgroup always begins with an at-
231       character.
232
233       e.g.
234              *@@*         all queue instances whose underlying
235                           host is part of at least one hostgroup
236              a*@@e*       all queue instances beginning with an 'a' whose underlying
237                           host is part of at least one hostgroup beginning with 'e'
238              *@@solaris   all queue instances on hosts part of
239                           the @solaris hostgroup
240
241   wc_cqueue
242       A wildcard expression cluster  queue  specification  (wc_cqueue)  is  a
243       wildcard  expression  which might match one or more cluster queues used
244       in the cluster.  That string never contains an at-character ('@'), even
245       if the expression begins with a wildcard character.
246
247       e.g.
248              *            all cluster queues
249              a*           all cluster queues beginning with an 'a'
250              a*&!adam     all cluster queues beginning with an 'a',but not adam
251
252   wc_qinstance
253       wc_qinstance := wc_cqueue "@" wc_host
254
255       A  wildcard  expression  queue  instance  specification  (wc_qinstance)
256       starts with a wildcard expression cluster queue name  (wc_cqueue)  fol‐
257       lowed  by  an  at-character  '@'  and  a  wildcard  expression hostname
258       (wc_host).
259
260       wc_qinstance expressions are used to address a group of queue instances
261       whose  underlying  hostname  matches the given expression.  Please note
262       that the first character of wc_host does  not  match  the  at-character
263       '@'.
264
265       e.g.
266              *@*          all queue instances in the cluster
267              *@b*         all queue instances whose
268                           hostname begins with a 'b'
269              *@b*|c*      all queue instances whose
270                           hostname begins with a 'b' or 'c'
271
272   wc_queue
273       wc_queue := wc_cqueue | wc_qdomain | wc_qinstance
274
275       A  wildcard  queue  expression  (wc_queue)  might  either be a wildcard
276       expression  cluster  queue  specification  (wc_cqueue)  or  a  wildcard
277       expression  queue  domain  specification  (wc_qdomain)  or  a  wildcard
278       expression queue instance specification (wc_qinstance).
279
280       e.g.
281              big_*1           cluster queues which begin with
282                               "big_" and end with "1"
283              big_*&!*1        cluster queues which begin with
284                               "big_" ,but does not end with "1"
285              *@fangorn        all qinstances residing on host
286                               fangorn
287
288   wc_queue_list
289       wc_queue_list := wc_queue ["," wc_queue "," ...]
290
291       Comma separated list of wc_queue elements.
292
293       e.g.
294              big, medium_*@@sol*, *@fangorn.sun.com
295
296   wc_user
297       A wildcard user name pattern is either a wildcard user name  specifica‐
298       tion or a full user name.
299
300       wc_user := user_name | pattern
301
302   wc_user_list
303       A list of user names.
304
305       wc_user_list := wc_user [ , wc_user , ...]
306
307   wc_project
308       A wildcard project name pattern is either a wildcard project name spec‐
309       ification or a full project name.
310
311       wc_project := project | pattern
312
313   wc_pe_name
314       A wildcard parallel environment name pattern is either  a  wildcard  PE
315       name specification or a full PE name.
316
317       wc_pe_name := pe_name | pattern
318

SEE ALSO

320       qacct(1), qconf(1), qquota(1)
321
323       Copyright: 2004-2007 by Sun Microsystems, Inc.
324
325
326
327GE 6.1                   $Date: 2007/07/19 08:17:15 $             SGE_TYPES(1)
Impressum