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