sparsify/virt-sparsify.pod

   1 =encoding utf8
   2
   3 =head1 NAME
   4
   5 virt-sparsify - Make a virtual machine disk sparse
   6
   7 =head1 SYNOPSIS
   8
   9  virt-sparsify [--options] indisk outdisk
  10
  11 =head1 DESCRIPTION
  12
  13 Virt-sparsify is a tool which can make a virtual machine disk (or any
  14 disk image) sparse a.k.a. thin-provisioned.  This means that free
  15 space within the disk image can be converted back to free space on the
  16 host.
  17
  18 Virt-sparsify can locate and sparsify free space in most filesystems
  19 (eg. ext2/3/4, btrfs, NTFS, etc.), and also in LVM physical volumes.
  20
  21 Virt-sparsify can also convert between some disk formats, for example
  22 converting a raw disk image to a thin-provisioned qcow2 image.
  23
  24 Virt-sparsify can operate on any disk image, not just ones from
  25 virtual machines.  If a virtual machine has more than one attached
  26 disk, you must sparsify each one separately.
  27
  28 =head2 IMPORTANT LIMITATIONS
  29
  30 =over 4
  31
  32 =item *
  33
  34 Virt-sparsify does not do in-place modifications.  It copies from a
  35 source image to a destination image, leaving the source unchanged.
  36 I<Check that the sparsification was successful before deleting the
  37 source image>.
  38
  39 =item *
  40
  41 The virtual machine I<must be shut down> before using this tool.
  42
  43 =item *
  44
  45 Virt-sparsify may require up to 2x the virtual size of the source disk
  46 image (1 temporary copy + 1 destination image).  This is in the worst
  47 case and usually much less space is required.
  48
  49 =item *
  50
  51 Virt-sparsify cannot resize disk images.  To do that, use
  52 L<virt-resize(1)>.
  53
  54 =item *
  55
  56 Virt-sparsify cannot handle encrypted disks.
  57
  58 =item *
  59
  60 Virt-sparsify cannot yet sparsify the space between partitions.  Note
  61 that this space is often used for critical items like bootloaders so
  62 it's not really unused.
  63
  64 =item *
  65
  66 Virt-sparsify does not yet know how to sparsify swapspace.  It is not
  67 safe to do this unless we can be sure there is no hibernation data, so
  68 at the moment swap partitions are ignored.
  69
  70 =back
  71
  72 You may also want to read the manual pages for the associated tools
  73 L<virt-filesystems(1)> and L<virt-df(1)> before starting.
  74
  75 =head1 EXAMPLES
  76
  77 Typical usage is:
  78
  79  virt-sparsify indisk outdisk
  80
  81 which copies C<indisk> to C<outdisk>, making the output sparse.
  82 C<outdisk> is created, or overwritten if it already exists.  The
  83 format of the input disk is detected (eg. qcow2) and the same format
  84 is used for the output disk.
  85
  86 To convert between formats, use the I<--convert> option:
  87
  88  virt-sparsify disk.raw --convert qcow2 disk.qcow2
  89
  90 Virt-sparsify tries to zero and sparsify free space on every
  91 filesystem it can find within the source disk image.  You can get it
  92 to ignore (don't zero free space on) certain filesystems by doing:
  93
  94  virt-sparsify --ignore /dev/sda1 indisk outdisk
  95
  96 See L<virt-filesystems(1)> to get a list of filesystems within a disk
  97 image.
  98
  99 =head1 OPTIONS
 100
 101 =over 4
 102
 103 =item B<--help>
 104
 105 Display help.
 106
 107 =item B<--convert> raw
 108
 109 =item B<--convert> qcow2
 110
 111 =item B<--convert> [other formats]
 112
 113 Use C<output-format> as the format for the destination image.  If this
 114 is not specified, then the input format is used.
 115
 116 Supported and known-working output formats are: C<raw>, C<qcow2>, C<vdi>.
 117
 118 You can also use any format supported by the L<qemu-img(1)> program,
 119 eg. C<vmdk>, but support for other formats is reliant on qemu.
 120
 121 Specifying the I<--convert> option is usually a good idea, because
 122 then virt-sparsify doesn't need to try to guess the input format.
 123
 124 =item B<--debug-gc>
 125
 126 Debug garbage collection and memory allocation.  This is only useful
 127 when debugging memory problems in virt-sparsify or the OCaml libguestfs
 128 bindings.
 129
 130 =item B<--format> raw
 131
 132 =item B<--format> qcow2
 133
 134 Specify the format of the input disk image.  If this flag is not
 135 given then it is auto-detected from the image itself.
 136
 137 If working with untrusted raw-format guest disk images, you should
 138 ensure the format is always specified.
 139
 140 =item B<--ignore> filesystem
 141
 142 =item B<--ignore> volgroup
 143
 144 Ignore the named filesystem.  Free space on the filesystem will not be
 145 zeroed, but existing blocks of zeroes will still be sparsified.
 146
 147 In the second form, this ignores the named volume group.  Use the
 148 volume group name without the C</dev/> prefix, eg. I<--ignore vg_foo>
 149
 150 You can give this option multiple times.
 151
 152 =item B<--machine-readable>
 153
 154 This option is used to make the output more machine friendly
 155 when being parsed by other programs.  See
 156 L</MACHINE READABLE OUTPUT> below.
 157
 158 =item B<-q>
 159
 160 =item B<--quiet>
 161
 162 This disables progress bars and other unnecessary output.
 163
 164 =item B<-v>
 165
 166 =item B<--verbose>
 167
 168 Enable verbose messages for debugging.
 169
 170 =item B<-V>
 171
 172 =item B<--version>
 173
 174 Display version number and exit.
 175
 176 =item B<-x>
 177
 178 Enable tracing of libguestfs API calls.
 179
 180 =back
 181
 182 =head1 MACHINE READABLE OUTPUT
 183
 184 The I<--machine-readable> option can be used to make the output more
 185 machine friendly, which is useful when calling virt-sparsify from
 186 other programs, GUIs etc.
 187
 188 There are two ways to use this option.
 189
 190 Firstly use the option on its own to query the capabilities of the
 191 virt-sparsify binary.  Typical output looks like this:
 192
 193  $ virt-sparsify --machine-readable
 194  virt-sparsify
 195  ntfs
 196  btrfs
 197
 198 A list of features is printed, one per line, and the program exits
 199 with status 0.
 200
 201 Secondly use the option in conjunction with other options to make the
 202 regular program output more machine friendly.
 203
 204 At the moment this means:
 205
 206 =over 4
 207
 208 =item 1.
 209
 210 Progress bar messages can be parsed from stdout by looking for this
 211 regular expression:
 212
 213  ^[0-9]+/[0-9]+$
 214
 215 =item 2.
 216
 217 The calling program should treat messages sent to stdout (except for
 218 progress bar messages) as status messages.  They can be logged and/or
 219 displayed to the user.
 220
 221 =item 3.
 222
 223 The calling program should treat messages sent to stderr as error
 224 messages.  In addition, virt-sparsify exits with a non-zero status
 225 code if there was a fatal error.
 226
 227 =back
 228
 229 All versions of virt-sparsify have supported the I<--machine-readable>
 230 option.
 231
 232 =head1 EXIT STATUS
 233
 234 This program returns 0 if successful, or non-zero if there was an
 235 error.
 236
 237 =head1 ENVIRONMENT VARIABLES
 238
 239 =over 4
 240
 241 =item TMPDIR
 242
 243 Location of the temporary directory used for the potentially large
 244 temporary overlay file.
 245
 246 You should ensure there is enough free space in the worst case for a
 247 full copy of the source disk (I<virtual> size), or else set C<$TMPDIR>
 248 to point to another directory that has enough space.
 249
 250 This defaults to C</tmp>.
 251
 252 =back
 253
 254 For other environment variables, see L<guestfs(3)/ENVIRONMENT VARIABLES>.
 255
 256 =head1 SEE ALSO
 257
 258 L<virt-filesystems(1)>,
 259 L<virt-df(1)>,
 260 L<virt-resize(1)>,
 261 L<virt-rescue(1)>,
 262 L<guestfs(3)>,
 263 L<guestfish(1)>,
 264 L<truncate(1)>,
 265 L<fallocate(1)>,
 266 L<qemu-img(1)>,
 267 L<http://libguestfs.org/>.
 268
 269 =head1 AUTHOR
 270
 271 Richard W.M. Jones L<http://people.redhat.com/~rjones/>
 272
 273 =head1 COPYRIGHT
 274
 275 Copyright (C) 2011 Red Hat Inc.
 276
 277 This program is free software; you can redistribute it and/or modify
 278 it under the terms of the GNU General Public License as published by
 279 the Free Software Foundation; either version 2 of the License, or
 280 (at your option) any later version.
 281
 282 This program is distributed in the hope that it will be useful,
 283 but WITHOUT ANY WARRANTY; without even the implied warranty of
 284 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 285 GNU General Public License for more details.
 286
 287 You should have received a copy of the GNU General Public License
 288 along with this program; if not, write to the Free Software
 289 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.