vgcfgbackup(8)

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

NAME

6       vgcfgbackup - Backup volume group configuration(s)
7

SYNOPSIS

9       vgcfgbackup
10           [ option_args ]
11           [ position_args ]
12

DESCRIPTION

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
18       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
21       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
23       replaced by the VG name.
24
25       NB. This DOES NOT back up the data content of LVs.
26
27       It may also be useful to regularly back up the files in /etc/lvm.
28

USAGE

30       vgcfgbackup
31           [ -f|--file String ]
32           [    --foreign ]
33           [    --ignorelockingfailure ]
34           [    --readonly ]
35           [    --reportformat basic|json ]
36           [ COMMON_OPTIONS ]
37           [ VG ... ]
38
39       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

OPTIONS

56       --commandprofile String
57              The command profile to use for command configuration.  See
58              lvm.conf(5) for more information about profiles.
59
60       --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
66       -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
70       --driverloaded y|n
71              If set to no, the command will not attempt to use device-mapper.
72              For testing and debugging.
73
74       -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
77              replaced by the VG name.
78
79       --foreign
80              Report/display foreign VGs that would otherwise be skipped.  See
81              lvmsystemid(7) for more information about foreign VGs.
82
83       -h|--help
84              Display help text.
85
86       --ignorelockingfailure
87              Allows a command to continue with read-only metadata operations
88              after locking failures.
89
90       --lockopt String
91              Used to pass options for special cases to lvmlockd.  See lvm‐
92              lockd(8) for more information.
93
94       --longhelp
95              Display long help text.
96
97       --nolocking
98              Disable locking.
99
100       --profile String
101              An alias for --commandprofile or --metadataprofile, depending on
102              the command.
103
104       -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
109       --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
117       --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
125       -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
129              unusual error messages in multi-stage operations if a tool
130              relies on reading back metadata it believes has changed but
131              hasn't.
132
133       -v|--verbose ...
134              Set verbose level. Repeat from 1 to 4 times to increase the
135              detail of messages sent to stdout and stderr.
136
137       --version
138              Display version information.
139
140       -y|--yes
141              Do not prompt for confirmation interactively but always assume
142              the answer yes. Use with extreme caution.  (For automatic no,
143              see -qq.)
144

VARIABLES

146       VG
147              Volume Group name.  See lvm(8) for valid names.
148
149       String
150              See the option description for information about the string con‐
151              tent.
152
153       Size[UNIT]
154              Size  is  an  input number that accepts an optional unit.  Input
155              units are always treated as base two values, regardless of capi‐
156              talization,  e.g.  'k'  and 'K' both refer to 1024.  The default
157              input unit is specified by letter, followed by |UNIT.  UNIT rep‐
158              resents  other  possible  input units: bBsSkKmMgGtTpPeE.  b|B is
159              bytes, s|S is sectors of 512 bytes, k|K  is  kilobytes,  m|M  is
160              megabytes, g|G is gigabytes, t|T is terabytes, p|P is petabytes,
161              e|E is exabytes.  (This should not be confused with  the  output
162              control --units, where capital letters mean multiple of 1000.)
163

ENVIRONMENT VARIABLES

165       See  lvm(8)  for  information  about environment variables used by lvm.
166       For example, LVM_VG_NAME can generally be substituted for a required VG
167       parameter.
168