man/systemd-detect-virt.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <!--
   6   This file is part of systemd.
   7
   8   Copyright 2010 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 -->
  23
  24 <refentry id="systemd-detect-virt"
  25           xmlns:xi="http://www.w3.org/2001/XInclude">
  26
  27         <refentryinfo>
  28                 <title>systemd-detect-virt</title>
  29                 <productname>systemd</productname>
  30
  31                 <authorgroup>
  32                         <author>
  33                                 <contrib>Developer</contrib>
  34                                 <firstname>Lennart</firstname>
  35                                 <surname>Poettering</surname>
  36                                 <email>lennart@poettering.net</email>
  37                         </author>
  38                 </authorgroup>
  39         </refentryinfo>
  40
  41         <refmeta>
  42                 <refentrytitle>systemd-detect-virt</refentrytitle>
  43                 <manvolnum>1</manvolnum>
  44         </refmeta>
  45
  46         <refnamediv>
  47                 <refname>systemd-detect-virt</refname>
  48                 <refpurpose>Detect execution in a virtualized environment</refpurpose>
  49         </refnamediv>
  50
  51         <refsynopsisdiv>
  52                 <cmdsynopsis>
  53                         <command>systemd-detect-virt <arg choice="opt" rep="repeat">OPTIONS</arg></command>
  54                 </cmdsynopsis>
  55         </refsynopsisdiv>
  56
  57         <refsect1>
  58                 <title>Description</title>
  59
  60                 <para><command>systemd-detect-virt</command> detects
  61                 execution in a virtualized environment. It identifies
  62                 the virtualization technology and can distinguish full
  63                 VM virtualization from container
  64                 virtualization.</para>
  65
  66                 <para>When executed without <option>--quiet</option>
  67                 will print a short identifier for the detected
  68                 virtualization technology. The following technologies
  69                 are currently identified: <varname>qemu</varname>,
  70                 <varname>kvm</varname>, <varname>vmware</varname>,
  71                 <varname>microsoft</varname> (Hyper-V, also known as
  72                 Viridian or Windows Server Virtualization),
  73                 <varname>oracle</varname> (VirtualBox),
  74                 <varname>xen</varname>, <varname>bochs</varname>,
  75                 <varname>chroot</varname>, <varname>uml</varname>,
  76                 <varname>openvz</varname>, <varname>lxc</varname>,
  77                 <varname>lxc-libvirt</varname>,
  78                 <varname>systemd-nspawn</varname>,
  79                 <varname>docker</varname>.</para>
  80
  81                 <para>If multiple virtualization solutions are used,
  82                 only the "innermost" is detected and identified. That
  83                 means if both VM virtualization and container
  84                 virtualization are used in conjunction, only the latter
  85                 will be identified (unless <option>--vm</option> is
  86                 passed).</para>
  87         </refsect1>
  88
  89         <refsect1>
  90                 <title>Options</title>
  91
  92                 <para>The following options are understood:</para>
  93
  94                 <variablelist>
  95                         <varlistentry>
  96                                 <term><option>-c</option></term>
  97                                 <term><option>--container</option></term>
  98
  99                                 <listitem><para>Only detects container
 100                                 virtualization (i.e. shared kernel
 101                                 virtualization).</para></listitem>
 102                         </varlistentry>
 103
 104                         <varlistentry>
 105                                 <term><option>-v</option></term>
 106                                 <term><option>--vm</option></term>
 107
 108                                 <listitem><para>Only detects VM
 109                                 virtualization (i.e. full hardware
 110                                 virtualization).</para></listitem>
 111                         </varlistentry>
 112
 113                         <varlistentry>
 114                                 <term><option>-q</option></term>
 115                                 <term><option>--quiet</option></term>
 116
 117                                 <listitem><para>Suppress output of the
 118                                 virtualization technology
 119                                 identifier.</para></listitem>
 120                         </varlistentry>
 121
 122                         <xi:include href="standard-options.xml" xpointer="help" />
 123                         <xi:include href="standard-options.xml" xpointer="version" />
 124                 </variablelist>
 125
 126         </refsect1>
 127
 128         <refsect1>
 129                 <title>Exit status</title>
 130
 131                 <para>If a virtualization technology is detected, 0 is
 132                 returned, a non-zero code otherwise.</para>
 133         </refsect1>
 134
 135         <refsect1>
 136                 <title>See Also</title>
 137                 <para>
 138                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 139                 </para>
 140         </refsect1>
 141
 142 </refentry>