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           [    --ignoreskippedcluster ]
36           [    --logonly ]
37           [    --noheadings ]
38           [    --nosuffix ]
39           [    --readonly ]
40           [    --reportformat basic|json ]
41           [    --segments ]
42           [    --separator String ]
43           [    --shared ]
44           [    --unbuffered ]
45           [    --units r|R|h|H|b|B|s|S|k|K|m|M|g|G|t|T|p|P|e|E ]
46           [ COMMON_OPTIONS ]
47           [ VG|LV|Tag ... ]
48
49       Common options for lvm:
50           [ -d|--debug ]
51           [ -h|--help ]
52           [ -q|--quiet ]
53           [ -t|--test ]
54           [ -v|--verbose ]
55           [ -y|--yes ]
56           [    --commandprofile String ]
57           [    --config String ]
58           [    --driverloaded y|n ]
59           [    --lockopt String ]
60           [    --longhelp ]
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
118              unless LVs were removed while lvm.conf metadata/record_lvs_his‐
119              tory was enabled.
120
121       --ignorelockingfailure
122              Allows a command to continue with read-only metadata operations
123              after locking failures.
124
125       --ignoreskippedcluster
126              Use to avoid exiting with an non-zero status code if the command
127              is run without clustered locking and clustered VGs are skipped.
128
129       --lockopt String
130              Used to pass options for special cases to lvmlockd.  See lvm‐
131              lockd(8) for more information.
132
133       --logonly
134              Suppress command report and display only log report.
135
136       --longhelp
137              Display long help text.
138
139       -m|--maps
140              Display the mapping of logical extents to PVs and physical
141              extents.  To map physical extents to logical extents use: pvs
142              --segments -o+lv_name,seg_start_pe,segtype
143
144       --noheadings
145              Suppress the headings line that is normally the first line of
146              output.  Useful if grepping the output.
147
148       --nosuffix
149              Suppress the suffix on output sizes. Use with --units (except h
150              and H) if processing the output.
151
152       -o|--options String
153              Comma-separated, ordered list of fields to display in columns.
154              String arg syntax is: [+|-|#]Field1[,Field2 ...]  The prefix +
155              will append the specified fields to the default fields, - will
156              remove the specified fields from the default fields, and # will
157              compact specified fields (removing them when empty for all
158              rows.)  Use -o help to view the list of all available fields.
159              Use separate lists of fields to add, remove or compact by
160              repeating the -o option: -o+field1,field2 -o-field3,field4
161              -o#field5.  These lists are evaluated from left to right.  Use
162              field name lv_all to view all LV fields, vg_all all VG fields,
163              pv_all all PV fields, pvseg_all all PV segment fields, seg_all
164              all LV segment fields, and pvseg_all all PV segment columns.
165              See the lvm.conf report section for more config options.  See
166              lvmreport(7) for more information about reporting.
167
168       --profile String
169              An alias for --commandprofile or --metadataprofile, depending on
170              the command.
171
172       -q|--quiet ...
173              Suppress output and log messages. Overrides --debug and --ver‐
174              bose.  Repeat once to also suppress any prompts with answer
175              'no'.
176
177       --readonly
178              Run the command in a special read-only mode which will read on-
179              disk metadata without needing to take any locks. This can be
180              used to peek inside metadata used by a virtual machine image
181              while the virtual machine is running.  It can also be used to
182              peek inside the metadata of clustered VGs when clustered locking
183              is not configured or running. No attempt will be made to commu‐
184              nicate with the device-mapper kernel driver, so this option is
185              unable to report whether or not LVs are actually in use.
186
187       --reportformat basic|json
188              Overrides current output format for reports which is defined
189              globally by the report/output_format setting in lvm.conf.  basic
190              is the original format with columns and rows.  If there is more
191              than one report per command, each report is prefixed with the
192              report name for identification. json produces report output in
193              JSON format. See lvmreport(7) for more information.
194
195       --segments
196
197       -S|--select String
198              Select objects for processing and reporting based on specified
199              criteria.  The criteria syntax is described by --select help and
200              lvmreport(7).  For reporting commands, one row is displayed for
201              each object matching the criteria.  See --options help for
202              selectable object fields.  Rows can be displayed with an addi‐
203              tional "selected" field (-o selected) showing 1 if the row
204              matches the selection and 0 otherwise.  For non-reporting com‐
205              mands which process LVM entities, the selection is used to
206              choose items to process.
207
208       --separator String
209              String to use to separate each column. Useful if grepping the
210              output.
211
212       --shared
213              Report/display shared VGs that would otherwise be skipped when
214              lvmlockd is not being used on the host.  See lvmlockd(8) for
215              more information about shared VGs.
216
217       -O|--sort String
218              Comma-separated ordered list of columns to sort by. Replaces the
219              default selection. Precede any column with - for a reverse sort
220              on that column.
221
222       -t|--test
223              Run in test mode. Commands will not update metadata.  This is
224              implemented by disabling all metadata writing but nevertheless
225              returning success to the calling function. This may lead to
226              unusual error messages in multi-stage operations if a tool
227              relies on reading back metadata it believes has changed but
228              hasn't.
229
230       --unbuffered
231              Produce output immediately without sorting or aligning the col‐
232              umns properly.
233
234       --units r|R|h|H|b|B|s|S|k|K|m|M|g|G|t|T|p|P|e|E
235              All sizes are output in these units: human-(r)eadable with '<'
236              rounding indicator, (h)uman-readable, (b)ytes, (s)ectors,
237              (k)ilobytes, (m)egabytes, (g)igabytes, (t)erabytes, (p)etabytes,
238              (e)xabytes.  Capitalise to use multiples of 1000 (S.I.) instead
239              of 1024.  Custom units can be specified, e.g. --units 3M.
240
241       -v|--verbose ...
242              Set verbose level. Repeat from 1 to 4 times to increase the
243              detail of messages sent to stdout and stderr.
244
245       --version
246              Display version information.
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       VG
255              Volume Group name.  See lvm(8) for valid names.
256
257       LV
258              Logical  Volume  name.  See lvm(8) for valid names.  An LV posi‐
259              tional arg generally includes the VG  name  and  LV  name,  e.g.
260              VG/LV.
261
262       Tag
263              Tag  name.  See lvm(8) for information about tag names and using
264              tags in place of a VG, LV or PV.
265
266       String
267              See the option description for information about the string con‐
268              tent.
269
270       Size[UNIT]
271              Size  is  an  input number that accepts an optional unit.  Input
272              units are always treated as base two values, regardless of capi‐
273              talization,  e.g.  'k'  and 'K' both refer to 1024.  The default
274              input unit is specified by letter, followed by |UNIT.  UNIT rep‐
275              resents  other  possible  input units: bBsSkKmMgGtTpPeE.  b|B is
276              bytes, s|S is sectors of 512 bytes, k|K  is  kilobytes,  m|M  is
277              megabytes, g|G is gigabytes, t|T is terabytes, p|P is petabytes,
278              e|E is exabytes.  (This should not be confused with  the  output
279              control --units, where capital letters mean multiple of 1000.)
280

ENVIRONMENT VARIABLES

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

SEE ALSO

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