NSRIM(8) Legato NetWorker 4.0 NSRIM(8)
NAME
nsrim - NetWorker index manager 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 save
group(8) command on termination, and by the 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 Net
Worker 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 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 recyclable in the media index. When all of the save sets
on a volume have been marked recyclable, then the volume is consid
ered recyclable. Recyclable volumes may be selected by NetWorker
when a writable volume is needed to hold new backups. When a recy
clable 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 infor
mation 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 auto
matically 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 hocs
to the header line.
Archive
Save sets that never automatically expire are designated by
appending archives to the header 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 associ
ated with the save set. For example, nsrim may print the following
output for a single save set name:
ad hoc mars:/usr, retention policy: Year, browse policy: Month
8481 browsable files of 16481 total, 89 MB retrievable of 179 MB total
Licensed material--property of copyright holder(s) 1
NSRIM(8) Legato NetWorker 4.0 NSRIM(8)
archive mars:/usr
13896 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 Net
Worker's on-line index. This means that save set is retriev
able from the back-up media; scanner(8) may be used to recover
the save set.
recycle
The save set is older than its associated retention policy and
may be over-written (deleted) once its back-up media is recy
cled. 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 modi
fiers:
(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 transi
tion symbol -> followed by the new status. For example:
Licensed material--property of copyright holder(s) 2
NSRIM(8) Legato NetWorker 4.0 NSRIM(8)
17221062 3/05/92 f 23115 files 158 MB recycle
17212499 3/19/92 f 625 files 26 MB retrieve(aborted)->recycle
17224025 5/23/92 i 0 files 0 KB retrieve->recycle->delete
17226063 6/05/92 f 3115 files 58 MB retrieve
17226963 6/09/92 f 3197 files 114 MB browse->retrieve
17227141 6/10/92 f 3197 files 115 MB browse
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 affected 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, but all the
save sets on the volume have expired.
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 POLICIES
Under normal circumstances the association between retention policies
and clients' save sets is obvious. However, there are exceptions and
clarifications listed below:
Save set names that do not match ``All'' or names explicitly found in
NetWorker client resource records, bind to the most common prefix
save set name listed for the client. If there is no common prefix,
then policies are obtained from the shortest save set name found in
the client's resource records.
Save sets which have no corresponding NetWorker client resource
records use those of the NetWorker server itself.
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.
Licensed material--property of copyright holder(s) 3
NSRIM(8) Legato NetWorker 4.0 NSRIM(8)
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 are more than one full save sets in the on-line index.
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 statis
tics 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 com
bined with the -n option to see how a new or modified policy
will affect the volumes.
Licensed material--property of copyright holder(s) 4
NSRIM(8) Legato NetWorker 4.0 NSRIM(8)
-X Consistency check the save sets' data structures with the vol
umes' 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).
-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) 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.
Licensed material--property of copyright holder(s) 5