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



NNAAMMEE
       sge_types - Grid Engine type descriptions

DDEESSCCRRIIPPTTIIOONN
       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.


OOBBJJEECCTT TTYYPPEESS
       These types are used for defining Grid Engine configuration:

   ccaalleennddaarr__nnaammee
       A calendar name is the name of a Grid Engine calendar described in _c_a_l_-
       _e_n_d_a_r___c_o_n_f(5).

       _c_a_l_e_n_d_a_r___n_a_m_e := _o_b_j_e_c_t___n_a_m_e

   cckkpptt__nnaammee
       A "ckpt_name" is the name of  a  Grid  Engine  checkpointing  interface
       described in _c_h_e_c_k_p_o_i_n_t(5).

       _c_k_p_t___n_a_m_e := _o_b_j_e_c_t___n_a_m_e

   ccoommpplleexx__nnaammee
       A  complex  name  is  the  name  of  a  Grid  Engine resource attribute
       described in _c_o_m_p_l_e_x(5).

       _c_o_m_p_l_e_x___n_a_m_e := _o_b_j_e_c_t___n_a_m_e

   hhoosstt__iiddeennttiiffiieerr
       A host identifier can be either a host name or a host group name.

       _h_o_s_t___i_d_e_n_t_i_f_i_e_r := _h_o_s_t___n_a_m_e | _h_o_s_t_g_r_o_u_p___n_a_m_e

   hhoossttggrroouupp__nnaammee
       A host group name is the name of a Grid Engine host group described  in
       _h_o_s_t_g_r_o_u_p(5).   Note, to allow host group names easily be differed from
       host names a "@" prefix is used.

       _h_o_s_t_g_r_o_u_p___n_a_m_e := @_o_b_j_e_c_t___n_a_m_e


   hhoosstt__nnaammee
       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 _b_o_o_t_s_t_r_a_p(5)) which affect how Grid
       Engine deals with host names in general.

   mmeemmoorryy__ssppeecciiffiieerr
       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.

   ppee__nnaammee
       A "pe_name" is the name of a Grid Engine parallel environment described
       in _s_g_e___p_e(5).

       _p_e___n_a_m_e := _o_b_j_e_c_t___n_a_m_e

   pprroojjeecctt__nnaammee
       A project name is the name  of  a  Grid  Engine  project  described  in
       _p_r_o_j_e_c_t(5).

       _p_r_o_j_e_c_t___n_a_m_e := _o_b_j_e_c_t___n_a_m_e

   qquueeuuee__nnaammee
       A  queue  name  is  the  name  of  a  Grid  Engine  queue  described in
       _q_u_e_u_e___c_o_n_f(5).

       _q_u_e_u_e___n_a_m_e  := _o_b_j_e_c_t___n_a_m_e

   ttiimmee__ssppeecciiffiieerr
       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).

   uusseerr__nnaammee
       A user name can be the name of a _l_o_g_i_n(1) user or of  the  Grid  Engine
       user object described in _u_s_e_r(5).

       _u_s_e_r___n_a_m_e := _o_b_j_e_c_t___n_a_m_e

   uusseerrsseett__nnaammee
       A user set name is the name of an Grid Engine access list or department
       described in _a_c_c_e_s_s___l_i_s_t(5).

       _u_s_e_r_s_e_t___n_a_m_e := _o_b_j_e_c_t___n_a_m_e

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

