


NSR_RESOURCE(5)                                   NSR_RESOURCE(5)


NNAAMMEE
       nsr_resource - NetWorker resource 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
       The  NetWorker  system  uses files containing _r_e_s_o_u_r_c_e_s to
       describe itself and its clients.  Each resource represents
       a component of the NetWorker system that might need admin-
       istration.  Devices, schedules, and clients  are  examples
       of  NetWorker resources.  The system administrator manipu-
       lates resources to control the NetWorker system.  The file
       and the resources in them are accessible through the nnwwaadd--
       mmiinn(8) and the nnssrraaddmmiinn(8) programs.   They  can  also  be
       viewed with a normal text editor.

       The  files  all share a common format.  The same format is
       used  by  the  nnssrraaddmmiinn(8)  program.   Each  resource   is
       described  by  a  list  of attributes, and ends in a blank
       line.  Each attribute in the attribute list has a name and
       an  optional  list of values.  The attribute name is sepa-
       rated from the attribute values by a colon (::),  attribute
       values  are  separated  by  commas (,,), and each attribute
       ends in a semicolon (;;).  A comma, semicolon or back-slash
       (\\)  at  the  end  of  a  line continues the line.  A line
       beginning with a pound-sign (##) is a comment and the  rest
       of the line is ignored.  The back-slash character can also
       be used to escape the special meaning of other  characters
       (comma, semicolon, pound-sign, and back-slash).

       The  attribute  name  and values can contain any printable
       character.  Upper and lower case is not  distinguished  on
       comparisons,  and  extra  white space is removed from both
       ends but not from inside of names and values. For example,
              Name: this is a test;
       matches
              name   :   This Is A Test ;
       but is different than
              Name: this      is     a    test;

       In   the  following  example  resource,  there  are  eight
       attributes.  They are ttyyppee, nnaammee, sseerrvveerr, sscchheedduullee, ddiirreecc--
       ttiivvee,  ggrroouupp,  ssaavvee  sseett,  and  rreemmoottee aacccceessss.  The rreemmoottee
       aacccceessss attribute has no value.


                       type: NSR client;
                       name: venus;
                     server: earth;
                   schedule: Default;



NetWorker rt_1998_4Q.Build.MMaJrFcehra0l8_,0021000                        1





NSR_RESOURCE(5)                                   NSR_RESOURCE(5)


                  directive: Unix standard directives;
                      group: Default;
                   save set: All;
              remote access: ;

       In the following resource, there are six attributes.   The
       aaddmmiinniissttrraattoorr  attribute  has  three values: &&eennggiinneeeerriinngg,
       rroooott, and ooppeerraattoorr.  Note that the three values are  sepa-
       rated by commas.  The aaccttiioonn attribute has one value: iinnccrr
       iinnccrr iinnccrr iinnccrr iinnccrr ffuullll iinnccrr.  Note that this is a single
       value  -  it  just  happens  to have spaces separating its
       words.


                       type: NSR schedule;
                     action: incr incr incr incr incr full incr;
              administrator: &engineering, root, operator;
                       name: engineering servers;
                   override: ;
                     period: Week;

SSPPEECCIIAALL AATTTTRRIIBBUUTTEESS
       Each NetWorker resource includes seven special attributes:
       ttyyppee,  nnaammee,  aaddmmiinniissttrraattoorr, hhoossttnnaammee, OONNCC pprrooggrraamm nnuummbbeerr,
       OONNCC vveerrssiioonn nnuummbbeerr, and OONNCC ttrraannssppoorrtt.  The ttyyppee and  nnaammee
       attributes are normally visible, but the others attributes
       are hidden.  That an attribute is hidden indicates that it
       is  infrequently  used  and perhaps esoteric.  Frequently,
       hidden attributes should not be changed by the user.

       The  ttyyppee  attribute  defines  which  other  attributes  a
       resource  can  contain.  For example, a resource with type
       NNSSRR cclliieenntt will always include the attribute sseerrvveerr, while
       a resource of type NNSSRR sscchheedduullee does not.

       The  nnaammee  attribute  is  a descriptive name of the object
       that a resource represents.  In the first  example  above,
       the  nnaammee  attribute  is  the name of the NetWorker client
       machine.   In  the  second  example,  the  nnaammee  attribute
       describes  a  schedule  used to back up the the servers in
       the engineering department.

       The aaddmmiinniissttrraattoorr attribute is the list of users that have
       permission  to  modify  or  delete  this  resource.   This
       attribute is inherited from the ttyyppee:: NNSSRR resource when  a
       new  resource  is  created.   The administrator of the NNSSRR
       resource also controls who has permission  to  create  and
       delete NetWorker resources.

       The  hhoossttnnaammee  attribute  specifies  the  hostname  of the
       machine on which the service that controls  this  resource
       is running. It is used internally and cannot be changed by
       the administrator.




NetWorker rt_1998_4Q.Build.MMaJrFcehra0l8_,0021000                        2





NSR_RESOURCE(5)                                   NSR_RESOURCE(5)


       The remaining attributes (OONNCC pprrooggrraamm nnuummbbeerr, OONNCC  vveerrssiioonn
       nnuummbbeerr,  and  OONNCC ttrraannssppoorrtt) specify the Open Network Com-
       puting information for this service.  They should never be
       changed manually.

       In  some  cases,  the resource identifier will be visible.
       Although it may look like an attribute, it is an  internal
       value that is set and used by the NetWorker system to pro-
       vide unique identification of  each  resource.   When  new
       resources  are created in the eeddiitt command of nnssrraaddmmiinn(8),
       the resource identifier  attribute  should  be  left  off.
       This signals that this is a new resource and a new identi-
       fier will be assigned.

       NetWorker resources are implemented by the Legato Resource
       Administration   Platform,   which  is  described  in  the
       rreessoouurrccee(5) manual page. This flexible architecture  means
       that  in future releases of NetWorker, more resource types
       or attributes may be added, and the  administration  tools
       in  this  release  will automatically be able to use them.
       To make this possible, each server provides _t_y_p_e  _d_e_s_c_r_i_p_-
       _t_o_r_s  that  are used internally to describe the attributes
       of each type, between the  administration  tools  and  the
       services.   These type descriptors may cause limitation on
       the values, such as only allowing a single value, allowing
       no value, or only numeric values.

RREESSOOUURRCCEE TTYYPPEESS
       This  release  of NetWorker defines the following types of
       resources:

       NNSSRR    This resource describes  a  NetWorker  server.   It
              contains   attributes  that  control  administrator
              authorization,  information  about  operations   in
              progress,  and  statistics  and  error  information
              about past operations.  For  more  information  see
              the nnssrr__sseerrvviiccee(5) manual page.

       NNSSRR cclliieenntt
              This  resource  describes  a  NetWorker client.  It
              includes attributes that specify the files to save,
              which  schedule to use, and which group this client
              belongs to.  There may  be  more  than  one  client
              resource  for  a  NetWorker  client.  This allows a
              client to save files on different  schedules.   For
              more information see the nnssrr__cclliieenntt(5) manual page.

       NNSSRR ddeevviiccee
              This resource type describes a storage device.   It
              includes   attributes  that  specify  a  particular
              device name (for example, /dev/nrst1),  media  type
              (for  example,  8mm), and the name of the currently
              mounted  volume.   It  also  provides  status   and
              statistics  on  current  and  past operations.  For



NetWorker rt_1998_4Q.Build.MMaJrFcehra0l8_,0021000                        3





NSR_RESOURCE(5)                                   NSR_RESOURCE(5)


              more information see the nnssrr__ddeevviiccee(5) manual page.

       NNSSRR ddiirreeccttiivvee
              This  resource  describes  a directive.  Directives
              control how a client's files are processed as  they
              are  being  saved.   For  more  information see the
              nnssrr__ddiirreeccttiivvee(5), the nnssrr(5) and the uuaassmm(8) manual
              pages.

       NNSSRR ggrroouupp
              This  resource specifies a logical grouping of Net-
              Worker clients and a starting time.  Each  day,  at
              the  specified  time, all members of the group will
              start their saves.  For more  information  see  the
              nnssrr__ggrroouupp(5) manual page.

       NNSSRR jjuukkeebbooxx
              This   resource   type  describes  a  jukebox.   It
              includes attributes such as the jukebox model,  the
              first and last slot numbers in the jukebox, and the
              names of the devices within the jukebox.  For  more
              information see the nnssrr__jjuukkeebbooxx(5) manual page.

       NNSSRR llaabbeell
              This  resource type specifies a template describing
              a sequence of names to be used when  labeling  vol-
              umes.  For  more  information  see the nnssrr__llaabbeell(5)
              manual page.

       NNSSRR lliicceennssee
              This resource contains  licensing  information  for
              each  feature  currently  enabled in this NetWorker
              installation.   It  contains  various  enabler  and
              authorization  codes  that are used by NetWorker to
              validate licensed capabilities.  For more  informa-
              tion  see  the  nnssrr__lliicceennssee(5) and nnssrrccaapp(8) manual
              pages.

       NNSSRR nnoottiiffiiccaattiioonn
              A notification specifies an action to be  performed
              when  a  particular  type  of NetWorker event takes
              place.  For more information see the  nnssrr__nnoottiiffiiccaa--
              ttiioonn(5) manual page.

       NNSSRR ppoolliiccyy
              Policy resources are used as part of the index man-
              agement process in NetWorker.  These policies  con-
              trol  how long entries remain in a client's on-line
              file index and when to mark a  save  set  as  recy-
              clable.  For more information see the nnssrr__ppoolliiccyy(5)
              manual page.

       NNSSRR ppooooll
              This  resource  type  is  used  by   NetWorker   to



NetWorker rt_1998_4Q.Build.MMaJrFcehra0l8_,0021000                        4





NSR_RESOURCE(5)                                   NSR_RESOURCE(5)


              determine  what  volumes save sets should reside on
              based on the characteristics  of  the  save  (e.g.,
              group  or  level).   For  more  information see the
              nnssrr__ppooooll(5) manual page.

       NNSSRR sscchheedduullee
              Schedule resources define a sequence of save levels
              and an override list.  The override list is made up
              of pairs of levels and dates.  The  level  controls
              the  amount  of  data saved when a client is backed
              up.  For more information see  the  nnssrr__sscchheedduullee(5)
              manual page.

       NNSSRR ssttaaggee
              Each  stage  resource  describes  a staging policy.
              The resource includes attributes that  define  con-
              trol parameters for the policy, and devices managed
              by  the  policy.   For  more  information  see  the
              nnssrr__ssttaaggee(5) manual page.

FFIILLEESS
       //nnssrr//rreess//nnssrr..rreess    Holds     the    NetWorker    server's
                           resources.

SSEEEE AALLSSOO
       rreessoouurrccee(5), nnssrr(5), nnssrr__cclliieenntt(5), nnssrr__ddeevviiccee(5),
       nnssrr__ddiirreeccttiivvee(5), nnssrr__ggrroouupp(5), nnssrr__jjuukkeebbooxx(5),
       nnssrr__llaabbeell(5), nnssrr__lliicceennssee(5), nnssrrccaapp(8),
       nnssrr__nnoottiiffiiccaattiioonn(5), nnssrr__ppoolliiccyy(5), nnssrr__ppooooll(5),
       nnssrr__sscchheedduullee(5), nnssrr__sseerrvviiccee(5), nnssrr__ssttaaggee(5), nnssrr(8),
       nnwwaaddmmiinn(8), ssaavveeggrroouupp(8), ssaavveeffss(8), nnssrraaddmmiinn(8), uuaassmm(8).


























NetWorker rt_1998_4Q.Build.MMaJrFcehra0l8_,0021000                        5


