]>
Commit | Line | Data |
---|---|---|
48685a8e MA |
1 | # -*- Mode: Python -*- |
2 | # | |
3 | ||
4 | ## | |
5 | # = Migration | |
6 | ## | |
7 | ||
8 | { 'include': 'common.json' } | |
9aca82ba | 9 | { 'include': 'sockets.json' } |
48685a8e MA |
10 | |
11 | ## | |
12 | # @MigrationStats: | |
13 | # | |
14 | # Detailed migration status. | |
15 | # | |
16 | # @transferred: amount of bytes already transferred to the target VM | |
17 | # | |
18 | # @remaining: amount of bytes remaining to be transferred to the target VM | |
19 | # | |
20 | # @total: total amount of bytes involved in the migration process | |
21 | # | |
22 | # @duplicate: number of duplicate (zero) pages (since 1.2) | |
23 | # | |
24 | # @skipped: number of skipped zero pages (since 1.5) | |
25 | # | |
26 | # @normal: number of normal pages (since 1.2) | |
27 | # | |
28 | # @normal-bytes: number of normal bytes sent (since 1.2) | |
29 | # | |
30 | # @dirty-pages-rate: number of pages dirtied by second by the | |
26ec4e53 | 31 | # guest (since 1.3) |
48685a8e MA |
32 | # |
33 | # @mbps: throughput in megabits/sec. (since 1.6) | |
34 | # | |
35 | # @dirty-sync-count: number of times that dirty ram was synchronized (since 2.1) | |
36 | # | |
37 | # @postcopy-requests: The number of page requests received from the destination | |
26ec4e53 | 38 | # (since 2.7) |
48685a8e MA |
39 | # |
40 | # @page-size: The number of bytes per page for the various page-based | |
26ec4e53 | 41 | # statistics (since 2.10) |
48685a8e | 42 | # |
a61c45bd JQ |
43 | # @multifd-bytes: The number of bytes sent through multifd (since 3.0) |
44 | # | |
aecbfe9c | 45 | # @pages-per-second: the number of memory pages transferred per second |
26ec4e53 | 46 | # (Since 4.0) |
aecbfe9c | 47 | # |
48685a8e MA |
48 | # Since: 0.14.0 |
49 | ## | |
50 | { 'struct': 'MigrationStats', | |
51 | 'data': {'transferred': 'int', 'remaining': 'int', 'total': 'int' , | |
52 | 'duplicate': 'int', 'skipped': 'int', 'normal': 'int', | |
53 | 'normal-bytes': 'int', 'dirty-pages-rate' : 'int', | |
54 | 'mbps' : 'number', 'dirty-sync-count' : 'int', | |
a61c45bd | 55 | 'postcopy-requests' : 'int', 'page-size' : 'int', |
aecbfe9c | 56 | 'multifd-bytes' : 'uint64', 'pages-per-second' : 'uint64' } } |
48685a8e MA |
57 | |
58 | ## | |
59 | # @XBZRLECacheStats: | |
60 | # | |
61 | # Detailed XBZRLE migration cache statistics | |
62 | # | |
63 | # @cache-size: XBZRLE cache size | |
64 | # | |
65 | # @bytes: amount of bytes already transferred to the target VM | |
66 | # | |
67 | # @pages: amount of pages transferred to the target VM | |
68 | # | |
69 | # @cache-miss: number of cache miss | |
70 | # | |
71 | # @cache-miss-rate: rate of cache miss (since 2.1) | |
72 | # | |
73 | # @overflow: number of overflows | |
74 | # | |
75 | # Since: 1.2 | |
76 | ## | |
77 | { 'struct': 'XBZRLECacheStats', | |
78 | 'data': {'cache-size': 'int', 'bytes': 'int', 'pages': 'int', | |
79 | 'cache-miss': 'int', 'cache-miss-rate': 'number', | |
80 | 'overflow': 'int' } } | |
81 | ||
76e03000 XG |
82 | ## |
83 | # @CompressionStats: | |
84 | # | |
85 | # Detailed migration compression statistics | |
86 | # | |
87 | # @pages: amount of pages compressed and transferred to the target VM | |
88 | # | |
89 | # @busy: count of times that no free thread was available to compress data | |
90 | # | |
91 | # @busy-rate: rate of thread busy | |
92 | # | |
93 | # @compressed-size: amount of bytes after compression | |
94 | # | |
95 | # @compression-rate: rate of compressed size | |
96 | # | |
97 | # Since: 3.1 | |
98 | ## | |
99 | { 'struct': 'CompressionStats', | |
100 | 'data': {'pages': 'int', 'busy': 'int', 'busy-rate': 'number', | |
dbb28bc8 | 101 | 'compressed-size': 'int', 'compression-rate': 'number' } } |
76e03000 | 102 | |
48685a8e MA |
103 | ## |
104 | # @MigrationStatus: | |
105 | # | |
106 | # An enumeration of migration status. | |
107 | # | |
108 | # @none: no migration has ever happened. | |
109 | # | |
110 | # @setup: migration process has been initiated. | |
111 | # | |
112 | # @cancelling: in the process of cancelling migration. | |
113 | # | |
114 | # @cancelled: cancelling migration is finished. | |
115 | # | |
116 | # @active: in the process of doing migration. | |
117 | # | |
118 | # @postcopy-active: like active, but now in postcopy mode. (since 2.5) | |
119 | # | |
51f63ec7 | 120 | # @postcopy-paused: during postcopy but paused. (since 3.0) |
a688d2c1 | 121 | # |
51f63ec7 | 122 | # @postcopy-recover: trying to recover from a paused postcopy. (since 3.0) |
135b87b4 | 123 | # |
48685a8e MA |
124 | # @completed: migration is finished. |
125 | # | |
126 | # @failed: some error occurred during migration process. | |
127 | # | |
128 | # @colo: VM is in the process of fault tolerance, VM can not get into this | |
129 | # state unless colo capability is enabled for migration. (since 2.8) | |
130 | # | |
31e06077 DDAG |
131 | # @pre-switchover: Paused before device serialisation. (since 2.11) |
132 | # | |
133 | # @device: During device serialisation when pause-before-switchover is enabled | |
26ec4e53 | 134 | # (since 2.11) |
31e06077 | 135 | # |
c7e0acd5 JF |
136 | # @wait-unplug: wait for device unplug request by guest OS to be completed. |
137 | # (since 4.2) | |
138 | # | |
48685a8e MA |
139 | # Since: 2.3 |
140 | # | |
141 | ## | |
142 | { 'enum': 'MigrationStatus', | |
143 | 'data': [ 'none', 'setup', 'cancelling', 'cancelled', | |
a688d2c1 | 144 | 'active', 'postcopy-active', 'postcopy-paused', |
135b87b4 | 145 | 'postcopy-recover', 'completed', 'failed', 'colo', |
c7e0acd5 | 146 | 'pre-switchover', 'device', 'wait-unplug' ] } |
48685a8e MA |
147 | |
148 | ## | |
149 | # @MigrationInfo: | |
150 | # | |
151 | # Information about current migration process. | |
152 | # | |
153 | # @status: @MigrationStatus describing the current migration status. | |
154 | # If this field is not returned, no migration process | |
155 | # has been initiated | |
156 | # | |
157 | # @ram: @MigrationStats containing detailed migration | |
158 | # status, only returned if status is 'active' or | |
159 | # 'completed'(since 1.2) | |
160 | # | |
161 | # @disk: @MigrationStats containing detailed disk migration | |
162 | # status, only returned if status is 'active' and it is a block | |
163 | # migration | |
164 | # | |
165 | # @xbzrle-cache: @XBZRLECacheStats containing detailed XBZRLE | |
166 | # migration statistics, only returned if XBZRLE feature is on and | |
167 | # status is 'active' or 'completed' (since 1.2) | |
168 | # | |
169 | # @total-time: total amount of milliseconds since migration started. | |
26ec4e53 PM |
170 | # If migration has ended, it returns the total migration |
171 | # time. (since 1.2) | |
48685a8e MA |
172 | # |
173 | # @downtime: only present when migration finishes correctly | |
26ec4e53 PM |
174 | # total downtime in milliseconds for the guest. |
175 | # (since 1.3) | |
48685a8e MA |
176 | # |
177 | # @expected-downtime: only present while migration is active | |
26ec4e53 PM |
178 | # expected downtime in milliseconds for the guest in last walk |
179 | # of the dirty bitmap. (since 1.3) | |
48685a8e | 180 | # |
a660eed4 PM |
181 | # @setup-time: amount of setup time in milliseconds *before* the |
182 | # iterations begin but *after* the QMP command is issued. This is designed | |
26ec4e53 PM |
183 | # to provide an accounting of any activities (such as RDMA pinning) which |
184 | # may be expensive, but do not actually occur during the iterative | |
185 | # migration rounds themselves. (since 1.6) | |
48685a8e MA |
186 | # |
187 | # @cpu-throttle-percentage: percentage of time guest cpus are being | |
26ec4e53 PM |
188 | # throttled during auto-converge. This is only present when auto-converge |
189 | # has started throttling guest cpus. (Since 2.7) | |
48685a8e MA |
190 | # |
191 | # @error-desc: the human readable error description string, when | |
192 | # @status is 'failed'. Clients should not attempt to parse the | |
193 | # error strings. (Since 2.7) | |
65ace060 AP |
194 | # |
195 | # @postcopy-blocktime: total time when all vCPU were blocked during postcopy | |
26ec4e53 PM |
196 | # live migration. This is only present when the postcopy-blocktime |
197 | # migration capability is enabled. (Since 3.0) | |
65ace060 | 198 | # |
5e50cae4 | 199 | # @postcopy-vcpu-blocktime: list of the postcopy blocktime per vCPU. This is |
26ec4e53 PM |
200 | # only present when the postcopy-blocktime migration capability |
201 | # is enabled. (Since 3.0) | |
65ace060 | 202 | # |
76e03000 | 203 | # @compression: migration compression statistics, only returned if compression |
26ec4e53 | 204 | # feature is on and status is 'active' or 'completed' (Since 3.1) |
48685a8e | 205 | # |
9aca82ba JQ |
206 | # @socket-address: Only used for tcp, to know what the real port is (Since 4.0) |
207 | # | |
48685a8e MA |
208 | # Since: 0.14.0 |
209 | ## | |
210 | { 'struct': 'MigrationInfo', | |
211 | 'data': {'*status': 'MigrationStatus', '*ram': 'MigrationStats', | |
212 | '*disk': 'MigrationStats', | |
213 | '*xbzrle-cache': 'XBZRLECacheStats', | |
214 | '*total-time': 'int', | |
215 | '*expected-downtime': 'int', | |
216 | '*downtime': 'int', | |
217 | '*setup-time': 'int', | |
218 | '*cpu-throttle-percentage': 'int', | |
65ace060 AP |
219 | '*error-desc': 'str', |
220 | '*postcopy-blocktime' : 'uint32', | |
76e03000 | 221 | '*postcopy-vcpu-blocktime': ['uint32'], |
9aca82ba JQ |
222 | '*compression': 'CompressionStats', |
223 | '*socket-address': ['SocketAddress'] } } | |
48685a8e MA |
224 | |
225 | ## | |
226 | # @query-migrate: | |
227 | # | |
228 | # Returns information about current migration process. If migration | |
229 | # is active there will be another json-object with RAM migration | |
230 | # status and if block migration is active another one with block | |
231 | # migration status. | |
232 | # | |
233 | # Returns: @MigrationInfo | |
234 | # | |
235 | # Since: 0.14.0 | |
236 | # | |
237 | # Example: | |
238 | # | |
239 | # 1. Before the first migration | |
240 | # | |
241 | # -> { "execute": "query-migrate" } | |
242 | # <- { "return": {} } | |
243 | # | |
244 | # 2. Migration is done and has succeeded | |
245 | # | |
246 | # -> { "execute": "query-migrate" } | |
247 | # <- { "return": { | |
248 | # "status": "completed", | |
be1d2c49 | 249 | # "total-time":12345, |
250 | # "setup-time":12345, | |
251 | # "downtime":12345, | |
48685a8e MA |
252 | # "ram":{ |
253 | # "transferred":123, | |
254 | # "remaining":123, | |
255 | # "total":246, | |
48685a8e MA |
256 | # "duplicate":123, |
257 | # "normal":123, | |
258 | # "normal-bytes":123456, | |
259 | # "dirty-sync-count":15 | |
260 | # } | |
261 | # } | |
262 | # } | |
263 | # | |
264 | # 3. Migration is done and has failed | |
265 | # | |
266 | # -> { "execute": "query-migrate" } | |
267 | # <- { "return": { "status": "failed" } } | |
268 | # | |
269 | # 4. Migration is being performed and is not a block migration: | |
270 | # | |
271 | # -> { "execute": "query-migrate" } | |
272 | # <- { | |
273 | # "return":{ | |
274 | # "status":"active", | |
be1d2c49 | 275 | # "total-time":12345, |
276 | # "setup-time":12345, | |
277 | # "expected-downtime":12345, | |
48685a8e MA |
278 | # "ram":{ |
279 | # "transferred":123, | |
280 | # "remaining":123, | |
281 | # "total":246, | |
48685a8e MA |
282 | # "duplicate":123, |
283 | # "normal":123, | |
284 | # "normal-bytes":123456, | |
285 | # "dirty-sync-count":15 | |
286 | # } | |
287 | # } | |
288 | # } | |
289 | # | |
290 | # 5. Migration is being performed and is a block migration: | |
291 | # | |
292 | # -> { "execute": "query-migrate" } | |
293 | # <- { | |
294 | # "return":{ | |
295 | # "status":"active", | |
be1d2c49 | 296 | # "total-time":12345, |
297 | # "setup-time":12345, | |
298 | # "expected-downtime":12345, | |
48685a8e MA |
299 | # "ram":{ |
300 | # "total":1057024, | |
301 | # "remaining":1053304, | |
302 | # "transferred":3720, | |
48685a8e MA |
303 | # "duplicate":123, |
304 | # "normal":123, | |
305 | # "normal-bytes":123456, | |
306 | # "dirty-sync-count":15 | |
307 | # }, | |
308 | # "disk":{ | |
309 | # "total":20971520, | |
310 | # "remaining":20880384, | |
311 | # "transferred":91136 | |
312 | # } | |
313 | # } | |
314 | # } | |
315 | # | |
316 | # 6. Migration is being performed and XBZRLE is active: | |
317 | # | |
318 | # -> { "execute": "query-migrate" } | |
319 | # <- { | |
320 | # "return":{ | |
321 | # "status":"active", | |
be1d2c49 | 322 | # "total-time":12345, |
323 | # "setup-time":12345, | |
324 | # "expected-downtime":12345, | |
48685a8e MA |
325 | # "ram":{ |
326 | # "total":1057024, | |
327 | # "remaining":1053304, | |
328 | # "transferred":3720, | |
48685a8e MA |
329 | # "duplicate":10, |
330 | # "normal":3333, | |
331 | # "normal-bytes":3412992, | |
332 | # "dirty-sync-count":15 | |
333 | # }, | |
334 | # "xbzrle-cache":{ | |
335 | # "cache-size":67108864, | |
336 | # "bytes":20971520, | |
337 | # "pages":2444343, | |
338 | # "cache-miss":2244, | |
339 | # "cache-miss-rate":0.123, | |
340 | # "overflow":34434 | |
341 | # } | |
342 | # } | |
343 | # } | |
344 | # | |
345 | ## | |
346 | { 'command': 'query-migrate', 'returns': 'MigrationInfo' } | |
347 | ||
348 | ## | |
349 | # @MigrationCapability: | |
350 | # | |
351 | # Migration capabilities enumeration | |
352 | # | |
353 | # @xbzrle: Migration supports xbzrle (Xor Based Zero Run Length Encoding). | |
354 | # This feature allows us to minimize migration traffic for certain work | |
355 | # loads, by sending compressed difference of the pages | |
356 | # | |
357 | # @rdma-pin-all: Controls whether or not the entire VM memory footprint is | |
26ec4e53 PM |
358 | # mlock()'d on demand or all at once. Refer to docs/rdma.txt for usage. |
359 | # Disabled by default. (since 2.0) | |
48685a8e MA |
360 | # |
361 | # @zero-blocks: During storage migration encode blocks of zeroes efficiently. This | |
26ec4e53 PM |
362 | # essentially saves 1MB of zeroes per block on the wire. Enabling requires |
363 | # source and target VM to support this feature. To enable it is sufficient | |
364 | # to enable the capability on the source VM. The feature is disabled by | |
365 | # default. (since 1.6) | |
48685a8e MA |
366 | # |
367 | # @compress: Use multiple compression threads to accelerate live migration. | |
26ec4e53 PM |
368 | # This feature can help to reduce the migration traffic, by sending |
369 | # compressed pages. Please note that if compress and xbzrle are both | |
370 | # on, compress only takes effect in the ram bulk stage, after that, | |
371 | # it will be disabled and only xbzrle takes effect, this can help to | |
372 | # minimize migration traffic. The feature is disabled by default. | |
373 | # (since 2.4 ) | |
48685a8e MA |
374 | # |
375 | # @events: generate events for each migration state change | |
376 | # (since 2.4 ) | |
377 | # | |
378 | # @auto-converge: If enabled, QEMU will automatically throttle down the guest | |
26ec4e53 | 379 | # to speed up convergence of RAM migration. (since 1.6) |
48685a8e MA |
380 | # |
381 | # @postcopy-ram: Start executing on the migration target before all of RAM has | |
26ec4e53 PM |
382 | # been migrated, pulling the remaining pages along as needed. The |
383 | # capacity must have the same setting on both source and target | |
384 | # or migration will not even start. NOTE: If the migration fails during | |
385 | # postcopy the VM will fail. (since 2.6) | |
48685a8e MA |
386 | # |
387 | # @x-colo: If enabled, migration will never end, and the state of the VM on the | |
26ec4e53 PM |
388 | # primary side will be migrated continuously to the VM on secondary |
389 | # side, this process is called COarse-Grain LOck Stepping (COLO) for | |
390 | # Non-stop Service. (since 2.8) | |
48685a8e MA |
391 | # |
392 | # @release-ram: if enabled, qemu will free the migrated ram pages on the source | |
26ec4e53 | 393 | # during postcopy-ram migration. (since 2.9) |
48685a8e MA |
394 | # |
395 | # @block: If enabled, QEMU will also migrate the contents of all block | |
26ec4e53 PM |
396 | # devices. Default is disabled. A possible alternative uses |
397 | # mirror jobs to a builtin NBD server on the destination, which | |
398 | # offers more flexibility. | |
399 | # (Since 2.10) | |
48685a8e MA |
400 | # |
401 | # @return-path: If enabled, migration will use the return path even | |
402 | # for precopy. (since 2.10) | |
403 | # | |
93fbd031 | 404 | # @pause-before-switchover: Pause outgoing migration before serialising device |
26ec4e53 | 405 | # state and before disabling block IO (since 2.11) |
93fbd031 | 406 | # |
cbfd6c95 | 407 | # @multifd: Use more than one fd for migration (since 4.0) |
30126bbf | 408 | # |
55efc8c2 VSO |
409 | # @dirty-bitmaps: If enabled, QEMU will migrate named dirty bitmaps. |
410 | # (since 2.12) | |
411 | # | |
f22f928e | 412 | # @postcopy-blocktime: Calculate downtime for postcopy live migration |
26ec4e53 | 413 | # (since 3.0) |
f22f928e | 414 | # |
0f073f44 | 415 | # @late-block-activate: If enabled, the destination will not activate block |
26ec4e53 PM |
416 | # devices (and thus take locks) immediately at the end of migration. |
417 | # (since 3.0) | |
0f073f44 | 418 | # |
18269069 YK |
419 | # @x-ignore-shared: If enabled, QEMU will not migrate shared memory (since 4.0) |
420 | # | |
b9d68df6 YK |
421 | # @validate-uuid: Send the UUID of the source to allow the destination |
422 | # to ensure it is the same. (since 4.2) | |
423 | # | |
48685a8e MA |
424 | # Since: 1.2 |
425 | ## | |
426 | { 'enum': 'MigrationCapability', | |
427 | 'data': ['xbzrle', 'rdma-pin-all', 'auto-converge', 'zero-blocks', | |
428 | 'compress', 'events', 'postcopy-ram', 'x-colo', 'release-ram', | |
cbfd6c95 | 429 | 'block', 'return-path', 'pause-before-switchover', 'multifd', |
18269069 | 430 | 'dirty-bitmaps', 'postcopy-blocktime', 'late-block-activate', |
b9d68df6 | 431 | 'x-ignore-shared', 'validate-uuid' ] } |
48685a8e MA |
432 | |
433 | ## | |
434 | # @MigrationCapabilityStatus: | |
435 | # | |
436 | # Migration capability information | |
437 | # | |
438 | # @capability: capability enum | |
439 | # | |
440 | # @state: capability state bool | |
441 | # | |
442 | # Since: 1.2 | |
443 | ## | |
444 | { 'struct': 'MigrationCapabilityStatus', | |
445 | 'data': { 'capability' : 'MigrationCapability', 'state' : 'bool' } } | |
446 | ||
447 | ## | |
448 | # @migrate-set-capabilities: | |
449 | # | |
450 | # Enable/Disable the following migration capabilities (like xbzrle) | |
451 | # | |
452 | # @capabilities: json array of capability modifications to make | |
453 | # | |
454 | # Since: 1.2 | |
455 | # | |
456 | # Example: | |
457 | # | |
458 | # -> { "execute": "migrate-set-capabilities" , "arguments": | |
459 | # { "capabilities": [ { "capability": "xbzrle", "state": true } ] } } | |
460 | # | |
461 | ## | |
462 | { 'command': 'migrate-set-capabilities', | |
463 | 'data': { 'capabilities': ['MigrationCapabilityStatus'] } } | |
464 | ||
465 | ## | |
466 | # @query-migrate-capabilities: | |
467 | # | |
468 | # Returns information about the current migration capabilities status | |
469 | # | |
470 | # Returns: @MigrationCapabilitiesStatus | |
471 | # | |
472 | # Since: 1.2 | |
473 | # | |
474 | # Example: | |
475 | # | |
476 | # -> { "execute": "query-migrate-capabilities" } | |
477 | # <- { "return": [ | |
478 | # {"state": false, "capability": "xbzrle"}, | |
479 | # {"state": false, "capability": "rdma-pin-all"}, | |
480 | # {"state": false, "capability": "auto-converge"}, | |
481 | # {"state": false, "capability": "zero-blocks"}, | |
482 | # {"state": false, "capability": "compress"}, | |
483 | # {"state": true, "capability": "events"}, | |
484 | # {"state": false, "capability": "postcopy-ram"}, | |
485 | # {"state": false, "capability": "x-colo"} | |
486 | # ]} | |
487 | # | |
488 | ## | |
489 | { 'command': 'query-migrate-capabilities', 'returns': ['MigrationCapabilityStatus']} | |
490 | ||
96eef042 JQ |
491 | ## |
492 | # @MultiFDCompression: | |
493 | # | |
494 | # An enumeration of multifd compression methods. | |
495 | # | |
496 | # @none: no compression. | |
7ec2c2b3 | 497 | # @zlib: use zlib compression method. |
87dc6f5f | 498 | # @zstd: use zstd compression method. |
96eef042 JQ |
499 | # |
500 | # Since: 5.0 | |
501 | # | |
502 | ## | |
503 | { 'enum': 'MultiFDCompression', | |
87dc6f5f JQ |
504 | 'data': [ 'none', 'zlib', |
505 | { 'name': 'zstd', 'if': 'defined(CONFIG_ZSTD)' } ] } | |
96eef042 | 506 | |
48685a8e MA |
507 | ## |
508 | # @MigrationParameter: | |
509 | # | |
510 | # Migration parameters enumeration | |
511 | # | |
ee3d96ba | 512 | # @announce-initial: Initial delay (in milliseconds) before sending the first |
26ec4e53 | 513 | # announce (Since 4.0) |
ee3d96ba DDAG |
514 | # |
515 | # @announce-max: Maximum delay (in milliseconds) between packets in the | |
26ec4e53 | 516 | # announcement (Since 4.0) |
ee3d96ba DDAG |
517 | # |
518 | # @announce-rounds: Number of self-announce packets sent after migration | |
26ec4e53 | 519 | # (Since 4.0) |
ee3d96ba DDAG |
520 | # |
521 | # @announce-step: Increase in delay (in milliseconds) between subsequent | |
26ec4e53 | 522 | # packets in the announcement (Since 4.0) |
ee3d96ba | 523 | # |
48685a8e | 524 | # @compress-level: Set the compression level to be used in live migration, |
26ec4e53 PM |
525 | # the compression level is an integer between 0 and 9, where 0 means |
526 | # no compression, 1 means the best compression speed, and 9 means best | |
527 | # compression ratio which will consume more CPU. | |
48685a8e MA |
528 | # |
529 | # @compress-threads: Set compression thread count to be used in live migration, | |
26ec4e53 | 530 | # the compression thread count is an integer between 1 and 255. |
48685a8e | 531 | # |
1d58872a XG |
532 | # @compress-wait-thread: Controls behavior when all compression threads are |
533 | # currently busy. If true (default), wait for a free | |
534 | # compression thread to become available; otherwise, | |
535 | # send the page uncompressed. (Since 3.1) | |
536 | # | |
48685a8e | 537 | # @decompress-threads: Set decompression thread count to be used in live |
26ec4e53 PM |
538 | # migration, the decompression thread count is an integer between 1 |
539 | # and 255. Usually, decompression is at least 4 times as fast as | |
540 | # compression, so set the decompress-threads to the number about 1/4 | |
541 | # of compress-threads is adequate. | |
48685a8e | 542 | # |
dc14a470 KZ |
543 | # @throttle-trigger-threshold: The ratio of bytes_dirty_period and bytes_xfer_period |
544 | # to trigger throttling. It is expressed as percentage. | |
545 | # The default value is 50. (Since 5.0) | |
546 | # | |
48685a8e MA |
547 | # @cpu-throttle-initial: Initial percentage of time guest cpus are throttled |
548 | # when migration auto-converge is activated. The | |
549 | # default value is 20. (Since 2.7) | |
550 | # | |
551 | # @cpu-throttle-increment: throttle percentage increase each time | |
552 | # auto-converge detects that migration is not making | |
553 | # progress. The default value is 10. (Since 2.7) | |
554 | # | |
555 | # @tls-creds: ID of the 'tls-creds' object that provides credentials for | |
556 | # establishing a TLS connection over the migration data channel. | |
557 | # On the outgoing side of the migration, the credentials must | |
558 | # be for a 'client' endpoint, while for the incoming side the | |
559 | # credentials must be for a 'server' endpoint. Setting this | |
560 | # will enable TLS for all migrations. The default is unset, | |
561 | # resulting in unsecured migration at the QEMU level. (Since 2.7) | |
562 | # | |
563 | # @tls-hostname: hostname of the target host for the migration. This is | |
564 | # required when using x509 based TLS credentials and the | |
565 | # migration URI does not already include a hostname. For | |
566 | # example if using fd: or exec: based migration, the | |
567 | # hostname must be provided so that the server's x509 | |
568 | # certificate identity can be validated. (Since 2.7) | |
569 | # | |
d2f1d29b DB |
570 | # @tls-authz: ID of the 'authz' object subclass that provides access control |
571 | # checking of the TLS x509 certificate distinguished name. | |
572 | # This object is only resolved at time of use, so can be deleted | |
573 | # and recreated on the fly while the migration server is active. | |
574 | # If missing, it will default to denying access (Since 4.0) | |
575 | # | |
48685a8e MA |
576 | # @max-bandwidth: to set maximum speed for migration. maximum speed in |
577 | # bytes per second. (Since 2.8) | |
578 | # | |
579 | # @downtime-limit: set maximum tolerated downtime for migration. maximum | |
580 | # downtime in milliseconds (Since 2.8) | |
581 | # | |
582 | # @x-checkpoint-delay: The delay time (in ms) between two COLO checkpoints in | |
26ec4e53 | 583 | # periodic mode. (Since 2.8) |
48685a8e MA |
584 | # |
585 | # @block-incremental: Affects how much storage is migrated when the | |
26ec4e53 PM |
586 | # block migration capability is enabled. When false, the entire |
587 | # storage backing chain is migrated into a flattened image at | |
588 | # the destination; when true, only the active qcow2 layer is | |
589 | # migrated and the destination must already have access to the | |
590 | # same backing chain as was used on the source. (since 2.10) | |
48685a8e | 591 | # |
cbfd6c95 JQ |
592 | # @multifd-channels: Number of channels used to migrate data in |
593 | # parallel. This is the same number that the | |
594 | # number of sockets used for migration. The | |
595 | # default value is 2 (since 4.0) | |
4075fb1c | 596 | # |
73af8dd8 JQ |
597 | # @xbzrle-cache-size: cache size to be used by XBZRLE migration. It |
598 | # needs to be a multiple of the target page size | |
599 | # and a power of 2 | |
600 | # (Since 2.11) | |
601 | # | |
7e555c6c | 602 | # @max-postcopy-bandwidth: Background transfer bandwidth during postcopy. |
26ec4e53 PM |
603 | # Defaults to 0 (unlimited). In bytes per second. |
604 | # (Since 3.0) | |
4cbc9c7f LQ |
605 | # |
606 | # @max-cpu-throttle: maximum cpu throttle percentage. | |
607 | # Defaults to 99. (Since 3.1) | |
ee3d96ba | 608 | # |
96eef042 JQ |
609 | # @multifd-compression: Which compression method to use. |
610 | # Defaults to none. (Since 5.0) | |
611 | # | |
9004db48 JQ |
612 | # @multifd-zlib-level: Set the compression level to be used in live |
613 | # migration, the compression level is an integer between 0 | |
614 | # and 9, where 0 means no compression, 1 means the best | |
615 | # compression speed, and 9 means best compression ratio which | |
616 | # will consume more CPU. | |
617 | # Defaults to 1. (Since 5.0) | |
618 | # | |
6a9ad154 JQ |
619 | # @multifd-zstd-level: Set the compression level to be used in live |
620 | # migration, the compression level is an integer between 0 | |
621 | # and 20, where 0 means no compression, 1 means the best | |
622 | # compression speed, and 20 means best compression ratio which | |
623 | # will consume more CPU. | |
624 | # Defaults to 1. (Since 5.0) | |
625 | # | |
48685a8e MA |
626 | # Since: 2.4 |
627 | ## | |
628 | { 'enum': 'MigrationParameter', | |
ee3d96ba DDAG |
629 | 'data': ['announce-initial', 'announce-max', |
630 | 'announce-rounds', 'announce-step', | |
631 | 'compress-level', 'compress-threads', 'decompress-threads', | |
dc14a470 | 632 | 'compress-wait-thread', 'throttle-trigger-threshold', |
48685a8e | 633 | 'cpu-throttle-initial', 'cpu-throttle-increment', |
d2f1d29b | 634 | 'tls-creds', 'tls-hostname', 'tls-authz', 'max-bandwidth', |
4075fb1c | 635 | 'downtime-limit', 'x-checkpoint-delay', 'block-incremental', |
cbfd6c95 | 636 | 'multifd-channels', |
4cbc9c7f | 637 | 'xbzrle-cache-size', 'max-postcopy-bandwidth', |
9004db48 | 638 | 'max-cpu-throttle', 'multifd-compression', |
6a9ad154 | 639 | 'multifd-zlib-level' ,'multifd-zstd-level' ] } |
48685a8e MA |
640 | |
641 | ## | |
642 | # @MigrateSetParameters: | |
643 | # | |
ee3d96ba | 644 | # @announce-initial: Initial delay (in milliseconds) before sending the first |
26ec4e53 | 645 | # announce (Since 4.0) |
ee3d96ba DDAG |
646 | # |
647 | # @announce-max: Maximum delay (in milliseconds) between packets in the | |
26ec4e53 | 648 | # announcement (Since 4.0) |
ee3d96ba DDAG |
649 | # |
650 | # @announce-rounds: Number of self-announce packets sent after migration | |
26ec4e53 | 651 | # (Since 4.0) |
ee3d96ba DDAG |
652 | # |
653 | # @announce-step: Increase in delay (in milliseconds) between subsequent | |
26ec4e53 | 654 | # packets in the announcement (Since 4.0) |
ee3d96ba | 655 | # |
48685a8e MA |
656 | # @compress-level: compression level |
657 | # | |
658 | # @compress-threads: compression thread count | |
659 | # | |
1d58872a XG |
660 | # @compress-wait-thread: Controls behavior when all compression threads are |
661 | # currently busy. If true (default), wait for a free | |
662 | # compression thread to become available; otherwise, | |
663 | # send the page uncompressed. (Since 3.1) | |
664 | # | |
48685a8e MA |
665 | # @decompress-threads: decompression thread count |
666 | # | |
dc14a470 KZ |
667 | # @throttle-trigger-threshold: The ratio of bytes_dirty_period and bytes_xfer_period |
668 | # to trigger throttling. It is expressed as percentage. | |
669 | # The default value is 50. (Since 5.0) | |
670 | # | |
48685a8e MA |
671 | # @cpu-throttle-initial: Initial percentage of time guest cpus are |
672 | # throttled when migration auto-converge is activated. | |
673 | # The default value is 20. (Since 2.7) | |
674 | # | |
675 | # @cpu-throttle-increment: throttle percentage increase each time | |
676 | # auto-converge detects that migration is not making | |
677 | # progress. The default value is 10. (Since 2.7) | |
678 | # | |
679 | # @tls-creds: ID of the 'tls-creds' object that provides credentials | |
680 | # for establishing a TLS connection over the migration data | |
681 | # channel. On the outgoing side of the migration, the credentials | |
682 | # must be for a 'client' endpoint, while for the incoming side the | |
683 | # credentials must be for a 'server' endpoint. Setting this | |
684 | # to a non-empty string enables TLS for all migrations. | |
685 | # An empty string means that QEMU will use plain text mode for | |
686 | # migration, rather than TLS (Since 2.9) | |
687 | # Previously (since 2.7), this was reported by omitting | |
688 | # tls-creds instead. | |
689 | # | |
690 | # @tls-hostname: hostname of the target host for the migration. This | |
691 | # is required when using x509 based TLS credentials and the | |
692 | # migration URI does not already include a hostname. For | |
693 | # example if using fd: or exec: based migration, the | |
694 | # hostname must be provided so that the server's x509 | |
695 | # certificate identity can be validated. (Since 2.7) | |
696 | # An empty string means that QEMU will use the hostname | |
697 | # associated with the migration URI, if any. (Since 2.9) | |
698 | # Previously (since 2.7), this was reported by omitting | |
699 | # tls-hostname instead. | |
700 | # | |
701 | # @max-bandwidth: to set maximum speed for migration. maximum speed in | |
702 | # bytes per second. (Since 2.8) | |
703 | # | |
704 | # @downtime-limit: set maximum tolerated downtime for migration. maximum | |
705 | # downtime in milliseconds (Since 2.8) | |
706 | # | |
707 | # @x-checkpoint-delay: the delay time between two COLO checkpoints. (Since 2.8) | |
708 | # | |
709 | # @block-incremental: Affects how much storage is migrated when the | |
26ec4e53 PM |
710 | # block migration capability is enabled. When false, the entire |
711 | # storage backing chain is migrated into a flattened image at | |
712 | # the destination; when true, only the active qcow2 layer is | |
713 | # migrated and the destination must already have access to the | |
714 | # same backing chain as was used on the source. (since 2.10) | |
48685a8e | 715 | # |
cbfd6c95 JQ |
716 | # @multifd-channels: Number of channels used to migrate data in |
717 | # parallel. This is the same number that the | |
718 | # number of sockets used for migration. The | |
719 | # default value is 2 (since 4.0) | |
4075fb1c | 720 | # |
73af8dd8 JQ |
721 | # @xbzrle-cache-size: cache size to be used by XBZRLE migration. It |
722 | # needs to be a multiple of the target page size | |
723 | # and a power of 2 | |
724 | # (Since 2.11) | |
7e555c6c DDAG |
725 | # |
726 | # @max-postcopy-bandwidth: Background transfer bandwidth during postcopy. | |
26ec4e53 PM |
727 | # Defaults to 0 (unlimited). In bytes per second. |
728 | # (Since 3.0) | |
4cbc9c7f LQ |
729 | # |
730 | # @max-cpu-throttle: maximum cpu throttle percentage. | |
731 | # The default value is 99. (Since 3.1) | |
732 | # | |
96eef042 JQ |
733 | # @multifd-compression: Which compression method to use. |
734 | # Defaults to none. (Since 5.0) | |
735 | # | |
9004db48 JQ |
736 | # @multifd-zlib-level: Set the compression level to be used in live |
737 | # migration, the compression level is an integer between 0 | |
738 | # and 9, where 0 means no compression, 1 means the best | |
739 | # compression speed, and 9 means best compression ratio which | |
740 | # will consume more CPU. | |
741 | # Defaults to 1. (Since 5.0) | |
742 | # | |
6a9ad154 JQ |
743 | # @multifd-zstd-level: Set the compression level to be used in live |
744 | # migration, the compression level is an integer between 0 | |
745 | # and 20, where 0 means no compression, 1 means the best | |
746 | # compression speed, and 20 means best compression ratio which | |
747 | # will consume more CPU. | |
748 | # Defaults to 1. (Since 5.0) | |
749 | # | |
48685a8e MA |
750 | # Since: 2.4 |
751 | ## | |
752 | # TODO either fuse back into MigrationParameters, or make | |
753 | # MigrationParameters members mandatory | |
754 | { 'struct': 'MigrateSetParameters', | |
ee3d96ba DDAG |
755 | 'data': { '*announce-initial': 'size', |
756 | '*announce-max': 'size', | |
757 | '*announce-rounds': 'size', | |
758 | '*announce-step': 'size', | |
759 | '*compress-level': 'int', | |
48685a8e | 760 | '*compress-threads': 'int', |
1d58872a | 761 | '*compress-wait-thread': 'bool', |
48685a8e | 762 | '*decompress-threads': 'int', |
dc14a470 | 763 | '*throttle-trigger-threshold': 'int', |
48685a8e MA |
764 | '*cpu-throttle-initial': 'int', |
765 | '*cpu-throttle-increment': 'int', | |
766 | '*tls-creds': 'StrOrNull', | |
767 | '*tls-hostname': 'StrOrNull', | |
d2f1d29b | 768 | '*tls-authz': 'StrOrNull', |
48685a8e MA |
769 | '*max-bandwidth': 'int', |
770 | '*downtime-limit': 'int', | |
771 | '*x-checkpoint-delay': 'int', | |
4075fb1c | 772 | '*block-incremental': 'bool', |
cbfd6c95 | 773 | '*multifd-channels': 'int', |
7e555c6c | 774 | '*xbzrle-cache-size': 'size', |
4cbc9c7f | 775 | '*max-postcopy-bandwidth': 'size', |
96eef042 | 776 | '*max-cpu-throttle': 'int', |
9004db48 | 777 | '*multifd-compression': 'MultiFDCompression', |
6a9ad154 JQ |
778 | '*multifd-zlib-level': 'int', |
779 | '*multifd-zstd-level': 'int' } } | |
48685a8e MA |
780 | |
781 | ## | |
782 | # @migrate-set-parameters: | |
783 | # | |
784 | # Set various migration parameters. | |
785 | # | |
786 | # Since: 2.4 | |
787 | # | |
788 | # Example: | |
789 | # | |
790 | # -> { "execute": "migrate-set-parameters" , | |
791 | # "arguments": { "compress-level": 1 } } | |
792 | # | |
793 | ## | |
794 | { 'command': 'migrate-set-parameters', 'boxed': true, | |
795 | 'data': 'MigrateSetParameters' } | |
796 | ||
797 | ## | |
798 | # @MigrationParameters: | |
799 | # | |
800 | # The optional members aren't actually optional. | |
801 | # | |
ee3d96ba | 802 | # @announce-initial: Initial delay (in milliseconds) before sending the |
26ec4e53 | 803 | # first announce (Since 4.0) |
ee3d96ba DDAG |
804 | # |
805 | # @announce-max: Maximum delay (in milliseconds) between packets in the | |
26ec4e53 | 806 | # announcement (Since 4.0) |
ee3d96ba DDAG |
807 | # |
808 | # @announce-rounds: Number of self-announce packets sent after migration | |
26ec4e53 | 809 | # (Since 4.0) |
ee3d96ba DDAG |
810 | # |
811 | # @announce-step: Increase in delay (in milliseconds) between subsequent | |
26ec4e53 | 812 | # packets in the announcement (Since 4.0) |
ee3d96ba | 813 | # |
48685a8e MA |
814 | # @compress-level: compression level |
815 | # | |
816 | # @compress-threads: compression thread count | |
817 | # | |
1d58872a XG |
818 | # @compress-wait-thread: Controls behavior when all compression threads are |
819 | # currently busy. If true (default), wait for a free | |
820 | # compression thread to become available; otherwise, | |
821 | # send the page uncompressed. (Since 3.1) | |
822 | # | |
48685a8e MA |
823 | # @decompress-threads: decompression thread count |
824 | # | |
dc14a470 KZ |
825 | # @throttle-trigger-threshold: The ratio of bytes_dirty_period and bytes_xfer_period |
826 | # to trigger throttling. It is expressed as percentage. | |
827 | # The default value is 50. (Since 5.0) | |
828 | # | |
48685a8e MA |
829 | # @cpu-throttle-initial: Initial percentage of time guest cpus are |
830 | # throttled when migration auto-converge is activated. | |
831 | # (Since 2.7) | |
832 | # | |
833 | # @cpu-throttle-increment: throttle percentage increase each time | |
834 | # auto-converge detects that migration is not making | |
835 | # progress. (Since 2.7) | |
836 | # | |
837 | # @tls-creds: ID of the 'tls-creds' object that provides credentials | |
838 | # for establishing a TLS connection over the migration data | |
839 | # channel. On the outgoing side of the migration, the credentials | |
840 | # must be for a 'client' endpoint, while for the incoming side the | |
841 | # credentials must be for a 'server' endpoint. | |
842 | # An empty string means that QEMU will use plain text mode for | |
843 | # migration, rather than TLS (Since 2.7) | |
844 | # Note: 2.8 reports this by omitting tls-creds instead. | |
845 | # | |
846 | # @tls-hostname: hostname of the target host for the migration. This | |
847 | # is required when using x509 based TLS credentials and the | |
848 | # migration URI does not already include a hostname. For | |
849 | # example if using fd: or exec: based migration, the | |
850 | # hostname must be provided so that the server's x509 | |
851 | # certificate identity can be validated. (Since 2.7) | |
852 | # An empty string means that QEMU will use the hostname | |
853 | # associated with the migration URI, if any. (Since 2.9) | |
854 | # Note: 2.8 reports this by omitting tls-hostname instead. | |
855 | # | |
d2f1d29b DB |
856 | # @tls-authz: ID of the 'authz' object subclass that provides access control |
857 | # checking of the TLS x509 certificate distinguished name. (Since | |
858 | # 4.0) | |
859 | # | |
48685a8e MA |
860 | # @max-bandwidth: to set maximum speed for migration. maximum speed in |
861 | # bytes per second. (Since 2.8) | |
862 | # | |
863 | # @downtime-limit: set maximum tolerated downtime for migration. maximum | |
864 | # downtime in milliseconds (Since 2.8) | |
865 | # | |
866 | # @x-checkpoint-delay: the delay time between two COLO checkpoints. (Since 2.8) | |
867 | # | |
868 | # @block-incremental: Affects how much storage is migrated when the | |
26ec4e53 PM |
869 | # block migration capability is enabled. When false, the entire |
870 | # storage backing chain is migrated into a flattened image at | |
871 | # the destination; when true, only the active qcow2 layer is | |
872 | # migrated and the destination must already have access to the | |
873 | # same backing chain as was used on the source. (since 2.10) | |
48685a8e | 874 | # |
cbfd6c95 JQ |
875 | # @multifd-channels: Number of channels used to migrate data in |
876 | # parallel. This is the same number that the | |
877 | # number of sockets used for migration. | |
878 | # The default value is 2 (since 4.0) | |
4075fb1c | 879 | # |
73af8dd8 JQ |
880 | # @xbzrle-cache-size: cache size to be used by XBZRLE migration. It |
881 | # needs to be a multiple of the target page size | |
882 | # and a power of 2 | |
883 | # (Since 2.11) | |
7e555c6c DDAG |
884 | # |
885 | # @max-postcopy-bandwidth: Background transfer bandwidth during postcopy. | |
26ec4e53 PM |
886 | # Defaults to 0 (unlimited). In bytes per second. |
887 | # (Since 3.0) | |
4cbc9c7f LQ |
888 | # |
889 | # @max-cpu-throttle: maximum cpu throttle percentage. | |
890 | # Defaults to 99. | |
26ec4e53 | 891 | # (Since 3.1) |
4cbc9c7f | 892 | # |
96eef042 JQ |
893 | # @multifd-compression: Which compression method to use. |
894 | # Defaults to none. (Since 5.0) | |
895 | # | |
9004db48 JQ |
896 | # @multifd-zlib-level: Set the compression level to be used in live |
897 | # migration, the compression level is an integer between 0 | |
898 | # and 9, where 0 means no compression, 1 means the best | |
899 | # compression speed, and 9 means best compression ratio which | |
900 | # will consume more CPU. | |
901 | # Defaults to 1. (Since 5.0) | |
902 | # | |
6a9ad154 JQ |
903 | # @multifd-zstd-level: Set the compression level to be used in live |
904 | # migration, the compression level is an integer between 0 | |
905 | # and 20, where 0 means no compression, 1 means the best | |
906 | # compression speed, and 20 means best compression ratio which | |
907 | # will consume more CPU. | |
908 | # Defaults to 1. (Since 5.0) | |
909 | # | |
48685a8e MA |
910 | # Since: 2.4 |
911 | ## | |
912 | { 'struct': 'MigrationParameters', | |
ee3d96ba DDAG |
913 | 'data': { '*announce-initial': 'size', |
914 | '*announce-max': 'size', | |
915 | '*announce-rounds': 'size', | |
916 | '*announce-step': 'size', | |
917 | '*compress-level': 'uint8', | |
741d4086 | 918 | '*compress-threads': 'uint8', |
1d58872a | 919 | '*compress-wait-thread': 'bool', |
741d4086 | 920 | '*decompress-threads': 'uint8', |
dc14a470 | 921 | '*throttle-trigger-threshold': 'uint8', |
741d4086 JQ |
922 | '*cpu-throttle-initial': 'uint8', |
923 | '*cpu-throttle-increment': 'uint8', | |
48685a8e MA |
924 | '*tls-creds': 'str', |
925 | '*tls-hostname': 'str', | |
d2f1d29b | 926 | '*tls-authz': 'str', |
741d4086 JQ |
927 | '*max-bandwidth': 'size', |
928 | '*downtime-limit': 'uint64', | |
929 | '*x-checkpoint-delay': 'uint32', | |
4075fb1c | 930 | '*block-incremental': 'bool' , |
cbfd6c95 | 931 | '*multifd-channels': 'uint8', |
7e555c6c | 932 | '*xbzrle-cache-size': 'size', |
dbb28bc8 | 933 | '*max-postcopy-bandwidth': 'size', |
96eef042 | 934 | '*max-cpu-throttle': 'uint8', |
9004db48 | 935 | '*multifd-compression': 'MultiFDCompression', |
6a9ad154 JQ |
936 | '*multifd-zlib-level': 'uint8', |
937 | '*multifd-zstd-level': 'uint8' } } | |
48685a8e MA |
938 | |
939 | ## | |
940 | # @query-migrate-parameters: | |
941 | # | |
942 | # Returns information about the current migration parameters | |
943 | # | |
944 | # Returns: @MigrationParameters | |
945 | # | |
946 | # Since: 2.4 | |
947 | # | |
948 | # Example: | |
949 | # | |
950 | # -> { "execute": "query-migrate-parameters" } | |
951 | # <- { "return": { | |
952 | # "decompress-threads": 2, | |
953 | # "cpu-throttle-increment": 10, | |
954 | # "compress-threads": 8, | |
955 | # "compress-level": 1, | |
956 | # "cpu-throttle-initial": 20, | |
957 | # "max-bandwidth": 33554432, | |
958 | # "downtime-limit": 300 | |
959 | # } | |
960 | # } | |
961 | # | |
962 | ## | |
963 | { 'command': 'query-migrate-parameters', | |
964 | 'returns': 'MigrationParameters' } | |
965 | ||
966 | ## | |
967 | # @client_migrate_info: | |
968 | # | |
969 | # Set migration information for remote display. This makes the server | |
970 | # ask the client to automatically reconnect using the new parameters | |
971 | # once migration finished successfully. Only implemented for SPICE. | |
972 | # | |
973 | # @protocol: must be "spice" | |
974 | # @hostname: migration target hostname | |
975 | # @port: spice tcp port for plaintext channels | |
976 | # @tls-port: spice tcp port for tls-secured channels | |
977 | # @cert-subject: server certificate subject | |
978 | # | |
979 | # Since: 0.14.0 | |
980 | # | |
981 | # Example: | |
982 | # | |
983 | # -> { "execute": "client_migrate_info", | |
984 | # "arguments": { "protocol": "spice", | |
985 | # "hostname": "virt42.lab.kraxel.org", | |
986 | # "port": 1234 } } | |
987 | # <- { "return": {} } | |
988 | # | |
989 | ## | |
990 | { 'command': 'client_migrate_info', | |
991 | 'data': { 'protocol': 'str', 'hostname': 'str', '*port': 'int', | |
992 | '*tls-port': 'int', '*cert-subject': 'str' } } | |
993 | ||
994 | ## | |
995 | # @migrate-start-postcopy: | |
996 | # | |
997 | # Followup to a migration command to switch the migration to postcopy mode. | |
c2eb7f21 GK |
998 | # The postcopy-ram capability must be set on both source and destination |
999 | # before the original migration command. | |
48685a8e MA |
1000 | # |
1001 | # Since: 2.5 | |
1002 | # | |
1003 | # Example: | |
1004 | # | |
1005 | # -> { "execute": "migrate-start-postcopy" } | |
1006 | # <- { "return": {} } | |
1007 | # | |
1008 | ## | |
1009 | { 'command': 'migrate-start-postcopy' } | |
1010 | ||
1011 | ## | |
1012 | # @MIGRATION: | |
1013 | # | |
1014 | # Emitted when a migration event happens | |
1015 | # | |
1016 | # @status: @MigrationStatus describing the current migration status. | |
1017 | # | |
1018 | # Since: 2.4 | |
1019 | # | |
1020 | # Example: | |
1021 | # | |
1022 | # <- {"timestamp": {"seconds": 1432121972, "microseconds": 744001}, | |
1023 | # "event": "MIGRATION", | |
1024 | # "data": {"status": "completed"} } | |
1025 | # | |
1026 | ## | |
1027 | { 'event': 'MIGRATION', | |
1028 | 'data': {'status': 'MigrationStatus'}} | |
1029 | ||
1030 | ## | |
1031 | # @MIGRATION_PASS: | |
1032 | # | |
1033 | # Emitted from the source side of a migration at the start of each pass | |
1034 | # (when it syncs the dirty bitmap) | |
1035 | # | |
1036 | # @pass: An incrementing count (starting at 1 on the first pass) | |
1037 | # | |
1038 | # Since: 2.6 | |
1039 | # | |
1040 | # Example: | |
1041 | # | |
1042 | # { "timestamp": {"seconds": 1449669631, "microseconds": 239225}, | |
1043 | # "event": "MIGRATION_PASS", "data": {"pass": 2} } | |
1044 | # | |
1045 | ## | |
1046 | { 'event': 'MIGRATION_PASS', | |
1047 | 'data': { 'pass': 'int' } } | |
1048 | ||
1049 | ## | |
1050 | # @COLOMessage: | |
1051 | # | |
1052 | # The message transmission between Primary side and Secondary side. | |
1053 | # | |
1054 | # @checkpoint-ready: Secondary VM (SVM) is ready for checkpointing | |
1055 | # | |
1056 | # @checkpoint-request: Primary VM (PVM) tells SVM to prepare for checkpointing | |
1057 | # | |
1058 | # @checkpoint-reply: SVM gets PVM's checkpoint request | |
1059 | # | |
1060 | # @vmstate-send: VM's state will be sent by PVM. | |
1061 | # | |
1062 | # @vmstate-size: The total size of VMstate. | |
1063 | # | |
1064 | # @vmstate-received: VM's state has been received by SVM. | |
1065 | # | |
1066 | # @vmstate-loaded: VM's state has been loaded by SVM. | |
1067 | # | |
1068 | # Since: 2.8 | |
1069 | ## | |
1070 | { 'enum': 'COLOMessage', | |
1071 | 'data': [ 'checkpoint-ready', 'checkpoint-request', 'checkpoint-reply', | |
1072 | 'vmstate-send', 'vmstate-size', 'vmstate-received', | |
1073 | 'vmstate-loaded' ] } | |
1074 | ||
1075 | ## | |
1076 | # @COLOMode: | |
1077 | # | |
41b6b779 | 1078 | # The COLO current mode. |
48685a8e | 1079 | # |
41b6b779 | 1080 | # @none: COLO is disabled. |
48685a8e | 1081 | # |
41b6b779 | 1082 | # @primary: COLO node in primary side. |
48685a8e | 1083 | # |
41b6b779 | 1084 | # @secondary: COLO node in slave side. |
48685a8e MA |
1085 | # |
1086 | # Since: 2.8 | |
1087 | ## | |
1088 | { 'enum': 'COLOMode', | |
41b6b779 | 1089 | 'data': [ 'none', 'primary', 'secondary'] } |
48685a8e MA |
1090 | |
1091 | ## | |
1092 | # @FailoverStatus: | |
1093 | # | |
1094 | # An enumeration of COLO failover status | |
1095 | # | |
1096 | # @none: no failover has ever happened | |
1097 | # | |
1098 | # @require: got failover requirement but not handled | |
1099 | # | |
1100 | # @active: in the process of doing failover | |
1101 | # | |
1102 | # @completed: finish the process of failover | |
1103 | # | |
1104 | # @relaunch: restart the failover process, from 'none' -> 'completed' (Since 2.9) | |
1105 | # | |
1106 | # Since: 2.8 | |
1107 | ## | |
1108 | { 'enum': 'FailoverStatus', | |
1109 | 'data': [ 'none', 'require', 'active', 'completed', 'relaunch' ] } | |
1110 | ||
9ecff6d6 HZ |
1111 | ## |
1112 | # @COLO_EXIT: | |
1113 | # | |
1114 | # Emitted when VM finishes COLO mode due to some errors happening or | |
1115 | # at the request of users. | |
1116 | # | |
1117 | # @mode: report COLO mode when COLO exited. | |
1118 | # | |
1119 | # @reason: describes the reason for the COLO exit. | |
1120 | # | |
1121 | # Since: 3.1 | |
1122 | # | |
1123 | # Example: | |
1124 | # | |
1125 | # <- { "timestamp": {"seconds": 2032141960, "microseconds": 417172}, | |
1126 | # "event": "COLO_EXIT", "data": {"mode": "primary", "reason": "request" } } | |
1127 | # | |
1128 | ## | |
1129 | { 'event': 'COLO_EXIT', | |
1130 | 'data': {'mode': 'COLOMode', 'reason': 'COLOExitReason' } } | |
1131 | ||
1132 | ## | |
1133 | # @COLOExitReason: | |
1134 | # | |
3a43ac47 | 1135 | # The reason for a COLO exit. |
9ecff6d6 | 1136 | # |
3a43ac47 | 1137 | # @none: failover has never happened. This state does not occur |
26ec4e53 PM |
1138 | # in the COLO_EXIT event, and is only visible in the result of |
1139 | # query-colo-status. | |
9ecff6d6 | 1140 | # |
3a43ac47 | 1141 | # @request: COLO exit is due to an external request. |
9ecff6d6 | 1142 | # |
3a43ac47 ZC |
1143 | # @error: COLO exit is due to an internal error. |
1144 | # | |
1145 | # @processing: COLO is currently handling a failover (since 4.0). | |
9ecff6d6 HZ |
1146 | # |
1147 | # Since: 3.1 | |
1148 | ## | |
1149 | { 'enum': 'COLOExitReason', | |
3a43ac47 | 1150 | 'data': [ 'none', 'request', 'error' , 'processing' ] } |
9ecff6d6 | 1151 | |
48685a8e MA |
1152 | ## |
1153 | # @x-colo-lost-heartbeat: | |
1154 | # | |
1155 | # Tell qemu that heartbeat is lost, request it to do takeover procedures. | |
1156 | # If this command is sent to the PVM, the Primary side will exit COLO mode. | |
1157 | # If sent to the Secondary, the Secondary side will run failover work, | |
1158 | # then takes over server operation to become the service VM. | |
1159 | # | |
1160 | # Since: 2.8 | |
1161 | # | |
1162 | # Example: | |
1163 | # | |
1164 | # -> { "execute": "x-colo-lost-heartbeat" } | |
1165 | # <- { "return": {} } | |
1166 | # | |
1167 | ## | |
1168 | { 'command': 'x-colo-lost-heartbeat' } | |
1169 | ||
1170 | ## | |
1171 | # @migrate_cancel: | |
1172 | # | |
1173 | # Cancel the current executing migration process. | |
1174 | # | |
1175 | # Returns: nothing on success | |
1176 | # | |
1177 | # Notes: This command succeeds even if there is no migration process running. | |
1178 | # | |
1179 | # Since: 0.14.0 | |
1180 | # | |
1181 | # Example: | |
1182 | # | |
1183 | # -> { "execute": "migrate_cancel" } | |
1184 | # <- { "return": {} } | |
1185 | # | |
1186 | ## | |
1187 | { 'command': 'migrate_cancel' } | |
1188 | ||
89cfc02c DDAG |
1189 | ## |
1190 | # @migrate-continue: | |
1191 | # | |
1192 | # Continue migration when it's in a paused state. | |
1193 | # | |
1194 | # @state: The state the migration is currently expected to be in | |
1195 | # | |
1196 | # Returns: nothing on success | |
1197 | # Since: 2.11 | |
1198 | # Example: | |
1199 | # | |
1200 | # -> { "execute": "migrate-continue" , "arguments": | |
1201 | # { "state": "pre-switchover" } } | |
1202 | # <- { "return": {} } | |
1203 | ## | |
1204 | { 'command': 'migrate-continue', 'data': {'state': 'MigrationStatus'} } | |
1205 | ||
48685a8e MA |
1206 | ## |
1207 | # @migrate_set_downtime: | |
1208 | # | |
1209 | # Set maximum tolerated downtime for migration. | |
1210 | # | |
1211 | # @value: maximum downtime in seconds | |
1212 | # | |
1213 | # Returns: nothing on success | |
1214 | # | |
1215 | # Notes: This command is deprecated in favor of 'migrate-set-parameters' | |
1216 | # | |
1217 | # Since: 0.14.0 | |
1218 | # | |
1219 | # Example: | |
1220 | # | |
1221 | # -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } } | |
1222 | # <- { "return": {} } | |
1223 | # | |
1224 | ## | |
1225 | { 'command': 'migrate_set_downtime', 'data': {'value': 'number'} } | |
1226 | ||
1227 | ## | |
1228 | # @migrate_set_speed: | |
1229 | # | |
1230 | # Set maximum speed for migration. | |
1231 | # | |
1232 | # @value: maximum speed in bytes per second. | |
1233 | # | |
1234 | # Returns: nothing on success | |
1235 | # | |
1236 | # Notes: This command is deprecated in favor of 'migrate-set-parameters' | |
1237 | # | |
1238 | # Since: 0.14.0 | |
1239 | # | |
1240 | # Example: | |
1241 | # | |
1242 | # -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } } | |
1243 | # <- { "return": {} } | |
1244 | # | |
1245 | ## | |
1246 | { 'command': 'migrate_set_speed', 'data': {'value': 'int'} } | |
1247 | ||
1248 | ## | |
1249 | # @migrate-set-cache-size: | |
1250 | # | |
1251 | # Set cache size to be used by XBZRLE migration | |
1252 | # | |
1253 | # @value: cache size in bytes | |
1254 | # | |
1255 | # The size will be rounded down to the nearest power of 2. | |
1256 | # The cache size can be modified before and during ongoing migration | |
1257 | # | |
1258 | # Returns: nothing on success | |
1259 | # | |
73af8dd8 JQ |
1260 | # Notes: This command is deprecated in favor of 'migrate-set-parameters' |
1261 | # | |
48685a8e MA |
1262 | # Since: 1.2 |
1263 | # | |
1264 | # Example: | |
1265 | # | |
1266 | # -> { "execute": "migrate-set-cache-size", | |
1267 | # "arguments": { "value": 536870912 } } | |
1268 | # <- { "return": {} } | |
1269 | # | |
1270 | ## | |
1271 | { 'command': 'migrate-set-cache-size', 'data': {'value': 'int'} } | |
1272 | ||
1273 | ## | |
1274 | # @query-migrate-cache-size: | |
1275 | # | |
1276 | # Query migration XBZRLE cache size | |
1277 | # | |
1278 | # Returns: XBZRLE cache size in bytes | |
1279 | # | |
73af8dd8 JQ |
1280 | # Notes: This command is deprecated in favor of 'query-migrate-parameters' |
1281 | # | |
48685a8e MA |
1282 | # Since: 1.2 |
1283 | # | |
1284 | # Example: | |
1285 | # | |
1286 | # -> { "execute": "query-migrate-cache-size" } | |
1287 | # <- { "return": 67108864 } | |
1288 | # | |
1289 | ## | |
1290 | { 'command': 'query-migrate-cache-size', 'returns': 'int' } | |
1291 | ||
1292 | ## | |
1293 | # @migrate: | |
1294 | # | |
1295 | # Migrates the current running guest to another Virtual Machine. | |
1296 | # | |
1297 | # @uri: the Uniform Resource Identifier of the destination VM | |
1298 | # | |
1299 | # @blk: do block migration (full disk copy) | |
1300 | # | |
1301 | # @inc: incremental disk copy migration | |
1302 | # | |
1303 | # @detach: this argument exists only for compatibility reasons and | |
1304 | # is ignored by QEMU | |
1305 | # | |
51f63ec7 | 1306 | # @resume: resume one paused migration, default "off". (since 3.0) |
7a4da28b | 1307 | # |
48685a8e MA |
1308 | # Returns: nothing on success |
1309 | # | |
1310 | # Since: 0.14.0 | |
1311 | # | |
1312 | # Notes: | |
1313 | # | |
1314 | # 1. The 'query-migrate' command should be used to check migration's progress | |
1315 | # and final result (this information is provided by the 'status' member) | |
1316 | # | |
1317 | # 2. All boolean arguments default to false | |
1318 | # | |
1319 | # 3. The user Monitor's "detach" argument is invalid in QMP and should not | |
1320 | # be used | |
1321 | # | |
1322 | # Example: | |
1323 | # | |
1324 | # -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } } | |
1325 | # <- { "return": {} } | |
1326 | # | |
1327 | ## | |
1328 | { 'command': 'migrate', | |
7a4da28b PX |
1329 | 'data': {'uri': 'str', '*blk': 'bool', '*inc': 'bool', |
1330 | '*detach': 'bool', '*resume': 'bool' } } | |
48685a8e MA |
1331 | |
1332 | ## | |
1333 | # @migrate-incoming: | |
1334 | # | |
1335 | # Start an incoming migration, the qemu must have been started | |
1336 | # with -incoming defer | |
1337 | # | |
1338 | # @uri: The Uniform Resource Identifier identifying the source or | |
1339 | # address to listen on | |
1340 | # | |
1341 | # Returns: nothing on success | |
1342 | # | |
1343 | # Since: 2.3 | |
1344 | # | |
1345 | # Notes: | |
1346 | # | |
1347 | # 1. It's a bad idea to use a string for the uri, but it needs to stay | |
1348 | # compatible with -incoming and the format of the uri is already exposed | |
1349 | # above libvirt. | |
1350 | # | |
1351 | # 2. QEMU must be started with -incoming defer to allow migrate-incoming to | |
1352 | # be used. | |
1353 | # | |
1354 | # 3. The uri format is the same as for -incoming | |
1355 | # | |
1356 | # Example: | |
1357 | # | |
1358 | # -> { "execute": "migrate-incoming", | |
1359 | # "arguments": { "uri": "tcp::4446" } } | |
1360 | # <- { "return": {} } | |
1361 | # | |
1362 | ## | |
1363 | { 'command': 'migrate-incoming', 'data': {'uri': 'str' } } | |
1364 | ||
1365 | ## | |
1366 | # @xen-save-devices-state: | |
1367 | # | |
1368 | # Save the state of all devices to file. The RAM and the block devices | |
1369 | # of the VM are not saved by this command. | |
1370 | # | |
1371 | # @filename: the file to save the state of the devices to as binary | |
26ec4e53 PM |
1372 | # data. See xen-save-devices-state.txt for a description of the binary |
1373 | # format. | |
48685a8e | 1374 | # |
5d6c599f | 1375 | # @live: Optional argument to ask QEMU to treat this command as part of a live |
26ec4e53 | 1376 | # migration. Default to true. (since 2.11) |
5d6c599f | 1377 | # |
48685a8e MA |
1378 | # Returns: Nothing on success |
1379 | # | |
1380 | # Since: 1.1 | |
1381 | # | |
1382 | # Example: | |
1383 | # | |
1384 | # -> { "execute": "xen-save-devices-state", | |
1385 | # "arguments": { "filename": "/tmp/save" } } | |
1386 | # <- { "return": {} } | |
1387 | # | |
1388 | ## | |
5d6c599f AP |
1389 | { 'command': 'xen-save-devices-state', |
1390 | 'data': {'filename': 'str', '*live':'bool' } } | |
48685a8e MA |
1391 | |
1392 | ## | |
1393 | # @xen-set-replication: | |
1394 | # | |
1395 | # Enable or disable replication. | |
1396 | # | |
1397 | # @enable: true to enable, false to disable. | |
1398 | # | |
1399 | # @primary: true for primary or false for secondary. | |
1400 | # | |
1401 | # @failover: true to do failover, false to stop. but cannot be | |
1402 | # specified if 'enable' is true. default value is false. | |
1403 | # | |
1404 | # Returns: nothing. | |
1405 | # | |
1406 | # Example: | |
1407 | # | |
1408 | # -> { "execute": "xen-set-replication", | |
1409 | # "arguments": {"enable": true, "primary": false} } | |
1410 | # <- { "return": {} } | |
1411 | # | |
1412 | # Since: 2.9 | |
1413 | ## | |
1414 | { 'command': 'xen-set-replication', | |
335d10cd MAL |
1415 | 'data': { 'enable': 'bool', 'primary': 'bool', '*failover' : 'bool' }, |
1416 | 'if': 'defined(CONFIG_REPLICATION)' } | |
48685a8e MA |
1417 | |
1418 | ## | |
1419 | # @ReplicationStatus: | |
1420 | # | |
1421 | # The result format for 'query-xen-replication-status'. | |
1422 | # | |
1423 | # @error: true if an error happened, false if replication is normal. | |
1424 | # | |
1425 | # @desc: the human readable error description string, when | |
1426 | # @error is 'true'. | |
1427 | # | |
1428 | # Since: 2.9 | |
1429 | ## | |
1430 | { 'struct': 'ReplicationStatus', | |
335d10cd MAL |
1431 | 'data': { 'error': 'bool', '*desc': 'str' }, |
1432 | 'if': 'defined(CONFIG_REPLICATION)' } | |
48685a8e MA |
1433 | |
1434 | ## | |
1435 | # @query-xen-replication-status: | |
1436 | # | |
1437 | # Query replication status while the vm is running. | |
1438 | # | |
1439 | # Returns: A @ReplicationResult object showing the status. | |
1440 | # | |
1441 | # Example: | |
1442 | # | |
1443 | # -> { "execute": "query-xen-replication-status" } | |
1444 | # <- { "return": { "error": false } } | |
1445 | # | |
1446 | # Since: 2.9 | |
1447 | ## | |
1448 | { 'command': 'query-xen-replication-status', | |
335d10cd MAL |
1449 | 'returns': 'ReplicationStatus', |
1450 | 'if': 'defined(CONFIG_REPLICATION)' } | |
48685a8e MA |
1451 | |
1452 | ## | |
1453 | # @xen-colo-do-checkpoint: | |
1454 | # | |
1455 | # Xen uses this command to notify replication to trigger a checkpoint. | |
1456 | # | |
1457 | # Returns: nothing. | |
1458 | # | |
1459 | # Example: | |
1460 | # | |
1461 | # -> { "execute": "xen-colo-do-checkpoint" } | |
1462 | # <- { "return": {} } | |
1463 | # | |
1464 | # Since: 2.9 | |
1465 | ## | |
335d10cd MAL |
1466 | { 'command': 'xen-colo-do-checkpoint', |
1467 | 'if': 'defined(CONFIG_REPLICATION)' } | |
02affd41 | 1468 | |
f56c0065 ZC |
1469 | ## |
1470 | # @COLOStatus: | |
1471 | # | |
1472 | # The result format for 'query-colo-status'. | |
1473 | # | |
1474 | # @mode: COLO running mode. If COLO is running, this field will return | |
1475 | # 'primary' or 'secondary'. | |
1476 | # | |
5cc8f9eb | 1477 | # @last-mode: COLO last running mode. If COLO is running, this field |
5ed0deca | 1478 | # will return same like mode field, after failover we can |
966c0d49 | 1479 | # use this field to get last colo mode. (since 4.0) |
5ed0deca | 1480 | # |
f56c0065 ZC |
1481 | # @reason: describes the reason for the COLO exit. |
1482 | # | |
ea3b23e5 | 1483 | # Since: 3.1 |
f56c0065 ZC |
1484 | ## |
1485 | { 'struct': 'COLOStatus', | |
5cc8f9eb | 1486 | 'data': { 'mode': 'COLOMode', 'last-mode': 'COLOMode', |
5ed0deca | 1487 | 'reason': 'COLOExitReason' } } |
f56c0065 ZC |
1488 | |
1489 | ## | |
1490 | # @query-colo-status: | |
1491 | # | |
1492 | # Query COLO status while the vm is running. | |
1493 | # | |
1494 | # Returns: A @COLOStatus object showing the status. | |
1495 | # | |
1496 | # Example: | |
1497 | # | |
1498 | # -> { "execute": "query-colo-status" } | |
b5922fc5 | 1499 | # <- { "return": { "mode": "primary", "reason": "request" } } |
f56c0065 | 1500 | # |
ea3b23e5 | 1501 | # Since: 3.1 |
f56c0065 ZC |
1502 | ## |
1503 | { 'command': 'query-colo-status', | |
1504 | 'returns': 'COLOStatus' } | |
1505 | ||
02affd41 PX |
1506 | ## |
1507 | # @migrate-recover: | |
1508 | # | |
1509 | # Provide a recovery migration stream URI. | |
1510 | # | |
1511 | # @uri: the URI to be used for the recovery of migration stream. | |
1512 | # | |
1513 | # Returns: nothing. | |
1514 | # | |
1515 | # Example: | |
1516 | # | |
1517 | # -> { "execute": "migrate-recover", | |
1518 | # "arguments": { "uri": "tcp:192.168.1.200:12345" } } | |
1519 | # <- { "return": {} } | |
1520 | # | |
51f63ec7 | 1521 | # Since: 3.0 |
02affd41 | 1522 | ## |
b0ddeba2 MAL |
1523 | { 'command': 'migrate-recover', |
1524 | 'data': { 'uri': 'str' }, | |
02affd41 | 1525 | 'allow-oob': true } |
bfbf89c2 PX |
1526 | |
1527 | ## | |
1528 | # @migrate-pause: | |
1529 | # | |
1530 | # Pause a migration. Currently it only supports postcopy. | |
1531 | # | |
1532 | # Returns: nothing. | |
1533 | # | |
1534 | # Example: | |
1535 | # | |
1536 | # -> { "execute": "migrate-pause" } | |
1537 | # <- { "return": {} } | |
1538 | # | |
51f63ec7 | 1539 | # Since: 3.0 |
bfbf89c2 PX |
1540 | ## |
1541 | { 'command': 'migrate-pause', 'allow-oob': true } | |
d328e6f3 JF |
1542 | |
1543 | ## | |
1544 | # @UNPLUG_PRIMARY: | |
1545 | # | |
1546 | # Emitted from source side of a migration when migration state is | |
1547 | # WAIT_UNPLUG. Device was unplugged by guest operating system. | |
1548 | # Device resources in QEMU are kept on standby to be able to re-plug it in case | |
1549 | # of migration failure. | |
1550 | # | |
1551 | # @device-id: QEMU device id of the unplugged device | |
1552 | # | |
1553 | # Since: 4.2 | |
1554 | # | |
1555 | # Example: | |
1556 | # {"event": "UNPLUG_PRIMARY", "data": {"device-id": "hostdev0"} } | |
1557 | # | |
1558 | ## | |
1559 | { 'event': 'UNPLUG_PRIMARY', | |
1560 | 'data': { 'device-id': 'str' } } |