qapi event: convert VNC events
[qemu.git] / docs / qmp / qmp-events.txt
1                    QEMU Machine Protocol Events
2                    ============================
3
4 ACPI_DEVICE_OST
5 ---------------
6
7 Emitted when guest executes ACPI _OST method.
8
9  - data: ACPIOSTInfo type as described in qapi-schema.json
10
11 { "event": "ACPI_DEVICE_OST",
12      "data": { "device": "d1", "slot": "0", "slot-type": "DIMM", "source": 1, "status": 0 } }
13
14 BALLOON_CHANGE
15 --------------
16
17 Emitted when the guest changes the actual BALLOON level. This
18 value is equivalent to the 'actual' field return by the
19 'query-balloon' command
20
21 Data:
22
23 - "actual": actual level of the guest memory balloon in bytes (json-number)
24
25 Example:
26
27 { "event": "BALLOON_CHANGE",
28     "data": { "actual": 944766976 },
29     "timestamp": { "seconds": 1267020223, "microseconds": 435656 } }
30
31 GUEST_PANICKED
32 --------------
33
34 Emitted when guest OS panic is detected.
35
36 Data:
37
38 - "action": Action that has been taken (json-string, currently always "pause").
39
40 Example:
41
42 { "event": "GUEST_PANICKED",
43      "data": { "action": "pause" } }
44
45 QUORUM_FAILURE
46 --------------
47
48 Emitted by the Quorum block driver if it fails to establish a quorum.
49
50 Data:
51
52 - "reference":    device name if defined else node name.
53 - "sector-num":   Number of the first sector of the failed read operation.
54 - "sector-count": Failed read operation sector count.
55
56 Example:
57
58 { "event": "QUORUM_FAILURE",
59      "data": { "reference": "usr1", "sector-num": 345435, "sector-count": 5 },
60      "timestamp": { "seconds": 1344522075, "microseconds": 745528 } }
61
62 QUORUM_REPORT_BAD
63 -----------------
64
65 Emitted to report a corruption of a Quorum file.
66
67 Data:
68
69 - "error":        Error message (json-string, optional)
70                   Only present on failure.  This field contains a human-readable
71                   error message.  There are no semantics other than that the
72                   block layer reported an error and clients should not try to
73                   interpret the error string.
74 - "node-name":    The graph node name of the block driver state.
75 - "sector-num":   Number of the first sector of the failed read operation.
76 - "sector-count": Failed read operation sector count.
77
78 Example:
79
80 { "event": "QUORUM_REPORT_BAD",
81      "data": { "node-name": "1.raw", "sector-num": 345435, "sector-count": 5 },
82      "timestamp": { "seconds": 1344522075, "microseconds": 745528 } }
83
84 SPICE_CONNECTED, SPICE_DISCONNECTED
85 -----------------------------------
86
87 Emitted when a SPICE client connects or disconnects.
88
89 Data:
90
91 - "server": Server information (json-object)
92   - "host": IP address (json-string)
93   - "port": port number (json-string)
94   - "family": address family (json-string, "ipv4" or "ipv6")
95 - "client": Client information (json-object)
96   - "host": IP address (json-string)
97   - "port": port number (json-string)
98   - "family": address family (json-string, "ipv4" or "ipv6")
99
100 Example:
101
102 { "timestamp": {"seconds": 1290688046, "microseconds": 388707},
103   "event": "SPICE_CONNECTED",
104   "data": {
105     "server": { "port": "5920", "family": "ipv4", "host": "127.0.0.1"},
106     "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"}
107 }}
108
109 SPICE_INITIALIZED
110 -----------------
111
112 Emitted after initial handshake and authentication takes place (if any)
113 and the SPICE channel is up'n'running
114
115 Data:
116
117 - "server": Server information (json-object)
118   - "host": IP address (json-string)
119   - "port": port number (json-string)
120   - "family": address family (json-string, "ipv4" or "ipv6")
121   - "auth": authentication method (json-string, optional)
122 - "client": Client information (json-object)
123   - "host": IP address (json-string)
124   - "port": port number (json-string)
125   - "family": address family (json-string, "ipv4" or "ipv6")
126   - "connection-id": spice connection id.  All channels with the same id
127                      belong to the same spice session (json-int)
128   - "channel-type": channel type.  "1" is the main control channel, filter for
129                     this one if you want track spice sessions only (json-int)
130   - "channel-id": channel id.  Usually "0", might be different needed when
131                   multiple channels of the same type exist, such as multiple
132                   display channels in a multihead setup (json-int)
133   - "tls": whevener the channel is encrypted (json-bool)
134
135 Example:
136
137 { "timestamp": {"seconds": 1290688046, "microseconds": 417172},
138   "event": "SPICE_INITIALIZED",
139   "data": {"server": {"auth": "spice", "port": "5921",
140                       "family": "ipv4", "host": "127.0.0.1"},
141            "client": {"port": "49004", "family": "ipv4", "channel-type": 3,
142                       "connection-id": 1804289383, "host": "127.0.0.1",
143                       "channel-id": 0, "tls": true}
144 }}