2010-02-25 16:07:02 +01:00
|
|
|
QEMU Monitor Protocol Events
|
|
|
|
============================
|
2009-11-27 01:59:08 +01:00
|
|
|
|
2010-02-25 16:07:02 +01:00
|
|
|
BLOCK_IO_ERROR
|
|
|
|
--------------
|
|
|
|
|
|
|
|
Emitted when a disk I/O error occurs.
|
|
|
|
|
|
|
|
Data:
|
|
|
|
|
|
|
|
- "device": device name (json-string)
|
|
|
|
- "operation": I/O operation (json-string, "read" or "write")
|
|
|
|
- "action": action that has been taken, it's one of the following (json-string):
|
|
|
|
"ignore": error has been ignored
|
|
|
|
"report": error has been reported to the device
|
|
|
|
"stop": error caused VM to be stopped
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
{ "event": "BLOCK_IO_ERROR",
|
|
|
|
"data": { "device": "ide0-hd1",
|
|
|
|
"operation": "write",
|
|
|
|
"action": "stop" },
|
|
|
|
"timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
|
|
|
|
|
|
|
|
Note: If action is "stop", a STOP event will eventually follow the
|
|
|
|
BLOCK_IO_ERROR event.
|
|
|
|
|
|
|
|
RESET
|
|
|
|
-----
|
|
|
|
|
|
|
|
Emitted when the Virtual Machine is reseted.
|
2009-11-27 01:59:08 +01:00
|
|
|
|
|
|
|
Data: None.
|
|
|
|
|
2010-02-25 16:07:02 +01:00
|
|
|
Example:
|
|
|
|
|
|
|
|
{ "event": "RESET",
|
|
|
|
"timestamp": { "seconds": 1267041653, "microseconds": 9518 } }
|
|
|
|
|
2010-04-28 01:35:59 +02:00
|
|
|
RESUME
|
|
|
|
------
|
|
|
|
|
|
|
|
Emitted when the Virtual Machine resumes execution.
|
|
|
|
|
|
|
|
Data: None.
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
{ "event": "RESUME",
|
|
|
|
"timestamp": { "seconds": 1271770767, "microseconds": 582542 } }
|
|
|
|
|
2010-02-25 16:11:44 +01:00
|
|
|
RTC_CHANGE
|
|
|
|
----------
|
|
|
|
|
2010-03-24 21:24:37 +01:00
|
|
|
Emitted when the guest changes the RTC time.
|
2010-02-25 16:11:44 +01:00
|
|
|
|
|
|
|
Data:
|
|
|
|
|
|
|
|
- "offset": delta against the host UTC in seconds (json-number)
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
{ "event": "RTC_CHANGE",
|
|
|
|
"data": { "offset": 78 },
|
|
|
|
"timestamp": { "seconds": 1267020223, "microseconds": 435656 } }
|
|
|
|
|
2010-02-25 16:07:02 +01:00
|
|
|
SHUTDOWN
|
|
|
|
--------
|
|
|
|
|
|
|
|
Emitted when the Virtual Machine is powered down.
|
2009-11-27 01:59:08 +01:00
|
|
|
|
|
|
|
Data: None.
|
|
|
|
|
2010-02-25 16:07:02 +01:00
|
|
|
Example:
|
|
|
|
|
|
|
|
{ "event": "SHUTDOWN",
|
|
|
|
"timestamp": { "seconds": 1267040730, "microseconds": 682951 } }
|
|
|
|
|
|
|
|
Note: If the command-line option "-no-shutdown" has been specified, a STOP
|
|
|
|
event will eventually follow the SHUTDOWN event.
|
|
|
|
|
|
|
|
STOP
|
|
|
|
----
|
|
|
|
|
|
|
|
Emitted when the Virtual Machine is stopped.
|
2009-11-27 01:59:08 +01:00
|
|
|
|
|
|
|
Data: None.
|
|
|
|
|
2010-02-25 16:07:02 +01:00
|
|
|
Example:
|
QMP: Introduce VNC_CONNECTED event
It's emitted when a VNC client connects to QEMU, client's information
such as port and IP address are provided.
Note that this event is emitted right when the connection is
established. This means that it happens before authentication
procedure and session initialization.
Event example:
{ "event": "VNC_CONNECTED",
"timestamp": { "seconds": 1262976601, "microseconds": 975795 },
"data": {
"server": { "auth": "sasl", "family": "ipv4",
"service": "5901", "host": "0.0.0.0" },
"client": { "family": "ipv4", "service": "58425",
"host": "127.0.0.1" } } }
Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2010-01-14 17:50:57 +01:00
|
|
|
|
2010-10-14 02:51:02 +02:00
|
|
|
{ "event": "STOP",
|
2010-02-25 16:07:02 +01:00
|
|
|
"timestamp": { "seconds": 1267041730, "microseconds": 281295 } }
|
QMP: Introduce VNC_DISCONNECTED event
It's emitted when a VNC client disconnects from QEMU, client's
information such as port and IP address are provided.
Event example:
{ "event": "VNC_DISCONNECTED",
"timestamp": { "seconds": 1262976601, "microseconds": 975795 },
"data": {
"server": { "auth": "sasl", "family": "ipv4",
"service": "5901", "host": "0.0.0.0" },
"client": { "family": "ipv4", "service": "58425",
"host": "127.0.0.1", "sasl_username": "foo" } } }
Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2010-01-14 17:50:58 +01:00
|
|
|
|
2010-02-25 16:07:02 +01:00
|
|
|
VNC_CONNECTED
|
|
|
|
-------------
|
QMP: Introduce VNC_DISCONNECTED event
It's emitted when a VNC client disconnects from QEMU, client's
information such as port and IP address are provided.
Event example:
{ "event": "VNC_DISCONNECTED",
"timestamp": { "seconds": 1262976601, "microseconds": 975795 },
"data": {
"server": { "auth": "sasl", "family": "ipv4",
"service": "5901", "host": "0.0.0.0" },
"client": { "family": "ipv4", "service": "58425",
"host": "127.0.0.1", "sasl_username": "foo" } } }
Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2010-01-14 17:50:58 +01:00
|
|
|
|
2010-02-25 16:07:02 +01:00
|
|
|
Emitted when a VNC client establishes a connection.
|
|
|
|
|
|
|
|
Data:
|
|
|
|
|
|
|
|
- "server": Server information (json-object)
|
|
|
|
- "host": IP address (json-string)
|
|
|
|
- "service": port number (json-string)
|
|
|
|
- "family": address family (json-string, "ipv4" or "ipv6")
|
|
|
|
- "auth": authentication method (json-string, optional)
|
|
|
|
- "client": Client information (json-object)
|
|
|
|
- "host": IP address (json-string)
|
|
|
|
- "service": port number (json-string)
|
|
|
|
- "family": address family (json-string, "ipv4" or "ipv6")
|
|
|
|
|
|
|
|
Example:
|
QMP: Introduce VNC_INITIALIZED event
It's emitted when a VNC client session is activated by QEMU,
client's information such as port, IP and auth ID (if the
session is authenticated) are provided.
Event example:
{ "event": "VNC_INITIALIZED",
"timestamp": {"seconds": 1263475302, "microseconds": 150772},
"data": {
"server": { "auth": "sasl", "family": "ipv4",
"service": "5901", "host": "0.0.0.0"},
"client": { "family": "ipv4", "service": "46089",
"host": "127.0.0.1", "sasl_username": "lcapitulino" } } }
Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2010-01-14 17:50:59 +01:00
|
|
|
|
2010-02-25 16:07:02 +01:00
|
|
|
{ "event": "VNC_CONNECTED",
|
|
|
|
"data": {
|
|
|
|
"server": { "auth": "sasl", "family": "ipv4",
|
|
|
|
"service": "5901", "host": "0.0.0.0" },
|
|
|
|
"client": { "family": "ipv4", "service": "58425",
|
|
|
|
"host": "127.0.0.1" } },
|
|
|
|
"timestamp": { "seconds": 1262976601, "microseconds": 975795 } }
|
QMP: Introduce VNC_INITIALIZED event
It's emitted when a VNC client session is activated by QEMU,
client's information such as port, IP and auth ID (if the
session is authenticated) are provided.
Event example:
{ "event": "VNC_INITIALIZED",
"timestamp": {"seconds": 1263475302, "microseconds": 150772},
"data": {
"server": { "auth": "sasl", "family": "ipv4",
"service": "5901", "host": "0.0.0.0"},
"client": { "family": "ipv4", "service": "46089",
"host": "127.0.0.1", "sasl_username": "lcapitulino" } } }
Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2010-01-14 17:50:59 +01:00
|
|
|
|
2010-02-03 15:41:00 +01:00
|
|
|
|
2010-02-25 16:07:02 +01:00
|
|
|
Note: This event is emitted before any authentication takes place, thus
|
|
|
|
the authentication ID is not provided.
|
|
|
|
|
|
|
|
VNC_DISCONNECTED
|
2010-02-03 15:41:00 +01:00
|
|
|
----------------
|
|
|
|
|
2011-11-22 11:06:19 +01:00
|
|
|
Emitted when the connection is closed.
|
2010-02-25 16:07:02 +01:00
|
|
|
|
2010-02-03 15:41:00 +01:00
|
|
|
Data:
|
|
|
|
|
2010-02-25 16:07:02 +01:00
|
|
|
- "server": Server information (json-object)
|
|
|
|
- "host": IP address (json-string)
|
|
|
|
- "service": port number (json-string)
|
|
|
|
- "family": address family (json-string, "ipv4" or "ipv6")
|
|
|
|
- "auth": authentication method (json-string, optional)
|
|
|
|
- "client": Client information (json-object)
|
|
|
|
- "host": IP address (json-string)
|
|
|
|
- "service": port number (json-string)
|
|
|
|
- "family": address family (json-string, "ipv4" or "ipv6")
|
|
|
|
- "x509_dname": TLS dname (json-string, optional)
|
|
|
|
- "sasl_username": SASL username (json-string, optional)
|
2010-02-03 15:41:00 +01:00
|
|
|
|
|
|
|
Example:
|
|
|
|
|
2010-02-25 16:07:02 +01:00
|
|
|
{ "event": "VNC_DISCONNECTED",
|
|
|
|
"data": {
|
|
|
|
"server": { "auth": "sasl", "family": "ipv4",
|
|
|
|
"service": "5901", "host": "0.0.0.0" },
|
|
|
|
"client": { "family": "ipv4", "service": "58425",
|
|
|
|
"host": "127.0.0.1", "sasl_username": "luiz" } },
|
|
|
|
"timestamp": { "seconds": 1262976601, "microseconds": 975795 } }
|
|
|
|
|
|
|
|
VNC_INITIALIZED
|
|
|
|
---------------
|
|
|
|
|
|
|
|
Emitted after authentication takes place (if any) and the VNC session is
|
|
|
|
made active.
|
|
|
|
|
|
|
|
Data:
|
|
|
|
|
|
|
|
- "server": Server information (json-object)
|
|
|
|
- "host": IP address (json-string)
|
|
|
|
- "service": port number (json-string)
|
|
|
|
- "family": address family (json-string, "ipv4" or "ipv6")
|
|
|
|
- "auth": authentication method (json-string, optional)
|
|
|
|
- "client": Client information (json-object)
|
|
|
|
- "host": IP address (json-string)
|
|
|
|
- "service": port number (json-string)
|
|
|
|
- "family": address family (json-string, "ipv4" or "ipv6")
|
|
|
|
- "x509_dname": TLS dname (json-string, optional)
|
|
|
|
- "sasl_username": SASL username (json-string, optional)
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
{ "event": "VNC_INITIALIZED",
|
|
|
|
"data": {
|
|
|
|
"server": { "auth": "sasl", "family": "ipv4",
|
|
|
|
"service": "5901", "host": "0.0.0.0"},
|
|
|
|
"client": { "family": "ipv4", "service": "46089",
|
|
|
|
"host": "127.0.0.1", "sasl_username": "luiz" } },
|
|
|
|
"timestamp": { "seconds": 1263475302, "microseconds": 150772 } }
|
2010-02-25 16:13:04 +01:00
|
|
|
|
2010-10-11 18:03:51 +02:00
|
|
|
SPICE_CONNECTED, SPICE_DISCONNECTED
|
|
|
|
-----------------------------------
|
|
|
|
|
|
|
|
Emitted when a SPICE client connects or disconnects.
|
|
|
|
|
|
|
|
Data:
|
|
|
|
|
|
|
|
- "server": Server information (json-object)
|
|
|
|
- "host": IP address (json-string)
|
|
|
|
- "port": port number (json-string)
|
|
|
|
- "family": address family (json-string, "ipv4" or "ipv6")
|
|
|
|
- "client": Client information (json-object)
|
|
|
|
- "host": IP address (json-string)
|
|
|
|
- "port": port number (json-string)
|
|
|
|
- "family": address family (json-string, "ipv4" or "ipv6")
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
{ "timestamp": {"seconds": 1290688046, "microseconds": 388707},
|
|
|
|
"event": "SPICE_CONNECTED",
|
|
|
|
"data": {
|
|
|
|
"server": { "port": "5920", "family": "ipv4", "host": "127.0.0.1"},
|
|
|
|
"client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"}
|
|
|
|
}}
|
|
|
|
|
|
|
|
|
|
|
|
SPICE_INITIALIZED
|
|
|
|
-----------------
|
|
|
|
|
|
|
|
Emitted after initial handshake and authentication takes place (if any)
|
|
|
|
and the SPICE channel is up'n'running
|
|
|
|
|
|
|
|
Data:
|
|
|
|
|
|
|
|
- "server": Server information (json-object)
|
|
|
|
- "host": IP address (json-string)
|
|
|
|
- "port": port number (json-string)
|
|
|
|
- "family": address family (json-string, "ipv4" or "ipv6")
|
|
|
|
- "auth": authentication method (json-string, optional)
|
|
|
|
- "client": Client information (json-object)
|
|
|
|
- "host": IP address (json-string)
|
|
|
|
- "port": port number (json-string)
|
|
|
|
- "family": address family (json-string, "ipv4" or "ipv6")
|
|
|
|
- "connection-id": spice connection id. All channels with the same id
|
|
|
|
belong to the same spice session (json-int)
|
|
|
|
- "channel-type": channel type. "1" is the main control channel, filter for
|
|
|
|
this one if you want track spice sessions only (json-int)
|
|
|
|
- "channel-id": channel id. Usually "0", might be different needed when
|
|
|
|
multiple channels of the same type exist, such as multiple
|
|
|
|
display channels in a multihead setup (json-int)
|
|
|
|
- "tls": whevener the channel is encrypted (json-bool)
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
{ "timestamp": {"seconds": 1290688046, "microseconds": 417172},
|
|
|
|
"event": "SPICE_INITIALIZED",
|
|
|
|
"data": {"server": {"auth": "spice", "port": "5921",
|
|
|
|
"family": "ipv4", "host": "127.0.0.1"},
|
|
|
|
"client": {"port": "49004", "family": "ipv4", "channel-type": 3,
|
|
|
|
"connection-id": 1804289383, "host": "127.0.0.1",
|
|
|
|
"channel-id": 0, "tls": true}
|
|
|
|
}}
|
|
|
|
|
|
|
|
|
2010-02-25 16:13:04 +01:00
|
|
|
WATCHDOG
|
|
|
|
--------
|
|
|
|
|
|
|
|
Emitted when the watchdog device's timer is expired.
|
|
|
|
|
|
|
|
Data:
|
|
|
|
|
|
|
|
- "action": Action that has been taken, it's one of the following (json-string):
|
|
|
|
"reset", "shutdown", "poweroff", "pause", "debug", or "none"
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
{ "event": "WATCHDOG",
|
|
|
|
"data": { "action": "reset" },
|
|
|
|
"timestamp": { "seconds": 1267061043, "microseconds": 959568 } }
|
|
|
|
|
|
|
|
Note: If action is "reset", "shutdown", or "pause" the WATCHDOG event is
|
|
|
|
followed respectively by the RESET, SHUTDOWN, or STOP events.
|
2012-01-18 15:40:46 +01:00
|
|
|
|
|
|
|
|
|
|
|
BLOCK_JOB_COMPLETED
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
Emitted when a block job has completed.
|
|
|
|
|
|
|
|
Data:
|
|
|
|
|
|
|
|
- "type": Job type ("stream" for image streaming, json-string)
|
|
|
|
- "device": Device name (json-string)
|
|
|
|
- "len": Maximum progress value (json-int)
|
|
|
|
- "offset": Current progress value (json-int)
|
|
|
|
On success this is equal to len.
|
|
|
|
On failure this is less than len.
|
|
|
|
- "speed": Rate limit, bytes per second (json-int)
|
|
|
|
- "error": Error message (json-string, optional)
|
|
|
|
Only present on failure. This field contains a human-readable
|
|
|
|
error message. There are no semantics other than that streaming
|
|
|
|
has failed and clients should not try to interpret the error
|
|
|
|
string.
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
{ "event": "BLOCK_JOB_COMPLETED",
|
|
|
|
"data": { "type": "stream", "device": "virtio-disk0",
|
|
|
|
"len": 10737418240, "offset": 10737418240,
|
|
|
|
"speed": 0 },
|
|
|
|
"timestamp": { "seconds": 1267061043, "microseconds": 959568 } }
|