


NSR_GROUP(5)                                         NSR_GROUP(5)


NNAAMMEE
       nsr_group - NetWorker resource type ``NSR group''

SSYYNNOOPPSSIISS
       ttyyppee:: NNSSRR ggrroouupp

DDEESSCCRRIIPPTTIIOONN
       Each  NetWorker group is described by a single resource of
       type NNSSRR ggrroouupp (see nnssrr__rreessoouurrccee(5)).   To  edit  the  NNSSRR
       ggrroouupp resources for a NetWorker server type:
              nsradmin -c "type:NSR group"
       or  use  the  nnwwaaddmmiinn(8)  GUI.  See the nnssrraaddmmiinn(8) manual
       page for more information on using the NetWorker  adminis-
       tration program.

       These  resources control when a group of NetWorker clients
       begin saving data and whether backups are started automat-
       ically   each   day.    Each   NNSSRR  cclliieenntt  resource  (see
       nnssrr__cclliieenntt(5)) lists the groups of which that  client  (or
       save  sets  for that client) is a member.  Groups can only
       be deleted if no clients are members of them.

AATTTTRRIIBBUUTTEESS
       The following attributes are defined for resource type NNSSRR
       ggrroouupp.   The  information in parentheses describes how the
       attribute values are accessed.  CCrreeaattee--oonnllyy indicates that
       the  value  cannot be changed by an administrator once the
       resource is created.  RReeaadd//wwrriittee means the  value  can  be
       set  as  well  as read at any time.  CChhooiiccee indicates that
       the value can only be selected from a given list.   YYeess//nnoo
       means  only  a  yes  or  no  choice  is  possible.  SSttaattiicc
       attributes  change  values  rarely,  if   ever.    DDyynnaammiicc
       attributes have values which change rapidly.  HHiiddddeenn means
       it is  an  attribute  of  interest  only  to  programs  or
       experts,  and  these  attributes can only be seen when the
       hidden option is turned on in nnssrraaddmmiinn(8).   For  example,
       an  attribute  marked  ((ccrreeaattee--oonnllyy,,  ssttaattiicc))  has a value
       which is set when  the  attribute  is  created  and  never
       changes.   Several additional attributes (e.g. administra-
       tor) are common to all resources,  and  are  described  in
       nnssrr__rreessoouurrccee(5).

       nnaammee      (create-only)
              This  attribute  contains  the  name  of  the group
              defined by this resource.  The name must be  unique
              for  this  NetWorker  server,  but otherwise can be
              anything that makes  sense  to  the  administrator.
              This name will appear as a choice attribute of each
              NNSSRR cclliieenntt and NNSSRR ppooooll(5) resource.  The NNSSRR ggrroouupp
              resource  named  `Default'  may be modified, but it
              may not be removed.  The name can only be specified
              when the group is created.
              _E_x_a_m_p_l_e_: name: marketing;




NetWorker rt_1998_4Q.Build.MMaJrFcehra0l8_,0021000                        1





NSR_GROUP(5)                                         NSR_GROUP(5)


       aauuttoossttaarrtt (read/write, choice)
              The  autostart  attribute  determines if this group
              will be saved automatically every day.  It  may  be
              one  of  three  values:  EEnnaabblleedd, DDiissaabblleedd or SSttaarrtt
              nnooww..  When the value is  EEnnaabblleedd,  the  members  of
              this group will start saving data at the time spec-
              ified in the ssttaarrtt ttiimmee attribute.  When the  value
              is  DDiissaabblleedd,  the  member  of  this group will not
              automatically start saving their  data.   When  the
              SSttaarrtt  nnooww  value  is specified, the member clients
              will  start  saving  their  data  immediately.  The
              attribute will then return to its prior value.
              _E_x_a_m_p_l_e_: autostart: Enabled;

       aauuttoorreessttaarrtt    (read/write, choice, hidden)
              This controls whether this group should be automat-
              ically restarted when an incomplete run (due  to  a
              power  failure  or  administrator  intervention) is
              noticed during NetWorker server startup.  Like  the
              aauuttoossttaarrtt attribute, setting this attribute's value
              to RReessttaarrtt nnooww  causes  NetWorker  to  restart  the
              group immediately. Enabling aauuttoorreessttaarrtt only has an
              effect if aauuttoossttaarrtt is also enabled.

       ssttoopp nnooww  (read/write, choice, hidden)
              Setting this value to `True'  when  this  group  is
              running causes this group to abort all of its saves
              immediately.  Once the group is stopped, the  value
              is  set  back to `False'.  These are the only valid
              values.

       ssttaarrtt ttiimmee     (read/write)
              The start time attribute specifies the time of  day
              when  this  group will start saving.  The NetWorker
              server's local time is used.  The time is specified
              as  "_h_o_u_r_s:_m_i_n_u_t_e_s".   Note  that the quotes may be
              necessary when using character-based administration
              tools  such  as the nnssrraaddmmiinn program because of the
              colon in the value.  The hours may range from 0  to
              23  (using  a  24 hour clock) and the minutes range
              from 0 to 59.
              _E_x_a_m_p_l_e_: start time: "4:53";

       llaasstt ssttaarrtt     (read/write, hidden)
              The  last  time  this  group  was  started.    This
              attribute  is  for informational purposes only, and
              changing it has no effect on the system.

       iinntteerrvvaall       (read/write, static, hidden)
              The interval time specifies how often this group is
              to  be  run  automatically  by NetWorker.  Manually
              starting  a  group  overrides  the  interval.   The
              default value is 24:00, which means run once a day.




NetWorker rt_1998_4Q.Build.MMaJrFcehra0l8_,0021000                        2





NSR_GROUP(5)                                         NSR_GROUP(5)


       ffoorrccee iinnccrreemmeennttaall   (read/write, static, hidden, choice)
              Setting this  attribute  to  `Yes'  will  force  an
              incremental level of a savegroup, when the iinntteerrvvaall
              attribute is less than 24 hours.  The default value
              is  `Yes,'  which means force an incremental if the
              group is run more than once a day.  A value of `No'
              would allow more than one full per day.

       cclliieenntt rreettrriieess (read/write)
              The  number  of  times  failed  clients  should  be
              retried before ssaavveeggrroouupp gives up and declare  them
              failed.   Zero  means don't retry.  Abandoned saves
              are not retried, because they may  eventually  com-
              plete.   A  client's save sets are retried by ssaavvee--
              ggrroouupp whenever savegroup  would  otherwise  not  be
              able  to  start a new save set.  That is, savegroup
              prefers to start new  save  sets  first,  and  only
              retries when there is nothing else to do.
              _E_x_a_m_p_l_e_: client retries: 1;

       cclloonneess         (read/write, static, yes/no, choice)
              Setting  this  value  to `Yes' causes saves of this
              group to automatically make a clone of  every  save
              set backed up.  The save set clones will be sent to
              the pool named in the cclloonnee ppooooll attribute.

       cclloonnee ppooooll          (read/write, static, choice)
              The pool to which save set clones  should  be  sent
              when `clones' is `Yes'.  Only pools of type `Backup
              Clone' are allowed (see nnssrr__ppooooll(5)).

       ooppttiioonnss        (read/write, static, hidden)
              The values specify flags with which this group will
              be  run.   The values No Monitor, No index save, No
              save, Verbose, Estimate, and Preview map to the the
              ssaavveeggrroouupp  command  line  flags -m, -I, -n, -v, -E,
              and -p respectively.  Some of these values (Preview
              and  No save) are automatically reset when a run of
              ssaavveeggrroouupp completes normally.
              _E_x_a_m_p_l_e_: options: Verbose;

       lleevveell          (read/write, hidden, choice)
              This is an explicit level the  savegroup  will  use
              when started automatically by NetWorker.  _T_h_i_s _h_i_d_-
              _d_e_n _a_t_t_r_i_b_u_t_e _c_a_n _b_e  _m_o_d_i_f_i_e_d  _b_y  _a  _u_s_e_r_.   This
              value  is  not  cleared  automatically, i.e. if one
              sets this attribute to full this savegroup will run
              with  a  full  level  until  this value is manually
              cleared.  When not specified (the normal case), the
              NSR  Schedule  for  each  client filesystem will be
              used to  determine  the  level.   Manually  running
              ssaavveeggrroouupp  from  the  command  line  overrides this
              value.  The choices are the standard level  identi-
              fiers  `full', `incr', `skip' and the number levels



NetWorker rt_1998_4Q.Build.MMaJrFcehra0l8_,0021000                        3





NSR_GROUP(5)                                         NSR_GROUP(5)


              `1' through `9'.

       pprriinntteerr        (read/write, static, hidden)
              The printer to which the bootstrap save set  infor-
              mation  will be printed, if one is generated by the
              run of this group.  _T_h_i_s _h_i_d_d_e_n  _a_t_t_r_i_b_u_t_e  _c_a_n  _b_e
              _m_o_d_i_f_i_e_d  _b_y _a _u_s_e_r_.  If an invalid printer name is
              specified, bootstrap information will  be  included
              in   the  savegroup  completion  information  piped
              through the _s_a_v_e_g_r_o_u_p _c_o_m_p_l_e_t_i_o_n notification  (see
              nnssrr__nnoottiiffiiccaattiioonn(5)).
              _E_x_a_m_p_l_e_: printer: ps;

       sscchheedduullee  (read/write, choice, hidden)
              The  schedule  to use for determining what level of
              save to perform.  _T_h_i_s _h_i_d_d_e_n _a_t_t_r_i_b_u_t_e _c_a_n _b_e _m_o_d_-
              _i_f_i_e_d  _b_y  _a _u_s_e_r_.  This value is not cleared auto-
              matically, i.e. if one sets  this  attribute  to  a
              particular  schedule, all clients which are part of
              this group will  have  their  schedules  overridden
              until  this  value is manually cleared.  This over-
              rides  the  schedule   specified   for   individual
              clients.  See nnssrr__sscchheedduullee(5)).

       sscchheedduullee ttiimmee  (read/write, hidden)
              An explicit time can be specified when looking at a
              schedule to determine which level of save  to  per-
              form.   A null value (normal setting) means use the
              current date to determine the level.
              _E_x_a_m_p_l_e_: schedule time: "3:00 am 01/11/93";

       iinnaaccttiivviittyy ttiimmeeoouutt  (read/write, static, hidden)
              The number of minutes that  the  ssaavveeggrroouupp  command
              waits for any kind of activity on the server before
              concluding that a  ssaavveeggrroouupp  descendant  is  hung.
              _T_h_i_s  _h_i_d_d_e_n  _a_t_t_r_i_b_u_t_e  _c_a_n _b_e _m_o_d_i_f_i_e_d _b_y _a _u_s_e_r_.
              Once a hang is detected, ssaavveeggrroouupp prints a message
              indicating  that a ssaavvee is abandoned, and ssaavveeggrroouupp
              moves on to its next task.
              _E_x_a_m_p_l_e_: inactivity timeout: 30;

       wwoorrkk lliisstt (read/write, dynamic, hidden)
              The list of saves still not completed.  These  come
              in sets of 3 values:  the client name, the level of
              save, and the path to save.
              _E_x_a_m_p_l_e_: work list: mars, incr, /usr,  mars,  incr,
              /g, mars, venus, /usr

       ccoommpplleettiioonn     (read/write, dynamic, hidden)
              The  status  of  each  save  set that has been com-
              pleted.  These come  in  sets  of  4  values:   the
              client name, the path saved, a status message (suc-
              ceeded, failed, or unexpectedly  exited),  and  the
              output from the save.



