Return to xfsinvutil.8 CVS log

Up to [Development] / xfs-cmds / xfsdump / man / man8

First step toward making the xfsdump inventory not break the FHS spec.
Previously, xfsdump wrote to /var/xfsdump for all its inventory data 
needs.  This is now a runtime decision - for existing installations we
continue doing just that, for new installations we use the compliant-
with-FHS directory /var/lib/xfsdump.  Note: cannot just mv one to the
other as xfsdump is "clever" enough to store full pathnames in all its
inventory file - this issue will be resolved by Ivan in an upcoming
xfsinvutil checkin.

.TH xfsinvutil 8
.SH NAME
xfsinvutil \- \&xfsdump inventory database checking and pruning utility
.SH SYNOPSIS
.nf
\f3xfsinvutil\f1 \c
[ \f3\-M\f1 mountpoint mm/dd/yyyy (prune all entries older than 
                specified date for the specified mount point) ] 
        [ \f3\-C\f1 (check and fix xfsdump inventory database \c
inconsistencies)]
        [ \f3-n\f1 (no questions)]
.fi
.SH DESCRIPTION
.I xfsdump 
maintains an online dump inventory in \f2/var/lib/xfsdump/inventory\f1.
The
.B \-I
option of xfsdump displays the inventory contents hierarchically.
The levels of the hierarchy are:
filesystem,
dump session,
stream, and
media file.
.P
Over time, this database may grow too large as xfsdump and xfsrestore do
not remove entries from the inventory. The database may also develop
inconsistencies due to various reasons such as operator errors etc., 
causing xfsdump or xfsrestore to print error or warning messages.
.P
.I xfsinvutil 
is an utility to check this inventory database for consistency and
to remove entries of dump sessions which may no longer be of relevance.
.P
The following command line options are available:
.P
.TP 5
\f3\-M\f1 \f2mountpoint mm/dd/yyyy\f1
Specifies the mount point and cut-off date of inventory entries to
be selected for pruning.
xfsinvutil prompts the operator when a dump session in the inventory 
is identified by the mount point and was created prior to the specified
date. 
The operator can then select specific dump sessions for removal from
the inventory database.
This prompt will not happen if the \f3\-n\f1 option is used; it will
be assumed that the pruning is wanted.
.I xfsinvutil 
also performs consistency checks on other inventory database entries when
invoked with this option. 
.RS
.PP
The \f2mountpoint\f1 must match the mount point as specified in
the inventory shown using
.I xfsdump
with the \f3\-I\f1 option.
This includes the host name and the mount path.
.RE
.TP 5
.B \-C
With this option, 
.I xfsinvutil 
performs consistency checks for all entries in the inventory database.
It fixes any problems found. If no consistent entries are found , the
corresponding inventory database file is removed.
.TP 5
.B \-n
With this option, 
.I xfsinvutil 
will not ask any confirmation questions regarding sessions to prune.
(It is the "Nike" option).
.SH NOTES
.SS Inventory
Each dump session updates an inventory database in \f2/var/lib/xfsdump/inventory\f1.
.I xfsdump
uses the inventory to determine the base of incremental
and resumed dumps.
.P
This database can be displayed by invoking
.I xfsdump
with the
.B \-I
option.
The display uses tabbed indentation to present the inventory
hierarchically.
The first level is filesystem.
The second level is session.
The third level is media stream (currently only one stream is supported).
The fourth level lists the media files sequentially composing the stream.
.SH FILES
.TP 25
/var/lib/xfsdump/inventory
dump inventory database
.SH SEE ALSO
xfsdump(8),
xfsrestore(8).