`affinity`: `<string>` ::
-List of host cores used to execute guest processes.
+List of host cores used to execute guest processes, for example: 0,5,8-11
-`agent`: `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
+`agent`: `[enabled=]<1|0> [,freeze-fs-on-backup=<1|0>] [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
-Enable/disable communication with the Qemu Guest Agent and its properties.
+Enable/disable communication with the QEMU Guest Agent and its properties.
`enabled`=`<boolean>` ('default =' `0`);;
-Enable/disable communication with a Qemu Guest Agent (QGA) running in the VM.
+Enable/disable communication with a QEMU Guest Agent (QGA) running in the VM.
+
+`freeze-fs-on-backup`=`<boolean>` ('default =' `1`);;
+
+Freeze/thaw guest filesystems on backup for consistency.
`fstrim_cloned_disks`=`<boolean>` ('default =' `0`);;
Arbitrary arguments passed to kvm, for example:
+
-args: -no-reboot -no-hpet
+args: -no-reboot -smbios 'type=0,vendor=FOO'
+
NOTE: this option is for experts only.
`balloon`: `<integer> (0 - N)` ::
-Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
+Amount of target RAM for the VM in MiB. Using zero disables the ballon driver.
`bios`: `<ovmf | seabios>` ('default =' `seabios`)::
`network`=`<volume>` ;;
-Specify a custom file containing all network data passed to the VM via cloud-init.
+To pass a custom file containing all network data to the VM via cloud-init.
`user`=`<volume>` ;;
-Specify a custom file containing all user data passed to the VM via cloud-init.
+To pass a custom file containing all user data to the VM via cloud-init.
`vendor`=`<volume>` ;;
-Specify a custom file containing all vendor data passed to the VM via cloud-init.
+To pass a custom file containing all vendor data to the VM via cloud-init.
`cipassword`: `<string>` ::
Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows.
+`ciupgrade`: `<boolean>` ::
+
+cloud-init: do an automatic package upgrade after the first boot.
+
`ciuser`: `<string>` ::
cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
`efidisk0`: `[file=]<volume> [,efitype=<2m|4m>] [,format=<enum>] [,pre-enrolled-keys=<1|0>] [,size=<DiskSize>]` ::
-Configure a Disk for storing EFI vars.
+Configure a disk for storing EFI vars.
`efitype`=`<2m | 4m>` ('default =' `2m`);;
-Size and type of the OVMF EFI vars. '4m' is newer and recommended, and required for Secure Boot. For backwards compatibility, '2m' is used if not otherwise specified.
+Size and type of the OVMF EFI vars. '4m' is newer and recommended, and required for Secure Boot. For backwards compatibility, '2m' is used if not otherwise specified. Ignored for VMs with arch=aarc64 (ARM).
`file`=`<volume>` ;;
Script that will be executed during various steps in the vms lifetime.
-`hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,device-id=<hex id>] [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,sub-device-id=<hex id>] [,sub-vendor-id=<hex id>] [,vendor-id=<hex id>] [,x-vga=<1|0>]` ::
+`hostpci[n]`: `[[host=]<HOSTPCIID[;HOSTPCIID2...]>] [,device-id=<hex id>] [,legacy-igd=<1|0>] [,mapping=<mapping-id>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,sub-device-id=<hex id>] [,sub-vendor-id=<hex id>] [,vendor-id=<hex id>] [,x-vga=<1|0>]` ::
Map host PCI devices into guest.
+
'bus:dev.func' (hexadecimal numbers)
+
You can us the 'lspci' command to list existing PCI devices.
++
+Either this or the 'mapping' key must be set.
`legacy-igd`=`<boolean>` ('default =' `0`);;
Pass this device in legacy IGD mode, making it the primary and exclusive graphics device in the VM. Requires 'pc-i440fx' machine type and VGA set to 'none'.
+`mapping`=`<mapping-id>` ;;
+
+The ID of a cluster wide mapping. Either this or the default-key 'host' must be set.
+
`mdev`=`<string>` ;;
The type of mediated device to use.
`machine`: `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
-Specifies the Qemu machine type.
+Specifies the QEMU machine type.
`memory`: `<integer> (16 - N)` ('default =' `512`)::
-Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
+Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device.
`migrate_downtime`: `<number> (0 - N)` ('default =' `0.1`)::
Force MTU, for VirtIO only. Set to '1' to use the bridge MTU
-`queues`=`<integer> (0 - 16)` ;;
+`queues`=`<integer> (0 - 64)` ;;
Number of packet queues to be used on the device.
win10;; Microsoft Windows 10/2016/2019
win11;; Microsoft Windows 11/2022
l24;; Linux 2.4 Kernel
-l26;; Linux 2.6 - 5.X Kernel
+l26;; Linux 2.6 - 6.X Kernel
solaris;; Solaris/OpenSolaris/OpenIndiania kernel
`parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::
The drive's backing volume.
-`usb[n]`: `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
+`usb[n]`: `[[host=]<HOSTUSBDEVICE|spice>] [,mapping=<mapping-id>] [,usb3=<1|0>]` ::
Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14).
machines - use with special care.
+
The value 'spice' can be used to add a usb redirection devices for spice.
++
+Either this or the 'mapping' key must be set.
+
+`mapping`=`<mapping-id>` ;;
+
+The ID of a cluster wide mapping. Either this or the default-key 'host' must be set.
`usb3`=`<boolean>` ('default =' `0`);;
projects / pve-docs.git / blobdiff