xfsinvutil - xfsdump inventory database checking and prun­
       ing utility


SYNOPSIS

       xfsinvutil [-F|-i] [-u UUID] [-M mount_point]
                  [-m media_label] mm/dd/yyyy
       xfsinvutil -i
       xfsinvutil -C


DESCRIPTION

       xfsdump   maintains   an   online   dump   inventory    in
       /var/lib/xfsdump/inventory.  The -I option of xfsdump dis­
       plays the inventory contents hierarchically.   The  levels
       of  the  hierarchy  are: filesystem, dump session, stream,
       and media file.

       Over time, this database may grow too large as xfsdump (8)
       and  xfsrestore(8)  do  not remove entries from the inven­
       tory. The database may also  develop  inconsistencies  for
       various  reasons  such  as  operator errors etc., that may
       cause xfsdump or xfsrestore to print error or warning mes­
       sages.

       xfsinvutil  is an utility to check this inventory database
       for consistency, to remove entries of dump sessions  which
       may  no longer be of relevance, and to browse the contents
       of the inventory.

       xfsinvutil may be used in three different modes.   In  the
       first   mode  xfsinvutil  steps  over  each  dump  session
       recorded in the inventory and prompts  for  a  yes  or  no
       response  to  whether  each session should be pruned.  The
       second is a batch mode  in  which  xfsinvutil  will  prune
       every  entry  matching  the  supplied criteria.  The third
       mode allows the user to browse the inventory in detail, to
       delete  or  undelete  records  at  will and also to import
       inventories from other hosts.

       The following command line options are available:

       -F   Don't prompt the operator.  When  xfsinvutil  encoun­
            ters  a  matching  dump session, xfsinvutil will nor­
            mally ask the operator for permission to  delete  the
            entry. With this option the deletion is performed, no
            questions asked.

       -i   Interactive mode.  Causes xfsinvutil to run in a mode
            that  will  allow the operator to browse the contents
            of the inventory. Please  refer  to  the  Interactive
            Mode section below for more information.

            Specifies  the mount point and cut-off date of inven­
            tory 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 -n option is used; it will  be  assumed
            that the pruning is wanted.  xfsinvutil also performs
            consistency  checks  on  other   inventory   database
            entries when invoked with this option.

            The  mountpoint  must match the mount point as speci­
            fied in the inventory shown using xfsdump with the -I
            option.   This  includes  the host name and the mount
            path.

       -u UUID
            Specifies the filesystem universally  unique  identi­
            fier  (UUID)  of inventory entries to be selected for
            pruning.  This option is equivalent to the -M option.

       -m media_label
            If  specified,  only sessions with at least one media
            file whose label matches this value will be  eligible
            for  pruning.   This  restriction  is  in addition to
            those imposed by the date and the -M or  -u  options.
            This  option allows the pruning of all inventory ref­
            erences to media which may have been  overwritten  or
            lost.

       -n   With this option, xfsinvutil will not ask any confir­
            mation questions regarding sessions to prune.  (It is
            the "Nike" option).

       -C   With  this  option,  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.

   Interactive Mode
       When  run  with  -i,  xfsinvutil will present the operator
       with a hierarchical representation of the  xfsdump  inven­
       tory.   In  this mode, the operator can use the arrow keys
       (or the h j k l keys) to navigate the inventory  and  also
       use the following keys and functionality:

       +    Expand a branch of the tree.

       -    Collapse a branch of the tree.

       *    Fully expand a branch of the tree.


       h    Move selection to the parent entry.

       l    Move selection to the child entry.

       j    Move selection to next entry.

       k    Move selection to previous entry.

       d    Mark  the  current record, and all sub-records, to be
            deleted.

       u    Clear the current record and all parent records  from
            being deleted.

       i    Import another xfsdump inventory.

       ?    Show help window.

       x    Commit  any  changes  made to the inventory, and exit
            the program.

       q    Exit the program without committing  any  changes  to
            the inventory.

       Inventories  from  other hosts can be imported to create a
       larger common inventory.  It is recommended that the  con­
       tents  of /var/lib/xfsdump/inventory on the remote host be
       copied to a temporary local  directory  prior  to  running
       xfsinvutil.   When  xfsinvutil is run in interactive mode,
       and the operator hits i, they will  be  prompted  for  the
       path  to  the  inventory  to be imported.  xfsinvutil will
       then add the contents of the  imported  inventory  to  the
       main  window,  and all entries will be marked as imported.
       The operator can then delete any of these entries that are
       not  to  be  imported.   When  the  operator  commits  the
       changes, xfsinvutil will import any entries which were not
       marked  as  deleted.   Deleted  entries  are  not actually
       deleted from the original imported inventory.


NOTES

   Inventory
       Each  dump  session  updates  an  inventory  database   in
       /var/lib/xfsdump/inventory.  xfsdump uses the inventory to
       determine the base of incremental and resumed dumps.

       This database can be displayed by  invoking  xfsdump  with
       the  -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 com­
       posing the stream.

       /var/lib/xfsdump/inventory
                                dump inventory database


SEE ALSO

       xfsdump(8), xfsrestore(8).


Man(1) output converted with man2html