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           [    --profile String ]
52           [    --version ]
53

OPTIONS

55       --commandprofile String
56              The command profile to use for command configuration.  See
57              lvm.conf(5) for more information about profiles.
58
59       --config String
60              Config settings for the command. These override lvm.conf set‐
61              tings.  The String arg uses the same format as lvm.conf, or may
62              use section/field syntax.  See lvm.conf(5) for more information
63              about config.
64
65       -d|--debug ...
66              Set debug level. Repeat from 1 to 6 times to increase the detail
67              of messages sent to the log file and/or syslog (if configured).
68
69       --driverloaded y|n
70              If set to no, the command will not attempt to use device-mapper.
71              For testing and debugging.
72
73       -f|--file String
74              Write the backup to the named file.  When backing up more than
75              one VG, the file name is treated as a template, and %s is
76              replaced by the VG name.
77
78       --foreign
79              Report/display foreign VGs that would otherwise be skipped.  See
80              lvmsystemid(7) for more information about foreign VGs.
81
82       -h|--help
83              Display help text.
84
85       --ignorelockingfailure
86              Allows a command to continue with read-only metadata operations
87              after locking failures.
88
89       --lockopt String
90              Used to pass options for special cases to lvmlockd.  See lvm‐
91              lockd(8) for more information.
92
93       --longhelp
94              Display long help text.
95
96       --profile String
97              An alias for --commandprofile or --metadataprofile, depending on
98              the command.
99
100       -q|--quiet ...
101              Suppress output and log messages. Overrides --debug and --ver‐
102              bose.  Repeat once to also suppress any prompts with answer
103              'no'.
104
105       --readonly
106              Run the command in a special read-only mode which will read on-
107              disk metadata without needing to take any locks. This can be
108              used to peek inside metadata used by a virtual machine image
109              while the virtual machine is running.  It can also be used to
110              peek inside the metadata of clustered VGs when clustered locking
111              is not configured or running. No attempt will be made to commu‐
112              nicate with the device-mapper kernel driver, so this option is
113              unable to report whether or not LVs are actually in use.
114
115       --reportformat basic|json
116              Overrides current output format for reports which is defined
117              globally by the report/output_format setting in lvm.conf.  basic
118              is the original format with columns and rows.  If there is more
119              than one report per command, each report is prefixed with the
120              report name for identification. json produces report output in
121              JSON format. See lvmreport(7) for more information.
122
123       -t|--test
124              Run in test mode. Commands will not update metadata.  This is
125              implemented by disabling all metadata writing but nevertheless
126              returning success to the calling function. This may lead to
127              unusual error messages in multi-stage operations if a tool
128              relies on reading back metadata it believes has changed but
129              hasn't.
130
131       -v|--verbose ...
132              Set verbose level. Repeat from 1 to 4 times to increase the
133              detail of messages sent to stdout and stderr.
134
135       --version
136              Display version information.
137
138       -y|--yes
139              Do not prompt for confirmation interactively but always assume
140              the answer yes. Use with extreme caution.  (For automatic no,
141              see -qq.)
142

VARIABLES

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

ENVIRONMENT VARIABLES

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