update generated docs

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

diff --git a/qm.1-synopsis.adoc b/qm.1-synopsis.adoc
index c19292f63120f531b57abec013ada966641d3b8e..d45a18b2d9aa9e62396a49490507bdc1b1d84a2e 100644 (file)
--- a/qm.1-synopsis.adoc
+++ b/qm.1-synopsis.adoc
@@ -1,51 +1,64 @@
 *qm* `<COMMAND> [ARGS] [OPTIONS]`
 
 *qm* `<COMMAND> [ARGS] [OPTIONS]`
 

+*qm agent* `<vmid> <command>`
+
+Execute Qemu Guest Agent commands.
+
+`<vmid>`: `<integer> (1 - N)` ::
+
+The (unique) ID of the VM.
+
+`<command>`: `<fsfreeze-freeze | fsfreeze-status | fsfreeze-thaw | fstrim | get-fsinfo | get-memory-block-info | get-memory-blocks | get-time | get-vcpus | info | network-get-interfaces | ping | shutdown | suspend-disk | suspend-hybrid | suspend-ram>` ::
+
+The QGA command.
+
+
+

 *qm clone* `<vmid> <newid>` `[OPTIONS]`
 
 Create a copy of virtual machine/template.
 
 *qm clone* `<vmid> <newid>` `[OPTIONS]`
 
 Create a copy of virtual machine/template.
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`<newid>` `integer (1 - N)` ::
+`<newid>`: `<integer> (1 - N)` ::

 
 VMID for the clone.
 
 
 VMID for the clone.
 

-`-description` `string` ::
+`-description` `<string>` ::

 
 Description for the new VM.
 
 
 Description for the new VM.
 

-`-format` `(qcow2 | raw | vmdk)` ::
+`-format` `<qcow2 | raw | vmdk>` ::

 
 Target format for file storage.
 +
 NOTE: Requires option(s): `full`
 
 
 Target format for file storage.
 +
 NOTE: Requires option(s): `full`
 

-`-full` `boolean` (default=`0`)::
+`-full` `<boolean>` ('default =' `0`)::

 
 

-Create a full copy of all disk. This is always done when you clone a normal
-VM. For VM templates, we try to create a linked clone by default.
+Create a full copy of all disk. This is always done when you clone a normal VM. For VM templates, we try to create a linked clone by default.

 
 

-`-name` `string` ::
+`-name` `<string>` ::

 
 Set a name for the new VM.
 
 
 Set a name for the new VM.
 

-`-pool` `string` ::
+`-pool` `<string>` ::

 
 Add the new VM to the specified pool.
 
 
 Add the new VM to the specified pool.
 

-`-snapname` `string` ::
+`-snapname` `<string>` ::

 
 The name of the snapshot.
 
 
 The name of the snapshot.
 

-`-storage` `string` ::
+`-storage` `<string>` ::

 
 Target storage for full clone.
 +
 NOTE: Requires option(s): `full`
 
 
 Target storage for full clone.
 +
 NOTE: Requires option(s): `full`
 

-`-target` `string` ::
+`-target` `<string>` ::

 
 Target node. Only allowed if the original VM is on shared storage.
 
 
 Target node. Only allowed if the original VM is on shared storage.
 


@@ -56,11 +69,11 @@ Target node. Only allowed if the original VM is on shared storage.
 Get current virtual machine configuration. This does not include pending
 configuration changes (see 'pending' API).
 
 Get current virtual machine configuration. This does not include pending
 configuration changes (see 'pending' API).
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`-current` `boolean` (default=`0`)::
+`-current` `<boolean>` ('default =' `0`)::

 
 Get current values (instead of pending values).
 
 
 Get current values (instead of pending values).
 


@@ -70,44 +83,39 @@ Get current values (instead of pending values).
 
 Create or restore a virtual machine.
 
 
 Create or restore a virtual machine.
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`-acpi` `boolean` (default=`1`)::
+`-acpi` `<boolean>` ('default =' `1`)::

 
 Enable/disable ACPI.
 
 
 Enable/disable ACPI.
 

-`-agent` `boolean` (default=`0`)::
+`-agent` `<boolean>` ('default =' `0`)::

 
 Enable/disable Qemu GuestAgent.
 
 
 Enable/disable Qemu GuestAgent.
 

-`-archive` `string` ::
+`-archive` `<string>` ::

 
 The backup file.
 
 
 The backup file.
 

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

 
 

-Arbitrary arguments passed to kvm, for example:
-+
-args: -no-reboot -no-hpet
-+
-NOTE: this option is for experts only.
+Arbitrary arguments passed to kvm.

 
 

-`-autostart` `boolean` (default=`0`)::
+`-autostart` `<boolean>` ('default =' `0`)::

 
 Automatic restart after crash (currently ignored).
 
 
 Automatic restart after crash (currently ignored).
 

-`-balloon` `integer (0 - N)` ::
+`-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 MB. Using zero disables the ballon driver.

 
 

-`-bios` `(ovmf | seabios)` (default=`seabios`)::
+`-bios` `<ovmf | seabios>` ('default =' `seabios`)::

 
 Select BIOS implementation.
 
 
 Select BIOS implementation.
 

-`-boot` `[acdn]{1,4}` (default=`cdn`)::
+`-boot` `[acdn]{1,4}` ('default =' `cdn`)::

 
 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
 
 
 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
 


@@ -115,90 +123,73 @@ Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
 
 Enable booting from specified disk.
 
 
 Enable booting from specified disk.
 

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

 
 This is an alias for option -ide2
 
 
 This is an alias for option -ide2
 

-`-cores` `integer (1 - N)` (default=`1`)::
+`-cores` `<integer> (1 - N)` ('default =' `1`)::

 
 The number of cores per socket.
 
 
 The number of cores per socket.
 

-`-cpu` `[cputype=]<cputype> [,hidden=<1|0>]` ::
+`-cpu` `[cputype=]<enum> [,hidden=<1|0>]` ::

 
 Emulated CPU type.
 
 
 Emulated CPU type.
 

-`-cpulimit` `number (0 - 128)` (default=`0`)::
+`-cpulimit` `<number> (0 - 128)` ('default =' `0`)::

 
 Limit of CPU usage.
 
 Limit of CPU usage.

-+
-NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0'
-indicates no CPU limit.

 
 

-`-cpuunits` `integer (0 - 500000)` (default=`1000`)::
+`-cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::

 
 

