=encoding utf8

=head1 名前

virt-inspector - Display operating system version and other information
about a virtual machine

=head1 書式

 virt-inspector [--options] -d domname

 virt-inspector [--options] -a disk.img [-a disk.img ...]

古い形式:

 virt-inspector domname

 virt-inspector disk.img [disk.img ...]

=head1 説明

B<virt-inspector> examines a virtual machine or disk image and tries to
determine the version of the operating system and other information about
the virtual machine.

Virt-inspector は他のプログラムに提供するための情報をXML形式出力で生成します。

In the normal usage, use C<virt-inspector -d domname> where C<domname> is
the libvirt domain (see: C<virsh list --all>).

You can also run virt-inspector directly on disk images from a single
virtual machine.  Use C<virt-inspector -a disk.img>.  In rare cases a domain
has several block devices, in which case you should list several I<-a>
options one after another, with the first corresponding to the guest's
C</dev/sda>, the second to the guest's C</dev/sdb> and so on.

You can also run virt-inspector on install disks, live CDs, bootable USB
keys and similar.

Virt-inspector can only inspect and report upon I<one domain at a time>.  To
inspect several virtual machines, you have to run virt-inspector several
times (for example, from a shell script for-loop).

Because virt-inspector needs direct access to guest images, it won't
normally work over remote libvirt connections.

All of the information available from virt-inspector is also available
through the core libguestfs inspection API (see L<guestfs(3)/INSPECTION>).
The same information can also be fetched using guestfish or via libguestfs
bindings in many programming languages (see L</GETTING INSPECTION DATA FROM
THE LIBGUESTFS API>).

=head1 オプション

=over 4

=item B<--help>

簡単なヘルプを表示します。

=item B<-a> file

=item B<--add> file

Add I<file> which should be a disk image from a virtual machine.  If the
virtual machine has multiple block devices, you must supply all of them with
separate I<-a> options.

ディスクイメージの形式は自動検知されます。これを上書きして強制的に特定の形式を使用するには、I<--format=..> オプションを使用します。

=item B<-c URI>

=item B<--connect URI>

libvirt を使用していると、指定された I<URI> に接続します。  省略すると、デフォルトの libvirt ハイパーバイザーに接続します。

Libvirt is only used if you specify a C<domname> on the command line.  If
you specify guest block devices directly (I<-a>), then libvirt is not used
at all.

=item B<-d> guest

=item B<--domain> guest

名前付きの libvirt 仮想マシンからすべてのディスクを追加します。  ドメインの UUID が名前の代わりに使用されます。

=item B<--echo-keys>

When prompting for keys and passphrases, virt-inspector normally turns
echoing off so you cannot see what you are typing.  If you are not worried
about Tempest attacks and there is no one else in the room you can specify
this flag to see what you are typing.

=item B<--format=raw|qcow2|..>

=item B<--format>

Specify the format of disk images given on the command line.  If this is
omitted then the format is autodetected from the content of the disk image.

If disk images are requested from libvirt, then this program asks libvirt
for this information.  In this case, the value of the format parameter is
ignored.

If working with untrusted raw-format guest disk images, you should ensure
the format is always specified.

=item B<--keys-from-stdin>

Read key or passphrase parameters from stdin.  The default is to try to read
passphrases from the user by opening C</dev/tty>.

=item B<-v>

=item B<--verbose>

デバッグ用の冗長なメッセージを有効にします。

=item B<-V>

=item B<--version>

バージョン番号を表示して終了します。

=item B<-x>

libguestfs API 呼び出しのトレースを有効にします。

=item B<--xpath> query

Perform an XPath query on the XML on stdin, and print the result on stdout.
In this mode virt-inspector simply runs an XPath query; all other inspection
functions are disabled.  See L</XPATH QUERIES> below for some examples.

=back

=head1 旧形式のコマンドライン引数

Previous versions of virt-inspector allowed you to write either:

 virt-inspector disk.img [disk.img ...]

または

 virt-inspector guestname

