


NSRIM(8)                                                 NSRIM(8)


NNAAMMEE
       nsrim - NetWorker index management program

SSYYNNOOPPSSIISS
       nnssrriimm [ --bb _b_r_o_w_s_e ] [ --cc _c_l_i_e_n_t ] [ --NN _s_a_v_e _s_e_t ]
       [ --rr _r_e_t_e_n_t_i_o_n ] [ --xx _p_e_r_c_e_n_t ] [ --llnnqqvvMMXX ]

DDEESSCCRRIIPPTTIIOONN
       The  nnssrriimm  program  is  used to manage NetWorker's online
       file and media indexes.  Normally,  nnssrriimm  is  invoked  by
       nnssrrmmmmddbbdd(8)  at startup, by the ssaavveeggrrpp(8) command on com-
       pletion, and  by  nnssrrdd(8)  when  _R_e_m_o_v_e  _o_l_d_e_s_t  _c_y_c_l_e  is
       selected  from the NetWorker Administrator program.  nnssrriimm
       is not normally run manually.

       nnssrriimm uses _p_o_l_i_c_i_e_s to determine  how  to  manage  on-line
       entries  (see nnssrr__ppoolliiccyy(5), nnssrr__cclliieenntt(5), and the _L_e_g_a_t_o
       _N_e_t_W_o_r_k_e_r _A_d_m_i_n_i_s_t_r_a_t_o_r_'_s  _G_u_i_d_e  for  an  explanation  of
       index  policies).   Entries  that  have been in an on-line
       file index longer than the period specified by the respec-
       tive  client's  browse policy are removed.  Save sets that
       have  existed  longer  than  the  period  specified  by  a
       client's  retention policy are marked as _r_e_c_y_c_l_a_b_l_e in the
       media index.  When all of the save sets on a  volume  have
       been  marked  recyclable,  then  the  volume is considered
       recyclable.  Recyclable volumes may be selected (and auto-
       matically  relabeled  by  a  jukebox)  by NetWorker when a
       writable volume is needed to hold  new  backups.   When  a
       recyclable  volume  is re-used, the old data is erased and
       is no longer recoverable.

       Unless the --qq option is  used,  nnssrriimm  prints  header  and
       trailer  information  for  each  group  of save sets.  The
       header lists the save set type, the client name, the  save
       set name, and the applicable browse and retention policies
       that apply to the save set (see the example below).  There
       are four types of save sets:

       _N_o_r_m_a_l includes  all  save  sets  backed  up automatically
              using ssaavveeggrrpp that are associated with a  schedule,
              a browse policy, and a retention policy.

       _A_d _h_o_c_s
              User  initiated save sets are designated by append-
              ing _a_d _h_o_c_s to the header line.

       _A_r_c_h_i_v_e_s
              Save sets that never expire automatically are  des-
              ignated by appending _a_r_c_h_i_v_e_s to the save set line.

       _M_i_g_r_a_t_i_o_n_s
              Save sets that never expire automatically and  were
              created  by a file migration application are desig-
              nated by appending _m_i_g_r_a_t_i_o_n_s to the save set line.



NetWorker rt_1998_4Q.Build.MMaJrFcehra0l8_,0021000                        1