-CPU weight for a VM. Argument is used in the kernel fair scheduler. The
-larger the number is, the more CPU time this VM gets. Number is relative to
-weights of all the other running VMs.
-+
-NOTE: You can disable fair-scheduler configuration by setting this to 0.
+CPU weight for a VM.

 
 

-`-description` `string` ::
+`-description` `<string>` ::

 
 

-Description for the VM. Only used on the configuration web interface. This
-is saved as comment inside the configuration file.
+Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.

 
 

-`-force` `boolean` ::
+`-efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
+
+Configure a Disk for storing EFI vars
+
+`-force` `<boolean>` ::

 
 Allow to overwrite existing VM.
 +
 NOTE: Requires option(s): `archive`
 
 
 Allow to overwrite existing VM.
 +
 NOTE: Requires option(s): `archive`
 

-`-freeze` `boolean` ::
+`-freeze` `<boolean>` ::

 
 Freeze CPU at startup (use 'c' monitor command to start execution).
 
 
 Freeze CPU at startup (use 'c' monitor command to start execution).
 

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

 
 

-Map host pci devices. HOSTPCIDEVICE syntax is:
-+
-'bus:dev.func' (hexadecimal numbers)
-+
-You can us the 'lspci' command to list existing pci devices.
-+
-The 'rombar' option determines whether or not the device's ROM will be
-visible in the guest's memory map (default is 'on').
-+
-NOTE: This option allows direct access to host hardware. So it is no longer
-possible to migrate such machines - use with special care.
-+
-Experimental: user reported problems with this option.
+Map host PCI devices into guest.
+
+`-hotplug` `<string>` ('default =' `network,disk,usb`)::
+
+Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'.

 
 

-`-hotplug` `string` (default=`network,disk,usb`)::
+`-hugepages` `<1024 | 2 | any>` ::

 
 

-Selectively enable hotplug features. This is a comma separated list of
-hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to
-disable hotplug completely. Value '1' is an alias for the default
-'network,disk,usb'.
+Enable/disable hugepages memory.

 
 

-`-ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
+`-ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_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_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::

 
 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
 
 
 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
 

-`-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)` (default=`en-us`)::
+`-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>` ('default =' `en-us`)::

 
 

-Keybord layout for vnc server. Default is read from the datacenter
-configuration file.
+Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.

 
 

-`-kvm` `boolean` (default=`1`)::
+`-kvm` `<boolean>` ('default =' `1`)::

 
 Enable/disable KVM hardware virtualization.
 
 
 Enable/disable KVM hardware virtualization.
 

-`-localtime` `boolean` ::
+`-localtime` `<boolean>` ::

 
 

-Set the real time clock to local time. This is enabled by default if ostype
-indicates a Microsoft OS.
+Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.

 
 

-`-lock` `(backup | migrate | rollback | snapshot)` ::
+`-lock` `<backup | migrate | rollback | snapshot>` ::

 
 Lock/unlock the VM.
 
 
 Lock/unlock the VM.
 


@@ -206,228 +197,143 @@ Lock/unlock the VM.
 
 Specific the Qemu machine type.
 
 
 Specific the Qemu machine type.
 

-`-memory` `integer (16 - N)` (default=`512`)::
+`-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 MB. This is the maximum available memory when you use the balloon device.

 
 

-`-migrate_downtime` `number (0 - N)` (default=`0.1`)::
+`-migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::

 
 Set maximum tolerated downtime (in seconds) for migrations.
 
 
 Set maximum tolerated downtime (in seconds) for migrations.
 

-`-migrate_speed` `integer (0 - N)` (default=`0`)::
+`-migrate_speed` `<integer> (0 - N)` ('default =' `0`)::

 
 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
 
 
 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
 

-`-name` `string` ::
+`-name` `<string>` ::

 
 Set a name for the VM. Only used on the configuration web interface.
 
 
 Set a name for the VM. Only used on the configuration web interface.
 

-`-net[n]` `string` ::
+`-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>]` ::

 
 Specify network devices.
 
 Specify network devices.

-+
-MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551
-i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3
-+
-XX:XX:XX:XX:XX:XX should be an unique MAC address. This is
-automatically generated if not specified.
-+
-The bridge parameter can be used to automatically add the interface to a
-bridge device. The Proxmox VE standard bridge is called 'vmbr0'.
-+
-Option 'rate' is used to limit traffic bandwidth from and to this
-interface. It is specified as floating point number, unit is 'Megabytes per
-second'.
-+
-If you specify no bridge, we create a kvm 'user' (NATed) network device,
-which provides DHCP and DNS services. The following addresses are used:
-+
-10.0.2.2   Gateway
-10.0.2.3   DNS Server
-10.0.2.4   SMB Server
-+
-The DHCP server assign addresses to the guest starting from 10.0.2.15.

 
 

-`-numa` `boolean` (default=`0`)::
+`-numa` `<boolean>` ('default =' `0`)::

 
 Enable/disable NUMA.
 
 
 Enable/disable NUMA.
 

-`-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<mb>] [,policy=<preferred|bind|interleave>]` ::
+`-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::

 
 

-numa topology
+NUMA topology.

 
 

-`-onboot` `boolean` (default=`0`)::
+`-onboot` `<boolean>` ('default =' `0`)::

 
 Specifies whether a VM will be started during system bootup.
 
 
 Specifies whether a VM will be started during system bootup.
 

