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