lvscan(8)

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

NAME

6       lvscan - List all logical volumes in all volume groups
7

SYNOPSIS

9       lvscan
10           [ option_args ]
11

DESCRIPTION

13       lvscan  scans  all VGs or all supported LVM block devices in the system
14       for LVs. The output consists of one line for each LV indicating whether
15       or  not  it is active, a snapshot or origin, the size of the device and
16       its allocation policy. Use lvs(8) or lvdisplay(8) to obtain  more  com‐
17       prehensive information about LVs.
18

USAGE

20       lvscan
21           [ -a|--all ]
22           [ -b|--blockdevice ]
23           [    --ignorelockingfailure ]
24           [    --readonly ]
25           [    --reportformat basic|json ]
26           [ COMMON_OPTIONS ]
27
28       Common options for lvm:
29           [ -d|--debug ]
30           [ -h|--help ]
31           [ -q|--quiet ]
32           [ -t|--test ]
33           [ -v|--verbose ]
34           [ -y|--yes ]
35           [    --commandprofile String ]
36           [    --config String ]
37           [    --driverloaded y|n ]
38           [    --lockopt String ]
39           [    --longhelp ]
40           [    --nolocking ]
41           [    --profile String ]
42           [    --version ]
43

OPTIONS

45       -a|--all
46              Show information about internal LVs.  These are components of
47              normal LVs, such as mirrors, which are not independently acces‐
48              sible, e.g. not mountable.
49
50       -b|--blockdevice
51              No longer used.
52
53       --commandprofile String
54              The command profile to use for command configuration.  See
55              lvm.conf(5) for more information about profiles.
56
57       --config String
58              Config settings for the command. These override lvm.conf set‐
59              tings.  The String arg uses the same format as lvm.conf, or may
60              use section/field syntax.  See lvm.conf(5) for more information
61              about config.
62
63       -d|--debug ...
64              Set debug level. Repeat from 1 to 6 times to increase the detail
65              of messages sent to the log file and/or syslog (if configured).
66
67       --driverloaded y|n
68              If set to no, the command will not attempt to use device-mapper.
69              For testing and debugging.
70
71       -h|--help
72              Display help text.
73
74       --ignorelockingfailure
75              Allows a command to continue with read-only metadata operations
76              after locking failures.
77
78       --lockopt String
79              Used to pass options for special cases to lvmlockd.  See lvm‐
80              lockd(8) for more information.
81
82       --longhelp
83              Display long help text.
84
85       --nolocking
86              Disable locking.
87
88       --profile String
89              An alias for --commandprofile or --metadataprofile, depending on
90              the command.
91
92       -q|--quiet ...
93              Suppress output and log messages. Overrides --debug and --ver‐
94              bose.  Repeat once to also suppress any prompts with answer
95              'no'.
96
97       --readonly
98              Run the command in a special read-only mode which will read on-
99              disk metadata without needing to take any locks. This can be
100              used to peek inside metadata used by a virtual machine image
101              while the virtual machine is running. No attempt will be made to
102              communicate with the device-mapper kernel driver, so this option
103              is unable to report whether or not LVs are actually in use.
104
105       --reportformat basic|json
106              Overrides current output format for reports which is defined
107              globally by the report/output_format setting in lvm.conf.  basic
108              is the original format with columns and rows.  If there is more
109              than one report per command, each report is prefixed with the
110              report name for identification. json produces report output in
111              JSON format. See lvmreport(7) for more information.
112
113       -t|--test
114              Run in test mode. Commands will not update metadata.  This is
115              implemented by disabling all metadata writing but nevertheless
116              returning success to the calling function. This may lead to un‐
117              usual error messages in multi-stage operations if a tool relies
118              on reading back metadata it believes has changed but hasn't.
119
120       -v|--verbose ...
121              Set verbose level. Repeat from 1 to 4 times to increase the de‐
122              tail of messages sent to stdout and stderr.
123
124       --version
125              Display version information.
126
127       -y|--yes
128              Do not prompt for confirmation interactively but always assume
129              the answer yes. Use with extreme caution.  (For automatic no,
130              see -qq.)
131

VARIABLES

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

ENVIRONMENT VARIABLES

149       See lvm(8) for information about environment  variables  used  by  lvm.
150       For example, LVM_VG_NAME can generally be substituted for a required VG
151       parameter.
152