fix 3372: fix typos, and impove pve-gui docs

[pve-docs.git] / qm.1-synopsis.adoc

diff --git a/qm.1-synopsis.adoc b/qm.1-synopsis.adoc
index fed122a46386f3b9bb1f2b009b57b31a283e404f..3f4964b6d1fdcc9dd2be0b2b89d4c509dca51e32 100644 (file)
--- a/qm.1-synopsis.adoc
+++ b/qm.1-synopsis.adoc
@@ -83,8 +83,9 @@ Config type.
 
 *qm config* `<vmid>` `[OPTIONS]`
 
 
 *qm config* `<vmid>` `[OPTIONS]`
 

-Get current virtual machine configuration. This does not include pending
-configuration changes (see 'pending' API).
+Get the virtual machine configuration with pending configuration changes
+applied. Set the 'current' parameter to get the current configuration
+instead.

 
 `<vmid>`: `<integer> (1 - N)` ::
 
 
 `<vmid>`: `<integer> (1 - N)` ::
 


@@ -110,7 +111,7 @@ The (unique) ID of the VM.
 
 Enable/disable ACPI.
 
 
 Enable/disable ACPI.
 

-`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]` ::
+`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::

 
 Enable/disable Qemu GuestAgent and its properties.
 
 
 Enable/disable Qemu GuestAgent and its properties.
 


@@ -120,7 +121,7 @@ Virtual processor architecture. Defaults to the host.
 
 `--archive` `<string>` ::
 
 
 `--archive` `<string>` ::
 

-The backup file.
+The backup archive. Either the file system path to a .tar or .vma file (use '-' to pipe data from stdin) or a proxmox storage backup volume identifier.

 
 `--args` `<string>` ::
 
 
 `--args` `<string>` ::
 


@@ -142,13 +143,13 @@ Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
 
 Select BIOS implementation.
 
 
 Select BIOS implementation.
 

-`--boot` `[acdn]{1,4}` ('default =' `cdn`)::
+`--boot` `[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]` ::

 
 

-Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
+Specify guest boot order. Use with 'order=', usage with no key or 'legacy=' is deprecated.

 
 `--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
 
 
 `--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
 

-Enable booting from specified disk.
+Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead.

 
 `--bwlimit` `<integer> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::
 
 
 `--bwlimit` `<integer> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::
 


@@ -178,7 +179,7 @@ cloud-init: User name to change ssh keys and password for instead of the image's
 
 The number of cores per socket.
 
 
 The number of cores per socket.
 

-`--cpu` `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>]` ::
+`--cpu` `[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]` ::

 
 Emulated CPU type.
 
 
 Emulated CPU type.
 


@@ -212,7 +213,7 @@ Freeze CPU at startup (use 'c' monitor command to start execution).
 
 Script that will be executed during various steps in the vms lifetime.
 
 
 Script that will be executed during various steps in the vms lifetime.
 

-`--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
+`--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::

 
 Map host PCI devices into guest.
 
 
 Map host PCI devices into guest.
 


@@ -234,15 +235,21 @@ cloud-init: Specify IP addresses and gateways for the corresponding interface.
 +
 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
 +
 +
 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
 +

-The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
+The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit
+gateway should be provided.

 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
 +
 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
 +

-If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
+If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
+dhcp on IPv4.

 
 `--ivshmem` `size=<integer> [,name=<string>]` ::
 
 Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
 
 
 `--ivshmem` `size=<integer> [,name=<string>]` ::
 
 Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
 

+`--keephugepages` `<boolean>` ('default =' `0`)::
+
+Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.
+

 `--keyboard` `<da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr>` ::
 
 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
 `--keyboard` `<da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr>` ::
 
 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.


@@ -259,7 +266,7 @@ Set the real time clock to local time. This is enabled by default if ostype indi
 
 Lock/unlock the VM.
 
 
 Lock/unlock the VM.
 

-`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\.pxe)?|virt(?:-\d+(\.\d+)+)?)` ::
+`--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.
 


