fixup: s/devies/devices/

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

diff --git a/qm.1-synopsis.adoc b/qm.1-synopsis.adoc
index dbbbd8d0bfe2c69c557cb446822f12eddc2aecbb..2df8cb836dd80348332e2211ce064e66357ef207 100644 (file)
--- a/qm.1-synopsis.adoc
+++ b/qm.1-synopsis.adoc
@@ -4,6 +4,23 @@
 
 An alias for 'qm guest cmd'.
 
+*qm cleanup* `<vmid> <clean-shutdown> <guest-requested>`
+
+Cleans up resources like tap devices, vgpus, etc. Called after a vm shuts
+down, crashes, etc.
+
+`<vmid>`: `<integer> (1 - N)` ::
+
+The (unique) ID of the VM.
+
+`<clean-shutdown>`: `<boolean>` ::
+
+Indicates if qemu shutdown cleanly.
+
+`<guest-requested>`: `<boolean>` ::
+
+Indicates if the shutdown was requested by the guest or via qmp.
+
 *qm clone* `<vmid> <newid>` `[OPTIONS]`
 
 Create a copy of virtual machine/template.
@@ -61,6 +78,10 @@ The (unique) ID of the VM.
 
 Get current values (instead of pending values).
 
+`--snapshot` `<string>` ::
+
+Fetch config values from given snapshot.
+
 *qm create* `<vmid>` `[OPTIONS]`
 
 Create or restore a virtual machine.
@@ -77,6 +98,10 @@ Enable/disable ACPI.
 
 Enable/disable Qemu GuestAgent and its properties.
 
+`--arch` `<aarch64 | x86_64>` ::
+
+Virtual processor architecture. Defaults to the host.
+
 `--archive` `<string>` ::
 
 The backup file.
@@ -129,7 +154,7 @@ cloud-init: User name to change ssh keys and password for instead of the image's
 
 The number of cores per socket.
 
-`--cpu` `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]` ::
+`--cpu` `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>]` ::
 
 Emulated CPU type.
 
@@ -159,7 +184,11 @@ NOTE: Requires option(s): `archive`
 
 Freeze CPU at startup (use 'c' monitor command to start execution).
 
-`--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
+`--hookscript` `<string>` ::
+
+Script that will be executed during various steps in the vms lifetime.
+
+`--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
 
 Map host PCI devices into guest.
 
@@ -198,11 +227,11 @@ Enable/disable KVM hardware virtualization.
 
 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 | clone | create | migrate | rollback | snapshot | snapshot-delete>` ::
 
 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)?|virt(?:-\d+\.\d+)?)` ::
 
 Specifies the Qemu machine type.
 
@@ -348,9 +377,9 @@ Configure an USB device (n is 0 to 4).
 
 Number of hotplugged vcpus.
 
-`--vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | virtio | vmware>` ::
+`--vga` `[[type=]<enum>] [,memory=<integer>]` ::
 
-Select the VGA type.
+Configure the VGA hardware.
 
 `--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>]` ::
 
@@ -731,6 +760,10 @@ Enable/disable ACPI.
 
 Enable/disable Qemu GuestAgent and its properties.
 
+`--arch` `<aarch64 | x86_64>` ::
+
+Virtual processor architecture. Defaults to the host.
+
 `--args` `<string>` ::
 
 Arbitrary arguments passed to kvm.
@@ -775,7 +808,7 @@ cloud-init: User name to change ssh keys and password for instead of the image's
 
 The number of cores per socket.
 
-`--cpu` `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]` ::
+`--cpu` `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>]` ::
 
 Emulated CPU type.
 
@@ -813,7 +846,11 @@ NOTE: Requires option(s): `delete`
 
 Freeze CPU at startup (use 'c' monitor command to start execution).
 
-`--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
+`--hookscript` `<string>` ::
+
+Script that will be executed during various steps in the vms lifetime.
+
+`--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
 
 Map host PCI devices into guest.
 
@@ -852,11 +889,11 @@ Enable/disable KVM hardware virtualization.
 
 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 | clone | create | migrate | rollback | snapshot | snapshot-delete>` ::
 
 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)?|virt(?:-\d+\.\d+)?)` ::
 
 Specifies the Qemu machine type.
 
@@ -992,9 +1029,9 @@ Configure an USB device (n is 0 to 4).
 
 Number of hotplugged vcpus.
 
-`--vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | virtio | vmware>` ::
+`--vga` `[[type=]<enum>] [,memory=<integer>]` ::
 
-Select the VGA type.
+Configure the VGA hardware.
 
 `--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>]` ::
 
@@ -1024,6 +1061,10 @@ The (unique) ID of the VM.
 
 Puts each option on a new line to enhance human readability
 
+`--snapshot` `<string>` ::
+
+Fetch config values from given snapshot.
+
 *qm shutdown* `<vmid>` `[OPTIONS]`
 
 Shutdown virtual machine. This is similar to pressing the power button on a
@@ -1078,7 +1119,7 @@ Start virtual machine.
 
 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)?|virt(?:-\d+\.\d+)?)` ::
 
 Specifies the Qemu machine type.