2017-03-17 02:08:59 +03:00
.TH VGSCAN 8 "LVM TOOLS #VERSION#" "Red Hat, Inc."
2017-03-14 03:47:46 +03:00
.SH NAME
2017-03-28 03:32:59 +03:00
vgscan - Search for all volume groups
2017-03-14 03:47:46 +03:00
.
.SH SYNOPSIS
\fBvgscan\fP
.br
[ \fIoption_args\fP ]
.br
.SH DESCRIPTION
vgscan scans all supported LVM block devices in the system for VGs.
.SH USAGE
\fBvgscan\fP
.br
.RS 4
.ad l
2017-03-28 03:32:59 +03:00
[ \fB--ignorelockingfailure\fP ]
2017-03-14 03:47:46 +03:00
.ad b
.br
.ad l
2017-03-28 03:32:59 +03:00
[ \fB--mknodes\fP ]
2017-03-14 03:47:46 +03:00
.ad b
.br
.ad l
2017-03-28 03:32:59 +03:00
[ \fB--notifydbus\fP ]
2017-03-14 03:47:46 +03:00
.ad b
.br
.ad l
2017-03-28 03:32:59 +03:00
[ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ]
2017-03-14 03:47:46 +03:00
.ad b
.br
[ COMMON_OPTIONS ]
.RE
.br
Common options for lvm:
.
.RS 4
.ad l
2017-03-28 03:32:59 +03:00
[ \fB-d\fP|\fB--debug\fP ]
2017-03-14 03:47:46 +03:00
.ad b
.br
.ad l
2017-03-28 03:32:59 +03:00
[ \fB-h\fP|\fB--help\fP ]
2017-03-14 03:47:46 +03:00
.ad b
.br
.ad l
2017-03-28 03:32:59 +03:00
[ \fB-q\fP|\fB--quiet\fP ]
2017-03-14 03:47:46 +03:00
.ad b
.br
.ad l
2017-03-28 03:32:59 +03:00
[ \fB-t\fP|\fB--test\fP ]
2017-03-14 03:47:46 +03:00
.ad b
.br
.ad l
2017-03-28 03:32:59 +03:00
[ \fB-v\fP|\fB--verbose\fP ]
2017-03-14 03:47:46 +03:00
.ad b
.br
.ad l
2017-03-28 03:32:59 +03:00
[ \fB-y\fP|\fB--yes\fP ]
2017-03-14 03:47:46 +03:00
.ad b
.br
.ad l
2017-03-28 03:32:59 +03:00
[ \fB--commandprofile\fP \fIString\fP ]
2017-03-14 03:47:46 +03:00
.ad b
.br
.ad l
2017-03-28 03:32:59 +03:00
[ \fB--config\fP \fIString\fP ]
2017-03-14 03:47:46 +03:00
.ad b
.br
.ad l
2021-02-24 14:40:15 +03:00
[ \fB--devices\fP \fIPV\fP ]
.ad b
.br
.ad l
[ \fB--devicesfile\fP \fIString\fP ]
.ad b
.br
.ad l
2017-03-28 03:32:59 +03:00
[ \fB--driverloaded\fP \fBy\fP|\fBn\fP ]
2017-03-14 03:47:46 +03:00
.ad b
.br
.ad l
2018-01-12 03:30:52 +03:00
[ \fB--lockopt\fP \fIString\fP ]
.ad b
.br
.ad l
2017-03-28 03:32:59 +03:00
[ \fB--longhelp\fP ]
2017-03-14 03:47:46 +03:00
.ad b
.br
.ad l
2018-06-08 23:16:00 +03:00
[ \fB--nolocking\fP ]
.ad b
.br
.ad l
2017-03-28 03:32:59 +03:00
[ \fB--profile\fP \fIString\fP ]
2017-03-14 03:47:46 +03:00
.ad b
.br
.ad l
2017-03-28 03:32:59 +03:00
[ \fB--version\fP ]
2017-03-14 03:47:46 +03:00
.ad b
.RE
.SH OPTIONS
2021-04-12 12:11:51 +03:00
.HP
2017-03-14 03:47:46 +03:00
.ad l
2017-03-28 03:32:59 +03:00
\fB--commandprofile\fP \fIString\fP
2017-03-14 03:47:46 +03:00
.br
2021-04-08 22:08:48 +03:00
.ad b
2017-03-14 03:47:46 +03:00
The command profile to use for command configuration.
See \fBlvm.conf\fP(5) for more information about profiles.
2021-04-12 12:11:51 +03:00
.HP
2017-03-14 03:47:46 +03:00
.ad l
2017-03-28 03:32:59 +03:00
\fB--config\fP \fIString\fP
2017-03-14 03:47:46 +03:00
.br
2021-04-08 22:08:48 +03:00
.ad b
2017-03-14 03:47:46 +03:00
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 \fBlvm.conf\fP(5) for more information about config.
2021-04-12 12:11:51 +03:00
.HP
2017-03-14 03:47:46 +03:00
.ad l
2017-03-28 03:32:59 +03:00
\fB-d\fP|\fB--debug\fP ...
2017-03-14 03:47:46 +03:00
.br
2021-04-08 22:08:48 +03:00
.ad b
2017-03-14 03:47:46 +03:00
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).
2021-04-12 12:11:51 +03:00
.HP
2017-03-14 03:47:46 +03:00
.ad l
2021-02-24 14:40:15 +03:00
\fB--devices\fP \fIPV\fP
.br
2021-04-08 22:08:48 +03:00
.ad b
2021-02-24 14:40:15 +03:00
Devices that the command can use. This option can be repeated
or accepts a comma separated list of devices. This overrides
the devices file.
2021-04-12 12:11:51 +03:00
.HP
2021-02-24 14:40:15 +03:00
.ad l
\fB--devicesfile\fP \fIString\fP
.br
2021-04-08 22:08:48 +03:00
.ad b
2021-02-24 14:40:15 +03:00
A file listing devices that LVM should use.
The file must exist in /etc/lvm/devices/ and is managed
with the lvmdevices(8) command.
This overrides the lvm.conf devices/devicesfile and
devices/use_devicesfile settings.
2021-04-12 12:11:51 +03:00
.HP
2021-02-24 14:40:15 +03:00
.ad l
2017-03-28 03:32:59 +03:00
\fB--driverloaded\fP \fBy\fP|\fBn\fP
2017-03-14 03:47:46 +03:00
.br
2021-04-08 22:08:48 +03:00
.ad b
2017-03-14 03:47:46 +03:00
If set to no, the command will not attempt to use device-mapper.
For testing and debugging.
2021-04-12 12:11:51 +03:00
.HP
2017-03-14 03:47:46 +03:00
.ad l
2017-03-28 03:32:59 +03:00
\fB-h\fP|\fB--help\fP
2017-03-14 03:47:46 +03:00
.br
.ad b
2021-04-08 22:08:48 +03:00
Display help text.
2021-04-12 12:11:51 +03:00
.HP
2017-03-14 03:47:46 +03:00
.ad l
2017-03-28 03:32:59 +03:00
\fB--ignorelockingfailure\fP
2017-03-14 03:47:46 +03:00
.br
2021-04-08 22:08:48 +03:00
.ad b
2017-03-14 03:47:46 +03:00
Allows a command to continue with read-only metadata
operations after locking failures.
2021-04-12 12:11:51 +03:00
.HP
2017-03-14 03:47:46 +03:00
.ad l
2018-01-12 03:30:52 +03:00
\fB--lockopt\fP \fIString\fP
.br
2021-04-08 22:08:48 +03:00
.ad b
2018-01-12 03:30:52 +03:00
Used to pass options for special cases to lvmlockd.
See \fBlvmlockd\fP(8) for more information.
2021-04-12 12:11:51 +03:00
.HP
2018-01-12 03:30:52 +03:00
.ad l
2017-03-28 03:32:59 +03:00
\fB--longhelp\fP
2017-03-14 03:47:46 +03:00
.br
.ad b
2021-04-08 22:08:48 +03:00
Display long help text.
2021-04-12 12:11:51 +03:00
.HP
2017-03-14 03:47:46 +03:00
.ad l
2017-03-28 03:32:59 +03:00
\fB--mknodes\fP
2017-03-14 03:47:46 +03:00
.br
2021-04-08 22:08:48 +03:00
.ad b
2017-03-14 03:47:46 +03:00
Also checks the LVM special files in /dev that are needed for active
LVs and creates any missing ones and removes unused ones.
2021-04-12 12:11:51 +03:00
.HP
2017-03-14 03:47:46 +03:00
.ad l
2018-06-08 23:16:00 +03:00
\fB--nolocking\fP
.br
.ad b
2021-04-08 22:08:48 +03:00
Disable locking.
2021-04-12 12:11:51 +03:00
.HP
2018-06-08 23:16:00 +03:00
.ad l
2017-03-28 03:32:59 +03:00
\fB--notifydbus\fP
2017-03-14 03:47:46 +03:00
.br
2021-04-08 22:08:48 +03:00
.ad b
2017-03-14 03:47:46 +03:00
Send a notification to D-Bus. The command will exit with an error
if LVM is not built with support for D-Bus notification, or if the
notify_dbus config setting is disabled.
2021-04-12 12:11:51 +03:00
.HP
2017-03-14 03:47:46 +03:00
.ad l
2017-03-28 03:32:59 +03:00
\fB--profile\fP \fIString\fP
2017-03-14 03:47:46 +03:00
.br
2021-04-08 22:08:48 +03:00
.ad b
2017-03-28 03:32:59 +03:00
An alias for --commandprofile or --metadataprofile, depending
2017-03-14 03:47:46 +03:00
on the command.
2021-04-12 12:11:51 +03:00
.HP
2017-03-14 03:47:46 +03:00
.ad l
2017-03-28 03:32:59 +03:00
\fB-q\fP|\fB--quiet\fP ...
2017-03-14 03:47:46 +03:00
.br
2021-04-08 22:08:48 +03:00
.ad b
2017-03-28 03:32:59 +03:00
Suppress output and log messages. Overrides --debug and --verbose.
2017-05-03 13:23:15 +03:00
Repeat once to also suppress any prompts with answer 'no'.
2021-04-12 12:11:51 +03:00
.HP
2017-03-14 03:47:46 +03:00
.ad l
2017-03-28 03:32:59 +03:00
\fB--reportformat\fP \fBbasic\fP|\fBjson\fP
2017-03-14 03:47:46 +03:00
.br
2021-04-08 22:08:48 +03:00
.ad b
2017-03-14 03:47:46 +03:00
Overrides current output format for reports which is defined globally by
the report/output_format setting in lvm.conf.
\fBbasic\fP 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. \fBjson\fP produces report
output in JSON format. See \fBlvmreport\fP(7) for more information.
2021-04-12 12:11:51 +03:00
.HP
2017-03-14 03:47:46 +03:00
.ad l
2017-03-28 03:32:59 +03:00
\fB-t\fP|\fB--test\fP
2017-03-14 03:47:46 +03:00
.br
2021-04-08 22:08:48 +03:00
.ad b
2017-03-14 03:47:46 +03:00
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.
2021-04-12 12:11:51 +03:00
.HP
2017-03-14 03:47:46 +03:00
.ad l
2017-03-28 03:32:59 +03:00
\fB-v\fP|\fB--verbose\fP ...
2017-03-14 03:47:46 +03:00
.br
2021-04-08 22:08:48 +03:00
.ad b
2017-03-14 03:47:46 +03:00
Set verbose level. Repeat from 1 to 4 times to increase the detail
of messages sent to stdout and stderr.
2021-04-12 12:11:51 +03:00
.HP
2017-03-14 03:47:46 +03:00
.ad l
2017-03-28 03:32:59 +03:00
\fB--version\fP
2017-03-14 03:47:46 +03:00
.br
.ad b
2021-04-08 22:08:48 +03:00
Display version information.
2021-04-12 12:11:51 +03:00
.HP
2017-03-14 03:47:46 +03:00
.ad l
2017-03-28 03:32:59 +03:00
\fB-y\fP|\fB--yes\fP
2017-03-14 03:47:46 +03:00
.br
2021-04-08 22:08:48 +03:00
.ad b
2017-03-14 03:47:46 +03:00
Do not prompt for confirmation interactively but always assume the
answer yes. Use with extreme caution.
(For automatic no, see -qq.)
.SH VARIABLES
2021-04-12 12:11:51 +03:00
.HP
2017-03-14 03:47:46 +03:00
\fIString\fP
.br
See the option description for information about the string content.
2021-04-12 12:11:51 +03:00
.HP
2017-03-14 03:47:46 +03:00
\fISize\fP[UNIT]
.br
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: \fBbBsSkKmMgGtTpPeE\fP.
2020-10-19 13:34:36 +03:00
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.
2017-03-28 03:32:59 +03:00
(This should not be confused with the output control --units, where
2017-03-14 03:47:46 +03:00
capital letters mean multiple of 1000.)
.SH ENVIRONMENT VARIABLES
See \fBlvm\fP(8) for information about environment variables used by lvm.
For example, LVM_VG_NAME can generally be substituted for a required VG parameter.
.SH SEE ALSO
2021-04-08 22:08:48 +03:00
.nh
.ad l
.BR lvm (8),
.BR lvm.conf (5),
.BR lvmconfig (8),
.BR lvmdevices (8),
2017-03-14 03:47:46 +03:00
2021-04-08 22:08:48 +03:00
.BR pvchange (8),
.BR pvck (8),
.BR pvcreate (8),
.BR pvdisplay (8),
.BR pvmove (8),
.BR pvremove (8),
.BR pvresize (8),
.BR pvs (8),
.BR pvscan (8),
2017-03-14 03:47:46 +03:00
2021-04-08 22:08:48 +03:00
.BR vgcfgbackup (8),
.BR vgcfgrestore (8),
.BR vgchange (8),
.BR vgck (8),
.BR vgcreate (8),
.BR vgconvert (8),
.BR vgdisplay (8),
.BR vgexport (8),
.BR vgextend (8),
.BR vgimport (8),
.BR vgimportclone (8),
.BR vgimportdevices (8),
.BR vgmerge (8),
.BR vgmknodes (8),
.BR vgreduce (8),
.BR vgremove (8),
.BR vgrename (8),
.BR vgs (8),
.BR vgscan (8),
.BR vgsplit (8),
2017-03-14 03:47:46 +03:00
2021-04-08 22:08:48 +03:00
.BR lvcreate (8),
.BR lvchange (8),
.BR lvconvert (8),
.BR lvdisplay (8),
.BR lvextend (8),
.BR lvreduce (8),
.BR lvremove (8),
.BR lvrename (8),
.BR lvresize (8),
.BR lvs (8),
.BR lvscan (8),
2017-03-14 03:47:46 +03:00
2021-04-08 22:08:48 +03:00
.BR lvm-fullreport (8),
.BR lvm-lvpoll (8),
.BR lvm2-activation-generator (8),
.BR blkdeactivate (8),
.BR lvmdump (8),
2017-03-14 03:47:46 +03:00
2021-04-08 22:08:48 +03:00
.BR dmeventd (8),
.BR lvmpolld (8),
.BR lvmlockd (8),
.BR lvmlockctl (8),
.BR cmirrord (8),
.BR lvmdbusd (8),
2017-03-14 03:47:46 +03:00
2021-04-08 22:08:48 +03:00
.BR lvmsystemid (7),
.BR lvmreport (7),
.BR lvmraid (7),
.BR lvmthin (7),
2017-03-14 03:47:46 +03:00
.BR lvmcache (7)