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