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