vgcfgrestore(8)

1VGCFGRESTORE(8)             System Manager's Manual            VGCFGRESTORE(8)
2
3
4

NAME

6       vgcfgrestore - Restore volume group configuration
7

SYNOPSIS

9       vgcfgrestore option_args position_args
10           [ option_args ]
11           [ position_args ]
12
13           --commandprofile String
14           --config String
15        -d|--debug
16           --driverloaded y|n
17        -f|--file String
18           --force
19        -h|--help
20        -l|--list
21           --lockopt String
22           --longhelp
23        -M|--metadatatype lvm2
24           --nolocking
25           --profile String
26        -q|--quiet
27        -t|--test
28        -v|--verbose
29           --version
30        -y|--yes
31

DESCRIPTION

33       vgcfgrestore  restores  the  metadata  of a VG from a text back up file
34       produced by vgcfgbackup. This  writes  VG  metadata  onto  the  devices
35       specifed in back up file.
36
37       A  back  up  file  can  be specified with --file.  If no backup file is
38       specified, the most recent one is used. Use --list for a  list  of  the
39       available back up and archive files of a VG.
40
41       WARNING: When a VG contains thin pools, changes to thin metadata cannot
42       be reverted, and data loss may occur if thin metadata has changed.  The
43       force option is required to restore in this case.
44

USAGE

46       Restore VG metadata from last backup.
47
48       vgcfgrestore VG
49           [ COMMON_OPTIONS ]
50       -
51
52       Restore VG metadata from specified file.
53
54       vgcfgrestore -f|--file String VG
55           [ COMMON_OPTIONS ]
56       -
57
58       List all VG metadata backups.
59
60       vgcfgrestore -l|--list VG
61           [ COMMON_OPTIONS ]
62       -
63
64       List one VG metadata backup file.
65
66       vgcfgrestore -l|--list -f|--file String
67           [ COMMON_OPTIONS ]
68           [ VG ]
69       -
70
71       Common options for command:
72           [ -M|--metadatatype lvm2 ]
73           [    --force ]
74
75       Common options for lvm:
76           [ -d|--debug ]
77           [ -h|--help ]
78           [ -q|--quiet ]
79           [ -t|--test ]
80           [ -v|--verbose ]
81           [ -y|--yes ]
82           [    --commandprofile String ]
83           [    --config String ]
84           [    --driverloaded y|n ]
85           [    --lockopt String ]
86           [    --longhelp ]
87           [    --nolocking ]
88           [    --profile String ]
89           [    --version ]
90

OPTIONS

92       --commandprofile String
93              The command profile to use for command configuration.  See
94              lvm.conf(5) for more information about profiles.
95
96       --config String
97              Config settings for the command. These override lvm.conf set‐
98              tings.  The String arg uses the same format as lvm.conf, or may
99              use section/field syntax.  See lvm.conf(5) for more information
100              about config.
101
102       -d|--debug ...
103              Set debug level. Repeat from 1 to 6 times to increase the detail
104              of messages sent to the log file and/or syslog (if configured).
105
106       --driverloaded y|n
107              If set to no, the command will not attempt to use device-mapper.
108              For testing and debugging.
109
110       -f|--file String
111              Read metadata backup from the named file.  Usually this file was
112              created by vgcfgbackup.
113
114       --force ...
115              Force metadata restore even with thin pool LVs.  Use with ex‐
116              treme caution. Most changes to thin metadata cannot be reverted.
117              You may lose data if you restore metadata that does not match
118              the thin pool kernel metadata precisely.
119
120       -h|--help
121              Display help text.
122
123       -l|--list
124              List metadata backup and archive files pertaining to the VG.
125              May be used with --file. Does not restore the VG.
126
127       --lockopt String
128              Used to pass options for special cases to lvmlockd.  See lvm‐
129              lockd(8) for more information.
130
131       --longhelp
132              Display long help text.
133
134       -M|--metadatatype lvm2
135              Specifies the type of on-disk metadata to use.  lvm2 (or just 2)
136              is the current, standard format.  lvm1 (or just 1) is no longer
137              used.
138
139       --nolocking
140              Disable locking.
141
142       --profile String
143              An alias for --commandprofile or --metadataprofile, depending on
144              the command.
145
146       -q|--quiet ...
147              Suppress output and log messages. Overrides --debug and --ver‐
148              bose.  Repeat once to also suppress any prompts with answer
149              'no'.
150
151       -t|--test
152              Run in test mode. Commands will not update metadata.  This is
153              implemented by disabling all metadata writing but nevertheless
154              returning success to the calling function. This may lead to un‐
155              usual error messages in multi-stage operations if a tool relies
156              on reading back metadata it believes has changed but hasn't.
157
158       -v|--verbose ...
159              Set verbose level. Repeat from 1 to 4 times to increase the de‐
160              tail of messages sent to stdout and stderr.
161
162       --version
163              Display version information.
164
165       -y|--yes
166              Do not prompt for confirmation interactively but always assume
167              the answer yes. Use with extreme caution.  (For automatic no,
168              see -qq.)
169

VARIABLES

171       VG
172              Volume Group name.  See lvm(8) for valid names.
173
174       String
175              See the option description for information about the string con‐
176              tent.
177
178       Size[UNIT]
179              Size is an input number that accepts an  optional  unit.   Input
180              units are always treated as base two values, regardless of capi‐
181              talization, e.g. 'k' and 'K' both refer to  1024.   The  default
182              input unit is specified by letter, followed by |UNIT.  UNIT rep‐
183              resents other possible input units:  bBsSkKmMgGtTpPeE.   b|B  is
184              bytes,  s|S is sectors of 512 bytes, k|K is KiB, m|M is MiB, g|G
185              is GiB, t|T is TiB, p|P is PiB, e|E is EiB.  (This should not be
186              confused  with the output control --units, where capital letters
187              mean multiple of 1000.)
188

ENVIRONMENT VARIABLES

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

NOTES

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