Ubuntu Manpage: vgdisplay - Display volume group information

Provided by: lvm2_2.02.176-4.1ubuntu3.18.04.3_amd64

NAME

       vgdisplay - Display volume group information

SYNOPSIS

       vgdisplay
           [ option_args ]
           [ position_args ]

DESCRIPTION

       vgdisplay shows the attributes of VGs, and the associated PVs and LVs.

       vgs(8)  is  a  preferred  alternative  that shows the same information and more, using a more compact and
       configurable output format.

USAGE

       vgdisplay
           [ -A|--activevolumegroups ]
           [ -c|--colon ]
           [ -C|--columns ]
           [ -o|--options String ]
           [ -S|--select String ]
           [ -s|--short ]
           [ -O|--sort String ]
           [    --aligned ]
           [    --binary ]
           [    --configreport log|vg|lv|pv|pvseg|seg ]
           [    --foreign ]
           [    --ignorelockingfailure ]
           [    --ignoreskippedcluster ]
           [    --logonly ]
           [    --noheadings ]
           [    --nosuffix ]
           [    --readonly ]
           [    --reportformat basic|json ]
           [    --shared ]
           [    --separator String ]
           [    --unbuffered ]
           [    --units r|R|h|H|b|B|s|S|k|K|m|M|g|G|t|T|p|P|e|E ]
           [ COMMON_OPTIONS ]
           [ VG|Tag ... ]

       Common options for lvm:
           [ -d|--debug ]
           [ -h|--help ]
           [ -q|--quiet ]
           [ -t|--test ]
           [ -v|--verbose ]
           [ -y|--yes ]
           [    --commandprofile String ]
           [    --config String ]
           [    --driverloaded y|n ]
           [    --longhelp ]
           [    --profile String ]
           [    --version ]

OPTIONS

-A|--activevolumegroups
Only select active VGs. The VG is considered active if at least one of its LVs is active.

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

--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 denotes that the value could
not be determined).

-c|--colon
Generate colon separated output for easier parsing in scripts or programs. Also see vgs(8) which
provides considerably more control over the output.

-C|--columns
Display output in columns, the equivalent of vgs(8). Options listed are the same as options given
in vgs(8).

--commandprofile String
The command profile to use for command configuration. See lvm.conf(5) for more information about
profiles.

--config String
Config settings for the command. These override lvm.conf settings. The String arg uses the same
format as lvm.conf, or may use section/field syntax. See lvm.conf(5) for more information about
config.

--configreport log|vg|lv|pv|pvseg|seg
See lvmreport(7).

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

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

--foreign
Report/display foreign VGs that would otherwise be skipped. See lvmsystemid(7) for more
information about foreign VGs.

-h|--help
Display help text.

--ignorelockingfailure
Allows a command to continue with read-only metadata operations after locking failures.

--ignoreskippedcluster
Use to avoid exiting with an non-zero status code if the command is run without clustered locking
and clustered VGs are skipped.

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

--longhelp
Display long help text.

--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 String
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 default 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 compact 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 report section for more config options. See lvmreport(7) for more information about
reporting.

--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 also 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. It can also be used to peek inside the metadata of clustered VGs when
clustered locking is not configured or running. No attempt will be made to communicate 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 report/output_format
setting in lvm.conf. 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) for more information.

-S|--select String
Select objects for processing and reporting based on specified criteria. The criteria syntax is
described by --select help and lvmreport(7). For reporting commands, one row is displayed for
each object matching the criteria. See --options help for selectable 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-reporting 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) for more information about shared VGs.

-s|--short
Give a short listing showing the existence of VGs.

-O|--sort String
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 reading back metadata it
believes has changed but hasn't.

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

--units 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)erabytes, (p)etabytes,
(e)xabytes. Capitalise to use multiples of 1000 (S.I.) instead of 1024. Custom units can be
specified, e.g. --units 3M.

-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) for valid names.

       Tag
              Tag name.  See lvm(8) 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:
              bBsSkKmMgGtTpPeE.   b|B is bytes, s|S is sectors of 512 bytes, k|K is kilobytes, m|M is megabytes,
              g|G is gigabytes, t|T is terabytes, p|P is petabytes,  e|E  is  exabytes.   (This  should  not  be
              confused with the output control --units, where capital letters mean multiple of 1000.)

ENVIRONMENT VARIABLES

       See  lvm(8)  for  information  about  environment  variables  used  by lvm.  For example, LVM_VG_NAME can
       generally be substituted for a required VG parameter.