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 ]
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 [ --driverloaded y|n ]
49 [ --lockopt String ]
50 [ --longhelp ]
51 [ --nolocking ]
52 [ --profile String ]
53 [ --version ]
54
56 --commandprofile String
57 The command profile to use for command configuration. See
58 lvm.conf(5) for more information about profiles.
59 --config String
61 Config settings for the command. These override lvm.conf set‐
62 tings. The String arg uses the same format as lvm.conf, or may
63 use section/field syntax. See lvm.conf(5) for more information
64 about config.
65 -d|--debug ...
67 Set debug level. Repeat from 1 to 6 times to increase the detail
68 of messages sent to the log file and/or syslog (if configured).
69 --driverloaded y|n
71 If set to no, the command will not attempt to use device-mapper.
72 For testing and debugging.
73 -f|--file String
75 Write the backup to the named file. When backing up more than
76 one VG, the file name is treated as a template, and %s is re‐
77 placed by the VG name.
78 --foreign
80 Report/display foreign VGs that would otherwise be skipped. See
81 lvmsystemid(7) for more information about foreign VGs.
82 -h|--help
84 Display help text.
85 --ignorelockingfailure
87 Allows a command to continue with read-only metadata operations
88 after locking failures.
89 --lockopt String
91 Used to pass options for special cases to lvmlockd. See lvm‐
92 lockd(8) for more information.
93 --longhelp
95 Display long help text.
96 --nolocking
98 Disable locking.
99 --profile String
101 An alias for --commandprofile or --metadataprofile, depending on
102 the command.
103 -q|--quiet ...
105 Suppress output and log messages. Overrides --debug and --ver‐
106 bose. Repeat once to also suppress any prompts with answer
107 'no'.
108 --readonly
110 Run the command in a special read-only mode which will read on-
111 disk metadata without needing to take any locks. This can be
112 used to peek inside metadata used by a virtual machine image
113 while the virtual machine is running. No attempt will be made to
114 communicate with the device-mapper kernel driver, so this option
115 is unable to report whether or not LVs are actually in use.
116 --reportformat basic|json
118 Overrides current output format for reports which is defined
119 globally by the report/output_format setting in lvm.conf. basic
120 is the original format with columns and rows. If there is more
121 than one report per command, each report is prefixed with the
122 report name for identification. json produces report output in
123 JSON format. See lvmreport(7) for more information.
124 -t|--test
126 Run in test mode. Commands will not update metadata. This is
127 implemented by disabling all metadata writing but nevertheless
128 returning success to the calling function. This may lead to un‐
129 usual error messages in multi-stage operations if a tool relies
130 on reading back metadata it believes has changed but hasn't.
131 -v|--verbose ...
133 Set verbose level. Repeat from 1 to 4 times to increase the de‐
134 tail of messages sent to stdout and stderr.
135 --version
137 Display version information.
138 -y|--yes
140 Do not prompt for confirmation interactively but always assume
141 the answer yes. Use with extreme caution. (For automatic no,
142 see -qq.)
143
145 VG
146 Volume Group name. See lvm(8) for valid names.
147 String
149 See the option description for information about the string con‐
150 tent.
151 Size[UNIT]
153 Size is an input number that accepts an optional unit. Input
154 units are always treated as base two values, regardless of capi‐
155 talization, e.g. 'k' and 'K' both refer to 1024. The default
156 input unit is specified by letter, followed by |UNIT. UNIT rep‐
157 resents other possible input units: bBsSkKmMgGtTpPeE. b|B is
158 bytes, s|S is sectors of 512 bytes, k|K is KiB, m|M is MiB, g|G
159 is GiB, t|T is TiB, p|P is PiB, e|E is EiB. (This should not be
160 confused with the output control --units, where capital letters
161 mean multiple of 1000.)
162
164 See lvm(8) for information about environment variables used by lvm.
165 For example, LVM_VG_NAME can generally be substituted for a required VG
166 parameter.
167
169 lvm(8) lvm.conf(5) lvmconfig(8)
170 pvchange(8) pvck(8) pvcreate(8) pvdisplay(8) pvmove(8) pvremove(8)
172 pvresize(8) pvs(8) pvscan(8)
173 vgcfgbackup(8) vgcfgrestore(8) vgchange(8) vgck(8) vgcreate(8) vgcon‐
175 vert(8) vgdisplay(8) vgexport(8) vgextend(8) vgimport(8) vgimport‐
176 clone(8) vgmerge(8) vgmknodes(8) vgreduce(8) vgremove(8) vgrename(8)
177 vgs(8) vgscan(8) vgsplit(8)
178 lvcreate(8) lvchange(8) lvconvert(8) lvdisplay(8) lvextend(8) lvre‐
180 duce(8) lvremove(8) lvrename(8) lvresize(8) lvs(8) lvscan(8)
181 lvm-fullreport(8) lvm-lvpoll(8) lvm2-activation-generator(8) blkdeacti‐
183 vate(8) lvmdump(8)
184 dmeventd(8) lvmpolld(8) lvmlockd(8) lvmlockctl(8) cmirrord(8) lvmd‐
186 busd(8)
187 lvmsystemid(7) lvmreport(7) lvmraid(7) lvmthin(7) lvmcache(7)
189Red Hat, Inc. LVM TOOLS 2.03.11(2) (2021-01-08) VGCFGBACKUP(8)