xfs_metadump.8   xfs_metadump.8 
xfs_metadump(8) xfs_metadump (8) xfs_metadump(8) xfs_metadump (8)
NAME NAME
xfs_metadump - copy XFS filesystem metadata to a file xfs_metadump - copy XFS filesystem metadata to a file
SYNOPSIS SYNOPSIS
xfs_metadump [ -efgow ] [ -l logdev ] source target xfs_metadump [ -efgow ] [ -m max_extents ] ] [ -l logdev ] source t
ar‐
get
xfs_metadump -V
DESCRIPTION DESCRIPTION
xfs_metadump is a debugging tool that copies the metadata from an xfs_metadump is a debugging tool that copies the metadata from an
XFS XFS
filesystem to a file. The source argument must be the pathname of filesystem to a file. The source argument must be the pathname of
the the
device or file containing the XFS filesystem and the target argum device or file containing the XFS filesystem and the target argum
ent ent
specifies the destination file name. If target is -, then the out specifies the destination file name. If target is -, then the out
put put
is sent to stdout. This allows the output to be redirected to anot is sent to stdout. This allows the output to be redirected to anot
her her
program such as a compression application. program such as a compression application.
xfs_metadump should only be used to copy unmounted filesystems, re xfs_metadump should only be used to copy unmounted filesystems, re
ad- ad-
only mounted filesystems, or frozen filesystems (see xfs_freeze(8 only mounted filesystems, or frozen filesystems (see xfs_freeze(8
)). )).
Otherwise, the generated dump could be inconsistent or corrupt. Otherwise, the generated dump could be inconsistent or corrupt.
xfs_metadump does not alter the source filesystem in any way. The t ar‐ xfs_metadump does not alter the source filesystem in any way. The t ar‐
get image is a contiguous (non-sparse) file containing all the files ys‐ get image is a contiguous (non-sparse) file containing all the files ys‐
tem's metadata and indexes to where the blocks were copied from. tem's metadata and indexes to where the blocks were copied from.
By default, xfs_metadump obfuscates most file (regular file, direct By default, xfs_metadump obfuscates most file (regular file, direct
ory ory
and symbolic link) names and extended attribute names to allow and symbolic link) names and extended attribute names to allow
the the
dumps to be sent without revealing confidential information. Exten dumps to be sent without revealing confidential information. Exten
ded ded
attribute values are zeroed and no data is copied. The only excepti attribute values are zeroed and no data is copied. The only excepti
ons ons
are file or attribute names that are 4 or less characters in leng are file or attribute names that are 4 or less characters in leng
th. th.
Also file names that span extents (this can only occur with Also file names that span extents (this can only occur with
the the
mkfs.xfs(8) options where -n size > -b size) are not obfuscated. Na mkfs.xfs(8) options where -n size > -b size) are not obfuscated. Na
mes mes
between 5 and 8 characters in length inclusively are partially obf between 5 and 8 characters in length inclusively are partially obf
us‐ us‐
cated. cated.
xfs_metadump should not be used for any purposes other than for deb xfs_metadump should not be used for any purposes other than for deb
ug‐ ug‐
ging and reporting filesystem problems. The most common usage scena ging and reporting filesystem problems. The most common usage scena
rio rio
for this tool is when xfs_repair(8) fails to repair a filesystem and for this tool is when xfs_repair(8) fails to repair a filesystem an
a d a
metadump image can be sent for analysis. metadump image can be sent for analysis.
The file generated by xfs_metadump can be restored to filesystem im age The file generated by xfs_metadump can be restored to filesystem im age
(minus the data) using the xfs_mdrestore(8) tool. (minus the data) using the xfs_mdrestore(8) tool.
OPTIONS OPTIONS
-e Stops the dump on a read error. Normally, it will ignore r ead -e Stops the dump on a read error. Normally, it will ignore r ead
errors and copy all the metadata that is accessible. errors and copy all the metadata that is accessible.
-f Specifies that the filesystem image to be processed is stored in -f Specifies that the filesystem image to be processed is stored in
a regular file (see the mkfs.xfs -d file option). This can a a regular file (see the mkfs.xfs -d file option). This can a
lso lso
happen if an image copy of a filesystem has been made into happen if an image copy of a filesystem has been made into
an an
ordinary file with xfs_copy(8). ordinary file with xfs_copy(8).
-g Shows dump progress. This is sent to stdout if the target is a -g Shows dump progress. This is sent to stdout if the target i s a
file or to stderr if the target is stdout. file or to stderr if the target is stdout.
-l logdev -l logdev
For filesystems which use an external log, this specifies For filesystems which use an external log, this specifies
the the
device where the external log resides. The external log is device where the external log resides. The external log is
not not
copied, only internal logs are copied. copied, only internal logs are copied.
-m Set the maximum size of an allowed metadata extent. Extrem
ely
large metadata extents are likely to be corrupt, and will
be
skipped if they exceed this value. The default size is 1
000
blocks.
-o Disables obfuscation of file names and extended attributes. -o Disables obfuscation of file names and extended attributes.
-w Prints warnings of inconsistent metadata encountered to stde rr. -w Prints warnings of inconsistent metadata encountered to stde rr.
Bad metadata is still copied. Bad metadata is still copied.
-V Prints the version number and exits.
DIAGNOSTICS DIAGNOSTICS
xfs_metadump returns an exit code of 0 if all readable metadata is s uc‐ xfs_metadump returns an exit code of 0 if all readable metadata is s uc‐
cessfully copied or 1 if a write error occurs or a read error occ urs cessfully copied or 1 if a write error occurs or a read error occ urs
and the -e option used. and the -e option used.
NOTES NOTES
As xfs_metadump copies metadata only, it does not matter if the sou rce As xfs_metadump copies metadata only, it does not matter if the sou rce
filesystem has a realtime section or not. If the filesystem has an filesystem has a realtime section or not. If the filesystem has an
external log, it is not copied. Internal logs are copied and any o ut‐ external log, it is not copied. Internal logs are copied and any o ut‐
standing log transactions are not obfuscated if they contain names. standing log transactions are not obfuscated if they contain names.
 End of changes. 13 change blocks. 
49 lines changed or deleted 62 lines changed or added

This html diff was produced by rfcdiff 1.41. The latest version is available from http://tools.ietf.org/tools/rfcdiff/