tools/virt-rescue

   1 #!/usr/bin/perl -w
   2 # virt-rescue
   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);
  24 use Pod::Usage;
  25 use Getopt::Long;
  26 use Locale::TextDomain 'libguestfs';
  27
  28 =encoding utf8
  29
  30 =head1 NAME
  31
  32 virt-rescue - Run a rescue shell on a virtual machine
  33
  34 =head1 SYNOPSIS
  35
  36  virt-rescue [--options] domname
  37
  38  virt-rescue [--options] disk.img [disk.img ...]
  39
  40 =head1 WARNING
  41
  42 You must I<not> use C<virt-rescue> on live virtual machines.  Doing so
  43 will probably result in disk corruption in the VM.  C<virt-rescue>
  44 tries to stop you from doing this, but doesn't catch all cases.
  45
  46 However if you use the I<--ro> (read only) option, then you can attach
  47 a shell to a live virtual machine.  The results might be strange or
  48 inconsistent at times but you won't get disk corruption.
  49
  50 =head1 DESCRIPTION
  51
  52 virt-rescue is like a Rescue CD, but for virtual machines, and without
  53 the need for a CD.  virt-rescue gives you a rescue shell and some
  54 simple recovery tools which you can use to examine or rescue a virtual
  55 machine or disk image.
  56
  57 You can run virt-rescue on any virtual machine known to libvirt, or
  58 directly on disk image(s):
  59
  60  virt-rescue GuestName
  61
  62  virt-rescue --ro /path/to/disk.img
  63
  64  virt-rescue /dev/sdc
  65
  66 For live VMs you I<must> use the --ro option.
  67
  68 When you run virt-rescue on a virtual machine or disk image, you are
  69 placed in an interactive bash shell where you can use many ordinary
  70 Linux commands.  What you see in C</> (C</bin>, C</lib> etc) is the
  71 rescue appliance.  You must mount the virtual machine's filesystems by
  72 hand.  There is an empty directory called C</sysroot> where you can
  73 mount filesystems.
  74
  75 In the example below, we list logical volumes, then choose one to
  76 mount under C</sysroot>:
  77
  78  ><rescue> lvs
  79  LV      VG        Attr   LSize   Origin Snap%  Move Log Copy%  Convert
  80  lv_root vg_f11x64 -wi-a-   8.83G
  81  lv_swap vg_f11x64 -wi-a- 992.00M
  82  ><rescue> mount /dev/vg_f11x64/lv_root /sysroot
  83  ><rescue> ls /sysroot
  84
  85 If you don't know what filesystems are available on the virtual
  86 machine then you can use commands such as L<parted(8)> and L<lvs(8)>
  87 to find out.
  88
  89 =head2 NOTES
  90
  91 Virt-rescue can be used on I<any> disk image file or device, not just
  92 a virtual machine.  For example you can use it on a blank file if you
  93 want to partition that file (although we would recommend using
  94 L<guestfish(1)> instead as it is more suitable for this purpose).  You
  95 can even use virt-rescue on things like SD cards.
  96
  97 This tool is just designed for quick interactive hacking on a virtual
  98 machine.  For more structured access to a virtual machine disk image,
  99 you should use L<guestfs(3)>.  To get a structured shell that you can
 100 use to make scripted changes to guests, use L<guestfish(1)>.
 101
 102 =head1 OPTIONS
 103
 104 =over 4
 105
 106 =cut
 107
 108 my $help;
 109
 110 =item B<--help>
 111
 112 Display brief help.
 113
 114 =cut
 115
 116 my $version;
 117
 118 =item B<--version>
 119
 120 Display version number and exit.
 121
 122 =cut
 123
 124 my $uri;
 125
 126 =item B<--connect URI> | B<-c URI>
 127
 128 If using libvirt, connect to the given I<URI>.  If omitted, then we
 129 connect to the default libvirt hypervisor.
 130
 131 If you specify guest block devices directly, then libvirt is not used
 132 at all.
 133
 134 =cut
 135
 136 my $readonly;
 137
 138 =item B<--ro> | B<-r>
 139
 140 Open the image read-only.
 141
 142 The option must always be used if the disk image or virtual machine
 143 might be running, and is generally recommended in cases where you
 144 don't need write access to the disk.
 145
 146 =back
 147
 148 =cut
 149
 150 GetOptions ("help|?" => \$help,
 151             "version" => \$version,
 152             "connect|c=s" => \$uri,
 153             "ro|r" => \$readonly,
 154     ) or pod2usage (2);
 155 pod2usage (1) if $help;
 156 if ($version) {
 157     my $g = Sys::Guestfs->new ();
 158     my %h = $g->version ();
 159     print "$h{major}.$h{minor}.$h{release}$h{extra}\n";
 160     exit
 161 }
 162
 163 pod2usage (__"virt-rescue: no image or VM names rescue given")
 164     if @ARGV == 0;
 165
 166 my @args = (\@ARGV);
 167 push @args, address => $uri if $uri;
 168 push @args, rw => 1 unless $readonly;
 169 my $g = open_guest (@args);
 170
 171 $g->set_direct (1);
 172 $g->set_append ("guestfs_rescue=1");
 173
 174 $g->launch ();
 175
 176 exit 0;
 177
 178 =head1 ENVIRONMENT VARIABLES
 179
 180 Several environment variables affect virt-rescue.  See
 181 L<guestfs(3)/ENVIRONMENT VARIABLES> for the complete list.
 182
 183 =head1 SEE ALSO
 184
 185 L<guestfs(3)>,
 186 L<guestfish(1)>,
 187 L<virt-cat(1)>,
 188 L<Sys::Guestfs(3)>,
 189 L<Sys::Guestfs::Lib(3)>,
 190 L<Sys::Virt(3)>,
 191 L<http://libguestfs.org/>.
 192
 193 =head1 AUTHOR
 194
 195 Richard W.M. Jones L<http://people.redhat.com/~rjones/>
 196
 197 =head1 COPYRIGHT
 198
 199 Copyright (C) 2009-2010 Red Hat Inc.
 200
 201 This program is free software; you can redistribute it and/or modify
 202 it under the terms of the GNU General Public License as published by
 203 the Free Software Foundation; either version 2 of the License, or
 204 (at your option) any later version.
 205
 206 This program is distributed in the hope that it will be useful,
 207 but WITHOUT ANY WARRANTY; without even the implied warranty of
 208 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 209 GNU General Public License for more details.
 210
 211 You should have received a copy of the GNU General Public License
 212 along with this program; if not, write to the Free Software
 213 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.