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: confirmed by RWMJ
  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 an 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 a 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<oci>
 207
 208 The guest is running in an OCI container.
 209
 210 Status: contributed by Alessandro Valentini, confirmed by RWMJ
 211
 212 =item B<openvz>
 213
 214 The guest appears to be running inside an OpenVZ or Virtuozzo
 215 container.
 216
 217 Status: contributed by Evgeniy Sokolov
 218
 219 =item B<ovirt>
 220
 221 The guest is running on an oVirt node.
 222 (See also C<rhev> below).
 223
 224 Status: contributed by RWMJ, not confirmed
 225
 226 =item B<parallels>
 227
 228 The guest is running inside Parallels Virtual Platform
 229 (Parallels Desktop, Parallels Server).
 230
 231 Status: contributed by Justin Clift
 232
 233 =item B<podman>
 234
 235 This is a Podman container.  (See also C<oci> above.)
 236
 237 Status: contributed by Jordan Webb
 238
 239 =item B<powervm_lx86>
 240
 241 The guest is running inside IBM PowerVM Lx86 Linux/x86 emulator.
 242
 243 Status: data originally supplied by Jeffrey Scheel, confirmed by
 244 Yufang Zhang and RWMJ
 245
 246 =item B<qemu>
 247
 248 This is QEMU hypervisor using software emulation.
 249
 250 Note that for KVM (hardware accelerated) guests you should I<not> see
 251 this.
 252
 253 Status: confirmed by RWMJ.
 254
 255 =item B<rhev>
 256
 257 The guest is running on a Red Hat Enterprise Virtualization (RHEV) node.
 258
 259 Status: confirmed by RWMJ
 260
 261 =item B<redhat>
 262
 263 The guest is running on the Red Hat hypervisor.
 264
 265 Status: confirmed by RWMJ
 266
 267 =item B<uml>
 268
 269 This is a User-Mode Linux (UML) guest.
 270
 271 Status: contributed by Laurent Léonard
 272
 273 =item B<upcloud>
 274
 275 This is running on UpCloud.
 276
 277 Status: contributed by Ville Skyttä
 278
 279 =item B<virt>
 280
 281 Some sort of virtualization appears to be present, but we are not sure
 282 what it is.  In some very rare corner cases where we know that
 283 virtualization is hard to detect, we will try a timing attack to see
 284 if certain machine instructions are running much more slowly than they
 285 should be, which would indicate virtualization.  In this case, the
 286 generic fact C<virt> is printed.
 287
 288 =item B<virtage>
 289
 290 This is Hitachi Virtualization Manager (HVM) Virtage
 291 hardware partitioning system.
 292
 293 Status: data supplied by Bhavna Sarathy, not confirmed
 294
 295 =item B<virtualbox>
 296
 297 This is a VirtualBox guest.
 298
 299 Status: contributed by Laurent Léonard
 300
 301 =item B<virtualpc>
 302
 303 The guest appears to be running on Microsoft VirtualPC.
 304
 305 Status: not confirmed
 306
 307 =item B<vmm>
 308
 309 This is a vmm (OpenBSD hypervisor) guest.
 310
 311 Status: contributed by Jasper Lievisse Adriaanse.
 312
 313 =item B<vmware>
 314
 315 The guest appears to be running on VMware hypervisor.
 316
 317 Status: confirmed by RWMJ
 318
 319 =item B<xen>
 320
 321 The guest appears to be running on Xen hypervisor.
 322
 323 Status: confirmed by RWMJ
 324
 325 =item B<xen-dom0>
 326
 327 This is the Xen dom0 (privileged domain).
 328
 329 Status: confirmed by RWMJ
 330
 331 =item B<xen-domU>
 332
 333 This is a Xen domU (paravirtualized guest domain).
 334
 335 Status: confirmed by RWMJ
 336
 337 =item B<xen-hvm>
 338
 339 This is a Xen guest fully virtualized (HVM).
 340
 341 Status: confirmed by RWMJ
 342
 343 =back
 344
 345 =head1 EXIT STATUS
 346
 347 Programs that use or wrap C<virt-what> should check that the exit
 348 status is 0 before they attempt to parse the output of the command.
 349
 350 A non-zero exit status indicates some error, for example, an
 351 unrecognized command line argument.  If the exit status is non-zero
 352 then the output "facts" (if any were printed) cannot be guaranteed and
 353 should be ignored.
 354
 355 The exit status does I<not> have anything to do with whether the
 356 program is running on baremetal or under virtualization, nor with
 357 whether C<virt-what> managed detection "correctly" (which is basically
 358 unknowable given the large variety of virtualization systems out there
 359 and that some systems deliberately emulate others).
 360
 361 =head1 RUNNING VIRT-WHAT FROM OTHER PROGRAMS
 362
 363 C<virt-what> is designed so that you can easily run it from
 364 other programs or wrap it up in a library.
 365
 366 Your program should check the exit status (see the section above).
 367
 368 Some programming languages (notably Python: issue 1652) erroneously
 369 mask the C<SIGPIPE> signal and do not restore it when executing
 370 subprocesses.  C<virt-what> is a shell script and some shell commands
 371 do not work correctly when you do this.  You may see warnings from
 372 C<virt-what> similar to this:
 373
 374  echo: write error: Broken pipe
 375
 376 The solution is to set the C<SIGPIPE> signal handler back to C<SIG_DFL>
 377 before running C<virt-what>.
 378
 379 =head1 IMPORTANT NOTE
 380
 381 Most of the time, using this program is the I<wrong> thing to do.
 382 Instead you should detect the specific features you actually want to
 383 use.  (As an example, if you wanted to issue Xen hypervisor commands
 384 you would look for the C</proc/xen/privcmd> file).
 385
 386 However people keep asking for this, so we provide it.  There are a
 387 few legitimate uses:
 388
 389 =over 4
 390
 391 =item Bug reporting tool
 392
 393 If you think that virtualization could affect how your program runs,
 394 then you might use C<virt-what> to report this in a bug reporting
 395 tool.
 396
 397 =item Status display and monitoring tools
 398
 399 You might include this information in status and monitoring programs.
 400
 401 =item System tuning (sometimes)
 402
 403 You might use this program to tune an operating system so it runs
 404 better as a virtual machine of a particular hypervisor.  However if
 405 installing paravirtualized drivers, it's better to check for the
 406 specific features your drivers need (eg. for the presence of PCI devices).
 407
 408 =back
 409
 410 =head1 SEE ALSO
 411
 412 L<virt-what-cvm(1)>,
 413 L<http://people.redhat.com/~rjones/virt-what/>,
 414 L<http://www.vmware.com/>,
 415 L<http://www.microsoft.com/windows/products/winfamily/virtualpc>,
 416 L<http://xensource.com/>,
 417 L<http://bellard.org/qemu/>,
 418 L<http://kvm.qumranet.com/>,
 419 L<http://openvz.org/>
 420
 421 =head1 AUTHORS
 422
 423 Richard W.M. Jones <rjones @ redhat . com>
 424
 425 =head1 COPYRIGHT
 426
 427 (C) Copyright 2008-2022 Red Hat Inc.,
 428 L<http://people.redhat.com/~rjones/virt-what/>
 429
 430 This program is free software; you can redistribute it and/or modify
 431 it under the terms of the GNU General Public License as published by
 432 the Free Software Foundation; either version 2 of the License, or
 433 (at your option) any later version.
 434
 435 This program is distributed in the hope that it will be useful,
 436 but WITHOUT ANY WARRANTY; without even the implied warranty of
 437 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 438 GNU General Public License for more details.
 439
 440 You should have received a copy of the GNU General Public License
 441 along with this program; if not, write to the Free Software
 442 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 443
 444 =head1 REPORTING BUGS
 445
 446 Bugs can be viewed on the Red Hat Bugzilla page:
 447 L<https://bugzilla.redhat.com/>.
 448
 449 If you find a bug in virt-what, please follow these steps to report it:
 450
 451 =over 4
 452
 453 =item 1. Check for existing bug reports
 454
 455 Go to L<https://bugzilla.redhat.com/> and search for similar bugs.
 456 Someone may already have reported the same bug, and they may even
 457 have fixed it.
 458
 459 =item 2. Capture debug and error messages
 460
 461 Run
 462
 463  virt-what > virt-what.log 2>&1
 464
 465 and keep I<virt-what.log>.  It may contain error messages which you
 466 should submit with your bug report.
 467
 468 =item 3. Get version of virt-what.
 469
 470 Run
 471
 472  virt-what --version
 473
 474 =item 4. Submit a bug report.
 475
 476 Go to L<https://bugzilla.redhat.com/> and enter a new bug.
 477 Please describe the problem in as much detail as possible.
 478
 479 Remember to include the version numbers (step 3) and the debug
 480 messages file (step 2) and as much other detail as possible.
 481
 482 =item 5. Assign the bug to rjones @ redhat.com
 483
 484 Assign or reassign the bug to B<rjones @ redhat.com> (without the
 485 spaces).  You can also send me an email with the bug number if you
 486 want a faster response.
 487
 488 =back