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 Microsoft Hyper-V hypervisor.
  31
  32 Status: confirmed by RWMJ
  33
  34 =item B<ibm_systemz>
  35
  36 This is an IBM SystemZ (or other S/390) hardware partitioning system.
  37 Additional facts listed below may also be printed.
  38
  39 =item B<ibm_systemz-direct>
  40
  41 This is Linux running directly on a IBM SystemZ hardware partitioning
  42 system.
  43
  44 This is expected to be a highly unusual configuration - if
  45 you see this result you should treat it with suspicion.
  46
  47 Status: not confirmed
  48
  49 =item B<ibm_systemz-lpar>
  50
  51 This is Linux running directly on an LPAR on an IBM SystemZ
  52 hardware partitioning system.
  53
  54 Status: not confirmed
  55
  56 =item B<ibm_systemz-zvm>
  57
  58 This is a z/VM guest running in an LPAR on an IBM SystemZ
  59 hardware partitioning system.
  60
  61 Status: confirmed by RWMJ using a Fedora guest running in z/VM
  62
  63 =item B<linux_vserver>
  64
  65 This process is running in a Linux VServer container.
  66
  67 Status: contributed by Barış Metin
  68
  69 =item B<kvm>
  70
  71 This guest is running on the KVM hypervisor using hardware
  72 acceleration.
  73
  74 Note that if the hypervisor is using software acceleration
  75 you should I<not> see this, but should see the C<qemu> fact
  76 instead.
  77
  78 Status: confirmed by RWMJ.
  79
  80 =item B<openvz>
  81
  82 The guest appears to be running inside an OpenVZ or Virtuozzo
  83 container.
  84
  85 Status: contributed by Evgeniy Sokolov
  86
  87 =item B<parallels>
  88
  89 The guest is running inside Parallels Virtual Platform
  90 (Parallels Desktop, Parallels Server).
  91
  92 Status: contributed by Justin Clift
  93
  94 =item B<powervm_lx86>
  95
  96 The guest is running inside IBM PowerVM Lx86 Linux/x86 emulator.
  97
  98 Status: data originally supplied by Jeffrey Scheel, confimed by
  99 Yufang Zhang and RWMJ
 100
 101 =item B<qemu>
 102
 103 This is QEMU hypervisor using software emulation.
 104
 105 Note that for KVM (hardware accelerated) guests you should I<not> see
 106 this.
 107
 108 Status: confirmed by RWMJ.
 109
 110 =item B<uml>
 111
 112 This is a User-Mode Linux (UML) guest.
 113
 114 Status: contributed by Laurent Léonard
 115
 116 =item B<virt>
 117
 118 Some sort of virtualization appears to be present, but we are not sure
 119 what it is.  In some very rare corner cases where we know that
 120 virtualization is hard to detect, we will try a timing attack to see
 121 if certain machine instructions are running much more slowly than they
 122 should be, which would indicate virtualization.  In this case, the
 123 generic fact C<virt> is printed.
 124
 125 =item B<virtage>
 126
 127 This is Hitachi Virtualization Manager (HVM) Virtage
 128 hardware partitioning system.
 129
 130 Status: data supplied by Bhavna Sarathy, not confirmed
 131
 132 =item B<virtualbox>
 133
 134 This is a VirtualBox guest.
 135
 136 Status: contributed by Laurent Léonard
 137
 138 =item B<virtualpc>
 139
 140 The guest appears to be running on Microsoft VirtualPC.
 141
 142 Status: not confirmed
 143
 144 =item B<vmware>
 145
 146 The guest appears to be running on VMware hypervisor.
 147
 148 Status: confirmed by RWMJ
 149
 150 =item B<xen>
 151
 152 The guest appears to be running on Xen hypervisor.
 153
 154 Status: confirmed by RWMJ
 155
 156 =item B<xen-dom0>
 157
 158 This is the Xen dom0 (privileged domain).
 159
 160 Status: confirmed by RWMJ
 161
 162 =item B<xen-domU>
 163
 164 This is a Xen domU (paravirtualized guest domain).
 165
 166 Status: confirmed by RWMJ
 167
 168 =item B<xen-hvm>
 169
 170 This is a Xen guest fully virtualized (HVM).
 171
 172 Status: confirmed by RWMJ
 173
 174 =back
 175
 176 =head1 EXIT STATUS
 177
 178 Programs that use or wrap C<virt-what> should check that the exit
 179 status is 0 before they attempt to parse the output of the command.
 180
 181 A non-zero exit status indicates some error, for example, an
 182 unrecognized command line argument.  If the exit status is non-zero
 183 then the output "facts" (if any were printed) cannot be guaranteed and
 184 should be ignored.
 185
 186 The exit status does I<not> have anything to do with whether the
 187 program is running on baremetal or under virtualization, nor with
 188 whether C<virt-what> managed detection "correctly" (which is basically
 189 unknowable given the large variety of virtualization systems out there
 190 and that some systems deliberately emulate others).
 191
 192 =head1 RUNNING VIRT-WHAT FROM OTHER PROGRAMS
 193
 194 C<virt-what> is designed so that you can easily run it from
 195 other programs or wrap it up in a library.
 196
 197 Your program should check the exit status (see the section above).
 198
 199 Some programming languages (notably Python: issue 1652) erroneously
 200 mask the C<SIGPIPE> signal and do not restore it when executing
 201 subprocesses.  C<virt-what> is a shell script and some shell commands
 202 do not work correctly when you do this.  You may see warnings from
 203 C<virt-what> similar to this:
 204
 205  echo: write error: Broken pipe
 206
 207 The solution is to set the C<SIGPIPE> signal handler back to C<SIG_DFL>
 208 before running C<virt-what>.
 209
 210 =head1 IMPORTANT NOTE
 211
 212 Most of the time, using this program is the I<wrong> thing to do.
 213 Instead you should detect the specific features you actually want to
 214 use.  (As an example, if you wanted to issue Xen hypervisor commands
 215 you would look for the C</proc/xen/privcmd> file).
 216
 217 However people keep asking for this, so we provide it.  There are a
 218 few legitimate uses:
 219
 220 =over 4
 221
 222 =item Bug reporting tool
 223
 224 If you think that virtualization could affect how your program runs,
 225 then you might use C<virt-what> to report this in a bug reporting
 226 tool.
 227
 228 =item Status display and monitoring tools
 229
 230 You might include this information in status and monitoring programs.
 231
 232 =back
 233
 234 =head1 SEE ALSO
 235
 236 L<http://people.redhat.com/~rjones/virt-what/>,
 237 L<http://www.vmware.com/>,
 238 L<http://www.microsoft.com/windows/products/winfamily/virtualpc>,
 239 L<http://xensource.com/>,
 240 L<http://bellard.org/qemu/>,
 241 L<http://kvm.qumranet.com/>,
 242 L<http://openvz.org/>
 243
 244 =head1 AUTHORS
 245
 246 Richard W.M. Jones <rjones @ redhat . com>
 247
 248 =head1 COPYRIGHT
 249
 250 (C) Copyright 2008-2011 Red Hat Inc.,
 251 L<http://people.redhat.com/~rjones/virt-what/>
 252
 253 This program is free software; you can redistribute it and/or modify
 254 it under the terms of the GNU General Public License as published by
 255 the Free Software Foundation; either version 2 of the License, or
 256 (at your option) any later version.
 257
 258 This program is distributed in the hope that it will be useful,
 259 but WITHOUT ANY WARRANTY; without even the implied warranty of
 260 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 261 GNU General Public License for more details.
 262
 263 You should have received a copy of the GNU General Public License
 264 along with this program; if not, write to the Free Software
 265 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 266
 267 =head1 REPORTING BUGS
 268
 269 Bugs can be viewed on the Red Hat Bugzilla page:
 270 L<https://bugzilla.redhat.com/>.
 271
 272 If you find a bug in virt-what, please follow these steps to report it:
 273
 274 =over 4
 275
 276 =item 1. Check for existing bug reports
 277
 278 Go to L<https://bugzilla.redhat.com/> and search for similar bugs.
 279 Someone may already have reported the same bug, and they may even
 280 have fixed it.
 281
 282 =item 2. Capture debug and error messages
 283
 284 Run
 285
 286  virt-what > virt-what.log 2>&1
 287
 288 and keep I<virt-what.log>.  It may contain error messages which you
 289 should submit with your bug report.
 290
 291 =item 3. Get version of virt-what.
 292
 293 Run
 294
 295  virt-what --version
 296
 297 =item 4. Submit a bug report.
 298
 299 Go to L<https://bugzilla.redhat.com/> and enter a new bug.
 300 Please describe the problem in as much detail as possible.
 301
 302 Remember to include the version numbers (step 3) and the debug
 303 messages file (step 2) and as much other detail as possible.
 304
 305 =item 5. Assign the bug to rjones @ redhat.com
 306
 307 Assign or reassign the bug to B<rjones @ redhat.com> (without the
 308 spaces).  You can also send me an email with the bug number if you
 309 want a faster response.
 310
 311 =back