3 # Copyright (C) 2009-2010 Red Hat Inc.
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 2 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 use Sys::Guestfs::Lib qw(open_guest);
27 use Locale::TextDomain 'libguestfs';
33 virt-tar - Extract or upload files to a virtual machine
37 virt-tar [--options] -x domname directory tarball
39 virt-tar [--options] -u domname tarball directory
41 virt-tar [--options] disk.img [disk.img ...] -x directory tarball
43 virt-tar [--options] disk.img [disk.img ...] -u tarball directory
47 Download C</home> from the VM into a local tarball:
49 virt-tar -x domname /home home.tar
51 virt-tar -zx domname /home home.tar.gz
53 Upload a local tarball and unpack it inside C</tmp> in the VM:
55 virt-tar -u domname uploadstuff.tar /tmp
57 virt-tar -zu domname uploadstuff.tar.gz /tmp
61 You must I<not> use C<virt-tar> with the C<-u> option (upload) on live
62 virtual machines. If you do this, you risk disk corruption in the VM.
63 C<virt-tar> tries to stop you from doing this, but doesn't catch all
66 You can use C<-x> (extract) on live virtual machines, but you might
67 get inconsistent results or errors if there is filesystem activity
68 inside the VM. If the live VM is synched and quiescent, then
69 C<virt-tar> will usually work, but the only way to guarantee
70 consistent results is if the virtual machine is shut down.
74 C<virt-tar> is a general purpose archive tool for downloading and
75 uploading parts of a guest filesystem. There are many possibilities:
76 making backups, uploading data files, snooping on guest activity,
77 fixing or customizing guests, etc.
79 If you want to just view a single file, use L<virt-cat(1)>. If you
80 just want to edit a single file, use L<virt-edit(1)>. For more
81 complex cases you should look at the L<guestfish(1)> tool.
83 There are two modes of operation: C<-x> (eXtract) downloads a
84 directory and its contents (recursively) from the virtual machine into
85 a local tarball. C<-u> uploads from a local tarball, unpacking it
86 into a directory inside the virtual machine. You cannot use these two
89 In addition, you may need to use the C<-z> (gZip) option to enable
90 compression. When uploading, you have to specify C<-z> if the upload
91 file is compressed because virt-tar won't detect this on its own.
93 C<virt-tar> can only handle tar (optionally gzipped) format tarballs.
94 For example it cannot do PKZip files or bzip2 compression. If you
95 want that then you'll have to rebuild the tarballs yourself. (This is
96 a limitation of the L<libguestfs(3)> API).
116 Display version number and exit.
122 =item B<--connect URI> | B<-c URI>
124 If using libvirt, connect to the given I<URI>. If omitted, then we
125 connect to the default libvirt hypervisor.
127 If you specify guest block devices directly, then libvirt is not used
134 =item B<--format> raw
136 Specify the format of disk images given on the command line. If this
137 is omitted then the format is autodetected from the content of the
140 If disk images are requested from libvirt, then this program asks
141 libvirt for this information. In this case, the value of the format
142 parameter is ignored.
144 If working with untrusted raw-format guest disk images, you should
145 ensure the format is always specified.
151 =item B<-x> | B<--extract> | B<--download>
153 =item B<-u> | B<--upload>
155 Use C<-x> to extract (download) a directory from a virtual machine
158 Use C<-u> to upload and unpack from a local tarball into a virtual
159 machine. Please read the L</WARNING> section above before using this
162 You must specify exactly one of these options.
168 =item B<-z> | B<--gzip>
170 Specify that the input or output tarball is gzip-compressed.
178 die __"virt-tar: extract/upload mode specified twice on the command line\n"
185 die __"virt-tar: extract/upload mode specified twice on the command line\n"
190 Getopt::Long::Configure ("bundling");
191 GetOptions ("help|?" => \$help,
192 "version" => \$version,
193 "connect|c=s" => \$uri,
194 "format=s" => \$format,
195 "extract|download|x" => \&set_mode_x,
196 "upload|u" => \&set_mode_u,
199 pod2usage (1) if $help;
201 my $g = Sys::Guestfs->new ();
202 my %h = $g->version ();
203 print "$h{major}.$h{minor}.$h{release}$h{extra}\n";
207 pod2usage (__"virt-tar: no image, VM names, directory or filename given")
210 die __"virt-tar: either -x or -u must be specified on the command line\n"
213 # Note: 'pop' reads arguments right to left.
214 my ($tarball, $directory);
216 $tarball = pop @ARGV;
217 $directory = pop @ARGV;
218 } else { # $mode eq "u"
219 $directory = pop @ARGV;
220 $tarball = pop @ARGV;
221 die __x("virt-tar: {tarball}: file not found\n",
222 tarball => $tarball) unless -f $tarball;
224 die __x("virt-tar: {dir}: directory name must start with '/' character\n",
226 unless substr ($directory, 0, 1) eq "/";
229 push @args, address => $uri if $uri;
230 push @args, rw => 1 if $mode eq "u";
231 push @args, format => $format if defined $format;
233 my $g = open_guest (@args);
236 my @roots = $g->inspect_os ();
238 die __x("{prog}: No operating system could be detected inside this disk image.\n\nThis may be because the file is not a disk image, or is not a virtual machine\nimage, or because the OS type is not understood by libguestfs.\n\nIf you feel this is an error, please file a bug report including as much\ninformation about the disk image as possible.\n",
239 prog => basename ($0));
242 die __x("{prog}: multiboot operating systems are not supported.\n",
243 prog => basename ($0))
245 my %fses = $g->inspect_get_mountpoints ($roots[0]);
246 my @fses = sort { length $a <=> length $b } keys %fses;
247 my $mountopts = $mode eq "u" ? "" : "ro";
249 $g->mount_options ($mountopts, $fses{$_}, $_);
252 # Do the tar command.
255 $g->tgz_out ($directory, $tarball);
257 $g->tar_out ($directory, $tarball);
259 } else { # mode eq "u"
261 $g->tgz_in ($tarball, $directory);
263 $g->tar_in ($tarball, $directory);
276 Libvirt guest names can contain arbitrary characters, some of which
277 have meaning to the shell such as C<#> and space. You may need to
278 quote or escape these characters on the command line. See the shell
279 manual page L<sh(1)> for details.
288 L<Sys::Guestfs::Lib(3)>,
290 L<http://libguestfs.org/>.
294 Richard W.M. Jones L<http://people.redhat.com/~rjones/>
298 Copyright (C) 2009 Red Hat Inc.
300 This program is free software; you can redistribute it and/or modify
301 it under the terms of the GNU General Public License as published by
302 the Free Software Foundation; either version 2 of the License, or
303 (at your option) any later version.
305 This program is distributed in the hope that it will be useful,
306 but WITHOUT ANY WARRANTY; without even the implied warranty of
307 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
308 GNU General Public License for more details.
310 You should have received a copy of the GNU General Public License
311 along with this program; if not, write to the Free Software
312 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.