summaryrefslogtreecommitdiff
blob: 50c31f20c91bf9c2b9cdb036e8a5e9f64158d689 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
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>