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 or RHEV node.
 137
 138 Status: contributed by RWMJ, not confirmed
 139
 140 =item B<parallels>
 141
 142 The guest is running inside Parallels Virtual Platform
 143 (Parallels Desktop, Parallels Server).
 144
 145 Status: contributed by Justin Clift
 146
 147 =item B<powervm_lx86>
 148
 149 The guest is running inside IBM PowerVM Lx86 Linux/x86 emulator.
 150
 151 Status: data originally supplied by Jeffrey Scheel, confirmed by
 152 Yufang Zhang and RWMJ
 153
 154 =item B<qemu>
 155
 156 This is QEMU hypervisor using software emulation.
 157
 158 Note that for KVM (hardware accelerated) guests you should I<not> see
 159 this.
 160
 161 Status: confirmed by RWMJ.
 162
 163 =item B<uml>
 164
 165 This is a User-Mode Linux (UML) guest.
 166
 167 Status: contributed by Laurent Léonard
 168
 169 =item B<virt>
 170
 171 Some sort of virtualization appears to be present, but we are not sure
 172 what it is.  In some very rare corner cases where we know that
 173 virtualization is hard to detect, we will try a timing attack to see
 174 if certain machine instructions are running much more slowly than they
 175 should be, which would indicate virtualization.  In this case, the
 176 generic fact C<virt> is printed.
 177
 178 =item B<virtage>
 179
 180 This is Hitachi Virtualization Manager (HVM) Virtage
 181 hardware partitioning system.
 182
 183 Status: data supplied by Bhavna Sarathy, not confirmed
 184
 185 =item B<virtualbox>
 186
 187 This is a VirtualBox guest.
 188
 189 Status: contributed by Laurent Léonard
 190
 191 =item B<virtualpc>
 192
 193 The guest appears to be running on Microsoft VirtualPC.
 194
 195 Status: not confirmed
 196
 197 =item B<vmware>
 198
 199 The guest appears to be running on VMware hypervisor.
 200
 201 Status: confirmed by RWMJ
 202
 203 =item B<xen>
 204
 205 The guest appears to be running on Xen hypervisor.
 206
 207 Status: confirmed by RWMJ
 208
 209 =item B<xen-dom0>
 210
 211 This is the Xen dom0 (privileged domain).
 212
 213 Status: confirmed by RWMJ
 214
 215 =item B<xen-domU>
 216
 217 This is a Xen domU (paravirtualized guest domain).
 218
 219 Status: confirmed by RWMJ
 220
 221 =item B<xen-hvm>
 222
 223 This is a Xen guest fully virtualized (HVM).
 224
 225 Status: confirmed by RWMJ
 226
 227 =back
 228
 229 =head1 EXIT STATUS
 230
 231 Programs that use or wrap C<virt-what> should check that the exit
 232 status is 0 before they attempt to parse the output of the command.
 233
 234 A non-zero exit status indicates some error, for example, an
 235 unrecognized command line argument.  If the exit status is non-zero
 236 then the output "facts" (if any were printed) cannot be guaranteed and
 237 should be ignored.
 238
 239 The exit status does I<not> have anything to do with whether the
 240 program is running on baremetal or under virtualization, nor with
 241 whether C<virt-what> managed detection "correctly" (which is basically
 242 unknowable given the large variety of virtualization systems out there
 243 and that some systems deliberately emulate others).
 244
 245 =head1 RUNNING VIRT-WHAT FROM OTHER PROGRAMS
 246
 247 C<virt-what> is designed so that you can easily run it from
 248 other programs or wrap it up in a library.
 249
 250 Your program should check the exit status (see the section above).
 251
 252 Some programming languages (notably Python: issue 1652) erroneously
 253 mask the C<SIGPIPE> signal and do not restore it when executing
 254 subprocesses.  C<virt-what> is a shell script and some shell commands
 255 do not work correctly when you do this.  You may see warnings from
 256 C<virt-what> similar to this:
 257
 258  echo: write error: Broken pipe
 259
 260 The solution is to set the C<SIGPIPE> signal handler back to C<SIG_DFL>
 261 before running C<virt-what>.
 262
 263 =head1 IMPORTANT NOTE
 264
 265 Most of the time, using this program is the I<wrong> thing to do.
 266 Instead you should detect the specific features you actually want to
 267 use.  (As an example, if you wanted to issue Xen hypervisor commands
 268 you would look for the C</proc/xen/privcmd> file).
 269
 270 However people keep asking for this, so we provide it.  There are a
 271 few legitimate uses:
 272
 273 =over 4
 274
 275 =item Bug reporting tool
 276
 277 If you think that virtualization could affect how your program runs,
 278 then you might use C<virt-what> to report this in a bug reporting
 279 tool.
 280
 281 =item Status display and monitoring tools
 282
 283 You might include this information in status and monitoring programs.
 284
 285 =item System tuning (sometimes)
 286
 287 You might use this program to tune an operating system so it runs
 288 better as a virtual machine of a particular hypervisor.  However if
 289 installing paravirtualized drivers, it's better to check for the
 290 specific features your drivers need (eg. for the presence of PCI devices).
 291
 292 =back
 293
 294 =head1 SEE ALSO
 295
 296 L<http://people.redhat.com/~rjones/virt-what/>,
 297 L<http://www.vmware.com/>,
 298 L<http://www.microsoft.com/windows/products/winfamily/virtualpc>,
 299 L<http://xensource.com/>,
 300 L<http://bellard.org/qemu/>,
 301 L<http://kvm.qumranet.com/>,
 302 L<http://openvz.org/>
 303
 304 =head1 AUTHORS
 305
 306 Richard W.M. Jones <rjones @ redhat . com>
 307
 308 =head1 COPYRIGHT
 309
 310 (C) Copyright 2008-2015 Red Hat Inc.,
 311 L<http://people.redhat.com/~rjones/virt-what/>
 312
 313 This program is free software; you can redistribute it and/or modify
 314 it under the terms of the GNU General Public License as published by
 315 the Free Software Foundation; either version 2 of the License, or
 316 (at your option) any later version.
 317
 318 This program is distributed in the hope that it will be useful,
 319 but WITHOUT ANY WARRANTY; without even the implied warranty of
 320 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 321 GNU General Public License for more details.
 322
 323 You should have received a copy of the GNU General Public License
 324 along with this program; if not, write to the Free Software
 325 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 326
 327 =head1 REPORTING BUGS
 328
 329 Bugs can be viewed on the Red Hat Bugzilla page:
 330 L<https://bugzilla.redhat.com/>.
 331
 332 If you find a bug in virt-what, please follow these steps to report it:
 333
 334 =over 4
 335
 336 =item 1. Check for existing bug reports
 337
 338 Go to L<https://bugzilla.redhat.com/> and search for similar bugs.
 339 Someone may already have reported the same bug, and they may even
 340 have fixed it.
 341
 342 =item 2. Capture debug and error messages
 343
 344 Run
 345
 346  virt-what > virt-what.log 2>&1
 347
 348 and keep I<virt-what.log>.  It may contain error messages which you
 349 should submit with your bug report.
 350
 351 =item 3. Get version of virt-what.
 352
 353 Run
 354
 355  virt-what --version
 356
 357 =item 4. Submit a bug report.
 358
 359 Go to L<https://bugzilla.redhat.com/> and enter a new bug.
 360 Please describe the problem in as much detail as possible.
 361
 362 Remember to include the version numbers (step 3) and the debug
 363 messages file (step 2) and as much other detail as possible.
 364
 365 =item 5. Assign the bug to rjones @ redhat.com
 366
 367 Assign or reassign the bug to B<rjones @ redhat.com> (without the
 368 spaces).  You can also send me an email with the bug number if you
 369 want a faster response.
 370
 371 =back