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.  This com‐
14       mand is no longer used because this version of lvm no  longer  supports
15       the LVM1 format.
16

USAGE

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

OPTIONS

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

VARIABLES

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

ENVIRONMENT VARIABLES

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