Ubuntu Manpage: vgconvert - Change volume group metadata format

Provided by: lvm2_2.02.176-4.1ubuntu3.18.04.3_amd64

NAME

       vgconvert - Change volume group metadata format

SYNOPSIS

       vgconvert position_args
           [ option_args ]

DESCRIPTION

       vgconvert  converts  VG metadata from one format to another.  The new metadata format must
       be able to fit into the space provided by the old format.

       Because the LVM1 format should no longer be used, this command  is  no  longer  needed  in
       general.

USAGE

       vgconvert VG ...
           [ -f|--force ]
           [ -M|--metadatatype lvm2|lvm1 ]
           [    --labelsector Number ]
           [    --bootloaderareasize Size[m|UNIT] ]
           [    --pvmetadatacopies 0|1|2 ]
           [    --metadatasize Size[m|UNIT] ]
           [    --reportformat basic|json ]
           [ COMMON_OPTIONS ]

       Common options for lvm:
           [ -d|--debug ]
           [ -h|--help ]
           [ -q|--quiet ]
           [ -t|--test ]
           [ -v|--verbose ]
           [ -y|--yes ]
           [    --commandprofile String ]
           [    --config String ]
           [    --driverloaded y|n ]
           [    --longhelp ]
           [    --profile String ]
           [    --version ]

OPTIONS

--bootloaderareasize Size[m|UNIT]
Create a separate bootloader area of specified size besides PV's data area. The
bootloader area is an area of reserved space on the PV from which LVM will not
allocate any extents and it's kept untouched. This is primarily aimed for use with
bootloaders to embed their own data or metadata. The start of the bootloader area
is always aligned, see also --dataalignment and --dataalignmentoffset. The
bootloader area size may eventually end up increased due to the alignment, but it's
never less than the size that is requested. To see the bootloader area start and
size of an existing PV use pvs -o +pv_ba_start,pv_ba_size.

--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 settings. The String arg
uses the same format as lvm.conf, 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).

--driverloaded y|n
If set to no, the command will not attempt to use device-mapper. For testing and
debugging.

-f|--force ...
Override various checks, confirmations and protections. Use with extreme caution.

-h|--help
Display help text.

--labelsector Number
By default the PV is labelled with an LVM2 identifier in its second sector (sector
1). This lets you use a different sector near the start of the disk (between 0 and
3 inclusive - see LABEL_SCAN_SECTORS in the source). Use with care.

--longhelp
Display long help text.

--metadatasize Size[m|UNIT]
The approximate amount of space used for each VG metadata area. The size may be
rounded.

-M|--metadatatype lvm2|lvm1
Specifies the type of on-disk metadata to use. lvm2 (or just 2) is the current,
standard format. lvm1 (or just 1) is a historical format that can be used for
accessing old data.

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

--pvmetadatacopies 0|1|2
The number of metadata areas to set aside on a PV for storing VG metadata. When 2,
one copy of the VG metadata is stored at the front of the PV and a second copy is
stored at the end. When 1, one copy of the VG metadata is stored at the front of
the PV (starting in the 5th sector). When 0, no copies of the VG metadata are
stored on the given PV. This may be useful in VGs containing many PVs (this places
limitations on the ability to use vgsplit later.)

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

--reportformat basic|json
Overrides current output format for reports which is defined globally by the
report/output_format setting in lvm.conf. 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: bBsSkKmMgGtTpPeE.  b|B is bytes, s|S is
              sectors  of 512 bytes, k|K is kilobytes, m|M is megabytes, g|G is gigabytes, t|T is
              terabytes, p|P is petabytes, e|E is exabytes.  (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.