NAME

nsrim − NetWorker index management program

SYNOPSIS

nsrim [ −b browse ] [ −c client ] [ −N save set ] [ −r retention ] [ −x percent ] [ −lnqvX ]

DESCRIPTION

nsrim is used to manage NetWorker’s on-line file and media indexes.  Normally, nsrim is invoked by nsrmmdbd(8) upon start up, by the savegroup(8) command on completion, and by nsrd(8) as the result of a user selecting Remove oldest cycle via a NetWorker GUI.  nsrim is not normally run by hand. 

nsrim uses policies (see nsr_policy(5), nsr_client(5), and the NetWorker Administrator’s Guide for an explanation of index policies) to determine how to manage on-line entries.  Entries that have been in an on-line file index longer than the period specified by the respective 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 recyclable 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 automatically 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 −q option is given, nsrim 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 three types of save sets:

Normal
Normal includes all save sets that have been backed up automatically via savegroup and are associated with a schedule, a browse policy and a retention policy. 

Ad hoc
User initiated save sets are designated by appending ad hoc to the header line. 

Archive
Save sets that never automatically expire are designated by appending archive to the save set line. 

The trailer lists four utilization statistics of the save set after nsrim has applied the policies to it.  The four statistics are the total number of browsable files remaining in the on-line index and the grand total of files currently associated with the save set, and the amount of retrievable data out of the grand total of data associated with the save set.  For example, nsrim may print the following output for a single save set name:

mars:/usr, retention policy: Year, browse policy: Month, ad hoc
8481 browsable files of 16481 total, 89 MB retrievable of 179 MB total
 mars:/usr, retention policy: Year, browse policy: Month, ad hoc
0 browsable files of 13896 total, 163 MB retrievable of 163 MB total
 mars:/usr, retention policy: Year, browse policy: Month
43835 browsable files of 427566 total, 6946 MB retrievable of 7114 MB total

When the −v option is given, the following information is also printed for each individual save set: the save set id, creation date, level, file count, size, and its status.  A save set’s status is one of the following:

browse The file entries for the save set are browsable; that is, the save sets files still exist in the on-line index.  This means that the files are easily restored using NetWorker’s recover mechanisms. 

retrieve
The save set’s age has not exceeded the retention policy for the save set, but its entries have been purged from NetWorker’s on-line index. This means that save set is retrievable from the back-up media. Retrievable save sets can be restored by running recover by save set (see recover(8)); scanner(8) may be also be used to recover the save set, but users should utilize recover first. 

recycle The save set is older than its associated retention policy and may be over-written (deleted) once its back-up media is recycled.  Until the media is recycled, the save set is also retrievable from the back-up media. 

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

The save set status may be followed by any of the following modifiers:

(expires mm/dd/yy)
The save set has an explicit expiration date in the future, and therefore it is exempt from any status change.

(archive)
The save set never expires, and therefore it is exempt from any status change.

(scanned in)
The save set was resurrected using the scanner command, and therefore it is exempt from any status change. 

(aborted)
A save set of dubious value which consumes back-up media real estate.

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

17221062  3/05/92  f23115files158 MBrecycle
17212499  3/19/92  f625files26 MBretrieve(aborted)->recycle
17224025  5/23/92  i0files0 KBretrieve->recycle->delete
17226063  6/05/92  f3115files58 MBretrieve
17226963  6/09/92  f3197files114 MBbrowse->retrieve
17227141  6/10/92  f3197files115 MBbrowse

Once nsrim has processed all of the save sets, it invokes nsrck(8) to consistency check any affected client’s on-line index.  Concurrently, it processes the status of any affected NetWorker volumes.  With the absence of the −q 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 may be one of

appendable
More save sets may be appended to the volume.

read-only, full
No more save sets may be appended to the volume, nor can the volume be re-used since it contains some valuable save sets.

recyclable
No more save sets may be appended to the volume and all the save sets on the volume have expired.

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

