Document new SSD emulation feature

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

diff --git a/qm.1-synopsis.adoc b/qm.1-synopsis.adoc
index 054436e45dbb91ac3a33162240954d25d20f5433..dbbbd8d0bfe2c69c557cb446822f12eddc2aecbb 100644 (file)
--- a/qm.1-synopsis.adoc
+++ b/qm.1-synopsis.adoc
@@ -1,18 +1,8 @@
 *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 agent*

 
 

+An alias for 'qm guest cmd'.

 
 *qm clone* `<vmid> <newid>` `[OPTIONS]`
 
 
 *qm clone* `<vmid> <newid>` `[OPTIONS]`
 


@@ -32,13 +22,11 @@ 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. Only valid for full clone.

 
 

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

 
 

-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 disks. 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>` ::
 


@@ -55,15 +43,11 @@ The name of the snapshot.
 `--storage` `<string>` ::
 
 Target storage for full clone.
 `--storage` `<string>` ::
 
 Target storage for full clone.

-+
-NOTE: Requires option(s): `full`

 
 `--target` `<string>` ::
 
 Target node. Only allowed if the original VM is on shared storage.
 
 
 `--target` `<string>` ::
 
 Target node. Only allowed if the original VM is on shared storage.
 

-
-

 *qm config* `<vmid>` `[OPTIONS]`
 
 Get current virtual machine configuration. This does not include pending
 *qm config* `<vmid>` `[OPTIONS]`
 
 Get current virtual machine configuration. This does not include pending


@@ -77,8 +61,6 @@ The (unique) ID of the VM.
 
 Get current values (instead of pending values).
 
 
 Get current values (instead of pending values).
 

-
-

 *qm create* `<vmid>` `[OPTIONS]`
 
 Create or restore a virtual machine.
 *qm create* `<vmid>` `[OPTIONS]`
 
 Create or restore a virtual machine.


@@ -91,9 +73,9 @@ The (unique) ID of the VM.
 
 Enable/disable ACPI.
 
 
 Enable/disable ACPI.
 

-`--agent` `<boolean>` ('default =' `0`)::
+`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]` ::

 
 

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

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


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

+`--bwlimit` `<integer> (0 - N)` ::
+
+Override i/o bandwidth limit (in KiB/s).
+

 `--cdrom` `<volume>` ::
 
 This is an alias for option -ide2
 
 `--cdrom` `<volume>` ::
 
 This is an alias for option -ide2
 

+`--cipassword` `<password>` ::
+
+cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.
+
+`--citype` `<configdrive2 | nocloud>` ::
+
+Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows.
+
+`--ciuser` `<string>` ::
+
+cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
+

 `--cores` `<integer> (1 - N)` ('default =' `1`)::
 
 The number of cores per socket.
 
 `--cores` `<integer> (1 - N)` ('default =' `1`)::
 
 The number of cores per socket.
 

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

 
 Emulated CPU type.
 
 
 Emulated CPU type.
 


@@ -173,13 +171,24 @@ Selectively enable hotplug features. This is a comma separated list of hotplug f
 
 Enable/disable hugepages memory.
 
 
 Enable/disable hugepages memory.
 

-`--ide[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>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
+`--ide[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>] [,model=<model>] [,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>]` ::

 
 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`)::
+`--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
+
+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.
++
+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.
++
+If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.

 
 

-Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
+`--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.

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


@@ -195,7 +204,7 @@ Lock/unlock the VM.
 
 `--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
 
 
 `--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
 

-Specific the Qemu machine type.
+Specifies the Qemu machine type.

 
 `--memory` `<integer> (16 - N)` ('default =' `512`)::
 
 
 `--memory` `<integer> (16 - N)` ('default =' `512`)::
 


@@ -213,6 +222,10 @@ Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
 
 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.
 

+`--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.
+

 `--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.
 `--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.


@@ -249,11 +262,11 @@ 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.
 

-`--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>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
+`--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>]` ::

 
 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=<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>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
+`--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>]` ::

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


@@ -261,13 +274,17 @@ Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
 
 SCSI controller model
 
 
 SCSI controller model
 

+`--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.
+

 `--serial[n]` `(/dev/.+|socket)` ::
 
 Create a serial device inside the VM (n is 0 to 3)
 
 `--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
 
 `--serial[n]` `(/dev/.+|socket)` ::
 
 Create a serial device inside the VM (n is 0 to 3)
 
 `--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. Auto-ballooning is done by pvestatd.

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


