aboutsummaryrefslogtreecommitdiffstats
path: root/QMP
diff options
context:
space:
mode:
authorLuiz Capitulino <lcapitulino@redhat.com>2009-11-26 22:59:06 -0200
committerAnthony Liguori <aliguori@us.ibm.com>2009-12-03 09:41:24 -0600
commit26d5a1cd23c3803f931cedbcb352dfa66d388375 (patch)
tree7ccd2d88c3d533a8c48b003a5b8709fcd7103a6c /QMP
parent4a29a85db9e67fcd07e6ca55d69e369e9874ec95 (diff)
QMP: Introduce README file
Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com> Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
Diffstat (limited to 'QMP')
-rw-r--r--QMP/README51
1 files changed, 51 insertions, 0 deletions
diff --git a/QMP/README b/QMP/README
new file mode 100644
index 000000000..50c31f20c
--- /dev/null
+++ b/QMP/README
@@ -0,0 +1,51 @@
+ QEMU Monitor Protocol
+ =====================
+
+Introduction
+-------------
+
+The QEMU Monitor Protocol (QMP) is a JSON[1] based protocol for QEMU.
+
+By using it applications can control QEMU in reliable and "parseable" way,
+QMP also provides asynchronous events support.
+
+For more information, please, refer to the following files:
+
+o qmp-spec.txt QEMU Monitor Protocol current draft specification
+o qmp-events.txt List of available asynchronous events
+
+There are also two simple Python scripts available:
+
+o qmp-shell A shell
+o vm-info Show some informations about the Virtal Machine
+
+[1] http://www.json.org
+
+Usage
+-----
+
+To enable QMP, QEMU has to be started in "control mode". This is done
+by passing the flag "control" to the "-monitor" command-line option.
+
+For example:
+
+$ qemu [...] -monitor control,tcp:localhost:4444,server
+
+Will start QEMU in control mode, waiting for a client TCP connection
+on localhost port 4444.
+
+To manually test it you can connect with telnet and issue commands:
+
+$ telnet localhost 4444
+Trying ::1...
+Connected to localhost.
+Escape character is '^]'.
+{"QMP": {"capabilities": []}}
+{ "execute": "query-version" }
+{"return": "0.11.50"}
+
+Contact
+-------
+
+http://www.linux-kvm.org/page/MonitorProtocol
+Luiz Fernando N. Capitulino <lcapitulino@redhat.com>