add documentation for display types and memory configuration
[pve-docs.git] / qm.adoc
1 [[chapter_virtual_machines]]
2 ifdef::manvolnum[]
3 qm(1)
4 =====
5 :pve-toplevel:
6
7 NAME
8 ----
9
10 qm - Qemu/KVM Virtual Machine Manager
11
12
13 SYNOPSIS
14 --------
15
16 include::qm.1-synopsis.adoc[]
17
18 DESCRIPTION
19 -----------
20 endif::manvolnum[]
21 ifndef::manvolnum[]
22 Qemu/KVM Virtual Machines
23 =========================
24 :pve-toplevel:
25 endif::manvolnum[]
26
27 // deprecates
28 // http://pve.proxmox.com/wiki/Container_and_Full_Virtualization
29 // http://pve.proxmox.com/wiki/KVM
30 // http://pve.proxmox.com/wiki/Qemu_Server
31
32 Qemu (short form for Quick Emulator) is an open source hypervisor that emulates a
33 physical computer. From the perspective of the host system where Qemu is
34 running, Qemu is a user program which has access to a number of local resources
35 like partitions, files, network cards which are then passed to an
36 emulated computer which sees them as if they were real devices.
37
38 A guest operating system running in the emulated computer accesses these
39 devices, and runs as it were running on real hardware. For instance you can pass
40 an iso image as a parameter to Qemu, and the OS running in the emulated computer
41 will see a real CDROM inserted in a CD drive.
42
43 Qemu can emulate a great variety of hardware from ARM to Sparc, but {pve} is
44 only concerned with 32 and 64 bits PC clone emulation, since it represents the
45 overwhelming majority of server hardware. The emulation of PC clones is also one
46 of the fastest due to the availability of processor extensions which greatly
47 speed up Qemu when the emulated architecture is the same as the host
48 architecture.
49
50 NOTE: You may sometimes encounter the term _KVM_ (Kernel-based Virtual Machine).
51 It means that Qemu is running with the support of the virtualization processor
52 extensions, via the Linux kvm module. In the context of {pve} _Qemu_ and
53 _KVM_ can be used interchangeably as Qemu in {pve} will always try to load the kvm
54 module.
55
56 Qemu inside {pve} runs as a root process, since this is required to access block
57 and PCI devices.
58
59
60 Emulated devices and paravirtualized devices
61 --------------------------------------------
62
63 The PC hardware emulated by Qemu includes a mainboard, network controllers,
64 scsi, ide and sata controllers, serial ports (the complete list can be seen in
65 the `kvm(1)` man page) all of them emulated in software. All these devices
66 are the exact software equivalent of existing hardware devices, and if the OS
67 running in the guest has the proper drivers it will use the devices as if it
68 were running on real hardware. This allows Qemu to runs _unmodified_ operating
69 systems.
70
71 This however has a performance cost, as running in software what was meant to
72 run in hardware involves a lot of extra work for the host CPU. To mitigate this,
73 Qemu can present to the guest operating system _paravirtualized devices_, where
74 the guest OS recognizes it is running inside Qemu and cooperates with the
75 hypervisor.
76
77 Qemu relies on the virtio virtualization standard, and is thus able to present
78 paravirtualized virtio devices, which includes a paravirtualized generic disk
79 controller, a paravirtualized network card, a paravirtualized serial port,
80 a paravirtualized SCSI controller, etc ...
81
82 It is highly recommended to use the virtio devices whenever you can, as they
83 provide a big performance improvement. Using  the virtio generic disk controller
84 versus an emulated IDE controller will double the sequential write throughput,
85 as measured with `bonnie++(8)`. Using the virtio network interface can deliver
86 up to three times the throughput of an emulated Intel E1000 network card, as
87 measured with `iperf(1)`. footnote:[See this benchmark on the KVM wiki
88 http://www.linux-kvm.org/page/Using_VirtIO_NIC]
89
90
91 [[qm_virtual_machines_settings]]
92 Virtual Machines Settings
93 -------------------------
94
95 Generally speaking {pve} tries to choose sane defaults for virtual machines
96 (VM). Make sure you understand the meaning of the settings you change, as it
97 could incur a performance slowdown, or putting your data at risk.
98
99
100 [[qm_general_settings]]
101 General Settings
102 ~~~~~~~~~~~~~~~~
103
104 [thumbnail="screenshot/gui-create-vm-general.png"]
105
106 General settings of a VM include
107
108 * the *Node* : the physical server on which the VM will run
109 * the *VM ID*: a unique number in this {pve} installation used to identify your VM
110 * *Name*: a free form text string you can use to describe the VM
111 * *Resource Pool*: a logical group of VMs
112
113
114 [[qm_os_settings]]
115 OS Settings
116 ~~~~~~~~~~~
117
118 [thumbnail="screenshot/gui-create-vm-os.png"]
119
120 When creating a VM, setting the proper Operating System(OS) allows {pve} to
121 optimize some low level parameters. For instance Windows OS expect the BIOS
122 clock to use the local time, while Unix based OS expect the BIOS clock to have
123 the UTC time.
124
125
126 [[qm_hard_disk]]
127 Hard Disk
128 ~~~~~~~~~
129
130 Qemu can emulate a number of storage controllers:
131
132 * the *IDE* controller, has a design which goes back to the 1984 PC/AT disk
133 controller. Even if this controller has been superseded by recent designs,
134 each and every OS you can think of has support for it, making it a great choice
135 if you want to run an OS released before 2003. You can connect up to 4 devices
136 on this controller.
137
138 * the *SATA* (Serial ATA) controller, dating from 2003, has a more modern
139 design, allowing higher throughput and a greater number of devices to be
140 connected. You can connect up to 6 devices on this controller.
141
142 * the *SCSI* controller, designed in 1985, is commonly found on server grade
143 hardware, and can connect up to 14 storage devices. {pve} emulates by default a
144 LSI 53C895A controller.
145 +
146 A SCSI controller of type _VirtIO SCSI_ is the recommended setting if you aim for
147 performance and is automatically selected for newly created Linux VMs since
148 {pve} 4.3. Linux distributions have support for this controller since 2012, and
149 FreeBSD since 2014. For Windows OSes, you need to provide an extra iso
150 containing the drivers during the installation.
151 // https://pve.proxmox.com/wiki/Paravirtualized_Block_Drivers_for_Windows#During_windows_installation.
152 If you aim at maximum performance, you can select a SCSI controller of type
153 _VirtIO SCSI single_ which will allow you to select the *IO Thread* option.
154 When selecting _VirtIO SCSI single_ Qemu will create a new controller for
155 each disk, instead of adding all disks to the same controller.
156
157 * The *VirtIO Block* controller, often just called VirtIO or virtio-blk,
158 is an older type of paravirtualized controller. It has been superseded by the
159 VirtIO SCSI Controller, in terms of features.
160
161 [thumbnail="screenshot/gui-create-vm-hard-disk.png"]
162 On each controller you attach a number of emulated hard disks, which are backed
163 by a file or a block device residing in the configured storage. The choice of
164 a storage type will determine the format of the hard disk image. Storages which
165 present block devices (LVM, ZFS, Ceph) will require the *raw disk image format*,
166 whereas files based storages (Ext4, NFS, CIFS, GlusterFS) will let you to choose
167 either the *raw disk image format* or the *QEMU image format*.
168
169  * the *QEMU image format* is a copy on write format which allows snapshots, and
170   thin provisioning of the disk image.
171  * the *raw disk image* is a bit-to-bit image of a hard disk, similar to what
172  you would get when executing the `dd` command on a block device in Linux. This
173  format does not support thin provisioning or snapshots by itself, requiring
174  cooperation from the storage layer for these tasks. It may, however, be up to
175  10% faster than the *QEMU image format*. footnote:[See this benchmark for details
176  http://events.linuxfoundation.org/sites/events/files/slides/CloudOpen2013_Khoa_Huynh_v3.pdf]
177  * the *VMware image format* only makes sense if you intend to import/export the
178  disk image to other hypervisors.
179
180 Setting the *Cache* mode of the hard drive will impact how the host system will
181 notify the guest systems of block write completions. The *No cache* default
182 means that the guest system will be notified that a write is complete when each
183 block reaches the physical storage write queue, ignoring the host page cache.
184 This provides a good balance between safety and speed.
185
186 If you want the {pve} backup manager to skip a disk when doing a backup of a VM,
187 you can set the *No backup* option on that disk.
188
189 If you want the {pve} storage replication mechanism to skip a disk when starting
190  a replication job, you can set the *Skip replication* option on that disk.
191 As of {pve} 5.0, replication requires the disk images to be on a storage of type
192 `zfspool`, so adding a disk image to other storages when the VM has replication
193 configured requires to skip replication for this disk image.
194
195 If your storage supports _thin provisioning_ (see the storage chapter in the
196 {pve} guide), and your VM has a *SCSI* controller you can activate the *Discard*
197 option on the hard disks connected to that controller. With *Discard* enabled,
198 when the filesystem of a VM marks blocks as unused after removing files, the
199 emulated SCSI controller will relay this information to the storage, which will
200 then shrink the disk image accordingly.
201
202 If you would like a drive to be presented to the guest as a solid-state drive
203 rather than a rotational hard disk, you can set the *SSD emulation* option on
204 that drive. There is no requirement that the underlying storage actually be
205 backed by SSDs; this feature can be used with physical media of any type.
206
207 .IO Thread
208 The option *IO Thread* can only be used when using a disk with the
209 *VirtIO* controller, or with the *SCSI* controller, when the emulated controller
210  type is  *VirtIO SCSI single*.
211 With this enabled, Qemu creates one I/O thread per storage controller,
212 instead of a single thread for all I/O, so it increases performance when
213 multiple disks are used and each disk has its own storage controller.
214 Note that backups do not currently work with *IO Thread* enabled.
215
216
217 [[qm_cpu]]
218 CPU
219 ~~~
220
221 [thumbnail="screenshot/gui-create-vm-cpu.png"]
222
223 A *CPU socket* is a physical slot on a PC motherboard where you can plug a CPU.
224 This CPU can then contain one or many *cores*, which are independent
225 processing units. Whether you have a single CPU socket with 4 cores, or two CPU
226 sockets with two cores is mostly irrelevant from a performance point of view.
227 However some software licenses depend on the number of sockets a machine has,
228 in that case it makes sense to set the number of sockets to what the license
229 allows you.
230
231 Increasing the number of virtual cpus (cores and sockets) will usually provide a
232 performance improvement though that is heavily dependent on the use of the VM.
233 Multithreaded applications will of course benefit from a large number of
234 virtual cpus, as for each virtual cpu you add, Qemu will create a new thread of
235 execution on the host system. If you're not sure about the workload of your VM,
236 it is usually a safe bet to set the number of *Total cores* to 2.
237
238 NOTE: It is perfectly safe if the _overall_ number of cores of all your VMs
239 is greater than the number of cores on the server (e.g., 4 VMs with each 4
240 cores on a machine with only 8 cores). In that case the host system will
241 balance the Qemu execution threads between your server cores, just like if you
242 were running a standard multithreaded application. However, {pve} will prevent
243 you from assigning more virtual CPU cores than physically available, as this will
244 only bring the performance down due to the cost of context switches.
245
246 [[qm_cpu_resource_limits]]
247 Resource Limits
248 ^^^^^^^^^^^^^^^
249
250 In addition to the number of virtual cores, you can configure how much resources
251 a VM can get in relation to the host CPU time and also in relation to other
252 VMs.
253 With the *cpulimit* (``Host CPU Time'') option you can limit how much CPU time
254 the whole VM can use on the host. It is a floating point value representing CPU
255 time in percent, so `1.0` is equal to `100%`, `2.5` to `250%` and so on. If a
256 single process would fully use one single core it would have `100%` CPU Time
257 usage. If a VM with four cores utilizes all its cores fully it would
258 theoretically use `400%`. In reality the usage may be even a bit higher as Qemu
259 can have additional threads for VM peripherals besides the vCPU core ones.
260 This setting can be useful if a VM should have multiple vCPUs, as it runs a few
261 processes in parallel, but the VM as a whole should not be able to run all
262 vCPUs at 100% at the same time. Using a specific example: lets say we have a VM
263 which would profit from having 8 vCPUs, but at no time all of those 8 cores
264 should run at full load - as this would make the server so overloaded that
265 other VMs and CTs would get to less CPU. So, we set the *cpulimit* limit to
266 `4.0` (=400%). If all cores do the same heavy work they would all get 50% of a
267 real host cores CPU time. But, if only 4 would do work they could still get
268 almost 100% of a real core each.
269
270 NOTE: VMs can, depending on their configuration, use additional threads e.g.,
271 for networking or IO operations but also live migration. Thus a VM can show up
272 to use more CPU time than just its virtual CPUs could use. To ensure that a VM
273 never uses more CPU time than virtual CPUs assigned set the *cpulimit* setting
274 to the same value as the total core count.
275
276 The second CPU resource limiting setting, *cpuunits* (nowadays often called CPU
277 shares or CPU weight), controls how much CPU time a VM gets in regards to other
278 VMs running.  It is a relative weight which defaults to `1024`, if you increase
279 this for a VM it will be prioritized by the scheduler in comparison to other
280 VMs with lower weight. E.g., if VM 100 has set the default 1024 and VM 200 was
281 changed to `2048`, the latter VM 200 would receive twice the CPU bandwidth than
282 the first VM 100.
283
284 For more information see `man systemd.resource-control`, here `CPUQuota`
285 corresponds to `cpulimit` and `CPUShares` corresponds to our `cpuunits`
286 setting, visit its Notes section for references and implementation details.
287
288 CPU Type
289 ^^^^^^^^
290
291 Qemu can emulate a number different of *CPU types* from 486 to the latest Xeon
292 processors. Each new processor generation adds new features, like hardware
293 assisted 3d rendering, random number generation, memory protection, etc ...
294 Usually you should select for your VM a processor type which closely matches the
295 CPU of the host system, as it means that the host CPU features (also called _CPU
296 flags_ ) will be available in your VMs. If you want an exact match, you can set
297 the CPU type to *host* in which case the VM will have exactly the same CPU flags
298 as your host system.
299
300 This has a downside though. If you want to do a live migration of VMs between
301 different hosts, your VM might end up on a new system with a different CPU type.
302 If the CPU flags passed to the guest are missing, the qemu process will stop. To
303 remedy this Qemu has also its own CPU type *kvm64*, that {pve} uses by defaults.
304 kvm64 is a Pentium 4 look a like CPU type, which has a reduced CPU flags set,
305 but is guaranteed to work everywhere.
306
307 In short, if you care about live migration and moving VMs between nodes, leave
308 the kvm64 default. If you don’t care about live migration or have a homogeneous
309 cluster where all nodes have the same CPU, set the CPU type to host, as in
310 theory this will give your guests maximum performance.
311
312 Meltdown / Spectre related CPU flags
313 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
314
315 There are several CPU flags related to the Meltdown and Spectre vulnerabilities
316 footnote:[Meltdown Attack https://meltdownattack.com/] which need to be set
317 manually unless the selected CPU type of your VM already enables them by default.
318
319 There are two requirements that need to be fulfilled in order to use these
320 CPU flags:
321
322 * The host CPU(s) must support the feature and propagate it to the guest's virtual CPU(s)
323 * The guest operating system must be updated to a version which mitigates the
324   attacks and is able to utilize the CPU feature
325
326 Otherwise you need to set the desired CPU flag of the virtual CPU, either by
327 editing the CPU options in the WebUI, or by setting the 'flags' property of the
328 'cpu' option in the VM configuration file.
329
330 For Spectre v1,v2,v4 fixes, your CPU or system vendor also needs to provide a
331 so-called ``microcode update'' footnote:[You can use `intel-microcode' /
332 `amd-microcode' from Debian non-free if your vendor does not provide such an
333 update. Note that not all affected CPUs can be updated to support spec-ctrl.]
334 for your CPU.
335
336
337 To check if the {pve} host is vulnerable, execute the following command as root:
338
339 ----
340 for f in /sys/devices/system/cpu/vulnerabilities/*; do echo "${f##*/} -" $(cat "$f"); done
341 ----
342
343 A community script is also available to detect is the host is still vulnerable.
344 footnote:[spectre-meltdown-checker https://meltdown.ovh/]
345
346 Intel processors
347 ^^^^^^^^^^^^^^^^
348
349 * 'pcid'
350 +
351 This reduces the performance impact of the Meltdown (CVE-2017-5754) mitigation
352 called 'Kernel Page-Table Isolation (KPTI)', which effectively hides
353 the Kernel memory from the user space. Without PCID, KPTI is quite an expensive
354 mechanism footnote:[PCID is now a critical performance/security feature on x86
355 https://groups.google.com/forum/m/#!topic/mechanical-sympathy/L9mHTbeQLNU].
356 +
357 To check if the {pve} host supports PCID, execute the following command as root:
358 +
359 ----
360 # grep ' pcid ' /proc/cpuinfo
361 ----
362 +
363 If this does not return empty your host's CPU has support for 'pcid'.
364
365 * 'spec-ctrl'
366 +
367 Required to enable the Spectre v1 (CVE-2017-5753) and Spectre v2 (CVE-2017-5715) fix,
368 in cases where retpolines are not sufficient.
369 Included by default in Intel CPU models with -IBRS suffix.
370 Must be explicitly turned on for Intel CPU models without -IBRS suffix.
371 Requires an updated host CPU microcode (intel-microcode >= 20180425).
372 +
373 * 'ssbd'
374 +
375 Required to enable the Spectre V4 (CVE-2018-3639) fix. Not included by default in any Intel CPU model.
376 Must be explicitly turned on for all Intel CPU models.
377 Requires an updated host CPU microcode(intel-microcode >= 20180703).
378
379
380 AMD processors
381 ^^^^^^^^^^^^^^
382
383 * 'ibpb'
384 +
385 Required to enable the Spectre v1 (CVE-2017-5753) and Spectre v2 (CVE-2017-5715) fix,
386 in cases where retpolines are not sufficient.
387 Included by default in AMD CPU models with -IBPB suffix.
388 Must be explicitly turned on for AMD CPU models without -IBPB suffix.
389 Requires the host CPU microcode to support this feature before it can be used for guest CPUs.
390
391
392
393 * 'virt-ssbd'
394 +
395 Required to enable the Spectre v4 (CVE-2018-3639) fix.
396 Not included by default in any AMD CPU model.
397 Must be explicitly turned on for all AMD CPU models.
398 This should be provided to guests, even if amd-ssbd is also provided, for maximum guest compatibility.
399 Note that this must be explicitly enabled when when using the "host" cpu model,
400 because this is a virtual feature which does not exist in the physical CPUs.
401
402
403 * 'amd-ssbd'
404 +
405 Required to enable the Spectre v4 (CVE-2018-3639) fix.
406 Not included by default in any AMD CPU model. Must be explicitly turned on for all AMD CPU models.
407 This provides higher performance than virt-ssbd, therefore a host supporting this should always expose this to guests if possible.
408 virt-ssbd should none the less also be exposed for maximum guest compatibility as some kernels only know about virt-ssbd.
409
410
411 * 'amd-no-ssb'
412 +
413 Recommended to indicate the host is not vulnerable to Spectre V4 (CVE-2018-3639).
414 Not included by default in any AMD CPU model.
415 Future hardware generations of CPU will not be vulnerable to CVE-2018-3639,
416 and thus the guest should be told not to enable its mitigations, by exposing amd-no-ssb.
417 This is mutually exclusive with virt-ssbd and amd-ssbd.
418
419
420 NUMA
421 ^^^^
422 You can also optionally emulate a *NUMA*
423 footnote:[https://en.wikipedia.org/wiki/Non-uniform_memory_access] architecture
424 in your VMs. The basics of the NUMA architecture mean that instead of having a
425 global memory pool available to all your cores, the memory is spread into local
426 banks close to each socket.
427 This can bring speed improvements as the memory bus is not a bottleneck
428 anymore. If your system has a NUMA architecture footnote:[if the command
429 `numactl --hardware | grep available` returns more than one node, then your host
430 system has a NUMA architecture] we recommend to activate the option, as this
431 will allow proper distribution of the VM resources on the host system.
432 This option is also required to hot-plug cores or RAM in a VM.
433
434 If the NUMA option is used, it is recommended to set the number of sockets to
435 the number of sockets of the host system.
436
437 vCPU hot-plug
438 ^^^^^^^^^^^^^
439
440 Modern operating systems introduced the capability to hot-plug and, to a
441 certain extent, hot-unplug CPUs in a running systems. Virtualisation allows us
442 to avoid a lot of the (physical) problems real hardware can cause in such
443 scenarios.
444 Still, this is a rather new and complicated feature, so its use should be
445 restricted to cases where its absolutely needed. Most of the functionality can
446 be replicated with other, well tested and less complicated, features, see
447 xref:qm_cpu_resource_limits[Resource Limits].
448
449 In {pve} the maximal number of plugged CPUs is always `cores * sockets`.
450 To start a VM with less than this total core count of CPUs you may use the
451 *vpus* setting, it denotes how many vCPUs should be plugged in at VM start.
452
453 Currently only this feature is only supported on Linux, a kernel newer than 3.10
454 is needed, a kernel newer than 4.7 is recommended.
455
456 You can use a udev rule as follow to automatically set new CPUs as online in
457 the guest:
458
459 ----
460 SUBSYSTEM=="cpu", ACTION=="add", TEST=="online", ATTR{online}=="0", ATTR{online}="1"
461 ----
462
463 Save this under /etc/udev/rules.d/ as a file ending in `.rules`.
464
465 Note: CPU hot-remove is machine dependent and requires guest cooperation.
466 The deletion command does not guarantee CPU removal to actually happen,
467 typically it's a request forwarded to guest using target dependent mechanism,
468 e.g., ACPI on x86/amd64.
469
470
471 [[qm_memory]]
472 Memory
473 ~~~~~~
474
475 For each VM you have the option to set a fixed size memory or asking
476 {pve} to dynamically allocate memory based on the current RAM usage of the
477 host.
478
479 .Fixed Memory Allocation
480 [thumbnail="screenshot/gui-create-vm-memory.png"]
481
482 When setting memory and minimum memory to the same amount
483 {pve} will simply allocate what you specify to your VM.
484
485 Even when using a fixed memory size, the ballooning device gets added to the
486 VM, because it delivers useful information such as how much memory the guest
487 really uses.
488 In general, you should leave *ballooning* enabled, but if you want to disable
489 it (e.g. for debugging purposes), simply uncheck
490 *Ballooning Device* or set
491
492  balloon: 0
493
494 in the configuration.
495
496 .Automatic Memory Allocation
497
498 // see autoballoon() in pvestatd.pm
499 When setting the minimum memory lower than memory, {pve} will make sure that the
500 minimum amount you specified is always available to the VM, and if RAM usage on
501 the host is below 80%, will dynamically add memory to the guest up to the
502 maximum memory specified.
503
504 When the host is running low on RAM, the VM will then release some memory
505 back to the host, swapping running processes if needed and starting the oom
506 killer in last resort. The passing around of memory between host and guest is
507 done via a special `balloon` kernel driver running inside the guest, which will
508 grab or release memory pages from the host.
509 footnote:[A good explanation of the inner workings of the balloon driver can be found here https://rwmj.wordpress.com/2010/07/17/virtio-balloon/]
510
511 When multiple VMs use the autoallocate facility, it is possible to set a
512 *Shares* coefficient which indicates the relative amount of the free host memory
513 that each VM should take. Suppose for instance you have four VMs, three of them
514 running an HTTP server and the last one is a database server. To cache more
515 database blocks in the database server RAM, you would like to prioritize the
516 database VM when spare RAM is available. For this you assign a Shares property
517 of 3000 to the database VM, leaving the other VMs to the Shares default setting
518 of 1000. The host server has 32GB of RAM, and is currently using 16GB, leaving 32
519 * 80/100 - 16 = 9GB RAM to be allocated to the VMs. The database VM will get 9 *
520 3000 / (3000 + 1000 + 1000 + 1000) = 4.5 GB extra RAM and each HTTP server will
521 get 1.5 GB.
522
523 All Linux distributions released after 2010 have the balloon kernel driver
524 included. For Windows OSes, the balloon driver needs to be added manually and can
525 incur a slowdown of the guest, so we don't recommend using it on critical
526 systems.
527 // see https://forum.proxmox.com/threads/solved-hyper-threading-vs-no-hyper-threading-fixed-vs-variable-memory.20265/
528
529 When allocating RAM to your VMs, a good rule of thumb is always to leave 1GB
530 of RAM available to the host.
531
532
533 [[qm_network_device]]
534 Network Device
535 ~~~~~~~~~~~~~~
536
537 [thumbnail="screenshot/gui-create-vm-network.png"]
538
539 Each VM can have many _Network interface controllers_ (NIC), of four different
540 types:
541
542  * *Intel E1000* is the default, and emulates an Intel Gigabit network card.
543  * the *VirtIO* paravirtualized NIC should be used if you aim for maximum
544 performance. Like all VirtIO devices, the guest OS should have the proper driver
545 installed.
546  * the *Realtek 8139* emulates an older 100 MB/s network card, and should
547 only be used when emulating older operating systems ( released before 2002 )
548  * the *vmxnet3* is another paravirtualized device, which should only be used
549 when importing a VM from another hypervisor.
550
551 {pve} will generate for each NIC a random *MAC address*, so that your VM is
552 addressable on Ethernet networks.
553
554 The NIC you added to the VM can follow one of two different models:
555
556  * in the default *Bridged mode* each virtual NIC is backed on the host by a
557 _tap device_, ( a software loopback device simulating an Ethernet NIC ). This
558 tap device is added to a bridge, by default vmbr0 in {pve}. In this mode, VMs
559 have direct access to the Ethernet LAN on which the host is located.
560  * in the alternative *NAT mode*, each virtual NIC will only communicate with
561 the Qemu user networking stack, where a built-in router and DHCP server can
562 provide network access. This built-in DHCP will serve addresses in the private
563 10.0.2.0/24 range. The NAT mode is much slower than the bridged mode, and
564 should only be used for testing. This mode is only available via CLI or the API,
565 but not via the WebUI.
566
567 You can also skip adding a network device when creating a VM by selecting *No
568 network device*.
569
570 .Multiqueue
571 If you are using the VirtIO driver, you can optionally activate the
572 *Multiqueue* option. This option allows the guest OS to process networking
573 packets using multiple virtual CPUs, providing an increase in the total number
574 of packets transferred.
575
576 //http://blog.vmsplice.net/2011/09/qemu-internals-vhost-architecture.html
577 When using the VirtIO driver with {pve}, each NIC network queue is passed to the
578 host kernel, where the queue will be processed by a kernel thread spawned by the
579 vhost driver. With this option activated, it is possible to pass _multiple_
580 network queues to the host kernel for each NIC.
581
582 //https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/html/Virtualization_Tuning_and_Optimization_Guide/sect-Virtualization_Tuning_Optimization_Guide-Networking-Techniques.html#sect-Virtualization_Tuning_Optimization_Guide-Networking-Multi-queue_virtio-net
583 When using Multiqueue, it is recommended to set it to a value equal
584 to the number of Total Cores of your guest. You also need to set in
585 the VM the number of multi-purpose channels on each VirtIO NIC with the ethtool
586 command:
587
588 `ethtool -L ens1 combined X`
589
590 where X is the number of the number of vcpus of the VM.
591
592 You should note that setting the Multiqueue parameter to a value greater
593 than one will increase the CPU load on the host and guest systems as the
594 traffic increases. We recommend to set this option only when the VM has to
595 process a great number of incoming connections, such as when the VM is running
596 as a router, reverse proxy or a busy HTTP server doing long polling.
597
598 [[qm_display]]
599 Display
600 ~~~~~~~
601
602 QEMU can virtualize a few types of VGA hardware. Some examples are:
603
604 * *std*, the default, emulates a card with Bochs VBE extensions.
605 * *vmware*, is a VMWare SVGA-II compatible adapter.
606 * *qxl*, is the QXL paravirtualized graphics card. Selecting this also
607 enables SPICE for the VM.
608
609 You can edit the amount of memory given to the virtual GPU, by setting
610 the *memory* option. This can enable higher resolutions inside the VM,
611 especially with SPICE/QXL.
612
613 Selecting Multi-Monitor mode for SPICE (e.g., qxl2 for dual monitors) has
614 some implications:
615
616 * Windows needs a device for each monitor, so if your ostype is some
617 version of windows, {pve} gives the VM an extra device per monitor.
618 Each device gets the specified amount of memory.
619 * Linux VMs, can always enable more virtual monitors, but selecting
620 a Multi-Monitor mode multiplies the memory given to the device with
621 the number of monitors.
622
623 Selecting *serialX* as display disables the VGA output, and redirects
624 the Web Console to the selected serial port. A configured memory setting
625 will be ignored in that case.
626
627 [[qm_usb_passthrough]]
628 USB Passthrough
629 ~~~~~~~~~~~~~~~
630
631 There are two different types of USB passthrough devices:
632
633 * Host USB passthrough
634 * SPICE USB passthrough
635
636 Host USB passthrough works by giving a VM a USB device of the host.
637 This can either be done via the vendor- and product-id, or
638 via the host bus and port.
639
640 The vendor/product-id looks like this: *0123:abcd*,
641 where *0123* is the id of the vendor, and *abcd* is the id
642 of the product, meaning two pieces of the same usb device
643 have the same id.
644
645 The bus/port looks like this: *1-2.3.4*, where *1* is the bus
646 and *2.3.4* is the port path. This represents the physical
647 ports of your host (depending of the internal order of the
648 usb controllers).
649
650 If a device is present in a VM configuration when the VM starts up,
651 but the device is not present in the host, the VM can boot without problems.
652 As soon as the device/port is available in the host, it gets passed through.
653
654 WARNING: Using this kind of USB passthrough means that you cannot move
655 a VM online to another host, since the hardware is only available
656 on the host the VM is currently residing.
657
658 The second type of passthrough is SPICE USB passthrough. This is useful
659 if you use a SPICE client which supports it. If you add a SPICE USB port
660 to your VM, you can passthrough a USB device from where your SPICE client is,
661 directly to the VM (for example an input device or hardware dongle).
662
663
664 [[qm_bios_and_uefi]]
665 BIOS and UEFI
666 ~~~~~~~~~~~~~
667
668 In order to properly emulate a computer, QEMU needs to use a firmware.
669 By default QEMU uses *SeaBIOS* for this, which is an open-source, x86 BIOS
670 implementation. SeaBIOS is a good choice for most standard setups.
671
672 There are, however, some scenarios in which a BIOS is not a good firmware
673 to boot from, e.g. if you want to do VGA passthrough. footnote:[Alex Williamson has a very good blog entry about this.
674 http://vfio.blogspot.co.at/2014/08/primary-graphics-assignment-without-vga.html]
675 In such cases, you should rather use *OVMF*, which is an open-source UEFI implementation. footnote:[See the OVMF Project http://www.tianocore.org/ovmf/]
676
677 If you want to use OVMF, there are several things to consider:
678
679 In order to save things like the *boot order*, there needs to be an EFI Disk.
680 This disk will be included in backups and snapshots, and there can only be one.
681
682 You can create such a disk with the following command:
683
684  qm set <vmid> -efidisk0 <storage>:1,format=<format>
685
686 Where *<storage>* is the storage where you want to have the disk, and
687 *<format>* is a format which the storage supports. Alternatively, you can
688 create such a disk through the web interface with 'Add' -> 'EFI Disk' in the
689 hardware section of a VM.
690
691 When using OVMF with a virtual display (without VGA passthrough),
692 you need to set the client resolution in the OVMF menu(which you can reach
693 with a press of the ESC button during boot), or you have to choose
694 SPICE as the display type.
695
696 [[qm_startup_and_shutdown]]
697 Automatic Start and Shutdown of Virtual Machines
698 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
699
700 After creating your VMs, you probably want them to start automatically
701 when the host system boots. For this you need to select the option 'Start at
702 boot' from the 'Options' Tab of your VM in the web interface, or set it with
703 the following command:
704
705  qm set <vmid> -onboot 1
706
707 .Start and Shutdown Order
708
709 [thumbnail="screenshot/gui-qemu-edit-start-order.png"]
710
711 In some case you want to be able to fine tune the boot order of your
712 VMs, for instance if one of your VM is providing firewalling or DHCP
713 to other guest systems.  For this you can use the following
714 parameters:
715
716 * *Start/Shutdown order*: Defines the start order priority. E.g. set it to 1 if
717 you want the VM to be the first to be started. (We use the reverse startup
718 order for shutdown, so a machine with a start order of 1 would be the last to
719 be shut down). If multiple VMs have the same order defined on a host, they will
720 additionally be ordered by 'VMID' in ascending order.
721 * *Startup delay*: Defines the interval between this VM start and subsequent
722 VMs starts . E.g. set it to 240 if you want to wait 240 seconds before starting
723 other VMs.
724 * *Shutdown timeout*: Defines the duration in seconds {pve} should wait
725 for the VM to be offline after issuing a shutdown command.
726 By default this value is set to 180, which means that {pve} will issue a
727 shutdown request and wait 180 seconds for the machine to be offline. If
728 the machine is still online after the timeout it will be stopped forcefully.
729
730 NOTE: VMs managed by the HA stack do not follow the 'start on boot' and
731 'boot order' options currently. Those VMs will be skipped by the startup and
732 shutdown algorithm as the HA manager itself ensures that VMs get started and
733 stopped.
734
735 Please note that machines without a Start/Shutdown order parameter will always
736 start after those where the parameter is set. Further, this parameter can only
737 be enforced between virtual machines running on the same host, not
738 cluster-wide.
739
740
741 [[qm_migration]]
742 Migration
743 ---------
744
745 [thumbnail="screenshot/gui-qemu-migrate.png"]
746
747 If you have a cluster, you can migrate your VM to another host with
748
749  qm migrate <vmid> <target>
750
751 There are generally two mechanisms for this
752
753 * Online Migration (aka Live Migration)
754 * Offline Migration
755
756 Online Migration
757 ~~~~~~~~~~~~~~~~
758
759 When your VM is running and it has no local resources defined (such as disks
760 on local storage, passed through devices, etc.) you can initiate a live
761 migration with the -online flag.
762
763 How it works
764 ^^^^^^^^^^^^
765
766 This starts a Qemu Process on the target host with the 'incoming' flag, which
767 means that the process starts and waits for the memory data and device states
768 from the source Virtual Machine (since all other resources, e.g. disks,
769 are shared, the memory content and device state are the only things left
770 to transmit).
771
772 Once this connection is established, the source begins to send the memory
773 content asynchronously to the target. If the memory on the source changes,
774 those sections are marked dirty and there will be another pass of sending data.
775 This happens until the amount of data to send is so small that it can
776 pause the VM on the source, send the remaining data to the target and start
777 the VM on the target in under a second.
778
779 Requirements
780 ^^^^^^^^^^^^
781
782 For Live Migration to work, there are some things required:
783
784 * The VM has no local resources (e.g. passed through devices, local disks, etc.)
785 * The hosts are in the same {pve} cluster.
786 * The hosts have a working (and reliable) network connection.
787 * The target host must have the same or higher versions of the
788   {pve} packages. (It *might* work the other way, but this is never guaranteed)
789
790 Offline Migration
791 ~~~~~~~~~~~~~~~~~
792
793 If you have local resources, you can still offline migrate your VMs,
794 as long as all disk are on storages, which are defined on both hosts.
795 Then the migration will copy the disk over the network to the target host.
796
797 [[qm_copy_and_clone]]
798 Copies and Clones
799 -----------------
800
801 [thumbnail="screenshot/gui-qemu-full-clone.png"]
802
803 VM installation is usually done using an installation media (CD-ROM)
804 from the operation system vendor. Depending on the OS, this can be a
805 time consuming task one might want to avoid.
806
807 An easy way to deploy many VMs of the same type is to copy an existing
808 VM. We use the term 'clone' for such copies, and distinguish between
809 'linked' and 'full' clones.
810
811 Full Clone::
812
813 The result of such copy is an independent VM. The
814 new VM does not share any storage resources with the original.
815 +
816
817 It is possible to select a *Target Storage*, so one can use this to
818 migrate a VM to a totally different storage. You can also change the
819 disk image *Format* if the storage driver supports several formats.
820 +
821
822 NOTE: A full clone need to read and copy all VM image data. This is
823 usually much slower than creating a linked clone.
824 +
825
826 Some storage types allows to copy a specific *Snapshot*, which
827 defaults to the 'current' VM data. This also means that the final copy
828 never includes any additional snapshots from the original VM.
829
830
831 Linked Clone::
832
833 Modern storage drivers supports a way to generate fast linked
834 clones. Such a clone is a writable copy whose initial contents are the
835 same as the original data. Creating a linked clone is nearly
836 instantaneous, and initially consumes no additional space.
837 +
838
839 They are called 'linked' because the new image still refers to the
840 original. Unmodified data blocks are read from the original image, but
841 modification are written (and afterwards read) from a new
842 location. This technique is called 'Copy-on-write'.
843 +
844
845 This requires that the original volume is read-only. With {pve} one
846 can convert any VM into a read-only <<qm_templates, Template>>). Such
847 templates can later be used to create linked clones efficiently.
848 +
849
850 NOTE: You cannot delete the original template while linked clones
851 exists.
852 +
853
854 It is not possible to change the *Target storage* for linked clones,
855 because this is a storage internal feature.
856
857
858 The *Target node* option allows you to create the new VM on a
859 different node. The only restriction is that the VM is on shared
860 storage, and that storage is also available on the target node.
861
862 To avoid resource conflicts, all network interface MAC addresses gets
863 randomized, and we generate a new 'UUID' for the VM BIOS (smbios1)
864 setting.
865
866
867 [[qm_templates]]
868 Virtual Machine Templates
869 -------------------------
870
871 One can convert a VM into a Template. Such templates are read-only,
872 and you can use them to create linked clones.
873
874 NOTE: It is not possible to start templates, because this would modify
875 the disk images. If you want to change the template, create a linked
876 clone and modify that.
877
878 VM Generation ID
879 ----------------
880
881 {pve} supports Virtual Machine Generation ID ('vmgedid') footnote:[Official
882 'vmgenid' Specification
883 https://docs.microsoft.com/en-us/windows/desktop/hyperv_v2/virtual-machine-generation-identifier]
884 for virtual machines.
885 This can be used by the guest operating system to detect any event resulting
886 in a time shift event, for example, restoring a backup or a snapshot rollback.
887
888 When creating new VMs, a 'vmgenid' will be automatically generated and saved
889 in its configuration file.
890
891 To create and add a 'vmgenid' to an already existing VM one can pass the
892 special value `1' to let {pve} autogenerate one or manually set the 'UUID'
893 footnote:[Online GUID generator http://guid.one/] by using it as value,
894 e.g.:
895
896 ----
897  qm set VMID -vmgenid 1
898  qm set VMID -vmgenid 00000000-0000-0000-0000-000000000000
899 ----
900
901 NOTE: The initial addition of a 'vmgenid' device to an existing VM, may result
902 in the same effects as a change on snapshot rollback, backup restore, etc., has
903 as the VM can interpret this as generation change.
904
905 In the rare case the 'vmgenid' mechanism is not wanted one can pass `0' for
906 its value on VM creation, or retroactively delete the property in the
907 configuration with:
908
909 ----
910  qm set VMID -delete vmgenid
911 ----
912
913 The most prominent use case for 'vmgenid' are newer Microsoft Windows
914 operating systems, which use it to avoid problems in time sensitive or
915 replicate services (e.g., databases, domain controller
916 footnote:[https://docs.microsoft.com/en-us/windows-server/identity/ad-ds/get-started/virtual-dc/virtualized-domain-controller-architecture])
917 on snapshot rollback, backup restore or a whole VM clone operation.
918
919 Importing Virtual Machines and disk images
920 ------------------------------------------
921
922 A VM export from a foreign hypervisor takes usually the form of one or more disk
923  images, with a configuration file describing the settings of the VM (RAM,
924  number of cores). +
925 The disk images can be in the vmdk format, if the disks come from
926 VMware or VirtualBox, or qcow2 if the disks come from a KVM hypervisor.
927 The most popular configuration format for VM exports is the OVF standard, but in
928 practice interoperation is limited because many settings are not implemented in
929 the standard itself, and hypervisors export the supplementary information
930 in non-standard extensions.
931
932 Besides the problem of format, importing disk images from other hypervisors
933 may fail if the emulated hardware changes too much from one hypervisor to
934 another. Windows VMs are particularly concerned by this, as the OS is very
935 picky about any changes of hardware. This problem may be solved by
936 installing the MergeIDE.zip utility available from the Internet before exporting
937 and choosing a hard disk type of *IDE* before booting the imported Windows VM.
938
939 Finally there is the question of paravirtualized drivers, which improve the
940 speed of the emulated system and are specific to the hypervisor.
941 GNU/Linux and other free Unix OSes have all the necessary drivers installed by
942 default and you can switch to the paravirtualized drivers right after importing
943 the VM. For Windows VMs, you need to install the Windows paravirtualized
944 drivers by yourself.
945
946 GNU/Linux and other free Unix can usually be imported without hassle. Note
947 that we cannot guarantee a successful import/export of Windows VMs in all
948 cases due to the problems above.
949
950 Step-by-step example of a Windows OVF import
951 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
952
953 Microsoft provides
954 https://developer.microsoft.com/en-us/windows/downloads/virtual-machines/[Virtual Machines downloads]
955  to get started with Windows development.We are going to use one of these
956 to demonstrate the OVF import feature.
957
958 Download the Virtual Machine zip
959 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
960
961 After getting informed about the user agreement, choose the _Windows 10
962 Enterprise (Evaluation - Build)_ for the VMware platform, and download the zip.
963
964 Extract the disk image from the zip
965 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
966
967 Using the `unzip` utility or any archiver of your choice, unpack the zip,
968 and copy via ssh/scp the ovf and vmdk files to your {pve} host.
969
970 Import the Virtual Machine
971 ^^^^^^^^^^^^^^^^^^^^^^^^^^
972
973 This will create a new virtual machine, using cores, memory and
974 VM name as read from the OVF manifest, and import the disks to the +local-lvm+
975  storage. You have to configure the network manually.
976
977  qm importovf 999 WinDev1709Eval.ovf local-lvm
978
979 The VM is ready to be started.
980
981 Adding an external disk image to a Virtual Machine
982 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
983
984 You can also add an existing disk image to a VM, either coming from a
985 foreign hypervisor, or one that you created yourself.
986
987 Suppose you created a Debian/Ubuntu disk image with the 'vmdebootstrap' tool:
988
989  vmdebootstrap --verbose \
990   --size 10GiB --serial-console \
991   --grub --no-extlinux \
992   --package openssh-server \
993   --package avahi-daemon \
994   --package qemu-guest-agent \
995   --hostname vm600 --enable-dhcp \
996   --customize=./copy_pub_ssh.sh \
997   --sparse --image vm600.raw
998
999 You can now create a new target VM for this image.
1000
1001  qm create 600 --net0 virtio,bridge=vmbr0 --name vm600 --serial0 socket \
1002    --bootdisk scsi0 --scsihw virtio-scsi-pci --ostype l26
1003
1004 Add the disk image as +unused0+ to the VM, using the storage +pvedir+:
1005
1006  qm importdisk 600 vm600.raw pvedir
1007
1008 Finally attach the unused disk to the SCSI controller of the VM:
1009
1010  qm set 600 --scsi0 pvedir:600/vm-600-disk-1.raw
1011
1012 The VM is ready to be started.
1013
1014
1015 ifndef::wiki[]
1016 include::qm-cloud-init.adoc[]
1017 endif::wiki[]
1018
1019
1020
1021 Managing Virtual Machines with `qm`
1022 ------------------------------------
1023
1024 qm is the tool to manage Qemu/Kvm virtual machines on {pve}. You can
1025 create and destroy virtual machines, and control execution
1026 (start/stop/suspend/resume). Besides that, you can use qm to set
1027 parameters in the associated config file. It is also possible to
1028 create and delete virtual disks.
1029
1030 CLI Usage Examples
1031 ~~~~~~~~~~~~~~~~~~
1032
1033 Using an iso file uploaded on the 'local' storage, create a VM
1034 with a 4 GB IDE disk on the 'local-lvm' storage
1035
1036  qm create 300 -ide0 local-lvm:4 -net0 e1000 -cdrom local:iso/proxmox-mailgateway_2.1.iso
1037
1038 Start the new VM
1039
1040  qm start 300
1041
1042 Send a shutdown request, then wait until the VM is stopped.
1043
1044  qm shutdown 300 && qm wait 300
1045
1046 Same as above, but only wait for 40 seconds.
1047
1048  qm shutdown 300 && qm wait 300 -timeout 40
1049
1050
1051 [[qm_configuration]]
1052 Configuration
1053 -------------
1054
1055 VM configuration files are stored inside the Proxmox cluster file
1056 system, and can be accessed at `/etc/pve/qemu-server/<VMID>.conf`.
1057 Like other files stored inside `/etc/pve/`, they get automatically
1058 replicated to all other cluster nodes.
1059
1060 NOTE: VMIDs < 100 are reserved for internal purposes, and VMIDs need to be
1061 unique cluster wide.
1062
1063 .Example VM Configuration
1064 ----
1065 cores: 1
1066 sockets: 1
1067 memory: 512
1068 name: webmail
1069 ostype: l26
1070 bootdisk: virtio0
1071 net0: e1000=EE:D2:28:5F:B6:3E,bridge=vmbr0
1072 virtio0: local:vm-100-disk-1,size=32G
1073 ----
1074
1075 Those configuration files are simple text files, and you can edit them
1076 using a normal text editor (`vi`, `nano`, ...). This is sometimes
1077 useful to do small corrections, but keep in mind that you need to
1078 restart the VM to apply such changes.
1079
1080 For that reason, it is usually better to use the `qm` command to
1081 generate and modify those files, or do the whole thing using the GUI.
1082 Our toolkit is smart enough to instantaneously apply most changes to
1083 running VM. This feature is called "hot plug", and there is no
1084 need to restart the VM in that case.
1085
1086
1087 File Format
1088 ~~~~~~~~~~~
1089
1090 VM configuration files use a simple colon separated key/value
1091 format. Each line has the following format:
1092
1093 -----
1094 # this is a comment
1095 OPTION: value
1096 -----
1097
1098 Blank lines in those files are ignored, and lines starting with a `#`
1099 character are treated as comments and are also ignored.
1100
1101
1102 [[qm_snapshots]]
1103 Snapshots
1104 ~~~~~~~~~
1105
1106 When you create a snapshot, `qm` stores the configuration at snapshot
1107 time into a separate snapshot section within the same configuration
1108 file. For example, after creating a snapshot called ``testsnapshot'',
1109 your configuration file will look like this:
1110
1111 .VM configuration with snapshot
1112 ----
1113 memory: 512
1114 swap: 512
1115 parent: testsnaphot
1116 ...
1117
1118 [testsnaphot]
1119 memory: 512
1120 swap: 512
1121 snaptime: 1457170803
1122 ...
1123 ----
1124
1125 There are a few snapshot related properties like `parent` and
1126 `snaptime`. The `parent` property is used to store the parent/child
1127 relationship between snapshots. `snaptime` is the snapshot creation
1128 time stamp (Unix epoch).
1129
1130
1131 [[qm_options]]
1132 Options
1133 ~~~~~~~
1134
1135 include::qm.conf.5-opts.adoc[]
1136
1137
1138 Locks
1139 -----
1140
1141 Online migrations, snapshots and backups (`vzdump`) set a lock to
1142 prevent incompatible concurrent actions on the affected VMs. Sometimes
1143 you need to remove such a lock manually (e.g., after a power failure).
1144
1145  qm unlock <vmid>
1146
1147 CAUTION: Only do that if you are sure the action which set the lock is
1148 no longer running.
1149
1150
1151 ifdef::wiki[]
1152
1153 See Also
1154 ~~~~~~~~
1155
1156 * link:/wiki/Cloud-Init_Support[Cloud-Init Support]
1157
1158 endif::wiki[]
1159
1160
1161 ifdef::manvolnum[]
1162
1163 Files
1164 ------
1165
1166 `/etc/pve/qemu-server/<VMID>.conf`::
1167
1168 Configuration file for the VM '<VMID>'.
1169
1170
1171 include::pve-copyright.adoc[]
1172 endif::manvolnum[]