X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=qm.adoc;h=81fd39ec06e3d8c55a5f2716deb0b8ec10de9dbd;hp=c75290035b32e244e8925ecc0012b816fccc401c;hb=41925ede90c6d0834c579d3532b79208009a8af3;hpb=25203dc111c1af5a1e100246954d1467535676c7 diff --git a/qm.adoc b/qm.adoc index c752900..81fd39e 100644 --- a/qm.adoc +++ b/qm.adoc @@ -117,11 +117,34 @@ OS Settings [thumbnail="screenshot/gui-create-vm-os.png"] -When creating a VM, setting the proper Operating System(OS) allows {pve} to -optimize some low level parameters. For instance Windows OS expect the BIOS -clock to use the local time, while Unix based OS expect the BIOS clock to have -the UTC time. +When creating a virtual machine (VM), setting the proper Operating System(OS) +allows {pve} to optimize some low level parameters. For instance Windows OS +expect the BIOS clock to use the local time, while Unix based OS expect the +BIOS clock to have the UTC time. +[[qm_system_settings]] +System Settings +~~~~~~~~~~~~~~~ + +On VM creation you can change some basic system components of the new VM. You +can specify which xref:qm_display[display type] you want to use. +[thumbnail="screenshot/gui-create-vm-system.png"] +Additionally, the xref:qm_hard_disk[SCSI controller] can be changed. +If you plan to install the QEMU Guest Agent, or if your selected ISO image +already ships and installs it automatically, you may want to tick the 'Qemu +Agent' box, which lets {pve} know that it can use its features to show some +more information, and complete some actions (for example, shutdown or +snapshots) more intelligently. + +{pve} allows to boot VMs with different firmware and machine types, namely +xref:qm_bios_and_uefi[SeaBIOS and OVMF]. In most cases you want to switch from +the default SeabBIOS to OVMF only if you plan to use +xref:qm_pci_passthrough[PCIe pass through]. A VMs 'Machine Type' defines the +hardware layout of the VM's virtual motherboard. You can choose between the +default https://en.wikipedia.org/wiki/Intel_440FX[Intel 440FX] or the +https://ark.intel.com/content/www/us/en/ark/products/31918/intel-82q35-graphics-and-memory-controller.html[Q35] +chipset, which also provides a virtual PCIe bus, and thus may be desired if +one want's to pass through PCIe hardware. [[qm_hard_disk]] Hard Disk @@ -193,16 +216,21 @@ As of {pve} 5.0, replication requires the disk images to be on a storage of type configured requires to skip replication for this disk image. If your storage supports _thin provisioning_ (see the storage chapter in the -{pve} guide), and your VM has a *SCSI* controller you can activate the *Discard* -option on the hard disks connected to that controller. With *Discard* enabled, -when the filesystem of a VM marks blocks as unused after removing files, the -emulated SCSI controller will relay this information to the storage, which will -then shrink the disk image accordingly. +{pve} guide), you can activate the *Discard* option on a drive. With *Discard* +set and a _TRIM_-enabled guest OS footnote:[TRIM, UNMAP, and discard +https://en.wikipedia.org/wiki/Trim_%28computing%29], when the VM's filesystem +marks blocks as unused after deleting files, the controller will relay this +information to the storage, which will then shrink the disk image accordingly. +For the guest to be able to issue _TRIM_ commands, you must either use a +*VirtIO SCSI* (or *VirtIO SCSI Single*) controller or set the *SSD emulation* +option on the drive. Note that *Discard* is not supported on *VirtIO Block* +drives. If you would like a drive to be presented to the guest as a solid-state drive rather than a rotational hard disk, you can set the *SSD emulation* option on that drive. There is no requirement that the underlying storage actually be backed by SSDs; this feature can be used with physical media of any type. +Note that *SSD emulation* is not supported on *VirtIO Block* drives. .IO Thread The option *IO Thread* can only be used when using a disk with the @@ -432,7 +460,7 @@ will allow proper distribution of the VM resources on the host system. This option is also required to hot-plug cores or RAM in a VM. If the NUMA option is used, it is recommended to set the number of sockets to -the number of sockets of the host system. +the number of nodes of the host system. vCPU hot-plug ^^^^^^^^^^^^^ @@ -479,7 +507,7 @@ host. .Fixed Memory Allocation [thumbnail="screenshot/gui-create-vm-memory.png"] -When setting memory and minimum memory to the same amount +ghen setting memory and minimum memory to the same amount {pve} will simply allocate what you specify to your VM. Even when using a fixed memory size, the ballooning device gets added to the @@ -595,6 +623,39 @@ traffic increases. We recommend to set this option only when the VM has to process a great number of incoming connections, such as when the VM is running as a router, reverse proxy or a busy HTTP server doing long polling. +[[qm_display]] +Display +~~~~~~~ + +QEMU can virtualize a few types of VGA hardware. Some examples are: + +* *std*, the default, emulates a card with Bochs VBE extensions. +* *cirrus*, this was once the default, it emulates a very old hardware module +with all its problems. This display type should only be used if really +necessary footnote:[https://www.kraxel.org/blog/2014/10/qemu-using-cirrus-considered-harmful/ +qemu: using cirrus considered harmful], e.g., if using Windows XP or earlier +* *vmware*, is a VMWare SVGA-II compatible adapter. +* *qxl*, is the QXL paravirtualized graphics card. Selecting this also +enables SPICE for the VM. + +You can edit the amount of memory given to the virtual GPU, by setting +the 'memory' option. This can enable higher resolutions inside the VM, +especially with SPICE/QXL. + +As the memory is reserved by display device, selecting Multi-Monitor mode +for SPICE (e.g., `qxl2` for dual monitors) has some implications: + +* Windows needs a device for each monitor, so if your 'ostype' is some +version of Windows, {pve} gives the VM an extra device per monitor. +Each device gets the specified amount of memory. + +* Linux VMs, can always enable more virtual monitors, but selecting +a Multi-Monitor mode multiplies the memory given to the device with +the number of monitors. + +Selecting `serialX` as display 'type' disables the VGA output, and redirects +the Web Console to the selected serial port. A configured display 'memory' +setting will be ignored in that case. [[qm_usb_passthrough]] USB Passthrough @@ -638,8 +699,12 @@ BIOS and UEFI ~~~~~~~~~~~~~ In order to properly emulate a computer, QEMU needs to use a firmware. -By default QEMU uses *SeaBIOS* for this, which is an open-source, x86 BIOS -implementation. SeaBIOS is a good choice for most standard setups. +Which, on common PCs often known as BIOS or (U)EFI, is executed as one of the +first steps when booting a VM. It is responsible for doing basic hardware +initialization and for providing an interface to the firmware and hardware for +the operating system. By default QEMU uses *SeaBIOS* for this, which is an +open-source, x86 BIOS implementation. SeaBIOS is a good choice for most +standard setups. There are, however, some scenarios in which a BIOS is not a good firmware to boot from, e.g. if you want to do VGA passthrough. footnote:[Alex Williamson has a very good blog entry about this. @@ -665,6 +730,29 @@ you need to set the client resolution in the OVMF menu(which you can reach with a press of the ESC button during boot), or you have to choose SPICE as the display type. +[[qm_ivshmem]] +Inter-VM shared memory +~~~~~~~~~~~~~~~~~~~~~~ + +You can add an Inter-VM shared memory device (`ivshmem`), which allows one to +share memory between the host and a guest, or also between multiple guests. + +To add such a device, you can use `qm`: + + qm set -ivshmem size=32,name=foo + +Where the size is in MiB. The file will be located under +`/dev/shm/pve-shm-$name` (the default name is the vmid). + +NOTE: Currently the device will get deleted as soon as any VM using it got +shutdown or stopped. Open connections will still persist, but new connections +to the exact same device cannot be made anymore. + +A use case for such a device is the Looking Glass +footnote:[Looking Glass: https://looking-glass.hostfission.com/] project, +which enables high performance, low-latency display mirroring between +host and guest. + [[qm_startup_and_shutdown]] Automatic Start and Shutdown of Virtual Machines ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -791,7 +879,7 @@ migrate a VM to a totally different storage. You can also change the disk image *Format* if the storage driver supports several formats. + -NOTE: A full clone need to read and copy all VM image data. This is +NOTE: A full clone needs to read and copy all VM image data. This is usually much slower than creating a linked clone. + @@ -802,7 +890,7 @@ never includes any additional snapshots from the original VM. Linked Clone:: -Modern storage drivers supports a way to generate fast linked +Modern storage drivers support a way to generate fast linked clones. Such a clone is a writable copy whose initial contents are the same as the original data. Creating a linked clone is nearly instantaneous, and initially consumes no additional space. @@ -819,8 +907,8 @@ can convert any VM into a read-only <>). Such templates can later be used to create linked clones efficiently. + -NOTE: You cannot delete the original template while linked clones -exists. +NOTE: You cannot delete an original template while linked clones +exist. + It is not possible to change the *Target storage* for linked clones, @@ -831,7 +919,7 @@ The *Target node* option allows you to create the new VM on a different node. The only restriction is that the VM is on shared storage, and that storage is also available on the target node. -To avoid resource conflicts, all network interface MAC addresses gets +To avoid resource conflicts, all network interface MAC addresses get randomized, and we generate a new 'UUID' for the VM BIOS (smbios1) setting. @@ -850,7 +938,7 @@ clone and modify that. VM Generation ID ---------------- -{pve} supports Virtual Machine Generation ID ('vmgedid') footnote:[Official +{pve} supports Virtual Machine Generation ID ('vmgenid') footnote:[Official 'vmgenid' Specification https://docs.microsoft.com/en-us/windows/desktop/hyperv_v2/virtual-machine-generation-identifier] for virtual machines. @@ -988,7 +1076,20 @@ ifndef::wiki[] include::qm-cloud-init.adoc[] endif::wiki[] +ifndef::wiki[] +include::qm-pci-passthrough.adoc[] +endif::wiki[] + +Hookscripts +----------- + +You can add a hook script to VMs with the config property `hookscript`. + + qm set 100 -hookscript local:snippets/hookscript.pl +It will be called during various phases of the guests lifetime. +For an example and documentation see the example script under +`/usr/share/pve-docs/examples/guest-example-hookscript.pl`. Managing Virtual Machines with `qm` ------------------------------------