]>
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 | |
63 | ## | |
64 | { 'event': 'STOP' } | |
591c48fb WX |
65 | |
66 | ## | |
5072f7b3 | 67 | # @RESUME: |
591c48fb WX |
68 | # |
69 | # Emitted when the virtual machine resumes execution | |
70 | # | |
71 | # Since: 0.12.0 | |
72 | ## | |
73 | { 'event': 'RESUME' } | |
1d11a95a WX |
74 | |
75 | ## | |
5072f7b3 | 76 | # @SUSPEND: |
1d11a95a WX |
77 | # |
78 | # Emitted when guest enters a hardware suspension state, for example, S3 state, | |
79 | # which is sometimes called standby state | |
80 | # | |
81 | # Since: 1.1 | |
82 | ## | |
83 | { 'event': 'SUSPEND' } | |
2ea4100f WX |
84 | |
85 | ## | |
5072f7b3 | 86 | # @SUSPEND_DISK: |
2ea4100f WX |
87 | # |
88 | # Emitted when guest enters a hardware suspension state with data saved on | |
89 | # disk, for example, S4 state, which is sometimes called hibernate state | |
90 | # | |
91 | # Note: QEMU shuts down (similar to event @SHUTDOWN) when entering this state | |
92 | # | |
93 | # Since: 1.2 | |
94 | ## | |
95 | { 'event': 'SUSPEND_DISK' } | |
7a906f7f WX |
96 | |
97 | ## | |
5072f7b3 | 98 | # @WAKEUP: |
7a906f7f WX |
99 | # |
100 | # Emitted when the guest has woken up from suspend state and is running | |
101 | # | |
102 | # Since: 1.1 | |
103 | ## | |
104 | { 'event': 'WAKEUP' } | |
e010ad8f WX |
105 | |
106 | ## | |
5072f7b3 | 107 | # @RTC_CHANGE: |
e010ad8f WX |
108 | # |
109 | # Emitted when the guest changes the RTC time. | |
110 | # | |
111 | # @offset: offset between base RTC clock (as specified by -rtc base), and | |
112 | # new RTC clock value | |
113 | # | |
114 | # Since: 0.13.0 | |
115 | ## | |
116 | { 'event': 'RTC_CHANGE', | |
117 | 'data': { 'offset': 'int' } } | |
99eaf09c WX |
118 | |
119 | ## | |
5072f7b3 | 120 | # @WATCHDOG: |
99eaf09c WX |
121 | # |
122 | # Emitted when the watchdog device's timer is expired | |
123 | # | |
124 | # @action: action that has been taken | |
125 | # | |
126 | # Note: If action is "reset", "shutdown", or "pause" the WATCHDOG event is | |
127 | # followed respectively by the RESET, SHUTDOWN, or STOP events | |
128 | # | |
129 | # Since: 0.13.0 | |
130 | ## | |
131 | { 'event': 'WATCHDOG', | |
132 | 'data': { 'action': 'WatchdogExpirationAction' } } | |
24b699fb WX |
133 | |
134 | ## | |
5072f7b3 | 135 | # @DEVICE_DELETED: |
24b699fb WX |
136 | # |
137 | # Emitted whenever the device removal completion is acknowledged by the guest. | |
138 | # At this point, it's safe to reuse the specified device ID. Device removal can | |
139 | # be initiated by the guest or by HMP/QMP commands. | |
140 | # | |
141 | # @device: #optional, device name | |
142 | # | |
143 | # @path: device path | |
144 | # | |
145 | # Since: 1.5 | |
146 | ## | |
147 | { 'event': 'DEVICE_DELETED', | |
148 | 'data': { '*device': 'str', 'path': 'str' } } | |
06150279 WX |
149 | |
150 | ## | |
5072f7b3 | 151 | # @NIC_RX_FILTER_CHANGED: |
06150279 WX |
152 | # |
153 | # Emitted once until the 'query-rx-filter' command is executed, the first event | |
154 | # will always be emitted | |
155 | # | |
156 | # @name: #optional, net client name | |
157 | # | |
158 | # @path: device path | |
159 | # | |
160 | # Since: 1.6 | |
161 | ## | |
162 | { 'event': 'NIC_RX_FILTER_CHANGED', | |
163 | 'data': { '*name': 'str', 'path': 'str' } } | |
fb6ba0d5 WX |
164 | |
165 | ## | |
5072f7b3 | 166 | # @VNC_CONNECTED: |
fb6ba0d5 WX |
167 | # |
168 | # Emitted when a VNC client establishes a connection | |
169 | # | |
170 | # @server: server information | |
171 | # | |
172 | # @client: client information | |
173 | # | |
174 | # Note: This event is emitted before any authentication takes place, thus | |
175 | # the authentication ID is not provided | |
176 | # | |
177 | # Since: 0.13.0 | |
178 | ## | |
179 | { 'event': 'VNC_CONNECTED', | |
180 | 'data': { 'server': 'VncServerInfo', | |
181 | 'client': 'VncBasicInfo' } } | |
182 | ||
183 | ## | |
5072f7b3 | 184 | # @VNC_INITIALIZED: |
fb6ba0d5 WX |
185 | # |
186 | # Emitted after authentication takes place (if any) and the VNC session is | |
187 | # made active | |
188 | # | |
189 | # @server: server information | |
190 | # | |
191 | # @client: client information | |
192 | # | |
193 | # Since: 0.13.0 | |
194 | ## | |
195 | { 'event': 'VNC_INITIALIZED', | |
196 | 'data': { 'server': 'VncServerInfo', | |
197 | 'client': 'VncClientInfo' } } | |
198 | ||
199 | ## | |
5072f7b3 | 200 | # @VNC_DISCONNECTED: |
fb6ba0d5 WX |
201 | # |
202 | # Emitted when the connection is closed | |
203 | # | |
204 | # @server: server information | |
205 | # | |
206 | # @client: client information | |
207 | # | |
208 | # Since: 0.13.0 | |
209 | ## | |
210 | { 'event': 'VNC_DISCONNECTED', | |
211 | 'data': { 'server': 'VncServerInfo', | |
212 | 'client': 'VncClientInfo' } } | |
7cfadb6b WX |
213 | |
214 | ## | |
5072f7b3 | 215 | # @SPICE_CONNECTED: |
7cfadb6b WX |
216 | # |
217 | # Emitted when a SPICE client establishes a connection | |
218 | # | |
219 | # @server: server information | |
220 | # | |
221 | # @client: client information | |
222 | # | |
223 | # Since: 0.14.0 | |
224 | ## | |
225 | { 'event': 'SPICE_CONNECTED', | |
226 | 'data': { 'server': 'SpiceBasicInfo', | |
227 | 'client': 'SpiceBasicInfo' } } | |
228 | ||
229 | ## | |
5072f7b3 | 230 | # @SPICE_INITIALIZED: |
7cfadb6b WX |
231 | # |
232 | # Emitted after initial handshake and authentication takes place (if any) | |
233 | # and the SPICE channel is up and running | |
234 | # | |
235 | # @server: server information | |
236 | # | |
237 | # @client: client information | |
238 | # | |
239 | # Since: 0.14.0 | |
240 | ## | |
241 | { 'event': 'SPICE_INITIALIZED', | |
242 | 'data': { 'server': 'SpiceServerInfo', | |
243 | 'client': 'SpiceChannel' } } | |
244 | ||
245 | ## | |
5072f7b3 | 246 | # @SPICE_DISCONNECTED: |
7cfadb6b WX |
247 | # |
248 | # Emitted when the SPICE connection is closed | |
249 | # | |
250 | # @server: server information | |
251 | # | |
252 | # @client: client information | |
253 | # | |
254 | # Since: 0.14.0 | |
255 | ## | |
256 | { 'event': 'SPICE_DISCONNECTED', | |
257 | 'data': { 'server': 'SpiceBasicInfo', | |
258 | 'client': 'SpiceBasicInfo' } } | |
259 | ||
260 | ## | |
5072f7b3 | 261 | # @SPICE_MIGRATE_COMPLETED: |
7cfadb6b WX |
262 | # |
263 | # Emitted when SPICE migration has completed | |
264 | # | |
265 | # Since: 1.3 | |
266 | ## | |
267 | { 'event': 'SPICE_MIGRATE_COMPLETED' } | |
5f41fbba | 268 | |
598cd2bd | 269 | ## |
5072f7b3 | 270 | # @MIGRATION: |
598cd2bd JQ |
271 | # |
272 | # Emitted when a migration event happens | |
273 | # | |
274 | # @status: @MigrationStatus describing the current migration status. | |
275 | # | |
276 | # Since: 2.4 | |
277 | ## | |
278 | { 'event': 'MIGRATION', | |
279 | 'data': {'status': 'MigrationStatus'}} | |
280 | ||
4addcd4f | 281 | ## |
5072f7b3 | 282 | # @MIGRATION_PASS: |
4addcd4f DDAG |
283 | # |
284 | # Emitted from the source side of a migration at the start of each pass | |
285 | # (when it syncs the dirty bitmap) | |
286 | # | |
287 | # @pass: An incrementing count (starting at 1 on the first pass) | |
288 | # | |
289 | # Since: 2.6 | |
290 | ## | |
291 | { 'event': 'MIGRATION_PASS', | |
292 | 'data': { 'pass': 'int' } } | |
293 | ||
5f41fbba | 294 | ## |
5072f7b3 | 295 | # @ACPI_DEVICE_OST: |
5f41fbba IM |
296 | # |
297 | # Emitted when guest executes ACPI _OST method. | |
298 | # | |
5f41fbba | 299 | # @info: ACPIOSTInfo type as described in qapi-schema.json |
5807ff88 MAL |
300 | # |
301 | # Since: 2.1 | |
5f41fbba IM |
302 | ## |
303 | { 'event': 'ACPI_DEVICE_OST', | |
304 | 'data': { 'info': 'ACPIOSTInfo' } } | |
aef9d311 WX |
305 | |
306 | ## | |
5072f7b3 | 307 | # @BALLOON_CHANGE: |
aef9d311 WX |
308 | # |
309 | # Emitted when the guest changes the actual BALLOON level. This value is | |
310 | # equivalent to the @actual field return by the 'query-balloon' command | |
311 | # | |
312 | # @actual: actual level of the guest memory balloon in bytes | |
313 | # | |
314 | # Since: 1.2 | |
315 | ## | |
316 | { 'event': 'BALLOON_CHANGE', | |
317 | 'data': { 'actual': 'int' } } | |
3a449690 WX |
318 | |
319 | ## | |
5072f7b3 | 320 | # @GUEST_PANICKED: |
3a449690 WX |
321 | # |
322 | # Emitted when guest OS panic is detected | |
323 | # | |
324 | # @action: action that has been taken, currently always "pause" | |
325 | # | |
326 | # Since: 1.5 | |
327 | ## | |
328 | { 'event': 'GUEST_PANICKED', | |
329 | 'data': { 'action': 'GuestPanicAction' } } | |
fe069d9d WX |
330 | |
331 | ## | |
5072f7b3 | 332 | # @QUORUM_FAILURE: |
fe069d9d WX |
333 | # |
334 | # Emitted by the Quorum block driver if it fails to establish a quorum | |
335 | # | |
336 | # @reference: device name if defined else node name | |
337 | # | |
338 | # @sector-num: number of the first sector of the failed read operation | |
339 | # | |
4e855baa | 340 | # @sectors-count: failed read operation sector count |
fe069d9d WX |
341 | # |
342 | # Since: 2.0 | |
343 | ## | |
344 | { 'event': 'QUORUM_FAILURE', | |
4e855baa | 345 | 'data': { 'reference': 'str', 'sector-num': 'int', 'sectors-count': 'int' } } |
fe069d9d WX |
346 | |
347 | ## | |
5072f7b3 | 348 | # @QUORUM_REPORT_BAD: |
fe069d9d WX |
349 | # |
350 | # Emitted to report a corruption of a Quorum file | |
351 | # | |
0ae053b7 CX |
352 | # @type: quorum operation type (Since 2.6) |
353 | # | |
fe069d9d WX |
354 | # @error: #optional, error message. Only present on failure. This field |
355 | # contains a human-readable error message. There are no semantics other | |
356 | # than that the block layer reported an error and clients should not | |
357 | # try to interpret the error string. | |
358 | # | |
359 | # @node-name: the graph node name of the block driver state | |
360 | # | |
361 | # @sector-num: number of the first sector of the failed read operation | |
362 | # | |
4e855baa | 363 | # @sectors-count: failed read operation sector count |
fe069d9d WX |
364 | # |
365 | # Since: 2.0 | |
366 | ## | |
367 | { 'event': 'QUORUM_REPORT_BAD', | |
0ae053b7 | 368 | 'data': { 'type': 'QuorumOpType', '*error': 'str', 'node-name': 'str', |
4e855baa | 369 | 'sector-num': 'int', 'sectors-count': 'int' } } |
e2ae6159 LE |
370 | |
371 | ## | |
5072f7b3 | 372 | # @VSERPORT_CHANGE: |
e2ae6159 LE |
373 | # |
374 | # Emitted when the guest opens or closes a virtio-serial port. | |
375 | # | |
376 | # @id: device identifier of the virtio-serial port | |
377 | # | |
378 | # @open: true if the guest has opened the virtio-serial port | |
379 | # | |
380 | # Since: 2.1 | |
381 | ## | |
382 | { 'event': 'VSERPORT_CHANGE', | |
383 | 'data': { 'id': 'str', 'open': 'bool' } } | |
bc09e061 ZG |
384 | |
385 | ## | |
5072f7b3 | 386 | # @MEM_UNPLUG_ERROR: |
bc09e061 ZG |
387 | # |
388 | # Emitted when memory hot unplug error occurs. | |
389 | # | |
390 | # @device: device name | |
391 | # | |
392 | # @msg: Informative message | |
393 | # | |
394 | # Since: 2.4 | |
395 | ## | |
396 | { 'event': 'MEM_UNPLUG_ERROR', | |
397 | 'data': { 'device': 'str', 'msg': 'str' } } | |
d42a0d14 PX |
398 | |
399 | ## | |
5072f7b3 | 400 | # @DUMP_COMPLETED: |
d42a0d14 PX |
401 | # |
402 | # Emitted when background dump has completed | |
403 | # | |
404 | # @result: DumpQueryResult type described in qapi-schema.json. | |
405 | # | |
406 | # @error: #optional human-readable error string that provides | |
407 | # hint on why dump failed. Only presents on failure. The | |
408 | # user should not try to interpret the error string. | |
409 | # | |
410 | # Since: 2.6 | |
411 | ## | |
412 | { 'event': 'DUMP_COMPLETED' , | |
413 | 'data': { 'result': 'DumpQueryResult', '*error': 'str' } } |