From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1NDpBr-00020P-MR for qemu-devel@nongnu.org; Thu, 26 Nov 2009 20:00:03 -0500 Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1NDpBm-0001v7-Ua for qemu-devel@nongnu.org; Thu, 26 Nov 2009 20:00:03 -0500 Received: from [199.232.76.173] (port=48305 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1NDpBm-0001uv-Mi for qemu-devel@nongnu.org; Thu, 26 Nov 2009 19:59:58 -0500 Received: from mx1.redhat.com ([209.132.183.28]:53940) by monty-python.gnu.org with esmtp (Exim 4.60) (envelope-from ) id 1NDpBm-0004U3-7B for qemu-devel@nongnu.org; Thu, 26 Nov 2009 19:59:58 -0500 From: Luiz Capitulino Date: Thu, 26 Nov 2009 22:59:06 -0200 Message-Id: <1259283550-3597-17-git-send-email-lcapitulino@redhat.com> In-Reply-To: <1259283550-3597-1-git-send-email-lcapitulino@redhat.com> References: <1259283550-3597-1-git-send-email-lcapitulino@redhat.com> Subject: [Qemu-devel] [PATCH 16/20] QMP: Introduce README file List-Id: qemu-devel.nongnu.org List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: qemu-devel@nongnu.org Cc: aliguori@us.ibm.com, avi@redhat.com, armbru@redhat.com Signed-off-by: Luiz Capitulino --- QMP/README | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 51 insertions(+), 0 deletions(-) create mode 100644 QMP/README diff --git a/QMP/README b/QMP/README new file mode 100644 index 0000000..50c31f2 --- /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 -- 1.6.6.rc0.50.gaf06e