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|profi‐
25           lable|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           [    --withsummary ]
36           [    --withcomments ]
37           [    --withgeneralpreamble ]
38           [    --withlocalpreamble ]
39           [    --withspaces ]
40           [    --unconfigured ]
41           [    --withversions ]
42           [ COMMON_OPTIONS ]
43           [ String ... ]
44
45       Common options for lvm:
46           [ -d|--debug ]
47           [ -h|--help ]
48           [ -q|--quiet ]
49           [ -t|--test ]
50           [ -v|--verbose ]
51           [ -y|--yes ]
52           [    --commandprofile String ]
53           [    --config String ]
54           [    --driverloaded y|n ]
55           [    --lockopt String ]
56           [    --longhelp ]
57           [    --nolocking ]
58           [    --profile String ]
59           [    --version ]
60

OPTIONS

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

VARIABLES

258       String
259              See the option description for information about the string con‐
260              tent.
261
262       Size[UNIT]
263              Size  is  an  input number that accepts an optional unit.  Input
264              units are always treated as base two values, regardless of capi‐
265              talization,  e.g.  'k'  and 'K' both refer to 1024.  The default
266              input unit is specified by letter, followed by |UNIT.  UNIT rep‐
267              resents  other  possible  input units: bBsSkKmMgGtTpPeE.  b|B is
268              bytes, s|S is sectors of 512 bytes, k|K  is  kilobytes,  m|M  is
269              megabytes, g|G is gigabytes, t|T is terabytes, p|P is petabytes,
270              e|E is exabytes.  (This should not be confused with  the  output
271              control --units, where capital letters mean multiple of 1000.)
272

ENVIRONMENT VARIABLES

274       See  lvm(8)  for  information  about environment variables used by lvm.
275       For example, LVM_VG_NAME can generally be substituted for a required VG
276       parameter.
277

SEE ALSO

279       lvm(8) lvm.conf(5) lvmconfig(8)
280
281       pvchange(8)  pvck(8)  pvcreate(8)  pvdisplay(8)  pvmove(8)  pvremove(8)
282       pvresize(8) pvs(8) pvscan(8)
283
284       vgcfgbackup(8) vgcfgrestore(8) vgchange(8) vgck(8)  vgcreate(8)  vgcon‐
285       vert(8)  vgdisplay(8)  vgexport(8)  vgextend(8)  vgimport(8)  vgimport‐
286       clone(8) vgmerge(8) vgmknodes(8)  vgreduce(8)  vgremove(8)  vgrename(8)
287       vgs(8) vgscan(8) vgsplit(8)
288
289       lvcreate(8)  lvchange(8)  lvconvert(8)  lvdisplay(8)  lvextend(8) lvre‐
290       duce(8) lvremove(8) lvrename(8) lvresize(8) lvs(8) lvscan(8)
291
292       lvm-fullreport(8) lvm-lvpoll(8) lvm2-activation-generator(8) blkdeacti‐
293       vate(8) lvmdump(8)
294
295       dmeventd(8)  lvmpolld(8)  lvmlockd(8)  lvmlockctl(8)  cmirrord(8) lvmd‐
296       busd(8)
297
298       lvmsystemid(7) lvmreport(7) lvmraid(7) lvmthin(7) lvmcache(7)
299
300
301
302Red Hat, Inc.       LVM TOOLS 2.03.02(2)-RHEL8 (2019-01-04)       LVMCONFIG(8)
Impressum