1VGS(8) System Manager's Manual VGS(8)
2
6 vgs - Display information about volume groups
7
9 vgs
10 [ option_args ]
11 [ position_args ]
12
14 vgs produces formatted output about VGs.
15
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 [ --unbuffered ]
37 [ --units r|R|h|H|b|B|s|S|k|K|m|M|g|G|t|T|p|P|e|E ]
38 [ --unquoted ]
39 [ COMMON_OPTIONS ]
40 [ VG|Tag ... ]
41 Common options for lvm:
43 [ -d|--debug ]
44 [ -h|--help ]
45 [ -q|--quiet ]
46 [ -t|--test ]
47 [ -v|--verbose ]
48 [ -y|--yes ]
49 [ --commandprofile String ]
50 [ --config String ]
51 [ --driverloaded y|n ]
52 [ --lockopt String ]
53 [ --longhelp ]
54 [ --nolocking ]
55 [ --profile String ]
56 [ --version ]
57
59 --aligned
60 Use with --separator to align the output columns
61 -a|--all
63 List all VGs. Equivalent to not specifying any VGs.
64 --binary
66 Use binary values "0" or "1" instead of descriptive literal val‐
67 ues for columns that have exactly two valid values to report
68 (not counting the "unknown" value which denotes that the value
69 could not be determined).
70 --commandprofile String
72 The command profile to use for command configuration. See
73 lvm.conf(5) for more information about profiles.
74 --config String
76 Config settings for the command. These override lvm.conf set‐
77 tings. The String arg uses the same format as lvm.conf, or may
78 use section/field syntax. See lvm.conf(5) for more information
79 about config.
80 --configreport log|vg|lv|pv|pvseg|seg
82 See lvmreport(7).
83 -d|--debug ...
85 Set debug level. Repeat from 1 to 6 times to increase the detail
86 of messages sent to the log file and/or syslog (if configured).
87 --driverloaded y|n
89 If set to no, the command will not attempt to use device-mapper.
90 For testing and debugging.
91 --foreign
93 Report/display foreign VGs that would otherwise be skipped. See
94 lvmsystemid(7) for more information about foreign VGs.
95 -h|--help
97 Display help text.
98 --ignorelockingfailure
100 Allows a command to continue with read-only metadata operations
101 after locking failures.
102 --lockopt String
104 Used to pass options for special cases to lvmlockd. See lvm‐
105 lockd(8) for more information.
106 --logonly
108 Suppress command report and display only log report.
109 --longhelp
111 Display long help text.
112 --nameprefixes
114 Add an "LVM2_" prefix plus the field name to the output. Useful
115 with --noheadings to produce a list of field=value pairs that
116 can be used to set environment variables (for example, in udev
117 rules).
118 --noheadings
120 Suppress the headings line that is normally the first line of
121 output. Useful if grepping the output.
122 --nolocking
124 Disable locking.
125 --nosuffix
127 Suppress the suffix on output sizes. Use with --units (except h
128 and H) if processing the output.
129 -o|--options String
131 Comma-separated, ordered list of fields to display in columns.
132 String arg syntax is: [+|-|#]Field1[,Field2 ...] The prefix +
133 will append the specified fields to the default fields, - will
134 remove the specified fields from the default fields, and # will
135 compact specified fields (removing them when empty for all
136 rows.) Use -o help to view the list of all available fields.
137 Use separate lists of fields to add, remove or compact by re‐
138 peating the -o option: -o+field1,field2 -o-field3,field4
139 -o#field5. These lists are evaluated from left to right. Use
140 field name lv_all to view all LV fields, vg_all all VG fields,
141 pv_all all PV fields, pvseg_all all PV segment fields, seg_all
142 all LV segment fields, and pvseg_all all PV segment columns.
143 See the lvm.conf report section for more config options. See
144 lvmreport(7) for more information about reporting.
145 --profile String
147 An alias for --commandprofile or --metadataprofile, depending on
148 the command.
149 -q|--quiet ...
151 Suppress output and log messages. Overrides --debug and --ver‐
152 bose. Repeat once to also suppress any prompts with answer
153 'no'.
154 --readonly
156 Run the command in a special read-only mode which will read on-
157 disk metadata without needing to take any locks. This can be
158 used to peek inside metadata used by a virtual machine image
159 while the virtual machine is running. No attempt will be made to
160 communicate with the device-mapper kernel driver, so this option
161 is unable to report whether or not LVs are actually in use.
162 --reportformat basic|json
164 Overrides current output format for reports which is defined
165 globally by the report/output_format setting in lvm.conf. basic
166 is the original format with columns and rows. If there is more
167 than one report per command, each report is prefixed with the
168 report name for identification. json produces report output in
169 JSON format. See lvmreport(7) for more information.
170 --rows
172 Output columns as rows.
173 -S|--select String
175 Select objects for processing and reporting based on specified
176 criteria. The criteria syntax is described by --select help and
177 lvmreport(7). For reporting commands, one row is displayed for
178 each object matching the criteria. See --options help for se‐
179 lectable object fields. Rows can be displayed with an addi‐
180 tional "selected" field (-o selected) showing 1 if the row
181 matches the selection and 0 otherwise. For non-reporting com‐
182 mands which process LVM entities, the selection is used to
183 choose items to process.
184 --separator String
186 String to use to separate each column. Useful if grepping the
187 output.
188 --shared
190 Report/display shared VGs that would otherwise be skipped when
191 lvmlockd is not being used on the host. See lvmlockd(8) for
192 more information about shared VGs.
193 -O|--sort String
195 Comma-separated ordered list of columns to sort by. Replaces the
196 default selection. Precede any column with - for a reverse sort
197 on that column.
198 -t|--test
200 Run in test mode. Commands will not update metadata. This is
201 implemented by disabling all metadata writing but nevertheless
202 returning success to the calling function. This may lead to un‐
203 usual error messages in multi-stage operations if a tool relies
204 on reading back metadata it believes has changed but hasn't.
205 --unbuffered
207 Produce output immediately without sorting or aligning the col‐
208 umns properly.
209 --units r|R|h|H|b|B|s|S|k|K|m|M|g|G|t|T|p|P|e|E
211 All sizes are output in these units: human-(r)eadable with '<'
212 rounding indicator, (h)uman-readable, (b)ytes, (s)ectors,
213 (k)ilobytes, (m)egabytes, (g)igabytes, (t)erabytes, (p)etabytes,
214 (e)xabytes. Capitalise to use multiples of 1000 (S.I.) instead
215 of 1024. Custom units can be specified, e.g. --units 3M.
216 --unquoted
218 When used with --nameprefixes, output values in the field=value
219 pairs are not quoted.
220 -v|--verbose ...
222 Set verbose level. Repeat from 1 to 4 times to increase the de‐
223 tail of messages sent to stdout and stderr.
224 --version
226 Display version information.
227 -y|--yes
229 Do not prompt for confirmation interactively but always assume
230 the answer yes. Use with extreme caution. (For automatic no,
231 see -qq.)
232
234 VG
235 Volume Group name. See lvm(8) for valid names.
236 Tag
238 Tag name. See lvm(8) for information about tag names and using
239 tags in place of a VG, LV or PV.
240 String
242 See the option description for information about the string con‐
243 tent.
244 Size[UNIT]
246 Size is an input number that accepts an optional unit. Input
247 units are always treated as base two values, regardless of capi‐
248 talization, e.g. 'k' and 'K' both refer to 1024. The default
249 input unit is specified by letter, followed by |UNIT. UNIT rep‐
250 resents other possible input units: bBsSkKmMgGtTpPeE. b|B is
251 bytes, s|S is sectors of 512 bytes, k|K is KiB, m|M is MiB, g|G
252 is GiB, t|T is TiB, p|P is PiB, e|E is EiB. (This should not be
253 confused with the output control --units, where capital letters
254 mean multiple of 1000.)
255
257 See lvm(8) for information about environment variables used by lvm.
258 For example, LVM_VG_NAME can generally be substituted for a required VG
259 parameter.
260
262 The vg_attr bits are:
263 1 Permissions: (w)riteable, (r)ead-only
265 2 Resi(z)eable
267 3 E(x)ported
269 4 (p)artial: one or more physical volumes belonging to the volume
271 group are missing from the system
272 5 Allocation policy: (c)ontiguous, c(l)ing, (n)ormal, (a)nywhere
274 6 (c)lustered, (s)hared
276
278 lvm(8) lvm.conf(5) lvmconfig(8)
279 pvchange(8) pvck(8) pvcreate(8) pvdisplay(8) pvmove(8) pvremove(8)
281 pvresize(8) pvs(8) pvscan(8)
282 vgcfgbackup(8) vgcfgrestore(8) vgchange(8) vgck(8) vgcreate(8) vgcon‐
284 vert(8) vgdisplay(8) vgexport(8) vgextend(8) vgimport(8) vgimport‐
285 clone(8) vgmerge(8) vgmknodes(8) vgreduce(8) vgremove(8) vgrename(8)
286 vgs(8) vgscan(8) vgsplit(8)
287 lvcreate(8) lvchange(8) lvconvert(8) lvdisplay(8) lvextend(8) lvre‐
289 duce(8) lvremove(8) lvrename(8) lvresize(8) lvs(8) lvscan(8)
290 lvm-fullreport(8) lvm-lvpoll(8) lvm2-activation-generator(8) blkdeacti‐
292 vate(8) lvmdump(8)
293 dmeventd(8) lvmpolld(8) lvmlockd(8) lvmlockctl(8) cmirrord(8) lvmd‐
295 busd(8)
296 lvmsystemid(7) lvmreport(7) lvmraid(7) lvmthin(7) lvmcache(7)
298Red Hat, Inc. LVM TOOLS 2.03.11(2) (2021-01-08) VGS(8)