@@ -281,9 +288,11 @@ Set a name for the VM. Only used on the configuration web interface.
 
 `--nameserver` `<string>` ::
 
 
 `--nameserver` `<string>` ::
 

-cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
+cloud-init: Sets DNS server IP address for a container. Create will'
+           .' automatically use the setting from the host if neither searchdomain nor nameserver'
+           .' are set.

 
 

-`--net[n]` `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
+`--net[n]` `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::

 
 Specify network devices.
 
 
 Specify network devices.
 


@@ -319,13 +328,17 @@ Sets the protection flag of the VM. This will disable the remove VM and remove d
 
 Allow reboot. If set to '0' the VM exit on reboot.
 
 
 Allow reboot. If set to '0' the VM exit on reboot.
 

+`--rng0` `[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]` ::
+
+Configure a VirtIO-based Random Number Generator.
+

 `--sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
 
 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
 
 `--scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
 
 `--sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
 
 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
 
 `--scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
 

-Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
+Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).

 
 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
 
 
 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
 


@@ -333,7 +346,9 @@ SCSI controller model
 
 `--searchdomain` `<string>` ::
 
 
 `--searchdomain` `<string>` ::
 

-cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
+cloud-init: Sets DNS search domains for a container. Create will'
+           .' automatically use the setting from the host if neither searchdomain nor nameserver'
+           .' are set.

 
 `--serial[n]` `(/dev/.+|socket)` ::
 
 
 `--serial[n]` `(/dev/.+|socket)` ::
 


@@ -369,7 +384,7 @@ Start VM after it was created successfully.
 
 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
 
 
 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
 

-Set the initial date of the real time clock. Valid format for date are: 'now' or '2006-06-17T16:01:21' or '2006-06-17'.
+Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'.

 
 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
 
 
 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
 


@@ -383,6 +398,10 @@ Default storage.
 
 Enable/disable the USB tablet device.
 
 
 Enable/disable the USB tablet device.
 

+`--tags` `<string>` ::
+
+Tags of the VM. This is only meta information.
+

 `--tdf` `<boolean>` ('default =' `0`)::
 
 Enable/disable time drift fix.
 `--tdf` `<boolean>` ('default =' `0`)::
 
 Enable/disable time drift fix.


@@ -397,7 +416,7 @@ Assign a unique random ethernet address.
 +
 NOTE: Requires option(s): `archive`
 
 +
 NOTE: Requires option(s): `archive`
 

-`--unused[n]` `<string>` ::
+`--unused[n]` `[file=]<volume>` ::

 
 Reference to unused volumes. This is used internally, and should not be modified manually.
 
 
 Reference to unused volumes. This is used internally, and should not be modified manually.
 


@@ -485,6 +504,10 @@ The (unique) ID of the VM.
 
 Extra arguments as array
 
 
 Extra arguments as array
 

+`--pass-stdin` `<boolean>` ('default =' `0`)::
+
+When set, read STDIN until EOF and forward to guest agent via 'input-data' (usually treated as STDIN to process launched by guest agent). Allows maximal 1 MiB.
+

 `--synchronous` `<boolean>` ('default =' `1`)::
 
 If set to off, returns the pid immediately instead of waiting for the commmand to finish or the timeout.
 `--synchronous` `<boolean>` ('default =' `1`)::
 
 If set to off, returns the pid immediately instead of waiting for the commmand to finish or the timeout.


@@ -628,7 +651,7 @@ Use online/live migration if VM is running. Ignored if VM is stopped.
 
 `--targetstorage` `<string>` ::
 
 
 `--targetstorage` `<string>` ::
 

-Default target storage.
+Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself.

 
 `--with-local-disks` `<boolean>` ::
 
 
 `--with-local-disks` `<boolean>` ::
 


