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

NAME

6       lvdisplay - Display information about a logical volume
7

SYNOPSIS

9       lvdisplay
10           [ option_args ]
11           [ position_args ]
12

DESCRIPTION

14       lvdisplay  shows  the  attributes of LVs, like size, read/write status,
15       snapshot information, etc.
16
17       lvs(8) is a preferred alternative that shows the same  information  and
18       more, using a more compact and configurable output format.
19

USAGE

21       lvdisplay
22           [ -a|--all ]
23           [ -c|--colon ]
24           [ -C|--columns ]
25           [ -H|--history ]
26           [ -m|--maps ]
27           [ -o|--options String ]
28           [ -O|--sort String ]
29           [ -S|--select String ]
30           [    --aligned ]
31           [    --binary ]
32           [    --configreport log|vg|lv|pv|pvseg|seg ]
33           [    --foreign ]
34           [    --ignorelockingfailure ]
35           [    --logonly ]
36           [    --noheadings ]
37           [    --nosuffix ]
38           [    --readonly ]
39           [    --reportformat basic|json ]
40           [    --segments ]
41           [    --separator String ]
42           [    --shared ]
43           [    --unbuffered ]
44           [    --units r|R|h|H|b|B|s|S|k|K|m|M|g|G|t|T|p|P|e|E ]
45           [ COMMON_OPTIONS ]
46           [ VG|LV|Tag ... ]
47
48       Common options for lvm:
49           [ -d|--debug ]
50           [ -h|--help ]
51           [ -q|--quiet ]
52           [ -t|--test ]
53           [ -v|--verbose ]
54           [ -y|--yes ]
55           [    --commandprofile String ]
56           [    --config String ]
57           [    --driverloaded y|n ]
58           [    --lockopt String ]
59           [    --longhelp ]
60           [    --nolocking ]
61           [    --profile String ]
62           [    --version ]
63

OPTIONS

