df/virt-df.pod

   1 =encoding utf8
   2
   3 =head1 NAME
   4
   5 virt-df - Display free space on virtual filesystems
   6
   7 =head1 SYNOPSIS
   8
   9  virt-df [--options]
  10
  11  virt-df [--options] -d domname
  12
  13  virt-df [--options] -a disk.img [-a disk.img ...]
  14
  15 Old style:
  16
  17  virt-df [--options] domname
  18
  19  virt-df [--options] disk.img [disk.img ...]
  20
  21 =head1 DESCRIPTION
  22
  23 C<virt-df> is a command line tool to display free space on virtual
  24 machine filesystems.  Unlike other tools, it doesn't just display the
  25 size of disk allocated to a virtual machine, but can look inside disk
  26 images to see how much space is really being used.
  27
  28 If used without any I<-a> or I<-d> arguments, C<virt-df> checks with
  29 libvirt to get a list of all active and inactive guests, and performs
  30 a C<df>-type operation on each one in turn, printing out the results.
  31
  32 If any I<-a> or I<-d> arguments are specified, C<virt-df> performs a
  33 C<df>-type operation on either the single named libvirt domain, or on
  34 the disk image(s) listed on the command line (which must all belong to
  35 a single VM).  In this mode (with arguments), C<virt-df> will I<only
  36 work for a single guest>.  If you want to run on multiple guests, then
  37 you have to invoke C<virt-df> multiple times.
  38
  39 Use the I<--csv> option to get a format which can be easily parsed by
  40 other programs.  Other options are similar to the standard L<df(1)>
  41 command.
  42
  43 =head1 EXAMPLES
  44
  45 Show disk usage for a single libvirt guest called C<F14x64>.  Make the
  46 output human-readable:
  47
  48  # virt-df -d F14x64 -h
  49  Filesystem                       Size     Used  Available  Use%
  50  F14x64:/dev/sda1                 484M      66M       393M   14%
  51  F14x64:/dev/vg_f13x64/lv_root    7.4G     3.4G       4.0G   46%
  52
  53 Show disk usage for a disk image file called C<test.img>:
  54
  55  $ virt-df -a test1.img
  56  Filesystem                  1K-blocks     Used  Available  Use%
  57  test1.img:/dev/sda1             99099     1551      92432    2%
  58
  59 =head1 OPTIONS
  60
  61 =over 4
  62
  63 =item B<--help>
  64
  65 Display brief help.
  66
  67 =item B<-a> file
  68
  69 =item B<--add> file
  70
  71 Add I<file> which should be a disk image from a virtual machine.  If
  72 the virtual machine has multiple block devices, you must supply all of
  73 them with separate I<-a> options.
  74
  75 The format of the disk image is auto-detected.  To override this and
  76 force a particular format use the I<--format=..> option.
  77
  78 =item B<-c> URI
  79
  80 =item B<--connect> URI
  81
  82 If using libvirt, connect to the given I<URI>.  If omitted, then we
  83 connect to the default libvirt hypervisor.
  84
  85 If you specify guest block devices directly (I<-a>), then libvirt is
  86 not used at all.
  87
  88 =item B<--csv>
  89
  90 Write out the results in CSV format (comma-separated values).  This
  91 format can be imported easily into databases and spreadsheets, but
  92 read L</NOTE ABOUT CSV FORMAT> below.
  93
  94 =item B<-d> guest
  95
  96 =item B<--domain> guest
  97
  98 Add all the disks from the named libvirt guest.
  99
 100 =item B<--format=raw|qcow2|..>
 101
 102 =item B<--format>
 103
 104 The default for the I<-a> option is to auto-detect the format of the
 105 disk image.  Using this forces the disk format for I<-a> options which
 106 follow on the command line.  Using I<--format> with no argument
 107 switches back to auto-detection for subsequent I<-a> options.
 108
 109 For example:
 110
 111  virt-df --format=raw -a disk.img
 112
 113 forces raw format (no auto-detection) for C<disk.img>.
 114
 115  virt-df --format=raw -a disk.img --format -a another.img
 116
 117 forces raw format (no auto-detection) for C<disk.img> and reverts to
 118 auto-detection for C<another.img>.
 119
 120 If you have untrusted raw-format guest disk images, you should use
 121 this option to specify the disk format.  This avoids a possible
 122 security problem with malicious guests (CVE-2010-3851).
 123
 124 =item B<-h>
 125
 126 =item B<--human-readable>
 127
 128 Print sizes in human-readable format.
 129
 130 You are not allowed to use I<-h> and I<--csv> at the same time.
 131
 132 =item B<--inodes> | B<-i>
 133
 134 Print inodes instead of blocks.
 135
 136 =item B<--one-per-guest>
 137
 138 Run one libguestfs appliance per guest.  Normally C<virt-df> will
 139 add the disks from several guests to a single libguestfs appliance.
 140
 141 You might use this option in the following circumstances:
 142
 143 =over 4
 144
 145 =item *
 146
 147 If you think an untrusted guest might actively try to exploit the
 148 libguestfs appliance kernel, then this prevents one guest from
 149 interfering with the stats printed for another guest.
 150
 151 =item *
 152
 153 If the kernel has a bug which stops it from accessing a
 154 filesystem in one guest (see for example RHBZ#635373) then
 155 this allows libguestfs to continue and report stats for further
 156 guests.
 157
 158 =back
 159
 160 =item B<--uuid>
 161
 162 Print UUIDs instead of names.  This is useful for following
 163 a guest even when the guest is migrated or renamed, or when
 164 two guests happen to have the same name.
 165
 166 Note that only domains that we fetch from libvirt come with UUIDs.
 167 For disk images, we still print the disk image name even when
 168 this option is specified.
 169
 170 =item B<-v>
 171
 172 =item B<--verbose>
 173
 174 Enable verbose messages for debugging.
 175
 176 =item B<-V>
 177
 178 =item B<--version>
 179
 180 Display version number and exit.
 181
 182 =item B<-x>
 183
 184 Enable tracing of libguestfs API calls.
 185
 186 =back
 187
 188 =head1 NOTE ABOUT CSV FORMAT
 189
 190 Comma-separated values (CSV) is a deceptive format.  It I<seems> like
 191 it should be easy to parse, but it is definitely not easy to parse.
 192
 193 Myth: Just split fields at commas.  Reality: This does I<not> work
 194 reliably.  This example has two columns:
 195
 196  "foo,bar",baz
 197
 198 Myth: Read the file one line at a time.  Reality: This does I<not>
 199 work reliably.  This example has one row:
 200
 201  "foo
 202  bar",baz
 203
 204 For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv>
 205 also packaged in major Linux distributions).
 206
 207 For other languages, use a CSV processing library (eg. C<Text::CSV>
 208 for Perl or Python's built-in csv library).
 209
 210 Most spreadsheets and databases can import CSV directly.
 211
 212 =head1 SHELL QUOTING
 213
 214 Libvirt guest names can contain arbitrary characters, some of which
 215 have meaning to the shell such as C<#> and space.  You may need to
 216 quote or escape these characters on the command line.  See the shell
 217 manual page L<sh(1)> for details.
 218
 219 =head1 SEE ALSO
 220
 221 L<df(1)>,
 222 L<guestfs(3)>,
 223 L<guestfish(1)>,
 224 L<virt-filesystems(1)>,
 225 L<http://libguestfs.org/>.
 226
 227 =head1 AUTHOR
 228
 229 Richard W.M. Jones L<http://people.redhat.com/~rjones/>
 230
 231 =head1 COPYRIGHT
 232
 233 Copyright (C) 2009-2011 Red Hat Inc.
 234
 235 This program is free software; you can redistribute it and/or modify
 236 it under the terms of the GNU General Public License as published by
 237 the Free Software Foundation; either version 2 of the License, or
 238 (at your option) any later version.
 239
 240 This program is distributed in the hope that it will be useful,
 241 but WITHOUT ANY WARRANTY; without even the implied warranty of
 242 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 243 GNU General Public License for more details.
 244
 245 You should have received a copy of the GNU General Public License
 246 along with this program; if not, write to the Free Software
 247 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.