man/systemd-detect-virt.1

   1 '\" t
   2 .TH "SYSTEMD\-DETECT\-VIRT" "1" "" "systemd 217" "systemd-detect-virt"
   3 .\" -----------------------------------------------------------------
   4 .\" * Define some portability stuff
   5 .\" -----------------------------------------------------------------
   6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   7 .\" http://bugs.debian.org/507673
   8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
   9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  10 .ie \n(.g .ds Aq \(aq
  11 .el       .ds Aq '
  12 .\" -----------------------------------------------------------------
  13 .\" * set default formatting
  14 .\" -----------------------------------------------------------------
  15 .\" disable hyphenation
  16 .nh
  17 .\" disable justification (adjust text to left margin only)
  18 .ad l
  19 .\" -----------------------------------------------------------------
  20 .\" * MAIN CONTENT STARTS HERE *
  21 .\" -----------------------------------------------------------------
  22 .SH "NAME"
  23 systemd-detect-virt \- Detect execution in a virtualized environment
  24 .SH "SYNOPSIS"
  25 .HP \w'\fBsystemd\-detect\-virt\ \fR\fB[OPTIONS...]\fR\ 'u
  26 \fBsystemd\-detect\-virt \fR\fB[OPTIONS...]\fR
  27 .SH "DESCRIPTION"
  28 .PP
  29 \fBsystemd\-detect\-virt\fR
  30 detects execution in a virtualized environment\&. It identifies the virtualization technology and can distinguish full VM virtualization from container virtualization\&.
  31 systemd\-detect\-virt
  32 exits with a return value of 0 (success) if a virtualization technology is detected, and non\-zero (error) otherwise\&. By default any type of virtualization is detected, and the options
  33 \fB\-\-container\fR
  34 and
  35 \fB\-\-vm\fR
  36 can be used to limit what types of virtualization are detected\&.
  37 .PP
  38 When executed without
  39 \fB\-\-quiet\fR
  40 will print a short identifier for the detected virtualization technology\&. The following technologies are currently identified:
  41 .sp
  42 .it 1 an-trap
  43 .nr an-no-space-flag 1
  44 .nr an-break-flag 1
  45 .br
  46 .B Table\ \&1.\ \&Known virtualization technologies (both VM, i.e. full hardware virtualization, and container, i.e. shared kernel virtualization)
  47 .TS
  48 allbox tab(:);
  49 lB lB lB.
  50 T{
  51 Type
  52 T}:T{
  53 ID
  54 T}:T{
  55 Product
  56 T}
  57 .T&
  58 l l l
  59 ^ l l
  60 ^ l l
  61 ^ l l
  62 ^ l l
  63 ^ l l
  64 ^ l l
  65 ^ l l
  66 ^ l l
  67 l l l
  68 ^ l l
  69 ^ l l
  70 ^ l l
  71 ^ l l
  72 ^.
  73 T{
  74 VM
  75 T}:T{
  76 \fIqemu\fR
  77 T}:T{
  78 QEMU software virtualization
  79 T}
  80 :T{
  81 \fIkvm\fR
  82 T}:T{
  83 Linux KVM kernel virtual machine
  84 T}
  85 :T{
  86 \fIzvm\fR
  87 T}:T{
  88 s390 z/VM
  89 T}
  90 :T{
  91 \fIvmware\fR
  92 T}:T{
  93 VMware Workstation or Server, and related products
  94 T}
  95 :T{
  96 \fImicrosoft\fR
  97 T}:T{
  98 Hyper\-V, also known as Viridian or Windows Server Virtualization
  99 T}
 100 :T{
 101 \fIoracle\fR
 102 T}:T{
 103 Oracle VM VirtualBox (historically marketed by innotek and Sun Microsystems)
 104 T}
 105 :T{
 106 \fIxen\fR
 107 T}:T{
 108 Xen hypervisor (only domU, not dom0)
 109 T}
 110 :T{
 111 \fIbochs\fR
 112 T}:T{
 113 Bochs Emulator
 114 T}
 115 :T{
 116 \fIuml\fR
 117 T}:T{
 118 User\-mode Linux
 119 T}
 120 T{
 121 container
 122 T}:T{
 123 \fIopenvz\fR
 124 T}:T{
 125 OpenVZ/Virtuozzo
 126 T}
 127 :T{
 128 \fIlxc\fR
 129 T}:T{
 130 Linux container implementation by LXC
 131 T}
 132 :T{
 133 \fIlxc\-libvirt\fR
 134 T}:T{
 135 Linux container implementation by libvirt
 136 T}
 137 :T{
 138 \fIsystemd\-nspawn\fR
 139 T}:T{
 140 systemd\*(Aqs minimal container implementation, see \fBsystemd-nspawn\fR(1)
 141 T}
 142 :T{
 143 \fIdocker\fR
 144 T}:T{
 145 Docker container manager
 146 T}
 147 .TE
 148 .sp 1
 149 .PP
 150 If multiple virtualization solutions are used, only the "innermost" is detected and identified\&. That means if both VM virtualization and container virtualization are used in conjunction, only the latter will be identified (unless
 151 \fB\-\-vm\fR
 152 is passed)\&.
 153 .SH "OPTIONS"
 154 .PP
 155 The following options are understood:
 156 .PP
 157 \fB\-c\fR, \fB\-\-container\fR
 158 .RS 4
 159 Only detects container virtualization (i\&.e\&. shared kernel virtualization)\&.
 160 .RE
 161 .PP
 162 \fB\-v\fR, \fB\-\-vm\fR
 163 .RS 4
 164 Only detects VM virtualization (i\&.e\&. full hardware virtualization)\&.
 165 .RE
 166 .PP
 167 \fB\-q\fR, \fB\-\-quiet\fR
 168 .RS 4
 169 Suppress output of the virtualization technology identifier\&.
 170 .RE
 171 .PP
 172 \fB\-h\fR, \fB\-\-help\fR
 173 .RS 4
 174 Print a short help text and exit\&.
 175 .RE
 176 .PP
 177 \fB\-\-version\fR
 178 .RS 4
 179 Print a short version string and exit\&.
 180 .RE
 181 .SH "EXIT STATUS"
 182 .PP
 183 If a virtualization technology is detected, 0 is returned, a non\-zero code otherwise\&.
 184 .SH "SEE ALSO"
 185 .PP
 186 \fBsystemd\fR(1),
 187 \fBsystemd-nspawn\fR(1)