qmp: qmp-events.txt: put events in alphabetical order
Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com> Reviewed-by: Eric Blake <eblake@redhat.com> Acked-by: Gerd Hoffmann <kraxel@redhat.com>
This commit is contained in:
Luiz Capitulino
parent
17c8660b0b
commit
cb8900fe0d
@ -1,6 +1,23 @@
|
|||||||
QEMU Monitor Protocol Events
|
QEMU Monitor Protocol Events
|
||||||
============================
|
============================
|
||||||
|
|
||||||
|
BALLOON_CHANGE
|
||||||
|
--------------
|
||||||
|
|
||||||
|
Emitted when the guest changes the actual BALLOON level. This
|
||||||
|
value is equivalent to the 'actual' field return by the
|
||||||
|
'query-balloon' command
|
||||||
|
|
||||||
|
Data:
|
||||||
|
|
||||||
|
- "actual": actual level of the guest memory balloon in bytes (json-number)
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
{ "event": "BALLOON_CHANGE",
|
||||||
|
"data": { "actual": 944766976 },
|
||||||
|
"timestamp": { "seconds": 1267020223, "microseconds": 435656 } }
|
||||||
|
|
||||||
BLOCK_IO_ERROR
|
BLOCK_IO_ERROR
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
@ -26,6 +43,57 @@ Example:
|
|||||||
Note: If action is "stop", a STOP event will eventually follow the
|
Note: If action is "stop", a STOP event will eventually follow the
|
||||||
BLOCK_IO_ERROR event.
|
BLOCK_IO_ERROR event.
|
||||||
|
|
||||||
|
BLOCK_JOB_CANCELLED
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
Emitted when a block job has been cancelled.
|
||||||
|
|
||||||
|
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)
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
{ "event": "BLOCK_JOB_CANCELLED",
|
||||||
|
"data": { "type": "stream", "device": "virtio-disk0",
|
||||||
|
"len": 10737418240, "offset": 134217728,
|
||||||
|
"speed": 0 },
|
||||||
|
"timestamp": { "seconds": 1267061043, "microseconds": 959568 } }
|
||||||
|
|
||||||
|
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 } }
|
||||||
|
|
||||||
DEVICE_TRAY_MOVED
|
DEVICE_TRAY_MOVED
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
@ -98,6 +166,68 @@ Example:
|
|||||||
Note: If the command-line option "-no-shutdown" has been specified, a STOP
|
Note: If the command-line option "-no-shutdown" has been specified, a STOP
|
||||||
event will eventually follow the SHUTDOWN event.
|
event will eventually follow the SHUTDOWN event.
|
||||||
|
|
||||||
|
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}
|
||||||
|
}}
|
||||||
|
|
||||||
STOP
|
STOP
|
||||||
----
|
----
|
||||||
|
|
||||||
@ -200,70 +330,6 @@ Example:
|
|||||||
"host": "127.0.0.1", "sasl_username": "luiz" } },
|
"host": "127.0.0.1", "sasl_username": "luiz" } },
|
||||||
"timestamp": { "seconds": 1263475302, "microseconds": 150772 } }
|
"timestamp": { "seconds": 1263475302, "microseconds": 150772 } }
|
||||||
|
|
||||||
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}
|
|
||||||
}}
|
|
||||||
|
|
||||||
|
|
||||||
WAKEUP
|
WAKEUP
|
||||||
------
|
------
|
||||||
|
|
||||||
@ -276,7 +342,6 @@ Example:
|
|||||||
{ "event": "WATCHDOG",
|
{ "event": "WATCHDOG",
|
||||||
"timestamp": { "seconds": 1344522075, "microseconds": 745528 } }
|
"timestamp": { "seconds": 1344522075, "microseconds": 745528 } }
|
||||||
|
|
||||||
|
|
||||||
WATCHDOG
|
WATCHDOG
|
||||||
--------
|
--------
|
||||||
|
|
||||||
@ -295,74 +360,3 @@ Example:
|
|||||||
|
|
||||||
Note: If action is "reset", "shutdown", or "pause" the WATCHDOG event is
|
Note: If action is "reset", "shutdown", or "pause" the WATCHDOG event is
|
||||||
followed respectively by the RESET, SHUTDOWN, or STOP events.
|
followed respectively by the RESET, SHUTDOWN, or STOP events.
|
||||||
|
|
||||||
|
|
||||||
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 } }
|
|
||||||
|
|
||||||
|
|
||||||
BLOCK_JOB_CANCELLED
|
|
||||||
-------------------
|
|
||||||
|
|
||||||
Emitted when a block job has been cancelled.
|
|
||||||
|
|
||||||
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)
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
{ "event": "BLOCK_JOB_CANCELLED",
|
|
||||||
"data": { "type": "stream", "device": "virtio-disk0",
|
|
||||||
"len": 10737418240, "offset": 134217728,
|
|
||||||
"speed": 0 },
|
|
||||||
"timestamp": { "seconds": 1267061043, "microseconds": 959568 } }
|
|
||||||
|
|
||||||
|
|
||||||
BALLOON_CHANGE
|
|
||||||
----------
|
|
||||||
|
|
||||||
Emitted when the guest changes the actual BALLOON level. This
|
|
||||||
value is equivalent to the 'actual' field return by the
|
|
||||||
'query-balloon' command
|
|
||||||
|
|
||||||
Data:
|
|
||||||
|
|
||||||
- "actual": actual level of the guest memory balloon in bytes (json-number)
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
{ "event": "BALLOON_CHANGE",
|
|
||||||
"data": { "actual": 944766976 },
|
|
||||||
"timestamp": { "seconds": 1267020223, "microseconds": 435656 } }
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user