@@ -281,6 +298,14 @@ The number of CPUs. Please use option -sockets instead.
 
 The number of CPU sockets.
 
 
 The number of CPU sockets.
 

+`--sshkeys` `<filepath>` ::
+
+cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
+
+`--start` `<boolean>` ('default =' `0`)::
+
+Start VM after it was created successfully.
+

 `--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'.
 `--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'.


@@ -323,14 +348,18 @@ Configure an USB device (n is 0 to 4).
 
 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 | virtio | vmware>` ::

 
 Select the VGA type.
 
 
 Select the VGA type.
 

-`--virtio[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>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
+`--virtio[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>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,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).
 

+`--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
+
+Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
+

 `--vmstatestorage` `<string>` ::
 
 Default storage for VM state volumes/files.
 `--vmstatestorage` `<string>` ::
 
 Default storage for VM state volumes/files.


@@ -339,8 +368,6 @@ Default storage for VM state volumes/files.
 
 Create a virtual hardware watchdog device.
 
 
 Create a virtual hardware watchdog device.
 

-
-

 *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
 
 Delete a VM snapshot.
 *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
 
 Delete a VM snapshot.


@@ -357,8 +384,6 @@ The name of the snapshot.
 
 For removal from config file, even if removing disk snapshots fails.
 
 
 For removal from config file, even if removing disk snapshots fails.
 

-
-

 *qm destroy* `<vmid>` `[OPTIONS]`
 
 Destroy the vm (also delete all used/owned volumes).
 *qm destroy* `<vmid>` `[OPTIONS]`
 
 Destroy the vm (also delete all used/owned volumes).


@@ -371,23 +396,77 @@ The (unique) ID of the VM.
 
 Ignore locks - only root is allowed to use this option.
 
 
 Ignore locks - only root is allowed to use this option.
 

+*qm guest cmd* `<vmid> <command>`
+
+Execute Qemu Guest Agent commands.

 
 

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

 
 

+The (unique) ID of the VM.

 
 

-*qm help* `[<cmd>]` `[OPTIONS]`
+`<command>`: `<fsfreeze-freeze | fsfreeze-status | fsfreeze-thaw | fstrim | get-fsinfo | get-host-name | get-memory-block-info | get-memory-blocks | get-osinfo | get-time | get-timezone | get-users | get-vcpus | info | network-get-interfaces | ping | shutdown | suspend-disk | suspend-hybrid | suspend-ram>` ::

 
 

-Get help about specified command.
+The QGA command.

 
 

-`<cmd>`: `<string>` ::
+*qm guest exec* `<vmid> [<extra-args>]` `[OPTIONS]`

 
 

-Command name
+Executes the given command via the guest agent

 
 

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

 
 

-Verbose output format.
+The (unique) ID of the VM.
+
+`<extra-args>`: `<array>` ::
+
+Extra arguments as array
+
+`--synchronous` `<boolean>` ('default =' `1`)::

 
 

+If set to off, returns the pid immediately instead of waiting for the commmand to finish or the timeout.

 
 

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

 
 

+The maximum time to wait synchronously for the command to finish. If reached, the pid gets returned. Set to 0 to deactivate
+
+*qm guest exec-status* `<vmid> <pid>`
+
+Gets the status of the given pid started by the guest-agent
+
+`<vmid>`: `<integer> (1 - N)` ::
+
+The (unique) ID of the VM.
+
+`<pid>`: `<integer>` ::
+
+The PID to query
+
+*qm guest passwd* `<vmid> <username>` `[OPTIONS]`
+
+Sets the password for the given user to the given password
+
+`<vmid>`: `<integer> (1 - N)` ::
+
+The (unique) ID of the VM.
+
+`<username>`: `<string>` ::
+
+The user to set the password for.
+
+`--crypted` `<boolean>` ('default =' `0`)::
+
+set to 1 if the password has already been passed through crypt()
+
+*qm help* `[OPTIONS]`
+
+Get help about specified command.
+
+`--extra-args` `<array>` ::
+
+Shows help for a specific command
+
+`--verbose` `<boolean>` ::
+
+Verbose output format.

 
 *qm importdisk* `<vmid> <source> <storage>` `[OPTIONS]`
 
 
 *qm importdisk* `<vmid> <source> <storage>` `[OPTIONS]`
 


@@ -410,8 +489,6 @@ Target storage ID
 
 Target format
 
 
 Target format
 

-
-

 *qm importovf* `<vmid> <manifest> <storage>` `[OPTIONS]`
 
 Create a new VM using parameters read from an OVF manifest
 *qm importovf* `<vmid> <manifest> <storage>` `[OPTIONS]`
 
 Create a new VM using parameters read from an OVF manifest


@@ -436,9 +513,6 @@ Print a parsed representation of the extracted OVF parameters, but do not create
 
 Target format
 
 
 Target format
 

-
-
-

 *qm list* `[OPTIONS]`
 
 Virtual machine index (per node).
 *qm list* `[OPTIONS]`
 
 Virtual machine index (per node).


@@ -447,8 +521,6 @@ Virtual machine index (per node).
 
 Determine the full status of active VMs.
 
 
 Determine the full status of active VMs.
 

-
-

 *qm listsnapshot* `<vmid>`
 
 List all snapshots.
 *qm listsnapshot* `<vmid>`
 
 List all snapshots.


@@ -457,8 +529,6 @@ List all snapshots.
 
 The (unique) ID of the VM.
 
 
 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.


@@ -495,9 +565,6 @@ Default target storage.
 
 Enable live storage migration for local disk
 
 
 Enable live storage migration for local disk
 

-
-
-

 *qm monitor* `<vmid>`
 
 Enter Qemu Monitor interface.
 *qm monitor* `<vmid>`
 
 Enter Qemu Monitor interface.


@@ -506,9 +573,6 @@ Enter Qemu Monitor interface.
 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-
-
-

 *qm move_disk* `<vmid> <disk> <storage>` `[OPTIONS]`
 
 Move volume to different storage.
 *qm move_disk* `<vmid> <disk> <storage>` `[OPTIONS]`
 
 Move volume to different storage.


@@ -537,15 +601,10 @@ Prevent changes if current configuration file has different SHA1 digest. This ca
 
 Target Format.
 
 
 Target Format.
 

-
-
-

 *qm mtunnel*
 
 Used by qmigrate - do not use manually.
 
 *qm mtunnel*
 
 Used by qmigrate - do not use manually.
 

-
-

 *qm nbdstop* `<vmid>`
 
 Stop embedded nbd server.
 *qm nbdstop* `<vmid>`
 
 Stop embedded nbd server.


@@ -554,9 +613,6 @@ Stop embedded nbd server.
 
 The (unique) ID of the VM.
 
 
 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.


@@ -565,19 +621,17 @@ Get virtual machine configuration, including pending changes.
 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-
-
-

 *qm rescan* `[OPTIONS]`
 
 Rescan all storages and update disk sizes and unused disk images.
 
 *qm rescan* `[OPTIONS]`
 
 Rescan all storages and update disk sizes and unused disk images.
 

-`--vmid` `<integer> (1 - N)` ::
-
-The (unique) ID of the VM.
+`--dryrun` `<boolean>` ('default =' `0`)::

 
 

+Do not actually write changes out to VM config(s).

 
 

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

 
 

+The (unique) ID of the VM.

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


@@ -591,8 +645,6 @@ The (unique) ID of the VM.
 
 Ignore locks - only root is allowed to use this option.
 
 
 Ignore locks - only root is allowed to use this option.
 

-
-

 *qm resize* `<vmid> <disk> <size>` `[OPTIONS]`
 
 Extend volume size.
 *qm resize* `<vmid> <disk> <size>` `[OPTIONS]`
 
 Extend volume size.


@@ -617,8 +669,6 @@ Prevent changes if current configuration file has different SHA1 digest. This ca
 
 Ignore locks - only root is allowed to use this option.
 
 
 Ignore locks - only root is allowed to use this option.
 

-
-

 *qm resume* `<vmid>` `[OPTIONS]`
 
 Resume virtual machine.
 *qm resume* `<vmid>` `[OPTIONS]`
 
 Resume virtual machine.


@@ -635,8 +685,6 @@ no description available
 
 Ignore locks - only root is allowed to use this option.
 
 
 Ignore locks - only root is allowed to use this option.
 

-
-

 *qm rollback* `<vmid> <snapname>`
 
 Rollback VM state to specified snapshot.
 *qm rollback* `<vmid> <snapname>`
 
 Rollback VM state to specified snapshot.


@@ -649,8 +697,6 @@ The (unique) ID of the VM.
 
 The name of the snapshot.
 
 
 The name of the snapshot.
 

-
-

 *qm sendkey* `<vmid> <key>` `[OPTIONS]`
 
 Send key event to virtual machine.
 *qm sendkey* `<vmid> <key>` `[OPTIONS]`
 
 Send key event to virtual machine.


@@ -667,8 +713,6 @@ The key (qemu monitor encoding).
 
 Ignore locks - only root is allowed to use this option.
 
 
 Ignore locks - only root is allowed to use this option.
 

-
-

 *qm set* `<vmid>` `[OPTIONS]`
 
 Set virtual machine options (synchrounous API) - You should consider using
 *qm set* `<vmid>` `[OPTIONS]`
 
 Set virtual machine options (synchrounous API) - You should consider using


@@ -683,9 +727,9 @@ The (unique) ID of the VM.
 
 Enable/disable ACPI.
 
 
 Enable/disable ACPI.
 

-`--agent` `<boolean>` ('default =' `0`)::
+`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]` ::

 
 

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

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


@@ -715,11 +759,23 @@ Enable booting from specified disk.
 
 This is an alias for option -ide2
 
 
 This is an alias for option -ide2
 

+`--cipassword` `<password>` ::
+
+cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.
+
+`--citype` `<configdrive2 | nocloud>` ::
+
+Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows.
+
+`--ciuser` `<string>` ::
+
+cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
+

 `--cores` `<integer> (1 - N)` ('default =' `1`)::
 
 The number of cores per socket.
 
 `--cores` `<integer> (1 - N)` ('default =' `1`)::
 
 The number of cores per socket.
 

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

 
 Emulated CPU type.
 
 
 Emulated CPU type.
 


@@ -769,13 +825,24 @@ Selectively enable hotplug features. This is a comma separated list of hotplug f
 
 Enable/disable hugepages memory.
 
 
 Enable/disable hugepages memory.
 

-`--ide[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>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
+`--ide[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>] [,model=<model>] [,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>]` ::

 
 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`)::
