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