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://people.redhat.com/~rjones/virt-what/>,
 142 L<http://www.vmware.com/>,
 143 L<http://www.microsoft.com/windows/products/winfamily/virtualpc>,
 144 L<http://xensource.com/>,
 145 L<http://bellard.org/qemu/>,
 146 L<http://kvm.qumranet.com/>,
 147 L<http://openvz.org/>
 148
 149 =head1 AUTHORS
 150
 151 Richard W.M. Jones <rjones @ redhat . com>
 152
 153 =head1 COPYRIGHT
 154
 155 (C) Copyright 2008-2011 Red Hat Inc.,
 156 L<http://people.redhat.com/~rjones/virt-what/>
 157
 158 This program is free software; you can redistribute it and/or modify
 159 it under the terms of the GNU General Public License as published by
 160 the Free Software Foundation; either version 2 of the License, or
 161 (at your option) any later version.
 162
 163 This program is distributed in the hope that it will be useful,
 164 but WITHOUT ANY WARRANTY; without even the implied warranty of
 165 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 166 GNU General Public License for more details.
 167
 168 You should have received a copy of the GNU General Public License
 169 along with this program; if not, write to the Free Software
 170 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 171
 172 =head1 REPORTING BUGS
 173
 174 Bugs can be viewed on the Red Hat Bugzilla page:
 175 L<https://bugzilla.redhat.com/>.
 176
 177 If you find a bug in virt-what, please follow these steps to report it:
 178
 179 =over 4
 180
 181 =item 1. Check for existing bug reports
 182
 183 Go to L<https://bugzilla.redhat.com/> and search for similar bugs.
 184 Someone may already have reported the same bug, and they may even
 185 have fixed it.
 186
 187 =item 2. Capture debug and error messages
 188
 189 Run
 190
 191  virt-what > virt-what.log 2>&1
 192
 193 and keep I<virt-what.log>.  It may contain error messages which you
 194 should submit with your bug report.
 195
 196 =item 3. Get version of virt-what and version of libvirt.
 197
 198 Run
 199
 200  virt-what --version
 201
 202 =item 4. Submit a bug report.
 203
 204 Go to L<https://bugzilla.redhat.com/> and enter a new bug.
 205 Please describe the problem in as much detail as possible.
 206
 207 Remember to include the version numbers (step 3) and the debug
 208 messages file (step 2).
 209
 210 =item 5. Assign the bug to rjones @ redhat.com
 211
 212 Assign or reassign the bug to B<rjones @ redhat.com> (without the
 213 spaces).  You can also send me an email with the bug number if you
 214 want a faster response.
 215
 216 =back