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

NAME

6       lvmconfig — Display and manipulate configuration information
7

SYNOPSIS

9       lvmconfig
10           [ option_args ]
11           [ position_args ]
12

DESCRIPTION

14       lvmconfig, lvm config, lvm dumpconfig (for compatibility reasons, to be
15       phased out) produce formatted output from the LVM  configuration  tree.
16       The  sources  of the configuration data include lvm.conf(5) and command
17       line settings from --config.
18

USAGE

20       lvmconfig
21           [ -f|--file String ]
22           [ -l|--list ]
23           [    --atversion String ]
24           [    --typeconfig current|default|diff|full|list|missing|new|
25           profilable|profilable-command|profilable-metadata ]
26           [    --ignoreadvanced ]
27           [    --ignoreunsupported ]
28           [    --ignorelocal ]
29           [    --mergedconfig ]
30           [    --metadataprofile String ]
31           [    --sinceversion String ]
32           [    --showdeprecated ]
33           [    --showunsupported ]
34           [    --validate ]
35           [    --valuesonly ]
36           [    --withsummary ]
37           [    --withcomments ]
38           [    --withgeneralpreamble ]
39           [    --withlocalpreamble ]
40           [    --withspaces ]
41           [    --unconfigured ]
42           [    --withversions ]
43           [ COMMON_OPTIONS ]
44           [ String ... ]
45
46       Common options for lvm:
47           [ -d|--debug ]
48           [ -h|--help ]
49           [ -q|--quiet ]
50           [ -t|--test ]
51           [ -v|--verbose ]
52           [ -y|--yes ]
53           [    --commandprofile String ]
54           [    --config String ]
55           [    --devices PV ]
56           [    --devicesfile String ]
57           [    --driverloaded y|n ]
58           [    --journal String ]
59           [    --lockopt String ]
60           [    --longhelp ]
61           [    --nohints ]
62           [    --nolocking ]
63           [    --profile String ]
64           [    --version ]
65

OPTIONS

