1LVM(FULLREPORT)                  Red Hat, Inc.                 LVM(FULLREPORT)
2
3
4

NAME

6       lvm fullreport — Display full report
7

SYNOPSIS

9       lvm fullreport
10           [ option_args ]
11           [ position_args ]
12

DESCRIPTION

14       lvm  fullreport  produces formatted output about PVs, PV segments, VGs,
15       LVs and LV segments. The information is all gathered together for  each
16       VG (under a per-VG lock) so it is consistent. Information gathered from
17       separate calls to vgs, pvs, and lvs can be inconsistent if  information
18       changes between commands.
19

USAGE

21       lvm fullreport
22           [ -a|--all ]
23           [ -o|--options String ]
24           [ -S|--select String ]
25           [ -O|--sort String ]
26           [    --aligned ]
27           [    --binary ]
28           [    --configreport log|vg|lv|pv|pvseg|seg ]
29           [    --foreign ]
30           [    --ignorelockingfailure ]
31           [    --logonly ]
32           [    --nameprefixes ]
33           [    --noheadings ]
34           [    --nosuffix ]
35           [    --readonly ]
36           [    --reportformat basic|json|json_std ]
37           [    --rows ]
38           [    --separator String ]
39           [    --shared ]
40           [    --unbuffered ]
41           [    --units [Number]r|R|h|H|b|B|s|S|k|K|m|M|g|G|t|T|p|P|e|E ]
42           [    --unquoted ]
43           [ COMMON_OPTIONS ]
44           [ VG ... ]
45
46       Common options for lvm:
47           [ -d|--debug ]
48           [ -h|--help ]
49           [ -q|--quiet ]
50           [ -t|--test ]
51           [ -v|--verbose ]
52           [ -y|--yes ]
53           [    --commandprofile String ]
54           [    --config String ]
55           [    --devices PV ]
56           [    --devicesfile String ]
57           [    --driverloaded y|n ]
58           [    --journal String ]
59           [    --lockopt String ]
60           [    --longhelp ]
61           [    --nohints ]
62           [    --nolocking ]
63           [    --profile String ]
64           [    --version ]
65

OPTIONS

