# vgcfgbackup

## NAME



           vgcfgbackup — Backup volume group configuration(s)
    


## SYNOPSIS



           **vgcfgbackup**
               [ _option_args_ ]
               [ _position_args_ ]
    


## DESCRIPTION



           vgcfgbackup creates back up files containing metadata of VGs.  If
           no VGs are named, back up files are created for all VGs. See
           vgcfgrestore(8) for information on using the back up files.
    
           In a default installation, each VG is backed up into a separate
           file bearing the name of the VG in the directory _/etc/lvm/backup_.
    
           To use an alternative back up file, use **-f**. In this case, when
           backing up multiple VGs, the file name is treated as a template,
           with %s replaced by the VG name.
    
           NB. This DOES NOT back up the data content of LVs.
    
           It may also be useful to regularly back up the files in _/etc/lvm_.
    


## USAGE



           **vgcfgbackup**
               [ **-f** |**--file** _String_ ]
               [    **--foreign**]
               [    **--ignorelockingfailure**]
               [    **--readonly**]
               [    **--reportformat basic** |**json**]
               [ COMMON_OPTIONS ]
               [ _VG_ ... ]
    
           Common options for lvm:
               [ **-d** |**--debug**]
               [ **-h** |**--help**]
               [ **-q** |**--quiet**]
               [ **-t** |**--test**]
               [ **-v** |**--verbose**]
               [ **-y** |**--yes**]
               [    **--commandprofile** _String_ ]
               [    **--config** _String_ ]
               [    **--devices** _PV_ ]
               [    **--devicesfile** _String_ ]
               [    **--driverloaded y** |**n**]
               [    **--journal** _String_ ]
               [    **--lockopt** _String_ ]
               [    **--longhelp**]
               [    **--nohints**]
               [    **--nolocking**]
               [    **--profile** _String_ ]
               [    **--version**]
    


## OPTIONS



    
           **--commandprofile** _String_
                  The  command profile to use for command configuration.  See
                  lvm.conf(5) for more information about profiles.
    
           **--config** _String_
                  Config settings for the command. These override lvm.conf(5)
                  settings.   The  String  arg  uses  the  same   format   as
                  lvm.conf(5),   or   may   use  section/field  syntax.   See
                  lvm.conf(5) for more information about config.
    
           **-d** |**--debug**...
                  Set debug level. Repeat from 1 to 6 times to  increase  the
                  detail  of  messages sent to the log file and/or syslog (if
                  configured).
    
           **--devices** _PV_
                  Devices that the  command  can  use.  This  option  can  be
                  repeated or accepts a comma separated list of devices. This
                  overrides the devices file.
    
           **--devicesfile** _String_
                  A  file listing devices that LVM should use.  The file must
                  exist  in  _/etc/lvm/devices/_  and  is  managed   with   the
                  lvmdevices(8)  command.   This  overrides  the  lvm.conf(5)
                  **devices/devicesfile** and **devices/use_devicesfile** settings.
    
           **--driverloaded y** |**n**
                  If set to no, the command will not attempt to  use  device-
                  mapper.  For testing and debugging.
    
           **-f** |**--file** _String_
                  Write  the  backup to the named file.  When backing up more
                  than one VG, the file name is treated as a template, and %s
                  is replaced by the VG name.
    
           **--foreign**
                  Report/display foreign VGs that would otherwise be skipped.
                  See lvmsystemid(7) for more information about foreign  VGs.
    
           **-h** |**--help**
                  Display help text.
    
           **--ignorelockingfailure**
                  Allows  a  command  to  continue  with  read-only  metadata
                  operations after locking failures.
    
           **--journal** _String_
                  Record  information   in   the   systemd   journal.    This
                  information  is  in  addition to information enabled by the
                  lvm.conf log/journal setting.  command: record  information
                  about  the  command.   output:  record  the default command
                  output.  debug: record full command debugging.
    
           **--lockopt** _String_
                  Used to pass options for special cases  to  lvmlockd.   See
                  lvmlockd(8) for more information.
    
           **--longhelp**
                  Display long help text.
    
           **--nohints**
                  Do  not  use  the  hints  file to locate devices for PVs. A
                  command may read more devices to find PVs  when  hints  are
                  not used. The command will still perform standard hint file
                  invalidation where appropriate.
    
           **--nolocking**
                  Disable locking.
    
           **--profile** _String_
                  An   alias   for   --commandprofile  or  --metadataprofile,
                  depending on the command.
    
           **-q** |**--quiet**...
                  Suppress output and log  messages.  Overrides  --debug  and
                  --verbose.   Repeat  once to also suppress any prompts with
                  answer 'no'.
    
           **--readonly**
                  Run the command in a special read-only mode which will read
                  on-disk metadata without needing to take  any  locks.  This
                  can  be  used  to  peek  inside  metadata used by a virtual
                  machine image while the  virtual  machine  is  running.  No
                  attempt  will be made to communicate with the device-mapper
                  kernel driver, so this option is unable to  report  whether
                  or not LVs are actually in use.
    
           **--reportformat basic** |**json**
                  Overrides  current  output  format  for  reports  which  is
                  defined globally by  the  report/output_format  setting  in
                  lvm.conf(5).  **basic** is the original format with columns and
                  rows.   If  there is more than one report per command, each
                  report is prefixed with the report name for identification.
                  **json** produces  report   output   in   JSON   format.   See
                  lvmreport(7) for more information.
    
           **-t** |**--test**
                  Run  in test mode. Commands will not update metadata.  This
                  is  implemented  by  disabling  all  metadata  writing  but
                  nevertheless  returning  success  to  the calling function.
                  This may lead to  unusual  error  messages  in  multi-stage
                  operations  if  a  tool  relies on reading back metadata it
                  believes has changed but hasn't.
    
           **-v** |**--verbose**...
                  Set verbose level. Repeat from 1 to 4 times to increase the
                  detail of messages sent to stdout and stderr.
    
           **--version**
                  Display version information.
    
           **-y** |**--yes**
                  Do not prompt for  confirmation  interactively  but  always
                  assume  the  answer  yes.  Use  with extreme caution.  (For
                  automatic no, see -qq.)
    


## VARIABLES



           _VG_     Volume Group name.  See lvm(8) for valid names.
    
           _String_ See the option description for information about the string
                  content.
    
           _Size_[UNIT]
                  Size is an input number that accepts an optional unit.
                  Input units are always treated as base two values,
                  regardless of capitalization, e.g. 'k' and 'K' both refer
                  to 1024.  The default input unit is specified by letter,
                  followed by |UNIT.  UNIT represents other possible input
                  units: **b** |**B** is bytes, **s** |**S** is sectors of 512 bytes, **k** |**K** is
                  KiB, **m** |**M** is MiB, **g** |**G** is GiB, **t** |**T** is TiB, **p** |**P** is PiB, **e** |**E** is
                  EiB.  (This should not be confused with the output control
                  --units, where capital letters mean multiple of 1000.)
    


## ENVIRONMENT VARIABLES



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


* * *