whereas in this version you should use I<-a> or I<-d> respectively to avoid
the confusing case where a disk image might have the same name as a guest.

互換性のため古い形式がまだサポートされています。

=head1 XML フォーマット

The virt-inspector XML is described precisely in a RELAX NG schema file
C<virt-inspector.rng> which is supplied with libguestfs.  This section is
just an overview.

The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or
more E<lt>operatingsystemE<gt> elements.  You would only see more than one
E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot,
which is vanishingly rare in real world VMs.

=head2 E<lt>operatingsystemE<gt>

In the E<lt>operatingsystemE<gt> tag are various optional fields that
describe the operating system, its architecture, the descriptive "product
name" string, the type of OS and so on, as in this example:

 <operatingsystems>
   <operatingsystem>
     <root>/dev/sda2</root>
     <name>windows</name>
     <arch>i386</arch>
     <distro>windows</distro>
     <product_name>Windows 7 Enterprise</product_name>
     <product_variant>Client</product_variant>
     <major_version>6</major_version>
     <minor_version>1</minor_version>
     <windows_systemroot>/Windows</windows_systemroot>
     <format>installed</format>

In brief, E<lt>nameE<gt> is the class of operating system (something like
C<linux> or C<windows>), E<lt>distroE<gt> is the distribution (eg. C<fedora>
but many other distros are recognized) and E<lt>archE<gt> is the guest
architecture.  The other fields are fairly self-explanatory, but because
these fields are taken directly from the libguestfs inspection API you can
find precise information from L<guestfs(3)/INSPECTION>.

The E<lt>rootE<gt> element is the root filesystem device, but from the point
of view of libguestfs (block devices may have completely different names
inside the VM itself).

=head2 E<lt>mountpointsE<gt>

Un*x-like guests typically have multiple filesystems which are mounted at
various mountpoints, and these are described in the E<lt>mountpointsE<gt>
element which looks like this:

 <operatingsystems>
   <operatingsystem>
     ...
     <mountpoints>
       <mountpoint dev="/dev/vg_f13x64/lv_root">/</mountpoint>
       <mountpoint dev="/dev/sda1">/boot</mountpoint>
     </mountpoints>

As with E<lt>rootE<gt>, devices are from the point of view of libguestfs,
and may have completely different names inside the guest.  Only mountable
filesystems appear in this list, not things like swap devices.

=head2 E<lt>filesystemsE<gt>

E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all>
filesystems belonging to the guest, including swap and empty partitions.
(In the rare case of a multi-boot guest, it covers filesystems belonging to
this OS or shared with this OS and other OSes).

次のように表示されることがあります:

 <operatingsystems>
   <operatingsystem>
     ...
     <filesystems>
       <filesystem dev="/dev/vg_f13x64/lv_root">
         <type>ext4</type>
         <label>Fedora-13-x86_64</label>
         <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>
       </filesystem>

The optional elements within E<lt>filesystemE<gt> are the filesystem type,
the label, and the UUID.

=head2 E<lt>applicationsE<gt>

関連する要素 E<lt>package_formatE<gt>, E<lt>package_managementE<gt> および
E<lt>applicationsE<gt> は仮想マシンにインストールされたアプリケーションを記述しています。

E<lt>package_formatE<gt>, if present, describes the packaging system used.
Typical values would be C<rpm> and C<deb>.

E<lt>package_managementE<gt>, if present, describes the package manager.
Typical values include C<yum>, C<up2date> and C<apt>

E<lt>applicationsE<gt> lists the packages or applications installed.

 <operatingsystems>
   <operatingsystem>
     ...
     <applications>
       <application>
         <name>coreutils</name>
         <version>8.5</version>
         <release>1</release>
       </application>

The version and release fields may not be available for some types guests.
Other fields are possible, see
L<guestfs(3)/guestfs_inspect_list_applications>.

=head2 E<lt>drive_mappingsE<gt>

For operating systems like Windows which use drive letters, virt-inspector
is able to find out how drive letters map to filesystems.

 <operatingsystems>
   <operatingsystem>
     ...
     <drive_mappings>
       <drive_mapping name="C">/dev/sda2</drive_mapping>
       <drive_mapping name="E">/dev/sdb1</drive_mapping>
     </drive_mappings>

