vgconvert(8)

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

NAME

6       vgconvert - Change volume group metadata format
7

SYNOPSIS

9       vgconvert position_args
10           [ option_args ]
11

DESCRIPTION

13       vgconvert  converts  VG  metadata  from one format to another.  The new
14       metadata format must be able to fit into the space provided by the  old
15       format.
16
17       Because  the  LVM1  format should no longer be used, this command is no
18       longer needed in general.
19

USAGE

21       vgconvert VG ...
22           [ -f|--force ]
23           [ -M|--metadatatype lvm2|lvm1 ]
24           [    --labelsector Number ]
25           [    --bootloaderareasize Size[m|UNIT] ]
26           [    --pvmetadatacopies 0|1|2 ]
27           [    --metadatasize Size[m|UNIT] ]
28           [    --reportformat basic|json ]
29           [ COMMON_OPTIONS ]
30
31       Common options for lvm:
32           [ -d|--debug ]
33           [ -h|--help ]
34           [ -q|--quiet ]
35           [ -t|--test ]
36           [ -v|--verbose ]
37           [ -y|--yes ]
38           [    --commandprofile String ]
39           [    --config String ]
40           [    --driverloaded y|n ]
41           [    --lockopt String ]
42           [    --longhelp ]
43           [    --profile String ]
44           [    --version ]
45

OPTIONS

47       --bootloaderareasize Size[m|UNIT]
48              Create a separate bootloader area of specified size besides PV's
49              data area. The bootloader area is an area of reserved space on
50              the PV from which LVM will not allocate any extents and it's
51              kept untouched. This is primarily aimed for use with bootloaders
52              to embed their own data or metadata.  The start of the boot‐
53              loader area is always aligned, see also --dataalignment and
54              --dataalignmentoffset. The bootloader area size may eventually
55              end up increased due to the alignment, but it's never less than
56              the size that is requested. To see the bootloader area start and
57              size of an existing PV use pvs -o +pv_ba_start,pv_ba_size.
58
59       --commandprofile String
60              The command profile to use for command configuration.  See
61              lvm.conf(5) for more information about profiles.
62
63       --config String
64              Config settings for the command. These override lvm.conf set‐
65              tings.  The String arg uses the same format as lvm.conf, or may
66              use section/field syntax.  See lvm.conf(5) for more information
67              about config.
68
69       -d|--debug ...
70              Set debug level. Repeat from 1 to 6 times to increase the detail
71              of messages sent to the log file and/or syslog (if configured).
72
73       --driverloaded y|n
74              If set to no, the command will not attempt to use device-mapper.
75              For testing and debugging.
76
77       -f|--force ...
78              Override various checks, confirmations and protections.  Use
79              with extreme caution.
80
81       -h|--help
82              Display help text.
83
84       --labelsector Number
85              By default the PV is labelled with an LVM2 identifier in its
86              second sector (sector 1). This lets you use a different sector
87              near the start of the disk (between 0 and 3 inclusive - see
88              LABEL_SCAN_SECTORS in the source). Use with care.
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       --metadatasize Size[m|UNIT]
98              The approximate amount of space used for each VG metadata area.
99              The size may be rounded.
100
101       -M|--metadatatype lvm2|lvm1
102              Specifies the type of on-disk metadata to use.  lvm2 (or just 2)
103              is the current, standard format.  lvm1 (or just 1) is a histori‐
104              cal format that can be used for accessing old data.
105
106       --profile String
107              An alias for --commandprofile or --metadataprofile, depending on
108              the command.
109
110       --pvmetadatacopies 0|1|2
111              The number of metadata areas to set aside on a PV for storing VG
112              metadata.  When 2, one copy of the VG metadata is stored at the
113              front of the PV and a second copy is stored at the end.  When 1,
114              one copy of the VG metadata is stored at the front of the PV
115              (starting in the 5th sector).  When 0, no copies of the VG meta‐
116              data are stored on the given PV.  This may be useful in VGs con‐
117              taining many PVs (this places limitations on the ability to use
118              vgsplit later.)
119
120       -q|--quiet ...
121              Suppress output and log messages. Overrides --debug and --ver‐
122              bose.  Repeat once to also suppress any prompts with answer
123              'no'.
124
125       --reportformat basic|json
126              Overrides current output format for reports which is defined
127              globally by the report/output_format setting in lvm.conf.  basic
128              is the original format with columns and rows.  If there is more
129              than one report per command, each report is prefixed with the
130              report name for identification. json produces report output in
131              JSON format. See lvmreport(7) for more information.
132
133       -t|--test
134              Run in test mode. Commands will not update metadata.  This is
135              implemented by disabling all metadata writing but nevertheless
136              returning success to the calling function. This may lead to
137              unusual error messages in multi-stage operations if a tool
138              relies on reading back metadata it believes has changed but
139              hasn't.
140
141       -v|--verbose ...
142              Set verbose level. Repeat from 1 to 4 times to increase the
143              detail of messages sent to stdout and stderr.
144
145       --version
146              Display version information.
147
148       -y|--yes
149              Do not prompt for confirmation interactively but always assume
150              the answer yes. Use with extreme caution.  (For automatic no,
151              see -qq.)
152

VARIABLES

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

ENVIRONMENT VARIABLES

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