virt-what.pod

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