tools/virt-cat

   1 #!/usr/bin/perl -w
   2 # virt-cat
   3 # Copyright (C) 2009 Red Hat Inc.
   4 #
   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.
   9 #
  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.
  14 #
  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.
  18
  19 use warnings;
  20 use strict;
  21
  22 use Sys::Guestfs;
  23 use Sys::Guestfs::Lib qw(open_guest get_partitions resolve_windows_path
  24   inspect_all_partitions inspect_partition
  25   inspect_operating_systems mount_operating_system);
  26 use Pod::Usage;
  27 use Getopt::Long;
  28 use Locale::TextDomain 'libguestfs';
  29
  30 =encoding utf8
  31
  32 =head1 NAME
  33
  34 virt-cat - Display a file in a virtual machine
  35
  36 =head1 SYNOPSIS
  37
  38  virt-cat [--options] domname file
  39
  40  virt-cat [--options] disk.img [disk.img ...] file
  41
  42 =head1 DESCRIPTION
  43
  44 C<virt-cat> is a command line tool to display the contents of C<file>
  45 where C<file> exists in the named virtual machine (or disk image).
  46
  47 C<virt-cat> can be used to quickly view a single file.  To edit a
  48 file, use C<virt-edit>.  For more complex cases you should look at the
  49 L<guestfish(1)> tool.
  50
  51 =head1 EXAMPLES
  52
  53 Display C</etc/fstab> file from inside the libvirt VM called
  54 C<mydomain>:
  55
  56  virt-cat mydomain /etc/fstab
  57
  58 List syslog messages from a VM:
  59
  60  virt-cat mydomain /var/log/messages | tail
  61
  62 Find out what DHCP IP address a VM acquired:
  63
  64  virt-cat mydomain /var/log/messages | grep 'dhclient: bound to' | tail
  65
  66 Find out what packages were recently installed:
  67
  68  virt-cat mydomain /var/log/yum.log | tail
  69
  70 Find out who is logged on inside a virtual machine:
  71
  72  virt-cat mydomain /var/run/utmp > /tmp/utmp
  73  who /tmp/utmp
  74
  75 or who was logged on:
  76
  77  virt-cat mydomain /var/log/wtmp > /tmp/wtmp
  78  last -f /tmp/wtmp
  79
  80 =head1 OPTIONS
  81
  82 =over 4
  83
  84 =cut
  85
  86 my $help;
  87
  88 =item B<--help>
  89
  90 Display brief help.
  91
  92 =cut
  93
  94 my $version;
  95
  96 =item B<--version>
  97
  98 Display version number and exit.
  99
 100 =cut
 101
 102 my $uri;
 103
 104 =item B<--connect URI> | B<-c URI>
 105
 106 If using libvirt, connect to the given I<URI>.  If omitted, then we
 107 connect to the default libvirt hypervisor.
 108
 109 If you specify guest block devices directly, then libvirt is not used
 110 at all.
 111
 112 =cut
 113
 114 my $format;
 115
 116 =item B<--format> raw
 117
 118 Specify the format of disk images given on the command line.  If this
 119 is omitted then the format is autodetected from the content of the
 120 disk image.
 121
 122 If disk images are requested from libvirt, then this program asks
 123 libvirt for this information.  In this case, the value of the format
 124 parameter is ignored.
 125
 126 If working with untrusted raw-format guest disk images, you should
 127 ensure the format is always specified.
 128
 129 =back
 130
 131 =cut
 132
 133 GetOptions ("help|?" => \$help,
 134             "version" => \$version,
 135             "connect|c=s" => \$uri,
 136             "format=s" => \$format,
 137     ) or pod2usage (2);
 138 pod2usage (1) if $help;
 139 if ($version) {
 140     my $g = Sys::Guestfs->new ();
 141     my %h = $g->version ();
 142     print "$h{major}.$h{minor}.$h{release}$h{extra}\n";
 143     exit
 144 }
 145
 146 pod2usage (__"virt-cat: no image, VM names or filenames to cat given")
 147     if @ARGV <= 1;
 148
 149 my $filename = pop @ARGV;
 150
 151 my $g;
 152 if ($uri) {
 153     $g = open_guest (\@ARGV, address => $uri, format => $format);
 154 } else {
 155     $g = open_guest (\@ARGV, format => $format);
 156 }
 157
 158 $g->launch ();
 159
 160 # List of possible filesystems.
 161 my @partitions = get_partitions ($g);
 162
 163 # Now query each one to build up a picture of what's in it.
 164 my %fses =
 165     inspect_all_partitions ($g, \@partitions,
 166       use_windows_registry => 0);
 167
 168 my $oses = inspect_operating_systems ($g, \%fses);
 169
 170 my @roots = keys %$oses;
 171 die __"multiboot operating systems are not supported by virt-cat" if @roots > 1;
 172 my $root_dev = $roots[0];
 173
 174 my $os = $oses->{$root_dev};
 175 mount_operating_system ($g, $os);
 176
 177 # Allow this to fail in case eg. the file does not exist.
 178 # NB: https://bugzilla.redhat.com/show_bug.cgi?id=501888
 179 print $g->download($filename, "/dev/stdout");
 180
 181 =head1 SHELL QUOTING
 182
 183 Libvirt guest names can contain arbitrary characters, some of which
 184 have meaning to the shell such as C<#> and space.  You may need to
 185 quote or escape these characters on the command line.  See the shell
 186 manual page L<sh(1)> for details.
 187
 188 =head1 SEE ALSO
 189
 190 L<guestfs(3)>,
 191 L<guestfish(1)>,
 192 L<virt-edit(1)>,
 193 L<Sys::Guestfs(3)>,
 194 L<Sys::Guestfs::Lib(3)>,
 195 L<Sys::Virt(3)>,
 196 L<http://libguestfs.org/>.
 197
 198 =head1 AUTHOR
 199
 200 Richard W.M. Jones L<http://people.redhat.com/~rjones/>
 201
 202 =head1 COPYRIGHT
 203
 204 Copyright (C) 2009 Red Hat Inc.
 205
 206 This program is free software; you can redistribute it and/or modify
 207 it under the terms of the GNU General Public License as published by
 208 the Free Software Foundation; either version 2 of the License, or
 209 (at your option) any later version.
 210
 211 This program is distributed in the hope that it will be useful,
 212 but WITHOUT ANY WARRANTY; without even the implied warranty of
 213 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 214 GNU General Public License for more details.
 215
 216 You should have received a copy of the GNU General Public License
 217 along with this program; if not, write to the Free Software
 218 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.