67       --aligned
68              Use with --separator to align the output columns
69
70       -a|--all
71
72       --binary
73              Use binary values "0" or "1" instead of descriptive literal val‐
74              ues for columns that have exactly two  valid  values  to  report
75              (not  counting  the "unknown" value which denotes that the value
76              could not be determined).
77
78       --commandprofile String
79              The command profile  to  use  for  command  configuration.   See
80              lvm.conf(5) for more information about profiles.
81
82       --config String
83              Config settings for the command. These override lvm.conf(5) set‐
84              tings.  The String arg uses the same format as  lvm.conf(5),  or
85              may use section/field syntax.  See lvm.conf(5) for more informa‐
86              tion about config.
87
88       --configreport log|vg|lv|pv|pvseg|seg
89              See lvmreport(7).
90
91       -d|--debug ...
92              Set debug level. Repeat from 1 to 6 times to increase the detail
93              of messages sent to the log file and/or syslog (if configured).
94
95       --devices PV
96              Restricts  the  devices  that  are visible and accessible to the
97              command.  Devices not listed will appear to be missing. This op‐
98              tion  can  be repeated, or accepts a comma separated list of de‐
99              vices. This overrides the devices file.
100
101       --devicesfile String
102              A file listing devices that LVM should use.  The file must exist
103              in  /etc/lvm/devices/ and is managed with the lvmdevices(8) com‐
104              mand.  This overrides the  lvm.conf(5)  devices/devicesfile  and
105              devices/use_devicesfile settings.
106
107       --driverloaded y|n
108              If set to no, the command will not attempt to use device-mapper.
109              For testing and debugging.
110
111       --foreign
112              Report/display foreign VGs that would otherwise be skipped.  See
113              lvmsystemid(7) for more information about foreign VGs.
114
115       -h|--help
116              Display help text.
117
118       --ignorelockingfailure
119              Allows  a command to continue with read-only metadata operations
120              after locking failures.
121
122       --journal String
123              Record information in the systemd journal.  This information  is
124              in  addition  to information enabled by the lvm.conf log/journal
125              setting.  command: record information about the  command.   out‐
126              put: record the default command output.  debug: record full com‐
127              mand debugging.
128
129       --lockopt String
130              Used to pass options for special cases to  lvmlockd.   See  lvm‐
131              lockd(8) for more information.
132
133       --logonly
134              Suppress command report and display only log report.
135
136       --longhelp
137              Display long help text.
138
139       --nameprefixes
140              Add  an "LVM2_" prefix plus the field name to the output. Useful
141              with --noheadings to produce a list of  field=value  pairs  that
142              can  be  used to set environment variables (for example, in udev
143              rules).
144
145       --noheadings
146              Suppress the headings line that is normally the  first  line  of
147              output.  Useful if grepping the output.
148
149       --nohints
150              Do  not  use the hints file to locate devices for PVs. A command
151              may read more devices to find PVs when hints are not  used.  The
152              command will still perform standard hint file invalidation where
153              appropriate.
154
155       --nolocking
156              Disable locking. Use with caution, concurrent commands may  pro‐
157              duce incorrect results.
158
159       --nosuffix
160              Suppress  the suffix on output sizes. Use with --units (except h
161              and H) if processing the output.
162
163       -o|--options String
164              Comma-separated, ordered list of fields to display  in  columns.
165              String  arg  syntax is: [+|-|#]Field1[,Field2 ...]  The prefix +
166              will append the specified fields to the default fields,  -  will
167              remove  the specified fields from the default fields, and # will
168              compact specified fields  (removing  them  when  empty  for  all
169              rows.)   Use  -o  help to view the list of all available fields.
170              Use separate lists of fields to add, remove or  compact  by  re‐
171              peating   the   -o   option:  -o+field1,field2  -o-field3,field4
172              -o#field5.  These lists are evaluated from left to  right.   Use
173              field  name  lv_all to view all LV fields, vg_all all VG fields,
174              pv_all all PV fields, pvseg_all all PV segment  fields,  seg_all
175              all  LV  segment  fields,  and pvseg_all all PV segment columns.
176              See the lvm.conf(5) report section for more config options.  See
177              lvmreport(7) for more information about reporting.
178
179       --profile String
180              An alias for --commandprofile or --metadataprofile, depending on
181              the command.
182
183       -q|--quiet ...
184              Suppress output and log messages. Overrides --debug  and  --ver‐
185              bose.   Repeat  once  to  also  suppress any prompts with answer
186              'no'.
187
188       --readonly
189              Run the command in a special read-only mode which will read  on-
190              disk  metadata  without  needing  to take any locks. This can be
191              used to peek inside metadata used by  a  virtual  machine  image
192              while the virtual machine is running. No attempt will be made to
193              communicate with the device-mapper kernel driver, so this option
194              is unable to report whether or not LVs are actually in use.
195
196       --reportformat basic|json|json_std
197              Overrides  current  output  format  for reports which is defined
198              globally by the  report/output_format  setting  in  lvm.conf(5).
199              basic is the original format with columns and rows.  If there is
200              more than one report per command, each report is  prefixed  with
201              the  report name for identification. json produces report output
202              in JSON format. json_std produces report output in  JSON  format
203              which  is  more  compliant with JSON standard.  See lvmreport(7)
204              for more information.
205
206       --rows
207              Output columns as rows.
208
209       -S|--select String
210              Select objects for processing and reporting based  on  specified
211              criteria.  The criteria syntax is described by --select help and
212              lvmreport(7).  For reporting commands, one row is displayed  for
213              each  object  matching the criteria.  See --options help for se‐
214              lectable object fields.  Rows can be displayed with an addition‐
215              al  "selected"  field (-o selected) showing 1 if the row matches
216              the selection and 0 otherwise.  For non-reporting commands which
217              process  LVM  entities, the selection is used to choose items to
218              process.
219
220       --separator String
221              String to use to separate each column. Useful  if  grepping  the
222              output.
223
224       --shared
225              Report/display  shared  VGs that would otherwise be skipped when
226              lvmlockd is not being used on the  host.   See  lvmlockd(8)  for
227              more information about shared VGs.
228
229       -O|--sort String
230              Comma-separated ordered list of columns to sort by. Replaces the
231              default selection. Precede any column with - for a reverse  sort
232              on that column.
233
234       -t|--test
235              Run  in  test  mode. Commands will not update metadata.  This is
236              implemented by disabling all metadata writing  but  nevertheless
237              returning  success to the calling function. This may lead to un‐
238              usual error messages in multi-stage operations if a tool  relies
239              on reading back metadata it believes has changed but hasn't.
240
241       --unbuffered
242              Produce  output immediately without sorting or aligning the col‐
243              umns properly.
244
245       --units [Number]r|R|h|H|b|B|s|S|k|K|m|M|g|G|t|T|p|P|e|E
246              All sizes are output in these units: human-(r)eadable  with  '<'
247              rounding   indicator,   (h)uman-readable,   (b)ytes,  (s)ectors,
248              (k)ilobytes, (m)egabytes, (g)igabytes, (t)erabytes, (p)etabytes,
249              (e)xabytes.   Capitalise to use multiples of 1000 (S.I.) instead
250              of 1024.  Custom units can be specified, e.g. --units 3M.
251
252       --unquoted
253              When used with --nameprefixes, output values in the  field=value
254              pairs are not quoted.
255
256       -v|--verbose ...
257              Set  verbose level. Repeat from 1 to 4 times to increase the de‐
258              tail of messages sent to stdout and stderr.
259
260       --version
261              Display version information.
262
263       -y|--yes
264              Do not prompt for confirmation interactively but  always  assume
265              the  answer  yes.  Use with extreme caution.  (For automatic no,
266              see -qq.)
267

VARIABLES

269       VG     Volume Group name.  See lvm(8) for valid names.
270
271       String See the option description for information about the string con‐
272              tent.
273
274       Size[UNIT]
275              Size  is  an  input number that accepts an optional unit.  Input
276              units are always treated as base two values, regardless of capi‐
277              talization,  e.g.  'k'  and 'K' both refer to 1024.  The default
278              input unit is specified by letter, followed by |UNIT.  UNIT rep‐
279              resents other possible input units: b|B is bytes, s|S is sectors
280              of 512 bytes, k|K is KiB, m|M is MiB, g|G is GiB,  t|T  is  TiB,
281              p|P  is  PiB, e|E is EiB.  (This should not be confused with the
282              output control --units, where capital letters mean  multiple  of
283              1000.)
284

ENVIRONMENT VARIABLES

286       See  lvm(8)  for  information  about environment variables used by lvm.
287       For example, LVM_VG_NAME can generally be substituted for a required VG
288       parameter.
289

SEE ALSO

291       lvm(8), lvm.conf(5), lvmconfig(8), lvmdevices(8),
292
293       pvchange(8), pvck(8), pvcreate(8), pvdisplay(8), pvmove(8),
294       pvremove(8), pvresize(8), pvs(8), pvscan(8),
295
296       vgcfgbackup(8), vgcfgrestore(8), vgchange(8), vgck(8), vgcreate(8),
297       vgconvert(8), vgdisplay(8), vgexport(8), vgextend(8), vgimport(8),
298       vgimportclone(8), vgimportdevices(8), vgmerge(8), vgmknodes(8),
299       vgreduce(8), vgremove(8), vgrename(8), vgs(8), vgscan(8), vgsplit(8),
300
301       lvcreate(8), lvchange(8), lvconvert(8), lvdisplay(8), lvextend(8),
302       lvreduce(8), lvremove(8), lvrename(8), lvresize(8), lvs(8), lvscan(8),
303
304       lvm-fullreport(8), lvm-lvpoll(8), blkdeactivate(8), lvmdump(8),
305
306       dmeventd(8), lvmpolld(8), lvmlockd(8), lvmlockctl(8), cmirrord(8),
307       lvmdbusd(8), fsadm(8),
308
309       lvmsystemid(7), lvmreport(7), lvmraid(7), lvmthin(7), lvmcache(7)
310
311
312
313LVM TOOLS 2.03.18(2)-git (2022-11-10)  8                       LVM(FULLREPORT)
Impressum