67       --atversion String
68              Specify an LVM version in x.y.z format where x is the major ver‐
69              sion, the y is the minor version and z is the  patchlevel  (e.g.
70              2.2.106).   When  configuration  is displayed, the configuration
71              settings recognized at this LVM version will be considered only.
72              This  can  be used to display a configuration that a certain LVM
73              version understands and which does not contain  any  newer  set‐
74              tings  for which LVM would issue a warning message when checking
75              the configuration.
76
77       --commandprofile String
78              The command profile  to  use  for  command  configuration.   See
79              lvm.conf(5) for more information about profiles.
80
81       --config String
82              Config settings for the command. These override lvm.conf(5) set‐
83              tings.  The String arg uses the same format as  lvm.conf(5),  or
84              may use section/field syntax.  See lvm.conf(5) for more informa‐
85              tion about config.
86
87       -d|--debug ...
88              Set debug level. Repeat from 1 to 6 times to increase the detail
89              of messages sent to the log file and/or syslog (if configured).
90
91       --devices PV
92              Restricts  the  devices  that  are visible and accessible to the
93              command.  Devices not listed will appear to be missing. This op‐
94              tion  can  be repeated, or accepts a comma separated list of de‐
95              vices. This overrides the devices file.
96
97       --devicesfile String
98              A file listing devices that LVM should use.  The file must exist
99              in  /etc/lvm/devices/ and is managed with the lvmdevices(8) com‐
100              mand.  This overrides the  lvm.conf(5)  devices/devicesfile  and
101              devices/use_devicesfile settings.
102
103       --driverloaded y|n
104              If set to no, the command will not attempt to use device-mapper.
105              For testing and debugging.
106
107       -f|--file String
108              Write output to the named file.
109
110       -h|--help
111              Display help text.
112
113       --ignoreadvanced
114              Exclude advanced configuration settings from the output.
115
116       --ignorelocal
117              Ignore the local section. The local section should be defined in
118              the  lvmlocal.conf file, and should contain config settings spe‐
119              cific to the local host which should  not  be  copied  to  other
120              hosts.
121
122       --ignoreunsupported
123              Exclude  unsupported  configuration  settings  from  the output.
124              These settings are either used  for  debugging  and  development
125              purposes  only or their support is not yet complete and they are
126              not meant to be used in production. The current and  diff  types
127              include unsupported settings in their output by default, all the
128              other types ignore unsupported settings.
129
130       --journal String
131              Record information in the systemd journal.  This information  is
132              in  addition  to information enabled by the lvm.conf log/journal
133              setting.  command: record information about the  command.   out‐
134              put: record the default command output.  debug: record full com‐
135              mand debugging.
136
137       -l|--list
138              List config settings with summarizing comment. This is the  same
139              as using options --typeconfig list --withsummary.
140
141       --lockopt String
142              Used  to  pass  options for special cases to lvmlockd.  See lvm‐
143              lockd(8) for more information.
144
145       --longhelp
146              Display long help text.
147
148       --mergedconfig
149              When the command is run with  --config  and/or  --commandprofile
150              (or  using LVM_COMMAND_PROFILE environment variable), --profile,
151              or --metadataprofile, merge all the contents of the "config cas‐
152              cade"  before displaying it.  Without merging, only the configu‐
153              ration  at  the  front  of  the  cascade  is   displayed.    See
154              lvm.conf(5) for more information about config.
155
156       --metadataprofile String
157              The  metadata  profile  to  use  for command configuration.  See
158              lvm.conf(5) for more information about profiles.
159
160       --nohints
161              Do not use the hints file to locate devices for PVs.  A  command
162              may  read  more devices to find PVs when hints are not used. The
163              command will still perform standard hint file invalidation where
164              appropriate.
165
166       --nolocking
167              Disable  locking. Use with caution, concurrent commands may pro‐
168              duce incorrect results.
169
170       --profile String
171              An alias for --commandprofile or --metadataprofile, depending on
172              the command.
173
174       -q|--quiet ...
175              Suppress  output  and log messages. Overrides --debug and --ver‐
176              bose.  Repeat once to also  suppress  any  prompts  with  answer
177              'no'.
178
179       --showdeprecated
180              Include  deprecated  configuration settings in the output. These
181              settings are deprecated after a certain version. If  a  concrete
182              version  is  specified with --atversion, deprecated settings are
183              automatically included if the specified version  is  lower  than
184              the  version  in which the settings were deprecated. The current
185              and diff types include deprecated settings in  their  output  by
186              default, all the other types ignore deprecated settings.
187
188       --showunsupported
189              Include  unsupported configuration settings in the output. These
190              settings are either used for debugging or  development  purposes
191              only,  or  their  support  is  not yet complete and they are not
192              meant to be used in production. The current and diff  types  in‐
193              clude  unsupported  settings in their output by default, all the
194              other types ignore unsupported settings.
195
196       --sinceversion String
197              Specify an LVM version in x.y.z format where x is the major ver‐
198              sion,  the  y is the minor version and z is the patchlevel (e.g.
199              2.2.106).  This option is currently applicable only with --type‐
200              config  new  to  display  all  configuration settings introduced
201              since given version.
202
203       -t|--test
204              Run in test mode. Commands will not update  metadata.   This  is
205              implemented  by  disabling all metadata writing but nevertheless
206              returning success to the calling function. This may lead to  un‐
207              usual  error messages in multi-stage operations if a tool relies
208              on reading back metadata it believes has changed but hasn't.
209
210       --typeconfig current|default|diff|full|list|missing|new|profilable|
211              profilable-command|profilable-metadata
212              current  prints  the config settings that would be applied to an
213              lvm command (assuming the command does not override them on  the
214              command  line.)  This includes: settings that have been modified
215              in lvm config files, settings that get their default values from
216              config files, and default settings that have been uncommented in
217              config files.  default prints all settings  with  their  default
218              values.   Changes  made in lvm config files are not reflected in
219              the output.  Some settings get their default values  internally,
220              and  these settings are printed as comments.  Other settings get
221              their default values from config files, and these  settings  are
222              not  printed as comments.  diff prints only config settings that
223              have been modified from their default  values  in  config  files
224              (the difference between current and default.)  full prints every
225              setting uncommented and set to the current value,  i.e.  how  it
226              would  be  used by an lvm command.  This includes settings modi‐
227              fied in config files, settings that usually get defaults  inter‐
228              nally,  and  settings that get defaults from config files.  list
229              prints all config names without values.  missing prints settings
230              that  are  missing  from the lvm config files. A missing setting
231              that usually gets its default from config files is  printed  un‐
232              commented  and  set  to the internal default.  Settings that get
233              their default internally and are not set  in  config  files  are
234              printed  commented with the internal default.  new prints config
235              settings that have been added since the lvm version specified by
236              --sinceversion.  They  are  printed  with  their default values.
237              profilable prints settings with their default values that can be
238              set  from  a  profile.   profilable-command prints settings with
239              their default values that can be set  from  a  command  profile.
240              profilable-metadata  prints  settings  with their default values
241              that can be set from a metadata profile.  Also see lvm.conf(5).
242
243       --unconfigured
244              Internal option used for generating config file during build.
245
246       --validate
247              Validate current configuration used and  exit  with  appropriate
248              return  code.  The validation is done only for the configuration
249              at the front of the "config  cascade".  To  validate  the  whole
250              merged configuration tree, also use --mergedconfig.  The valida‐
251              tion is done even if lvm.conf(5) config/checks is disabled.
252
253       --valuesonly
254              When printing config settings, print only values without keys.
255
256       -v|--verbose ...
257              Set verbose level. Repeat from 1 to 4 times to increase the  de‐
258              tail of messages sent to stdout and stderr.
259
260       --version
261              Display version information.
262
263       --withcomments
264              Display  a  full comment for each configuration node. For depre‐
265              cated settings, also display comments about deprecation.
266
267       --withgeneralpreamble
268              Include general config file preamble.
269
270       --withlocalpreamble
271              Include local config file preamble.
272
273       --withspaces
274              Where appropriate, add more spaces in output  for  better  read‐
275              ability.
276
277       --withsummary
278              Display a one line comment for each configuration node.
279
280       --withversions
281              Also  display  a  comment containing the version of introduction
282              for each configuration node. If the setting is deprecated,  also
283              display the version since which it is deprecated.
284
285       -y|--yes
286              Do  not  prompt for confirmation interactively but always assume
287              the answer yes. Use with extreme caution.   (For  automatic  no,
288              see -qq.)
289