@@ -650,7 +673,7 @@ Move volume to different storage.
 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`<disk>`: `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
+`<disk>`: `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi14 | scsi15 | scsi16 | scsi17 | scsi18 | scsi19 | scsi2 | scsi20 | scsi21 | scsi22 | scsi23 | scsi24 | scsi25 | scsi26 | scsi27 | scsi28 | scsi29 | scsi3 | scsi30 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::

 
 The disk you want to move.
 
 
 The disk you want to move.
 


@@ -688,7 +711,7 @@ The (unique) ID of the VM.
 
 *qm pending* `<vmid>`
 
 
 *qm pending* `<vmid>`
 

-Get virtual machine configuration, including pending changes.
+Get the virtual machine configuration with both current and pending values.

 
 `<vmid>`: `<integer> (1 - N)` ::
 
 
 `<vmid>`: `<integer> (1 - N)` ::
 


@@ -739,7 +762,7 @@ Extend volume size.
 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`<disk>`: `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
+`<disk>`: `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi14 | scsi15 | scsi16 | scsi17 | scsi18 | scsi19 | scsi2 | scsi20 | scsi21 | scsi22 | scsi23 | scsi24 | scsi25 | scsi26 | scsi27 | scsi28 | scsi29 | scsi3 | scsi30 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::

 
 The disk you want to resize.
 
 
 The disk you want to resize.
 


@@ -813,7 +836,7 @@ The (unique) ID of the VM.
 
 Enable/disable ACPI.
 
 
 Enable/disable ACPI.
 

-`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]` ::
+`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::

 
 Enable/disable Qemu GuestAgent and its properties.
 
 
 Enable/disable Qemu GuestAgent and its properties.
 


@@ -841,13 +864,13 @@ Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
 
 Select BIOS implementation.
 
 
 Select BIOS implementation.
 

-`--boot` `[acdn]{1,4}` ('default =' `cdn`)::
+`--boot` `[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]` ::

 
 

-Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
+Specify guest boot order. Use with 'order=', usage with no key or 'legacy=' is deprecated.

 
 `--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
 
 
 `--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
 

-Enable booting from specified disk.
+Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead.

 
 `--cdrom` `<volume>` ::
 
 
 `--cdrom` `<volume>` ::
 


@@ -873,7 +896,7 @@ cloud-init: User name to change ssh keys and password for instead of the image's
 
 The number of cores per socket.
 
 
 The number of cores per socket.
 

-`--cpu` `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>]` ::
+`--cpu` `[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]` ::

 
 Emulated CPU type.
 
 
 Emulated CPU type.
 


@@ -915,7 +938,7 @@ Freeze CPU at startup (use 'c' monitor command to start execution).
 
 Script that will be executed during various steps in the vms lifetime.
 
 
 Script that will be executed during various steps in the vms lifetime.
 

-`--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
+`--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::

 
 Map host PCI devices into guest.
 
 
 Map host PCI devices into guest.
 


@@ -937,15 +960,21 @@ cloud-init: Specify IP addresses and gateways for the corresponding interface.
 +
 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
 +
 +
 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
 +

-The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
+The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit
+gateway should be provided.

 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
 +
 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
 +

-If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
+If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
+dhcp on IPv4.

 
 `--ivshmem` `size=<integer> [,name=<string>]` ::
 
 Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
 
 
 `--ivshmem` `size=<integer> [,name=<string>]` ::
 
 Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
 

+`--keephugepages` `<boolean>` ('default =' `0`)::
+
+Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.
+

 `--keyboard` `<da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr>` ::
 
 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
 `--keyboard` `<da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr>` ::
 
 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.


@@ -962,7 +991,7 @@ Set the real time clock to local time. This is enabled by default if ostype indi
 
 Lock/unlock the VM.
 
 
 Lock/unlock the VM.
 

-`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\.pxe)?|virt(?:-\d+(\.\d+)+)?)` ::
+`--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.
 