NSRIM(8)                                                 NSRIM(8)


       The  trailer lists four utilization statistics of the save
       set after nnssrriimm has applied the policies to it.  The  four
       statistics are the total number of browsable files remain-
       ing in the online index, the grand  total  of  files  cur-
       rently  associated  with  the  save set, and the amount of
       recoverable data out of the grand total of data associated
       with  the save set.  For example, nnssrriimm may print the fol-
       lowing output for a single save set name:

              mars:/usr, retention policy: Year, browse policy: Month, ad hocs
              8481 browsable files of 16481 total, 89 MB recoverable of 179 MB total

              mars:/usr, retention policy: Year, browse policy: Month, ad hocs
              0 browsable files of 13896 total, 163 MB recoverable of 163 MB total

              mars:/usr, retention policy: Year, browse policy: Month 43835
              browsable files of 427566 total, 6946 MB recoverable of 7114 MB total


       When the --vv option is used, the following  information  is
       also  printed for each save set: the save set id, creation
       date, level, file count, size, and status.  A  save  set's
       status is one of the following:

       _b_r_o_w_s_e The  file  entries  for  the save set are browsable
              (the save set  files  still  exist  in  the  online
              index).  These files are easily restored using Net-
              Worker's recover mechanisms.

       _r_e_c_o_v_e_r
              The age of the  save  set's  does  not  exceed  its
              retention  policy for the save set, but its entries
              have been purged  from  NetWorker's  online  index.
              This  means  that  save set is recoverable from the
              back-up media using rreeccoovveerr (see rreeccoovveerr(8)); ssccaann--
              nneerr(8) may be also be used to recover the save set,
              but users should utilize rreeccoovveerr first).

       _r_e_c_y_c_l_e
              The save set is older than its associated retention
              policy  and  may  be overwritten (deleted) once its
              backup media is recycled.  Until the media is recy-
              cled,  the  save  set  is also recoverable from the
              back-up media.

       _d_e_l_e_t_e The  save  set  will  be  deleted  from  the  media
              database.   nnssrriimm deletes only recyclable save sets
              that have zero files.

       The save set status may be followed by any of the  follow-
       ing modifiers:

       _(_e_x_p_i_r_e_s _m_m_/_d_d_/_y_y_)
              The save set has an explicit expiration date in the



NetWorker rt_1998_4Q.Build.MMaJrFcehra0l8_,0021000                        2





NSRIM(8)                                                 NSRIM(8)


              future, and is exempt from any status change.

       _(_a_r_c_h_i_v_e_)
              The save set never expires, and is exempt from  any
              status change.

       _(_m_i_g_r_a_t_i_o_n_)
              The save set was created by a file migration appli-
              cation and never expires, and is  exempt  from  any
              status change.

       _(_s_c_a_n_n_e_d _i_n_)
              The  save  set  was restored using the ssccaannnneerr com-
              mand, and is exempt from any status change.

       _(_a_b_o_r_t_e_d_)
              A save set of questionable  size  consuming  backup
              media space.

       If  nnssrriimm changes the status of a save set, then it prints
       the transition symbol -->> followed by the new status.   For
       example:

              17221062  3/05/92  f  23115 files   158 MB recycle
              17212499  3/19/92  f  625   files    26 MB recover(aborted)->recycle
              17224025  5/23/92  i  0     files     0 KB recover->recycle->delete
              17226063  6/05/92  f  3115  files    58 MB recover
              17226963  6/09/92  f  3197  files   114 MB browse->recover
              17227141  6/10/92  f  3197  files   115 MB browse


       Once  nnssrriimm  has  processed all of the save sets, it flags
       the file index for cross-checking in nnssrriinnddeexxdd(8).  If the
       --ll  flag  is  specified, the cross-check is attempted syn-
       chronously,  otherwise,  it  is   simply   scheduled   and
       nnssrriinnddeexxdd performs the cross-check when the index is idle.
       Concurrently, nnssrriimm processes the status of  any  affected
       NetWorker  volumes.   With  the  absence of the --qq flag, a
       line is printed for each volume.  The  line  includes  the
       volume name, the amount of space used, the total number of
       save sets, and the status.  The status will be one of  the
       following:

       _a_p_p_e_n_d_a_b_l_e
              More  save sets may be appended to the volume.  The
              status  may  also  be  modified   with   _(_c_u_r_r_e_n_t_l_y
              _m_o_u_n_t_e_d_)  which  signifies  that  the  volume could
              transition to the _r_e_c_y_c_l_a_b_l_e state if  it  was  not
              mounted for writing.

       _r_e_a_d_-_o_n_l_y, _f_u_l_l
              No  more  save  sets can be appended to the volume,
              nor can the volume be re-used,  since  it  contains
              some valuable save sets.



NetWorker rt_1998_4Q.Build.MMaJrFcehra0l8_,0021000                        3





