Changes
/* Getting list of available qemu-ga commands */
</syntaxhighlight>
This will create a new virtual serial device within the VM and a new socket under code>/var/lib/libvirt/qemu/channel/target/</code> (make sure that this directory is protected!) named <code>/var/lib/libvirt/qemu/channel/target/${VMNAME}.org.qemu.guest_agent.0</code>.
Make sure that this directory exists and is protected:<syntaxhighlight lang='xml'>mkdir -p /var/lib/libvirt/qemu/channel/target/chown root:qemu /var/lib/libvirt/qemu/channel/target/chmod 770 /var/lib/libvirt/qemu/channel/target/</syntaxhighlight> The sockets are named <code>/var/lib/libvirt/qemu/channel/target/${VMNAME}.org.qemu.guest_agent.0</code>. Please note: since libvirt will automatically listen on that socket one can not use a tool like <code>qemu-ga-client</code> to do anything on it, everything has to go via libvirt.
= VM =
= Test =
See the links for an example on how to read a file (it is non-trivial and the returned content is base64-encoded, so it must be scripted and there is no point in duplicating it here).
== Shutdown a VM via qemu-ga ==
</pre>
== Ping Manually ping qemu-ga via libvirt== Libvirt issues a <code>guest-sync</code> before any other command as a way to ensure availability of qemu-ga. Nevertheless it may be useful to run commands directly, like the <code>guest-ping</code>.
<syntaxhighlight lang='bash'>
virsh qemu-agent-command $VMNAME'{"execute":"guest-ping"}'
</syntaxhighlight>
</pre>
== Getting list of available qemu-ga commands ==
<syntaxhighlight lang='bash'>
VMNAME=<UUID>
virsh qemu-agent-command ${VMNAME} '{"execute":"guest-info"}'
</syntaxhighlight>
'''Example:'''
<source lang="bash">
VMNAME=2d52c542-432b-42f1-95a7-5a152788fcd3
virsh qemu-agent-command ${VMNAME} '{"execute":"guest-info"}'
</source>
The return values will look something like:
<source lang="bash">
{"return":
{"version":"2.1.2","supported_commands":[
{"enabled":true,"name":"guest-set-vcpus","success-response":true},
{"enabled":true,"name":"guest-get-vcpus","success-response":true},
{"enabled":true,"name":"guest-network-get-interfaces","success-response":true},
{"enabled":true,"name":"guest-suspend-hybrid","success-response":false},
{"enabled":true,"name":"guest-suspend-ram","success-response":false},
{"enabled":true,"name":"guest-suspend-disk","success-response":false},
{"enabled":true,"name":"guest-fstrim","success-response":true},
{"enabled":true,"name":"guest-fsfreeze-thaw","success-response":true},
{"enabled":true,"name":"guest-fsfreeze-freeze","success-response":true},
{"enabled":true,"name":"guest-fsfreeze-status","success-response":true},
{"enabled":true,"name":"guest-file-flush","success-response":true},
{"enabled":true,"name":"guest-file-seek","success-response":true},
{"enabled":true,"name":"guest-file-write","success-response":true},
{"enabled":true,"name":"guest-file-read","success-response":true},
{"enabled":true,"name":"guest-file-close","success-response":true},
{"enabled":true,"name":"guest-file-open","success-response":true},
{"enabled":true,"name":"guest-shutdown","success-response":false},
{"enabled":true,"name":"guest-info","success-response":true},
{"enabled":true,"name":"guest-set-time","success-response":true},
{"enabled":true,"name":"guest-get-time","success-response":true},
{"enabled":true,"name":"guest-ping","success-response":true},
{"enabled":true,"name":"guest-sync","success-response":true},
{"enabled":true,"name":"guest-sync-delimited","success-response":true}
]}
}
</source>
= Links =
