# vgs - Display information about volume groups - man(8) - [phpMan]

[_VGS_(8)](https://www.chedong.com/phpMan.php/man/VGS/8/markdown)                                 System Manager's Manual                                [_VGS_(8)](https://www.chedong.com/phpMan.php/man/VGS/8/markdown)

## NAME
       vgs — Display information about volume groups

## SYNOPSIS
### vgs
           [ _option_args_ ]
           [ _position_args_ ]

## DESCRIPTION
       vgs produces formatted output about VGs.

## USAGE
### vgs
           [ **-a**|**--all **]
           [ **-o**|**--options **_String_ ]
           [ **-S**|**--select **_String_ ]
           [ **-O**|**--sort **_String_ ]
           [    **--aligned **]
           [    **--binary **]
           [    **--configreport log**|**vg**|**lv**|**pv**|**pvseg**|**seg **]
           [    **--foreign **]
           [    **--ignorelockingfailure **]
           [    **--logonly **]
           [    **--nameprefixes **]
           [    **--noheadings **]
           [    **--nosuffix **]
           [    **--readonly **]
           [    **--reportformat basic**|**json **]
           [    **--rows **]
           [    **--separator **_String_ ]
           [    **--shared **]
           [    **--unbuffered **]
           [    **--units **[_Number_]**r**|**R**|**h**|**H**|**b**|**B**|**s**|**S**|**k**|**K**|**m**|**M**|**g**|**G**|**t**|**T**|**p**|**P**|**e**|**E **]
           [    **--unquoted **]
           [ COMMON_OPTIONS ]
           [ _VG_|_Tag_ ... ]

       Common options for lvm:
           [ **-d**|**--debug **]
           [ **-h**|**--help **]
           [ **-q**|**--quiet **]
           [ **-t**|**--test **]
           [ **-v**|**--verbose **]
           [ **-y**|**--yes **]
           [    **--commandprofile **_String_ ]
           [    **--config **_String_ ]
           [    **--devices **_PV_ ]
           [    **--devicesfile **_String_ ]
           [    **--driverloaded y**|**n **]
           [    **--journal **_String_ ]
           [    **--lockopt **_String_ ]
           [    **--longhelp **]
           [    **--nohints **]
           [    **--nolocking **]
           [    **--profile **_String_ ]
           [    **--version **]

## OPTIONS


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

### -a --all
              List all VGs. Equivalent to not specifying any VGs.

### --binary
              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  de‐
              notes that the value could not be determined).

       **--commandprofile **_String_
              The command profile to use for command configuration.  See [**lvm.conf**(5)](https://www.chedong.com/phpMan.php/man/lvm.conf/5/markdown) for more infor‐
              mation about profiles.

       **--config **_String_
              Config  settings for the command. These override [**lvm.conf**(5)](https://www.chedong.com/phpMan.php/man/lvm.conf/5/markdown) settings.  The String arg
              uses the same format as [**lvm.conf**(5)](https://www.chedong.com/phpMan.php/man/lvm.conf/5/markdown), or may use section/field syntax.  See [**lvm.conf**(5)](https://www.chedong.com/phpMan.php/man/lvm.conf/5/markdown)
              for more information about config.

       **--configreport log**|**vg**|**lv**|**pv**|**pvseg**|**seg**
              See [**lvmreport**(7)](https://www.chedong.com/phpMan.php/man/lvmreport/7/markdown).

### -d --debug 
              Set debug level. Repeat from 1 to 6 times to increase the detail of messages  sent  to
              the log file and/or syslog (if configured).

       **--devices **_PV_
              Restricts  the  devices  that  are visible and accessible to the command.  Devices not
              listed will appear to be missing. This option can be repeated, or accepts a comma sep‐
              arated list of devices. This overrides the devices file.

       **--devicesfile **_String_
              A file listing devices that LVM should use.  The file must exist in  _/etc/lvm/devices/_
              and  is  managed  with  the [**lvmdevices**(8)](https://www.chedong.com/phpMan.php/man/lvmdevices/8/markdown) command.  This overrides the [**lvm.conf**(5)](https://www.chedong.com/phpMan.php/man/lvm.conf/5/markdown) **de‐**
              **vices/devicesfile **and **devices/use_devicesfile **settings.

       **--driverloaded y**|**n**
              If set to no, the command will not attempt to use device-mapper.  For testing and  de‐
              bugging.

### --foreign
              Report/display  foreign  VGs  that would otherwise be skipped.  See [**lvmsystemid**(7)](https://www.chedong.com/phpMan.php/man/lvmsystemid/7/markdown) for
              more information about foreign VGs.

### -h --help
              Display help text.

### --ignorelockingfailure
              Allows a command to continue with read-only metadata operations  after  locking  fail‐
              ures.

       **--journal **_String_
              Record  information in the systemd journal.  This information is in addition to infor‐
              mation enabled by the lvm.conf log/journal setting.  command: record information about
              the command.  output: record the default command output.  debug: record  full  command
              debugging.

       **--lockopt **_String_
              Used to pass options for special cases to lvmlockd.  See [**lvmlockd**(8)](https://www.chedong.com/phpMan.php/man/lvmlockd/8/markdown) for more informa‐
              tion.

### --logonly
              Suppress command report and display only log report.

### --longhelp
              Display long help text.

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

### --noheadings
              Suppress the headings line that is normally the first line of output.  Useful if grep‐
              ping the output.

### --nohints
              Do not use the hints file to locate devices for PVs. A command may read  more  devices
              to find PVs when hints are not used. The command will still perform standard hint file
              invalidation where appropriate.

### --nolocking
              Disable  locking. Use with caution, concurrent commands may produce incorrect results.


### --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 fields to display in columns.  String arg syntax is:
              [**+**|**-**|**#**]_Field1_[**,**_Field2_ ...]  The prefix **+ **will append the specified fields to  the  de‐
              fault  fields,  **- **will remove the specified fields from the default fields, and **# **will
              compact specified fields (removing them when empty for all rows.)  Use **-o help **to view
              the list of all available fields.  Use separate lists of fields to add, remove or com‐
              pact by repeating the -o option: -o+field1,field2 -o-field3,field4  -o#field5.   These
              lists  are evaluated from left to right.  Use field name **lv_all **to view all LV fields,
              **vg_all **all VG fields, **pv_all **all PV fields, **pvseg_all **all PV segment  fields,  **seg_all**
              all  LV segment fields, and **pvseg_all **all PV segment columns.  See the [**lvm.conf**(5)](https://www.chedong.com/phpMan.php/man/lvm.conf/5/markdown) re‐
              port section for more config options.  See [**lvmreport**(7)](https://www.chedong.com/phpMan.php/man/lvmreport/7/markdown) for more information about re‐
              porting.

       **--profile **_String_
              An alias for --commandprofile or --metadataprofile, depending on the command.

### -q --quiet 
              Suppress output and log messages. Overrides --debug and --verbose.  Repeat once to al‐
              so suppress any prompts with answer 'no'.

### --readonly
              Run the command in a special read-only mode which will read on-disk  metadata  without
              needing  to take any locks. This can be used to peek inside metadata used by a virtual
              machine image while the virtual machine is running. No attempt will be made to  commu‐
              nicate  with  the  device-mapper  kernel  driver,  so  this option is unable to report
              whether or not LVs are actually in use.

       **--reportformat basic**|**json**
              Overrides current output format for reports which  is  defined  globally  by  the  re‐
              port/output_format  setting in [**lvm.conf**(5)](https://www.chedong.com/phpMan.php/man/lvm.conf/5/markdown).  **basic **is the original format with columns
              and rows.  If there is more than one report per command, each report is prefixed  with
              the  report  name  for identification. **json **produces report output in JSON format. See
              [**lvmreport**(7)](https://www.chedong.com/phpMan.php/man/lvmreport/7/markdown) for more information.

### --rows
              Output columns as rows.

### -S --select 
              Select objects for processing and reporting based on specified criteria.  The criteria
              syntax is described by **--select help **and [**lvmreport**(7)](https://www.chedong.com/phpMan.php/man/lvmreport/7/markdown).  For  reporting  commands,  one
              row is displayed for each object matching the criteria.  See **--options help **for selec‐
              table  object  fields.   Rows can be displayed with an additional "selected" field (-o
              selected) showing 1 if the row matches the selection and 0 otherwise.  For non-report‐
              ing commands which process LVM entities, the selection is  used  to  choose  items  to
              process.

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

### --shared
              Report/display  shared  VGs that would otherwise be skipped when lvmlockd is not being
              used on the host.  See [**lvmlockd**(8)](https://www.chedong.com/phpMan.php/man/lvmlockd/8/markdown) for more information about shared VGs.

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

### -t --test
              Run in test mode. Commands will not update metadata.  This is implemented by disabling
              all  metadata writing but nevertheless returning success to the calling function. This
              may lead to unusual error messages in multi-stage operations if a tool relies on read‐
              ing back metadata it believes has changed but hasn't.

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

       **--units **[_Number_]**r**|**R**|**h**|**H**|**b**|**B**|**s**|**S**|**k**|**K**|**m**|**M**|**g**|**G**|**t**|**T**|**p**|**P**|**e**|**E**
              All sizes are output in these units: human-(r)eadable  with  '<'  rounding  indicator,
              (h)uman-readable,  (b)ytes,  (s)ectors,  (k)ilobytes, (m)egabytes, (g)igabytes, (t)er‐
              abytes, (p)etabytes, (e)xabytes.  Capitalise to use multiples of 1000  (S.I.)  instead
              of 1024.  Custom units can be specified, e.g. --units 3M.

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


### -v --verbose 
              Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to
              stdout and stderr.

### --version
              Display version information.

### -y --yes
              Do not prompt for confirmation interactively but always assume  the  answer  yes.  Use
              with extreme caution.  (For automatic no, see -qq.)

## VARIABLES
       _VG_     Volume Group name.  See [**lvm**(8)](https://www.chedong.com/phpMan.php/man/lvm/8/markdown) for valid names.

       _Tag_    Tag name.  See [**lvm**(8)](https://www.chedong.com/phpMan.php/man/lvm/8/markdown) for information about tag names and using tags in place of a VG,
              LV or PV.

       _String_ See the option description for information about the string content.

       _Size_[UNIT]
              Size is an input number that accepts an optional unit.  Input units are always treated
              as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024.
              The  default  input  unit  is specified by letter, followed by |UNIT.  UNIT represents
              other possible input units: **b**|**B **is bytes, **s**|**S **is sectors of 512 bytes, **k**|**K **is KiB, **m**|**M**
              is MiB, **g**|**G **is GiB, **t**|**T **is TiB, **p**|**P **is PiB, **e**|**E **is EiB.  (This should not be  confused
              with the output control --units, where capital letters mean multiple of 1000.)

## ENVIRONMENT VARIABLES
       See [**lvm**(8)](https://www.chedong.com/phpMan.php/man/lvm/8/markdown) for information about environment variables used by lvm.  For example, LVM_VG_NAME
       can generally be substituted for a required VG parameter.

## NOTES
       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, (**a**)nywhere

       6  (**c**)lustered, (**s**)hared

## SEE ALSO
       [**lvm**(8)](https://www.chedong.com/phpMan.php/man/lvm/8/markdown), [**lvm.conf**(5)](https://www.chedong.com/phpMan.php/man/lvm.conf/5/markdown), [**lvmconfig**(8)](https://www.chedong.com/phpMan.php/man/lvmconfig/8/markdown), [**lvmdevices**(8)](https://www.chedong.com/phpMan.php/man/lvmdevices/8/markdown),

       [**pvchange**(8)](https://www.chedong.com/phpMan.php/man/pvchange/8/markdown), [**pvck**(8)](https://www.chedong.com/phpMan.php/man/pvck/8/markdown), [**pvcreate**(8)](https://www.chedong.com/phpMan.php/man/pvcreate/8/markdown), [**pvdisplay**(8)](https://www.chedong.com/phpMan.php/man/pvdisplay/8/markdown), [**pvmove**(8)](https://www.chedong.com/phpMan.php/man/pvmove/8/markdown), [**pvremove**(8)](https://www.chedong.com/phpMan.php/man/pvremove/8/markdown), [**pvresize**(8)](https://www.chedong.com/phpMan.php/man/pvresize/8/markdown), [**pvs**(8)](https://www.chedong.com/phpMan.php/man/pvs/8/markdown),
       [**pvscan**(8)](https://www.chedong.com/phpMan.php/man/pvscan/8/markdown),

       [**vgcfgbackup**(8)](https://www.chedong.com/phpMan.php/man/vgcfgbackup/8/markdown), [**vgcfgrestore**(8)](https://www.chedong.com/phpMan.php/man/vgcfgrestore/8/markdown), [**vgchange**(8)](https://www.chedong.com/phpMan.php/man/vgchange/8/markdown), [**vgck**(8)](https://www.chedong.com/phpMan.php/man/vgck/8/markdown), [**vgcreate**(8)](https://www.chedong.com/phpMan.php/man/vgcreate/8/markdown), [**vgconvert**(8)](https://www.chedong.com/phpMan.php/man/vgconvert/8/markdown),
       [**vgdisplay**(8)](https://www.chedong.com/phpMan.php/man/vgdisplay/8/markdown), [**vgexport**(8)](https://www.chedong.com/phpMan.php/man/vgexport/8/markdown), [**vgextend**(8)](https://www.chedong.com/phpMan.php/man/vgextend/8/markdown), [**vgimport**(8)](https://www.chedong.com/phpMan.php/man/vgimport/8/markdown), [**vgimportclone**(8)](https://www.chedong.com/phpMan.php/man/vgimportclone/8/markdown), [**vgimportdevices**(8)](https://www.chedong.com/phpMan.php/man/vgimportdevices/8/markdown),
       [**vgmerge**(8)](https://www.chedong.com/phpMan.php/man/vgmerge/8/markdown), [**vgmknodes**(8)](https://www.chedong.com/phpMan.php/man/vgmknodes/8/markdown), [**vgreduce**(8)](https://www.chedong.com/phpMan.php/man/vgreduce/8/markdown), [**vgremove**(8)](https://www.chedong.com/phpMan.php/man/vgremove/8/markdown), [**vgrename**(8)](https://www.chedong.com/phpMan.php/man/vgrename/8/markdown), [**vgs**(8)](https://www.chedong.com/phpMan.php/man/vgs/8/markdown), [**vgscan**(8)](https://www.chedong.com/phpMan.php/man/vgscan/8/markdown),
       [**vgsplit**(8)](https://www.chedong.com/phpMan.php/man/vgsplit/8/markdown),

       [**lvcreate**(8)](https://www.chedong.com/phpMan.php/man/lvcreate/8/markdown), [**lvchange**(8)](https://www.chedong.com/phpMan.php/man/lvchange/8/markdown), [**lvconvert**(8)](https://www.chedong.com/phpMan.php/man/lvconvert/8/markdown), [**lvdisplay**(8)](https://www.chedong.com/phpMan.php/man/lvdisplay/8/markdown), [**lvextend**(8)](https://www.chedong.com/phpMan.php/man/lvextend/8/markdown), [**lvreduce**(8)](https://www.chedong.com/phpMan.php/man/lvreduce/8/markdown), [**lvremove**(8)](https://www.chedong.com/phpMan.php/man/lvremove/8/markdown),
       [**lvrename**(8)](https://www.chedong.com/phpMan.php/man/lvrename/8/markdown), [**lvresize**(8)](https://www.chedong.com/phpMan.php/man/lvresize/8/markdown), [**lvs**(8)](https://www.chedong.com/phpMan.php/man/lvs/8/markdown), [**lvscan**(8)](https://www.chedong.com/phpMan.php/man/lvscan/8/markdown),

       [**lvm-fullreport**(8)](https://www.chedong.com/phpMan.php/man/lvm-fullreport/8/markdown), [**lvm-lvpoll**(8)](https://www.chedong.com/phpMan.php/man/lvm-lvpoll/8/markdown), [**blkdeactivate**(8)](https://www.chedong.com/phpMan.php/man/blkdeactivate/8/markdown), [**lvmdump**(8)](https://www.chedong.com/phpMan.php/man/lvmdump/8/markdown),

       [**dmeventd**(8)](https://www.chedong.com/phpMan.php/man/dmeventd/8/markdown), [**lvmpolld**(8)](https://www.chedong.com/phpMan.php/man/lvmpolld/8/markdown), [**lvmlockd**(8)](https://www.chedong.com/phpMan.php/man/lvmlockd/8/markdown), [**lvmlockctl**(8)](https://www.chedong.com/phpMan.php/man/lvmlockctl/8/markdown), [**cmirrord**(8)](https://www.chedong.com/phpMan.php/man/cmirrord/8/markdown), [**lvmdbusd**(8)](https://www.chedong.com/phpMan.php/man/lvmdbusd/8/markdown), [**fsadm**(8)](https://www.chedong.com/phpMan.php/man/fsadm/8/markdown),

       [**lvmsystemid**(7)](https://www.chedong.com/phpMan.php/man/lvmsystemid/7/markdown), [**lvmreport**(7)](https://www.chedong.com/phpMan.php/man/lvmreport/7/markdown), [**lvmraid**(7)](https://www.chedong.com/phpMan.php/man/lvmraid/7/markdown), [**lvmthin**(7)](https://www.chedong.com/phpMan.php/man/lvmthin/7/markdown), [**lvmcache**(7)](https://www.chedong.com/phpMan.php/man/lvmcache/7/markdown)

Red Hat, Inc.                     LVM TOOLS [2.03.16(2)](https://www.chedong.com/phpMan.php/man/2.03.16/2/markdown) (2022-05-18)                           [_VGS_(8)](https://www.chedong.com/phpMan.php/man/VGS/8/markdown)