+`--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
+
+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.
++
+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.
++
+If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.

 
 

-Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
+`--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.

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


@@ -791,7 +858,7 @@ Lock/unlock the VM.
 
 `--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
 
 
 `--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
 

-Specific the Qemu machine type.
+Specifies the Qemu machine type.

 
 `--memory` `<integer> (16 - N)` ('default =' `512`)::
 
 
 `--memory` `<integer> (16 - N)` ('default =' `512`)::
 


@@ -809,6 +876,10 @@ Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
 
 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.
 

+`--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.
+

 `--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.
 `--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.


@@ -845,11 +916,11 @@ Allow reboot. If set to '0' the VM exit on reboot.
 
 Revert a pending change.
 
 
 Revert a pending change.
 

-`--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>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
+`--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>]` ::

 
 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=<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>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
+`--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>]` ::

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


@@ -857,13 +928,17 @@ Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
 
 SCSI controller model
 
 
 SCSI controller model
 

+`--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.
+

 `--serial[n]` `(/dev/.+|socket)` ::
 
 Create a serial device inside the VM (n is 0 to 3)
 
 `--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
 
 `--serial[n]` `(/dev/.+|socket)` ::
 
 Create a serial device inside the VM (n is 0 to 3)
 
 `--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. Auto-ballooning is done by pvestatd.

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


@@ -881,6 +956,10 @@ The number of CPUs. Please use option -sockets instead.
 
 The number of CPU sockets.
 
 
 The number of CPU sockets.
 

+`--sshkeys` `<filepath>` ::
+
+cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
+

 `--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'.
 `--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'.


@@ -913,14 +992,18 @@ Configure an USB device (n is 0 to 4).
 
 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 | virtio | vmware>` ::

 
 Select the VGA type.
 
 
 Select the VGA type.
 

