vgscan(8)

1VGSCAN(8)                   System Manager's Manual                  VGSCAN(8)
2
3
4

NAME

6       vgscan — Search for all volume groups
7

SYNOPSIS

9       vgscan
10           [ option_args ]
11

DESCRIPTION

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

USAGE

16       vgscan
17           [    --ignorelockingfailure ]
18           [    --mknodes ]
19           [    --notifydbus ]
20           [    --reportformat basic|json|json_std ]
21           [ COMMON_OPTIONS ]
22
23       Common options for lvm:
24           [ -d|--debug ]
25           [ -h|--help ]
26           [ -q|--quiet ]
27           [ -t|--test ]
28           [ -v|--verbose ]
29           [ -y|--yes ]
30           [    --commandprofile String ]
31           [    --config String ]
32           [    --devices PV ]
33           [    --devicesfile String ]
34           [    --driverloaded y|n ]
35           [    --journal String ]
36           [    --lockopt String ]
37           [    --longhelp ]
38           [    --nohints ]
39           [    --nolocking ]
40           [    --profile String ]
41           [    --version ]
42

OPTIONS

44       --commandprofile String
45              The  command  profile  to  use  for  command configuration.  See
46              lvm.conf(5) for more information about profiles.
47
48       --config String
49              Config settings for the command. These override lvm.conf(5) set‐
50              tings.   The  String arg uses the same format as lvm.conf(5), or
51              may use section/field syntax.  See lvm.conf(5) for more informa‐
52              tion about config.
53
54       -d|--debug ...
55              Set debug level. Repeat from 1 to 6 times to increase the detail
56              of messages sent to the log file and/or syslog (if configured).
57
58       --devices PV
59              Restricts the devices that are visible  and  accessible  to  the
60              command.  Devices not listed will appear to be missing. This op‐
61              tion can be repeated, or accepts a comma separated list  of  de‐
62              vices. This overrides the devices file.
63
64       --devicesfile String
65              A file listing devices that LVM should use.  The file must exist
66              in /etc/lvm/devices/ and is managed with the lvmdevices(8)  com‐
67              mand.   This  overrides  the lvm.conf(5) devices/devicesfile and
68              devices/use_devicesfile settings.
69
70       --driverloaded y|n
71              If set to no, the command will not attempt to use device-mapper.
72              For testing and debugging.
73
74       -h|--help
75              Display help text.
76
77       --ignorelockingfailure
78              Allows  a command to continue with read-only metadata operations
79              after locking failures.
80
81       --journal String
82              Record information in the systemd journal.  This information  is
83              in  addition  to information enabled by the lvm.conf log/journal
84              setting.  command: record information about the  command.   out‐
85              put: record the default command output.  debug: record full com‐
86              mand debugging.
87
88       --lockopt String
89              Used to pass options for special cases to  lvmlockd.   See  lvm‐
90              lockd(8) for more information.
91
92       --longhelp
93              Display long help text.
94
95       --mknodes
96              Also  checks  the  LVM special files in /dev that are needed for
97              active LVs and creates any missing ones and removes unused ones.
98
99       --nohints
100              Do not use the hints file to locate devices for PVs.  A  command
101              may  read  more devices to find PVs when hints are not used. The
102              command will still perform standard hint file invalidation where
103              appropriate.
104
105       --nolocking
106              Disable  locking. Use with caution, concurrent commands may pro‐
107              duce incorrect results.
108
109       --notifydbus
110              Send a notification to D-Bus. The command will exit with an  er‐
111              ror  if LVM is not built with support for D-Bus notification, or
112              if the notify_dbus config setting is disabled.
113
114       --profile String
115              An alias for --commandprofile or --metadataprofile, depending on
116              the command.
117
118       -q|--quiet ...
119              Suppress  output  and log messages. Overrides --debug and --ver‐
120              bose.  Repeat once to also  suppress  any  prompts  with  answer
121              'no'.
122
123       --reportformat basic|json|json_std
124              Overrides  current  output  format  for reports which is defined
125              globally by the  report/output_format  setting  in  lvm.conf(5).
126              basic is the original format with columns and rows.  If there is
127              more than one report per command, each report is  prefixed  with
128              the  report name for identification. json produces report output
129              in JSON format. json_std produces report output in  JSON  format
130              which  is  more  compliant with JSON standard.  See lvmreport(7)
131              for more information.
132
133       -t|--test
134              Run in test mode. Commands will not update  metadata.   This  is
135              implemented  by  disabling all metadata writing but nevertheless
136              returning success to the calling function. This may lead to  un‐
137              usual  error messages in multi-stage operations if a tool relies
138              on reading back metadata it believes has changed but hasn't.
139
140       -v|--verbose ...
141              Set verbose level. Repeat from 1 to 4 times to increase the  de‐
142              tail of messages sent to stdout and stderr.
143
144       --version
145              Display version information.
146
147       -y|--yes
148              Do  not  prompt for confirmation interactively but always assume
149              the answer yes. Use with extreme caution.   (For  automatic  no,
150              see -qq.)
151

VARIABLES

153       String See the option description for information about the string con‐
154              tent.
155
156       Size[UNIT]
157              Size is an input number that accepts an  optional  unit.   Input
158              units are always treated as base two values, regardless of capi‐
159              talization, e.g. 'k' and 'K' both refer to  1024.   The  default
160              input unit is specified by letter, followed by |UNIT.  UNIT rep‐
161              resents other possible input units: b|B is bytes, s|S is sectors
162              of  512  bytes,  k|K is KiB, m|M is MiB, g|G is GiB, t|T is TiB,
163              p|P is PiB, e|E is EiB.  (This should not be confused  with  the
164              output  control  --units, where capital letters mean multiple of
165              1000.)
166

ENVIRONMENT VARIABLES

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