In the example above, drive C maps to the filesystem on the second partition
on the first disk, and drive E maps to the filesystem on the first partition
on the second disk.

Note that this only covers permanent local filesystem mappings, not things
like network shares.  Furthermore NTFS volume mount points may not be listed
here.

=head2 E<lt>iconE<gt>

Virt-inspector is sometimes able to extract an icon or logo for the guest.
The icon is returned as base64-encoded PNG data.  Note that the icon can be
very large and high quality.

 <operatingsystems>
   <operatingsystem>
     ...
     <icon>
       iVBORw0KGgoAAAANSUhEUgAAAGAAAABg[.......]
       [... many lines of base64 data ...]
     </icon>

To display the icon, you have to extract it and convert the base64 data back
to a binary file.  Use an XPath query or simply an editor to extract the
data, then use the coreutils L<base64(1)> program to do the conversion back
to a PNG file:

 base64 -i -d < icon.data > icon.png

=head2 INSPECTING INSTALL DISKS, LIVE CDs

Virt-inspector can detect some operating system installers on install disks,
live CDs, bootable USB keys and more.

In this case the E<lt>formatE<gt> tag will contain C<installer> and other
fields may be present to indicate a live CD, network installer, or one part
of a multipart CD.  For example:

 <operatingsystems>
   <operatingsystem>
     <root>/dev/sda</root>
     <name>linux</name>
     <arch>i386</arch>
     <distro>ubuntu</distro>
     <product_name>Ubuntu 10.10 "Maverick Meerkat"</product_name>
     <major_version>10</major_version>
     <minor_version>10</minor_version>
     <format>installer</format>
     <live/>

=head1 XPath クエリー

Virt-inspector includes built in support for running XPath queries.  The
reason for including XPath support directly in virt-inspector is simply that
there are no good and widely available command line programs that can do
XPath queries.  The only good one is L<xmlstarlet(1)> and that is not
available on Red Hat Enterprise Linux.

To perform an XPath query, use the I<--xpath> option.  Note that in this
mode, virt-inspector simply reads XML from stdin and outputs the query
result on stdout.  All other inspection features are disabled in this mode.

例:

 $ virt-inspector -d Guest | virt-inspector --xpath '//filesystems'
 <filesystems>
      <filesystem dev="/dev/vg_f13x64/lv_root">
        <type>ext4</type>
 [...]

 $ virt-inspector -d Guest | \
     virt-inspector --xpath "string(//filesystem[@dev='/dev/sda1']/type)"
 ext4

 $ virt-inspector -d Guest | \
     virt-inspector --xpath 'string(//icon)' | base64 -i -d | display -
 [displays the guest icon, if there is one]

=head1 SHELL QUOTING

Libvirt guest names can contain arbitrary characters, some of which have
meaning to the shell such as C<#> and space.  You may need to quote or
escape these characters on the command line.  See the shell manual page
L<sh(1)> for details.

=head1 GETTING INSPECTION DATA FROM THE LIBGUESTFS API

In early versions of libguestfs, virt-inspector was a large Perl script that
contained many heuristics for inspecting guests.  This had several problems:
in order to do inspection from other tools (like guestfish) we had to call
out to this Perl script; and it privileged Perl over other languages that
libguestfs supports.

By libguestfs 1.8 we had rewritten the Perl code in C, and incorporated it
all into the core libguestfs API (L<guestfs(3)>).  Now virt-inspector is
simply a thin C program over the core C API.  All of the inspection
information is available from all programming languages that libguestfs
supports, and from guestfish.

For a description of the C inspection API, read L<guestfs(3)/INSPECTION>.

For example code using the C inspection API, look for C<inspect_vm.c> which
ships with libguestfs.

C<inspect_vm.c> has also been translated into other languages.  For example,
C<inspect_vm.pl> is the Perl translation, and there are other translations
for OCaml, Python, etc.  See L<guestfs(3)/USING LIBGUESTFS WITH OTHER
PROGRAMMING LANGUAGES> for a list of man pages which contain this example
code.