-`--virtio[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>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
+`--virtio[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>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,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).
 

+`--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
+
+Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
+

 `--vmstatestorage` `<string>` ::
 
 Default storage for VM state volumes/files.
 `--vmstatestorage` `<string>` ::
 
 Default storage for VM state volumes/files.


@@ -929,10 +1012,7 @@ Default storage for VM state volumes/files.
 
 Create a virtual hardware watchdog device.
 
 
 Create a virtual hardware watchdog device.
 

-
-
-
-*qm showcmd* `<vmid>`
+*qm showcmd* `<vmid>` `[OPTIONS]`

 
 Show command line which is used to start the VM (debug info).
 
 
 Show command line which is used to start the VM (debug info).
 


@@ -940,8 +1020,9 @@ Show command line which is used to start the VM (debug info).
 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

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

 
 

-
+Puts each option on a new line to enhance human readability

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


@@ -969,8 +1050,6 @@ Ignore locks - only root is allowed to use this option.
 
 Wait maximal timeout seconds.
 
 
 Wait maximal timeout seconds.
 

-
-

 *qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
 
 Snapshot a VM.
 *qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
 
 Snapshot a VM.


@@ -991,8 +1070,6 @@ A textual description or comment.
 
 Save the vmstate
 
 
 Save the vmstate
 

-
-

 *qm start* `<vmid>` `[OPTIONS]`
 
 Start virtual machine.
 *qm start* `<vmid>` `[OPTIONS]`
 
 Start virtual machine.


@@ -1003,7 +1080,7 @@ The (unique) ID of the VM.
 
 `--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
 
 
 `--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
 

-Specific the Qemu machine type.
+Specifies the Qemu machine type.

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


@@ -1029,9 +1106,6 @@ Some command save/restore state from this location.
 
 Target storage for the migration. (Can be '1' to use the same storage id as on the source node.)
 
 
 Target storage for the migration. (Can be '1' to use the same storage id as on the source node.)
 

-
-
-

 *qm status* `<vmid>` `[OPTIONS]`
 
 Show VM status.
 *qm status* `<vmid>` `[OPTIONS]`
 
 Show VM status.


@@ -1044,9 +1118,6 @@ The (unique) ID of the VM.
 
 Verbose output format
 
 
 Verbose output format
 

-
-
-

 *qm stop* `<vmid>` `[OPTIONS]`
 
 Stop virtual machine. The qemu process will exit immediately. Thisis akin
 *qm stop* `<vmid>` `[OPTIONS]`
 
 Stop virtual machine. The qemu process will exit immediately. Thisis akin


@@ -1072,8 +1143,6 @@ Ignore locks - only root is allowed to use this option.
 
 Wait maximal timeout seconds.
 
 
 Wait maximal timeout seconds.
 

-
-

 *qm suspend* `<vmid>` `[OPTIONS]`
 
 Suspend virtual machine.
 *qm suspend* `<vmid>` `[OPTIONS]`
 
 Suspend virtual machine.


@@ -1086,8 +1155,6 @@ The (unique) ID of the VM.
 
 Ignore locks - only root is allowed to use this option.
 
 
 Ignore locks - only root is allowed to use this option.
 

-
-

 *qm template* `<vmid>` `[OPTIONS]`
 
 Create a Template.
 *qm template* `<vmid>` `[OPTIONS]`
 
 Create a Template.


@@ -1100,9 +1167,6 @@ The (unique) ID of the VM.
 
 If you want to convert only 1 disk to base image.
 
 
 If you want to convert only 1 disk to base image.
 

-
-
-

 *qm terminal* `<vmid>` `[OPTIONS]`
 
 Open a terminal using a serial device (The VM need to have a serial device
 *qm terminal* `<vmid>` `[OPTIONS]`
 
 Open a terminal using a serial device (The VM need to have a serial device


@@ -1112,12 +1176,13 @@ configured, for example 'serial0: socket')
 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`--iface` `<serial0 | serial1 | serial2 | serial3>` ::
-
-Select the serial device. By default we simply use the first suitable device.
+`--escape` `<string>` ('default =' `^O`)::

 
 

+Escape character.

 
 

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

 
 

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

 
 *qm unlink* `<vmid> --idlist <string>` `[OPTIONS]`
 
 
 *qm unlink* `<vmid> --idlist <string>` `[OPTIONS]`
 


@@ -1135,9 +1200,6 @@ Force physical removal. Without this, we simple remove the disk from the config
 
 A list of disk IDs you want to delete.
 
 
 A list of disk IDs you want to delete.
 

-
-
-

 *qm unlock* `<vmid>`
 
 Unlock the VM.
 *qm unlock* `<vmid>`
 
 Unlock the VM.


@@ -1146,8 +1208,6 @@ Unlock the VM.
 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-
-

 *qm vncproxy* `<vmid>`
 
 Proxy VM VNC traffic to stdin/stdout
 *qm vncproxy* `<vmid>`
 
 Proxy VM VNC traffic to stdin/stdout


@@ -1156,8 +1216,6 @@ Proxy VM VNC traffic to stdin/stdout
 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-
-

 *qm wait* `<vmid>` `[OPTIONS]`
 
 Wait until the VM is stopped.
 *qm wait* `<vmid>` `[OPTIONS]`
 
 Wait until the VM is stopped.


@@ -1171,5 +1229,3 @@ The (unique) ID of the VM.
 Timeout in seconds. Default is to wait forever.
 
 
 Timeout in seconds. Default is to wait forever.
 
 

-
-