Ubuntu Manpage: vgscan — Search for all volume groups

Provided by: lvm2_2.03.16-1ubuntu1_amd64

NAME

       vgscan — Search for all volume groups

SYNOPSIS

       vgscan
           [ option_args ]

DESCRIPTION

       vgscan scans all supported LVM block devices in the system for VGs.

USAGE

       vgscan
           [    --ignorelockingfailure ]
           [    --mknodes ]
           [    --notifydbus ]
           [    --reportformat basic|json ]
           [ COMMON_OPTIONS ]

       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

--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(5) settings. The String
arg uses the same format as lvm.conf(5), or may use section/field syntax. See
lvm.conf(5) for more information about config.

-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
separated 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) command. This overrides
the lvm.conf(5) devices/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
debugging.

-h|--help
Display help text.

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

--journal String
Record information in the systemd journal. This information is in addition to
information 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) for more
information.

--longhelp
Display long help text.

--mknodes
Also checks the LVM special files in /dev that are needed for active LVs and
creates any missing ones and removes unused ones.

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

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

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

--reportformat basic|json
Overrides current output format for reports which is defined globally by the
report/output_format setting in lvm.conf(5). 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.

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

-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

       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)  for  information  about  environment  variables  used  by  lvm.  For example,
       LVM_VG_NAME can generally be substituted for a required VG parameter.