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