1VGCFGBACKUP(8) System Manager's Manual VGCFGBACKUP(8)
2
6 vgcfgbackup — Backup volume group configuration(s)
7
9 vgcfgbackup
10 [ option_args ]
11 [ position_args ]
12
14 vgcfgbackup creates back up files containing metadata of VGs. If no
15 VGs are named, back up files are created for all VGs. See vgcfgrestore
16 for information on using the back up files.
17 In a default installation, each VG is backed up into a separate file
19 bearing the name of the VG in the directory /etc/lvm/backup.
20 To use an alternative back up file, use -f. In this case, when backing
22 up multiple VGs, the file name is treated as a template, with %s re‐
23 placed by the VG name.
24 NB. This DOES NOT back up the data content of LVs.
26 It may also be useful to regularly back up the files in /etc/lvm.
28
30 vgcfgbackup
31 [ -f|--file String ]
32 [ --foreign ]
33 [ --ignorelockingfailure ]
34 [ --readonly ]
35 [ --reportformat basic|json|json_std ]
36 [ COMMON_OPTIONS ]
37 [ VG ... ]
38 Common options for lvm:
40 [ -d|--debug ]
41 [ -h|--help ]
42 [ -q|--quiet ]
43 [ -t|--test ]
44 [ -v|--verbose ]
45 [ -y|--yes ]
46 [ --commandprofile String ]
47 [ --config String ]
48 [ --devices PV ]
49 [ --devicesfile String ]
50 [ --driverloaded y|n ]
51 [ --journal String ]
52 [ --lockopt String ]
53 [ --longhelp ]
54 [ --nohints ]
55 [ --nolocking ]
56 [ --profile String ]
57 [ --version ]
58
60 --commandprofile String
61 The command profile to use for command configuration. See
62 lvm.conf(5) for more information about profiles.
63 --config String
65 Config settings for the command. These override lvm.conf(5) set‐
66 tings. The String arg uses the same format as lvm.conf(5), or
67 may use section/field syntax. See lvm.conf(5) for more informa‐
68 tion about config.
69 -d|--debug ...
71 Set debug level. Repeat from 1 to 6 times to increase the detail
72 of messages sent to the log file and/or syslog (if configured).
73 --devices PV
75 Restricts the devices that are visible and accessible to the
76 command. Devices not listed will appear to be missing. This op‐
77 tion can be repeated, or accepts a comma separated list of de‐
78 vices. This overrides the devices file.
79 --devicesfile String
81 A file listing devices that LVM should use. The file must exist
82 in /etc/lvm/devices/ and is managed with the lvmdevices(8) com‐
83 mand. This overrides the lvm.conf(5) devices/devicesfile and
84 devices/use_devicesfile settings.
85 --driverloaded y|n
87 If set to no, the command will not attempt to use device-mapper.
88 For testing and debugging.
89 -f|--file String
91 Write the backup to the named file. When backing up more than
92 one VG, the file name is treated as a template, and %s is re‐
93 placed by the VG name.
94 --foreign
96 Report/display foreign VGs that would otherwise be skipped. See
97 lvmsystemid(7) for more information about foreign VGs.
98 -h|--help
100 Display help text.
101 --ignorelockingfailure
103 Allows a command to continue with read-only metadata operations
104 after locking failures.
105 --journal String
107 Record information in the systemd journal. This information is
108 in addition to information enabled by the lvm.conf log/journal
109 setting. command: record information about the command. out‐
110 put: record the default command output. debug: record full com‐
111 mand debugging.
112 --lockopt String
114 Used to pass options for special cases to lvmlockd. See lvm‐
115 lockd(8) for more information.
116 --longhelp
118 Display long help text.
119 --nohints
121 Do not use the hints file to locate devices for PVs. A command
122 may read more devices to find PVs when hints are not used. The
123 command will still perform standard hint file invalidation where
124 appropriate.
125 --nolocking
127 Disable locking. Use with caution, concurrent commands may pro‐
128 duce incorrect results.
129 --profile String
131 An alias for --commandprofile or --metadataprofile, depending on
132 the command.
133 -q|--quiet ...
135 Suppress output and log messages. Overrides --debug and --ver‐
136 bose. Repeat once to also suppress any prompts with answer
137 'no'.
138 --readonly
140 Run the command in a special read-only mode which will read on-
141 disk metadata without needing to take any locks. This can be
142 used to peek inside metadata used by a virtual machine image
143 while the virtual machine is running. No attempt will be made to
144 communicate with the device-mapper kernel driver, so this option
145 is unable to report whether or not LVs are actually in use.
146 --reportformat basic|json|json_std
148 Overrides current output format for reports which is defined
149 globally by the report/output_format setting in lvm.conf(5).
150 basic is the original format with columns and rows. If there is
151 more than one report per command, each report is prefixed with
152 the report name for identification. json produces report output
153 in JSON format. json_std produces report output in JSON format
154 which is more compliant with JSON standard. See lvmreport(7)
155 for more information.
156 -t|--test
158 Run in test mode. Commands will not update metadata. This is
159 implemented by disabling all metadata writing but nevertheless
160 returning success to the calling function. This may lead to un‐
161 usual error messages in multi-stage operations if a tool relies
162 on reading back metadata it believes has changed but hasn't.
163 -v|--verbose ...
165 Set verbose level. Repeat from 1 to 4 times to increase the de‐
166 tail of messages sent to stdout and stderr.
167 --version
169 Display version information.
170 -y|--yes
172 Do not prompt for confirmation interactively but always assume
173 the answer yes. Use with extreme caution. (For automatic no,
174 see -qq.)
175
177 VG Volume Group name. See lvm(8) for valid names.
178 String See the option description for information about the string con‐
180 tent.
181 Size[UNIT]
183 Size is an input number that accepts an optional unit. Input
184 units are always treated as base two values, regardless of capi‐
185 talization, e.g. 'k' and 'K' both refer to 1024. The default
186 input unit is specified by letter, followed by |UNIT. UNIT rep‐
187 resents other possible input units: b|B is bytes, s|S is sectors
188 of 512 bytes, k|K is KiB, m|M is MiB, g|G is GiB, t|T is TiB,
189 p|P is PiB, e|E is EiB. (This should not be confused with the
190 output control --units, where capital letters mean multiple of
191 1000.)
192
194 See lvm(8) for information about environment variables used by lvm.
195 For example, LVM_VG_NAME can generally be substituted for a required VG
196 parameter.
197
199 lvm(8), lvm.conf(5), lvmconfig(8), lvmdevices(8),
200 pvchange(8), pvck(8), pvcreate(8), pvdisplay(8), pvmove(8),
202 pvremove(8), pvresize(8), pvs(8), pvscan(8),
203 vgcfgbackup(8), vgcfgrestore(8), vgchange(8), vgck(8), vgcreate(8),
205 vgconvert(8), vgdisplay(8), vgexport(8), vgextend(8), vgimport(8),
206 vgimportclone(8), vgimportdevices(8), vgmerge(8), vgmknodes(8),
207 vgreduce(8), vgremove(8), vgrename(8), vgs(8), vgscan(8), vgsplit(8),
208 lvcreate(8), lvchange(8), lvconvert(8), lvdisplay(8), lvextend(8),
210 lvreduce(8), lvremove(8), lvrename(8), lvresize(8), lvs(8), lvscan(8),
211 lvm-fullreport(8), lvm-lvpoll(8), blkdeactivate(8), lvmdump(8),
213 dmeventd(8), lvmpolld(8), lvmlockd(8), lvmlockctl(8), cmirrord(8),
215 lvmdbusd(8), fsadm(8),
216 lvmsystemid(7), lvmreport(7), lvmraid(7), lvmthin(7), lvmcache(7)
218Red Hat, Inc. LVM TOOLS 2.03.18(2)-git (2022-11-10) VGCFGBACKUP(8)