65       --aligned
66              Use with --separator to align the output columns
67
68       -a|--all
69              Show information about internal LVs.  These are components of
70              normal LVs, such as mirrors, which are not independently acces‐
71              sible, e.g. not mountable.
72
73       --binary
74              Use binary values "0" or "1" instead of descriptive literal val‐
75              ues for columns that have exactly two valid values to report
76              (not counting the "unknown" value which denotes that the value
77              could not be determined).
78
79       -c|--colon
80              Generate colon separated output for easier parsing in scripts or
81              programs.  Also see vgs(8) which provides considerably more con‐
82              trol over the output.
83
84       -C|--columns
85              Display output in columns, the equivalent of vgs(8).  Options
86              listed are the same as options given in vgs(8).
87
88       --commandprofile String
89              The command profile to use for command configuration.  See
90              lvm.conf(5) for more information about profiles.
91
92       --config String
93              Config settings for the command. These override lvm.conf set‐
94              tings.  The String arg uses the same format as lvm.conf, or may
95              use section/field syntax.  See lvm.conf(5) for more information
96              about config.
97
98       --configreport log|vg|lv|pv|pvseg|seg
99              See lvmreport(7).
100
101       -d|--debug ...
102              Set debug level. Repeat from 1 to 6 times to increase the detail
103              of messages sent to the log file and/or syslog (if configured).
104
105       --driverloaded y|n
106              If set to no, the command will not attempt to use device-mapper.
107              For testing and debugging.
108
109       --foreign
110              Report/display foreign VGs that would otherwise be skipped.  See
111              lvmsystemid(7) for more information about foreign VGs.
112
113       -h|--help
114              Display help text.
115
116       -H|--history
117              Include historical LVs in the output.  (This has no effect un‐
118              less LVs were removed while lvm.conf metadata/record_lvs_history
119              was enabled.
120
121       --ignorelockingfailure
122              Allows a command to continue with read-only metadata operations
123              after locking failures.
124
125       --lockopt String
126              Used to pass options for special cases to lvmlockd.  See lvm‐
127              lockd(8) for more information.
128
129       --logonly
130              Suppress command report and display only log report.
131
132       --longhelp
133              Display long help text.
134
135       -m|--maps
136              Display the mapping of logical extents to PVs and physical ex‐
137              tents.  To map physical extents to logical extents use: pvs
138              --segments -o+lv_name,seg_start_pe,segtype
139
140       --noheadings
141              Suppress the headings line that is normally the first line of
142              output.  Useful if grepping the output.
143
144       --nolocking
145              Disable locking.
146
147       --nosuffix
148              Suppress the suffix on output sizes. Use with --units (except h
149              and H) if processing the output.
150
151       -o|--options String
152              Comma-separated, ordered list of fields to display in columns.
153              String arg syntax is: [+|-|#]Field1[,Field2 ...]  The prefix +
154              will append the specified fields to the default fields, - will
155              remove the specified fields from the default fields, and # will
156              compact specified fields (removing them when empty for all
157              rows.)  Use -o help to view the list of all available fields.
158              Use separate lists of fields to add, remove or compact by re‐
159              peating the -o option: -o+field1,field2 -o-field3,field4
160              -o#field5.  These lists are evaluated from left to right.  Use
161              field name lv_all to view all LV fields, vg_all all VG fields,
162              pv_all all PV fields, pvseg_all all PV segment fields, seg_all
163              all LV segment fields, and pvseg_all all PV segment columns.
164              See the lvm.conf report section for more config options.  See
165              lvmreport(7) for more information about reporting.
166
167       --profile String
168              An alias for --commandprofile or --metadataprofile, depending on
169              the command.
170
171       -q|--quiet ...
172              Suppress output and log messages. Overrides --debug and --ver‐
173              bose.  Repeat once to also suppress any prompts with answer
174              'no'.
175
176       --readonly
177              Run the command in a special read-only mode which will read on-
178              disk metadata without needing to take any locks. This can be
179              used to peek inside metadata used by a virtual machine image
180              while the virtual machine is running. No attempt will be made to
181              communicate with the device-mapper kernel driver, so this option
182              is unable to report whether or not LVs are actually in use.
183
184       --reportformat basic|json
185              Overrides current output format for reports which is defined
186              globally by the report/output_format setting in lvm.conf.  basic
187              is the original format with columns and rows.  If there is more
188              than one report per command, each report is prefixed with the
189              report name for identification. json produces report output in
190              JSON format. See lvmreport(7) for more information.
191
192       --segments
193
194       -S|--select String
195              Select objects for processing and reporting based on specified
196              criteria.  The criteria syntax is described by --select help and
197              lvmreport(7).  For reporting commands, one row is displayed for
198              each object matching the criteria.  See --options help for se‐
199              lectable object fields.  Rows can be displayed with an addi‐
200              tional "selected" field (-o selected) showing 1 if the row
201              matches the selection and 0 otherwise.  For non-reporting com‐
202              mands which process LVM entities, the selection is used to
203              choose items to process.
204
205       --separator String
206              String to use to separate each column. Useful if grepping the
207              output.
208
209       --shared
210              Report/display shared VGs that would otherwise be skipped when
211              lvmlockd is not being used on the host.  See lvmlockd(8) for
212              more information about shared VGs.
213
214       -O|--sort String
215              Comma-separated ordered list of columns to sort by. Replaces the
216              default selection. Precede any column with - for a reverse sort
217              on that column.
218
219       -t|--test
220              Run in test mode. Commands will not update metadata.  This is
221              implemented by disabling all metadata writing but nevertheless
222              returning success to the calling function. This may lead to un‐
223              usual error messages in multi-stage operations if a tool relies
224              on reading back metadata it believes has changed but hasn't.
225
226       --unbuffered
227              Produce output immediately without sorting or aligning the col‐
228              umns properly.
229
230       --units r|R|h|H|b|B|s|S|k|K|m|M|g|G|t|T|p|P|e|E
231              All sizes are output in these units: human-(r)eadable with '<'
232              rounding indicator, (h)uman-readable, (b)ytes, (s)ectors,
233              (k)ilobytes, (m)egabytes, (g)igabytes, (t)erabytes, (p)etabytes,
234              (e)xabytes.  Capitalise to use multiples of 1000 (S.I.) instead
235              of 1024.  Custom units can be specified, e.g. --units 3M.
236
237       -v|--verbose ...
238              Set verbose level. Repeat from 1 to 4 times to increase the de‐
239              tail of messages sent to stdout and stderr.
240
241       --version
242              Display version information.
243
244       -y|--yes
245              Do not prompt for confirmation interactively but always assume
246              the answer yes. Use with extreme caution.  (For automatic no,
247              see -qq.)
248

VARIABLES

250       VG
251              Volume Group name.  See lvm(8) for valid names.
252
253       LV
254              Logical  Volume  name.  See lvm(8) for valid names.  An LV posi‐
255              tional arg generally includes the VG  name  and  LV  name,  e.g.
256              VG/LV.
257
258       Tag
259              Tag  name.  See lvm(8) for information about tag names and using
260              tags in place of a VG, LV or PV.
261
262       String
263              See the option description for information about the string con‐
264              tent.
265
266       Size[UNIT]
267              Size  is  an  input number that accepts an optional unit.  Input
268              units are always treated as base two values, regardless of capi‐
269              talization,  e.g.  'k'  and 'K' both refer to 1024.  The default
270              input unit is specified by letter, followed by |UNIT.  UNIT rep‐
271              resents  other  possible  input units: bBsSkKmMgGtTpPeE.  b|B is
272              bytes, s|S is sectors of 512 bytes, k|K is KiB, m|M is MiB,  g|G
273              is GiB, t|T is TiB, p|P is PiB, e|E is EiB.  (This should not be
274              confused with the output control --units, where capital  letters
275              mean multiple of 1000.)
276

ENVIRONMENT VARIABLES

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

SEE ALSO

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