


RESOURCE(5)                                           RESOURCE(5)


NNAAMMEE
       resource descriptors - RAP resource file format

SSYYNNOOPPSSIISS
       _r_e_s_o_u_r_c_e ::= _a_t_t_r_i_b_u_t_e _l_i_s_t _<_b_l_a_n_k _l_i_n_e_>
       _a_t_t_r_i_b_u_t_e _l_i_s_t ::= _a_t_t_r_i_b_u_t_e [ ;; _a_t_t_r_i_b_u_t_e ]*
       _a_t_t_r_i_b_u_t_e ::= _n_a_m_e [ :: _v_a_l_u_e [ ,, _v_a_l_u_e ]* ]
       _n_a_m_e_, _v_a_l_u_e ::= _<_p_r_i_n_t_a_b_l_e _s_t_r_i_n_g_>

DDEESSCCRRIIPPTTIIOONN
       Files with the ..rreess suffix use a common format to describe
       _r_e_s_o_u_r_c_e_s_.  Generally,  a  resource  represents  something
       that  a  system  administrator  might  want to manage (for
       example, devices, backup schedules, file systems), or that
       a user might want to locate.  The encoding of the informa-
       tion describing a resource is called the _r_e_s_o_u_r_c_e _d_e_s_c_r_i_p_-
       _t_o_r.   Resource  description  files  are  are  accessed by
       applications and services that use the  Resource  Adminis-
       tration Platform (RAP), but they can also be viewed with a
       normal text editor.

       Each  resource  descriptor  is  made  up  of  a  list   of
       attributes,  and  ends  in a blank line. Each attribute in
       the attribute list has a name and an optional list of val-
       ues.  The  attribute  name is separated from the attribute
       values by a colon (::), attribute values are  separated  by
       commas  (,,),  and  attributes  are separated by semicolons
       (;;). A comma at the end of a line continues the  line,  as
       does  a back-slash (\\) character. The back-slash character
       can also be used to escape the special meaning of a single
       character  (such  as  comma,  semicolon, double quote, and
       back-slash), or the string can be included in  quotes.   A
       line  beginning with a pound-sign (##) is a comment and the
       rest of the line  is  ignored.   The  end  of  a  resource
       attribute list is marked with a blank line.

       The  attribute  name  and values can contain any printable
       character.  Upper and lower case  is  ignored  on  compar-
       isons,  and  extra white space is ignored on both ends but
       not in the middle of names and values. For example,
              Name: testing 1 2;
       will match
              name   :   Testing 1 2 ;
       but is different than
              Name: testing 1     2;

       Below is an example  which  includes  two  resources.  The
       first  resource  has eight attributes: ttyyppee, nnaammee, sseerrvveerr,
       sscchheedduullee, ddiirreeccttiivvee, ggrroouupp, ssaavvee sseett, and  rreemmoottee  aacccceessss.
       The  ggrroouupp  attribute has two values: mmaarrkkeettiinngg and ssaalleess.
       The rreemmoottee aacccceessss attribute  has  no  value.   The  second
       example includes an attribute that needs quotes because it
       contains a colon.




UNRELEASED                March 08, 2000                        1





RESOURCE(5)                                           RESOURCE(5)


                       type: NSR client;
                       name: venus;
                     server: mars;
                   schedule: Default;
                  directive: custom;
                      group: marketing, sales;
                   save set: /, /usr;
              remote access: ;

                       type: NSR group;
                       name: engineering servers;
                  autostart: Enabled;
                 start time: "3:33";

       Each resource includes the special  attribute  ttyyppee.   The
       ttyyppee  attribute  defines which other attributes a resource
       can contain. For example, a  resource  with  type  printer
       might include an attribute ppaappeerr ssiizzee, while in a resource
       of type NNFFSS ffiilleessyysstteemm this attribute makes no sense.


       The nnaammee attribute is a descriptive  name  of  the  object
       that a resource represents. In the example above, the name
       of the  second  resource  is  eennggiinneeeerriinngg  sseerrvveerrss,  which
       describes a group of machines to be saved together.

       The aaddmmiinniissttrraattoorr attribute is the list of users that have
       permission to modify  this  resource.  This  attribute  is
       inherited  from the server resource when a new resource is
       created. The administrator in  the  server  resource  also
       controls  who  has  permission to create new resources and
       delete old ones.

       The rreessoouurrccee iiddeennttiiffiieerr is set and used internally by  the
       RAP  system.   It provides a unique identification of each
       resource, and although it is  sometimes  printed  like  an
       attribute,  it  is stored differently.  When new resources
       are created the rreessoouurrccee iiddeennttiiffiieerr  attribute  should  be
       left  off.  This  signals  the  system  that this is a new
       resource and a new identifier will be assigned.

TTYYPPEESS
       There are special resources  that  define  the  attributes
       found  in  a  given  type.  They  are called resource type
       descriptors. Type descriptors  have  the  same  syntax  as
       other  resources  except  that  they have a type attribute
       with the value ttyyppee and a ttyyppee  nnaammee  attribute  with  the
       value  of  the  type  they  describe.   For  example,  the
       resource type descriptor for  type  NFS  filesystem  would
       have, among its other attributes:
              type:type; type name:NFS filesystem

       Type  descriptors are used internally, and should normally
       never be stored in files or seen by  administrators.   For



UNRELEASED                March 08, 2000                        2





RESOURCE(5)                                           RESOURCE(5)


       each  of  the other attributes in a type descriptor, there
       are three or more values.  The first value gives the  base
       type,  the second value gives a list of flags separated by
       spaces, the third value is a string for on-line help,  and
       any  subsequent  strings  are  default  values.  This type
       information is used  by  system  administration  tools  to
       improve the user interface.

FFIILLEESS
       **..rreess     Files that contain resource descriptors.

SSEEEE AALLSSOO
       rraapp(8), rraappdd(8).












































UNRELEASED                March 08, 2000                        3


