btrfs-image is used to create an image of a btrfs filesystem. All
data will be zeroed, but metadata and the like is preserved.
Mainly used for debugging purposes.
In the dump mode, source is the btrfs device/file and target is
the output file (use - for stdout).
In the restore mode (option -r), source is the dumped image and
target is the btrfs device/file.
Restore metadump image. By default, this fixes super’s chunk
tree, by using 1 stripe pointing to primary device, so that
file system can be restored by running tree log reply if
possible. To restore without changing number of stripes in
chunk tree check -o option.
Compression level (0 ~ 9).
Number of threads (1 ~ 32) to be used to process the image
dump or restore.
Use the old restore method, this does not fixup the chunk
tree so the restored file system will not be able to be
Sanitize the file names when generating the image. One -s
means just generate random garbage, which means that the
directory indexes won’t match up since the hashes won’t match
with the garbage filenames. Using -ss will calculate a
collision for the filename so that the hashes match, and if
it can’t calculate a collision then it will just generate
garbage. The collision calculator is very time and CPU
intensive so only use it if you are having problems with your
file system tree and need to have it mostly working.
Walk all the trees manually and copy any blocks that are
referenced. Use this option if your extent tree is corrupted
to make sure that all of the metadata is captured.
Restore for multiple devices, more than 1 device should be
This page is part of the btrfs-progs (btrfs filesystem tools)
project. Information about the project can be found at
If you have a bug report for this manual page, see
This page was obtained from the project's upstream Git repository
on 2023-12-22. (At that time, the date of the most recent commit
that was found in the repository was 2023-12-14.) If you
discover any rendering problems in this HTML version of the page,
or you believe there is a better or more up-to-date source for
the page, or you have corrections or improvements to the
information in this COLOPHON (which is not part of the original
manual page), send a mail to email@example.com
Btrfs v5.16.1 02/06/2022 BTRFS-IMAGE(8)