=head2 GETTING INSPECTION DATA FROM GUESTFISH

If you use the guestfish I<-i> option, then the main C inspection API
L<guestfs(3)/guestfs_inspect_os> is called.  This is equivalent to the
guestfish command C<inspect-os>.  You can also call this guestfish command
by hand.

C<inspect-os> performs inspection on the current disk image, returning the
list of operating systems found.  Each OS is represented by its root
filesystem device.  In the majority of cases, this command prints nothing
(no OSes found), or a single root device, but beware that it can print
multiple lines if there are multiple OSes or if there is an install CD
attached to the guest.

 $ guestfish --ro -a F15x32.img
 ><fs> run
 ><fs> inspect-os
 /dev/vg_f15x32/lv_root

ルートデバイスを使用して、ゲストに関するさらなる情報を取得できます:

 ><fs> inspect-get-type /dev/vg_f15x32/lv_root
 linux
 ><fs> inspect-get-distro /dev/vg_f15x32/lv_root
 fedora
 ><fs> inspect-get-major-version /dev/vg_f15x32/lv_root
 15
 ><fs> inspect-get-product-name /dev/vg_f15x32/lv_root
 Fedora release 15 (Lovelock)

Limitations of guestfish make it hard to assign the root device to a
variable (since guestfish doesn't have variables), so if you want to do this
reproducibly you are better off writing a script using one of the other
languages that the libguestfs API supports.

To list applications, you have to first mount up the disks:

 ><fs> inspect-get-mountpoints /dev/vg_f15x32/lv_root
 /: /dev/vg_f15x32/lv_root
 /boot: /dev/vda1
 ><fs> mount-ro /dev/vg_f15x32/lv_root /
 ><fs> mount-ro /dev/vda1 /boot

and then call the inspect-list-applications API:

 ><fs> inspect-list-applications /dev/vg_f15x32/lv_root | head -28
 [0] = {
   app_name: ConsoleKit
   app_display_name:
   app_epoch: 0
   app_version: 0.4.5
   app_release: 1.fc15
   app_install_path:
   app_trans_path:
   app_publisher:
   app_url:
   app_source_package:
   app_summary:
   app_description:
 }
 [1] = {
   app_name: ConsoleKit-libs
   app_display_name:
   app_epoch: 0
   app_version: 0.4.5
   app_release: 1.fc15
   app_install_path:
   app_trans_path:
   app_publisher:
   app_url:
   app_source_package:
   app_summary:
   app_description:
 }

To display an icon for the guest, note that filesystems must also be mounted
as above.  You can then do:

 ><fs> inspect-get-icon /dev/vg_f15x32/lv_root | display -

=head1 古いバージョンの virt-inspector

As described above, early versions of libguestfs shipped with a different
virt-inspector program written in Perl (the current version is written in
C).  The XML output of the Perl virt-inspector was different and it could
also output in other formats like text.

古い virt-inspector はもはや libguestfs でサポートされず、同梱されていません。

さらに混乱することに、Red Hat Enterprise Linux 6 では異なる名前で 2 つのバージョンの virt-inspector
が同梱されています:

 virt-inspector     古い Perl バージョンです。
 virt-inspector2    新しい C バージョンです。

=head1 終了ステータス

このプログラムは、成功すると 0 を、エラーがあると 0 以外を返します。

=head1 関連項目

L<guestfs(3)>, L<guestfish(1)>, L<http://www.w3.org/TR/xpath/>,
L<base64(1)>, L<xmlstarlet(1)>, L<http://libguestfs.org/>.

=head1 著者

=over 4

=item *

Richard W.M. Jones L<http://people.redhat.com/~rjones/>

=item *

Matthew Booth L<mbooth@redhat.com>

=back

=head1 COPYRIGHT

Copyright (C) 2010-2012 Red Hat Inc.

This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2 of the License, or (at your option)
any later version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
more details.

You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 51
Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.