make update-static

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

diff --git a/qm.1-synopsis.adoc b/qm.1-synopsis.adoc
index d77a5d3ff7ba9e49c597739db39d981bf3e1961b..5c84a1fdca640069687c3eaa6932909ddb01d57f 100644 (file)
--- a/qm.1-synopsis.adoc
+++ b/qm.1-synopsis.adoc
@@ -1,16 +1,8 @@
 *qm* `<COMMAND> [ARGS] [OPTIONS]`
 
-*qm agent* `<vmid> <command>`
+*qm agent*
 
-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-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>` ::
-
-The QGA command.
+An alias for 'qm guest cmd'.
 
 *qm clone* `<vmid> <newid>` `[OPTIONS]`
 
@@ -81,9 +73,9 @@ The (unique) ID of the VM.
 
 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>` ::
 
@@ -212,7 +204,7 @@ Lock/unlock the VM.
 
 `--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`)::
 
@@ -356,7 +348,7 @@ Configure an USB device (n is 0 to 4).
 
 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.
 
@@ -364,6 +356,10 @@ Select the VGA type.
 
 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.
@@ -400,6 +396,66 @@ The (unique) ID of the VM.
 
 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.
+
+`<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>` ::
+
+The QGA command.
+
+*qm guest exec* `<vmid> [<extra-args>]` `[OPTIONS]`
+
+Executes the given command via the guest agent
+
+`<vmid>`: `<integer> (1 - N)` ::
+
+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.
@@ -569,6 +625,10 @@ The (unique) ID of the VM.
 
 Rescan all storages and update disk sizes and unused disk images.
 
+`--dryrun` `<boolean>` ('default =' `0`)::
+
+Do not actually write changes out to VM config(s).
+
 `--vmid` `<integer> (1 - N)` ::
 
 The (unique) ID of the VM.
@@ -667,9 +727,9 @@ The (unique) ID of the VM.
 
 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>` ::
 
@@ -798,7 +858,7 @@ Lock/unlock the VM.
 
 `--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`)::
 
@@ -932,7 +992,7 @@ Configure an USB device (n is 0 to 4).
 
 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.
 
@@ -940,6 +1000,10 @@ Select the VGA type.
 
 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.
@@ -1016,7 +1080,7 @@ The (unique) ID of the VM.
 
 `--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>` ::