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           [    --ignoreskippedcluster ]
34           [    --logonly ]
35           [    --noheadings ]
36           [    --nosuffix ]
37           [    --readonly ]
38           [    --reportformat basic|json ]
39           [    --shared ]
40           [    --separator String ]
41           [    --unbuffered ]
42           [    --units r|R|h|H|b|B|s|S|k|K|m|M|g|G|t|T|p|P|e|E ]
43           [ COMMON_OPTIONS ]
44           [ VG|Tag ... ]
45
46       Common options for lvm:
47           [ -d|--debug ]
48           [ -h|--help ]
49           [ -q|--quiet ]
50           [ -t|--test ]
51           [ -v|--verbose ]
52           [ -y|--yes ]
53           [    --commandprofile String ]
54           [    --config String ]
55           [    --driverloaded y|n ]
56           [    --lockopt String ]
57           [    --longhelp ]
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       --ignoreskippedcluster
117              Use to avoid exiting with an non-zero status code if the command
118              is run without clustered locking and clustered VGs are skipped.
119
120       --lockopt String
121              Used to pass options for special cases to lvmlockd.  See lvm‐
122              lockd(8) for more information.
123
124       --logonly
125              Suppress command report and display only log report.
126
127       --longhelp
128              Display long help text.
129
130       --noheadings
131              Suppress the headings line that is normally the first line of
132              output.  Useful if grepping the output.
133
134       --nosuffix
135              Suppress the suffix on output sizes. Use with --units (except h
136              and H) if processing the output.
137
138       -o|--options String
139              Comma-separated, ordered list of fields to display in columns.
140              String arg syntax is: [+|-|#]Field1[,Field2 ...]  The prefix +
141              will append the specified fields to the default fields, - will
142              remove the specified fields from the default fields, and # will
143              compact specified fields (removing them when empty for all
144              rows.)  Use -o help to view the list of all available fields.
145              Use separate lists of fields to add, remove or compact by
146              repeating the -o option: -o+field1,field2 -o-field3,field4
147              -o#field5.  These lists are evaluated from left to right.  Use
148              field name lv_all to view all LV fields, vg_all all VG fields,
149              pv_all all PV fields, pvseg_all all PV segment fields, seg_all
150              all LV segment fields, and pvseg_all all PV segment columns.
151              See the lvm.conf report section for more config options.  See
152              lvmreport(7) for more information about reporting.
153
154       --profile String
155              An alias for --commandprofile or --metadataprofile, depending on
156              the command.
157
158       -q|--quiet ...
159              Suppress output and log messages. Overrides --debug and --ver‐
160              bose.  Repeat once to also suppress any prompts with answer
161              'no'.
162
163       --readonly
164              Run the command in a special read-only mode which will read on-
165              disk metadata without needing to take any locks. This can be
166              used to peek inside metadata used by a virtual machine image
167              while the virtual machine is running.  It can also be used to
168              peek inside the metadata of clustered VGs when clustered locking
169              is not configured or running. No attempt will be made to commu‐
170              nicate with the device-mapper kernel driver, so this option is
171              unable to report whether or not LVs are actually in use.
172
173       --reportformat basic|json
174              Overrides current output format for reports which is defined
175              globally by the report/output_format setting in lvm.conf.  basic
176              is the original format with columns and rows.  If there is more
177              than one report per command, each report is prefixed with the
178              report name for identification. json produces report output in
179              JSON format. See lvmreport(7) for more information.
180
181       -S|--select String
182              Select objects for processing and reporting based on specified
183              criteria.  The criteria syntax is described by --select help and
184              lvmreport(7).  For reporting commands, one row is displayed for
185              each object matching the criteria.  See --options help for
186              selectable object fields.  Rows can be displayed with an addi‐
187              tional "selected" field (-o selected) showing 1 if the row
188              matches the selection and 0 otherwise.  For non-reporting com‐
189              mands which process LVM entities, the selection is used to
190              choose items to process.
191
192       --separator String
193              String to use to separate each column. Useful if grepping the
194              output.
195
196       --shared
197              Report/display shared VGs that would otherwise be skipped when
198              lvmlockd is not being used on the host.  See lvmlockd(8) for
199              more information about shared VGs.
200
201       -s|--short
202              Give a short listing showing the existence of VGs.
203
204       -O|--sort String
205              Comma-separated ordered list of columns to sort by. Replaces the
206              default selection. Precede any column with - for a reverse sort
207              on that column.
208
209       -t|--test
210              Run in test mode. Commands will not update metadata.  This is
211              implemented by disabling all metadata writing but nevertheless
212              returning success to the calling function. This may lead to
213              unusual error messages in multi-stage operations if a tool
214              relies on reading back metadata it believes has changed but
215              hasn't.
216
217       --unbuffered
218              Produce output immediately without sorting or aligning the col‐
219              umns properly.
220
221       --units r|R|h|H|b|B|s|S|k|K|m|M|g|G|t|T|p|P|e|E
222              All sizes are output in these units: human-(r)eadable with '<'
223              rounding indicator, (h)uman-readable, (b)ytes, (s)ectors,
224              (k)ilobytes, (m)egabytes, (g)igabytes, (t)erabytes, (p)etabytes,
225              (e)xabytes.  Capitalise to use multiples of 1000 (S.I.) instead
226              of 1024.  Custom units can be specified, e.g. --units 3M.
227
228       -v|--verbose ...
229              Set verbose level. Repeat from 1 to 4 times to increase the
230              detail of messages sent to stdout and stderr.
231
232       --version
233              Display version information.
234
235       -y|--yes
236              Do not prompt for confirmation interactively but always assume
237              the answer yes. Use with extreme caution.  (For automatic no,
238              see -qq.)
239

VARIABLES

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

ENVIRONMENT VARIABLES

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

SEE ALSO

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