]>
Commit | Line | Data |
---|---|---|
d3a48372 MAL |
1 | # -*- Mode: Python -*- |
2 | ||
3 | ## | |
4 | # = Other events | |
5 | ## | |
6 | ||
84321831 | 7 | ## |
5072f7b3 | 8 | # @SHUTDOWN: |
84321831 | 9 | # |
2f44a08b WX |
10 | # Emitted when the virtual machine has shut down, indicating that qemu is |
11 | # about to exit. | |
84321831 WX |
12 | # |
13 | # Note: If the command-line option "-no-shutdown" has been specified, qemu will | |
14 | # not exit, and a STOP event will eventually follow the SHUTDOWN event | |
15 | # | |
16 | # Since: 0.12.0 | |
12defe50 MAL |
17 | # |
18 | # Example: | |
19 | # | |
20 | # <- { "event": "SHUTDOWN", | |
21 | # "timestamp": { "seconds": 1267040730, "microseconds": 682951 } } | |
22 | # | |
84321831 WX |
23 | ## |
24 | { 'event': 'SHUTDOWN' } | |
0aab9ec3 WX |
25 | |
26 | ## | |
5072f7b3 | 27 | # @POWERDOWN: |
0aab9ec3 WX |
28 | # |
29 | # Emitted when the virtual machine is powered down through the power control | |
30 | # system, such as via ACPI. | |
31 | # | |
32 | # Since: 0.12.0 | |
189d43be MAL |
33 | # |
34 | # Example: | |
35 | # | |
36 | # <- { "event": "POWERDOWN", | |
37 | # "timestamp": { "seconds": 1267040730, "microseconds": 682951 } } | |
38 | # | |
0aab9ec3 WX |
39 | ## |
40 | { 'event': 'POWERDOWN' } | |
a6330785 WX |
41 | |
42 | ## | |
5072f7b3 | 43 | # @RESET: |
a6330785 WX |
44 | # |
45 | # Emitted when the virtual machine is reset | |
46 | # | |
47 | # Since: 0.12.0 | |
7a2aae7a MAL |
48 | # |
49 | # Example: | |
50 | # | |
51 | # <- { "event": "RESET", | |
52 | # "timestamp": { "seconds": 1267041653, "microseconds": 9518 } } | |
53 | # | |
a6330785 WX |
54 | ## |
55 | { 'event': 'RESET' } | |
a4e15de9 WX |
56 | |
57 | ## | |
5072f7b3 | 58 | # @STOP: |
a4e15de9 WX |
59 | # |
60 | # Emitted when the virtual machine is stopped | |
61 | # | |
62 | # Since: 0.12.0 | |
138c454c MAL |
63 | # |
64 | # Example: | |
65 | # | |
66 | # <- { "event": "STOP", | |
67 | # "timestamp": { "seconds": 1267041730, "microseconds": 281295 } } | |
68 | # | |
a4e15de9 WX |
69 | ## |
70 | { 'event': 'STOP' } | |
591c48fb WX |
71 | |
72 | ## | |
5072f7b3 | 73 | # @RESUME: |
591c48fb WX |
74 | # |
75 | # Emitted when the virtual machine resumes execution | |
76 | # | |
77 | # Since: 0.12.0 | |
a2235a04 MAL |
78 | # |
79 | # Example: | |
80 | # | |
81 | # <- { "event": "RESUME", | |
82 | # "timestamp": { "seconds": 1271770767, "microseconds": 582542 } } | |
83 | # | |
591c48fb WX |
84 | ## |
85 | { 'event': 'RESUME' } | |
1d11a95a WX |
86 | |
87 | ## | |
5072f7b3 | 88 | # @SUSPEND: |
1d11a95a WX |
89 | # |
90 | # Emitted when guest enters a hardware suspension state, for example, S3 state, | |
91 | # which is sometimes called standby state | |
92 | # | |
93 | # Since: 1.1 | |
6f3cc540 MAL |
94 | # |
95 | # Example: | |
96 | # | |
97 | # <- { "event": "SUSPEND", | |
98 | # "timestamp": { "seconds": 1344456160, "microseconds": 309119 } } | |
99 | # | |
1d11a95a WX |
100 | ## |
101 | { 'event': 'SUSPEND' } | |
2ea4100f WX |
102 | |
103 | ## | |
5072f7b3 | 104 | # @SUSPEND_DISK: |
2ea4100f WX |
105 | # |
106 | # Emitted when guest enters a hardware suspension state with data saved on | |
107 | # disk, for example, S4 state, which is sometimes called hibernate state | |
108 | # | |
109 | # Note: QEMU shuts down (similar to event @SHUTDOWN) when entering this state | |
110 | # | |
111 | # Since: 1.2 | |
4de62c38 MAL |
112 | # |
113 | # Example: | |
114 | # | |
115 | # <- { "event": "SUSPEND_DISK", | |
116 | # "timestamp": { "seconds": 1344456160, "microseconds": 309119 } } | |
117 | # | |
2ea4100f WX |
118 | ## |
119 | { 'event': 'SUSPEND_DISK' } | |
7a906f7f WX |
120 | |
121 | ## | |
5072f7b3 | 122 | # @WAKEUP: |
7a906f7f WX |
123 | # |
124 | # Emitted when the guest has woken up from suspend state and is running | |
125 | # | |
126 | # Since: 1.1 | |
aa496f98 MAL |
127 | # |
128 | # Example: | |
129 | # | |
130 | # <- { "event": "WAKEUP", | |
131 | # "timestamp": { "seconds": 1344522075, "microseconds": 745528 } } | |
132 | # | |
7a906f7f WX |
133 | ## |
134 | { 'event': 'WAKEUP' } | |
e010ad8f WX |
135 | |
136 | ## | |
5072f7b3 | 137 | # @RTC_CHANGE: |
e010ad8f WX |
138 | # |
139 | # Emitted when the guest changes the RTC time. | |
140 | # | |
141 | # @offset: offset between base RTC clock (as specified by -rtc base), and | |
142 | # new RTC clock value | |
143 | # | |
73c41bfd MAL |
144 | # Note: This event is rate-limited. |
145 | # | |
e010ad8f | 146 | # Since: 0.13.0 |
73c41bfd MAL |
147 | # |
148 | # Example: | |
149 | # | |
150 | # <- { "event": "RTC_CHANGE", | |
151 | # "data": { "offset": 78 }, | |
152 | # "timestamp": { "seconds": 1267020223, "microseconds": 435656 } } | |
153 | # | |
e010ad8f WX |
154 | ## |
155 | { 'event': 'RTC_CHANGE', | |
156 | 'data': { 'offset': 'int' } } | |
99eaf09c WX |
157 | |
158 | ## | |
5072f7b3 | 159 | # @WATCHDOG: |
99eaf09c WX |
160 | # |
161 | # Emitted when the watchdog device's timer is expired | |
162 | # | |
163 | # @action: action that has been taken | |
164 | # | |
165 | # Note: If action is "reset", "shutdown", or "pause" the WATCHDOG event is | |
166 | # followed respectively by the RESET, SHUTDOWN, or STOP events | |
167 | # | |
9ba5cec9 MAL |
168 | # Note: This event is rate-limited. |
169 | # | |
99eaf09c | 170 | # Since: 0.13.0 |
9ba5cec9 MAL |
171 | # |
172 | # Example: | |
173 | # | |
174 | # <- { "event": "WATCHDOG", | |
175 | # "data": { "action": "reset" }, | |
176 | # "timestamp": { "seconds": 1267061043, "microseconds": 959568 } } | |
177 | # | |
99eaf09c WX |
178 | ## |
179 | { 'event': 'WATCHDOG', | |
180 | 'data': { 'action': 'WatchdogExpirationAction' } } | |
24b699fb WX |
181 | |
182 | ## | |
5072f7b3 | 183 | # @DEVICE_DELETED: |
24b699fb WX |
184 | # |
185 | # Emitted whenever the device removal completion is acknowledged by the guest. | |
186 | # At this point, it's safe to reuse the specified device ID. Device removal can | |
187 | # be initiated by the guest or by HMP/QMP commands. | |
188 | # | |
189 | # @device: #optional, device name | |
190 | # | |
191 | # @path: device path | |
192 | # | |
193 | # Since: 1.5 | |
cdc94a1b MAL |
194 | # |
195 | # Example: | |
196 | # | |
197 | # <- { "event": "DEVICE_DELETED", | |
198 | # "data": { "device": "virtio-net-pci-0", | |
199 | # "path": "/machine/peripheral/virtio-net-pci-0" }, | |
200 | # "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } | |
201 | # | |
24b699fb WX |
202 | ## |
203 | { 'event': 'DEVICE_DELETED', | |
204 | 'data': { '*device': 'str', 'path': 'str' } } | |
06150279 WX |
205 | |
206 | ## | |
5072f7b3 | 207 | # @NIC_RX_FILTER_CHANGED: |
06150279 WX |
208 | # |
209 | # Emitted once until the 'query-rx-filter' command is executed, the first event | |
210 | # will always be emitted | |
211 | # | |
212 | # @name: #optional, net client name | |
213 | # | |
214 | # @path: device path | |
215 | # | |
216 | # Since: 1.6 | |
5dbdcf43 MAL |
217 | # |
218 | # Example: | |
219 | # | |
220 | # <- { "event": "NIC_RX_FILTER_CHANGED", | |
221 | # "data": { "name": "vnet0", | |
222 | # "path": "/machine/peripheral/vnet0/virtio-backend" }, | |
223 | # "timestamp": { "seconds": 1368697518, "microseconds": 326866 } } | |
224 | # } | |
225 | # | |
06150279 WX |
226 | ## |
227 | { 'event': 'NIC_RX_FILTER_CHANGED', | |
228 | 'data': { '*name': 'str', 'path': 'str' } } | |
fb6ba0d5 WX |
229 | |
230 | ## | |
5072f7b3 | 231 | # @VNC_CONNECTED: |
fb6ba0d5 WX |
232 | # |
233 | # Emitted when a VNC client establishes a connection | |
234 | # | |
235 | # @server: server information | |
236 | # | |
237 | # @client: client information | |
238 | # | |
239 | # Note: This event is emitted before any authentication takes place, thus | |
240 | # the authentication ID is not provided | |
241 | # | |
242 | # Since: 0.13.0 | |
f46052fd MAL |
243 | # |
244 | # Example: | |
245 | # | |
246 | # <- { "event": "VNC_CONNECTED", | |
247 | # "data": { | |
248 | # "server": { "auth": "sasl", "family": "ipv4", | |
249 | # "service": "5901", "host": "0.0.0.0" }, | |
250 | # "client": { "family": "ipv4", "service": "58425", | |
251 | # "host": "127.0.0.1" } }, | |
252 | # "timestamp": { "seconds": 1262976601, "microseconds": 975795 } } | |
253 | # | |
fb6ba0d5 WX |
254 | ## |
255 | { 'event': 'VNC_CONNECTED', | |
256 | 'data': { 'server': 'VncServerInfo', | |
257 | 'client': 'VncBasicInfo' } } | |
258 | ||
259 | ## | |
5072f7b3 | 260 | # @VNC_INITIALIZED: |
fb6ba0d5 WX |
261 | # |
262 | # Emitted after authentication takes place (if any) and the VNC session is | |
263 | # made active | |
264 | # | |
265 | # @server: server information | |
266 | # | |
267 | # @client: client information | |
268 | # | |
269 | # Since: 0.13.0 | |
270 | ## | |
271 | { 'event': 'VNC_INITIALIZED', | |
272 | 'data': { 'server': 'VncServerInfo', | |
273 | 'client': 'VncClientInfo' } } | |
274 | ||
275 | ## | |
5072f7b3 | 276 | # @VNC_DISCONNECTED: |
fb6ba0d5 WX |
277 | # |
278 | # Emitted when the connection is closed | |
279 | # | |
280 | # @server: server information | |
281 | # | |
282 | # @client: client information | |
283 | # | |
284 | # Since: 0.13.0 | |
285 | ## | |
286 | { 'event': 'VNC_DISCONNECTED', | |
287 | 'data': { 'server': 'VncServerInfo', | |
288 | 'client': 'VncClientInfo' } } | |
7cfadb6b WX |
289 | |
290 | ## | |
5072f7b3 | 291 | # @SPICE_CONNECTED: |
7cfadb6b WX |
292 | # |
293 | # Emitted when a SPICE client establishes a connection | |
294 | # | |
295 | # @server: server information | |
296 | # | |
297 | # @client: client information | |
298 | # | |
299 | # Since: 0.14.0 | |
300 | ## | |
301 | { 'event': 'SPICE_CONNECTED', | |
302 | 'data': { 'server': 'SpiceBasicInfo', | |
303 | 'client': 'SpiceBasicInfo' } } | |
304 | ||
305 | ## | |
5072f7b3 | 306 | # @SPICE_INITIALIZED: |
7cfadb6b WX |
307 | # |
308 | # Emitted after initial handshake and authentication takes place (if any) | |
309 | # and the SPICE channel is up and running | |
310 | # | |
311 | # @server: server information | |
312 | # | |
313 | # @client: client information | |
314 | # | |
315 | # Since: 0.14.0 | |
316 | ## | |
317 | { 'event': 'SPICE_INITIALIZED', | |
318 | 'data': { 'server': 'SpiceServerInfo', | |
319 | 'client': 'SpiceChannel' } } | |
320 | ||
321 | ## | |
5072f7b3 | 322 | # @SPICE_DISCONNECTED: |
7cfadb6b WX |
323 | # |
324 | # Emitted when the SPICE connection is closed | |
325 | # | |
326 | # @server: server information | |
327 | # | |
328 | # @client: client information | |
329 | # | |
330 | # Since: 0.14.0 | |
331 | ## | |
332 | { 'event': 'SPICE_DISCONNECTED', | |
333 | 'data': { 'server': 'SpiceBasicInfo', | |
334 | 'client': 'SpiceBasicInfo' } } | |
335 | ||
336 | ## | |
5072f7b3 | 337 | # @SPICE_MIGRATE_COMPLETED: |
7cfadb6b WX |
338 | # |
339 | # Emitted when SPICE migration has completed | |
340 | # | |
341 | # Since: 1.3 | |
342 | ## | |
343 | { 'event': 'SPICE_MIGRATE_COMPLETED' } | |
5f41fbba | 344 | |
598cd2bd | 345 | ## |
5072f7b3 | 346 | # @MIGRATION: |
598cd2bd JQ |
347 | # |
348 | # Emitted when a migration event happens | |
349 | # | |
350 | # @status: @MigrationStatus describing the current migration status. | |
351 | # | |
352 | # Since: 2.4 | |
353 | ## | |
354 | { 'event': 'MIGRATION', | |
355 | 'data': {'status': 'MigrationStatus'}} | |
356 | ||
4addcd4f | 357 | ## |
5072f7b3 | 358 | # @MIGRATION_PASS: |
4addcd4f DDAG |
359 | # |
360 | # Emitted from the source side of a migration at the start of each pass | |
361 | # (when it syncs the dirty bitmap) | |
362 | # | |
363 | # @pass: An incrementing count (starting at 1 on the first pass) | |
364 | # | |
365 | # Since: 2.6 | |
366 | ## | |
367 | { 'event': 'MIGRATION_PASS', | |
368 | 'data': { 'pass': 'int' } } | |
369 | ||
5f41fbba | 370 | ## |
5072f7b3 | 371 | # @ACPI_DEVICE_OST: |
5f41fbba IM |
372 | # |
373 | # Emitted when guest executes ACPI _OST method. | |
374 | # | |
5f41fbba | 375 | # @info: ACPIOSTInfo type as described in qapi-schema.json |
5807ff88 MAL |
376 | # |
377 | # Since: 2.1 | |
5f41fbba IM |
378 | ## |
379 | { 'event': 'ACPI_DEVICE_OST', | |
380 | 'data': { 'info': 'ACPIOSTInfo' } } | |
aef9d311 WX |
381 | |
382 | ## | |
5072f7b3 | 383 | # @BALLOON_CHANGE: |
aef9d311 WX |
384 | # |
385 | # Emitted when the guest changes the actual BALLOON level. This value is | |
386 | # equivalent to the @actual field return by the 'query-balloon' command | |
387 | # | |
388 | # @actual: actual level of the guest memory balloon in bytes | |
389 | # | |
390 | # Since: 1.2 | |
391 | ## | |
392 | { 'event': 'BALLOON_CHANGE', | |
393 | 'data': { 'actual': 'int' } } | |
3a449690 WX |
394 | |
395 | ## | |
5072f7b3 | 396 | # @GUEST_PANICKED: |
3a449690 WX |
397 | # |
398 | # Emitted when guest OS panic is detected | |
399 | # | |
400 | # @action: action that has been taken, currently always "pause" | |
401 | # | |
402 | # Since: 1.5 | |
403 | ## | |
404 | { 'event': 'GUEST_PANICKED', | |
405 | 'data': { 'action': 'GuestPanicAction' } } | |
fe069d9d WX |
406 | |
407 | ## | |
5072f7b3 | 408 | # @QUORUM_FAILURE: |
fe069d9d WX |
409 | # |
410 | # Emitted by the Quorum block driver if it fails to establish a quorum | |
411 | # | |
412 | # @reference: device name if defined else node name | |
413 | # | |
414 | # @sector-num: number of the first sector of the failed read operation | |
415 | # | |
4e855baa | 416 | # @sectors-count: failed read operation sector count |
fe069d9d WX |
417 | # |
418 | # Since: 2.0 | |
419 | ## | |
420 | { 'event': 'QUORUM_FAILURE', | |
4e855baa | 421 | 'data': { 'reference': 'str', 'sector-num': 'int', 'sectors-count': 'int' } } |
fe069d9d WX |
422 | |
423 | ## | |
5072f7b3 | 424 | # @QUORUM_REPORT_BAD: |
fe069d9d WX |
425 | # |
426 | # Emitted to report a corruption of a Quorum file | |
427 | # | |
0ae053b7 CX |
428 | # @type: quorum operation type (Since 2.6) |
429 | # | |
fe069d9d WX |
430 | # @error: #optional, error message. Only present on failure. This field |
431 | # contains a human-readable error message. There are no semantics other | |
432 | # than that the block layer reported an error and clients should not | |
433 | # try to interpret the error string. | |
434 | # | |
435 | # @node-name: the graph node name of the block driver state | |
436 | # | |
437 | # @sector-num: number of the first sector of the failed read operation | |
438 | # | |
4e855baa | 439 | # @sectors-count: failed read operation sector count |
fe069d9d WX |
440 | # |
441 | # Since: 2.0 | |
442 | ## | |
443 | { 'event': 'QUORUM_REPORT_BAD', | |
0ae053b7 | 444 | 'data': { 'type': 'QuorumOpType', '*error': 'str', 'node-name': 'str', |
4e855baa | 445 | 'sector-num': 'int', 'sectors-count': 'int' } } |
e2ae6159 LE |
446 | |
447 | ## | |
5072f7b3 | 448 | # @VSERPORT_CHANGE: |
e2ae6159 LE |
449 | # |
450 | # Emitted when the guest opens or closes a virtio-serial port. | |
451 | # | |
452 | # @id: device identifier of the virtio-serial port | |
453 | # | |
454 | # @open: true if the guest has opened the virtio-serial port | |
455 | # | |
456 | # Since: 2.1 | |
457 | ## | |
458 | { 'event': 'VSERPORT_CHANGE', | |
459 | 'data': { 'id': 'str', 'open': 'bool' } } | |
bc09e061 ZG |
460 | |
461 | ## | |
5072f7b3 | 462 | # @MEM_UNPLUG_ERROR: |
bc09e061 ZG |
463 | # |
464 | # Emitted when memory hot unplug error occurs. | |
465 | # | |
466 | # @device: device name | |
467 | # | |
468 | # @msg: Informative message | |
469 | # | |
470 | # Since: 2.4 | |
471 | ## | |
472 | { 'event': 'MEM_UNPLUG_ERROR', | |
473 | 'data': { 'device': 'str', 'msg': 'str' } } | |
d42a0d14 PX |
474 | |
475 | ## | |
5072f7b3 | 476 | # @DUMP_COMPLETED: |
d42a0d14 PX |
477 | # |
478 | # Emitted when background dump has completed | |
479 | # | |
480 | # @result: DumpQueryResult type described in qapi-schema.json. | |
481 | # | |
482 | # @error: #optional human-readable error string that provides | |
483 | # hint on why dump failed. Only presents on failure. The | |
484 | # user should not try to interpret the error string. | |
485 | # | |
486 | # Since: 2.6 | |
487 | ## | |
488 | { 'event': 'DUMP_COMPLETED' , | |
489 | 'data': { 'result': 'DumpQueryResult', '*error': 'str' } } |