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