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|lvm1
24           --profile String
25        -q|--quiet
26        -t|--test
27        -v|--verbose
28           --version
29        -y|--yes
30

DESCRIPTION

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

USAGE

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

OPTIONS

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

VARIABLES

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

ENVIRONMENT VARIABLES

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

NOTES

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