NSRIM(8)                                                 NSRIM(8)


       _r_e_c_y_c_l_a_b_l_e
              No  more  save  sets can be appended to the volume,
              and all save sets on the volume have expired.

       In addition, the following modifier applies to all four of
       the above states:

       _(_m_a_n_u_a_l _r_e_c_y_c_l_a_b_l_e_)
              The  volume  will not be automatically eligible for
              recycling when all of its save sets  have  expired.
              Instead,  the volume may only be recycled by a man-
              ual relabel operation.  Note that a _r_e_a_d_-_o_n_l_y  vol-
              ume  can  still be recycled unless the _m_a_n_u_a_l_-_r_e_c_y_-
              _c_l_a_b_l_e flag is  also  set.   The  manual-recyclable
              flag  can be set using the NetWorker administration
              GUI (nnwwaaddmmiinn(8)) or the nnssrrmmmm(8) and nnssrrjjbb(8)  com-
              mands  when  volumes  are  labeled  or  at any time
              thereafter.  This flag is never set  automatically.

       If  the  volume status changes, then nnssrriimm appends -->>rreeccyy--
       ccllaabbllee to the status.  If the volume contains some  brows-
       able  save sets, then this is noted; recoverable save sets
       are also noted.  The odd case where an  appendable  volume
       has only recyclable save sets is also noted. For example:

              jupiter.20: 3474 MB used, 398 save sets, full->recyclable
              jupiter.21: 4680 MB used, 440 save sets, full, 249 recoverable
              jupiter.22: 4689 MB used, 351 save sets, full, 351 browsable
              jupiter.24: 1488 MB used, 141 save sets, appendable, 141 browsable


RREETTEENNTTIIOONN AANNDD BBRROOWWSSEE PPOOLLIICCIIEESS
       Under normal circumstances, the association between browse
       or retention policies and client  save  sets  is  obvious.
       However,  since  a save set may be listed by more than one
       client resource  with  the  same  name,  and  each  client
       resource  may specify different browse and retention poli-
       cies, determining the policies applicable to a save set is
       not always straight forward.  nnssrriimm(8), uses the following
       steps to select an instance of a client resource with  the
       client's  name.  Once the client resource is selected, its
       browse or retention policy is used for  managing  informa-
       tion about the save set.

       1)   Locate  a client resource explicitly listing the save
            set.  If more than one client resource lists the save
            set, choose the client resource with the longest pol-
            icy.

       2)   Search for a client resource  listing  the  save  set
            "All".   If  more  than one client resource lists the
            save set "All", choose the client resource  with  the
            longest policy.




NetWorker rt_1998_4Q.Build.MMaJrFcehra0l8_,0021000                        4





NSRIM(8)                                                 NSRIM(8)


       3)   Find  the client resource listing a save set with the
            most common prefix (longest) of the target save  set.
            If  more  than one client resource lists the save set
            with  the  most  common  prefix,  choose  the  client
            resource with the longest policy.

       4)   Among  all of the client resources, choose the client
            resource with the longest policy.

       Note that if two or more client resources  with  the  same
       name exist, it is possible that the browse policy from one
       instance of the client resource and the  retention  policy
       of another instance of the client resource may be used for
       managing save set information.

       Save sets that  have  no  corresponding  NetWorker  client
       resource  use the NetWorker client resources of the server
       to determine the browse or retention policies.

       A save set cannot be purged from the index or  marked  for
       recycling  until  all  of its dependent save sets are also
       eligible for purging or recycling.  See  the  _L_e_g_a_t_o  _N_e_t_-
       _W_o_r_k_e_r  _A_d_m_i_n_i_s_t_r_a_t_o_r_s  _G_u_i_d_e for an explanation of depen-
       dent save sets.

       The last (and only) Full save set will not be purged  from
       the  on-line  index until it is also marked for recycling.
       In this case, the header line of the save  set  omits  the
       browse  policy  and prints a message stating that only one
       browsable cycle exists.

       With the exception of the --ll option, manual hoc save  sets
       are  treated  as  full  save sets that have no dependents.
       However, unlike true full save sets, the last manual  save
       set  is not given any special consideration with regard to
       index purging.

       The expiration time applied to save sets is rounded up  to
       midnight  when the elapsed time implied by the policies is
       greater than or equal to a day.  Therefore,  nnssrriimm  should
       produce  the same results whether it is run at 8 a.m. or 5
       p.m. on the same day.

OOPPTTIIOONNSS
       --bb _b_r_o_w_s_e
              Uses the specified policy rather  than  the  browse
              policy  found  on  the  client's resource.  This is
              very useful when combined with the --nn option to see
              how  a  new  or  modified  policy  will  affect the
              indexes.

       --cc _c_l_i_e_n_t
              Only processes the online file index for the speci-
              fied  client.   Normally,  all  client  indexes are



