OPTIONS

--aligned
Use with --separator to align the output columns
-a|--all
Show information about devices that have not been initialized by LVM, i.e. they are
not PVs.
--binary
Use binary values "0" or "1" instead of descriptive literal values for columns that
have exactly two valid values to report (not counting the "unknown" value which
denotes that the value could not be determined).
--commandprofileString
The command profile to use for command configuration. See lvm.conf(5) for more
information about profiles.
--configString
Config settings for the command. These override lvm.conf settings. The String arg
uses the same format as lvm.conf, or may use section/field syntax. See lvm.conf(5)
for more information about config.
--configreportlog|vg|lv|pv|pvseg|seg
See lvmreport(7).
-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).
--driverloadedy|n
If set to no, the command will not attempt to use device-mapper. For testing and
debugging.
--foreign
Report/display foreign VGs that would otherwise be skipped. See lvmsystemid(7) for
more information about foreign VGs.
-h|--help
Display help text.
--ignorelockingfailure
Allows a command to continue with read-only metadata operations after locking
failures.
--ignoreskippedcluster
Use to avoid exiting with an non-zero status code if the command is run without
clustered locking and clustered VGs are skipped.
--logonly
Suppress command report and display only log report.
--longhelp
Display long help text.
--nameprefixes
Add an "LVM2_" prefix plus the field name to the output. Useful with --noheadings
to produce a list of field=value pairs that can be used to set environment
variables (for example, in udev rules).
--noheadings
Suppress the headings line that is normally the first line of output. Useful if
grepping the output.
--nolocking
Disable locking.
--nosuffix
Suppress the suffix on output sizes. Use with --units (except h and H) if
processing the output.
-o|--optionsString
Comma-separated, ordered list of fields to display in columns. String arg syntax
is: [+|-|#]Field1[,Field2 ...] The prefix + will append the specified fields to
the default fields, - will remove the specified fields from the default fields, and
# will compact specified fields (removing them when empty for all rows.) Use -ohelp to view the list of all available fields. Use separate lists of fields to
add, remove or compact by repeating the -o option: -o+field1,field2 -o-
field3,field4 -o#field5. These lists are evaluated from left to right. Use field
name lv_all to view all LV fields, vg_all all VG fields, pv_all all PV fields,
pvseg_all all PV segment fields, seg_all all LV segment fields, and pvseg_all all
PV segment columns. See the lvm.conf report section for more config options. See
lvmreport(7) for more information about reporting.
--profileString
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'.
--readonly
Run the command in a special read-only mode which will read on-disk metadata
without needing to take any locks. This can be used to peek inside metadata used by
a virtual machine image while the virtual machine is running. It can also be used
to peek inside the metadata of clustered VGs when clustered locking is not
configured or running. No attempt will be made to communicate with the device-
mapper kernel driver, so this option is unable to report whether or not LVs are
actually in use.
--reportformatbasic|json
Overrides current output format for reports which is defined globally by the
report/output_format setting in lvm.conf. basic is the original format with
columns and rows. If there is more than one report per command, each report is
prefixed with the report name for identification. json produces report output in
JSON format. See lvmreport(7) for more information.
--rows
Output columns as rows.
--segments
Produces one line of output for each contiguous allocation of space on each PV,
showing the start (pvseg_start) and length (pvseg_size) in units of physical
extents.
-S|--selectString
Select objects for processing and reporting based on specified criteria. The
criteria syntax is described by --selecthelp and lvmreport(7). For reporting
commands, one row is displayed for each object matching the criteria. See
--optionshelp for selectable object fields. Rows can be displayed with an
additional "selected" field (-o selected) showing 1 if the row matches the
selection and 0 otherwise. For non-reporting commands which process LVM entities,
the selection is used to choose items to process.
--separatorString
String to use to separate each column. Useful if grepping the output.
--shared
Report/display shared VGs that would otherwise be skipped when lvmlockd is not
being used on the host. See lvmlockd(8) for more information about shared VGs.
-O|--sortString
Comma-separated ordered list of columns to sort by. Replaces the default selection.
Precede any column with - for a reverse sort on that column.
-t|--test
Run in test mode. Commands will not update metadata. This is implemented by
disabling all metadata 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.
--trustcache
Avoids certain device scanning during command processing. Do not use.
--unbuffered
Produce output immediately without sorting or aligning the columns properly.
--unitsr|R|h|H|b|B|s|S|k|K|m|M|g|G|t|T|p|P|e|E
All sizes are output in these units: human-(r)eadable with '<' rounding indicator,
(h)uman-readable, (b)ytes, (s)ectors, (k)ilobytes, (m)egabytes, (g)igabytes,
(t)erabytes, (p)etabytes, (e)xabytes. Capitalise to use multiples of 1000 (S.I.)
instead of 1024. Custom units can be specified, e.g. --units 3M.
--unquoted
When used with --nameprefixes, output values in the field=value pairs are not
quoted.
-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.
-y|--yes
Do not prompt for confirmation interactively but always assume the answer yes. Use
with extreme caution. (For automatic no, see -qq.)

VARIABLES

PV
Physical Volume name, a device path under /dev. For commands managing physical
extents, a PV positional arg generally accepts a suffix indicating a range (or
multiple ranges) of physical extents (PEs). When the first PE is omitted, it
defaults to the start of the device, and when the last PE is omitted it defaults to
end. Start and end range (inclusive): PV[:PE-PE]... Start and length range
(counting from 0): PV[:PE+PE]...
Tag
Tag name. See lvm(8) for information about tag names and using tags in place of a
VG, LV or PV.
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: bBsSkKmMgGtTpPeE. b|B is bytes, s|S is
sectors of 512 bytes, k|K is kilobytes, m|M is megabytes, g|G is gigabytes, t|T is
terabytes, p|P is petabytes, e|E is exabytes. (This should not be confused with
the output control --units, where capital letters mean multiple of 1000.)

ENVIRONMENTVARIABLES

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