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 ]
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           [    --driverloaded y|n ]
33           [    --lockopt String ]
34           [    --longhelp ]
35           [    --nolocking ]
36           [    --profile String ]
37           [    --version ]
38

OPTIONS

40       --commandprofile String
41              The command profile to use for command configuration.  See
42              lvm.conf(5) for more information about profiles.
43
44       --config String
45              Config settings for the command. These override lvm.conf set‐
46              tings.  The String arg uses the same format as lvm.conf, or may
47              use section/field syntax.  See lvm.conf(5) for more information
48              about config.
49
50       -d|--debug ...
51              Set debug level. Repeat from 1 to 6 times to increase the detail
52              of messages sent to the log file and/or syslog (if configured).
53
54       --driverloaded y|n
55              If set to no, the command will not attempt to use device-mapper.
56              For testing and debugging.
57
58       -h|--help
59              Display help text.
60
61       --ignorelockingfailure
62              Allows a command to continue with read-only metadata operations
63              after locking failures.
64
65       --lockopt String
66              Used to pass options for special cases to lvmlockd.  See lvm‐
67              lockd(8) for more information.
68
69       --longhelp
70              Display long help text.
71
72       --mknodes
73              Also checks the LVM special files in /dev that are needed for
74              active LVs and creates any missing ones and removes unused ones.
75
76       --nolocking
77              Disable locking.
78
79       --notifydbus
80              Send a notification to D-Bus. The command will exit with an er‐
81              ror if LVM is not built with support for D-Bus notification, or
82              if the notify_dbus config setting is disabled.
83
84       --profile String
85              An alias for --commandprofile or --metadataprofile, depending on
86              the command.
87
88       -q|--quiet ...
89              Suppress output and log messages. Overrides --debug and --ver‐
90              bose.  Repeat once to also suppress any prompts with answer
91              'no'.
92
93       --reportformat basic|json
94              Overrides current output format for reports which is defined
95              globally by the report/output_format setting in lvm.conf.  basic
96              is the original format with columns and rows.  If there is more
97              than one report per command, each report is prefixed with the
98              report name for identification. json produces report output in
99              JSON format. See lvmreport(7) for more information.
100
101       -t|--test
102              Run in test mode. Commands will not update metadata.  This is
103              implemented by disabling all metadata writing but nevertheless
104              returning success to the calling function. This may lead to un‐
105              usual error messages in multi-stage operations if a tool relies
106              on reading back metadata it believes has changed but hasn't.
107
108       -v|--verbose ...
109              Set verbose level. Repeat from 1 to 4 times to increase the de‐
110              tail of messages sent to stdout and stderr.
111
112       --version
113              Display version information.
114
115       -y|--yes
116              Do not prompt for confirmation interactively but always assume
117              the answer yes. Use with extreme caution.  (For automatic no,
118              see -qq.)
119

VARIABLES

121       String
122              See the option description for information about the string con‐
123              tent.
124
125       Size[UNIT]
126              Size is an input number that accepts an  optional  unit.   Input
127              units are always treated as base two values, regardless of capi‐
128              talization, e.g. 'k' and 'K' both refer to  1024.   The  default
129              input unit is specified by letter, followed by |UNIT.  UNIT rep‐
130              resents other possible input units:  bBsSkKmMgGtTpPeE.   b|B  is
131              bytes,  s|S is sectors of 512 bytes, k|K is KiB, m|M is MiB, g|G
132              is GiB, t|T is TiB, p|P is PiB, e|E is EiB.  (This should not be
133              confused  with the output control --units, where capital letters
134              mean multiple of 1000.)
135

ENVIRONMENT VARIABLES

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