-`-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` ::
+`-ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::

 
 

-Used to enable special optimization/features for specific
-operating systems:
-+
-other  => unspecified OS
-wxp    => Microsoft Windows XP
-w2k    => Microsoft Windows 2000
-w2k3   => Microsoft Windows 2003
-w2k8   => Microsoft Windows 2008
-wvista => Microsoft Windows Vista
-win7   => Microsoft Windows 7
-win8   => Microsoft Windows 8/2012
-l24    => Linux 2.4 Kernel
-l26    => Linux 2.6/3.X Kernel
-solaris => solaris/opensolaris/openindiania kernel
-+
-other|l24|l26|solaris                      ... no special behaviour
-wxp|w2k|w2k3|w2k8|wvista|win7|win8  ... use --localtime switch
+Specify guest operating system.

 
 `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
 
 Map host parallel devices (n is 0 to 2).
 
 `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
 
 Map host parallel devices (n is 0 to 2).

-+
-NOTE: This option allows direct access to host hardware. So it is no longer
-possible to migrate such machines - use with special care.
-+
-Experimental: user reported problems with this option.

 
 

-`-pool` `string` ::
+`-pool` `<string>` ::

 
 Add the VM to the specified pool.
 
 
 Add the VM to the specified pool.
 

-`-protection` `boolean` (default=`0`)::
+`-protection` `<boolean>` ('default =' `0`)::

 
 

-Sets the protection flag of the VM. This will prevent the remove operation.
+Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.

 
 

-`-reboot` `boolean` (default=`1`)::
+`-reboot` `<boolean>` ('default =' `1`)::

 
 Allow reboot. If set to '0' the VM exit on reboot.
 
 
 Allow reboot. If set to '0' the VM exit on reboot.
 

-`-sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
+`-sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_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_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::

 
 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
 
 
 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
 

-`-scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<off|on>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<nbqueues>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
+`-scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_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_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,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>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::

 
 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 13).
 

-`-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`)::

 
 

-scsi controller model
+SCSI controller model

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

-Create a serial device inside the VM (n is 0 to 3), and pass through a host
-serial device (i.e. /dev/ttyS0), or create a unix socket on the host side
-(use 'qm terminal' to open a terminal connection).
-+
-NOTE: If you pass through a host serial device, it is no longer possible to
-migrate such machines - use with special care.
-+
-Experimental: user reported problems with this option.
+Create a serial device inside the VM (n is 0 to 3)

 
 

-`-shares` `integer (0 - 50000)` (default=`1000`)::
+`-shares` `<integer> (0 - 50000)` ('default =' `1000`)::

 
 

-Amount of memory shares for auto-ballooning. The larger the number is, the
-more memory this VM gets. Number is relative to weights of all other
-running VMs. Using zero disables auto-ballooning
+Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning

 
 

-`-smbios1` `[family=<str>] [,manufacturer=<name>] [,product=<name>] [,serial=<str>] [,sku=<str>] [,uuid=<UUID>] [,version=<str>]` ::
+`-smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::

 
 Specify SMBIOS type 1 fields.
 
 
 Specify SMBIOS type 1 fields.
 

-`-smp` `integer (1 - N)` (default=`1`)::
+`-smp` `<integer> (1 - N)` ('default =' `1`)::

 
 The number of CPUs. Please use option -sockets instead.
 
 
 The number of CPUs. Please use option -sockets instead.
 

-`-sockets` `integer (1 - N)` (default=`1`)::
+`-sockets` `<integer> (1 - N)` ('default =' `1`)::

 
 The number of CPU sockets.
 
 
 The number of CPU sockets.
 

-`-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+] ` ::
 

-Startup and shutdown behavior. Order is a non-negative number defining the
-general startup order. Shutdown in done with reverse ordering. Additionally
-you can set the 'up' or 'down' delay in seconds, which specifies a delay to
-wait before the next VM is started or stopped.
+Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.

 
 

-`-storage` `string` ::
+`-storage` `<string>` ::

 
 Default storage.
 
 
 Default storage.
 

-`-tablet` `boolean` (default=`1`)::
+`-tablet` `<boolean>` ('default =' `1`)::

 
 

-Enable/disable the USB tablet device. This device is usually needed to
-allow absolute mouse positioning with VNC. Else the mouse runs out of sync
-with normal VNC clients. If you're running lots of console-only guests on
-one host, you may consider disabling this to save some context switches.
-This is turned off by default if you use spice (-vga=qxl).
+Enable/disable the USB tablet device.

 
 

-`-tdf` `boolean` (default=`0`)::
+`-tdf` `<boolean>` ('default =' `0`)::

 
 Enable/disable time drift fix.
 
 
 Enable/disable time drift fix.
 

-`-template` `boolean` (default=`0`)::
+`-template` `<boolean>` ('default =' `0`)::

 
 Enable/disable Template.
 
 
 Enable/disable Template.
 

-`-unique` `boolean` ::
+`-unique` `<boolean>` ::

 
 Assign a unique random ethernet address.
 +
 NOTE: Requires option(s): `archive`
 
 
 Assign a unique random ethernet address.
 +
 NOTE: Requires option(s): `archive`
 

-`-unused[n]` `string` ::
+`-unused[n]` `<string>` ::

 
 

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

 
 

-`-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<yes|no>]` ::
+`-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::

 
 

-Configure an USB device (n is 0 to 4). This can be used to
-pass-through usb devices to the guest. HOSTUSBDEVICE syntax is:
-+
-'bus-port(.port)*' (decimal numbers) or
-'vendor_id:product_id' (hexadeciaml numbers) or
-'spice'
-+
-You can use the 'lsusb -t' command to list existing usb devices.
-+
-NOTE: This option allows direct access to host hardware. So it is no longer
-possible to migrate such machines - use with special care.
-+
-The value 'spice' can be used to add a usb redirection devices for spice.
-+
-The 'usb3' option determines whether the device is a USB3 device or not
-(this does currently not work reliably with spice redirection and is then
-ignored).
+Configure an USB device (n is 0 to 4).

 
 

-`-vcpus` `integer (1 - N)` (default=`0`)::
+`-vcpus` `<integer> (1 - N)` ('default =' `0`)::

 
 Number of hotplugged vcpus.
 
 
 Number of hotplugged vcpus.
 

-`-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
+`-vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` ::

 
 

-Select the VGA type. If you want to use high resolution modes (>=
-1280x1024x16) then you should use the options 'std' or 'vmware'. Default is
-'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option
-enables the SPICE display sever. For win* OS you can select how many
-independent displays you want, Linux guests can add displays them self. You
-can also run without any graphic card, using a serial device as terminal.
+Select the VGA type.

 
 

