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