1GE_TYPES(1) Grid Engine User Commands GE_TYPES(1)
2
6 sge_types - Grid Engine type descriptions
7
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
14 These types are used for defining Grid Engine configuration:
15 calendar_name
17 A calendar name is the name of a Grid Engine calendar described in cal‐
18 endar_conf(5).
19 calendar_name := object_name
21 ckpt_name
23 A "ckpt_name" is the name of a Grid Engine checkpointing interface
24 described in checkpoint(5).
25 ckpt_name := object_name
27 complex_name
29 A complex name is the name of a Grid Engine resource attribute
30 described in complex(5).
31 complex_name := object_name
33 host_identifier
35 A host identifier can be either a host name or a host group name.
36 host_identifier := host_name | hostgroup_name
38 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 hostgroup_name := @object_name
45 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 jsv_url
55 The jsv_url has following format:
56 jsv_url := jsv_client_url | jsv_server_url
58 jsv_server_url := [ type ':' ] [ user '@' ] path
60 jsv_client_url := [ type ':' ] path
62 type := 'script'
64 In the moment only the type script is allowed. This means that path is
66 either the path to a script or to a binary application which will be
67 used to instantiate a JSV process. The type is optional till other
68 types are supported by Grid Engine.
69 Specifying a user is only allowed for server JSV's. Client JSV's will
71 automatically be started as submit user and server JSV's as admin user
72 if not other specified.
73 The path has always to be the absolute path to a binary or application.
75 memory_specifier
77 Memory specifiers are positive decimal, hexadecimal or octal integer
78 constants which may be followed by a multiplier letter. Valid mul‐
79 tiplier letters are k, K, m, M, g and G, where k means multiply
80 the value by 1000, K multiply by 1024, m multiply by 1000*1000, M mul‐
81 tiply by 1024*1024, g multiply by 1000*1000*1000 and G multiply by
82 1024*1024*1024. If no multiplier is present, the value is just
83 counted in bytes.
84 pe_name
86 A "pe_name" is the name of a Grid Engine parallel environment described
87 in sge_pe(5).
88 pe_name := object_name
90 project_name
92 A project name is the name of a Grid Engine project described in
93 project(5).
94 project_name := object_name
96 queue_name
98 A queue name is the name of a Grid Engine queue described in
99 queue_conf(5).
100 queue_name := object_name
102 time_specifier
104 A time specifier either consists of a positive decimal, hexadecimal or
105 octal integer constant, in which case the value is interpreted to be in
106 seconds, or is built by 3 decimal integer numbers separated by colon
107 signs where the first number counts the hours, the second the minutes
108 and the third the seconds. If a number would be zero it can be left out
109 but the separating colon must remain (e.g. 1:0:1 = 1::1 means 1 hours
110 and 1 second).
111 user_name
113 A user name can be the name of a login(1) user or of the Grid Engine
114 user object described in user(5).
115 user_name := object_name
117 userset_name
119 A user set name is the name of an Grid Engine access list or department
120 described in access_list(5).
121 userset_name := object_name
123 object_name
125 An object name is a sequence of up to 512 ASCII string characters
126 except "\n", "\t", "\r", " ", "/", ":", "´", "\", "[", "]", "{", "}",
127 "|", "(", ")", "@", "%", "," or the " character itself.
128
130 These types are used for matching Grid Engine configuration:
131 expression
133 A wildcard expression is a regular boolean expression that consists of
134 one or more patterns joined by boolean operators. When a wildcard
135 expression is used, the following definition applies:
136 expression= ["!"] ["("] valExp [")"] [ AND_OR expression ]*
138 valExp = pattern | expression
139 AND_OR = "&" | "|"
140 where:
142 "!" not operator -- negate the following pattern or expression
144 "&" and operator -- logically and with the following expression
145 "|" or operator -- logically or with the following expression
146 "(" open bracket -- begin an inner expression.
147 ")" close bracket -- end an inner expression.
148 "pattern" see the pattern definition that's follow
149 The expression itself should be put inside quotes ('"') to ensure that
151 clients receive the complete expression.
152 e.g.
154 "(lx*|sol*)&*64*" any string beginning with either "lx" or
155 "sol" and containing "64"
156 "rh_3*&!rh_3.1" any string beginning with "rh_3", except
157 "rh_3.1"
158 pattern
160 When patterns are used the following definitions apply:
161 "*" matches any character and any number of characters
163 (between 0 and inv).
164 "?" matches any character. It cannot be no character
165 "." is the character ".". It has no other meaning
166 "\" escape character. "\\" = "\", "\*" = "*", "\?" = "?"
167 "[...]" specifies an array or a range of allowed
168 characters for one character at a specific position.
169 Character ranges may be specified using the a-z notation.
170 The caret symbol (^) is not interpreted as a logical
171 not; it is interpreted literally.
172 For more details please see
174 fnmatch(5)
175 The pattern itself should be put inside quotes ('"') to ensure that
178 clients receive the complete pattern.
179 range
181 The task range specifier has the form
182 n[-m[:s]][,n[-m[:s]], ...] or n[-m[:s]][ n[-m[:s]] ...]
184 and thus consists of a comma or blank separated list of range speci‐
186 fiers n[-m[:s]]. The ranges are concatenated to the complete task id
187 range. Each range may be a single number, a simple range of the form n-
188 m or a range with a step size.
189 wc_ar
191 The wildcard advance reservation (AR) specification is a placeholder
192 for AR ids, AR names including AR name patterns. An AR id always refer‐
193 ences one AR, while the name and pattern might reference multiple ARs.
194 wc_ar := ar_id | ar_name | pattern
196 wc_ar_list
198 The wildcard advance reservation (AR) list specification allows to ref‐
199 erence multiple ARs with one command.
200 wc_ar_list := wc_ar [ , wc_ar , ...]
202 wc_host
204 A wildcard host specification (wc_host) is a wildcard expression which
205 might match one or more hosts used in the cluster. The first character
206 of that string never begins with an at-character ('@'), even if the
207 expression begins with a wildcard character.
208 e.g.
210 * all hosts
211 a* all host beginning with an 'a'
212 wc_hostgroup
214 A wildcard hostgroup specification (wc_hostgroup) is a wildcard expres‐
215 sion which might match one or more hostgroups. The first character of
216 that string is always an at-character ('@').
217 More information concerning hostgroups can be found in hostgroup(5)
219 e.g.
221 @* all hostgroups in the cluster
222 @solaris the @solaris hostgroup
223 wc_job
225 The wildcard job specification is a placeholder for job ids, job names
226 including job name patterns. A job id always references one job, while
227 the name and pattern might reference multiple jobs.
228 wc_job := job-id | job-name | pattern
230 wc_job_range
232 The wildcard job range specification allows to reference specific array
233 tasks for one or multiple jobs. The job is referenced via wc_job and in
234 addition gets a range specifier for the array tasks.
235 wc_job_range := wc_job [ -t range]
237 wc_job_list
239 The wildcard job list specification allows to reference multiple jobs
240 with one command.
241 wc_job_list := wc_job [ , wc_job , ...]
243 wc_job_range_list
245 The wildcard job range list (wc_job_range_list) is specified by one of
246 the following forms:
247 wc_job[ -t range][{, }wc_job[ -t range]{, }...]
249 If present, the task_range restricts the effect of the qmod operation
251 to the array job task range specified as suffix to the job id (see the
252 -t option to qsub(1) for further details on array jobs).
253 wc_qdomain
255 wc_qdomain := wc_cqueue "@" wc_hostgroup
256 A wildcard expression queue domain specification (wc_qdomain) starts
258 with a wildcard expression cluster queue name (wc_cqueue) followed by
259 an at-character '@' and a wildcard expression hostgroup specification
260 (wc_hostgroup).
261 wc_qdomain are used to address a group of queue instances. All queue
263 instances residing on a hosts which is part of matching hostgroups will
264 be addressed. Please note, that wc_hostgroup always begins with an at-
265 character.
266 e.g.
268 *@@* all queue instances whose underlying
269 host is part of at least one hostgroup
270 a*@@e* all queue instances begins with a whose underlying
271 host is part of at least one hostgroup begin with e
272 *@@solaris all queue instances on hosts part of
273 the @solaris hostgroup
274 wc_cqueue
276 A wildcard expression cluster queue specification (wc_cqueue) is a
277 wildcard expression which might match one or more cluster queues used
278 in the cluster. That string never contains an at-character ('@'), even
279 if the expression begins with a wildcard character.
280 e.g.
282 * all cluster queues
283 a* all cluster queues beginning with an 'a'
284 a*&!adam all cluster queues beginning with an 'a',but not adam
285 wc_qinstance
287 wc_qinstance := wc_cqueue "@" wc_host
288 A wildcard expression queue instance specification (wc_qinstance)
290 starts with a wildcard expression cluster queue name (wc_cqueue) fol‐
291 lowed by an at-character '@' and a wildcard expression hostname
292 (wc_host).
293 wc_qinstance expressions are used to address a group of queue instances
295 whose underlying hostname matches the given expression. Please note
296 that the first character of wc_host does never match the at-character
297 '@'.
298 e.g.
300 *@* all queue instances in the cluster
301 *@b* all queue instances whose
302 hostname begins with a 'b'
303 *@b*|c* all queue instances whose
304 hostname begins with a 'b' or 'c'
305 wc_queue
307 wc_queue := wc_cqueue | wc_qdomain | wc_qinstance
308 A wildcard queue expression (wc_queue) might either be a wildcard
310 expression cluster queue specification (wc_cqueue) or a wildcard
311 expression queue domain specification (wc_qdomain) or a wildcard
312 expression queue instance specification (wc_qinstance).
313 e.g.
315 big_*1 cluster queues which begin with
316 "big_" and end with "1"
317 big_*&!*1 cluster queues which begin with
318 "big_" ,but does not end with "1"
319 *@fangorn all qinstances residing on host
320 fangorn
321 wc_queue_list
323 wc_queue_list := wc_queue ["," wc_queue "," ...]
324 Comma separated list of wc_queue elements.
326 e.g.
328 big, medium_*@@sol*, *@fangorn.sun.com
329 wc_user
331 A wildcard user name pattern is either a wildcard user name specifica‐
332 tion or a full user name.
333 wc_user := user_name | pattern
335 wc_user_list
337 A list of user names.
338 wc_user_list := wc_user [ , wc_user , ...]
340 wc_project
342 A wildcard project name pattern is either a wildcard project name spec‐
343 ification or a full project name.
344 wc_project := project | pattern
346 wc_pe_name
348 A wildcard parallel environment name pattern is either a wildcard pe
349 name specification or a full pe name.
350 wc_pe_name := pe_name | pattern
352 parallel_env n[-[m]]|[-]m,...
354 Parallel programming environment (PE) to select for an AR. The range
355 descriptor behind the PE name specifies the number of parallel pro‐
356 cesses to be run. Grid Engine will allocate the appropriate resources
357 as available. The ge_pe(5) manual page contains information about the
358 definition of PEs and about how to obtain a list of currently valid
359 PEs.
360 You can specify a PE name which uses the wildcard character, "*". Thus
362 the request "pvm*" will match any parallel environment with a name
363 starting with the string "pvm". In the case of multiple parallel envi‐
364 ronments whose names match the name string, the parallel environment
365 with the most available slots is chosen.
366 The range specification is a list of range expressions of the form "n-
368 m", where n and m are positive, non-zero integers. The form "n" is
369 equivalent to "n-n". The form "-m" is equivalent to "1-m". The form
370 "n-" is equivalent to "n-infinity". The range specification is pro‐
371 cessed as follows: The largest number of queues requested is checked
372 first. If enough queues meeting the specified attribute list are avail‐
373 able, all are reserved. If not, the next smaller number of queues is
374 checked, and so forth.
375 date_time
377 The date_time value must conform to [[CC]]YY]MMDDhhmm[.SS], where:
378 e.g.
380 CC denotes the century in 2 digits.
381 YY denotes the year in 2 digits.
382 MM denotes the month in 2 digits.
383 DD denotes the day in 2 digits.
384 hh denotes the hour in 2 digits.
385 mm denotes the minute in 2 digits.
386 ss denotes the seconds in 2 digits (default 00).
387 time
389 The time value must conform to hh:mm:ss, or seconds where:
390 e.g.
392 hh denotes the hour in 2 digits.
393 mm denotes the minute in 2 digits.
394 ss denotes the seconds in 2 digits (default 00).
395 seconds is a number of seconds (is used for duration values)
396 If any of the optional date fields are omitted, the correspond‐
398 ing value of the current date is assumed. If CC is not speci‐
399 fied, a YY of < 70 means 20YY.
400 Use of this option may cause unexpected results if the clocks of
401 the hosts in the Grid Engine pool are out of sync. Also, the
402 proper behavior of this option very much depends on the correct
403 setting of the appropriate timezone, e.g. in the TZ environment
404 variable (see date(1) for details), when the Grid Engine daemons
405 ge_qmaster(8) and ge_execd(8) are invoked.
406 name
408 The name may be any arbitrary alphanumeric ASCII string, but may not
409 contain "\n", "\t", "\r", "/", ":", "@", "\", "*", or "?".
410
412 qacct(1), qconf(1), qquota(1), qsub(1), qrsub(1)
413
415 Copyright: 2004-2007 by Sun Microsystems, Inc.
416GE 6.2u5 $Date: 2009/05/28 16:56:18 $ GE_TYPES(1)