-`-virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<off|on>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
+`-virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_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_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,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>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::

 
 Use volume as VIRTIO hard disk (n is 0 to 15).
 
 
 Use volume as VIRTIO hard disk (n is 0 to 15).
 

-`-watchdog` `[action=<reset|shutdown|poweroff|pause|debug|none>] [,[model=]<i6300esb|ib700>]` ::
+`-watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::

 
 

-Create a virtual hardware watchdog device. Once enabled (by a guest
-action), the watchdog must be periodically polled by an agent inside the
-guest or else the watchdog will reset the guest (or execute the respective
-action specified)
+Create a virtual hardware watchdog device.

 
 
 
 
 
 


@@ -435,15 +341,15 @@ action specified)
 
 Delete a VM snapshot.
 
 
 Delete a VM snapshot.
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`<snapname>` `string` ::
+`<snapname>`: `<string>` ::

 
 The name of the snapshot.
 
 
 The name of the snapshot.
 

-`-force` `boolean` ::
+`-force` `<boolean>` ::

 
 For removal from config file, even if removing disk snapshots fails.
 
 
 For removal from config file, even if removing disk snapshots fails.
 


@@ -453,11 +359,11 @@ For removal from config file, even if removing disk snapshots fails.
 
 Destroy the vm (also delete all used/owned volumes).
 
 
 Destroy the vm (also delete all used/owned volumes).
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`-skiplock` `boolean` ::
+`-skiplock` `<boolean>` ::

 
 Ignore locks - only root is allowed to use this option.
 
 
 Ignore locks - only root is allowed to use this option.
 


@@ -468,11 +374,11 @@ Ignore locks - only root is allowed to use this option.
 
 Get help about specified command.
 
 
 Get help about specified command.
 

-`<cmd>` `string` ::
+`<cmd>`: `<string>` ::

 
 Command name
 
 
 Command name
 

-`-verbose` `boolean` ::
+`-verbose` `<boolean>` ::

 
 Verbose output format.
 
 
 Verbose output format.
 


@@ -483,33 +389,58 @@ Verbose output format.
 
 Virtual machine index (per node).
 
 
 Virtual machine index (per node).
 

-`-full` `boolean` ::
+`-full` `<boolean>` ::

 
 Determine the full status of active VMs.
 
 
 
 
 Determine the full status of active VMs.
 
 
 

+*qm listsnapshot* `<vmid>`
+
+List all snapshots.
+
+`<vmid>`: `<integer> (1 - N)` ::
+
+The (unique) ID of the VM.
+
+
+

 *qm migrate* `<vmid> <target>` `[OPTIONS]`
 
 Migrate virtual machine. Creates a new migration task.
 
 *qm migrate* `<vmid> <target>` `[OPTIONS]`
 
 Migrate virtual machine. Creates a new migration task.
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`<target>` `string` ::
+`<target>`: `<string>` ::

 
 Target node.
 
 
 Target node.
 

-`-force` `boolean` ::
+`-force` `<boolean>` ::
+
+Allow to migrate VMs which use local devices. Only root may use this option.
+
+`-migration_network` `<string>` ::
+
+CIDR of the (sub) network that is used for migration.

 
 

-Allow to migrate VMs which use local devices. Only root may use this
-option.
+`-migration_type` `<insecure | secure>` ::

 
 

-`-online` `boolean` ::
+Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
+
+`-online` `<boolean>` ::

 
 Use online/live migration.
 
 
 Use online/live migration.
 

+`-targetstorage` `<string>` ::
+
+Default target storage.
+
+`-with-local-disks` `<boolean>` ::
+
+Enable live storage migration for local disk
+

 
 
 
 
 
 


@@ -517,7 +448,7 @@ Use online/live migration.
 
 Enter Qemu Monitor interface.
 
 
 Enter Qemu Monitor interface.
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 


@@ -528,29 +459,27 @@ The (unique) ID of the VM.
 
 Move volume to different storage.
 
 
 Move volume to different storage.
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`<disk>` `(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 | scsi2 | scsi3 | 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.
 

-`<storage>` `string` ::
+`<storage>`: `<string>` ::

 
 Target storage.
 
 
 Target storage.
 

-`-delete` `boolean` (default=`0`)::
+`-delete` `<boolean>` ('default =' `0`)::

 
 

-Delete the original disk after successful copy. By default the original
-disk is kept as unused disk.
+Delete the original disk after successful copy. By default the original disk is kept as unused disk.

 
 

-`-digest` `string` ::
+`-digest` `<string>` ::

 
 

-Prevent changes if current configuration file has different SHA1 digest.
-This can be used to prevent concurrent modifications.
+Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.

 
 

-`-format` `(qcow2 | raw | vmdk)` ::
+`-format` `<qcow2 | raw | vmdk>` ::

 
 Target Format.
 
 
 Target Format.
 


@@ -563,12 +492,22 @@ Used by qmigrate - do not use manually.
 
 
 
 
 
 

+*qm nbdstop* `<vmid>`
+
+Stop embedded nbd server.
+
+`<vmid>`: `<integer> (1 - N)` ::
+
+The (unique) ID of the VM.
+
+
+

 
 *qm pending* `<vmid>`
 
 Get virtual machine configuration, including pending changes.
 
 
 *qm pending* `<vmid>`
 
 Get virtual machine configuration, including pending changes.
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 


@@ -579,7 +518,7 @@ The (unique) ID of the VM.
 
 Rescan all storages and update disk sizes and unused disk images.
 
 
 Rescan all storages and update disk sizes and unused disk images.
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 


@@ -590,11 +529,11 @@ The (unique) ID of the VM.
 
 Reset virtual machine.
 
 
 Reset virtual machine.
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`-skiplock` `boolean` ::
+`-skiplock` `<boolean>` ::

 
 Ignore locks - only root is allowed to use this option.
 
 
 Ignore locks - only root is allowed to use this option.
 


@@ -604,26 +543,23 @@ Ignore locks - only root is allowed to use this option.
 
 Extend volume size.
 
 
 Extend volume size.
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`<disk>` `(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 | scsi2 | scsi3 | 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.
 

-`<size>` `\+?\d+(\.\d+)?[KMGT]?` ::
+`<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::

 
 

-The new size. With the '+' sign the value is added to the actual size of
-the volume and without it, the value is taken as an absolute one. Shrinking
-disk size is not supported.
+The new size. With the '+' sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported.

 
 

-`-digest` `string` ::
+`-digest` `<string>` ::

 
 

-Prevent changes if current configuration file has different SHA1 digest.
-This can be used to prevent concurrent modifications.
+Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.

 
 

-`-skiplock` `boolean` ::
+`-skiplock` `<boolean>` ::

 
 Ignore locks - only root is allowed to use this option.
 
 
 Ignore locks - only root is allowed to use this option.
 


@@ -633,15 +569,15 @@ Ignore locks - only root is allowed to use this option.
 
 Resume virtual machine.
 
 
 Resume virtual machine.
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`-nocheck` `boolean` ::
+`-nocheck` `<boolean>` ::

 
 no description available
 
 
 no description available
 

-`-skiplock` `boolean` ::
+`-skiplock` `<boolean>` ::

 
 Ignore locks - only root is allowed to use this option.
 
 
 Ignore locks - only root is allowed to use this option.
 


@@ -651,11 +587,11 @@ Ignore locks - only root is allowed to use this option.
 
 Rollback VM state to specified snapshot.
 
 
 Rollback VM state to specified snapshot.
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`<snapname>` `string` ::
+`<snapname>`: `<string>` ::

 
 The name of the snapshot.
 
 
 The name of the snapshot.
 


@@ -665,15 +601,15 @@ The name of the snapshot.
 
 Send key event to virtual machine.
 
 
 Send key event to virtual machine.
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`<key>` `string` ::
+`<key>`: `<string>` ::

 
 The key (qemu monitor encoding).
 
 
 The key (qemu monitor encoding).
 

-`-skiplock` `boolean` ::
+`-skiplock` `<boolean>` ::

 
 Ignore locks - only root is allowed to use this option.
 
 
 Ignore locks - only root is allowed to use this option.
 


@@ -685,40 +621,35 @@ Set virtual machine options (synchrounous API) - You should consider using
 the POST method instead for any actions involving hotplug or storage
 allocation.
 
 the POST method instead for any actions involving hotplug or storage
 allocation.
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`-acpi` `boolean` (default=`1`)::
+`-acpi` `<boolean>` ('default =' `1`)::

 
 Enable/disable ACPI.
 
 
 Enable/disable ACPI.
 

-`-agent` `boolean` (default=`0`)::
+`-agent` `<boolean>` ('default =' `0`)::

 
 Enable/disable Qemu GuestAgent.
 
 
 Enable/disable Qemu GuestAgent.
 

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

 
 

-Arbitrary arguments passed to kvm, for example:
-+
-args: -no-reboot -no-hpet
-+
-NOTE: this option is for experts only.
+Arbitrary arguments passed to kvm.

 
 

-`-autostart` `boolean` (default=`0`)::
+`-autostart` `<boolean>` ('default =' `0`)::

 
 Automatic restart after crash (currently ignored).
 
 
 Automatic restart after crash (currently ignored).
 

-`-balloon` `integer (0 - N)` ::
+`-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 MB. Using zero disables the ballon driver.

 
 

-`-bios` `(ovmf | seabios)` (default=`seabios`)::
+`-bios` `<ovmf | seabios>` ('default =' `seabios`)::

 
 Select BIOS implementation.
 
 
 Select BIOS implementation.
 

-`-boot` `[acdn]{1,4}` (default=`cdn`)::
+`-boot` `[acdn]{1,4}` ('default =' `cdn`)::

 
 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
 
 
 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
 


@@ -726,102 +657,81 @@ Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
 
 Enable booting from specified disk.
 
 
 Enable booting from specified disk.
 

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

 
 This is an alias for option -ide2
 
 
 This is an alias for option -ide2
 

-`-cores` `integer (1 - N)` (default=`1`)::
+`-cores` `<integer> (1 - N)` ('default =' `1`)::

 
 The number of cores per socket.
 
 
 The number of cores per socket.
 

-`-cpu` `[cputype=]<cputype> [,hidden=<1|0>]` ::
+`-cpu` `[cputype=]<enum> [,hidden=<1|0>]` ::

 
 Emulated CPU type.
 
 
 Emulated CPU type.
 

-`-cpulimit` `number (0 - 128)` (default=`0`)::
+`-cpulimit` `<number> (0 - 128)` ('default =' `0`)::

 
 Limit of CPU usage.
 
 Limit of CPU usage.

-+
-NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0'
-indicates no CPU limit.

 
 

-`-cpuunits` `integer (0 - 500000)` (default=`1000`)::
+`-cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::

 
 

-CPU weight for a VM. Argument is used in the kernel fair scheduler. The
-larger the number is, the more CPU time this VM gets. Number is relative to
-weights of all the other running VMs.
-+
-NOTE: You can disable fair-scheduler configuration by setting this to 0.
+CPU weight for a VM.

 
 

-`-delete` `string` ::
+`-delete` `<string>` ::

 
 A list of settings you want to delete.
 
 
 A list of settings you want to delete.
 

-`-description` `string` ::
+`-description` `<string>` ::

 
 

-Description for the VM. Only used on the configuration web interface. This
-is saved as comment inside the configuration file.
+Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.

 
 

-`-digest` `string` ::
+`-digest` `<string>` ::

 
 

-Prevent changes if current configuration file has different SHA1 digest.
-This can be used to prevent concurrent modifications.
+Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.

 
 

-`-force` `boolean` ::
+`-efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::

 
 

-Force physical removal. Without this, we simple remove the disk from the
-config file and create an additional configuration entry called
-'unused[n]', which contains the volume ID. Unlink of unused[n] always cause
-physical removal.
+Configure a Disk for storing EFI vars
+
+`-force` `<boolean>` ::
+
+Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal.

 +
 NOTE: Requires option(s): `delete`
 
 +
 NOTE: Requires option(s): `delete`
 

-`-freeze` `boolean` ::
+`-freeze` `<boolean>` ::

 
 Freeze CPU at startup (use 'c' monitor command to start execution).
 
 
 Freeze CPU at startup (use 'c' monitor command to start execution).
 

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

 
 

-Map host pci devices. HOSTPCIDEVICE syntax is:
-+
-'bus:dev.func' (hexadecimal numbers)
-+
-You can us the 'lspci' command to list existing pci devices.
-+
-The 'rombar' option determines whether or not the device's ROM will be
-visible in the guest's memory map (default is 'on').
-+
-NOTE: This option allows direct access to host hardware. So it is no longer
-possible to migrate such machines - use with special care.
-+
-Experimental: user reported problems with this option.
+Map host PCI devices into guest.
+
+`-hotplug` `<string>` ('default =' `network,disk,usb`)::
+
+Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'.

 
 

-`-hotplug` `string` (default=`network,disk,usb`)::
+`-hugepages` `<1024 | 2 | any>` ::

 
 

-Selectively enable hotplug features. This is a comma separated list of
-hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to
-disable hotplug completely. Value '1' is an alias for the default
-'network,disk,usb'.
+Enable/disable hugepages memory.

 
 

-`-ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
+`-ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_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_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::

 
 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
 
 
 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
 

-`-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)` (default=`en-us`)::
+`-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>` ('default =' `en-us`)::

 
 

-Keybord layout for vnc server. Default is read from the datacenter
-configuration file.
+Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.

 
 

-`-kvm` `boolean` (default=`1`)::
+`-kvm` `<boolean>` ('default =' `1`)::

 
 Enable/disable KVM hardware virtualization.
 
 
 Enable/disable KVM hardware virtualization.
 

-`-localtime` `boolean` ::
+`-localtime` `<boolean>` ::

 
 

-Set the real time clock to local time. This is enabled by default if ostype
-indicates a Microsoft OS.
+Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.

 
 

-`-lock` `(backup | migrate | rollback | snapshot)` ::
+`-lock` `<backup | migrate | rollback | snapshot>` ::

 
 Lock/unlock the VM.
 
 
 Lock/unlock the VM.
 


@@ -829,222 +739,137 @@ Lock/unlock the VM.
 
 Specific the Qemu machine type.
 
 
 Specific the Qemu machine type.
 

-`-memory` `integer (16 - N)` (default=`512`)::
+`-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 MB. This is the maximum available memory when you use the balloon device.

 
 

