2012-04-12 16:58:52 +04:00
<?xml version='1.0'?> <!-- * - nxml - * -->
2019-03-14 16:40:58 +03:00
< !DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
2015-06-18 20:47:44 +03:00
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
2020-11-09 07:23:58 +03:00
<!-- SPDX - License - Identifier: LGPL - 2.1 - or - later -->
2012-04-12 16:58:52 +04:00
2014-02-13 23:33:51 +04:00
<refentry id= "systemd-detect-virt"
2015-11-11 02:48:59 +03:00
xmlns:xi="http://www.w3.org/2001/XInclude">
2015-02-04 05:14:13 +03:00
<refentryinfo >
<title > systemd-detect-virt</title>
<productname > systemd</productname>
</refentryinfo>
<refmeta >
<refentrytitle > systemd-detect-virt</refentrytitle>
<manvolnum > 1</manvolnum>
</refmeta>
<refnamediv >
<refname > systemd-detect-virt</refname>
<refpurpose > Detect execution in a virtualized environment</refpurpose>
</refnamediv>
<refsynopsisdiv >
<cmdsynopsis >
2016-10-21 06:41:21 +03:00
<command > systemd-detect-virt</command>
<arg choice= "opt" rep= "repeat" > OPTIONS</arg>
2015-02-04 05:14:13 +03:00
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 >
<title > Description</title>
<para > <command > systemd-detect-virt</command> detects execution in
a virtualized environment. It identifies the virtualization
2015-11-02 12:36:56 +03:00
technology and can distinguish full machine virtualization from
2015-02-04 05:14:13 +03:00
container virtualization. <filename > systemd-detect-virt</filename>
exits with a return value of 0 (success) if a virtualization
2014-08-03 09:11:12 +04:00
technology is detected, and non-zero (error) otherwise. By default,
2015-02-04 05:14:13 +03:00
any type of virtualization is detected, and the options
<option > --container</option> and <option > --vm</option> can be used
to limit what types of virtualization are detected.</para>
<para > When executed without <option > --quiet</option> will print a
short identifier for the detected virtualization technology. The
following technologies are currently identified:</para>
<table >
<title > Known virtualization technologies (both
VM, i.e. full hardware virtualization,
and container, i.e. shared kernel virtualization)</title>
<tgroup cols= '3' align= 'left' colsep= '1' rowsep= '1' >
<colspec colname= "type" />
<colspec colname= "id" />
<colspec colname= "product" />
<thead >
<row >
2015-11-11 02:48:59 +03:00
<entry > Type</entry>
<entry > ID</entry>
<entry > Product</entry>
2015-02-04 05:14:13 +03:00
</row>
</thead>
<tbody >
<row >
2022-08-22 19:35:21 +03:00
<entry valign= "top" morerows= "15" > VM</entry>
2015-11-11 02:48:59 +03:00
<entry > <varname > qemu</varname> </entry>
2017-02-14 16:51:12 +03:00
<entry > QEMU software virtualization, without KVM</entry>
2015-02-04 05:14:13 +03:00
</row>
<row >
2015-11-11 02:48:59 +03:00
<entry > <varname > kvm</varname> </entry>
2020-10-11 23:25:00 +03:00
<entry > Linux KVM kernel virtual machine, in combination with QEMU. Not used for other virtualizers using the KVM interfaces, such as Oracle VirtualBox or Amazon EC2 Nitro, see below.</entry>
</row>
<row >
<entry > <varname > amazon</varname> </entry>
<entry > Amazon EC2 Nitro using Linux KVM</entry>
2015-02-04 05:14:13 +03:00
</row>
<row >
2015-11-11 02:48:59 +03:00
<entry > <varname > zvm</varname> </entry>
<entry > s390 z/VM</entry>
2015-02-04 05:14:13 +03:00
</row>
<row >
2015-11-11 02:48:59 +03:00
<entry > <varname > vmware</varname> </entry>
<entry > VMware Workstation or Server, and related products</entry>
2015-02-04 05:14:13 +03:00
</row>
<row >
2015-11-11 02:48:59 +03:00
<entry > <varname > microsoft</varname> </entry>
<entry > Hyper-V, also known as Viridian or Windows Server Virtualization</entry>
2015-02-04 05:14:13 +03:00
</row>
<row >
2015-11-11 02:48:59 +03:00
<entry > <varname > oracle</varname> </entry>
2018-05-03 17:02:43 +03:00
<entry > Oracle VM VirtualBox (historically marketed by innotek and Sun Microsystems), for legacy and KVM hypervisor</entry>
2015-02-04 05:14:13 +03:00
</row>
2020-10-02 12:05:23 +03:00
<row >
<entry > <varname > powervm</varname> </entry>
2020-12-10 19:05:42 +03:00
<entry > IBM PowerVM hypervisor — comes as firmware with some IBM POWER servers</entry>
2020-10-02 12:05:23 +03:00
</row>
2015-02-04 05:14:13 +03:00
<row >
2015-11-11 02:48:59 +03:00
<entry > <varname > xen</varname> </entry>
<entry > Xen hypervisor (only domU, not dom0)</entry>
2015-02-04 05:14:13 +03:00
</row>
<row >
2015-11-11 02:48:59 +03:00
<entry > <varname > bochs</varname> </entry>
<entry > Bochs Emulator</entry>
2015-02-04 05:14:13 +03:00
</row>
<row >
2015-11-11 02:48:59 +03:00
<entry > <varname > uml</varname> </entry>
<entry > User-mode Linux</entry>
2015-02-04 05:14:13 +03:00
</row>
2015-09-02 04:43:32 +03:00
<row >
2015-11-11 02:48:59 +03:00
<entry > <varname > parallels</varname> </entry>
<entry > Parallels Desktop, Parallels Server</entry>
2015-09-02 04:43:32 +03:00
</row>
2018-02-22 16:35:47 +03:00
<row >
2016-08-01 16:04:49 +03:00
<entry > <varname > bhyve</varname> </entry>
<entry > bhyve, FreeBSD hypervisor</entry>
2018-02-22 16:35:47 +03:00
</row>
<row >
<entry > <varname > qnx</varname> </entry>
<entry > QNX hypervisor</entry>
2016-08-01 16:04:49 +03:00
</row>
2019-02-28 18:36:50 +03:00
<row >
<entry > <varname > acrn</varname> </entry>
<entry > <ulink url= "https://projectacrn.org" > ACRN hypervisor</ulink> </entry>
</row>
2022-08-22 19:35:21 +03:00
<row >
<entry > <varname > apple</varname> </entry>
<entry > <ulink url= "https://developer.apple.com/documentation/virtualization" > Apple Virtualization.framework</ulink> </entry>
</row>
2015-02-04 05:14:13 +03:00
<row >
2020-10-05 18:45:58 +03:00
<entry valign= "top" morerows= "9" > Container</entry>
2015-11-11 02:48:59 +03:00
<entry > <varname > openvz</varname> </entry>
<entry > OpenVZ/Virtuozzo</entry>
2015-02-04 05:14:13 +03:00
</row>
<row >
2015-11-11 02:48:59 +03:00
<entry > <varname > lxc</varname> </entry>
<entry > Linux container implementation by LXC</entry>
2015-02-04 05:14:13 +03:00
</row>
<row >
2015-11-11 02:48:59 +03:00
<entry > <varname > lxc-libvirt</varname> </entry>
<entry > Linux container implementation by libvirt</entry>
2015-02-04 05:14:13 +03:00
</row>
<row >
2015-11-11 02:48:59 +03:00
<entry > <varname > systemd-nspawn</varname> </entry>
<entry > systemd's minimal container implementation, see <citerefentry > <refentrytitle > systemd-nspawn</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </entry>
2015-02-04 05:14:13 +03:00
</row>
<row >
2015-11-11 02:48:59 +03:00
<entry > <varname > docker</varname> </entry>
<entry > Docker container manager</entry>
2015-02-04 05:14:13 +03:00
</row>
2015-11-09 16:37:43 +03:00
2019-04-26 15:13:53 +03:00
<row >
<entry > <varname > podman</varname> </entry>
<entry > <ulink url= "https://podman.io" > Podman</ulink> container manager</entry>
</row>
2015-11-09 16:37:43 +03:00
<row >
2015-11-11 02:48:59 +03:00
<entry > <varname > rkt</varname> </entry>
<entry > rkt app container runtime</entry>
2015-11-09 16:37:43 +03:00
</row>
2019-03-06 20:46:04 +03:00
<row >
<entry > <varname > wsl</varname> </entry>
<entry > <ulink url= "https://docs.microsoft.com/en-us/windows/wsl/about" > Windows Subsystem for Linux</ulink> </entry>
</row>
2020-04-14 20:15:04 +03:00
<row >
<entry > <varname > proot</varname> </entry>
<entry > <ulink url= "https://proot-me.github.io/" > proot</ulink> userspace chroot/bind mount emulation</entry>
</row>
2020-08-19 14:47:03 +03:00
<row >
<entry > <varname > pouch</varname> </entry>
<entry > <ulink url= "https://github.com/alibaba/pouch" > Pouch</ulink> Container Engine</entry>
</row>
2015-02-04 05:14:13 +03:00
</tbody>
</tgroup>
</table>
<para > If multiple virtualization solutions are used, only the
2015-11-02 12:36:56 +03:00
"innermost" is detected and identified. That means if both
machine and container virtualization are used in
2015-02-04 05:14:13 +03:00
conjunction, only the latter will be identified (unless
<option > --vm</option> is passed).</para>
2019-03-06 20:46:04 +03:00
<para > Windows Subsystem for Linux is not a Linux container,
but an environment for running Linux userspace applications on
top of the Windows kernel using a Linux-compatible interface.
WSL is categorized as a container for practical purposes.
Multiple WSL environments share the same kernel and services
should generally behave like when being run in a container.</para>
2015-02-04 05:14:13 +03:00
</refsect1>
<refsect1 >
<title > Options</title>
<para > The following options are understood:</para>
<variablelist >
<varlistentry >
<term > <option > -c</option> </term>
<term > <option > --container</option> </term>
<listitem > <para > Only detects container virtualization (i.e.
shared kernel virtualization).</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > -v</option> </term>
<term > <option > --vm</option> </term>
2019-02-19 08:35:10 +03:00
<listitem > <para > Only detects hardware virtualization.</para> </listitem>
2015-02-04 05:14:13 +03:00
</varlistentry>
2015-10-27 02:07:54 +03:00
<varlistentry >
<term > <option > -r</option> </term>
<term > <option > --chroot</option> </term>
<listitem > <para > Detect whether invoked in a
<citerefentry > <refentrytitle > chroot</refentrytitle> <manvolnum > 2</manvolnum> </citerefentry>
2014-08-03 09:11:12 +04:00
environment. In this mode, no output is written, but the return
2015-10-27 02:07:54 +03:00
value indicates whether the process was invoked in a
<function > chroot()</function>
environment or not.</para> </listitem>
</varlistentry>
2016-10-21 06:41:21 +03:00
<varlistentry >
<term > <option > --private-users</option> </term>
<listitem > <para > Detect whether invoked in a user namespace. In this mode, no
output is written, but the return value indicates whether the process was invoked
inside of a user namespace or not. See
<citerefentry project= 'man-pages' > <refentrytitle > user_namespaces</refentrytitle> <manvolnum > 7</manvolnum> </citerefentry>
for more information.</para> </listitem>
</varlistentry>
2015-02-04 05:14:13 +03:00
<varlistentry >
<term > <option > -q</option> </term>
<term > <option > --quiet</option> </term>
<listitem > <para > Suppress output of the virtualization
technology identifier.</para> </listitem>
</varlistentry>
2018-05-22 13:12:44 +03:00
<varlistentry >
<term > <option > --list</option> </term>
<listitem > <para > Output all currently known and detectable container and VM environments.</para> </listitem>
</varlistentry>
2015-02-04 05:14:13 +03:00
<xi:include href= "standard-options.xml" xpointer= "help" />
<xi:include href= "standard-options.xml" xpointer= "version" />
</variablelist>
</refsect1>
<refsect1 >
<title > Exit status</title>
<para > If a virtualization technology is detected, 0 is returned, a
non-zero code otherwise.</para>
</refsect1>
<refsect1 >
<title > See Also</title>
<para >
<citerefentry > <refentrytitle > systemd</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> ,
2015-10-27 02:07:54 +03:00
<citerefentry > <refentrytitle > systemd-nspawn</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> ,
2016-10-21 06:41:21 +03:00
<citerefentry > <refentrytitle > chroot</refentrytitle> <manvolnum > 2</manvolnum> </citerefentry> ,
<citerefentry project= 'man-pages' > <refentrytitle > namespaces</refentrytitle> <manvolnum > 7</manvolnum> </citerefentry>
2015-02-04 05:14:13 +03:00
</para>
</refsect1>
2012-04-12 16:58:52 +04:00
</refentry>