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

NAME

6       vgs - Display information about volume groups
7

SYNOPSIS

9       vgs
10           [ option_args ]
11           [ position_args ]
12

DESCRIPTION

14       vgs produces formatted output about VGs.
15

USAGE

17       vgs
18           [ -a|--all ]
19           [ -o|--options String ]
20           [ -S|--select String ]
21           [ -O|--sort String ]
22           [    --aligned ]
23           [    --binary ]
24           [    --configreport log|vg|lv|pv|pvseg|seg ]
25           [    --foreign ]
26           [    --ignorelockingfailure ]
27           [    --ignoreskippedcluster ]
28           [    --logonly ]
29           [    --nameprefixes ]
30           [    --noheadings ]
31           [    --nolocking ]
32           [    --nosuffix ]
33           [    --readonly ]
34           [    --reportformat basic|json ]
35           [    --rows ]
36           [    --separator String ]
37           [    --shared ]
38           [    --trustcache ]
39           [    --unbuffered ]
40           [    --units r|R|h|H|b|B|s|S|k|K|m|M|g|G|t|T|p|P|e|E ]
41           [    --unquoted ]
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           [    --profile String ]
58           [    --version ]
59

OPTIONS

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

VARIABLES

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

ENVIRONMENT VARIABLES

270       See  lvm(8)  for  information  about environment variables used by lvm.
271       For example, LVM_VG_NAME can generally be substituted for a required VG
272       parameter.
273

NOTES

275       The vg_attr bits are:
276
277       1  Permissions: (w)riteable, (r)ead-only
278
279       2  Resi(z)eable
280
281       3  E(x)ported
282
283       4  (p)artial:  one  or  more  physical  volumes belonging to the volume
284          group are missing from the system
285
286       5  Allocation policy: (c)ontiguous, c(l)ing, (n)ormal, (a)nywhere
287
288       6  (c)lustered, (s)hared
289

SEE ALSO

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