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