(manual recyclable)
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 manual relabel operation. Note that a read-only volume may still be recycled unless the manual-recyclable flag is also set.  The manual-recyclable flag may be set using the NetWorker administration GUI (nwadmin(8)) or the nsrmm(8) and nsrjb(8) commands when volumes are labeled or at any time thereafter.  This flag is never set automatically. 

If the volume’s status changes, then nsrim appends −>recyclable to the status.  If the volume contains some browsable save sets, then this fact is noted; retrievable save sets are noted similarly.  The odd case that an appendable volume only has 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 retrievable save sets
jupiter.22: 4689 MB used, 351 save sets, full, 351 browsable save sets
jupiter.24: 1488 MB used, 141 save sets, appendable, 141 browsable save sets

RETENTION AND BROWSE POLICIES

Under normal circumstances the association between browse or retention policies, and clients’ 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 policies, determining the policies applicable to a save set is not always straight forward.  nsrim(8), uses the following steps to select an instance of a client resource with the client’s name.  Once the client resource is selected it’s browse or retention policy is used for managing information 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 policy. 

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. 

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 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 which 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 NetWorker Administrators Guide for an explanation of dependent 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 save set’s header line omits the browse policy and instead prints that fact that only 1 browsable cycle exists. 

With the exception of the −l option, ad hoc save sets are treated as Full save sets that never have any dependents.  However unlike true Full save sets, the last ad hoc 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, nsrim should produce the same results whether it is run at 8am or 5pm on the same day. 

OPTIONS

−b browse
Use the specified policy rather than the browse policy found on the client’s resource. This is very useful when combined with the −n option to see how a new or modified policy will affect the indexes. 

−c client
Only process the on-line file index for the specified client. Normally, all client indexes are processed. This option may be repeated such that multiple clients are processed.

−l Remove the oldest full save and all save sets that depend on it from the on-line index.  This option only has an affect if there is more than one cycle of the save set in the on-line index, i.e. there must be multiple full level backups.  Browse and retention policies are ignored.  The save sets’ header information will print the number of browsable full cycles that are currently in the on-line index.  Archive save sets are ignored.  With this option, ad hoc save sets are treated as normal incremental level save sets.  This option also sets the utilization threshold to 30 percent. 

−n Do nothing.  Instead, emulate the actions of this command, sans executing the nsrck command.  Note that trailer statistics reflect current (and not emulated) reality. 

−N save set
Only save sets named save set are processed, all others are skipped.  This option may be repeated such that multiple save set names are processed. 

−q Run quietly.  This option will not generate header, trailer or save set  messages.  This flag is also passed to nsrck. 

−r retention
Use the specified policy rather than the retention policy found on the client’s resource. This is very useful when combined with the −n option to see how a new or modified policy will affect the volumes. 

−X Consistency check the save sets’ data structures with the volumes’ data structures.  This should only need to be done after a NetWorker crash.  This option also sets the utilization threshold to 30 percent. 

−x percent
Set the utilization threshold. If, after removing entries, an on-line file index’s utilization is less than the specified amount, the index is automatically compressed by passing this option to nsrck.  The default value is 50 (percent).  Note that specifying −X or −l changes the default to 30 (percent). 

−v Produce a more detailed report.  This may produce a fantastic amount of output.  When both −v and −q are issued, they cancel each other’s affect. 

FILES

/nsr/tmp/.nsrim
nsrim locks this file, thereby preventing more than one copy of itself from thrashing the media database. 

SEE ALSO

nsr_layout(5), nsrd(8), nsrmm(8), mminfo(8), nsrck(8), nsr_client(5), nsr_policy(5), nsrmmdbd(8), nwadmin(8), recover(8), save(8), savegroup(8), scanner(8). 

DIAGNOSTICS

You are not authorized to run this command
Only root or NetWorker administrators may run nsrim.  However, any user may invoke the command with the −n option. 

Cannot fetch client resource for <clientname>
The named client has no resource to extract the browse and retention policies from.  Therefore, the NetWorker server’s resource will be used.

nsrim has finished (cross) checking the media db
This notification messages appears in the NetWorker messages window when nsrim completes and the command was invoked with the −q option and without the −c and −N options. 

NetWorker 4.1.2  —  Last change: May 1995