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
116              extreme caution. Most changes to thin metadata cannot be
117              reverted.  You may lose data if you restore metadata that does
118              not match 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
155              unusual error messages in multi-stage operations if a tool
156              relies on reading back metadata it believes has changed but
157              hasn't.
158
159       -v|--verbose ...
160              Set verbose level. Repeat from 1 to 4 times to increase the
161              detail of messages sent to stdout and stderr.
162
163       --version
164              Display version information.
165
166       -y|--yes
167              Do not prompt for confirmation interactively but always assume
168              the answer yes. Use with extreme caution.  (For automatic no,
169              see -qq.)
170

VARIABLES

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

ENVIRONMENT VARIABLES

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

NOTES

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