Provided by: lvm2_2.03.16-3ubuntu3.2_amd64 bug

NAME

       lvmconfig — Display and manipulate configuration information

SYNOPSIS

       lvmconfig
           [ option_args ]
           [ position_args ]

DESCRIPTION

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

USAGE

       lvmconfig
           [ -f|--file String ]
           [ -l|--list ]
           [    --atversion String ]
           [    --typeconfig current|default|diff|full|list|missing|new|profilable|profilable-command|
           profilable-metadata ]
           [    --ignoreadvanced ]
           [    --ignoreunsupported ]
           [    --ignorelocal ]
           [    --mergedconfig ]
           [    --metadataprofile String ]
           [    --sinceversion String ]
           [    --showdeprecated ]
           [    --showunsupported ]
           [    --validate ]
           [    --withsummary ]
           [    --withcomments ]
           [    --withgeneralpreamble ]
           [    --withlocalpreamble ]
           [    --withspaces ]
           [    --unconfigured ]
           [    --withversions ]
           [ COMMON_OPTIONS ]
           [ String ... ]

       Common options for lvm:
           [ -d|--debug ]
           [ -h|--help ]
           [ -q|--quiet ]
           [ -t|--test ]
           [ -v|--verbose ]
           [ -y|--yes ]
           [    --commandprofile String ]
           [    --config String ]
           [    --devices PV ]
           [    --devicesfile String ]
           [    --driverloaded y|n ]
           [    --journal String ]
           [    --lockopt String ]
           [    --longhelp ]
           [    --nohints ]
           [    --nolocking ]
           [    --profile String ]
           [    --version ]

OPTIONS


       --atversion String
              Specify  an  LVM  version in x.y.z format where x is the major version, the y is the minor version
              and z is the patchlevel (e.g. 2.2.106).  When configuration is displayed, the  configuration  set‐
              tings  recognized  at this LVM version will be considered only. This can be used to display a con‐
              figuration that a certain LVM version understands and which does not contain  any  newer  settings
              for which LVM would issue a warning message when checking the configuration.

       --commandprofile String
              The  command profile to use for command configuration.  See lvm.conf(5) for more information about
              profiles.

       --config String
              Config settings for the command. These override lvm.conf(5) settings.  The  String  arg  uses  the
              same format as lvm.conf(5), or may use section/field syntax.  See lvm.conf(5) for more information
              about config.

       -d|--debug ...
              Set  debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file
              and/or syslog (if configured).

       --devices PV
              Restricts the devices that are visible and accessible to the command.  Devices not listed will ap‐
              pear to be missing. This option can be repeated, or accepts a comma  separated  list  of  devices.
              This overrides the devices file.

       --devicesfile String
              A  file listing devices that LVM should use.  The file must exist in /etc/lvm/devices/ and is man‐
              aged with the lvmdevices(8) command.  This overrides the lvm.conf(5) devices/devicesfile  and  de‐
              vices/use_devicesfile settings.

       --driverloaded y|n
              If set to no, the command will not attempt to use device-mapper.  For testing and debugging.

       -f|--file String
              Write output to the named file.

       -h|--help
              Display help text.

       --ignoreadvanced
              Exclude advanced configuration settings from the output.

       --ignorelocal
              Ignore  the  local  section.  The  local  section should be defined in the lvmlocal.conf file, and
              should contain config settings specific to the local host which should  not  be  copied  to  other
              hosts.

       --ignoreunsupported
              Exclude unsupported configuration settings from the output. These settings are either used for de‐
              bugging  and development purposes only or their support is not yet complete and they are not meant
              to be used in production. The current and diff types include unsupported settings in their  output
              by default, all the other types ignore unsupported settings.

       --journal String
              Record information in the systemd journal.  This information is in addition to information enabled
              by  the  lvm.conf  log/journal  setting.   command: record information about the command.  output:
              record the default command output.  debug: record full command debugging.

       -l|--list
              List config settings with summarizing comment. This is the same as using options --typeconfig list
              --withsummary.

       --lockopt String
              Used to pass options for special cases to lvmlockd.  See lvmlockd(8) for more information.

       --longhelp
              Display long help text.

       --mergedconfig
              When the command is run with --config and/or --commandprofile (or using LVM_COMMAND_PROFILE  envi‐
              ronment variable), --profile, or --metadataprofile, merge all the contents of the "config cascade"
              before displaying it.  Without merging, only the configuration at the front of the cascade is dis‐
              played.  See lvm.conf(5) for more information about config.

       --metadataprofile String
              The metadata profile to use for command configuration.  See lvm.conf(5) for more information about
              profiles.

       --nohints
              Do  not  use the hints file to locate devices for PVs. A command may read more devices to find PVs
              when hints are not used. The command will still perform standard hint file invalidation where  ap‐
              propriate.

       --nolocking
              Disable locking. Use with caution, concurrent commands may produce incorrect results.

       --profile String
              An alias for --commandprofile or --metadataprofile, depending on the command.

       -q|--quiet ...
              Suppress  output  and log messages. Overrides --debug and --verbose.  Repeat once to also suppress
              any prompts with answer 'no'.

       --showdeprecated
              Include deprecated configuration settings in the output. These settings  are  deprecated  after  a
              certain  version. If a concrete version is specified with --atversion, deprecated settings are au‐
              tomatically included if the specified version is lower than the version in which the settings were
              deprecated. The current and diff types include deprecated settings in their output by default, all
              the other types ignore deprecated settings.

       --showunsupported
              Include unsupported configuration settings in the output. These settings are either used  for  de‐
              bugging  or development purposes only, or their support is not yet complete and they are not meant
              to be used in production. The current and diff types include unsupported settings in their  output
              by default, all the other types ignore unsupported settings.

       --sinceversion String
              Specify  an  LVM  version in x.y.z format where x is the major version, the y is the minor version
              and z is the patchlevel (e.g. 2.2.106).  This option is currently applicable only with  --typecon‐
              fig new to display all configuration settings introduced since given version.

       -t|--test
              Run in test mode. Commands will not update metadata.  This is implemented by disabling all metada‐
              ta  writing  but  nevertheless returning success to the calling function. This may lead to unusual
              error messages in multi-stage operations if a tool relies on reading back metadata it believes has
              changed but hasn't.

       --typeconfig current|default|diff|full|list|missing|new|profilable|profilable-command|profilable-metadata
              current prints the config settings that would be applied to an lvm command (assuming  the  command
              does  not  override  them on the command line.) This includes: settings that have been modified in
              lvm config files, settings that get their default values from config files, and  default  settings
              that  have  been uncommented in config files.  default prints all settings with their default val‐
              ues.  Changes made in lvm config files are not reflected in the output.  Some settings  get  their
              default  values  internally, and these settings are printed as comments.  Other settings get their
              default values from config files, and these settings are not printed as comments.  diff prints on‐
              ly config settings that have been modified from their default values in config files (the  differ‐
              ence  between  current and default.)  full prints every setting uncommented and set to the current
              value, i.e. how it would be used by an lvm command.  This includes  settings  modified  in  config
              files,  settings  that usually get defaults internally, and settings that get defaults from config
              files.  list prints all config names without values.  missing prints  settings  that  are  missing
              from  the  lvm  config files. A missing setting that usually gets its default from config files is
              printed uncommented and set to the internal default.  Settings that get their  default  internally
              and  are not set in config files are printed commented with the internal default.  new prints con‐
              fig settings that have been added since the lvm version  specified  by  --sinceversion.  They  are
              printed  with their default values.  profilable prints settings with their default values that can
              be set from a profile.  profilable-command prints settings with their default values that  can  be
              set  from  a  command profile.  profilable-metadata prints settings with their default values that
              can be set from a metadata profile.  Also see lvm.conf(5).

       --unconfigured
              Internal option used for generating config file during build.

       --validate
              Validate current configuration used and exit with appropriate return code. The validation is  done
              only for the configuration at the front of the "config cascade". To validate the whole merged con‐
              figuration  tree,  also  use  --mergedconfig.   The  validation  is  done even if lvm.conf(5) con‐
              fig/checks is disabled.

       -v|--verbose ...
              Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout  and
              stderr.

       --version
              Display version information.

       --withcomments
              Display a full comment for each configuration node. For deprecated settings, also display comments
              about deprecation.

       --withgeneralpreamble
              Include general config file preamble.

       --withlocalpreamble
              Include local config file preamble.

       --withspaces
              Where appropriate, add more spaces in output for better readability.

       --withsummary
              Display a one line comment for each configuration node.

       --withversions
              Also  display a comment containing the version of introduction for each configuration node. If the
              setting is deprecated, also display the version since which it is deprecated.

       -y|--yes
              Do not prompt for confirmation interactively but always assume the answer yes.  Use  with  extreme
              caution.  (For automatic no, see -qq.)