VARIABLES

291       String See the option description for information about the string con‐
292              tent.
293
294       Size[UNIT]
295              Size is an input number that accepts an  optional  unit.   Input
296              units are always treated as base two values, regardless of capi‐
297              talization, e.g. 'k' and 'K' both refer to  1024.   The  default
298              input unit is specified by letter, followed by |UNIT.  UNIT rep‐
299              resents other possible input units: b|B is bytes, s|S is sectors
300              of  512  bytes,  k|K is KiB, m|M is MiB, g|G is GiB, t|T is TiB,
301              p|P is PiB, e|E is EiB.  (This should not be confused  with  the
302              output  control  --units, where capital letters mean multiple of
303              1000.)
304

ENVIRONMENT VARIABLES

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

SEE ALSO

311       lvm(8), lvm.conf(5), lvmconfig(8), lvmdevices(8),
312
313       pvchange(8), pvck(8), pvcreate(8), pvdisplay(8), pvmove(8),
314       pvremove(8), pvresize(8), pvs(8), pvscan(8),
315
316       vgcfgbackup(8), vgcfgrestore(8), vgchange(8), vgck(8), vgcreate(8),
317       vgconvert(8), vgdisplay(8), vgexport(8), vgextend(8), vgimport(8),
318       vgimportclone(8), vgimportdevices(8), vgmerge(8), vgmknodes(8),
319       vgreduce(8), vgremove(8), vgrename(8), vgs(8), vgscan(8), vgsplit(8),
320
321       lvcreate(8), lvchange(8), lvconvert(8), lvdisplay(8), lvextend(8),
322       lvreduce(8), lvremove(8), lvrename(8), lvresize(8), lvs(8), lvscan(8),
323
324       lvm-fullreport(8), lvm-lvpoll(8), blkdeactivate(8), lvmdump(8),
325
326       dmeventd(8), lvmpolld(8), lvmlockd(8), lvmlockctl(8), cmirrord(8),
327       lvmdbusd(8), fsadm(8),
328
329       lvmsystemid(7), lvmreport(7), lvmcache(7), lvmraid(7), lvmthin(7),
330       lvmvdo(7), lvmautoactivation(7)
331
332
333
334
335Red Hat, Inc.          LVM TOOLS 2.03.22(2) (2023-08-02)          LVMCONFIG(8)
Impressum