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";
211 $g = open_guest (\@ARGV, rw => $rw, address => $uri);
213 $g = open_guest (\@ARGV, rw => $rw);
223 Linux (distro + version)
227 +--- Filesystems ---------- Installed apps --- Kernel & drivers
228 ----------- -------------- ----------------
229 mount point => device List of apps Extra information
230 mount point => device and versions about kernel(s)
233 (plus lots of extra information
234 about each filesystem)
236 The output of virt-inspector is a complex two-level data structure.
238 At the top level is a list of the operating systems installed on the
239 guest. (For the vast majority of guests, only a single OS is
240 installed.) The data returned for the OS includes the name (Linux,
241 Windows), the distribution and version.
243 The diagram above shows what we return for each OS.
245 With the I<--xml> option the output is mapped into an XML document.
246 Unfortunately there is no clear schema for this document
247 (contributions welcome) but you can get an idea of the format by
248 looking at other documents and as a last resort the source for this
251 With the I<--fish> or I<--ro-fish> option the mount points are mapped to
252 L<guestfish(1)> command line parameters, so that you can go in
253 afterwards and inspect the guest with everything mounted in the
254 right place. For example:
256 guestfish $(virt-inspector --ro-fish guest.img)
257 ==> guestfish --ro -a guest.img -m /dev/VG/LV:/ -m /dev/sda1:/boot
261 # List of possible filesystems.
262 my @partitions = get_partitions ($g);
264 # Now query each one to build up a picture of what's in it.
266 inspect_all_partitions ($g, \@partitions,
267 use_windows_registry => $windows_registry);
269 #print "fses -----------\n";
270 #print Dumper(\%fses);
272 my $oses = inspect_operating_systems ($g, \%fses);
274 #print "oses -----------\n";
275 #print Dumper($oses);
277 # Mount up the disks so we can check for applications
278 # and kernels. Skip this if the output is "*fish" because
279 # we don't need to know.
281 if ($output !~ /.*fish$/) {
283 foreach $root_dev (sort keys %$oses) {
284 my $os = $oses->{$root_dev};
285 mount_operating_system ($g, $os);
286 inspect_in_detail ($g, $os);
291 #----------------------------------------------------------------------
294 if ($output eq "fish" || $output eq "ro-fish") {
295 my @osdevs = keys %$oses;
296 # This only works if there is a single OS.
297 die __"--fish output is only possible with a single OS\n" if @osdevs != 1;
299 my $root_dev = $osdevs[0];
301 if ($output eq "ro-fish") {
305 print "-a $_ " foreach @ARGV;
307 my $mounts = $oses->{$root_dev}->{mounts};
308 # Have to mount / first. Luckily '/' is early in the ASCII
309 # character set, so this should be OK.
310 foreach (sort keys %$mounts) {
311 print "-m $mounts->{$_}:$_ " if $_ ne "swap" && $_ ne "none";
317 elsif ($output eq "perl") {
318 print Dumper(%$oses);
322 elsif ($output eq "yaml") {
323 die __"virt-inspector: no YAML support\n"
324 unless exists $INC{"YAML/Any.pm"};
329 # Plain text output (the default).
330 elsif ($output eq "text") {
335 elsif ($output eq "xml") {
340 elsif ($output eq "query") {
346 output_text_os ($oses->{$_}) foreach sort keys %$oses;
353 print $os->{os}, " " if exists $os->{os};
354 print $os->{distro}, " " if exists $os->{distro};
355 print $os->{version}, " " if exists $os->{version};
356 print "on ", $os->{root_device}, ":\n";
358 print __" Mountpoints:\n";
359 my $mounts = $os->{mounts};
360 foreach (sort keys %$mounts) {
361 printf " %-30s %s\n", $mounts->{$_}, $_
364 print __" Filesystems:\n";
365 my $filesystems = $os->{filesystems};
366 foreach (sort keys %$filesystems) {
368 print " label: $filesystems->{$_}{label}\n"
369 if exists $filesystems->{$_}{label};
370 print " UUID: $filesystems->{$_}{uuid}\n"
371 if exists $filesystems->{$_}{uuid};
372 print " type: $filesystems->{$_}{fstype}\n"
373 if exists $filesystems->{$_}{fstype};
374 print " content: $filesystems->{$_}{content}\n"
375 if exists $filesystems->{$_}{content};
378 if (exists $os->{modprobe_aliases}) {
379 my %aliases = %{$os->{modprobe_aliases}};
380 my @keys = sort keys %aliases;
382 print __" Modprobe aliases:\n";
384 printf " %-30s %s\n", $_, $aliases{$_}->{modulename}
389 if (exists $os->{initrd_modules}) {
390 my %modvers = %{$os->{initrd_modules}};
391 my @keys = sort keys %modvers;
393 print __" Initrd modules:\n";
395 my @modules = @{$modvers{$_}};
397 print " $_\n" foreach @modules;
402 print __" Applications:\n";
403 my @apps = @{$os->{apps}};
405 print " $_->{name} $_->{version}\n"
408 print __" Kernels:\n";
409 my @kernels = @{$os->{kernels}};
411 print " $_->{version}\n";
412 my @modules = @{$_->{modules}};
418 if (exists $os->{root}->{registry}) {
419 print __" Windows Registry entries:\n";
420 # These are just lumps of text - dump them out.
421 foreach (@{$os->{root}->{registry}}) {
429 my $xml = new XML::Writer(DATA_MODE => 1, DATA_INDENT => 2);
431 $xml->startTag("operatingsystems");
432 output_xml_os ($oses->{$_}, $xml) foreach sort keys %$oses;
433 $xml->endTag("operatingsystems");
442 $xml->startTag("operatingsystem");
444 foreach ( [ "name" => "os" ],
445 [ "distro" => "distro" ],
446 [ "version" => "version" ],
447 [ "root" => "root_device" ] ) {
448 $xml->dataElement($_->[0], $os->{$_->[1]}) if exists $os->{$_->[1]};
451 $xml->startTag("mountpoints");
452 my $mounts = $os->{mounts};
453 foreach (sort keys %$mounts) {
454 $xml->dataElement("mountpoint", $_, "dev" => $mounts->{$_});
456 $xml->endTag("mountpoints");
458 $xml->startTag("filesystems");
459 my $filesystems = $os->{filesystems};
460 foreach (sort keys %$filesystems) {
461 $xml->startTag("filesystem", "dev" => $_);
463 foreach my $field ( [ "label" => "label" ],
464 [ "uuid" => "uuid" ],
465 [ "type" => "fstype" ],
466 [ "content" => "content" ],
467 [ "spec" => "spec" ] ) {
468 $xml->dataElement($field->[0], $filesystems->{$_}{$field->[1]})
469 if exists $filesystems->{$_}{$field->[1]};
472 $xml->endTag("filesystem");
474 $xml->endTag("filesystems");
476 if (exists $os->{modprobe_aliases}) {
477 my %aliases = %{$os->{modprobe_aliases}};
478 my @keys = sort keys %aliases;
480 $xml->startTag("modprobealiases");
482 $xml->startTag("alias", "device" => $_);
484 foreach my $field ( [ "modulename" => "modulename" ],
485 [ "augeas" => "augeas" ],
486 [ "file" => "file" ] ) {
487 $xml->dataElement($field->[0], $aliases{$_}->{$field->[1]});
490 $xml->endTag("alias");
492 $xml->endTag("modprobealiases");
496 if (exists $os->{initrd_modules}) {
497 my %modvers = %{$os->{initrd_modules}};
498 my @keys = sort keys %modvers;
500 $xml->startTag("initrds");
502 my @modules = @{$modvers{$_}};
503 $xml->startTag("initrd", "version" => $_);
504 $xml->dataElement("module", $_) foreach @modules;
505 $xml->endTag("initrd");
507 $xml->endTag("initrds");
511 $xml->startTag("applications");
512 my @apps = @{$os->{apps}};
514 $xml->startTag("application");
515 $xml->dataElement("name", $_->{name});
516 $xml->dataElement("version", $_->{version});
517 $xml->endTag("application");
519 $xml->endTag("applications");
521 $xml->startTag("kernels");
522 my @kernels = @{$os->{kernels}};
524 $xml->startTag("kernel", "version" => $_->{version});
525 $xml->startTag("modules");
526 my @modules = @{$_->{modules}};
528 $xml->dataElement("module", $_);
530 $xml->endTag("modules");
531 $xml->endTag("kernel");
533 $xml->endTag("kernels");
535 if (exists $os->{root}->{registry}) {
536 $xml->startTag("windowsregistryentries");
537 # These are just lumps of text - dump them out.
538 foreach (@{$os->{root}->{registry}}) {
539 $xml->dataElement("windowsregistryentry", $_);
541 $xml->endTag("windowsregistryentries");
544 $xml->endTag("operatingsystem");
549 When you use C<virt-inspector --query>, the output is a series of
557 (each answer is usually C<yes> or C<no>, or the line is completely
558 missing if we could not determine the answer at all).
560 If the guest is multiboot, you can get apparently conflicting answers
561 (eg. C<windows=yes> and C<linux=yes>, or a guest which is both
562 fullvirt and has a Xen PV kernel). This is normal, and just means
563 that the guest can do both things, although it might require operator
564 intervention such as selecting a boot option when the guest is
567 This section describes the full range of answers possible.
575 output_query_windows ();
576 output_query_linux ();
577 output_query_rhel ();
578 output_query_fedora ();
579 output_query_debian ();
580 output_query_fullvirt ();
581 output_query_xen_domU_kernel ();
582 output_query_xen_pv_drivers ();
583 output_query_virtio_drivers ();
586 =item windows=(yes|no)
588 Answer C<yes> if Microsoft Windows is installed in the guest.
592 sub output_query_windows
595 foreach my $os (keys %$oses) {
596 $windows="yes" if $oses->{$os}->{os} eq "windows";
598 print "windows=$windows\n";
603 Answer C<yes> if a Linux kernel is installed in the guest.
607 sub output_query_linux
610 foreach my $os (keys %$oses) {
611 $linux="yes" if $oses->{$os}->{os} eq "linux";
613 print "linux=$linux\n";
618 Answer C<yes> if the guest contains Red Hat Enterprise Linux.
622 sub output_query_rhel
625 foreach my $os (keys %$oses) {
626 $rhel="yes" if $oses->{$os}->{os} eq "linux" && $oses->{$os}->{distro} eq "redhat";
628 print "rhel=$rhel\n";
631 =item fedora=(yes|no)
633 Answer C<yes> if the guest contains the Fedora Linux distribution.
637 sub output_query_fedora
640 foreach my $os (keys %$oses) {
641 $fedora="yes" if $oses->{$os}->{os} eq "linux" && $oses->{$os}->{distro} eq "fedora";
643 print "fedora=$fedora\n";
646 =item debian=(yes|no)
648 Answer C<yes> if the guest contains the Debian Linux distribution.
652 sub output_query_debian
655 foreach my $os (keys %$oses) {
656 $debian="yes" if $oses->{$os}->{os} eq "linux" && $oses->{$os}->{distro} eq "debian";
658 print "debian=$debian\n";
661 =item fullvirt=(yes|no)
663 Answer C<yes> if there is at least one operating system kernel
664 installed in the guest which runs fully virtualized. Such a guest
665 would require a hypervisor which supports full system virtualization.
669 sub output_query_fullvirt
671 # The assumption is full-virt, unless all installed kernels
672 # are identified as paravirt.
673 # XXX Fails on Windows guests.
674 foreach my $os (keys %$oses) {
675 foreach my $kernel (@{$oses->{$os}->{kernels}}) {
676 my $is_pv = $kernel->{version} =~ m/xen/;
678 print "fullvirt=yes\n";
683 print "fullvirt=no\n";
686 =item xen_domU_kernel=(yes|no)
688 Answer C<yes> if there is at least one Linux kernel installed in
689 the guest which is compiled as a Xen DomU (a Xen paravirtualized
694 sub output_query_xen_domU_kernel
696 foreach my $os (keys %$oses) {
697 foreach my $kernel (@{$oses->{$os}->{kernels}}) {
698 my $is_xen = $kernel->{version} =~ m/xen/;
700 print "xen_domU_kernel=yes\n";
705 print "xen_domU_kernel=no\n";
708 =item xen_pv_drivers=(yes|no)
710 Answer C<yes> if the guest has Xen paravirtualized drivers installed
711 (usually the kernel itself will be fully virtualized, but the PV
712 drivers have been installed by the administrator for performance
717 sub output_query_xen_pv_drivers
719 foreach my $os (keys %$oses) {
720 foreach my $kernel (@{$oses->{$os}->{kernels}}) {
721 foreach my $module (@{$kernel->{modules}}) {
722 if ($module =~ m/xen-/) {
723 print "xen_pv_drivers=yes\n";
729 print "xen_pv_drivers=no\n";
732 =item virtio_drivers=(yes|no)
734 Answer C<yes> if the guest has virtio paravirtualized drivers
735 installed. Virtio drivers are commonly used to improve the
740 sub output_query_virtio_drivers
742 foreach my $os (keys %$oses) {
743 foreach my $kernel (@{$oses->{$os}->{kernels}}) {
744 foreach my $module (@{$kernel->{modules}}) {
745 if ($module =~ m/virtio_/) {
746 print "virtio_drivers=yes\n";
752 print "virtio_drivers=no\n";
762 L<Sys::Guestfs::Lib(3)>,
764 L<http://libguestfs.org/>.
766 For Windows registry parsing we require the C<reged> program
767 from L<http://home.eunet.no/~pnordahl/ntpasswd/>.
771 Richard W.M. Jones L<http://et.redhat.com/~rjones/>
773 Matthew Booth L<mbooth@redhat.com>
777 Copyright (C) 2009 Red Hat Inc.
779 This program is free software; you can redistribute it and/or modify
780 it under the terms of the GNU General Public License as published by
781 the Free Software Foundation; either version 2 of the License, or
782 (at your option) any later version.
784 This program is distributed in the hope that it will be useful,
785 but WITHOUT ANY WARRANTY; without even the implied warranty of
786 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
787 GNU General Public License for more details.
789 You should have received a copy of the GNU General Public License
790 along with this program; if not, write to the Free Software
791 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.