-`-migrate_downtime` `number (0 - N)` (default=`0.1`)::
+`-migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::

 
 Set maximum tolerated downtime (in seconds) for migrations.
 
 
 Set maximum tolerated downtime (in seconds) for migrations.
 

-`-migrate_speed` `integer (0 - N)` (default=`0`)::
+`-migrate_speed` `<integer> (0 - N)` ('default =' `0`)::

 
 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
 
 
 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
 

-`-name` `string` ::
+`-name` `<string>` ::

 
 Set a name for the VM. Only used on the configuration web interface.
 
 
 Set a name for the VM. Only used on the configuration web interface.
 

-`-net[n]` `string` ::
+`-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>]` ::

 
 Specify network devices.
 
 Specify network devices.

-+
-MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551
-i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3
-+
-XX:XX:XX:XX:XX:XX should be an unique MAC address. This is
-automatically generated if not specified.
-+
-The bridge parameter can be used to automatically add the interface to a
-bridge device. The Proxmox VE standard bridge is called 'vmbr0'.
-+
-Option 'rate' is used to limit traffic bandwidth from and to this
-interface. It is specified as floating point number, unit is 'Megabytes per
-second'.
-+
-If you specify no bridge, we create a kvm 'user' (NATed) network device,
-which provides DHCP and DNS services. The following addresses are used:
-+
-10.0.2.2   Gateway
-10.0.2.3   DNS Server
-10.0.2.4   SMB Server
-+
-The DHCP server assign addresses to the guest starting from 10.0.2.15.

 
 

-`-numa` `boolean` (default=`0`)::
+`-numa` `<boolean>` ('default =' `0`)::

 
 Enable/disable NUMA.
 
 
 Enable/disable NUMA.
 

-`-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<mb>] [,policy=<preferred|bind|interleave>]` ::
+`-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::

 
 