NetWorker rt_1998_4Q.Build.MMaJrFcehra0l8_,0021000                        4





NSR_GROUP(5)                                         NSR_GROUP(5)


              _E_x_a_m_p_l_e_:  completion:  "mars", "/usr", "succeeded",
              "mars: /           level=full,   6577  KB  00:06:41
              625 files"

       ssttaattuuss    (read-only, dynamic, hidden)
              The  current  status of this NSR group.  Currently,
              this can have  the  values  `idle',  `running'  and
              `cloning'.   The value `idle' is set when the group
              is not active, it is `running' while backups are in
              progress,  and it is `cloning' when the backups are
              complete and clones are automatically being made.

EEXXAAMMPPLLEE
       The default NSR group resource  automatically  starts  its
       members at 33 minutes past 3 o`clock in the morning:


                         type:  NSR group;
                         name:  Default;
                    autostart:  Enabled;
                   start time:  "3:33";
                administrator:  root;

       A  complete  example  follows,  with the hidden attributes
       shown with values reasonable for an active group:


                       type:  NSR group;
                       name:  Default;
                  autostart:  Enabled;
                 start time:  "3:33";
                    options:  Restartable;
                    printer:  lp2;
         inactivity timeout:  30;
                  work list:  mars, incr, /g, mars, incr, index,
                              venus, incr, /usr, venus, incr, index,
                              jupiter, full, /, jupiter, full, /usr,
                              jupiter, full, index
                 completion:  mars, /, succeeded,
       "mars: / level=incr,     31 KB 00:01:01     72 files
       ",
                              mars, /usr, succeeded,
       "mars: /usr level=incr,      2 KB 00:00:48      5 files
       ",
                              venus, /, succeeded,
       "venus: / level=incr,   7711 KB 00:04:37     29 files
       ";
              administrator:  root, &operator;

SSEEEE AALLSSOO
       nnssrr(8), nnssrr__nnoottiiffiiccaattiioonn(5), nnssrr__ppooooll(5), nnssrr__rreessoouurrccee(5),
       nnssrr__sscchheedduullee(5), nnssrraaddmmiinn(8), nnwwaaddmmiinn(8), ssaavveeggrroouupp(8).





NetWorker rt_1998_4Q.Build.MMaJrFcehra0l8_,0021000                        5


