SHARE_TREE(5)              Grid Engine File Formats              SHARE_TREE(5)



[1mNAME[0m
       share_tree - Grid Engine share tree file format

[1mDESCRIPTION[0m
       The   share   tree  defines  the  long-term  resource  entitlements  of
       users/projects and of a hierarchy of arbitrary groups thereof.

       The current share tree  can  be  displayed  via  the  [4mqconf[24m(1)  [1m-sstree[0m
       option.  The  output follows the [4mshare_tree[24m format description. A share
       tree can be created and an existing can be modified via the [1m-astree [22mand
       [1m-mstree  [22moptions  to  [4mqconf[24m(1).  The [1m-sst [22moption shows a formated share
       tree (tree view).  Individual share tree nodes can  be  created,  modi-
       fied,  deleted,  or  shown  via  the  [1m-astnode[22m, [1m-dstnode[22m, [1m-mstnode[22m, and
       [1m-sstnode [22moptions to [4mqconf[24m(1).

       Note, Grid Engine allows backslashes (\)  be  used  to  escape  newline
       (\newline)  characters. The backslash and the newline are replaced with
       a space (" ") character before any interpretation.

[1mFORMAT[0m
       The format of a share tree file is defined as follows:

       +o  A new node starts with the attribute [1mid[22m,  and  equal  sign  and  the
          numeric  identification  number  of  the node. Further attributes of
          that node follow until another [1mid[22m-keyword is encountered.

       +o  The attribute [1mtype [22mdefines, if a sharetree node  references  a  user
          (type=0), or a project (type=1)

       +o  The  attribute  [1mchildnodes  [22mcontains a comma separated list of child
          nodes to this node.

       +o  The parameter [1mname [22mrefers to an arbitrary name for the node or to  a
          corresponding  user (see [4muser[24m(5)) or project (see [4mproject[24m(5)) if the
          node is a leaf node of the share tree. The name for the root node of
          the tree is "Root" by convention.

       +o  The  parameter  [1mshares [22mdefines the share of the node among the nodes
          with the same parent node.

       +o  A user leaf node named 'default' can be defined as a descendant of a
          [4mproject[24m(5))  node  in  the  share tree. The default node defines the
          number of shares for users  who are running in the project, but  who
          do  not have a user node defined under the project. The default user
          node is a convenient way of specifying a single node for  all  users
          which  should  receive  an equal share of the project resources. The
          default node may be specified by itself or with other [4muser[24m(5)) nodes
          at  the  same  level  below a project. All users, whether explicitly
          specified as a user node or those which map to  the  'default'  user
          node  must  have a corresponding [4muser[24m(5)) object defined in order to
          get shares. Do not configure a [4muser[24m(5)) object named 'default'.


[1mEXAMPLES[0m
       Jobs of projects P1 and P2 get 50 shares, all other jobs get 10 shares.

       id=0
       name=Root
       type=0
       shares=1
       childnodes=1,2,3
       id=1
       name=P1
       type=1
       shares=50
       childnodes=NONE
       id=2
       name=P2
       type=1
       shares=50
       childnodes=NONE
       id=3
       name=default
       type=0
       shares=10
       childnodes=NONE

[1mSEE ALSO[0m
       [4mge_intro[24m(1), [4mqconf[24m(1), [4mproject[24m(5), [4muser[24m(5).

[1mCOPYRIGHT[0m
       See [4mge_intro[24m(1) for a full statement of rights and permissions.



GE 6.2u2                 $Date: 2008/12/10 15:05:28 $            SHARE_TREE(5)
