From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:47168) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1X9hC0-0001Ve-99 for qemu-devel@nongnu.org; Tue, 22 Jul 2014 17:01:58 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1X9hBq-0001mx-E9 for qemu-devel@nongnu.org; Tue, 22 Jul 2014 17:01:48 -0400 Received: from qmta01.emeryville.ca.mail.comcast.net ([2001:558:fe2d:43:76:96:30:16]:60527) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1X9hBq-0001ms-5B for qemu-devel@nongnu.org; Tue, 22 Jul 2014 17:01:38 -0400 From: Eric Blake Date: Tue, 22 Jul 2014 15:01:32 -0600 Message-Id: <1406062892-4982-1-git-send-email-eblake@redhat.com> Subject: [Qemu-devel] [PATCH for-2.1] docs: document remaining QMP events List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: qemu-devel@nongnu.org Cc: pbonzini@redhat.com, wenchaoqemu@gmail.com, lcapitulino@redhat.com Commit dfab4892 restored this file, but did not address any of the grammar problems that had been fixed in passing when moving events out of this file. There are also a couple events that were undocumented since introduction, and one that had been added only in the time that this file was temporarily deleted. * docs/qmp/qmp-events.txt (POWERDOWN, SPICE_MIGRATE_COMPLETED) (VSERPORT_CHANGE): Add. (RESET, SPICE_INITIALIZED): Fix grammar. (SPICE_CONNECTED, SPICE_DISCONNECTED): Split. Signed-off-by: Eric Blake --- docs/qmp/qmp-events.txt | 80 +++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 74 insertions(+), 6 deletions(-) diff --git a/docs/qmp/qmp-events.txt b/docs/qmp/qmp-events.txt index 4a6c2a2..78dd76a 100644 --- a/docs/qmp/qmp-events.txt +++ b/docs/qmp/qmp-events.txt @@ -243,6 +243,19 @@ Data: "timestamp": { "seconds": 1368697518, "microseconds": 326866 } } } +POWERDOWN +--------- + +Emitted when the Virtual Machine is powered down through the power +control system, such as via ACPI. + +Data: None. + +Example: + +{ "event": "POWERDOWN", + "timestamp": { "seconds": 1267040730, "microseconds": 682951 } } + QUORUM_FAILURE -------------- @@ -285,7 +298,7 @@ Example: RESET ----- -Emitted when the Virtual Machine is reseted. +Emitted when the Virtual Machine is reset. Data: None. @@ -325,7 +338,8 @@ Example: SHUTDOWN -------- -Emitted when the Virtual Machine is powered down. +Emitted when the Virtual Machine has shut down, indicating that qemu +is about to exit. Data: None. @@ -337,10 +351,10 @@ Example: Note: If the command-line option "-no-shutdown" has been specified, a STOP event will eventually follow the SHUTDOWN event. -SPICE_CONNECTED, SPICE_DISCONNECTED ------------------------------------ +SPICE_CONNECTED +--------------- -Emitted when a SPICE client connects or disconnects. +Emitted when a SPICE client connects. Data: @@ -362,11 +376,36 @@ Example: "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"} }} +SPICE_DISCONNECTED +------------------ + +Emitted when a SPICE client 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_DISCONNECTED", + "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 +and the SPICE channel is up and running Data: @@ -399,6 +438,19 @@ Example: "channel-id": 0, "tls": true} }} +SPICE_INITIALIZED +----------------- + +Emitted when SPICE migration has completed + +Data: None. + +Example: + +{ "timestamp": {"seconds": 1290688046, "microseconds": 417172}, + "event": "SPICE_MIGRATE_COMPLETED" } + + STOP ---- @@ -527,6 +579,22 @@ Example: "host": "127.0.0.1", "sasl_username": "luiz" } }, "timestamp": { "seconds": 1263475302, "microseconds": 150772 } } +VSERPORT_CHANGE +--------------- + +Emitted when the guest opens or closes a virtio-serial port. + +Data: + +- "id": device identifier of the virtio-serial port (json-string) +- "open": true if the guest has opened the virtio-serial port (json-bool) + +Example: + +{ "event": "VSERPORT_CHANGE", + "data": { "id": "channel0", "open": true }, + "timestamp": { "seconds": 1401385907, "microseconds": 422329 } } + WAKEUP ------ -- 1.9.3