NetWorker rt_1998_4Q.Build.MMaJrFcehra0l8_,0021000                        5





NSRIM(8)                                                 NSRIM(8)


              processed.  This option may be repeated to  process
              multiple clients.

       --ll     Removes  the  oldest  full  save  and all save sets
              dependant on it from the online index.  Browse  and
              retention  policies  are  ignored.   The  save  set
              header information will print the number of  brows-
              able  full  cycles  currently  in the online index.
              _A_r_c_h_i_v_e and _M_i_g_r_a_t_i_o_n save sets are ignored.   With
              this option, _m_a_n_u_a_l save sets are treated as normal
              _i_n_c_r_e_m_e_n_t_a_l level save sets.  This option also sets
              the utilization threshold to 30 percent.

       --MM     Master  mode  (not  advised  for manual operation).
              Advises nnssrriimm that it is being run  by  nnssrrdd(8)  or
              another  NetWorker  daemon  and  that it should log
              messages with timestamps,  and  perform  any  other
              behavior expected by nnssrrdd.

       --NN _s_a_v_e _s_e_t
              Processes  only  save  sets  named;  all others are
              skipped.  This option can be  repeated  to  process
              multiple save sets.

       --nn     Do  nothing.   Instead, emulate the actions of this
              command without the index cross-check.   Note  that
              trailer  statistics  reflect  current (and not emu-
              lated) results.

       --qq     Run quietly.  This option will not generate header,
              trailer or save set  messages.

       --rr _r_e_t_e_n_t_i_o_n
              Uses the specified policy rather than the retention
              policy found on the  client's  resource.   This  is
              very useful when combined with the --nn option to see
              how a new or modified policy will affect  the  vol-
              umes.

       --vv     Produces  a more detailed report.  This may produce
              a large amount of output.  When both --vv and --qq  are
              issued, they cancel each other.

       --XX     Consistency  check  the data structures of the save
              set with the data structures of the  volume.   This
              is  only  required  after  a NetWorker crash.  This
              option also sets the utilization  threshold  to  30
              percent.

       --xx _p_e_r_c_e_n_t
              Sets the utilization threshold.  If, after removing
              entries, the utilization of an online file index is
              less  than  the specified amount, the index is com-
              pressed automatically by passing this percentage to



NetWorker rt_1998_4Q.Build.MMaJrFcehra0l8_,0021000                        6





NSRIM(8)                                                 NSRIM(8)


              nnssrriinnddeexxdd   when  requesting  a  cross-check.   The
              default value is 50 (percent).  Note that  specify-
              ing --XX or --ll changes the default to 30 (percent).

FFIILLEESS
       //nnssrr//ttmmpp//..nnssrriimm
              nnssrriimm  locks  this  file,  preventing more than one
              copy of itself from thrashing the media database.

SSEEEE AALLSSOO
       nnssrr__cclliieenntt(5), nnssrr__llaayyoouutt(5), nnssrr__ppoolliiccyy(5), nnssrrdd(8),
       nnssrriinnddeexxdd(8), nnssrrmmmm(8), nnssrrmmmmddbbdd(8), nnwwaaddmmiinn(8),
       rreeccoovveerr(8), ssaavveeggrrpp(8), ssccaannnneerr(8).

DDIIAAGGNNOOSSTTIICCSS
       YYoouu aarree nnoott aauutthhoorriizzeedd ttoo rruunn tthhiiss ccoommmmaanndd
              Only root or NetWorker administrators may run nnssrriimm
              to  modify  the  online indexes.  However, any user
              may invoke the command with the --nn option.

       CCaannnnoott ffeettcchh cclliieenntt rreessoouurrccee ffoorr <<cclliieennttnnaammee>>
              The named client has no  resource  to  extract  the
              browse  and retention policies from.  In this case,
              the resources of the NetWorker server are used.

       nnssrriimm hhaass ffiinniisshheedd ((ccrroossss)) cchheecckkiinngg tthhee mmeeddiiaa ddbb
              This notification messages appears in the NetWorker
              messages  window  when nnssrriimm completes and the com-
              mand was invoked with the --qq  option,  but  without
              the --cc and --NN options.



























NetWorker rt_1998_4Q.Build.MMaJrFcehra0l8_,0021000                        7


