xref: /dragonfly/contrib/lvm2/dist/man/vgs.8.in (revision 0ca59c34)
VGS 8 "LVM TOOLS #VERSION#" "Sistina Software UK" \" -*- nroff -*-
NAME
vgs - report information about volume groups
SYNOPSIS
vgs [-a|--all] [--aligned] [-d|--debug] [-h|-?|--help] [--ignorelockingfailure] [--nameprefixes] [--noheadings] [--nosuffix] [-o|--options [+]Field[,Field]] [-O|--sort [+|-]Key1[,[+|-]Key2[,...]]] [-P|--partial] [--rows] [--separator Separator] [--unbuffered] [--units hHbBsSkKmMgGtTpPeE] [--unquoted] [-v|--verbose] [--version] [VolumeGroupName [VolumeGroupName...]]
DESCRIPTION
vgs produces formatted output about volume groups.
OPTIONS
See lvm for common options.

--all List all volume groups. Equivalent to not specifying any volume groups.

--aligned Use with --separator to align the output columns.

--nameprefixes Add an "LVM2_" prefix plus the field name to the output. Useful with --noheadings to produce a list of field=value pairs that can be used to set environment variables (for example, in udev (7) rules).

--noheadings Suppress the headings line that is normally the first line of output. Useful if grepping the output.

--nosuffix Suppress the suffix on output sizes. Use with --units (except h and H) if processing the output.

-o, --options Comma-separated ordered list of columns. Precede the list with '+' to append to the default selection of columns.

Use \fb-o vg_all to select all volume group columns.
Use \fb-o help to view the full list of columns available.
Column names include: vg_fmt, vg_uuid, vg_name, vg_attr, vg_size, vg_free, vg_sysid, vg_extent_size, vg_extent_count, vg_free_count, max_lv, max_pv, pv_count, lv_count, snap_count, vg_seqno, vg_tags, vg_mda_count, vg_mda_free, and vg_mda_size.
Any "vg_" prefixes are optional. Columns mentioned in either pvs (8) or lvs (8) can also be chosen, but columns cannot be taken from both at the same time.
The vg_attr bits are:

1 3
Permissions: (w)riteable, (r)ead-only
2 3
Resi(z)eable
3 3
E(x)ported
4 3
(p)artial: one or more physical volumes belonging to the volume group are missing from the system
5 3
Allocation policy: (c)ontiguous, c(l)ing, (n)ormal, (a)nywhere, (i)nherited
6 3
(c)lustered

-O, --sort Comma-separated ordered list of columns to sort by. Replaces the default selection. Precede any column with - for a reverse sort on that column.

--rows Output columns as rows.

--separator Separator String to use to separate each column. Useful if grepping the output.

--unbuffered Produce output immediately without sorting or aligning the columns properly.

--units hHbBsSkKmMgGtTpPeE All sizes are output in these units: (h)uman-readable, (b)ytes, (s)ectors, (k)ilobytes, (m)egabytes, (g)igabytes, (t)erabytes, (p)etabytes, (e)xabytes. Capitalise to use multiples of 1000 (S.I.) instead of 1024. Can also specify custom units e.g. --units 3M

--unquoted When used with --nameprefixes, output values in the field=value pairs are not quoted.

SEE ALSO
lvm (8), vgdisplay (8), pvs (8), lvs (8)