virt-what.pod

   1 =head1 NAME
   2
   3 virt-what - detect if we are running in a virtual machine
   4
   5 =head1 SUMMARY
   6
   7 virt-what [options]
   8
   9 =head1 DESCRIPTION
  10
  11 C<virt-what> is a shell script which can be used to detect if the
  12 program is running in a virtual machine.
  13
  14 The program prints out a list of "facts" about the virtual machine,
  15 derived from heuristics.  One fact is printed per line.
  16
  17 If nothing is printed and the script exits with code 0 (no error),
  18 then it can mean I<either> that the program is running on bare-metal
  19 I<or> the program is running inside a type of virtual machine which we
  20 don't know about or cannot detect.
  21
  22 =head1 FACTS
  23
  24 =over 4
  25
  26 =item B<openvz>
  27
  28 The guest appears to be running inside an OpenVZ or Virtuozzo
  29 container.
  30
  31 Status: contributed by Evgeniy Sokolov
  32
  33 =item B<kvm>
  34
  35 This is KVM.
  36
  37 Status: confirmed by RWMJ.
  38
  39 =item B<qemu>
  40
  41 This is QEMU.
  42
  43 Status: confirmed by RWMJ.
  44
  45 =item B<virtualpc>
  46
  47 The guest appears to be running on Microsoft VirtualPC.
  48
  49 Status: not confirmed
  50
  51 =item B<vmware>
  52
  53 The guest appears to be running on VMware.
  54
  55 Status: not confirmed
  56
  57 =item B<xen>
  58
  59 The guest appears to be running on Xen.
  60
  61 Status: confirmed by RWMJ
  62
  63 =item B<xen-dom0>
  64
  65 This is the Xen dom0 (privileged domain).
  66
  67 Status: confirmed by RWMJ
  68
  69 =item B<xen-domU>
  70
  71 This is a Xen domU (paravirtualized guest domain).
  72
  73 Status: confirmed by RWMJ
  74
  75 =item B<xen-hvm>
  76
  77 This is a Xen guest fully virtualized (HVM).
  78
  79 Status: confirmed by RWMJ
  80
  81 =back
  82
  83 =head1 IMPORTANT NOTE
  84
  85 Most of the time, using this program is the I<wrong> thing to do.
  86 Instead you should detect the specific features you actually want to
  87 use.  (As an example, if you wanted to issue Xen hypervisor commands
  88 you would look for the C</proc/xen/privcmd> file).
  89
  90 However people keep asking for this, so we provide it.  There are a
  91 few legitimate uses:
  92
  93 =over 4
  94
  95 =item Bug reporting tool
  96
  97 If you think that virtualization could affect how your program runs,
  98 then you might use C<virt-what> to report this in a bug reporting
  99 tool.
 100
 101 =item Status display and monitoring tools
 102
 103 You might include this information in status and monitoring programs.
 104
 105 =back
 106
 107 =head1 SEE ALSO
 108
 109 L<http://www.libvirt.org/>,
 110 L<http://et.redhat.com/~rjones/>,
 111 L<http://www.vmware.com/>,
 112 L<http://www.microsoft.com/windows/products/winfamily/virtualpc>,
 113 L<http://xensource.com/>,
 114 L<http://bellard.org/qemu/>,
 115 L<http://kvm.qumranet.com/>,
 116 L<http://openvz.org/>
 117
 118 =head1 AUTHORS
 119
 120 Richard W.M. Jones <rjones @ redhat . com>
 121
 122 =head1 COPYRIGHT
 123
 124 (C) Copyright 2008 Red Hat Inc.,
 125 L<http://libvirt.org/>
 126
 127 This program is free software; you can redistribute it and/or modify
 128 it under the terms of the GNU General Public License as published by
 129 the Free Software Foundation; either version 2 of the License, or
 130 (at your option) any later version.
 131
 132 This program is distributed in the hope that it will be useful,
 133 but WITHOUT ANY WARRANTY; without even the implied warranty of
 134 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 135 GNU General Public License for more details.
 136
 137 You should have received a copy of the GNU General Public License
 138 along with this program; if not, write to the Free Software
 139 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 140
 141 =head1 REPORTING BUGS
 142
 143 Bugs can be viewed on the Red Hat Bugzilla page:
 144 L<https://bugzilla.redhat.com/>.
 145
 146 If you find a bug in virt-what, please follow these steps to report it:
 147
 148 =over 4
 149
 150 =item 1. Check for existing bug reports
 151
 152 Go to L<https://bugzilla.redhat.com/> and search for similar bugs.
 153 Someone may already have reported the same bug, and they may even
 154 have fixed it.
 155
 156 =item 2. Capture debug and error messages
 157
 158 Run
 159
 160  virt-what > virt-what.log 2>&1
 161
 162 and keep I<virt-what.log>.  It may contain error messages which you
 163 should submit with your bug report.
 164
 165 =item 3. Get version of virt-what and version of libvirt.
 166
 167 Run
 168
 169  virt-what --version
 170
 171 =item 4. Submit a bug report.
 172
 173 Go to L<https://bugzilla.redhat.com/> and enter a new bug.
 174 Please describe the problem in as much detail as possible.
 175
 176 Remember to include the version numbers (step 3) and the debug
 177 messages file (step 2).
 178
 179 =item 5. Assign the bug to rjones @ redhat.com
 180
 181 Assign or reassign the bug to B<rjones @ redhat.com> (without the
 182 spaces).  You can also send me an email with the bug number if you
 183 want a faster response.
 184
 185 =back