VARIABLES

       String See the option description for information about the string content.

       Size[UNIT]
              Size is an input number that accepts an optional unit.  Input units are always treated as base two
              values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024.  The default input unit
              is  specified  by  letter,  followed by |UNIT.  UNIT represents other possible input units: b|B is
              bytes, s|S is sectors of 512 bytes, k|K is KiB, m|M is MiB, g|G is GiB, t|T is TiB,  p|P  is  PiB,
              e|E  is  EiB.  (This should not be confused with the output control --units, where capital letters
              mean multiple of 1000.)

ENVIRONMENT VARIABLES

       See lvm(8) for information about environment variables used by lvm.  For example, LVM_VG_NAME can  gener‐
       ally be substituted for a required VG parameter.

SEE ALSO

       lvm(8), lvm.conf(5), lvmconfig(8), lvmdevices(8),

       pvchange(8), pvck(8), pvcreate(8), pvdisplay(8), pvmove(8), pvremove(8), pvresize(8), pvs(8), pvscan(8),

       vgcfgbackup(8), vgcfgrestore(8), vgchange(8), vgck(8), vgcreate(8), vgconvert(8), vgdisplay(8),
       vgexport(8), vgextend(8), vgimport(8), vgimportclone(8), vgimportdevices(8), vgmerge(8), vgmknodes(8),
       vgreduce(8), vgremove(8), vgrename(8), vgs(8), vgscan(8), vgsplit(8),

       lvcreate(8), lvchange(8), lvconvert(8), lvdisplay(8), lvextend(8), lvreduce(8), lvremove(8), lvrename(8),
       lvresize(8), lvs(8), lvscan(8),

       lvm-fullreport(8), lvm-lvpoll(8), blkdeactivate(8), lvmdump(8),

       dmeventd(8), lvmpolld(8), lvmlockd(8), lvmlockctl(8), cmirrord(8), lvmdbusd(8), fsadm(8),

       lvmsystemid(7), lvmreport(7), lvmraid(7), lvmthin(7), lvmcache(7)

Red Hat, Inc.                           LVM TOOLS 2.03.16(2) (2022-05-18)                           LVMCONFIG(8)