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.
  56
  57 Status: confirmed by RWMJ.
  58
  59 =item B<uml>
  60
  61 This is a User-Mode Linux (UML) guest.
  62
  63 Status: contributed by Laurent Léonard
  64
  65 =item B<virtage>
  66
  67 This is Hitachi Virtualization Manager (HVM) Virtage logical partitioning.
  68
  69 Status: data supplied by Bhavna Sarathy, not confirmed
  70
  71 =item B<virtualbox>
  72
  73 This is a VirtualBox guest.
  74
  75 Status: contributed by Laurent Léonard
  76
  77 =item B<virtualpc>
  78
  79 The guest appears to be running on Microsoft VirtualPC.
  80
  81 Status: not confirmed
  82
  83 =item B<vmware>
  84
  85 The guest appears to be running on VMware.
  86
  87 Status: confirmed by RWMJ
  88
  89 =item B<xen>
  90
  91 The guest appears to be running on Xen.
  92
  93 Status: confirmed by RWMJ
  94
  95 =item B<xen-dom0>
  96
  97 This is the Xen dom0 (privileged domain).
  98
  99 Status: confirmed by RWMJ
 100
 101 =item B<xen-domU>
 102
 103 This is a Xen domU (paravirtualized guest domain).
 104
 105 Status: confirmed by RWMJ
 106
 107 =item B<xen-hvm>
 108
 109 This is a Xen guest fully virtualized (HVM).
 110
 111 Status: confirmed by RWMJ
 112
 113 =back
 114
 115 =head1 IMPORTANT NOTE
 116
 117 Most of the time, using this program is the I<wrong> thing to do.
 118 Instead you should detect the specific features you actually want to
 119 use.  (As an example, if you wanted to issue Xen hypervisor commands
 120 you would look for the C</proc/xen/privcmd> file).
 121
 122 However people keep asking for this, so we provide it.  There are a
 123 few legitimate uses:
 124
 125 =over 4
 126
 127 =item Bug reporting tool
 128
 129 If you think that virtualization could affect how your program runs,
 130 then you might use C<virt-what> to report this in a bug reporting
 131 tool.
 132
 133 =item Status display and monitoring tools
 134
 135 You might include this information in status and monitoring programs.
 136
 137 =back
 138
 139 =head1 SEE ALSO
 140
 141 L<http://www.libvirt.org/>,
 142 L<http://et.redhat.com/~rjones/>,
 143 L<http://www.vmware.com/>,
 144 L<http://www.microsoft.com/windows/products/winfamily/virtualpc>,
 145 L<http://xensource.com/>,
 146 L<http://bellard.org/qemu/>,
 147 L<http://kvm.qumranet.com/>,
 148 L<http://openvz.org/>
 149
 150 =head1 AUTHORS
 151
 152 Richard W.M. Jones <rjones @ redhat . com>
 153
 154 =head1 COPYRIGHT
 155
 156 (C) Copyright 2008 Red Hat Inc.,
 157 L<http://libvirt.org/>
 158
 159 This program is free software; you can redistribute it and/or modify
 160 it under the terms of the GNU General Public License as published by
 161 the Free Software Foundation; either version 2 of the License, or
 162 (at your option) any later version.
 163
 164 This program is distributed in the hope that it will be useful,
 165 but WITHOUT ANY WARRANTY; without even the implied warranty of
 166 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 167 GNU General Public License for more details.
 168
 169 You should have received a copy of the GNU General Public License
 170 along with this program; if not, write to the Free Software
 171 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 172
 173 =head1 REPORTING BUGS
 174
 175 Bugs can be viewed on the Red Hat Bugzilla page:
 176 L<https://bugzilla.redhat.com/>.
 177
 178 If you find a bug in virt-what, please follow these steps to report it:
 179
 180 =over 4
 181
 182 =item 1. Check for existing bug reports
 183
 184 Go to L<https://bugzilla.redhat.com/> and search for similar bugs.
 185 Someone may already have reported the same bug, and they may even
 186 have fixed it.
 187
 188 =item 2. Capture debug and error messages
 189
 190 Run
 191
 192  virt-what > virt-what.log 2>&1
 193
 194 and keep I<virt-what.log>.  It may contain error messages which you
 195 should submit with your bug report.
 196
 197 =item 3. Get version of virt-what and version of libvirt.
 198
 199 Run
 200
 201  virt-what --version
 202
 203 =item 4. Submit a bug report.
 204
 205 Go to L<https://bugzilla.redhat.com/> and enter a new bug.
 206 Please describe the problem in as much detail as possible.
 207
 208 Remember to include the version numbers (step 3) and the debug
 209 messages file (step 2).
 210
 211 =item 5. Assign the bug to rjones @ redhat.com
 212
 213 Assign or reassign the bug to B<rjones @ redhat.com> (without the
 214 spaces).  You can also send me an email with the bug number if you
 215 want a faster response.
 216
 217 =back