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