-numa topology
+NUMA topology.

 
 

-`-onboot` `boolean` (default=`0`)::
+`-onboot` `<boolean>` ('default =' `0`)::

 
 Specifies whether a VM will be started during system bootup.
 
 
 Specifies whether a VM will be started during system bootup.
 

-`-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` ::
+`-ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::

 
 

-Used to enable special optimization/features for specific
-operating systems:
-+
-other  => unspecified OS
-wxp    => Microsoft Windows XP
-w2k    => Microsoft Windows 2000
-w2k3   => Microsoft Windows 2003
-w2k8   => Microsoft Windows 2008
-wvista => Microsoft Windows Vista
-win7   => Microsoft Windows 7
-win8   => Microsoft Windows 8/2012
-l24    => Linux 2.4 Kernel
-l26    => Linux 2.6/3.X Kernel
-solaris => solaris/opensolaris/openindiania kernel
-+
-other|l24|l26|solaris                      ... no special behaviour
-wxp|w2k|w2k3|w2k8|wvista|win7|win8  ... use --localtime switch
+Specify guest operating system.

 
 `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
 
 Map host parallel devices (n is 0 to 2).
 
 `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
 
 Map host parallel devices (n is 0 to 2).

-+
-NOTE: This option allows direct access to host hardware. So it is no longer
-possible to migrate such machines - use with special care.
-+
-Experimental: user reported problems with this option.

 
 

-`-protection` `boolean` (default=`0`)::
+`-protection` `<boolean>` ('default =' `0`)::

 
 

-Sets the protection flag of the VM. This will prevent the remove operation.
+Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.

 
 

-`-reboot` `boolean` (default=`1`)::
+`-reboot` `<boolean>` ('default =' `1`)::

 
 Allow reboot. If set to '0' the VM exit on reboot.
 
 
 Allow reboot. If set to '0' the VM exit on reboot.
 

-`-revert` `string` ::
+`-revert` `<string>` ::

 
 Revert a pending change.
 
 
 Revert a pending change.
 

-`-sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
+`-sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_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_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::

 
 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
 
 
 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
 

-`-scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<off|on>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<nbqueues>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
+`-scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_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_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,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>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::

 
 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 13).
 

-`-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`)::

 
 

-scsi controller model
+SCSI controller model

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

-Create a serial device inside the VM (n is 0 to 3), and pass through a host
-serial device (i.e. /dev/ttyS0), or create a unix socket on the host side
-(use 'qm terminal' to open a terminal connection).
-+
-NOTE: If you pass through a host serial device, it is no longer possible to
-migrate such machines - use with special care.
-+
-Experimental: user reported problems with this option.
+Create a serial device inside the VM (n is 0 to 3)

 
 

-`-shares` `integer (0 - 50000)` (default=`1000`)::
+`-shares` `<integer> (0 - 50000)` ('default =' `1000`)::

 
 

-Amount of memory shares for auto-ballooning. The larger the number is, the
-more memory this VM gets. Number is relative to weights of all other
-running VMs. Using zero disables auto-ballooning
+Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning

 
 

-`-skiplock` `boolean` ::
+`-skiplock` `<boolean>` ::

 
 Ignore locks - only root is allowed to use this option.
 
 
 Ignore locks - only root is allowed to use this option.
 

-`-smbios1` `[family=<str>] [,manufacturer=<name>] [,product=<name>] [,serial=<str>] [,sku=<str>] [,uuid=<UUID>] [,version=<str>]` ::
+`-smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::

 
 Specify SMBIOS type 1 fields.
 
 
 Specify SMBIOS type 1 fields.
 

