cache_restore(8)

cache_restore8

Restore cache metadata file to device or file.

Usage

cache_restore [options] -i xml file -o {device | file}

Overview

cache_restore restores cache metadata created by the respective device-mapper target dumped into an XML formatted (see cache_dump(8)) file, which optionally can be preprocessed before the restore to another device or file. If restored to a metadata device, the metadata can be processed by the device-mapper target.

This tool cannot be run on live metadata.

Options

-h, --help

Print help and exit.

-V, --version

Print version information and exit.

-q, --quiet

Don't print any output. Check the exit code to test for success.

-i, --input {xml file}

Input xml.

-o, --output {device|file}

Output file or device for restored binary metadata.

    If a file is used thin it must be preallocated, and large enough to hold
    the metadata.
--metadata-version {1|2}

Choose a metadata version.

Options

--debug-override-metadata-version {integer}

Override the version stored in the metadata.

--omit-clean-shutdown

Don't set the clean shutdown flag.

Examples

Restores the XML formatted cache metadata on file metadata to logical volume /dev/vg/metadata for further processing by the respective device-mapper target:

    $ cache_restore -i metadata -o /dev/vg/metadata

Diagnostics

cache_restore returns an exit code of 0 for success or 1 for error.

Releases

7 releases since Debian 8 (Jessie); the text changed 4 times.

  1. 8
  2. 9
  3. 10
  4. 11–12
  5. 13–Arch

--debug-override-metadata-version since Debian 10 (Buster); --metadata-version since Debian 10 (Buster); --omit-clean-shutdown since Debian 10 (Buster); --quiet since Debian 10 (Buster); -q since Debian 10 (Buster).

--input until Debian 9 (Stretch); -i until Debian 9 (Stretch).

Author

Joe Thornber <[email protected]>, Heinz Mauelshagen <[email protected]>

From thin-provisioning-tools 1.3.4-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.