9b89b6a287
Giving QMP its own subdirectory in docs/ is hardly worthwhile when we have just four files, and one of them isn't even in the subdirectory. Move the files from docs/qmp/ to docs/, renaming docs/qmp/README to docs/qmp-intro. Update MAINTAINERS. The new pattern also captures the fourth file docs/writing-qmp-commands.txt. Signed-off-by: Markus Armbruster <armbru@redhat.com> Message-Id: <1443111117-29831-2-git-send-email-armbru@redhat.com> Reviewed-by: Eric Blake <eblake@redhat.com> Reviewed-by: Luiz Capitulino <lcapitulino@redhat.com>
88 lines
2.1 KiB
Plaintext
88 lines
2.1 KiB
Plaintext
QEMU Machine Protocol
|
|
=====================
|
|
|
|
Introduction
|
|
------------
|
|
|
|
The QEMU Machine Protocol (QMP) allows applications to operate a
|
|
QEMU instance.
|
|
|
|
QMP is JSON[1] based and features the following:
|
|
|
|
- Lightweight, text-based, easy to parse data format
|
|
- Asynchronous messages support (ie. events)
|
|
- Capabilities Negotiation
|
|
|
|
For detailed information on QMP's usage, please, refer to the following files:
|
|
|
|
o qmp-spec.txt QEMU Machine Protocol current specification
|
|
o qmp-commands.txt QMP supported commands (auto-generated at build-time)
|
|
o qmp-events.txt List of available asynchronous events
|
|
|
|
[1] http://www.json.org
|
|
|
|
Usage
|
|
-----
|
|
|
|
You can use the -qmp option to enable QMP. For example, the following
|
|
makes QMP available on localhost port 4444:
|
|
|
|
$ qemu [...] -qmp tcp:localhost:4444,server,nowait
|
|
|
|
However, for more flexibility and to make use of more options, the -mon
|
|
command-line option should be used. For instance, the following example
|
|
creates one HMP instance (human monitor) on stdio and one QMP instance
|
|
on localhost port 4444:
|
|
|
|
$ qemu [...] -chardev stdio,id=mon0 -mon chardev=mon0,mode=readline \
|
|
-chardev socket,id=mon1,host=localhost,port=4444,server,nowait \
|
|
-mon chardev=mon1,mode=control,pretty=on
|
|
|
|
Please, refer to QEMU's manpage for more information.
|
|
|
|
Simple Testing
|
|
--------------
|
|
|
|
To manually test QMP one can connect with telnet and issue commands by hand:
|
|
|
|
$ telnet localhost 4444
|
|
Trying 127.0.0.1...
|
|
Connected to localhost.
|
|
Escape character is '^]'.
|
|
{
|
|
"QMP": {
|
|
"version": {
|
|
"qemu": {
|
|
"micro": 50,
|
|
"minor": 6,
|
|
"major": 1
|
|
},
|
|
"package": ""
|
|
},
|
|
"capabilities": [
|
|
]
|
|
}
|
|
}
|
|
|
|
{ "execute": "qmp_capabilities" }
|
|
{
|
|
"return": {
|
|
}
|
|
}
|
|
|
|
{ "execute": "query-status" }
|
|
{
|
|
"return": {
|
|
"status": "prelaunch",
|
|
"singlestep": false,
|
|
"running": false
|
|
}
|
|
}
|
|
|
|
Please, refer to the qapi-schema.json file for a complete command reference.
|
|
|
|
QMP wiki page
|
|
-------------
|
|
|
|
http://wiki.qemu-project.org/QMP
|