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>,
  72                 <varname>oracle</varname>, <varname>xen</varname>,
  73                 <varname>bochs</varname>, <varname>chroot</varname>,
  74                 <varname>uml</varname>,
  75                 <varname>openvz</varname>, <varname>lxc</varname>,
  76                 <varname>lxc-libvirt</varname>,
  77                 <varname>systemd-nspawn</varname>,
  78                 <varname>docker</varname>.</para>
  79
  80                 <para>If multiple virtualization solutions are used,
  81                 only the "innermost" is detected and identified. That
  82                 means if both VM virtualization and container
  83                 virtualization are used in conjunction, only the latter
  84                 will be identified (unless <option>--vm</option> is
  85                 passed).</para>
  86         </refsect1>
  87
  88         <refsect1>
  89                 <title>Options</title>
  90
  91                 <para>The following options are understood:</para>
  92
  93                 <variablelist>
  94                         <varlistentry>
  95                                 <term><option>-c</option></term>
  96                                 <term><option>--container</option></term>
  97
  98                                 <listitem><para>Only detects container
  99                                 virtualization (i.e. shared kernel
 100                                 virtualization).</para></listitem>
 101                         </varlistentry>
 102
 103                         <varlistentry>
 104                                 <term><option>-v</option></term>
 105                                 <term><option>--vm</option></term>
 106
 107                                 <listitem><para>Only detects VM
 108                                 virtualization (i.e. full hardware
 109                                 virtualization).</para></listitem>
 110                         </varlistentry>
 111
 112                         <varlistentry>
 113                                 <term><option>-q</option></term>
 114                                 <term><option>--quiet</option></term>
 115
 116                                 <listitem><para>Suppress output of the
 117                                 virtualization technology
 118                                 identifier.</para></listitem>
 119                         </varlistentry>
 120
 121                         <xi:include href="standard-options.xml" xpointer="help" />
 122                         <xi:include href="standard-options.xml" xpointer="version" />
 123                 </variablelist>
 124
 125         </refsect1>
 126
 127         <refsect1>
 128                 <title>Exit status</title>
 129
 130                 <para>If a virtualization technology is detected, 0 is
 131                 returned, a non-zero code otherwise.</para>
 132         </refsect1>
 133
 134         <refsect1>
 135                 <title>See Also</title>
 136                 <para>
 137                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 138                 </para>
 139         </refsect1>
 140
 141 </refentry>