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