-`-smp` `integer (1 - N)` (default=`1`)::
+`-smp` `<integer> (1 - N)` ('default =' `1`)::

 
 The number of CPUs. Please use option -sockets instead.
 
 
 The number of CPUs. Please use option -sockets instead.
 

-`-sockets` `integer (1 - N)` (default=`1`)::
+`-sockets` `<integer> (1 - N)` ('default =' `1`)::

 
 The number of CPU sockets.
 
 
 The number of CPU sockets.
 

-`-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+] ` ::
 

-Startup and shutdown behavior. Order is a non-negative number defining the
-general startup order. Shutdown in done with reverse ordering. Additionally
-you can set the 'up' or 'down' delay in seconds, which specifies a delay to
-wait before the next VM is started or stopped.
+Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.

 
 

-`-tablet` `boolean` (default=`1`)::
+`-tablet` `<boolean>` ('default =' `1`)::

 
 

-Enable/disable the USB tablet device. This device is usually needed to
-allow absolute mouse positioning with VNC. Else the mouse runs out of sync
-with normal VNC clients. If you're running lots of console-only guests on
-one host, you may consider disabling this to save some context switches.
-This is turned off by default if you use spice (-vga=qxl).
+Enable/disable the USB tablet device.

 
 

-`-tdf` `boolean` (default=`0`)::
+`-tdf` `<boolean>` ('default =' `0`)::

 
 Enable/disable time drift fix.
 
 
 Enable/disable time drift fix.
 

-`-template` `boolean` (default=`0`)::
+`-template` `<boolean>` ('default =' `0`)::

 
 Enable/disable Template.
 
 
 Enable/disable Template.
 

-`-unused[n]` `string` ::
+`-unused[n]` `<string>` ::

 
 

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

 
 

-`-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<yes|no>]` ::
+`-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::

 
 

-Configure an USB device (n is 0 to 4). This can be used to
-pass-through usb devices to the guest. HOSTUSBDEVICE syntax is:
-+
-'bus-port(.port)*' (decimal numbers) or
-'vendor_id:product_id' (hexadeciaml numbers) or
-'spice'
-+
-You can use the 'lsusb -t' command to list existing usb devices.
-+
-NOTE: This option allows direct access to host hardware. So it is no longer
-possible to migrate such machines - use with special care.
-+
-The value 'spice' can be used to add a usb redirection devices for spice.
-+
-The 'usb3' option determines whether the device is a USB3 device or not
-(this does currently not work reliably with spice redirection and is then
-ignored).
+Configure an USB device (n is 0 to 4).

 
 

-`-vcpus` `integer (1 - N)` (default=`0`)::
+`-vcpus` `<integer> (1 - N)` ('default =' `0`)::

 
 Number of hotplugged vcpus.
 
 
 Number of hotplugged vcpus.
 

-`-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
+`-vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` ::

 
 

-Select the VGA type. If you want to use high resolution modes (>=
-1280x1024x16) then you should use the options 'std' or 'vmware'. Default is
-'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option
-enables the SPICE display sever. For win* OS you can select how many
-independent displays you want, Linux guests can add displays them self. You
-can also run without any graphic card, using a serial device as terminal.
+Select the VGA type.

 
 

-`-virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<off|on>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
+`-virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_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_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,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>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::

 
 Use volume as VIRTIO hard disk (n is 0 to 15).
 
 
 Use volume as VIRTIO hard disk (n is 0 to 15).
 

