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