3 # Copyright (C) 2009 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 get_partitions resolve_windows_path
24 inspect_all_partitions inspect_partition
25 inspect_operating_systems mount_operating_system inspect_in_detail);
30 use Locale::TextDomain 'libguestfs';
33 eval "use YAML::Any;";
39 virt-inspector - Display OS version, kernel, drivers, mount points, applications, etc. in a virtual machine
43 virt-inspector [--connect URI] domname
45 virt-inspector guest.img [guest.img ...]
49 B<virt-inspector> examines a virtual machine and tries to determine
50 the version of the OS, the kernel version, what drivers are installed,
51 whether the virtual machine is fully virtualized (FV) or
52 para-virtualized (PV), what applications are installed and more.
54 Virt-inspector can produce output in several formats, including a
55 readable text report, and XML for feeding into other programs.
57 Virt-inspector should only be run on I<inactive> virtual machines.
58 The program tries to determine that the machine is inactive and will
59 refuse to run if it thinks you are trying to inspect a running domain.
61 In the normal usage, use C<virt-inspector domname> where C<domname> is
62 the libvirt domain (see: C<virsh list --all>).
64 You can also run virt-inspector directly on disk images from a single
65 virtual machine. Use C<virt-inspector guest.img>. In rare cases a
66 domain has several block devices, in which case you should list them
67 one after another, with the first corresponding to the guest's
68 C</dev/sda>, the second to the guest's C</dev/sdb> and so on.
70 Virt-inspector can only inspect and report upon I<one domain at a
71 time>. To inspect several virtual machines, you have to run
72 virt-inspector several times (for example, from a shell script
75 Because virt-inspector needs direct access to guest images, it won't
76 normally work over remote libvirt connections.
96 Display version number and exit.
102 =item B<--connect URI> | B<-c URI>
104 If using libvirt, connect to the given I<URI>. If omitted,
105 then we connect to the default libvirt hypervisor.
107 Libvirt is only used if you specify a C<domname> on the
108 command line. If you specify guest block devices directly,
109 then libvirt is not used at all.
117 The following options select the output format. Use only one of them.
118 The default is a readable text report.
122 =item B<--text> (default)
128 Produce no output at all.
132 If you select I<--xml> then you get XML output which can be fed
137 If you select I<--yaml> then you get YAML output which can be fed
142 If you select I<--perl> then you get Perl structures output which
143 can be used directly in another Perl program.
149 If you select I<--fish> then we print a L<guestfish(1)> command
150 line which will automatically mount up the filesystems on the
151 correct mount points. Try this for example:
153 guestfish $(virt-inspector --fish guest.img)
155 I<--ro-fish> is the same, but the I<--ro> option is passed to
156 guestfish so that the filesystems are mounted read-only.
160 In "query mode" we answer common questions about the guest, such
161 as whether it is fullvirt or needs a Xen hypervisor to run.
163 See section I<QUERY MODE> below.
167 my $windows_registry;
169 =item B<--windows-registry>
171 If this item is passed, I<and> the guest is Windows, I<and> the
172 external program C<reged> is available (see SEE ALSO section), then we
173 attempt to parse the Windows registry. This allows much more
174 information to be gathered for Windows guests.
176 This is quite an expensive and slow operation, so we don't do it by
183 GetOptions ("help|?" => \$help,
184 "version" => \$version,
185 "connect|c=s" => \$uri,
186 "text" => sub { $output = "text" },
187 "none" => sub { $output = "none" },
188 "xml" => sub { $output = "xml" },
189 "yaml" => sub { $output = "yaml" },
190 "perl" => sub { $output = "perl" },
191 "fish" => sub { $output = "fish" },
192 "guestfish" => sub { $output = "fish" },
193 "ro-fish" => sub { $output = "ro-fish" },
194 "ro-guestfish" => sub { $output = "ro-fish" },
195 "query" => sub { $output = "query" },
196 "windows-registry" => \$windows_registry,
198 pod2usage (1) if $help;
200 my $g = Sys::Guestfs->new ();
201 my %h = $g->version ();
202 print "$h{major}.$h{minor}.$h{release}$h{extra}\n";
205 pod2usage (__"virt-inspector: no image or VM names given") if @ARGV == 0;
208 $rw = 1 if $output eq "fish";
213 ($g, $conn, $dom, @images) =
214 open_guest (\@ARGV, rw => $rw, address => $uri);
217 ($g, $conn, $dom, @images) =
218 open_guest (\@ARGV, rw => $rw);
228 Linux (distro + version)
232 +--- Filesystems ---------- Installed apps --- Kernel & drivers
233 ----------- -------------- ----------------
234 mount point => device List of apps Extra information
235 mount point => device and versions about kernel(s)
238 (plus lots of extra information
239 about each filesystem)
241 The output of virt-inspector is a complex two-level data structure.
243 At the top level is a list of the operating systems installed on the
244 guest. (For the vast majority of guests, only a single OS is
245 installed.) The data returned for the OS includes the name (Linux,
246 Windows), the distribution and version.
248 The diagram above shows what we return for each OS.
250 With the I<--xml> option the output is mapped into an XML document.
251 Unfortunately there is no clear schema for this document
252 (contributions welcome) but you can get an idea of the format by
253 looking at other documents and as a last resort the source for this
256 With the I<--fish> or I<--ro-fish> option the mount points are mapped to
257 L<guestfish(1)> command line parameters, so that you can go in
258 afterwards and inspect the guest with everything mounted in the
259 right place. For example:
261 guestfish $(virt-inspector --ro-fish guest.img)
262 ==> guestfish --ro -a guest.img -m /dev/VG/LV:/ -m /dev/sda1:/boot
266 # List of possible filesystems.
267 my @partitions = get_partitions ($g);
269 # Now query each one to build up a picture of what's in it.
271 inspect_all_partitions ($g, \@partitions,
272 use_windows_registry => $windows_registry);
274 #print "fses -----------\n";
275 #print Dumper(\%fses);
277 my $oses = inspect_operating_systems ($g, \%fses);
279 #print "oses -----------\n";
280 #print Dumper($oses);
282 # Mount up the disks so we can check for applications
283 # and kernels. Skip this if the output is "*fish" because
284 # we don't need to know.
286 if ($output !~ /.*fish$/) {
288 foreach $root_dev (sort keys %$oses) {
289 my $os = $oses->{$root_dev};
290 mount_operating_system ($g, $os);
291 inspect_in_detail ($g, $os);
296 #----------------------------------------------------------------------
299 if ($output eq "fish" || $output eq "ro-fish") {
300 my @osdevs = keys %$oses;
301 # This only works if there is a single OS.
302 die __"--fish output is only possible with a single OS\n" if @osdevs != 1;
304 my $root_dev = $osdevs[0];
306 if ($output eq "ro-fish") {
310 print "-a $_ " foreach @images;
312 my $mounts = $oses->{$root_dev}->{mounts};
313 # Have to mount / first. Luckily '/' is early in the ASCII
314 # character set, so this should be OK.
315 foreach (sort keys %$mounts) {
316 print "-m $mounts->{$_}:$_ " if $_ ne "swap" && $_ ne "none";
322 elsif ($output eq "perl") {
323 print Dumper(%$oses);
327 elsif ($output eq "yaml") {
328 die __"virt-inspector: no YAML support\n"
329 unless exists $INC{"YAML/Any.pm"};
334 # Plain text output (the default).
335 elsif ($output eq "text") {
340 elsif ($output eq "xml") {
345 elsif ($output eq "query") {
351 output_text_os ($oses->{$_}) foreach sort keys %$oses;
358 print $os->{os}, " " if exists $os->{os};
359 print $os->{distro}, " " if exists $os->{distro};
360 print $os->{version}, " " if exists $os->{version};
361 print "on ", $os->{root_device}, ":\n";
363 print __" Mountpoints:\n";
364 my $mounts = $os->{mounts};
365 foreach (sort keys %$mounts) {
366 printf " %-30s %s\n", $mounts->{$_}, $_
369 print __" Filesystems:\n";
370 my $filesystems = $os->{filesystems};
371 foreach (sort keys %$filesystems) {
373 print " label: $filesystems->{$_}{label}\n"
374 if exists $filesystems->{$_}{label};
375 print " UUID: $filesystems->{$_}{uuid}\n"
376 if exists $filesystems->{$_}{uuid};
377 print " type: $filesystems->{$_}{fstype}\n"
378 if exists $filesystems->{$_}{fstype};
379 print " content: $filesystems->{$_}{content}\n"
380 if exists $filesystems->{$_}{content};
383 if (exists $os->{modprobe_aliases}) {
384 my %aliases = %{$os->{modprobe_aliases}};
385 my @keys = sort keys %aliases;
387 print __" Modprobe aliases:\n";
389 printf " %-30s %s\n", $_, $aliases{$_}->{modulename}
394 if (exists $os->{initrd_modules}) {
395 my %modvers = %{$os->{initrd_modules}};
396 my @keys = sort keys %modvers;
398 print __" Initrd modules:\n";
400 my @modules = @{$modvers{$_}};
402 print " $_\n" foreach @modules;
407 print __" Applications:\n";
408 my @apps = @{$os->{apps}};
410 print " $_->{name} $_->{version}\n"
413 print __" Kernels:\n";
414 my @kernels = @{$os->{kernels}};
416 print " $_->{version}\n";
417 my @modules = @{$_->{modules}};
423 if (exists $os->{root}->{registry}) {
424 print __" Windows Registry entries:\n";
425 # These are just lumps of text - dump them out.
426 foreach (@{$os->{root}->{registry}}) {
434 my $xml = new XML::Writer(DATA_MODE => 1, DATA_INDENT => 2);
436 $xml->startTag("operatingsystems");
437 output_xml_os ($oses->{$_}, $xml) foreach sort keys %$oses;
438 $xml->endTag("operatingsystems");
447 $xml->startTag("operatingsystem");
449 foreach ( [ "name" => "os" ],
450 [ "distro" => "distro" ],
451 [ "version" => "version" ],
452 [ "package_format" => "package_format" ],
453 [ "package_management" => "package_management" ],
454 [ "root" => "root_device" ] ) {
455 $xml->dataElement($_->[0], $os->{$_->[1]}) if exists $os->{$_->[1]};
458 $xml->startTag("mountpoints");
459 my $mounts = $os->{mounts};
460 foreach (sort keys %$mounts) {
461 $xml->dataElement("mountpoint", $_, "dev" => $mounts->{$_});
463 $xml->endTag("mountpoints");
465 $xml->startTag("filesystems");
466 my $filesystems = $os->{filesystems};
467 foreach (sort keys %$filesystems) {
468 $xml->startTag("filesystem", "dev" => $_);
470 foreach my $field ( [ "label" => "label" ],
471 [ "uuid" => "uuid" ],
472 [ "type" => "fstype" ],
473 [ "content" => "content" ],
474 [ "spec" => "spec" ] ) {
475 $xml->dataElement($field->[0], $filesystems->{$_}{$field->[1]})
476 if exists $filesystems->{$_}{$field->[1]};
479 $xml->endTag("filesystem");
481 $xml->endTag("filesystems");
483 if (exists $os->{modprobe_aliases}) {
484 my %aliases = %{$os->{modprobe_aliases}};
485 my @keys = sort keys %aliases;
487 $xml->startTag("modprobealiases");
489 $xml->startTag("alias", "device" => $_);
491 foreach my $field ( [ "modulename" => "modulename" ],
492 [ "augeas" => "augeas" ],
493 [ "file" => "file" ] ) {
494 $xml->dataElement($field->[0], $aliases{$_}->{$field->[1]});
497 $xml->endTag("alias");
499 $xml->endTag("modprobealiases");
503 if (exists $os->{initrd_modules}) {
504 my %modvers = %{$os->{initrd_modules}};
505 my @keys = sort keys %modvers;
507 $xml->startTag("initrds");
509 my @modules = @{$modvers{$_}};
510 $xml->startTag("initrd", "version" => $_);
511 $xml->dataElement("module", $_) foreach @modules;
512 $xml->endTag("initrd");
514 $xml->endTag("initrds");
518 $xml->startTag("applications");
519 my @apps = @{$os->{apps}};
521 $xml->startTag("application");
522 $xml->dataElement("name", $_->{name});
523 $xml->dataElement("version", $_->{version});
524 $xml->endTag("application");
526 $xml->endTag("applications");
528 $xml->startTag("kernels");
529 my @kernels = @{$os->{kernels}};
531 $xml->startTag("kernel", "version" => $_->{version});
532 $xml->startTag("modules");
533 my @modules = @{$_->{modules}};
535 $xml->dataElement("module", $_);
537 $xml->endTag("modules");
538 $xml->endTag("kernel");
540 $xml->endTag("kernels");
542 if (exists $os->{root}->{registry}) {
543 $xml->startTag("windowsregistryentries");
544 # These are just lumps of text - dump them out.
545 foreach (@{$os->{root}->{registry}}) {
546 $xml->dataElement("windowsregistryentry", $_);
548 $xml->endTag("windowsregistryentries");
551 $xml->endTag("operatingsystem");
556 When you use C<virt-inspector --query>, the output is a series of
564 (each answer is usually C<yes> or C<no>, or the line is completely
565 missing if we could not determine the answer at all).
567 If the guest is multiboot, you can get apparently conflicting answers
568 (eg. C<windows=yes> and C<linux=yes>, or a guest which is both
569 fullvirt and has a Xen PV kernel). This is normal, and just means
570 that the guest can do both things, although it might require operator
571 intervention such as selecting a boot option when the guest is
574 This section describes the full range of answers possible.
582 output_query_windows ();
583 output_query_linux ();
584 output_query_rhel ();
585 output_query_fedora ();
586 output_query_debian ();
587 output_query_fullvirt ();
588 output_query_xen_domU_kernel ();
589 output_query_xen_pv_drivers ();
590 output_query_virtio_drivers ();
593 =item windows=(yes|no)
595 Answer C<yes> if Microsoft Windows is installed in the guest.
599 sub output_query_windows
602 foreach my $os (keys %$oses) {
603 $windows="yes" if $oses->{$os}->{os} eq "windows";
605 print "windows=$windows\n";
610 Answer C<yes> if a Linux kernel is installed in the guest.
614 sub output_query_linux
617 foreach my $os (keys %$oses) {
618 $linux="yes" if $oses->{$os}->{os} eq "linux";
620 print "linux=$linux\n";
625 Answer C<yes> if the guest contains Red Hat Enterprise Linux.
629 sub output_query_rhel
632 foreach my $os (keys %$oses) {
633 $rhel="yes" if ($oses->{$os}->{os} eq "linux" &&
634 $oses->{$os}->{distro} eq "rhel");
636 print "rhel=$rhel\n";
639 =item fedora=(yes|no)
641 Answer C<yes> if the guest contains the Fedora Linux distribution.
645 sub output_query_fedora
648 foreach my $os (keys %$oses) {
649 $fedora="yes" if $oses->{$os}->{os} eq "linux" && $oses->{$os}->{distro} eq "fedora";
651 print "fedora=$fedora\n";
654 =item debian=(yes|no)
656 Answer C<yes> if the guest contains the Debian Linux distribution.
660 sub output_query_debian
663 foreach my $os (keys %$oses) {
664 $debian="yes" if $oses->{$os}->{os} eq "linux" && $oses->{$os}->{distro} eq "debian";
666 print "debian=$debian\n";
669 =item fullvirt=(yes|no)
671 Answer C<yes> if there is at least one operating system kernel
672 installed in the guest which runs fully virtualized. Such a guest
673 would require a hypervisor which supports full system virtualization.
677 sub output_query_fullvirt
679 # The assumption is full-virt, unless all installed kernels
680 # are identified as paravirt.
681 # XXX Fails on Windows guests.
682 foreach my $os (keys %$oses) {
683 foreach my $kernel (@{$oses->{$os}->{kernels}}) {
684 my $is_pv = $kernel->{version} =~ m/xen/;
686 print "fullvirt=yes\n";
691 print "fullvirt=no\n";
694 =item xen_domU_kernel=(yes|no)
696 Answer C<yes> if there is at least one Linux kernel installed in
697 the guest which is compiled as a Xen DomU (a Xen paravirtualized
702 sub output_query_xen_domU_kernel
704 foreach my $os (keys %$oses) {
705 foreach my $kernel (@{$oses->{$os}->{kernels}}) {
706 my $is_xen = $kernel->{version} =~ m/xen/;
708 print "xen_domU_kernel=yes\n";
713 print "xen_domU_kernel=no\n";
716 =item xen_pv_drivers=(yes|no)
718 Answer C<yes> if the guest has Xen paravirtualized drivers installed
719 (usually the kernel itself will be fully virtualized, but the PV
720 drivers have been installed by the administrator for performance
725 sub output_query_xen_pv_drivers
727 foreach my $os (keys %$oses) {
728 foreach my $kernel (@{$oses->{$os}->{kernels}}) {
729 foreach my $module (@{$kernel->{modules}}) {
730 if ($module =~ m/xen-/) {
731 print "xen_pv_drivers=yes\n";
737 print "xen_pv_drivers=no\n";
740 =item virtio_drivers=(yes|no)
742 Answer C<yes> if the guest has virtio paravirtualized drivers
743 installed. Virtio drivers are commonly used to improve the
748 sub output_query_virtio_drivers
750 foreach my $os (keys %$oses) {
751 foreach my $kernel (@{$oses->{$os}->{kernels}}) {
752 foreach my $module (@{$kernel->{modules}}) {
753 if ($module =~ m/virtio_/) {
754 print "virtio_drivers=yes\n";
760 print "virtio_drivers=no\n";
770 L<Sys::Guestfs::Lib(3)>,
772 L<http://libguestfs.org/>.
774 For Windows registry parsing we require the C<reged> program
775 from L<http://home.eunet.no/~pnordahl/ntpasswd/>.
779 Richard W.M. Jones L<http://et.redhat.com/~rjones/>
781 Matthew Booth L<mbooth@redhat.com>
785 Copyright (C) 2009 Red Hat Inc.
787 This program is free software; you can redistribute it and/or modify
788 it under the terms of the GNU General Public License as published by
789 the Free Software Foundation; either version 2 of the License, or
790 (at your option) any later version.
792 This program is distributed in the hope that it will be useful,
793 but WITHOUT ANY WARRANTY; without even the implied warranty of
794 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
795 GNU General Public License for more details.
797 You should have received a copy of the GNU General Public License
798 along with this program; if not, write to the Free Software
799 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.