1xfsinvutil(8)               System Manager's Manual              xfsinvutil(8)
2
3
4

NAME

6       xfsinvutil - xfsdump inventory database checking and pruning utility
7

SYNOPSIS

9       xfsinvutil [-F|-i] [-u UUID] [-M mount_point]
10                  [-m media_label] mm/dd/yyyy
11       xfsinvutil -i
12       xfsinvutil -C
13

DESCRIPTION

15       xfsdump  maintains  an online dump inventory in /var/lib/xfsdump/inven‐
16       tory.  The -I option of xfsdump displays the inventory contents hierar‐
17       chically.   The  levels of the hierarchy are: filesystem, dump session,
18       stream, and media file.
19
20       Over time, this database may grow too large as xfsdump (8)  and  xfsre‐
21       store(8)  do  not  remove  entries from the inventory. The database may
22       also develop inconsistencies  for  various  reasons  such  as  operator
23       errors  etc.,  that  may  cause xfsdump or xfsrestore to print error or
24       warning messages.
25
26       xfsinvutil is an utility to check this inventory database  for  consis‐
27       tency,  to  remove  entries  of dump sessions which may no longer be of
28       relevance, and to browse the contents of the inventory.
29
30       xfsinvutil may be used in three different modes.   In  the  first  mode
31       xfsinvutil  steps  over each dump session recorded in the inventory and
32       prompts for a yes or no response to  whether  each  session  should  be
33       pruned.   The  second  is  a  batch mode in which xfsinvutil will prune
34       every entry matching the supplied criteria.  The third mode allows  the
35       user  to  browse the inventory in detail, to delete or undelete records
36       at will and also to import inventories from other hosts.
37
38       The following command line options are available:
39
40       -F   Don't prompt the operator.  When xfsinvutil encounters a  matching
41            dump  session,  xfsinvutil will normally ask the operator for per‐
42            mission to delete the entry. With this option the deletion is per‐
43            formed, no questions asked.
44
45       -i   Interactive  mode.   Causes  xfsinvutil to run in a mode that will
46            allow the operator to browse the contents of the inventory. Please
47            refer to the Interactive Mode section below for more information.
48
49       -M mount_point mm/dd/yyyy
50            Specifies the mount point and cut-off date of inventory entries to
51            be selected for pruning.  xfsinvutil prompts the operator  when  a
52            dump session in the inventory is identified by the mount point and
53            was created prior to the specified date.  The  operator  can  then
54            select specific dump sessions for removal from the inventory data‐
55            base.  This prompt will not happen if the -n option  is  used;  it
56            will  be assumed that the pruning is wanted.  xfsinvutil also per‐
57            forms consistency checks on other inventory database entries  when
58            invoked with this option.
59
60            The  mountpoint  must  match  the  mount point as specified in the
61            inventory shown using xfsdump with the -I option.   This  includes
62            the host name and the mount path.
63
64       -u UUID
65            Specifies  the  filesystem universally unique identifier (UUID) of
66            inventory entries to be selected  for  pruning.   This  option  is
67            equivalent to the -M option.
68
69       -m media_label
70            If  specified,  only  sessions  with at least one media file whose
71            label matches this value  will  be  eligible  for  pruning.   This
72            restriction is in addition to those imposed by the date and the -M
73            or -u options.  This option allows the pruning  of  all  inventory
74            references to media which may have been overwritten or lost.
75
76       -n   With  this  option, xfsinvutil will not ask any confirmation ques‐
77            tions regarding sessions to prune.  (It is the "Nike" option).
78
79       -C   With this option, xfsinvutil performs consistency checks  for  all
80            entries  in  the inventory database.  It fixes any problems found.
81            If no consistent entries are found , the  corresponding  inventory
82            database file is removed.
83
84   Interactive Mode
85       When  run  with -i, xfsinvutil will present the operator with a hierar‐
86       chical representation of the xfsdump  inventory.   In  this  mode,  the
87       operator  can  use the arrow keys (or the h j k l keys) to navigate the
88       inventory and also use the following keys and functionality:
89
90       +    Expand a branch of the tree.
91
92       -    Collapse a branch of the tree.
93
94       *    Fully expand a branch of the tree.
95
96       %    Fully collapse a branch of the tree.
97
98       h    Move selection to the parent entry.
99
100       l    Move selection to the child entry.
101
102       j    Move selection to next entry.
103
104       k    Move selection to previous entry.
105
106       d    Mark the current record, and all sub-records, to be deleted.
107
108       u    Clear the  current  record  and  all  parent  records  from  being
109            deleted.
110
111       i    Import another xfsdump inventory.
112
113       ?    Show help window.
114
115       x    Commit any changes made to the inventory, and exit the program.
116
117       q    Exit the program without committing any changes to the inventory.
118
119       Inventories  from other hosts can be imported to create a larger common
120       inventory.  It  is  recommended  that  the  contents  of  /var/lib/xfs‐
121       dump/inventory on the remote host be copied to a temporary local direc‐
122       tory prior to running xfsinvutil.  When xfsinvutil is run  in  interac‐
123       tive  mode, and the operator hits i, they will be prompted for the path
124       to the inventory to be imported.  xfsinvutil will then add the contents
125       of  the  imported inventory to the main window, and all entries will be
126       marked as imported.  The operator can then delete any of these  entries
127       that  are  not  to be imported.  When the operator commits the changes,
128       xfsinvutil will import any entries which were not  marked  as  deleted.
129       Deleted  entries  are  not  actually deleted from the original imported
130       inventory.
131

NOTES

133   Inventory
134       Each dump  session  updates  an  inventory  database  in  /var/lib/xfs‐
135       dump/inventory.   xfsdump  uses  the inventory to determine the base of
136       incremental and resumed dumps.
137
138       This database can be displayed by invoking xfsdump with the -I  option.
139       The display uses tabbed indentation to present the inventory hierarchi‐
140       cally.  The first level is filesystem.  The second  level  is  session.
141       The  third  level  is  media  stream (currently only one stream is sup‐
142       ported).  The fourth level lists the media files sequentially composing
143       the stream.
144

FILES

146       /var/lib/xfsdump/inventory
147                                dump inventory database
148

SEE ALSO

150       xfsdump(8), xfsrestore(8).
151
152
153
154                                                                 xfsinvutil(8)
Impressum