@@ -984,9 +1013,11 @@ Set a name for the VM. Only used on the configuration web interface.
 
 `--nameserver` `<string>` ::
 
 
 `--nameserver` `<string>` ::
 

-cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
+cloud-init: Sets DNS server IP address for a container. Create will'
+           .' automatically use the setting from the host if neither searchdomain nor nameserver'
+           .' are set.

 
 

-`--net[n]` `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
+`--net[n]` `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::

 
 Specify network devices.
 
 
 Specify network devices.
 


@@ -1022,13 +1053,17 @@ Allow reboot. If set to '0' the VM exit on reboot.
 
 Revert a pending change.
 
 
 Revert a pending change.
 

+`--rng0` `[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]` ::
+
+Configure a VirtIO-based Random Number Generator.
+

 `--sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
 
 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
 
 `--scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
 
 `--sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
 
 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
 
 `--scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
 

-Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
+Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).

 
 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
 
 
 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
 


@@ -1036,7 +1071,9 @@ SCSI controller model
 
 `--searchdomain` `<string>` ::
 
 
 `--searchdomain` `<string>` ::
 

-cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
+cloud-init: Sets DNS search domains for a container. Create will'
+           .' automatically use the setting from the host if neither searchdomain nor nameserver'
+           .' are set.

 
 `--serial[n]` `(/dev/.+|socket)` ::
 
 
 `--serial[n]` `(/dev/.+|socket)` ::
 


@@ -1072,7 +1109,7 @@ cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
 
 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
 
 
 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
 

-Set the initial date of the real time clock. Valid format for date are: 'now' or '2006-06-17T16:01:21' or '2006-06-17'.
+Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'.

 
 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
 
 
 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
 


@@ -1082,6 +1119,10 @@ Startup and shutdown behavior. Order is a non-negative number defining the gener
 
 Enable/disable the USB tablet device.
 
 
 Enable/disable the USB tablet device.
 

+`--tags` `<string>` ::
+
+Tags of the VM. This is only meta information.
+

 `--tdf` `<boolean>` ('default =' `0`)::
 
 Enable/disable time drift fix.
 `--tdf` `<boolean>` ('default =' `0`)::
 
 Enable/disable time drift fix.


@@ -1090,7 +1131,7 @@ Enable/disable time drift fix.
 
 Enable/disable Template.
 
 
 Enable/disable Template.
 

-`--unused[n]` `<string>` ::
+`--unused[n]` `[file=]<volume>` ::

 
 Reference to unused volumes. This is used internally, and should not be modified manually.
 
 
 Reference to unused volumes. This is used internally, and should not be modified manually.
 


@@ -1192,7 +1233,11 @@ Start virtual machine.
 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\.pxe)?|virt(?:-\d+(\.\d+)+)?)` ::
+`--force-cpu` `<string>` ::
+
+Override QEMU's -cpu argument with the given string.
+
+`--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.
 


@@ -1218,7 +1263,11 @@ Some command save/restore state from this location.
 
 `--targetstorage` `<string>` ::
 
 
 `--targetstorage` `<string>` ::
 

-Target storage for the migration. (Can be '1' to use the same storage id as on the source node.)
+Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself.
+
+`--timeout` `<integer> (0 - N)` ('default =' `max(30, vm memory in GiB)`)::
+
+Wait maximal timeout seconds.

 
 *qm status* `<vmid>` `[OPTIONS]`
 
 
 *qm status* `<vmid>` `[OPTIONS]`
 


@@ -1287,7 +1336,7 @@ Create a Template.
 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`--disk` `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
+`--disk` `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi14 | scsi15 | scsi16 | scsi17 | scsi18 | scsi19 | scsi2 | scsi20 | scsi21 | scsi22 | scsi23 | scsi24 | scsi25 | scsi26 | scsi27 | scsi28 | scsi29 | scsi3 | scsi30 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::

 
 If you want to convert only 1 disk to base image.
 
 
 If you want to convert only 1 disk to base image.