pveum: improve tfa section

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

diff --git a/qm.1-synopsis.adoc b/qm.1-synopsis.adoc
index 0b579244bee28f0d9ccf8c9378eec0cb4bf77ead..191eb99e3825c7cf17f1c26bd81c05e2a57e0baa 100644 (file)
--- a/qm.1-synopsis.adoc
+++ b/qm.1-synopsis.adoc
@@ -69,6 +69,18 @@ Target storage for full clone.
 
 Target node. Only allowed if the original VM is on shared storage.
 
+*qm cloudinit dump* `<vmid> <type>`
+
+Get automatically generated cloudinit config.
+
+`<vmid>`: `<integer> (1 - N)` ::
+
+The (unique) ID of the VM.
+
+`<type>`: `<meta | network | user>` ::
+
+Config type.
+
 *qm config* `<vmid>` `[OPTIONS]`
 
 Get current virtual machine configuration. This does not include pending
@@ -98,7 +110,7 @@ The (unique) ID of the VM.
 
 Enable/disable ACPI.
 
-`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]` ::
+`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
 
 Enable/disable Qemu GuestAgent and its properties.
 
@@ -114,6 +126,10 @@ The backup file.
 
 Arbitrary arguments passed to kvm.
 
+`--audio0` `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice>]` ::
+
+Configure a audio device, useful in combination with QXL/Spice.
+
 `--autostart` `<boolean>` ('default =' `0`)::
 
 Automatic restart after crash (currently ignored).
@@ -243,7 +259,7 @@ Set the real time clock to local time. This is enabled by default if ostype indi
 
 Lock/unlock the VM.
 
-`--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?|virt(?:-\d+\.\d+)?)` ::
+`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
 
 Specifies the Qemu machine type.
 
@@ -327,7 +343,7 @@ Create a serial device inside the VM (n is 0 to 3)
 
 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` `[base64=<1|0>] [,family=<Base64 encoded string>] [,manufacturer=<Base64 encoded string>] [,product=<Base64 encoded string>] [,serial=<Base64 encoded string>] [,sku=<Base64 encoded string>] [,uuid=<UUID>] [,version=<Base64 encoded string>]` ::
 
 Specify SMBIOS type 1 fields.
 
@@ -339,6 +355,10 @@ The number of CPUs. Please use option -sockets instead.
 
 The number of CPU sockets.
 
+`--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
+
+Configure additional enhancements for SPICE.
+
 `--sshkeys` `<filepath>` ::
 
 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
@@ -363,6 +383,10 @@ Default storage.
 
 Enable/disable the USB tablet device.
 
+`--tags` `<string>` ::
+
+Tags of the VM. This is only meta information.
+
 `--tdf` `<boolean>` ('default =' `0`)::
 
 Enable/disable time drift fix.
@@ -433,6 +457,10 @@ Destroy the vm (also delete all used/owned volumes).
 
 The (unique) ID of the VM.
 
+`--purge` `<boolean>` ::
+
+Remove vmid from backup cron jobs.
+
 `--skiplock` `<boolean>` ::
 
 Ignore locks - only root is allowed to use this option.
@@ -600,7 +628,7 @@ Migration traffic is encrypted using an SSH tunnel by default. On secure, comple
 
 `--online` `<boolean>` ::
 
-Use online/live migration.
+Use online/live migration if VM is running. Ignored if VM is stopped.
 
 `--targetstorage` `<string>` ::
 
@@ -670,6 +698,19 @@ Get virtual machine configuration, including pending changes.
 
 The (unique) ID of the VM.
 
+*qm reboot* `<vmid>` `[OPTIONS]`
+
+Reboot the VM by shutting it down, and starting it again. Applies pending
+changes.
+
+`<vmid>`: `<integer> (1 - N)` ::
+
+The (unique) ID of the VM.
+
+`--timeout` `<integer> (0 - N)` ::
+
+Wait maximal timeout seconds for the shutdown.
+
 *qm rescan* `[OPTIONS]`
 
 Rescan all storages and update disk sizes and unused disk images.
@@ -776,7 +817,7 @@ The (unique) ID of the VM.
 
 Enable/disable ACPI.
 
-`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]` ::
+`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
 
 Enable/disable Qemu GuestAgent and its properties.
 
@@ -788,6 +829,10 @@ Virtual processor architecture. Defaults to the host.
 
 Arbitrary arguments passed to kvm.
 
+`--audio0` `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice>]` ::
+
+Configure a audio device, useful in combination with QXL/Spice.
+
 `--autostart` `<boolean>` ('default =' `0`)::
 
 Automatic restart after crash (currently ignored).
@@ -921,7 +966,7 @@ Set the real time clock to local time. This is enabled by default if ostype indi
 
 Lock/unlock the VM.
 
-`--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?|virt(?:-\d+\.\d+)?)` ::
+`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
 
 Specifies the Qemu machine type.
 
@@ -1009,7 +1054,7 @@ Amount of memory shares for auto-ballooning. The larger the number is, the more
 
 Ignore locks - only root is allowed to use this option.
 
-`--smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
+`--smbios1` `[base64=<1|0>] [,family=<Base64 encoded string>] [,manufacturer=<Base64 encoded string>] [,product=<Base64 encoded string>] [,serial=<Base64 encoded string>] [,sku=<Base64 encoded string>] [,uuid=<UUID>] [,version=<Base64 encoded string>]` ::
 
 Specify SMBIOS type 1 fields.
 
@@ -1021,6 +1066,10 @@ The number of CPUs. Please use option -sockets instead.
 
 The number of CPU sockets.
 
+`--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
+
+Configure additional enhancements for SPICE.
+
 `--sshkeys` `<filepath>` ::
 
 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
@@ -1037,6 +1086,10 @@ Startup and shutdown behavior. Order is a non-negative number defining the gener
 
 Enable/disable the USB tablet device.
 
+`--tags` `<string>` ::
+
+Tags of the VM. This is only meta information.
+
 `--tdf` `<boolean>` ('default =' `0`)::
 
 Enable/disable time drift fix.
@@ -1147,7 +1200,7 @@ Start virtual machine.
 
 The (unique) ID of the VM.
 
-`--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?|virt(?:-\d+\.\d+)?)` ::
+`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
 
 Specifies the Qemu machine type.