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

NAME

6       vgdisplay — Display volume group information
7

SYNOPSIS

9       vgdisplay
10           [ option_args ]
11           [ position_args ]
12

DESCRIPTION

14       vgdisplay shows the attributes of VGs, and the associated PVs and LVs.
15
16       vgs(8)  is  a preferred alternative that shows the same information and
17       more, using a more compact and configurable output format.
18

USAGE

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

OPTIONS

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

VARIABLES

258       VG     Volume Group name.  See lvm(8) for valid names.
259
260       Tag    Tag name.  See lvm(8) for information about tag names and  using
261              tags in place of a VG, LV or PV.
262
263       String 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: b|B is bytes, s|S is sectors
272              of  512  bytes,  k|K is KiB, m|M is MiB, g|G is GiB, t|T is TiB,
273              p|P is PiB, e|E is EiB.  (This should not be confused  with  the
274              output  control  --units, where capital letters mean multiple of
275              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), lvmdevices(8),
284
285       pvchange(8), pvck(8), pvcreate(8), pvdisplay(8), pvmove(8),
286       pvremove(8), pvresize(8), pvs(8), pvscan(8),
287
288       vgcfgbackup(8), vgcfgrestore(8), vgchange(8), vgck(8), vgcreate(8),
289       vgconvert(8), vgdisplay(8), vgexport(8), vgextend(8), vgimport(8),
290       vgimportclone(8), vgimportdevices(8), vgmerge(8), vgmknodes(8),
291       vgreduce(8), vgremove(8), vgrename(8), vgs(8), vgscan(8), vgsplit(8),
292
293       lvcreate(8), lvchange(8), lvconvert(8), lvdisplay(8), lvextend(8),
294       lvreduce(8), lvremove(8), lvrename(8), lvresize(8), lvs(8), lvscan(8),
295
296       lvm-fullreport(8), lvm-lvpoll(8), blkdeactivate(8), lvmdump(8),
297
298       dmeventd(8), lvmpolld(8), lvmlockd(8), lvmlockctl(8), cmirrord(8),
299       lvmdbusd(8), fsadm(8),
300
301       lvmsystemid(7), lvmreport(7), lvmraid(7), lvmthin(7), lvmcache(7)
302
303
304
305Red Hat, Inc.        LVM TOOLS 2.03.18(2)-git (2022-11-10)        VGDISPLAY(8)
Impressum