-`-watchdog` `[action=<reset|shutdown|poweroff|pause|debug|none>] [,[model=]<i6300esb|ib700>]` ::
+`-watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::

 
 

-Create a virtual hardware watchdog device. Once enabled (by a guest
-action), the watchdog must be periodically polled by an agent inside the
-guest or else the watchdog will reset the guest (or execute the respective
-action specified)
+Create a virtual hardware watchdog device.

 
 
 
 
 
 


@@ -1053,7 +878,7 @@ action specified)
 
 Show command line which is used to start the VM (debug info).
 
 
 Show command line which is used to start the VM (debug info).
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 


@@ -1066,23 +891,23 @@ Shutdown virtual machine. This is similar to pressing the power button on a
 physical machine.This will send an ACPI event for the guest OS, which
 should then proceed to a clean shutdown.
 
 physical machine.This will send an ACPI event for the guest OS, which
 should then proceed to a clean shutdown.
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`-forceStop` `boolean` (default=`0`)::
+`-forceStop` `<boolean>` ('default =' `0`)::

 
 Make sure the VM stops.
 
 
 Make sure the VM stops.
 

-`-keepActive` `boolean` (default=`0`)::
+`-keepActive` `<boolean>` ('default =' `0`)::

 
 

-Do not decativate storage volumes.
+Do not deactivate storage volumes.

 
 

-`-skiplock` `boolean` ::
+`-skiplock` `<boolean>` ::

 
 Ignore locks - only root is allowed to use this option.
 
 
 Ignore locks - only root is allowed to use this option.
 

-`-timeout` `integer (0 - N)` ::
+`-timeout` `<integer> (0 - N)` ::

 
 Wait maximal timeout seconds.
 
 
 Wait maximal timeout seconds.
 


@@ -1092,19 +917,19 @@ Wait maximal timeout seconds.
 
 Snapshot a VM.
 
 
 Snapshot a VM.
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`<snapname>` `string` ::
+`<snapname>`: `<string>` ::

 
 The name of the snapshot.
 
 
 The name of the snapshot.
 

-`-description` `string` ::
+`-description` `<string>` ::

 
 A textual description or comment.
 
 
 A textual description or comment.
 

-`-vmstate` `boolean` ::
+`-vmstate` `<boolean>` ::

 
 Save the vmstate
 
 
 Save the vmstate
 


@@ -1114,7 +939,7 @@ Save the vmstate
 
 Start virtual machine.
 
 
 Start virtual machine.
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 


@@ -1122,18 +947,30 @@ The (unique) ID of the VM.
 
 Specific the Qemu machine type.
 
 
 Specific the Qemu machine type.
 

-`-migratedfrom` `string` ::
+`-migratedfrom` `<string>` ::

 
 The cluster node name.
 
 
 The cluster node name.
 

-`-skiplock` `boolean` ::
+`-migration_network` `<string>` ::
+
+CIDR of the (sub) network that is used for migration.
+
+`-migration_type` `<insecure | secure>` ::
+
+Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
+
+`-skiplock` `<boolean>` ::

 
 Ignore locks - only root is allowed to use this option.
 
 
 Ignore locks - only root is allowed to use this option.
 

-`-stateuri` `string` ::
+`-stateuri` `<string>` ::

 
 Some command save/restore state from this location.
 
 
 Some command save/restore state from this location.
 

+`-targetstorage` `<string>` ::
+
+Target storage for the migration. (Can be '1' to use the same storage id as on the source node.)
+

 
 
 
 
 
 


@@ -1141,11 +978,11 @@ Some command save/restore state from this location.
 
 Show VM status.
 
 
 Show VM status.
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`-verbose` `boolean` ::
+`-verbose` `<boolean>` ::

 
 Verbose output format
 
 
 Verbose output format
 


@@ -1157,23 +994,23 @@ Verbose output format
 Stop virtual machine. The qemu process will exit immediately. Thisis akin
 to pulling the power plug of a running computer and may damage the VM data
 
 Stop virtual machine. The qemu process will exit immediately. Thisis akin
 to pulling the power plug of a running computer and may damage the VM data
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`-keepActive` `boolean` (default=`0`)::
+`-keepActive` `<boolean>` ('default =' `0`)::

 
 

-Do not decativate storage volumes.
+Do not deactivate storage volumes.

 
 

-`-migratedfrom` `string` ::
+`-migratedfrom` `<string>` ::

 
 The cluster node name.
 
 
 The cluster node name.
 

-`-skiplock` `boolean` ::
+`-skiplock` `<boolean>` ::

 
 Ignore locks - only root is allowed to use this option.
 
 
 Ignore locks - only root is allowed to use this option.
 

-`-timeout` `integer (0 - N)` ::
+`-timeout` `<integer> (0 - N)` ::

 
 Wait maximal timeout seconds.
 
 
 Wait maximal timeout seconds.
 


@@ -1183,11 +1020,11 @@ Wait maximal timeout seconds.
 
 Suspend virtual machine.
 
 
 Suspend virtual machine.
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`-skiplock` `boolean` ::
+`-skiplock` `<boolean>` ::

 
 Ignore locks - only root is allowed to use this option.
 
 
 Ignore locks - only root is allowed to use this option.
 


@@ -1197,11 +1034,11 @@ Ignore locks - only root is allowed to use this option.
 
 Create a Template.
 
 
 Create a Template.
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`-disk` `(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 | scsi2 | scsi3 | 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.
 


@@ -1213,14 +1050,13 @@ If you want to convert only 1 disk to base image.
 Open a terminal using a serial device (The VM need to have a serial device
 configured, for example 'serial0: socket')
 
 Open a terminal using a serial device (The VM need to have a serial device
 configured, for example 'serial0: socket')
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`-iface` `(serial0 | serial1 | serial2 | serial3)` ::
+`-iface` `<serial0 | serial1 | serial2 | serial3>` ::

 
 

-Select the serial device. By default we simply use the first suitable
-device.
+Select the serial device. By default we simply use the first suitable device.

 
 
 
 
 
 


@@ -1229,18 +1065,15 @@ device.
 
 Unlink/delete disk images.
 
 
 Unlink/delete disk images.
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`-force` `boolean` ::
+`-force` `<boolean>` ::

 
 

-Force physical removal. Without this, we simple remove the disk from the
-config file and create an additional configuration entry called
-'unused[n]', which contains the volume ID. Unlink of unused[n] always cause
-physical removal.
+Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal.

 
 

-`-idlist` `string` ::
+`-idlist` `<string>` ::

 
 A list of disk IDs you want to delete.
 
 
 A list of disk IDs you want to delete.
 


@@ -1251,7 +1084,7 @@ A list of disk IDs you want to delete.
 
 Unlock the VM.
 
 
 Unlock the VM.
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 


@@ -1261,7 +1094,7 @@ The (unique) ID of the VM.
 
 Proxy VM VNC traffic to stdin/stdout
 
 
 Proxy VM VNC traffic to stdin/stdout
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 


@@ -1271,11 +1104,11 @@ The (unique) ID of the VM.
 
 Wait until the VM is stopped.
 
 
 Wait until the VM is stopped.
 

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

 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`-timeout` `integer (1 - N)` ::
+`-timeout` `<integer> (1 - N)` ::

 
 Timeout in seconds. Default is to wait forever.
 
 
 Timeout in seconds. Default is to wait forever.