From 33ae851409ddd136bd2a00f1874f3753fc2c60cd Mon Sep 17 00:00:00 2001 From: Peter Krempa Date: Mon, 17 Feb 2025 16:11:23 +0100 Subject: [PATCH] docs: formatdomain: Mention that vhostuser interface with mode='server' waits for connection MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit When starting a VM with a vhost-user interface in server mode qemu will wait for the incoming connection without running CPUs. This isn't really documented in our XML. Additionally when hotplugging the same interface the above will not happen. Signed-off-by: Peter Krempa Reviewed-by: Ján Tomko --- docs/formatdomain.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index 4a5241e610..fdb3c2459e 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -6346,6 +6346,11 @@ two attributes ``enabled`` (which accepts ``yes`` and ``no``) and ``timeout`` which specifies the amount of seconds after which hypervisor tries to reconnect. +Note that when ``mode='server'`` is used, the hypervisor will wait for the +incoming connection to be established prior to actually running the VM. This is +not possible when hotplugging an interface with such config so the VM will +continue to run even when no connection is made. It's advised to use +``mode='client'`` instead. vhost-user connection with passt backend ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^