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           [    --profile String ]
58           [    --version ]
59

OPTIONS

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

VARIABLES

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

ENVIRONMENT VARIABLES

270       See  lvm(8)  for  information  about environment variables used by lvm.
271       For example, LVM_VG_NAME can generally be substituted for a required VG
272       parameter.
273

SEE ALSO

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