search..
No manual entry for -- in section 8
VGCFGBACKUP(8)		    System Manager's Manual		 VGCFGBACKUP(8)

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 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  re-
       placed 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|json_std ]
	   [ 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)  set-
	      tings.   The  String  arg uses the same format as lvm.conf(5), or
	      may use section/field syntax.  See lvm.conf(5) for more  informa-
	      tion 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
	      Restricts the devices that are visible and accessible to the com-
	      mand.  Devices not listed will appear to be missing. 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) com-
	      mand.  This overrides the lvm.conf(5) devices/devicesfile and de-
	      vices/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  re-
	      placed 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  lvm-
	      lockd(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. Use with caution, concurrent commands  may  pro-
	      duce incorrect results.

       --profile String
	      An  alias for --commandprofile or --metadataprofile, depending on
	      the command.

       -q|--quiet ...
	      Suppress output and log messages. Overrides  --debug  and	 --ver-
	      bose.  Repeat once to also suppress any prompts with answer 'no'.

       --readonly
	      Prevent the command from making changes, including activation and
	      metadata updates.	 (See --permission r for read only LVs.)

       --reportformat basic|json|json_std
	      Overrides	 current  output  format  for  reports which is defined
	      globally by the report/output_format setting in lvm.conf(5).  ba-
	      sic 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.	 json_std produces report output in JSON format
	      which is more compliant with JSON standard.  See lvmreport(7) for
	      more information.

       -t|--test
	      Run in test mode. Commands will not update metadata.  This is im-
	      plemented by disabling all metadata writing but nevertheless  re-
	      turning 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  de-
	      tail 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  con-
	      tent.

       Size[UNIT]
	      Size  is	an  input  number that accepts an optional unit.  Input
	      units are always treated as base two values, regardless of  capi-
	      talization, e.g. 'k' and 'K' both refer to 1024.	The default in-
	      put  unit is specified by letter, followed by |UNIT.  UNIT repre-
	      sents 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 pa-
       rameter.

SEE ALSO
       lvm(8), lvm.conf(5), lvmconfig(8), lvmdevices(8),

       pvchange(8), pvck(8), pvcreate(8), pvdisplay(8), pvmove(8), pvremove(8),
       pvresize(8), pvs(8), pvscan(8),

       vgcfgbackup(8), vgcfgrestore(8), vgchange(8), vgck(8), vgcreate(8),
       vgconvert(8), vgdisplay(8), vgexport(8), vgextend(8), vgimport(8),
       vgimportclone(8), vgimportdevices(8), vgmerge(8), vgmknodes(8),
       vgreduce(8), vgremove(8), vgrename(8), vgs(8), vgscan(8), vgsplit(8),

       lvcreate(8), lvchange(8), lvconvert(8), lvdisplay(8), lvextend(8),
       lvreduce(8), lvremove(8), lvrename(8), lvresize(8), lvs(8), lvscan(8),

       lvm-fullreport(8), lvm-lvpoll(8), blkdeactivate(8), lvmdump(8),

       dmeventd(8), lvmpolld(8), lvmlockd(8), lvmlockctl(8), cmirrord(8),
       lvmdbusd(8), fsadm(8),

       lvmsystemid(7), lvmreport(7), lvmcache(7), lvmraid(7), lvmthin(7),
       lvmvdo(7), lvmautoactivation(7)

Red Hat, Inc.	       LVM TOOLS 2.03.31(2) (2025-02-27)	 VGCFGBACKUP(8)