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