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

OPTIONS

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

VARIABLES

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

ENVIRONMENT VARIABLES

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

NOTES

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

SEE ALSO

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