MMAATTCCHHIINNGG TTYYPPEESS
       These types are used for matching Grid Engine configuration:

   eexxpprreessssiioonn
       A wildcard expression is a regular boolean expression that consists  of
       one  or  more  _p_a_t_t_e_r_ns  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 _p_a_t_t_e_r_n 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"

   ppaatttteerrnn
       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 nnoott interpreted as a logical
               not; it is interpreted literally.

       For more details please see
       _f_n_m_a_t_c_h(5)


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


   rraannggee
       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.


   wwcc__hhoosstt
       A  wildcard host specification (_w_c___h_o_s_t) 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'

   wwcc__hhoossttggrroouupp
       A wildcard hostgroup specification (_w_c___h_o_s_t_g_r_o_u_p) 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 _h_o_s_t_g_r_o_u_p(5)

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

   wwcc__jjoobb
       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


   wwcc__jjoobb__rraannggee
       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]


   wwcc__jjoobb__lliisstt
       The wildcard job list specification allows to reference  multiple  jobs
       with one command.

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


   wwcc__jjoobb__rraannggee__lliisstt
       The  wildcard job range list (_w_c___j_o_b___r_a_n_g_e___l_i_s_t) is specified by one of
       the following forms:

           _w_c___j_o_b_[ _-_t _r_a_n_g_e_]_[_{_, _}_w_c___j_o_b_[ _-_t _r_a_n_g_e_]_{_, _}_._._._]

       If present, the _t_a_s_k___r_a_n_g_e restricts the effect of the  _q_m_o_d  operation
       to  the array job task range specified as suffix to the job id (see the
       --tt option to _q_s_u_b(1) for further details on array jobs).


   wwcc__qqddoommaaiinn
       _w_c___q_d_o_m_a_i_n := _w_c___c_q_u_e_u_e "@" _w_c___h_o_s_t_g_r_o_u_p

       A wildcard expression queue domain  specification  (_w_c___q_d_o_m_a_i_n)  starts
       with  a  wildcard expression cluster queue name (_w_c___c_q_u_e_u_e) followed by
       an at-character '@' and a wildcard expression  hostgroup  specification
       (_w_c___h_o_s_t_g_r_o_u_p).

       _w_c___q_d_o_m_a_i_n  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 _w_c___h_o_s_t_g_r_o_u_p 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

   wwcc__ccqquueeuuee
       A wildcard expression cluster  queue  specification  (_w_c___c_q_u_e_u_e)  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

   wwcc__qqiinnssttaannccee
       _w_c___q_i_n_s_t_a_n_c_e := _w_c___c_q_u_e_u_e "@" _w_c___h_o_s_t

       A  wildcard  expression  queue  instance  specification  (_w_c___q_i_n_s_t_a_n_c_e)
       starts with a wildcard expression cluster queue name  (_w_c___c_q_u_e_u_e)  fol-
       lowed  by  an  at-character  '@'  and  a  wildcard  expression hostname
       (_w_c___h_o_s_t).

       _w_c___q_i_n_s_t_a_n_c_e expressions are used to address a group of queue instances
       whose  underlying  hostname  matches the given expression.  Please note
       that the first character of _w_c___h_o_s_t 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'

   wwcc__qquueeuuee
       _w_c___q_u_e_u_e := _w_c___c_q_u_e_u_e | _w_c___q_d_o_m_a_i_n | _w_c___q_i_n_s_t_a_n_c_e

       A  wildcard  queue  expression  (_w_c___q_u_e_u_e)  might  either be a wildcard
       expression  cluster  queue  specification  (_w_c___c_q_u_e_u_e)  or  a  wildcard
       expression  queue  domain  specification  (_w_c___q_d_o_m_a_i_n)  or  a  wildcard
       expression queue instance specification (_w_c___q_i_n_s_t_a_n_c_e).

       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

   wwcc__qquueeuuee__lliisstt
       _w_c___q_u_e_u_e___l_i_s_t := _w_c___q_u_e_u_e ["," _w_c___q_u_e_u_e "," ...]

       Comma separated list of wc_queue elements.

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


   wwcc__uusseerr
       A wildcard user name pattern is either a wildcard user name  specifica-
       tion or a full user name.

       wc_user := user_name | pattern


   wwcc__uusseerr__lliisstt
       A list of user names.

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


   wwcc__pprroojjeecctt
       A wildcard project name pattern is either a wildcard project name spec-
       ification or a full project name.

       wc_project := project | pattern


   wwcc__ppee__nnaammee
       A wildcard parallel environment name pattern is either  a  wildcard  PE
       name specification or a full PE name.

       wc_pe_name := pe_name | pattern


SSEEEE AALLSSOO
       _q_a_c_c_t(1), _q_c_o_n_f(1), _q_q_u_o_t_a(1)

CCOOPPYYRRIIGGHHTT
       Copyright: 2004-2007 by Sun Microsystems, Inc.



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