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           [    --reportformat basic|json ]
38           [    --shared ]
39           [    --separator String ]
40           [    --unbuffered ]
41           [    --units r|R|h|H|b|B|s|S|k|K|m|M|g|G|t|T|p|P|e|E ]
42           [ COMMON_OPTIONS ]
43           [ VG|Tag ... ]
44
45       Common options for lvm:
46           [ -d|--debug ]
47           [ -h|--help ]
48           [ -q|--quiet ]
49           [ -t|--test ]
50           [ -v|--verbose ]
51           [ -y|--yes ]
52           [    --commandprofile String ]
53           [    --config String ]
54           [    --driverloaded y|n ]
55           [    --lockopt String ]
56           [    --longhelp ]
57           [    --nolocking ]
58           [    --profile String ]
59           [    --version ]
60

OPTIONS

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

VARIABLES

237       VG
238              Volume Group name.  See lvm(8) for valid names.
239
240       Tag
241              Tag  name.  See lvm(8) for information about tag names and using
242              tags in place of a VG, LV or PV.
243
244       String
245              See the option description for information about the string con‐
246              tent.
247
248       Size[UNIT]
249              Size  is  an  input number that accepts an optional unit.  Input
250              units are always treated as base two values, regardless of capi‐
251              talization,  e.g.  'k'  and 'K' both refer to 1024.  The default
252              input unit is specified by letter, followed by |UNIT.  UNIT rep‐
253              resents  other  possible  input units: bBsSkKmMgGtTpPeE.  b|B is
254              bytes, s|S is sectors of 512 bytes, k|K is KiB, m|M is MiB,  g|G
255              is GiB, t|T is TiB, p|P is PiB, e|E is EiB.  (This should not be
256              confused with the output control --units, where capital  letters
257              mean multiple of 1000.)
258

ENVIRONMENT VARIABLES

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

SEE ALSO

265       lvm(8) lvm.conf(5) lvmconfig(8)
266
267       pvchange(8)  pvck(8)  pvcreate(8)  pvdisplay(8)  pvmove(8)  pvremove(8)
268       pvresize(8) pvs(8) pvscan(8)
269
270       vgcfgbackup(8) vgcfgrestore(8) vgchange(8) vgck(8)  vgcreate(8)  vgcon‐
271       vert(8)  vgdisplay(8)  vgexport(8)  vgextend(8)  vgimport(8)  vgimport‐
272       clone(8) vgmerge(8) vgmknodes(8)  vgreduce(8)  vgremove(8)  vgrename(8)
273       vgs(8) vgscan(8) vgsplit(8)
274
275       lvcreate(8)  lvchange(8)  lvconvert(8)  lvdisplay(8)  lvextend(8) lvre‐
276       duce(8) lvremove(8) lvrename(8) lvresize(8) lvs(8) lvscan(8)
277
278       lvm-fullreport(8) lvm-lvpoll(8) lvm2-activation-generator(8) blkdeacti‐
279       vate(8) lvmdump(8)
280
281       dmeventd(8)  lvmpolld(8)  lvmlockd(8)  lvmlockctl(8)  cmirrord(8) lvmd‐
282       busd(8)
283
284       lvmsystemid(7) lvmreport(7) lvmraid(7) lvmthin(7) lvmcache(7)
285
286
287
288Red Hat, Inc.          LVM TOOLS 2.03.11(2) (2021-01-08)          VGDISPLAY(8)
Impressum