Qemu Guest Agent Integration - Revision history

Michael: /* Getting list of available qemu-ga commands */

2015-03-12T10:32:19Z

Getting list of available qemu-ga commands

← Older revision		Revision as of 12:32, 12 March 2015
Line 82:		Line 82:

	<syntaxhighlight lang='bash'>		<syntaxhighlight lang='bash'>
	VMNAME=		VMNAME=<UUID>
	virsh qemu-agent-command $VMNAME '{"execute":"guest-info"}'		virsh qemu-agent-command ${VMNAME} '{"execute":"guest-info"}'
	</syntaxhighlight>		</syntaxhighlight>

	'''Example:'''		'''Example:'''
	<source lang="bash">		<source lang="bash">
	~~~ #~~ virsh qemu-agent-command ~~bc58f697-1f21-4613-9f4d-469cdaff0621~~ '{"execute":"guest-info"}'		VMNAME=2d52c542-432b-42f1-95a7-5a152788fcd3
			virsh qemu-agent-command ${VMNAME} '{"execute":"guest-info"}'
	</source>		</source>
			The return values will look something like:
	<source lang="bash">		<source lang="bash">
	{"return":		{"return":

Michael: /* Getting list of available qemu-ga commands */

2015-03-12T10:31:04Z

Getting list of available qemu-ga commands

← Older revision		Revision as of 12:31, 12 March 2015
Line 91:		Line 91:
	</source>		</source>

	<source lang="~~javascript~~">		<source lang="bash">
	{"return":		{"return":
	{"version":"2.1.2","supported_commands":[		{"version":"2.1.2","supported_commands":[

Michael: /* Getting list of available qemu-ga commands */

2015-03-12T10:30:38Z

Getting list of available qemu-ga commands

← Older revision		Revision as of 12:30, 12 March 2015
Line 91:		Line 91:
	</source>		</source>

	<source lang="~~json~~">		<source lang="javascript">
	{"return":		{"return":
	{"version":"2.1.2","supported_commands":[		{"version":"2.1.2","supported_commands":[

Michael: /* Getting list of available qemu-ga commands */

2015-03-12T10:29:49Z

Getting list of available qemu-ga commands

← Older revision		Revision as of 12:29, 12 March 2015
Line 87:		Line 87:

	'''Example:'''		'''Example:'''
	<~~pre~~>		<source lang="bash">
	~ # virsh qemu-agent-command bc58f697-1f21-4613-9f4d-469cdaff0621 '{"execute":"guest-info"}'		~ # virsh qemu-agent-command bc58f697-1f21-4613-9f4d-469cdaff0621 '{"execute":"guest-info"}'
			</source>

			<source lang="json">
	{"return":		{"return":
	{"version":"1.5.2","supported_commands":[		{"version":"2.1.2","supported_commands":[
	{"enabled":true,"name":"guest-set-vcpus"},		{"enabled":true,"name":"guest-set-vcpus","success-response":true},
	{"enabled":true,"name":"guest-get-vcpus"},		{"enabled":true,"name":"guest-get-vcpus","success-response":true},
	{"enabled":true,"name":"guest-network-get-interfaces"},		{"enabled":true,"name":"guest-network-get-interfaces","success-response":true},
	{"enabled":true,"name":"guest-suspend-hybrid"},		{"enabled":true,"name":"guest-suspend-hybrid","success-response":false},
	{"enabled":true,"name":"guest-suspend-ram"},		{"enabled":true,"name":"guest-suspend-ram","success-response":false},
	{"enabled":true,"name":"guest-suspend-disk"},		{"enabled":true,"name":"guest-suspend-disk","success-response":false},
	{"enabled":true,"name":"guest-fstrim"},		{"enabled":true,"name":"guest-fstrim","success-response":true},
	{"enabled":true,"name":"guest-fsfreeze-thaw"},		{"enabled":true,"name":"guest-fsfreeze-thaw","success-response":true},
	{"enabled":true,"name":"guest-fsfreeze-freeze"},		{"enabled":true,"name":"guest-fsfreeze-freeze","success-response":true},
	{"enabled":true,"name":"guest-fsfreeze-status"},		{"enabled":true,"name":"guest-fsfreeze-status","success-response":true},
	{"enabled":true,"name":"guest-file-flush"},		{"enabled":true,"name":"guest-file-flush","success-response":true},
	{"enabled":true,"name":"guest-file-seek"},		{"enabled":true,"name":"guest-file-seek","success-response":true},
	{"enabled":true,"name":"guest-file-write"},		{"enabled":true,"name":"guest-file-write","success-response":true},
	{"enabled":true,"name":"guest-file-read"},		{"enabled":true,"name":"guest-file-read","success-response":true},
	{"enabled":true,"name":"guest-file-close"},		{"enabled":true,"name":"guest-file-close","success-response":true},
	{"enabled":true,"name":"guest-file-open"},		{"enabled":true,"name":"guest-file-open","success-response":true},
	{"enabled":true,"name":"guest-shutdown"},		{"enabled":true,"name":"guest-shutdown","success-response":false},
	{"enabled":true,"name":"guest-info"},		{"enabled":true,"name":"guest-info","success-response":true},
	{"enabled":true,"name":"guest-set-time"},		{"enabled":true,"name":"guest-set-time","success-response":true},
	{"enabled":true,"name":"guest-get-time"},		{"enabled":true,"name":"guest-get-time","success-response":true},
	{"enabled":true,"name":"guest-ping"},		{"enabled":true,"name":"guest-ping","success-response":true},
	{"enabled":true,"name":"guest-sync"},		{"enabled":true,"name":"guest-sync","success-response":true},
	{"enabled":true,"name":"guest-sync-delimited"} ]		{"enabled":true,"name":"guest-sync-delimited","success-response":true}
	}		]}
	}		}
	</~~pre~~>		</source>

	= Links =		= Links =

Michael: /* Getting list of available qemu-ga commands */

2014-05-01T14:30:45Z

Getting list of available qemu-ga commands

← Older revision		Revision as of 16:30, 1 May 2014
Line 82:		Line 82:

	<syntaxhighlight lang='bash'>		<syntaxhighlight lang='bash'>
			VMNAME=
	virsh qemu-agent-command $VMNAME '{"execute":"guest-info"}'		virsh qemu-agent-command $VMNAME '{"execute":"guest-info"}'
	</syntaxhighlight>		</syntaxhighlight>

Tiziano: /* Libvirt */

2013-09-24T16:31:41Z

Libvirt

← Older revision		Revision as of 18:31, 24 September 2013
Line 33:		Line 33:
	The sockets are named <code>/var/lib/libvirt/qemu/channel/target/${VMNAME}.org.qemu.guest_agent.0</code>.		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 anything on it, everything has to go via libvirt.		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 =		= VM =

Tiziano: /* Libvirt */

2013-09-24T16:31:21Z

Libvirt

← Older revision		Revision as of 18:31, 24 September 2013
Line 22:		Line 22:
	</syntaxhighlight>		</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>		This will create a new virtual serial device within the VM and a new socket under <code>/var/lib/libvirt/qemu/channel/target/</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 anything on it, everything has to go via libvirt.		Please note: since libvirt will automatically listen on that socket one can not use a tool like <code>qemu-ga-client</code> to anything on it, everything has to go via libvirt.

Tiziano: /* Test */

2013-09-13T07:56:44Z

Test

← Older revision		Revision as of 09:56, 13 September 2013
Line 39:		Line 39:

	= Test =		= 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 ==		== Shutdown a VM via qemu-ga ==

Tiziano: /* Ping qemu-ga via libvirt */

2013-09-13T07:54:29Z

Ping qemu-ga via libvirt

@@ Line 53: / Line 53: @@
 </pre>
-== Ping qemu-ga via libvirt==
+== Manually ping qemu-ga via libvirt ==
 <syntaxhighlight lang='bash'>
-virsh qemu-agent-command $VMNAME'{"execute":"guest-ping"}'
+virsh qemu-agent-command $VMNAME '{"execute":"guest-ping"}'
 </syntaxhighlight>
@@ Line 65: / Line 67: @@
 {"return":{}}
 </pre>

Tiziano at 07:47, 13 September 2013

2013-09-13T07:47:24Z

← Older revision		Revision as of 09:47, 13 September 2013
Line 1:		Line 1:
			= Abstract =

	The Qemu Guest Agent permits access to a VM via a virtual serial socket. This has the advantage that the VM can be accessed via the VM node (hypervisor) without network connection or remote desktop protocol.		The Qemu Guest Agent permits access to a VM via a virtual serial socket. This has the advantage that the VM can be accessed via the VM node (hypervisor) without network connection or remote desktop protocol.

			This is a requirement to be able to take disk-only-snapshots without downtime by issueing a disk-freeze (shadow-copy) within the guest prior to taking the snapshot.

			Furthermore it is useful for orchestrating CPU and memory hotplugging:

			* guest OS must be told to enable CPU/memory after hot-plug
			* guest OS must release a CPU/memory prior to hot-unplug


	= Libvirt =		= Libvirt =