thin-provisioning-tools/man8/cache_dump.8
2017-09-18 16:10:56 +01:00

65 lines
1.4 KiB
Groff

.TH CACHE_DUMP 8 "Thin Provisioning Tools" "Red Hat, Inc." \" -*- nroff -*-
.SH NAME
cache_dump \- dump cache metadata from device or file to standard output
.SH SYNOPSIS
.B cache_dump
.RB [options]
.I {device|file}
.SH DESCRIPTION
.B cache_dump
dumps binary cache metadata created by
the device-mapper cache target on a
.I device
or
.I file
to standard output for
analysis or postprocessing in XML format.
XML formated metadata can be fed into cache_restore (see
.BR cache_restore(8) )
in order to put it back onto a metadata
.I device
(to process by the device-mapper target) or
.I file.
This tool cannot be run on live metadata.
.IP "\fB\-r, \-\-repair\fP".
Repair the metadata whilst dumping it.
.IP "\fB\-h, \-\-help\fP".
Print help and exit.
.IP "\fB-o \<xml file\>\fP".
Specify an output file for the xml, rather than printing to stdout.
.IP "\fB\-V, \-\-version\fP".
Output version information and exit.
.SH EXAMPLES
Dumps the cache metadata on logical volume /dev/vg/metadata
to standard output in XML format:
.sp
.B cache_dump /dev/vg/metadata
.SH EXAMPLES
Dumps the cache metadata on logical volume /dev/vg/metadata
whilst repairing it to standard output in XML format:
.sp
.B cache_dump --repair /dev/vg/metadata
.SH DIAGNOSTICS
.B cache_dump
returns an exit code of 0 for success or 1 for error.
.SH SEE ALSO
.B cache_check(8)
.B cache_repair(8)
.B cache_restore(8)
.SH AUTHOR
Joe Thornber <ejt@redhat.com>
.br
Heinz Mauelshagen <HeinzM@RedHat.com>