VGS(8)                     System Manager's Manual                    VGS(8)

NAME         top

       vgs — report information about volume groups

SYNOPSIS         top

       vgs [-a|--all] [--aligned] [--binary] [--commandprofile ProfileName]
       [[--configreport ReportName] [-o|--options [+|-|#]Field1[,Field2...]
       [-O|--sort [+|-]Key1[,Key2...]]  [-S|--select Selection] ...]
       [-d|--debug] [-h|-?|--help] [--ignorelockingfailure]
       [--ignoreskippedcluster] [--logonly] [--nameprefixes] [--noheadings]
       [--nosuffix] [-P|--partial] [--reportformat {basic|json}] [--rows]
       [--separator Separator] [--unbuffered] [--units hHbBsSkKmMgGtTpPeE]
       [--unquoted] [-v|--verbose] [--version] [VolumeGroupName

DESCRIPTION         top

       vgs produces formatted output about volume groups.

OPTIONS         top

       See lvm(8) for common options.

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

              Use with --separator to align the output columns.

              Use binary values "0" or "1" instead of descriptive literal
              values for columns that have exactly two valid values to
              report (not counting the "unknown" value which denotes that
              the value could not be determined).

       --configreport  ReportName
              Make any subsequent -o, --options, -O, --sort or -S, --select
              to apply for ReportName where ReportName is either 'vg' for
              command's main report or 'log' for log report.  If
              --configreport option is not used to identify a report, then
              command's main report is assumed. The log report is available
              only if enabled by log/report_command_log lvm.conf(5) setting
              or if --logonly option is used.

              Suppress the vgs report itself and display only log report on

              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).

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

              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 current list of
              columns, '-' to remove from the current list of columns or '#'
              to compact given columns. The -o option can be repeated,
              providing several lists. These lists are evaluated from left
              to right.

              Use -o vg_all to select all volume group columns.

              Use -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, vg_profile, max_lv, max_pv, pv_count, lv_count,
              snap_count, vg_seqno, vg_tags, vg_mda_count, vg_mda_free, and
              vg_mda_size, vg_mda_used_count.

              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  Permissions: (w)riteable, (r)ead-only

              2  Resi(z)eable

              3  E(x)ported

              4  (p)artial: one or more physical volumes belonging to the
                 volume group are missing from the system

              5  Allocation policy: (c)ontiguous, c(l)ing, (n)ormal,

              6  (c)lustered, (s)hared

       -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.

       -S, --select Selection
              Display only rows that match Selection criteria. All rows are
              displayed with the additional "selected" column (-o selected)
              showing 1 if the row matches the Selection and 0 otherwise.
              The Selection criteria are defined by specifying column names
              and their valid values (that can include reserved values)
              while making use of supported comparison operators. See lvm(8)
              and -S, --select description for more detailed information
              about constructing the Selection criteria. As a quick help and
              to see full list of column names that can be used in Selection
              including the list of reserved values and the set of supported
              selection operators, check the output of vgs -S help command.

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

              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

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

SEE ALSO         top

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

COLOPHON         top

       This page is part of the lvm2 (Logical Volume Manager 2) project.
       Information about the project can be found at 
       ⟨⟩.  If you have a bug report for this
       manual page, send it to  This page was obtained
       from the project's upstream Git repository 
       ⟨⟩ on 2017-03-13.  If you
       discover any rendering problems in this HTML version of the page, or
       you believe there is a better or more up-to-date source for the page,
       or you have corrections or improvements to the information in this
       COLOPHON (which is not part of the original manual page), send a mail

Sistina Software UKLVM TOOLS 2.02.169(2)-git (2016-11-30)             VGS(8)