QMP/README

   1                           QEMU Monitor Protocol
   2                           =====================
   3
   4 Introduction
   5 -------------
   6
   7 The QEMU Monitor Protocol (QMP) is a JSON[1] based protocol for QEMU.
   8
   9 By using it applications can control QEMU in reliable and "parseable" way,
  10 QMP also provides asynchronous events support.
  11
  12 For more information, please, refer to the following files:
  13
  14 o qmp-spec.txt    QEMU Monitor Protocol current draft specification
  15 o qmp-events.txt  List of available asynchronous events
  16
  17 There are also two simple Python scripts available:
  18
  19 o qmp-shell       A shell
  20 o vm-info         Show some informations about the Virtal Machine
  21
  22 [1] http://www.json.org
  23
  24 Usage
  25 -----
  26
  27 To enable QMP, QEMU has to be started in "control mode". This is done
  28 by passing the flag "control" to the "-monitor" command-line option.
  29
  30 For example:
  31
  32 $ qemu [...] -monitor control,tcp:localhost:4444,server
  33
  34 Will start QEMU in control mode, waiting for a client TCP connection
  35 on localhost port 4444.
  36
  37 To manually test it you can connect with telnet and issue commands:
  38
  39 $ telnet localhost 4444
  40 Trying ::1...
  41 Connected to localhost.
  42 Escape character is '^]'.
  43 {"QMP": {"capabilities": []}}
  44 { "execute": "query-version" }
  45 {"return": "0.11.50"}
  46
  47 Contact
  48 -------
  49
  50 http://www.linux-kvm.org/page/MonitorProtocol
  51 Luiz Fernando N. Capitulino <lcapitulino@redhat.com>