cat/virt-cat.pl

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