SGE_TYPES(1)               Grid Engine User Commands              SGE_TYPES(1)



[1mNAME[0m
       sge_types - Grid Engine type descriptions

[1mDESCRIPTION[0m
       The  Grid Engine user interface consists of several programs and files.
       Some command-line switches and several file attributes are  types.  The
       syntax for these types is explained in this page.


[1mOBJECT TYPES[0m
       These types are used for defining Grid Engine configuration:

   [1mcalendar_name[0m
       A calendar name is the name of a Grid Engine calendar described in [4mcal-[0m
       [4mendar_conf[24m(5).

       [4mcalendar_name[24m := [4mobject_name[0m

   [1mckpt_name[0m
       A "ckpt_name" is the name of  a  Grid  Engine  checkpointing  interface
       described in [4mcheckpoint[24m(5).

       [4mckpt_name[24m := [4mobject_name[0m

   [1mcomplex_name[0m
       A  complex  name  is  the  name  of  a  Grid  Engine resource attribute
       described in [4mcomplex[24m(5).

       [4mcomplex_name[24m := [4mobject_name[0m

   [1mhost_identifier[0m
       A host identifier can be either a host name or a host group name.

       [4mhost_identifier[24m := [4mhost_name[24m | [4mhostgroup_name[0m

   [1mhostgroup_name[0m
       A host group name is the name of a Grid Engine host group described  in
       [4mhostgroup[24m(5).   Note, to allow host group names easily be differed from
       host names a "@" prefix is used.

       [4mhostgroup_name[24m := @[4mobject_name[0m


   [1mhost_name[0m
       A host name is the official name of a host  node.  Host  names  with  a
       domain  specification  such  as  "gridmaster.sun.com" are called fully-
       qualified host names, whereas host names like "gridmaster"  are  called
       short   host  names.  Note,  there  are  the  install  time  parameters
       default_domain and ignore_fqdn (see [4mbootstrap[24m(5)) which affect how Grid
       Engine deals with host names in general.

   [1mmemory_specifier[0m
       Memory  specifiers  are  positive decimal, hexadecimal or octal integer
       constants  which  may  be  followed by a multiplier letter. Valid  mul-
       tiplier  letters  are k, K, m, M,  g  and  G, where  k  means  multiply
       the  value by 1000, K multiply by 1024, m multiply by 1000*1000, M mul-
       tiply   by   1024*1024,  g multiply by 1000*1000*1000 and G multiply by
       1024*1024*1024.  If no  multiplier  is  present,  the  value  is   just
       counted  in bytes.

   [1mpe_name[0m
       A "pe_name" is the name of a Grid Engine parallel environment described
       in [4msge_pe[24m(5).

       [4mpe_name[24m := [4mobject_name[0m

   [1mproject_name[0m
       A project name is the name  of  a  Grid  Engine  project  described  in
       [4mproject[24m(5).

       [4mproject_name[24m := [4mobject_name[0m

   [1mqueue_name[0m
       A  queue  name  is  the  name  of  a  Grid  Engine  queue  described in
       [4mqueue_conf[24m(5).

       [4mqueue_name[24m  := [4mobject_name[0m

   [1mtime_specifier[0m
       A time specifier either consists of a positive decimal, hexadecimal  or
       octal integer constant, in which case the value is interpreted to be in
       seconds, or is built by 3 decimal integer numbers  separated  by  colon
       signs  where  the first number counts the hours, the second the minutes
       and the third the seconds. If a number is zero it can be left  out  but
       the separating colon must remain (e.g. 1:0:1 = 1::1 means 1 hours and 1
       second).

   [1muser_name[0m
       A user name can be the name of a [4mlogin[24m(1) user or of  the  Grid  Engine
       user object described in [4muser[24m(5).

       [4muser_name[24m := [4mobject_name[0m

   [1muserset_name[0m
       A user set name is the name of an Grid Engine access list or department
       described in [4maccess_list[24m(5).

       [4muserset_name[24m := [4mobject_name[0m

   [1mobject_name[0m
       An object name is a sequence of  up  to  512  ASCII  string  characters
       except  "\n",  "\t", "\r", " ", "/", ":", "'", "\", "[", "]", "{", "}",
       "|", "(", ")", "@", "%", "," or the " character itself.

[1mMATCHING TYPES[0m
       These types are used for matching Grid Engine configuration:

   [1mexpression[0m
       A wildcard expression is a regular boolean expression that consists  of
       one  or  more  [4mpattern[24ms  joined  by boolean operators.  When a wildcard
       expression is used, the following definition applies:

       expression= ["!"] ["("] valExp [")"] [ AND_OR expression ]*
       valExp  = pattern | expression
       AND_OR  = "&" | "|"

       where:

       "!"       not operator -- negate the following pattern or expression
       "&"       and operator -- logically and with the following expression
       "|"       or operator -- logically or with the following expression
       "("       open bracket -- begin an inner expression.
       ")"       close bracket -- end an inner expression.
       "pattern" see the [4mpattern[24m definition that's follow

       The expression itself should be put inside quotes ('"') to ensure  that
       clients receive the complete expression.

       e.g.
              "(lx*|sol*)&*64*" any string beginning with either "lx" or
                                "sol" and containing "64"
              "rh_3*&!rh_3.1"   any string beginning with "rh_3", except
                                "rh_3.1"

   [1mpattern[0m
       When patterns are used the following definitions apply:

       "*"     matches any character and any number of characters
               (between 0 and inv).
       "?"     matches any character. It must be a character other that the empty
               string
       "."     is the character ".". It has no other meaning
       "\"     escape character. "\\" = "\", "\*" = "*", "\?" = "?"
       "[...]" specifies an array or a range of allowed
               characters for one character at a specific position.
               Character ranges may be specified using the a-z notation.
               The caret symbol (^) is [1mnot [22minterpreted as a logical
               not; it is interpreted literally.

       For more details please see
       [4mfnmatch[24m(5)


       The  pattern  itself  should  be put inside quotes ('"') to ensure that
       clients receive the complete pattern.


   [1mrange[0m
       The task range specifier has the form

       n[-m[:s]][,n[-m[:s]], ...]  or n[-m[:s]][ n[-m[:s]] ...]

       and thus consists of a comma or blank separated list  of  range  speci-
       fiers  n[-m[:s]].  The  ranges are concatenated to the complete task id
       range. Each range may be a single number, a simple range of the form n-
       m or a range with a step size.


   [1mwc_host[0m
       A  wildcard host specification ([4mwc_host[24m) is a wildcard expression which
       might match one or more hosts used in the cluster.  The first character
       of  that  string  never  begins with an at-character ('@'), even if the
       expression begins with a wildcard character.

       e.g.
              *            all hosts
              a*           all host beginning with an 'a'

   [1mwc_hostgroup[0m
       A wildcard hostgroup specification ([4mwc_hostgroup[24m) is a wildcard expres-
       sion  which might match one or more hostgroups.  The first character of
       that string is always an at-character ('@').

       More information concerning hostgroups can be found in [4mhostgroup[24m(5)

       e.g.
              @*           all hostgroups in the cluster
              @solaris     the @solaris hostgroup

   [1mwc_job[0m
       The wildcard job specification is a placeholder for job ids, job  names
       include job name pattern. A job id always references one job, while the
       names and pattern might reference multiple jobs.

       wc_job := job-id | job-name | pattern


   [1mwc_job_range[0m
       The wildcard job range specification allows to reference specific array
       tasks for one or multiple jobs. The job is referenced via wc_job and in
       addition gets a range specifier for the array tasks.

       wc_job_range := wc_job [ -t range]


   [1mwc_job_list[0m
       The wildcard job list specification allows to reference  multiple  jobs
       with one command.

       wc_job_list := wc_job [ , wc_job , ...]


   [1mwc_job_range_list[0m
       The  wildcard job range list ([4mwc_job_range_list[24m) is specified by one of
       the following forms:

           [4mwc_job[[24m [4m-t[24m [4mrange][{,[24m [4m}wc_job[[24m [4m-t[24m [4mrange]{,[24m [4m}...][0m

       If present, the [4mtask_range[24m restricts the effect of the  [4mqmod[24m  operation
       to  the array job task range specified as suffix to the job id (see the
       [1m-t [22moption to [4mqsub[24m(1) for further details on array jobs).


   [1mwc_qdomain[0m
       [4mwc_qdomain[24m := [4mwc_cqueue[24m "@" [4mwc_hostgroup[0m

       A wildcard expression queue domain  specification  ([4mwc_qdomain[24m)  starts
       with  a  wildcard expression cluster queue name ([4mwc_cqueue[24m) followed by
       an at-character '@' and a wildcard expression  hostgroup  specification
       ([4mwc_hostgroup[24m).

       [4mwc_qdomain[24m  are  used to address a group of queue instances.  All queue
       instances residing on a hosts which is part of matching hostgroups will
       be  addressed. Please note, that [4mwc_hostgroup[24m always begins with an at-
       character.

       e.g.
              *@@*         all queue instances whose underlying
                           host is part of at least one hostgroup
              a*@@e*       all queue instances beginning with an 'a' whose underlying
                           host is part of at least one hostgroup beginning with 'e'
              *@@solaris   all queue instances on hosts part of
                           the @solaris hostgroup

   [1mwc_cqueue[0m
       A wildcard expression cluster  queue  specification  ([4mwc_cqueue[24m)  is  a
       wildcard  expression  which might match one or more cluster queues used
       in the cluster.  That string never contains an at-character ('@'), even
       if the expression begins with a wildcard character.

       e.g.
              *            all cluster queues
              a*           all cluster queues beginning with an 'a'
              a*&!adam     all cluster queues beginning with an 'a',but not adam

   [1mwc_qinstance[0m
       [4mwc_qinstance[24m := [4mwc_cqueue[24m "@" [4mwc_host[0m

       A  wildcard  expression  queue  instance  specification  ([4mwc_qinstance[24m)
       starts with a wildcard expression cluster queue name  ([4mwc_cqueue[24m)  fol-
       lowed  by  an  at-character  '@'  and  a  wildcard  expression hostname
       ([4mwc_host[24m).

       [4mwc_qinstance[24m expressions are used to address a group of queue instances
       whose  underlying  hostname  matches the given expression.  Please note
       that the first character of [4mwc_host[24m does  not  match  the  at-character
       '@'.

       e.g.
              *@*          all queue instances in the cluster
              *@b*         all queue instances whose
                           hostname begins with a 'b'
              *@b*|c*      all queue instances whose
                           hostname begins with a 'b' or 'c'

   [1mwc_queue[0m
       [4mwc_queue[24m := [4mwc_cqueue[24m | [4mwc_qdomain[24m | [4mwc_qinstance[0m

       A  wildcard  queue  expression  ([4mwc_queue[24m)  might  either be a wildcard
       expression  cluster  queue  specification  ([4mwc_cqueue[24m)  or  a  wildcard
       expression  queue  domain  specification  ([4mwc_qdomain[24m)  or  a  wildcard
       expression queue instance specification ([4mwc_qinstance[24m).

       e.g.
              big_*1           cluster queues which begin with
                               "big_" and end with "1"
              big_*&!*1        cluster queues which begin with
                               "big_" ,but does not end with "1"
              *@fangorn        all qinstances residing on host
                               fangorn

   [1mwc_queue_list[0m
       [4mwc_queue_list[24m := [4mwc_queue[24m ["," [4mwc_queue[24m "," ...]

       Comma separated list of wc_queue elements.

       e.g.
              big, medium_*@@sol*, *@fangorn.sun.com


   [1mwc_user[0m
       A wildcard user name pattern is either a wildcard user name  specifica-
       tion or a full user name.

       wc_user := user_name | pattern


   [1mwc_user_list[0m
       A list of user names.

       wc_user_list := wc_user [ , wc_user , ...]


   [1mwc_project[0m
       A wildcard project name pattern is either a wildcard project name spec-
       ification or a full project name.

       wc_project := project | pattern


   [1mwc_pe_name[0m
       A wildcard parallel environment name pattern is either  a  wildcard  PE
       name specification or a full PE name.

       wc_pe_name := pe_name | pattern


[1mSEE ALSO[0m
       [4mqacct[24m(1), [4mqconf[24m(1), [4mqquota[24m(1)

[1mCOPYRIGHT[0m
       Copyright: 2004-2007 by Sun Microsystems, Inc.



GE 6.1                   $Date: 2007/07/19 08:17:15 $             SGE_TYPES(1)
