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           [    --cache ]
18           [    --ignorelockingfailure ]
19           [    --mknodes ]
20           [    --notifydbus ]
21           [    --reportformat basic|json ]
22           [ COMMON_OPTIONS ]
23
24       Common options for lvm:
25           [ -d|--debug ]
26           [ -h|--help ]
27           [ -q|--quiet ]
28           [ -t|--test ]
29           [ -v|--verbose ]
30           [ -y|--yes ]
31           [    --commandprofile String ]
32           [    --config String ]
33           [    --driverloaded y|n ]
34           [    --lockopt String ]
35           [    --longhelp ]
36           [    --profile String ]
37           [    --version ]
38

OPTIONS

40       --cache
41              Scan all devices and send the metadata to lvmetad.
42
43       --commandprofile String
44              The command profile to use for command configuration.  See
45              lvm.conf(5) for more information about profiles.
46
47       --config String
48              Config settings for the command. These override lvm.conf set‐
49              tings.  The String arg uses the same format as lvm.conf, or may
50              use section/field syntax.  See lvm.conf(5) for more information
51              about config.
52
53       -d|--debug ...
54              Set debug level. Repeat from 1 to 6 times to increase the detail
55              of messages sent to the log file and/or syslog (if configured).
56
57       --driverloaded y|n
58              If set to no, the command will not attempt to use device-mapper.
59              For testing and debugging.
60
61       -h|--help
62              Display help text.
63
64       --ignorelockingfailure
65              Allows a command to continue with read-only metadata operations
66              after locking failures.
67
68       --lockopt String
69              Used to pass options for special cases to lvmlockd.  See lvm‐
70              lockd(8) for more information.
71
72       --longhelp
73              Display long help text.
74
75       --mknodes
76              Also checks the LVM special files in /dev that are needed for
77              active LVs and creates any missing ones and removes unused ones.
78
79       --notifydbus
80              Send a notification to D-Bus. The command will exit with an
81              error if LVM is not built with support for D-Bus notification,
82              or 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
105              unusual error messages in multi-stage operations if a tool
106              relies on reading back metadata it believes has changed but
107              hasn't.
108
109       -v|--verbose ...
110              Set verbose level. Repeat from 1 to 4 times to increase the
111              detail of messages sent to stdout and stderr.
112
113       --version
114              Display version information.
115
116       -y|--yes
117              Do not prompt for confirmation interactively but always assume
118              the answer yes. Use with extreme caution.  (For automatic no,
119              see -qq.)
120

VARIABLES

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

ENVIRONMENT VARIABLES

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