Hi,
Just a few language corrections. I have no problem with the content :)
Dylan
On 12/16/20 3:38 PM, Aaron Lauterer wrote:
Signed-off-by: Aaron Lauterer <a.laute...@proxmox.com>
---
Additionally to the previous series [0] which changes the phrasing, it
would be nice to have a dedicated Qemu Guest Agent section in the docs.
This is a first draft. If there is something missing or could be phrased
/ structured in a better way, let me know :)
[0] https://lists.proxmox.com/pipermail/pve-devel/2020-December/046502.html
qm.adoc | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 52 insertions(+)
diff --git a/qm.adoc b/qm.adoc
index 5e53e4a..9c121f1 100644
--- a/qm.adoc
+++ b/qm.adoc
@@ -917,6 +917,58 @@ start after those where the parameter is set. Further,
this parameter can only
be enforced between virtual machines running on the same host, not
cluster-wide.
+
+[[qm_qemu_agent]]
+Qemu Guest Agent
+~~~~~~~~~~~~~~~~
+
+The Qemu Guest Agent is a service which is running inside the VM, providing a
s/which is running/which runs/
+communication channel between the host and the guest. It is used to exchange
+information and allows the host to issue commands to the guest.
+
+For example, the IP addresses in the VM summary panel are fetched via the guest
+agent. When starting a backup, the guest is told via the guest agent to sync
+outstanding writes via the 'fs-freeze' and 'fs-thaw' commands. It is possible
+to add custom hook scripts to react to these commands and tell software like a
I would say "software such as" or "software, for example, ", but that's
more personal preference.
+database server to write current data to disk so it is included in the backup.
s/disk so it is/disk, so that it is/
+
+Install Guest Agent
+^^^^^^^^^^^^^^^^^^^
+
+For most Linux distributions the guest agent is available. The package is
s/distributions the guest/distributions, the guest/
+usually named `qemu-guest-agent`.
+
+For Windows, it can be installed from the
+https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/stable-virtio/virtio-win.iso[Fedora
+VirtIO driver ISO].
+
+Enable Guest Agent
+^^^^^^^^^^^^^^^^^^
+
+The guest agent can be enabled in the VMs *Options* panel.
s/in the VMs/from the VM's/
+A fresh start of the VM is necessary for the changes to take effect.
+
+It is possible to enable the 'Run guest-trim'. With this option enabled,
s/enable the 'Run/enable 'Run/ (not 100% sure about this)
+Proxmox VE will issue a trim command to the guest after the following
+operations that have the potential to write out zeros to the storage:
+
+* moving a disk to another storage
+* live migrating a VM to another node with local storage
+
+On a thin provisioned storages this can help to free up unused space.
s/On a thin provisioned storages this/On thin provisioned storage, this/
+
+Troubleshooting
+^^^^^^^^^^^^^^^
+
+.VM does not shut down
+
+Make sure the guest agent is installed and running.
+
+Once the guest agent is enabled, Proxmox VE will send power commands like
+'shutdown' via the guest agent. These commands will be ignored if the guest
+agent in the VM is not running.
+
+
[[qm_spice_enhancements]]
SPICE Enhancements
~~~~~~~~~~~~~~~~~~
_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
