Version 1.11.2.
[libguestfs.git] / cat / virt-filesystems.pod
1 =encoding utf8
2
3 =head1 NAME
4
5 virt-filesystems - List filesystems, partitions, block devices, LVM in a virtual machine or disk image
6
7 =head1 SYNOPSIS
8
9  virt-filesystems [--options] -d domname
10
11  virt-filesystems [--options] -a disk.img [-a disk.img ...]
12
13 =head1 DESCRIPTION
14
15 This tool allows you to discover filesystems, partitions, logical
16 volumes, and their sizes in a disk image or virtual machine.  It is a
17 replacement for L<virt-list-filesystems(1)> and
18 L<virt-list-partitions(1)>.
19
20 One use for this tool is from shell scripts to iterate over all
21 filesystems from a disk image:
22
23  for fs in $(virt-filesystems -a disk.img); do
24    # ...
25  done
26
27 Another use is to list partitions before using another tool to modify
28 those partitions (such as L<virt-resize(1)>).  If you are curious
29 about what an unknown disk image contains, use this tool along with
30 L<virt-inspector(1)>.
31
32 Various command line options control what this program displays.  You
33 need to give either I<-a> or I<-d> options to specify the disk image
34 or libvirt guest respectively.  If you just specify that then the
35 program shows filesystems found, one per line, like this:
36
37  $ virt-filesystems -a disk.img
38  /dev/sda1
39  /dev/vg_guest/lv_root
40
41 If you add I<-l> or I<--long> then the output includes extra
42 information:
43
44  $ virt-filesystems -a disk.img -l
45  Name                   Type         VFS   Label  Size
46  /dev/sda1              filesystem   ext4  boot   524288000
47  /dev/vg_guest/lv_root  filesystem   ext4  root   10212081664
48
49 If you add I<--extra> then non-mountable (swap, unknown) filesystems
50 are shown as well:
51
52  $ virt-filesystems -a disk.img --extra
53  /dev/sda1
54  /dev/vg_guest/lv_root
55  /dev/vg_guest/lv_swap
56  /dev/vg_guest/lv_data
57
58 If you add I<--partitions> then partitions are shown instead of filesystems:
59
60  $ virt-filesystems -a disk.img --partitions
61  /dev/sda1
62  /dev/sda2
63
64 Similarly you can use I<--logical-volumes>, I<--volume-groups>,
65 I<--physical-volumes>, I<--block-devices> to list those items.
66
67 You can use these options in combination as well (if you want a
68 combination including filesystems, you have to add I<--filesystems>).
69 Notice that some items fall into several categories (eg. C</dev/sda1>
70 might be both a partition and a filesystem).  These items are listed
71 several times.  To get a list which includes absolutely everything
72 that virt-filesystems knows about, use the I<--all> option.
73
74 UUIDs (because they are quite long) are not shown by default.  Add the
75 I<--uuid> option to display device and filesystem UUIDs in the long
76 output.
77
78 I<--all --long --uuid> is a useful combination to display all possible
79 information about everything.
80
81  $ virt-filesystems -a win.img --all --long --uuid -h
82  Name      Type       VFS  Label           Size Parent   UUID
83  /dev/sda1 filesystem ntfs System Reserved 100M -        F81C92571C92112C
84  /dev/sda2 filesystem ntfs -               20G  -        F2E8996AE8992E3B
85  /dev/sda1 partition  -    -               100M /dev/sda -
86  /dev/sda2 partition  -    -               20G  /dev/sda -
87  /dev/sda  device     -    -               20G  -        -
88
89 For machine-readable output, use I<--csv> to get Comma-Separated Values.
90
91 =head1 OPTIONS
92
93 =over 4
94
95 =item B<--help>
96
97 Display brief help.
98
99 =item B<-a> file
100
101 =item B<--add> file
102
103 Add I<file> which should be a disk image from a virtual machine.  If
104 the virtual machine has multiple block devices, you must supply all of
105 them with separate I<-a> options.
106
107 The format of the disk image is auto-detected.  To override this and
108 force a particular format use the I<--format=..> option.
109
110 =item B<--all>
111
112 Display everything.  This is currently the same as specifying these
113 options: I<--filesystems>, I<--extra>, I<--partitions>,
114 I<--block-devices>, I<--logical-volumes>, I<--volume-groups>,
115 I<--physical-volumes>.  (More may be added to this list in future).
116
117 See also I<--long>.
118
119 =item B<--blkdevs>
120
121 =item B<--block-devices>
122
123 Display block devices.
124
125 =item B<-c> URI
126
127 =item B<--connect> URI
128
129 If using libvirt, connect to the given I<URI>.  If omitted, then we
130 connect to the default libvirt hypervisor.
131
132 If you specify guest block devices directly (I<-a>), then libvirt is
133 not used at all.
134
135 =item B<--csv>
136
137 Write out the results in CSV format (comma-separated values).  This
138 format can be imported easily into databases and spreadsheets, but
139 read L</NOTE ABOUT CSV FORMAT> below.
140
141 =item B<-d> guest
142
143 =item B<--domain> guest
144
145 Add all the disks from the named libvirt guest.
146
147 =item B<--echo-keys>
148
149 When prompting for keys and passphrases, virt-filesystems normally
150 turns echoing off so you cannot see what you are typing.  If you are
151 not worried about Tempest attacks and there is no one else in the room
152 you can specify this flag to see what you are typing.
153
154 =item B<--extra>
155
156 This causes filesystems that are not ordinary, mountable filesystems
157 to be displayed.  This category includes swapspace, and filesystems
158 that are empty or contain unknown data.
159
160 This option implies I<--filesystems>.
161
162 =item B<--filesystems>
163
164 Display mountable filesystems.  If no display option was selected then
165 this option is implied.
166
167 With I<--extra>, non-mountable filesystems are shown too.
168
169 =item B<--format=raw|qcow2|..>
170
171 =item B<--format>
172
173 The default for the I<-a> option is to auto-detect the format of the
174 disk image.  Using this forces the disk format for I<-a> options which
175 follow on the command line.  Using I<--format> with no argument
176 switches back to auto-detection for subsequent I<-a> options.
177
178 For example:
179
180  virt-filesystems --format=raw -a disk.img
181
182 forces raw format (no auto-detection) for C<disk.img>.
183
184  virt-filesystems --format=raw -a disk.img --format -a another.img
185
186 forces raw format (no auto-detection) for C<disk.img> and reverts to
187 auto-detection for C<another.img>.
188
189 If you have untrusted raw-format guest disk images, you should use
190 this option to specify the disk format.  This avoids a possible
191 security problem with malicious guests (CVE-2010-3851).
192
193 =item B<-h>
194
195 =item B<--human-readable>
196
197 In I<--long> mode, display sizes in human-readable format.
198
199 =item B<--keys-from-stdin>
200
201 Read key or passphrase parameters from stdin.  The default is
202 to try to read passphrases from the user by opening C</dev/tty>.
203
204 =item B<-l>
205
206 =item B<--long>
207
208 Display extra columns of data ("long format").
209
210 A title row is added unless you also specify I<--no-title>.
211
212 The extra columns displayed depend on what output you select, and the
213 ordering of columns may change in future versions.  Use the title row,
214 I<--csv> output and/or L<csvtool(1)> to match columns to data in
215 external programs.
216
217 Use I<-h> if you want sizes to be displayed in human-readable format.
218 The default is to show raw numbers of I<bytes>.
219
220 Use I<--uuid> to display UUIDs too.
221
222 =item B<--lvs>
223
224 =item B<--logvols>
225
226 =item B<--logical-volumes>
227
228 Display LVM logical volumes.  In this mode, these are displayed
229 irrespective of whether the LVs contain filesystems.
230
231 =item B<--no-title>
232
233 In I<--long> mode, don't add a title row.
234
235 Note that the order of the columns is not fixed, and may change in
236 future versions of virt-filesystems, so using this option may give you
237 unexpected surprises.
238
239 =item B<--parts>
240
241 =item B<--partitions>
242
243 Display partitions.  In this mode, these are displayed
244 irrespective of whether the partitions contain filesystems.
245
246 =item B<--pvs>
247
248 =item B<--physvols>
249
250 =item B<--physical-volumes>
251
252 Display LVM physical volumes.
253
254 =item B<--uuid>
255
256 =item B<--uuids>
257
258 In I<--long> mode, display UUIDs as well.
259
260 =item B<-v>
261
262 =item B<--verbose>
263
264 Enable verbose messages for debugging.
265
266 =item B<-V>
267
268 =item B<--version>
269
270 Display version number and exit.
271
272 =item B<--vgs>
273
274 =item B<--volgroups>
275
276 =item B<--volume-groups>
277
278 Display LVM volume groups.
279
280 =item B<-x>
281
282 Enable tracing of libguestfs API calls.
283
284 =back
285
286 =head1 COLUMNS
287
288 Note that columns in the output are subject to reordering and change
289 in future versions of this tool.
290
291 =over 4
292
293 =item B<Name>
294
295 The filesystem, partition, block device or LVM name.
296
297 For device and partition names these are displayed as canonical
298 libguestfs names, so that for example C</dev/sda2> is the second
299 partition on the first device.
300
301 If the I<--long> option is B<not> specified, then only the name column
302 is shown in the output.
303
304 =item B<Type>
305
306 The object type, for example C<filesystem>, C<lv>, C<device> etc.
307
308 =item B<VFS>
309
310 If there is a filesystem, then this column displays the filesystem
311 type if one could be detected, eg. C<ext4>.
312
313 =item B<Label>
314
315 If the object has a label (used for identifying and mounting
316 filesystems) then this column contains the label.
317
318 =item B<Size>
319
320 The size of the object in bytes.  If the I<--human> option is used
321 then the size is displayed in a human-readable form.
322
323 =item B<Parent>
324
325 The parent column records the parent relationship between objects.
326 For example, if the object is a partition, then this column contains
327 the name of the containing device.  If the object is a logical volume,
328 then this column is the name of the volume group.
329
330 =item B<UUID>
331
332 If the object has a UUID (used for identifying and mounting
333 filesystems and block devices) then this column contains the UUID as a
334 string.
335
336 The UUID is only displayed if the I<--uuid> option is given.
337
338 =back
339
340 =head1 NOTE ABOUT CSV FORMAT
341
342 Comma-separated values (CSV) is a deceptive format.  It I<seems> like
343 it should be easy to parse, but it is definitely not easy to parse.
344
345 Myth: Just split fields at commas.  Reality: This does I<not> work
346 reliably.  This example has two columns:
347
348  "foo,bar",baz
349
350 Myth: Read the file one line at a time.  Reality: This does I<not>
351 work reliably.  This example has one row:
352
353  "foo
354  bar",baz
355
356 For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv>
357 also packaged in major Linux distributions).
358
359 For other languages, use a CSV processing library (eg. C<Text::CSV>
360 for Perl or Python's built-in csv library).
361
362 Most spreadsheets and databases can import CSV directly.
363
364 =head1 SHELL QUOTING
365
366 Libvirt guest names can contain arbitrary characters, some of which
367 have meaning to the shell such as C<#> and space.  You may need to
368 quote or escape these characters on the command line.  See the shell
369 manual page L<sh(1)> for details.
370
371 =head1 SEE ALSO
372
373 L<guestfs(3)>,
374 L<guestfish(1)>,
375 L<virt-cat(1)>,
376 L<virt-df(1)>,
377 L<virt-list-filesystems(1)>,
378 L<virt-list-partitions(1)>,
379 L<csvtool(1)>,
380 L<http://libguestfs.org/>.
381
382 =head1 AUTHOR
383
384 Richard W.M. Jones L<http://people.redhat.com/~rjones/>
385
386 =head1 COPYRIGHT
387
388 Copyright (C) 2010 Red Hat Inc.
389
390 This program is free software; you can redistribute it and/or modify
391 it under the terms of the GNU General Public License as published by
392 the Free Software Foundation; either version 2 of the License, or
393 (at your option) any later version.
394
395 This program is distributed in the hope that it will be useful,
396 but WITHOUT ANY WARRANTY; without even the implied warranty of
397 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
398 GNU General Public License for more details.
399
400 You should have received a copy of the GNU General Public License
401 along with this program; if not, write to the Free Software
402 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.