]>
Commit | Line | Data |
---|---|---|
dfab4892 LC |
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 | ||
7f1e7b23 MA |
31 | Note: this event is rate-limited. |
32 | ||
d42a0d14 PX |
33 | DUMP_COMPLETED |
34 | -------------- | |
35 | ||
36 | Emitted when the guest has finished one memory dump. | |
37 | ||
38 | Data: | |
39 | ||
40 | - "result": DumpQueryResult type described in qapi-schema.json | |
41 | - "error": Error message when dump failed. This is only a | |
42 | human-readable string provided when dump failed. It should not be | |
43 | parsed in any way (json-string, optional) | |
44 | ||
45 | Example: | |
46 | ||
47 | { "event": "DUMP_COMPLETED", | |
48 | "data": {"result": {"total": 1090650112, "status": "completed", | |
49 | "completed": 1090650112} } } | |
50 | ||
dfab4892 LC |
51 | GUEST_PANICKED |
52 | -------------- | |
53 | ||
54 | Emitted when guest OS panic is detected. | |
55 | ||
56 | Data: | |
57 | ||
58 | - "action": Action that has been taken (json-string, currently always "pause"). | |
59 | ||
60 | Example: | |
61 | ||
62 | { "event": "GUEST_PANICKED", | |
63 | "data": { "action": "pause" } } | |
64 | ||
777abdfe | 65 | MEM_UNPLUG_ERROR |
bc09e061 ZG |
66 | -------------------- |
67 | Emitted when memory hot unplug error occurs. | |
68 | ||
69 | Data: | |
70 | ||
71 | - "device": device name (json-string) | |
72 | - "msg": Informative message (e.g., reason for the error) (json-string) | |
73 | ||
74 | Example: | |
75 | ||
777abdfe | 76 | { "event": "MEM_UNPLUG_ERROR" |
bc09e061 ZG |
77 | "data": { "device": "dimm1", |
78 | "msg": "acpi: device unplug for unsupported device" | |
79 | }, | |
80 | "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } | |
81 | ||
dfab4892 LC |
82 | QUORUM_FAILURE |
83 | -------------- | |
84 | ||
85 | Emitted by the Quorum block driver if it fails to establish a quorum. | |
86 | ||
87 | Data: | |
88 | ||
4e855baa BC |
89 | - "reference": device name if defined else node name. |
90 | - "sector-num": Number of the first sector of the failed read operation. | |
91 | - "sectors-count": Failed read operation sector count. | |
dfab4892 LC |
92 | |
93 | Example: | |
94 | ||
95 | { "event": "QUORUM_FAILURE", | |
4e855baa | 96 | "data": { "reference": "usr1", "sector-num": 345435, "sectors-count": 5 }, |
dfab4892 LC |
97 | "timestamp": { "seconds": 1344522075, "microseconds": 745528 } } |
98 | ||
7f1e7b23 MA |
99 | Note: this event is rate-limited. |
100 | ||
dfab4892 LC |
101 | QUORUM_REPORT_BAD |
102 | ----------------- | |
103 | ||
104 | Emitted to report a corruption of a Quorum file. | |
105 | ||
106 | Data: | |
107 | ||
0ae053b7 | 108 | - "type": Quorum operation type |
4e855baa BC |
109 | - "error": Error message (json-string, optional) |
110 | Only present on failure. This field contains a human-readable | |
111 | error message. There are no semantics other than that the | |
112 | block layer reported an error and clients should not try to | |
113 | interpret the error string. | |
114 | - "node-name": The graph node name of the block driver state. | |
115 | - "sector-num": Number of the first sector of the failed read operation. | |
116 | - "sectors-count": Failed read operation sector count. | |
dfab4892 LC |
117 | |
118 | Example: | |
119 | ||
0ae053b7 | 120 | Read operation: |
dfab4892 | 121 | { "event": "QUORUM_REPORT_BAD", |
0ae053b7 CX |
122 | "data": { "node-name": "node0", "sector-num": 345435, "sectors-count": 5, |
123 | "type": "read" }, | |
dfab4892 LC |
124 | "timestamp": { "seconds": 1344522075, "microseconds": 745528 } } |
125 | ||
0ae053b7 CX |
126 | Flush operation: |
127 | { "event": "QUORUM_REPORT_BAD", | |
128 | "data": { "node-name": "node0", "sector-num": 0, "sectors-count": 2097120, | |
129 | "type": "flush", "error": "Broken pipe" }, | |
130 | "timestamp": { "seconds": 1456406829, "microseconds": 291763 } } | |
131 | ||
7f1e7b23 MA |
132 | Note: this event is rate-limited. |
133 | ||
5e255004 EB |
134 | SPICE_MIGRATE_COMPLETED |
135 | ----------------------- | |
136 | ||
137 | Emitted when SPICE migration has completed | |
138 | ||
139 | Data: None. | |
140 | ||
141 | Example: | |
142 | ||
143 | { "timestamp": {"seconds": 1290688046, "microseconds": 417172}, | |
144 | "event": "SPICE_MIGRATE_COMPLETED" } | |
145 | ||
598cd2bd JQ |
146 | MIGRATION |
147 | --------- | |
148 | ||
149 | Emitted when a migration event happens | |
150 | ||
151 | Data: None. | |
152 | ||
153 | - "status": migration status | |
154 | See MigrationStatus in ~/qapi-schema.json for possible values | |
155 | ||
156 | Example: | |
157 | ||
158 | {"timestamp": {"seconds": 1432121972, "microseconds": 744001}, | |
159 | "event": "MIGRATION", "data": {"status": "completed"}} | |
5e255004 | 160 | |
4addcd4f DDAG |
161 | MIGRATION_PASS |
162 | -------------- | |
163 | ||
164 | Emitted from the source side of a migration at the start of each pass | |
165 | (when it syncs the dirty bitmap) | |
166 | ||
167 | Data: None. | |
168 | ||
169 | - "pass": An incrementing count (starting at 1 on the first pass) | |
170 | ||
171 | Example: | |
172 | {"timestamp": {"seconds": 1449669631, "microseconds": 239225}, | |
173 | "event": "MIGRATION_PASS", "data": {"pass": 2}} | |
174 | ||
032badde EB |
175 | VSERPORT_CHANGE |
176 | --------------- | |
177 | ||
178 | Emitted when the guest opens or closes a virtio-serial port. | |
179 | ||
180 | Data: | |
181 | ||
182 | - "id": device identifier of the virtio-serial port (json-string) | |
183 | - "open": true if the guest has opened the virtio-serial port (json-bool) | |
184 | ||
185 | Example: | |
186 | ||
187 | { "event": "VSERPORT_CHANGE", | |
188 | "data": { "id": "channel0", "open": true }, | |
189 | "timestamp": { "seconds": 1401385907, "microseconds": 422329 } } | |
190 | ||
7f1e7b23 | 191 | Note: this event is rate-limited separately for each "id". |