1 <?xml version='
1.0'
?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
6 <refentry id=
"systemd-detect-virt"
7 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
10 <title>systemd-detect-virt
</title>
11 <productname>systemd
</productname>
15 <refentrytitle>systemd-detect-virt
</refentrytitle>
16 <manvolnum>1</manvolnum>
20 <refname>systemd-detect-virt
</refname>
21 <refpurpose>Detect execution in a virtualized environment
</refpurpose>
26 <command>systemd-detect-virt
</command>
27 <arg choice=
"opt" rep=
"repeat">OPTIONS
</arg>
32 <title>Description
</title>
34 <para><command>systemd-detect-virt
</command> detects execution in
35 a virtualized environment. It identifies the virtualization
36 technology and can distinguish full machine virtualization from
37 container virtualization.
<filename>systemd-detect-virt
</filename>
38 exits with a return value of
0 (success) if a virtualization
39 technology is detected, and non-zero (error) otherwise. By default,
40 any type of virtualization is detected, and the options
41 <option>--container
</option> and
<option>--vm
</option> can be used
42 to limit what types of virtualization are detected.
</para>
44 <para>When executed without
<option>--quiet
</option> will print a
45 short identifier for the detected virtualization technology. The
46 following technologies are currently identified:
</para>
49 <title>Known virtualization technologies (both
50 VM, i.e. full hardware virtualization,
51 and container, i.e. shared kernel virtualization)
</title>
52 <tgroup cols='
3' align='left' colsep='
1' rowsep='
1'
>
53 <colspec colname=
"type" />
54 <colspec colname=
"id" />
55 <colspec colname=
"product" />
60 <entry>Product
</entry>
65 <entry valign=
"top" morerows=
"12">VM
</entry>
66 <entry><varname>qemu
</varname></entry>
67 <entry>QEMU software virtualization, without KVM
</entry>
71 <entry><varname>kvm
</varname></entry>
72 <entry>Linux KVM kernel virtual machine, with whatever software, except Oracle Virtualbox
</entry>
76 <entry><varname>zvm
</varname></entry>
77 <entry>s390 z/VM
</entry>
81 <entry><varname>vmware
</varname></entry>
82 <entry>VMware Workstation or Server, and related products
</entry>
86 <entry><varname>microsoft
</varname></entry>
87 <entry>Hyper-V, also known as Viridian or Windows Server Virtualization
</entry>
91 <entry><varname>oracle
</varname></entry>
92 <entry>Oracle VM VirtualBox (historically marketed by innotek and Sun Microsystems), for legacy and KVM hypervisor
</entry>
96 <entry><varname>xen
</varname></entry>
97 <entry>Xen hypervisor (only domU, not dom0)
</entry>
101 <entry><varname>bochs
</varname></entry>
102 <entry>Bochs Emulator
</entry>
106 <entry><varname>uml
</varname></entry>
107 <entry>User-mode Linux
</entry>
111 <entry><varname>parallels
</varname></entry>
112 <entry>Parallels Desktop, Parallels Server
</entry>
116 <entry><varname>bhyve
</varname></entry>
117 <entry>bhyve, FreeBSD hypervisor
</entry>
121 <entry><varname>qnx
</varname></entry>
122 <entry>QNX hypervisor
</entry>
126 <entry><varname>acrn
</varname></entry>
127 <entry><ulink url=
"https://projectacrn.org">ACRN hypervisor
</ulink></entry>
131 <entry valign=
"top" morerows=
"7">Container
</entry>
132 <entry><varname>openvz
</varname></entry>
133 <entry>OpenVZ/Virtuozzo
</entry>
137 <entry><varname>lxc
</varname></entry>
138 <entry>Linux container implementation by LXC
</entry>
142 <entry><varname>lxc-libvirt
</varname></entry>
143 <entry>Linux container implementation by libvirt
</entry>
147 <entry><varname>systemd-nspawn
</varname></entry>
148 <entry>systemd's minimal container implementation, see
<citerefentry><refentrytitle>systemd-nspawn
</refentrytitle><manvolnum>1</manvolnum></citerefentry></entry>
152 <entry><varname>docker
</varname></entry>
153 <entry>Docker container manager
</entry>
157 <entry><varname>podman
</varname></entry>
158 <entry><ulink url=
"https://podman.io">Podman
</ulink> container manager
</entry>
162 <entry><varname>rkt
</varname></entry>
163 <entry>rkt app container runtime
</entry>
167 <entry><varname>wsl
</varname></entry>
168 <entry><ulink url=
"https://docs.microsoft.com/en-us/windows/wsl/about">Windows Subsystem for Linux
</ulink></entry>
174 <para>If multiple virtualization solutions are used, only the
175 "innermost" is detected and identified. That means if both
176 machine and container virtualization are used in
177 conjunction, only the latter will be identified (unless
178 <option>--vm
</option> is passed).
</para>
179 <para> Windows Subsystem for Linux is not a Linux container,
180 but an environment for running Linux userspace applications on
181 top of the Windows kernel using a Linux-compatible interface.
182 WSL is categorized as a container for practical purposes.
183 Multiple WSL environments share the same kernel and services
184 should generally behave like when being run in a container.
</para>
188 <title>Options
</title>
190 <para>The following options are understood:
</para>
194 <term><option>-c
</option></term>
195 <term><option>--container
</option></term>
197 <listitem><para>Only detects container virtualization (i.e.
198 shared kernel virtualization).
</para></listitem>
202 <term><option>-v
</option></term>
203 <term><option>--vm
</option></term>
205 <listitem><para>Only detects hardware virtualization.
</para></listitem>
209 <term><option>-r
</option></term>
210 <term><option>--chroot
</option></term>
212 <listitem><para>Detect whether invoked in a
213 <citerefentry><refentrytitle>chroot
</refentrytitle><manvolnum>2</manvolnum></citerefentry>
214 environment. In this mode, no output is written, but the return
215 value indicates whether the process was invoked in a
216 <function>chroot()
</function>
217 environment or not.
</para></listitem>
221 <term><option>--private-users
</option></term>
223 <listitem><para>Detect whether invoked in a user namespace. In this mode, no
224 output is written, but the return value indicates whether the process was invoked
225 inside of a user namespace or not. See
226 <citerefentry project='man-pages'
><refentrytitle>user_namespaces
</refentrytitle><manvolnum>7</manvolnum></citerefentry>
227 for more information.
</para></listitem>
231 <term><option>-q
</option></term>
232 <term><option>--quiet
</option></term>
234 <listitem><para>Suppress output of the virtualization
235 technology identifier.
</para></listitem>
239 <term><option>--list
</option></term>
241 <listitem><para>Output all currently known and detectable container and VM environments.
</para></listitem>
244 <xi:include href=
"standard-options.xml" xpointer=
"help" />
245 <xi:include href=
"standard-options.xml" xpointer=
"version" />
251 <title>Exit status
</title>
253 <para>If a virtualization technology is detected,
0 is returned, a
254 non-zero code otherwise.
</para>
258 <title>See Also
</title>
260 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
261 <citerefentry><refentrytitle>systemd-nspawn
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
262 <citerefentry><refentrytitle>chroot
</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
263 <citerefentry project='man-pages'
><refentrytitle>namespaces
</refentrytitle><manvolnum>7</manvolnum></citerefentry>