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