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