mirror of
https://github.com/libvirt/libvirt.git
synced 2026-08-19 01:24:42 -05:00
libvirt-qemu: Add reference to QEMU agent protocol syntax
Add a reference to the expected format of commands used with 'virDomainQemuAgentCommand'. Closes: https://gitlab.com/libvirt/libvirt/-/work_items/891 Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
This commit is contained in:
+7
-1
@@ -278,6 +278,11 @@ virDomainQemuAttach(virConnectPtr conn,
|
||||
* Execute an arbitrary Guest Agent command.
|
||||
*
|
||||
* Issue @cmd to the guest agent running in @domain.
|
||||
*
|
||||
* The QEMU guest agent expects the command @cmd to be in the QEMU Guest Agent
|
||||
* Protocol format documented at:
|
||||
* https://www.qemu.org/docs/master/interop/qemu-ga-ref.html
|
||||
*
|
||||
* @timeout must be -2, -1, 0 or positive.
|
||||
* VIR_DOMAIN_QEMU_AGENT_COMMAND_BLOCK(-2): meaning to block forever waiting for
|
||||
* a result.
|
||||
@@ -285,7 +290,8 @@ virDomainQemuAttach(virConnectPtr conn,
|
||||
* VIR_DOMAIN_QEMU_AGENT_COMMAND_NOWAIT(0): does not wait.
|
||||
* positive value: wait for @timeout seconds
|
||||
*
|
||||
* Returns strings if success, NULL in failure.
|
||||
* Returns string containing the verbatim reply from the guest agent on
|
||||
* success, NULL on failure.
|
||||
*
|
||||
* Since: 0.10.0
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user