VGCFGRESTORE

Section: Maintenance Commands (8)
Updated: LVM TOOLS 2.03.11(2) (2021-01-08)
Page Index

NAME

vgcfgrestore - Restore volume group configuration

SYNOPSIS

vgcfgrestore option_args position_args

[ option_args ]

[ position_args ]

DESCRIPTION

vgcfgrestore restores the metadata of a VG from a text back up file produced by vgcfgbackup. This writes VG metadata onto the devices specifed in back up file.

A back up file can be specified with --file. If no backup file is specified, the most recent one is used. Use --list for a list of the available back up and archive files of a VG.

WARNING: When a VG contains thin pools, changes to thin metadata cannot be reverted, and data loss may occur if thin metadata has changed. The force option is required to restore in this case.

USAGE

Restore VG metadata from last backup.

vgcfgrestore VG

: [ COMMON_OPTIONS ]

Restore VG metadata from specified file.

vgcfgrestore -f|--file String VG

: [ COMMON_OPTIONS ]

List all VG metadata backups.

vgcfgrestore -l|--list VG

: [ COMMON_OPTIONS ]

List one VG metadata backup file.

vgcfgrestore -l|--list -f|--file String

: [ COMMON_OPTIONS ]

: [ VG ]

Common options for command:

: [ -M|--metadatatype lvm2 ]
[ --force ]

Common options for lvm:

: [ -d|--debug ]
[ -h|--help ]
[ -q|--quiet ]
[ -t|--test ]
[ -v|--verbose ]
[ -y|--yes ]
[ --commandprofile String ]
[ --config String ]
[ --driverloaded y|n ]
[ --lockopt String ]
[ --longhelp ]
[ --nolocking ]
[ --profile String ]
[ --version ]

OPTIONS

--commandprofile String: The command profile to use for command configuration. See lvm.conf(5) for more information about profiles.
--config String: Config settings for the command. These override lvm.conf settings. The String arg uses the same format as lvm.conf, or may use section/field syntax. See lvm.conf(5) for more information about config.
-d|--debug ...: Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured).
--driverloaded y|n: If set to no, the command will not attempt to use device-mapper. For testing and debugging.
-f|--file String: Read metadata backup from the named file. Usually this file was created by vgcfgbackup.
--force ...: Force metadata restore even with thin pool LVs. Use with extreme caution. Most changes to thin metadata cannot be reverted. You may lose data if you restore metadata that does not match the thin pool kernel metadata precisely.
-h|--help: Display help text.
-l|--list: List metadata backup and archive files pertaining to the VG. May be used with --file. Does not restore the VG.
--lockopt String: Used to pass options for special cases to lvmlockd. See lvmlockd(8) for more information.
--longhelp: Display long help text.
-M|--metadatatype lvm2: Specifies the type of on-disk metadata to use. lvm2 (or just 2) is the current, standard format. lvm1 (or just 1) is no longer used.
--nolocking: Disable locking.
--profile String: An alias for --commandprofile or --metadataprofile, depending on the command.
-q|--quiet ...: Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'.
-t|--test: Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't.
-v|--verbose ...: Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr.
--version: Display version information.
-y|--yes: Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.)

VARIABLES

VG: Volume Group name. See lvm(8) for valid names.
String: See the option description for information about the string content.
Size[UNIT]: Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. UNIT represents other possible input units: bBsSkKmMgGtTpPeE. b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.)

ENVIRONMENT VARIABLES

See lvm(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter.

NOTES

To replace PVs, vgdisplay --partial --verbose will show the UUIDs and sizes of any PVs that are no longer present. If a PV in the VG is lost and you wish to substitute another of the same size, use pvcreate --restorefile filename --uuid uuid (plus additional arguments as appropriate) to initialise it with the same UUID as the missing PV. Repeat for all other missing PVs in the VG. Then use vgcfgrestore --file filename to restore the VG's metadata.