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|json_std ]
33 [ --rows ]
34 [ --separator String ]
35 [ --shared ]
36 [ --unbuffered ]
37 [ --units [Number]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 [ --devices PV ]
52 [ --devicesfile String ]
53 [ --driverloaded y|n ]
54 [ --journal String ]
55 [ --lockopt String ]
56 [ --longhelp ]
57 [ --nohints ]
58 [ --nolocking ]
59 [ --profile String ]
60 [ --version ]
61
63 --aligned
64 Use with --separator to align the output columns
65 -a|--all
67 List all VGs. Equivalent to not specifying any VGs.
68 --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 --commandprofile String
76 The command profile to use for command configuration. See
77 lvm.conf(5) for more information about profiles.
78 --config String
80 Config settings for the command. These override lvm.conf(5) set‐
81 tings. The String arg uses the same format as lvm.conf(5), or
82 may use section/field syntax. See lvm.conf(5) for more informa‐
83 tion about config.
84 --configreport log|vg|lv|pv|pvseg|seg
86 See lvmreport(7).
87 -d|--debug ...
89 Set debug level. Repeat from 1 to 6 times to increase the detail
90 of messages sent to the log file and/or syslog (if configured).
91 --devices PV
93 Restricts the devices that are visible and accessible to the
94 command. Devices not listed will appear to be missing. This op‐
95 tion can be repeated, or accepts a comma separated list of de‐
96 vices. This overrides the devices file.
97 --devicesfile String
99 A file listing devices that LVM should use. The file must exist
100 in /etc/lvm/devices/ and is managed with the lvmdevices(8) com‐
101 mand. This overrides the lvm.conf(5) devices/devicesfile and
102 devices/use_devicesfile settings.
103 --driverloaded y|n
105 If set to no, the command will not attempt to use device-mapper.
106 For testing and debugging.
107 --foreign
109 Report/display foreign VGs that would otherwise be skipped. See
110 lvmsystemid(7) for more information about foreign VGs.
111 -h|--help
113 Display help text.
114 --ignorelockingfailure
116 Allows a command to continue with read-only metadata operations
117 after locking failures.
118 --journal String
120 Record information in the systemd journal. This information is
121 in addition to information enabled by the lvm.conf log/journal
122 setting. command: record information about the command. out‐
123 put: record the default command output. debug: record full com‐
124 mand debugging.
125 --lockopt String
127 Used to pass options for special cases to lvmlockd. See lvm‐
128 lockd(8) for more information.
129 --logonly
131 Suppress command report and display only log report.
132 --longhelp
134 Display long help text.
135 --nameprefixes
137 Add an "LVM2_" prefix plus the field name to the output. Useful
138 with --noheadings to produce a list of field=value pairs that
139 can be used to set environment variables (for example, in udev
140 rules).
141 --noheadings
143 Suppress the headings line that is normally the first line of
144 output. Useful if grepping the output.
145 --nohints
147 Do not use the hints file to locate devices for PVs. A command
148 may read more devices to find PVs when hints are not used. The
149 command will still perform standard hint file invalidation where
150 appropriate.
151 --nolocking
153 Disable locking. Use with caution, concurrent commands may pro‐
154 duce incorrect results.
155 --nosuffix
157 Suppress the suffix on output sizes. Use with --units (except h
158 and H) if processing the output.
159 -o|--options String
161 Comma-separated, ordered list of fields to display in columns.
162 String arg syntax is: [+|-|#]Field1[,Field2 ...] The prefix +
163 will append the specified fields to the default fields, - will
164 remove the specified fields from the default fields, and # will
165 compact specified fields (removing them when empty for all
166 rows.) Use -o help to view the list of all available fields.
167 Use separate lists of fields to add, remove or compact by re‐
168 peating the -o option: -o+field1,field2 -o-field3,field4
169 -o#field5. These lists are evaluated from left to right. Use
170 field name lv_all to view all LV fields, vg_all all VG fields,
171 pv_all all PV fields, pvseg_all all PV segment fields, seg_all
172 all LV segment fields, and pvseg_all all PV segment columns.
173 See the lvm.conf(5) report section for more config options. See
174 lvmreport(7) for more information about reporting.
175 --profile String
177 An alias for --commandprofile or --metadataprofile, depending on
178 the command.
179 -q|--quiet ...
181 Suppress output and log messages. Overrides --debug and --ver‐
182 bose. Repeat once to also suppress any prompts with answer
183 'no'.
184 --readonly
186 Run the command in a special read-only mode which will read on-
187 disk metadata without needing to take any locks. This can be
188 used to peek inside metadata used by a virtual machine image
189 while the virtual machine is running. No attempt will be made to
190 communicate with the device-mapper kernel driver, so this option
191 is unable to report whether or not LVs are actually in use.
192 --reportformat basic|json|json_std
194 Overrides current output format for reports which is defined
195 globally by the report/output_format setting in lvm.conf(5).
196 basic is the original format with columns and rows. If there is
197 more than one report per command, each report is prefixed with
198 the report name for identification. json produces report output
199 in JSON format. json_std produces report output in JSON format
200 which is more compliant with JSON standard. See lvmreport(7)
201 for more information.
202 --rows
204 Output columns as rows.
205 -S|--select String
207 Select objects for processing and reporting based on specified
208 criteria. The criteria syntax is described by --select help and
209 lvmreport(7). For reporting commands, one row is displayed for
210 each object matching the criteria. See --options help for se‐
211 lectable object fields. Rows can be displayed with an addition‐
212 al "selected" field (-o selected) showing 1 if the row matches
213 the selection and 0 otherwise. For non-reporting commands which
214 process LVM entities, the selection is used to choose items to
215 process.
216 --separator String
218 String to use to separate each column. Useful if grepping the
219 output.
220 --shared
222 Report/display shared VGs that would otherwise be skipped when
223 lvmlockd is not being used on the host. See lvmlockd(8) for
224 more information about shared VGs.
225 -O|--sort String
227 Comma-separated ordered list of columns to sort by. Replaces the
228 default selection. Precede any column with - for a reverse sort
229 on that column.
230 -t|--test
232 Run in test mode. Commands will not update metadata. This is
233 implemented by disabling all metadata writing but nevertheless
234 returning success to the calling function. This may lead to un‐
235 usual error messages in multi-stage operations if a tool relies
236 on reading back metadata it believes has changed but hasn't.
237 --unbuffered
239 Produce output immediately without sorting or aligning the col‐
240 umns properly.
241 --units [Number]r|R|h|H|b|B|s|S|k|K|m|M|g|G|t|T|p|P|e|E
243 All sizes are output in these units: human-(r)eadable with '<'
244 rounding indicator, (h)uman-readable, (b)ytes, (s)ectors,
245 (k)ilobytes, (m)egabytes, (g)igabytes, (t)erabytes, (p)etabytes,
246 (e)xabytes. Capitalise to use multiples of 1000 (S.I.) instead
247 of 1024. Custom units can be specified, e.g. --units 3M.
248 --unquoted
250 When used with --nameprefixes, output values in the field=value
251 pairs are not quoted.
252 -v|--verbose ...
254 Set verbose level. Repeat from 1 to 4 times to increase the de‐
255 tail of messages sent to stdout and stderr.
256 --version
258 Display version information.
259 -y|--yes
261 Do not prompt for confirmation interactively but always assume
262 the answer yes. Use with extreme caution. (For automatic no,
263 see -qq.)
264
266 VG Volume Group name. See lvm(8) for valid names.
267 Tag Tag name. See lvm(8) for information about tag names and using
269 tags in place of a VG, LV or PV.
270 String See the option description for information about the string con‐
272 tent.
273 Size[UNIT]
275 Size is an input number that accepts an optional unit. Input
276 units are always treated as base two values, regardless of capi‐
277 talization, e.g. 'k' and 'K' both refer to 1024. The default
278 input unit is specified by letter, followed by |UNIT. UNIT rep‐
279 resents other possible input units: b|B is bytes, s|S is sectors
280 of 512 bytes, k|K is KiB, m|M is MiB, g|G is GiB, t|T is TiB,
281 p|P is PiB, e|E is EiB. (This should not be confused with the
282 output control --units, where capital letters mean multiple of
283 1000.)
284
286 See lvm(8) for information about environment variables used by lvm.
287 For example, LVM_VG_NAME can generally be substituted for a required VG
288 parameter.
289
291 The vg_attr bits are:
292 1 Permissions: (w)riteable, (r)ead-only
294 2 Resi(z)eable
296 3 E(x)ported
298 4 (p)artial: one or more physical volumes belonging to the volume
300 group are missing from the system
301 5 Allocation policy: (c)ontiguous, c(l)ing, (n)ormal, (a)nywhere
303 6 (c)lustered, (s)hared
305
307 lvm(8), lvm.conf(5), lvmconfig(8), lvmdevices(8),
308 pvchange(8), pvck(8), pvcreate(8), pvdisplay(8), pvmove(8),
310 pvremove(8), pvresize(8), pvs(8), pvscan(8),
311 vgcfgbackup(8), vgcfgrestore(8), vgchange(8), vgck(8), vgcreate(8),
313 vgconvert(8), vgdisplay(8), vgexport(8), vgextend(8), vgimport(8),
314 vgimportclone(8), vgimportdevices(8), vgmerge(8), vgmknodes(8),
315 vgreduce(8), vgremove(8), vgrename(8), vgs(8), vgscan(8), vgsplit(8),
316 lvcreate(8), lvchange(8), lvconvert(8), lvdisplay(8), lvextend(8),
318 lvreduce(8), lvremove(8), lvrename(8), lvresize(8), lvs(8), lvscan(8),
319 lvm-fullreport(8), lvm-lvpoll(8), blkdeactivate(8), lvmdump(8),
321 dmeventd(8), lvmpolld(8), lvmlockd(8), lvmlockctl(8), cmirrord(8),
323 lvmdbusd(8), fsadm(8),
324 lvmsystemid(7), lvmreport(7), lvmraid(7), lvmthin(7), lvmcache(7)
326Red Hat, Inc. LVM TOOLS 2.03.18(2)-git (2022-11-10) VGS(8)