| blob | b7348d0c8bfad8e0990685b3f3350487a40172ee |
1 # -*- Mode: Python -*-
2 #
4 ##
5 # = Migration
6 ##
8 { 'include': 'common.json' }
9 { 'include': 'sockets.json' }
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
31 # guest (since 1.3)
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
38 # (since 2.7)
39 #
40 # @page-size: The number of bytes per page for the various page-based
41 # statistics (since 2.10)
42 #
43 # @multifd-bytes: The number of bytes sent through multifd (since 3.0)
44 #
45 # @pages-per-second: the number of memory pages transferred per second
46 # (Since 4.0)
47 #
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',
55 'postcopy-requests' : 'int', 'page-size' : 'int',
56 'multifd-bytes' : 'uint64', 'pages-per-second' : 'uint64' } }
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' } }
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',
101 'compressed-size': 'int', 'compression-rate': 'number' } }
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 #
120 # @postcopy-paused: during postcopy but paused. (since 3.0)
121 #
122 # @postcopy-recover: trying to recover from a paused postcopy. (since 3.0)
123 #
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 #
131 # @pre-switchover: Paused before device serialisation. (since 2.11)
132 #
133 # @device: During device serialisation when pause-before-switchover is enabled
134 # (since 2.11)
135 #
136 # @wait-unplug: wait for device unplug request by guest OS to be completed.
137 # (since 4.2)
138 #
139 # Since: 2.3
140 #
141 ##
142 { 'enum': 'MigrationStatus',
143 'data': [ 'none', 'setup', 'cancelling', 'cancelled',
144 'active', 'postcopy-active', 'postcopy-paused',
145 'postcopy-recover', 'completed', 'failed', 'colo',
146 'pre-switchover', 'device', 'wait-unplug' ] }
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.
170 # If migration has ended, it returns the total migration
171 # time. (since 1.2)
172 #
173 # @downtime: only present when migration finishes correctly
174 # total downtime in milliseconds for the guest.
175 # (since 1.3)
176 #
177 # @expected-downtime: only present while migration is active
178 # expected downtime in milliseconds for the guest in last walk
179 # of the dirty bitmap. (since 1.3)
180 #
181 # @setup-time: amount of setup time in milliseconds _before_ the
182 # iterations begin but _after_ the QMP command is issued. This is designed
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)
186 #
187 # @cpu-throttle-percentage: percentage of time guest cpus are being
188 # throttled during auto-converge. This is only present when auto-converge
189 # has started throttling guest cpus. (Since 2.7)
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)
194 #
195 # @postcopy-blocktime: total time when all vCPU were blocked during postcopy
196 # live migration. This is only present when the postcopy-blocktime
197 # migration capability is enabled. (Since 3.0)
198 #
199 # @postcopy-vcpu-blocktime: list of the postcopy blocktime per vCPU. This is
200 # only present when the postcopy-blocktime migration capability
201 # is enabled. (Since 3.0)
202 #
203 # @compression: migration compression statistics, only returned if compression
204 # feature is on and status is 'active' or 'completed' (Since 3.1)
205 #
206 # @socket-address: Only used for tcp, to know what the real port is (Since 4.0)
207 #
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',
219 '*error-desc': 'str',
220 '*postcopy-blocktime' : 'uint32',
221 '*postcopy-vcpu-blocktime': ['uint32'],
222 '*compression': 'CompressionStats',
223 '*socket-address': ['SocketAddress'] } }
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",
249 # "total-time":12345,
250 # "setup-time":12345,
251 # "downtime":12345,
252 # "ram":{
253 # "transferred":123,
254 # "remaining":123,
255 # "total":246,
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",
275 # "total-time":12345,
276 # "setup-time":12345,
277 # "expected-downtime":12345,
278 # "ram":{
279 # "transferred":123,
280 # "remaining":123,
281 # "total":246,
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",
296 # "total-time":12345,
297 # "setup-time":12345,
298 # "expected-downtime":12345,
299 # "ram":{
300 # "total":1057024,
301 # "remaining":1053304,
302 # "transferred":3720,
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",
322 # "total-time":12345,
323 # "setup-time":12345,
324 # "expected-downtime":12345,
325 # "ram":{
326 # "total":1057024,
327 # "remaining":1053304,
328 # "transferred":3720,
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' }
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
358 # mlock()'d on demand or all at once. Refer to docs/rdma.txt for usage.
359 # Disabled by default. (since 2.0)
360 #
361 # @zero-blocks: During storage migration encode blocks of zeroes efficiently. This
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)
366 #
367 # @compress: Use multiple compression threads to accelerate live migration.
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 )
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
379 # to speed up convergence of RAM migration. (since 1.6)
380 #
381 # @postcopy-ram: Start executing on the migration target before all of RAM has
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)
386 #
387 # @x-colo: If enabled, migration will never end, and the state of the VM on the
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)
391 #
392 # @release-ram: if enabled, qemu will free the migrated ram pages on the source
393 # during postcopy-ram migration. (since 2.9)
394 #
395 # @block: If enabled, QEMU will also migrate the contents of all block
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)
400 #
401 # @return-path: If enabled, migration will use the return path even
402 # for precopy. (since 2.10)
403 #
404 # @pause-before-switchover: Pause outgoing migration before serialising device
405 # state and before disabling block IO (since 2.11)
406 #
407 # @multifd: Use more than one fd for migration (since 4.0)
408 #
409 # @dirty-bitmaps: If enabled, QEMU will migrate named dirty bitmaps.
410 # (since 2.12)
411 #
412 # @postcopy-blocktime: Calculate downtime for postcopy live migration
413 # (since 3.0)
414 #
415 # @late-block-activate: If enabled, the destination will not activate block
416 # devices (and thus take locks) immediately at the end of migration.
417 # (since 3.0)
418 #
419 # @x-ignore-shared: If enabled, QEMU will not migrate shared memory (since 4.0)
420 #
421 # @validate-uuid: Send the UUID of the source to allow the destination
422 # to ensure it is the same. (since 4.2)
423 #
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',
429 'block', 'return-path', 'pause-before-switchover', 'multifd',
430 'dirty-bitmaps', 'postcopy-blocktime', 'late-block-activate',
431 'x-ignore-shared', 'validate-uuid' ] }
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' } }
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'] } }
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']}
491 ##
492 # @MigrationParameter:
493 #
494 # Migration parameters enumeration
495 #
496 # @announce-initial: Initial delay (in milliseconds) before sending the first
497 # announce (Since 4.0)
498 #
499 # @announce-max: Maximum delay (in milliseconds) between packets in the
500 # announcement (Since 4.0)
501 #
502 # @announce-rounds: Number of self-announce packets sent after migration
503 # (Since 4.0)
504 #
505 # @announce-step: Increase in delay (in milliseconds) between subsequent
506 # packets in the announcement (Since 4.0)
507 #
508 # @compress-level: Set the compression level to be used in live migration,
509 # the compression level is an integer between 0 and 9, where 0 means
510 # no compression, 1 means the best compression speed, and 9 means best
511 # compression ratio which will consume more CPU.
512 #
513 # @compress-threads: Set compression thread count to be used in live migration,
514 # the compression thread count is an integer between 1 and 255.
515 #
516 # @compress-wait-thread: Controls behavior when all compression threads are
517 # currently busy. If true (default), wait for a free
518 # compression thread to become available; otherwise,
519 # send the page uncompressed. (Since 3.1)
520 #
521 # @decompress-threads: Set decompression thread count to be used in live
522 # migration, the decompression thread count is an integer between 1
523 # and 255. Usually, decompression is at least 4 times as fast as
524 # compression, so set the decompress-threads to the number about 1/4
525 # of compress-threads is adequate.
526 #
527 # @cpu-throttle-initial: Initial percentage of time guest cpus are throttled
528 # when migration auto-converge is activated. The
529 # default value is 20. (Since 2.7)
530 #
531 # @cpu-throttle-increment: throttle percentage increase each time
532 # auto-converge detects that migration is not making
533 # progress. The default value is 10. (Since 2.7)
534 #
535 # @tls-creds: ID of the 'tls-creds' object that provides credentials for
536 # establishing a TLS connection over the migration data channel.
537 # On the outgoing side of the migration, the credentials must
538 # be for a 'client' endpoint, while for the incoming side the
539 # credentials must be for a 'server' endpoint. Setting this
540 # will enable TLS for all migrations. The default is unset,
541 # resulting in unsecured migration at the QEMU level. (Since 2.7)
542 #
543 # @tls-hostname: hostname of the target host for the migration. This is
544 # required when using x509 based TLS credentials and the
545 # migration URI does not already include a hostname. For
546 # example if using fd: or exec: based migration, the
547 # hostname must be provided so that the server's x509
548 # certificate identity can be validated. (Since 2.7)
549 #
550 # @tls-authz: ID of the 'authz' object subclass that provides access control
551 # checking of the TLS x509 certificate distinguished name.
552 # This object is only resolved at time of use, so can be deleted
553 # and recreated on the fly while the migration server is active.
554 # If missing, it will default to denying access (Since 4.0)
555 #
556 # @max-bandwidth: to set maximum speed for migration. maximum speed in
557 # bytes per second. (Since 2.8)
558 #
559 # @downtime-limit: set maximum tolerated downtime for migration. maximum
560 # downtime in milliseconds (Since 2.8)
561 #
562 # @x-checkpoint-delay: The delay time (in ms) between two COLO checkpoints in
563 # periodic mode. (Since 2.8)
564 #
565 # @block-incremental: Affects how much storage is migrated when the
566 # block migration capability is enabled. When false, the entire
567 # storage backing chain is migrated into a flattened image at
568 # the destination; when true, only the active qcow2 layer is
569 # migrated and the destination must already have access to the
570 # same backing chain as was used on the source. (since 2.10)
571 #
572 # @multifd-channels: Number of channels used to migrate data in
573 # parallel. This is the same number that the
574 # number of sockets used for migration. The
575 # default value is 2 (since 4.0)
576 #
577 # @xbzrle-cache-size: cache size to be used by XBZRLE migration. It
578 # needs to be a multiple of the target page size
579 # and a power of 2
580 # (Since 2.11)
581 #
582 # @max-postcopy-bandwidth: Background transfer bandwidth during postcopy.
583 # Defaults to 0 (unlimited). In bytes per second.
584 # (Since 3.0)
585 #
586 # @max-cpu-throttle: maximum cpu throttle percentage.
587 # Defaults to 99. (Since 3.1)
588 #
589 # Since: 2.4
590 ##
591 { 'enum': 'MigrationParameter',
592 'data': ['announce-initial', 'announce-max',
593 'announce-rounds', 'announce-step',
594 'compress-level', 'compress-threads', 'decompress-threads',
595 'compress-wait-thread',
596 'cpu-throttle-initial', 'cpu-throttle-increment',
597 'tls-creds', 'tls-hostname', 'tls-authz', 'max-bandwidth',
598 'downtime-limit', 'x-checkpoint-delay', 'block-incremental',
599 'multifd-channels',
600 'xbzrle-cache-size', 'max-postcopy-bandwidth',
601 'max-cpu-throttle' ] }
603 ##
604 # @MigrateSetParameters:
605 #
606 # @announce-initial: Initial delay (in milliseconds) before sending the first
607 # announce (Since 4.0)
608 #
609 # @announce-max: Maximum delay (in milliseconds) between packets in the
610 # announcement (Since 4.0)
611 #
612 # @announce-rounds: Number of self-announce packets sent after migration
613 # (Since 4.0)
614 #
615 # @announce-step: Increase in delay (in milliseconds) between subsequent
616 # packets in the announcement (Since 4.0)
617 #
618 # @compress-level: compression level
619 #
620 # @compress-threads: compression thread count
621 #
622 # @compress-wait-thread: Controls behavior when all compression threads are
623 # currently busy. If true (default), wait for a free
624 # compression thread to become available; otherwise,
625 # send the page uncompressed. (Since 3.1)
626 #
627 # @decompress-threads: decompression thread count
628 #
629 # @cpu-throttle-initial: Initial percentage of time guest cpus are
630 # throttled when migration auto-converge is activated.
631 # The default value is 20. (Since 2.7)
632 #
633 # @cpu-throttle-increment: throttle percentage increase each time
634 # auto-converge detects that migration is not making
635 # progress. The default value is 10. (Since 2.7)
636 #
637 # @tls-creds: ID of the 'tls-creds' object that provides credentials
638 # for establishing a TLS connection over the migration data
639 # channel. On the outgoing side of the migration, the credentials
640 # must be for a 'client' endpoint, while for the incoming side the
641 # credentials must be for a 'server' endpoint. Setting this
642 # to a non-empty string enables TLS for all migrations.
643 # An empty string means that QEMU will use plain text mode for
644 # migration, rather than TLS (Since 2.9)
645 # Previously (since 2.7), this was reported by omitting
646 # tls-creds instead.
647 #
648 # @tls-hostname: hostname of the target host for the migration. This
649 # is required when using x509 based TLS credentials and the
650 # migration URI does not already include a hostname. For
651 # example if using fd: or exec: based migration, the
652 # hostname must be provided so that the server's x509
653 # certificate identity can be validated. (Since 2.7)
654 # An empty string means that QEMU will use the hostname
655 # associated with the migration URI, if any. (Since 2.9)
656 # Previously (since 2.7), this was reported by omitting
657 # tls-hostname instead.
658 #
659 # @max-bandwidth: to set maximum speed for migration. maximum speed in
660 # bytes per second. (Since 2.8)
661 #
662 # @downtime-limit: set maximum tolerated downtime for migration. maximum
663 # downtime in milliseconds (Since 2.8)
664 #
665 # @x-checkpoint-delay: the delay time between two COLO checkpoints. (Since 2.8)
666 #
667 # @block-incremental: Affects how much storage is migrated when the
668 # block migration capability is enabled. When false, the entire
669 # storage backing chain is migrated into a flattened image at
670 # the destination; when true, only the active qcow2 layer is
671 # migrated and the destination must already have access to the
672 # same backing chain as was used on the source. (since 2.10)
673 #
674 # @multifd-channels: Number of channels used to migrate data in
675 # parallel. This is the same number that the
676 # number of sockets used for migration. The
677 # default value is 2 (since 4.0)
678 #
679 # @xbzrle-cache-size: cache size to be used by XBZRLE migration. It
680 # needs to be a multiple of the target page size
681 # and a power of 2
682 # (Since 2.11)
683 #
684 # @max-postcopy-bandwidth: Background transfer bandwidth during postcopy.
685 # Defaults to 0 (unlimited). In bytes per second.
686 # (Since 3.0)
687 #
688 # @max-cpu-throttle: maximum cpu throttle percentage.
689 # The default value is 99. (Since 3.1)
690 #
691 # Since: 2.4
692 ##
693 # TODO either fuse back into MigrationParameters, or make
694 # MigrationParameters members mandatory
695 { 'struct': 'MigrateSetParameters',
696 'data': { '*announce-initial': 'size',
697 '*announce-max': 'size',
698 '*announce-rounds': 'size',
699 '*announce-step': 'size',
700 '*compress-level': 'int',
701 '*compress-threads': 'int',
702 '*compress-wait-thread': 'bool',
703 '*decompress-threads': 'int',
704 '*cpu-throttle-initial': 'int',
705 '*cpu-throttle-increment': 'int',
706 '*tls-creds': 'StrOrNull',
707 '*tls-hostname': 'StrOrNull',
708 '*tls-authz': 'StrOrNull',
709 '*max-bandwidth': 'int',
710 '*downtime-limit': 'int',
711 '*x-checkpoint-delay': 'int',
712 '*block-incremental': 'bool',
713 '*multifd-channels': 'int',
714 '*xbzrle-cache-size': 'size',
715 '*max-postcopy-bandwidth': 'size',
716 '*max-cpu-throttle': 'int' } }
718 ##
719 # @migrate-set-parameters:
720 #
721 # Set various migration parameters.
722 #
723 # Since: 2.4
724 #
725 # Example:
726 #
727 # -> { "execute": "migrate-set-parameters" ,
728 # "arguments": { "compress-level": 1 } }
729 #
730 ##
731 { 'command': 'migrate-set-parameters', 'boxed': true,
732 'data': 'MigrateSetParameters' }
734 ##
735 # @MigrationParameters:
736 #
737 # The optional members aren't actually optional.
738 #
739 # @announce-initial: Initial delay (in milliseconds) before sending the
740 # first announce (Since 4.0)
741 #
742 # @announce-max: Maximum delay (in milliseconds) between packets in the
743 # announcement (Since 4.0)
744 #
745 # @announce-rounds: Number of self-announce packets sent after migration
746 # (Since 4.0)
747 #
748 # @announce-step: Increase in delay (in milliseconds) between subsequent
749 # packets in the announcement (Since 4.0)
750 #
751 # @compress-level: compression level
752 #
753 # @compress-threads: compression thread count
754 #
755 # @compress-wait-thread: Controls behavior when all compression threads are
756 # currently busy. If true (default), wait for a free
757 # compression thread to become available; otherwise,
758 # send the page uncompressed. (Since 3.1)
759 #
760 # @decompress-threads: decompression thread count
761 #
762 # @cpu-throttle-initial: Initial percentage of time guest cpus are
763 # throttled when migration auto-converge is activated.
764 # (Since 2.7)
765 #
766 # @cpu-throttle-increment: throttle percentage increase each time
767 # auto-converge detects that migration is not making
768 # progress. (Since 2.7)
769 #
770 # @tls-creds: ID of the 'tls-creds' object that provides credentials
771 # for establishing a TLS connection over the migration data
772 # channel. On the outgoing side of the migration, the credentials
773 # must be for a 'client' endpoint, while for the incoming side the
774 # credentials must be for a 'server' endpoint.
775 # An empty string means that QEMU will use plain text mode for
776 # migration, rather than TLS (Since 2.7)
777 # Note: 2.8 reports this by omitting tls-creds instead.
778 #
779 # @tls-hostname: hostname of the target host for the migration. This
780 # is required when using x509 based TLS credentials and the
781 # migration URI does not already include a hostname. For
782 # example if using fd: or exec: based migration, the
783 # hostname must be provided so that the server's x509
784 # certificate identity can be validated. (Since 2.7)
785 # An empty string means that QEMU will use the hostname
786 # associated with the migration URI, if any. (Since 2.9)
787 # Note: 2.8 reports this by omitting tls-hostname instead.
788 #
789 # @tls-authz: ID of the 'authz' object subclass that provides access control
790 # checking of the TLS x509 certificate distinguished name. (Since
791 # 4.0)
792 #
793 # @max-bandwidth: to set maximum speed for migration. maximum speed in
794 # bytes per second. (Since 2.8)
795 #
796 # @downtime-limit: set maximum tolerated downtime for migration. maximum
797 # downtime in milliseconds (Since 2.8)
798 #
799 # @x-checkpoint-delay: the delay time between two COLO checkpoints. (Since 2.8)
800 #
801 # @block-incremental: Affects how much storage is migrated when the
802 # block migration capability is enabled. When false, the entire
803 # storage backing chain is migrated into a flattened image at
804 # the destination; when true, only the active qcow2 layer is
805 # migrated and the destination must already have access to the
806 # same backing chain as was used on the source. (since 2.10)
807 #
808 # @multifd-channels: Number of channels used to migrate data in
809 # parallel. This is the same number that the
810 # number of sockets used for migration.
811 # The default value is 2 (since 4.0)
812 #
813 # @xbzrle-cache-size: cache size to be used by XBZRLE migration. It
814 # needs to be a multiple of the target page size
815 # and a power of 2
816 # (Since 2.11)
817 #
818 # @max-postcopy-bandwidth: Background transfer bandwidth during postcopy.
819 # Defaults to 0 (unlimited). In bytes per second.
820 # (Since 3.0)
821 #
822 # @max-cpu-throttle: maximum cpu throttle percentage.
823 # Defaults to 99.
824 # (Since 3.1)
825 #
826 # Since: 2.4
827 ##
828 { 'struct': 'MigrationParameters',
829 'data': { '*announce-initial': 'size',
830 '*announce-max': 'size',
831 '*announce-rounds': 'size',
832 '*announce-step': 'size',
833 '*compress-level': 'uint8',
834 '*compress-threads': 'uint8',
835 '*compress-wait-thread': 'bool',
836 '*decompress-threads': 'uint8',
837 '*cpu-throttle-initial': 'uint8',
838 '*cpu-throttle-increment': 'uint8',
839 '*tls-creds': 'str',
840 '*tls-hostname': 'str',
841 '*tls-authz': 'str',
842 '*max-bandwidth': 'size',
843 '*downtime-limit': 'uint64',
844 '*x-checkpoint-delay': 'uint32',
845 '*block-incremental': 'bool' ,
846 '*multifd-channels': 'uint8',
847 '*xbzrle-cache-size': 'size',
848 '*max-postcopy-bandwidth': 'size',
849 '*max-cpu-throttle':'uint8'} }
851 ##
852 # @query-migrate-parameters:
853 #
854 # Returns information about the current migration parameters
855 #
856 # Returns: @MigrationParameters
857 #
858 # Since: 2.4
859 #
860 # Example:
861 #
862 # -> { "execute": "query-migrate-parameters" }
863 # <- { "return": {
864 # "decompress-threads": 2,
865 # "cpu-throttle-increment": 10,
866 # "compress-threads": 8,
867 # "compress-level": 1,
868 # "cpu-throttle-initial": 20,
869 # "max-bandwidth": 33554432,
870 # "downtime-limit": 300
871 # }
872 # }
873 #
874 ##
875 { 'command': 'query-migrate-parameters',
876 'returns': 'MigrationParameters' }
878 ##
879 # @client_migrate_info:
880 #
881 # Set migration information for remote display. This makes the server
882 # ask the client to automatically reconnect using the new parameters
883 # once migration finished successfully. Only implemented for SPICE.
884 #
885 # @protocol: must be "spice"
886 # @hostname: migration target hostname
887 # @port: spice tcp port for plaintext channels
888 # @tls-port: spice tcp port for tls-secured channels
889 # @cert-subject: server certificate subject
890 #
891 # Since: 0.14.0
892 #
893 # Example:
894 #
895 # -> { "execute": "client_migrate_info",
896 # "arguments": { "protocol": "spice",
897 # "hostname": "virt42.lab.kraxel.org",
898 # "port": 1234 } }
899 # <- { "return": {} }
900 #
901 ##
902 { 'command': 'client_migrate_info',
903 'data': { 'protocol': 'str', 'hostname': 'str', '*port': 'int',
904 '*tls-port': 'int', '*cert-subject': 'str' } }
906 ##
907 # @migrate-start-postcopy:
908 #
909 # Followup to a migration command to switch the migration to postcopy mode.
910 # The postcopy-ram capability must be set on both source and destination
911 # before the original migration command.
912 #
913 # Since: 2.5
914 #
915 # Example:
916 #
917 # -> { "execute": "migrate-start-postcopy" }
918 # <- { "return": {} }
919 #
920 ##
921 { 'command': 'migrate-start-postcopy' }
923 ##
924 # @MIGRATION:
925 #
926 # Emitted when a migration event happens
927 #
928 # @status: @MigrationStatus describing the current migration status.
929 #
930 # Since: 2.4
931 #
932 # Example:
933 #
934 # <- {"timestamp": {"seconds": 1432121972, "microseconds": 744001},
935 # "event": "MIGRATION",
936 # "data": {"status": "completed"} }
937 #
938 ##
939 { 'event': 'MIGRATION',
940 'data': {'status': 'MigrationStatus'}}
942 ##
943 # @MIGRATION_PASS:
944 #
945 # Emitted from the source side of a migration at the start of each pass
946 # (when it syncs the dirty bitmap)
947 #
948 # @pass: An incrementing count (starting at 1 on the first pass)
949 #
950 # Since: 2.6
951 #
952 # Example:
953 #
954 # { "timestamp": {"seconds": 1449669631, "microseconds": 239225},
955 # "event": "MIGRATION_PASS", "data": {"pass": 2} }
956 #
957 ##
958 { 'event': 'MIGRATION_PASS',
959 'data': { 'pass': 'int' } }
961 ##
962 # @COLOMessage:
963 #
964 # The message transmission between Primary side and Secondary side.
965 #
966 # @checkpoint-ready: Secondary VM (SVM) is ready for checkpointing
967 #
968 # @checkpoint-request: Primary VM (PVM) tells SVM to prepare for checkpointing
969 #
970 # @checkpoint-reply: SVM gets PVM's checkpoint request
971 #
972 # @vmstate-send: VM's state will be sent by PVM.
973 #
974 # @vmstate-size: The total size of VMstate.
975 #
976 # @vmstate-received: VM's state has been received by SVM.
977 #
978 # @vmstate-loaded: VM's state has been loaded by SVM.
979 #
980 # Since: 2.8
981 ##
982 { 'enum': 'COLOMessage',
983 'data': [ 'checkpoint-ready', 'checkpoint-request', 'checkpoint-reply',
984 'vmstate-send', 'vmstate-size', 'vmstate-received',
985 'vmstate-loaded' ] }
987 ##
988 # @COLOMode:
989 #
990 # The COLO current mode.
991 #
992 # @none: COLO is disabled.
993 #
994 # @primary: COLO node in primary side.
995 #
996 # @secondary: COLO node in slave side.
997 #
998 # Since: 2.8
999 ##
1000 { 'enum': 'COLOMode',
1001 'data': [ 'none', 'primary', 'secondary'] }
1003 ##
1004 # @FailoverStatus:
1005 #
1006 # An enumeration of COLO failover status
1007 #
1008 # @none: no failover has ever happened
1009 #
1010 # @require: got failover requirement but not handled
1011 #
1012 # @active: in the process of doing failover
1013 #
1014 # @completed: finish the process of failover
1015 #
1016 # @relaunch: restart the failover process, from 'none' -> 'completed' (Since 2.9)
1017 #
1018 # Since: 2.8
1019 ##
1020 { 'enum': 'FailoverStatus',
1021 'data': [ 'none', 'require', 'active', 'completed', 'relaunch' ] }
1023 ##
1024 # @COLO_EXIT:
1025 #
1026 # Emitted when VM finishes COLO mode due to some errors happening or
1027 # at the request of users.
1028 #
1029 # @mode: report COLO mode when COLO exited.
1030 #
1031 # @reason: describes the reason for the COLO exit.
1032 #
1033 # Since: 3.1
1034 #
1035 # Example:
1036 #
1037 # <- { "timestamp": {"seconds": 2032141960, "microseconds": 417172},
1038 # "event": "COLO_EXIT", "data": {"mode": "primary", "reason": "request" } }
1039 #
1040 ##
1041 { 'event': 'COLO_EXIT',
1042 'data': {'mode': 'COLOMode', 'reason': 'COLOExitReason' } }
1044 ##
1045 # @COLOExitReason:
1046 #
1047 # The reason for a COLO exit.
1048 #
1049 # @none: failover has never happened. This state does not occur
1050 # in the COLO_EXIT event, and is only visible in the result of
1051 # query-colo-status.
1052 #
1053 # @request: COLO exit is due to an external request.
1054 #
1055 # @error: COLO exit is due to an internal error.
1056 #
1057 # @processing: COLO is currently handling a failover (since 4.0).
1058 #
1059 # Since: 3.1
1060 ##
1061 { 'enum': 'COLOExitReason',
1062 'data': [ 'none', 'request', 'error' , 'processing' ] }
1064 ##
1065 # @x-colo-lost-heartbeat:
1066 #
1067 # Tell qemu that heartbeat is lost, request it to do takeover procedures.
1068 # If this command is sent to the PVM, the Primary side will exit COLO mode.
1069 # If sent to the Secondary, the Secondary side will run failover work,
1070 # then takes over server operation to become the service VM.
1071 #
1072 # Since: 2.8
1073 #
1074 # Example:
1075 #
1076 # -> { "execute": "x-colo-lost-heartbeat" }
1077 # <- { "return": {} }
1078 #
1079 ##
1080 { 'command': 'x-colo-lost-heartbeat' }
1082 ##
1083 # @migrate_cancel:
1084 #
1085 # Cancel the current executing migration process.
1086 #
1087 # Returns: nothing on success
1088 #
1089 # Notes: This command succeeds even if there is no migration process running.
1090 #
1091 # Since: 0.14.0
1092 #
1093 # Example:
1094 #
1095 # -> { "execute": "migrate_cancel" }
1096 # <- { "return": {} }
1097 #
1098 ##
1099 { 'command': 'migrate_cancel' }
1101 ##
1102 # @migrate-continue:
1103 #
1104 # Continue migration when it's in a paused state.
1105 #
1106 # @state: The state the migration is currently expected to be in
1107 #
1108 # Returns: nothing on success
1109 # Since: 2.11
1110 # Example:
1111 #
1112 # -> { "execute": "migrate-continue" , "arguments":
1113 # { "state": "pre-switchover" } }
1114 # <- { "return": {} }
1115 ##
1116 { 'command': 'migrate-continue', 'data': {'state': 'MigrationStatus'} }
1118 ##
1119 # @migrate_set_downtime:
1120 #
1121 # Set maximum tolerated downtime for migration.
1122 #
1123 # @value: maximum downtime in seconds
1124 #
1125 # Returns: nothing on success
1126 #
1127 # Notes: This command is deprecated in favor of 'migrate-set-parameters'
1128 #
1129 # Since: 0.14.0
1130 #
1131 # Example:
1132 #
1133 # -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
1134 # <- { "return": {} }
1135 #
1136 ##
1137 { 'command': 'migrate_set_downtime', 'data': {'value': 'number'} }
1139 ##
1140 # @migrate_set_speed:
1141 #
1142 # Set maximum speed for migration.
1143 #
1144 # @value: maximum speed in bytes per second.
1145 #
1146 # Returns: nothing on success
1147 #
1148 # Notes: This command is deprecated in favor of 'migrate-set-parameters'
1149 #
1150 # Since: 0.14.0
1151 #
1152 # Example:
1153 #
1154 # -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
1155 # <- { "return": {} }
1156 #
1157 ##
1158 { 'command': 'migrate_set_speed', 'data': {'value': 'int'} }
1160 ##
1161 # @migrate-set-cache-size:
1162 #
1163 # Set cache size to be used by XBZRLE migration
1164 #
1165 # @value: cache size in bytes
1166 #
1167 # The size will be rounded down to the nearest power of 2.
1168 # The cache size can be modified before and during ongoing migration
1169 #
1170 # Returns: nothing on success
1171 #
1172 # Notes: This command is deprecated in favor of 'migrate-set-parameters'
1173 #
1174 # Since: 1.2
1175 #
1176 # Example:
1177 #
1178 # -> { "execute": "migrate-set-cache-size",
1179 # "arguments": { "value": 536870912 } }
1180 # <- { "return": {} }
1181 #
1182 ##
1183 { 'command': 'migrate-set-cache-size', 'data': {'value': 'int'} }
1185 ##
1186 # @query-migrate-cache-size:
1187 #
1188 # Query migration XBZRLE cache size
1189 #
1190 # Returns: XBZRLE cache size in bytes
1191 #
1192 # Notes: This command is deprecated in favor of 'query-migrate-parameters'
1193 #
1194 # Since: 1.2
1195 #
1196 # Example:
1197 #
1198 # -> { "execute": "query-migrate-cache-size" }
1199 # <- { "return": 67108864 }
1200 #
1201 ##
1202 { 'command': 'query-migrate-cache-size', 'returns': 'int' }
1204 ##
1205 # @migrate:
1206 #
1207 # Migrates the current running guest to another Virtual Machine.
1208 #
1209 # @uri: the Uniform Resource Identifier of the destination VM
1210 #
1211 # @blk: do block migration (full disk copy)
1212 #
1213 # @inc: incremental disk copy migration
1214 #
1215 # @detach: this argument exists only for compatibility reasons and
1216 # is ignored by QEMU
1217 #
1218 # @resume: resume one paused migration, default "off". (since 3.0)
1219 #
1220 # Returns: nothing on success
1221 #
1222 # Since: 0.14.0
1223 #
1224 # Notes:
1225 #
1226 # 1. The 'query-migrate' command should be used to check migration's progress
1227 # and final result (this information is provided by the 'status' member)
1228 #
1229 # 2. All boolean arguments default to false
1230 #
1231 # 3. The user Monitor's "detach" argument is invalid in QMP and should not
1232 # be used
1233 #
1234 # Example:
1235 #
1236 # -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
1237 # <- { "return": {} }
1238 #
1239 ##
1240 { 'command': 'migrate',
1241 'data': {'uri': 'str', '*blk': 'bool', '*inc': 'bool',
1242 '*detach': 'bool', '*resume': 'bool' } }
1244 ##
1245 # @migrate-incoming:
1246 #
1247 # Start an incoming migration, the qemu must have been started
1248 # with -incoming defer
1249 #
1250 # @uri: The Uniform Resource Identifier identifying the source or
1251 # address to listen on
1252 #
1253 # Returns: nothing on success
1254 #
1255 # Since: 2.3
1256 #
1257 # Notes:
1258 #
1259 # 1. It's a bad idea to use a string for the uri, but it needs to stay
1260 # compatible with -incoming and the format of the uri is already exposed
1261 # above libvirt.
1262 #
1263 # 2. QEMU must be started with -incoming defer to allow migrate-incoming to
1264 # be used.
1265 #
1266 # 3. The uri format is the same as for -incoming
1267 #
1268 # Example:
1269 #
1270 # -> { "execute": "migrate-incoming",
1271 # "arguments": { "uri": "tcp::4446" } }
1272 # <- { "return": {} }
1273 #
1274 ##
1275 { 'command': 'migrate-incoming', 'data': {'uri': 'str' } }
1277 ##
1278 # @xen-save-devices-state:
1279 #
1280 # Save the state of all devices to file. The RAM and the block devices
1281 # of the VM are not saved by this command.
1282 #
1283 # @filename: the file to save the state of the devices to as binary
1284 # data. See xen-save-devices-state.txt for a description of the binary
1285 # format.
1286 #
1287 # @live: Optional argument to ask QEMU to treat this command as part of a live
1288 # migration. Default to true. (since 2.11)
1289 #
1290 # Returns: Nothing on success
1291 #
1292 # Since: 1.1
1293 #
1294 # Example:
1295 #
1296 # -> { "execute": "xen-save-devices-state",
1297 # "arguments": { "filename": "/tmp/save" } }
1298 # <- { "return": {} }
1299 #
1300 ##
1301 { 'command': 'xen-save-devices-state',
1302 'data': {'filename': 'str', '*live':'bool' } }
1304 ##
1305 # @xen-set-replication:
1306 #
1307 # Enable or disable replication.
1308 #
1309 # @enable: true to enable, false to disable.
1310 #
1311 # @primary: true for primary or false for secondary.
1312 #
1313 # @failover: true to do failover, false to stop. but cannot be
1314 # specified if 'enable' is true. default value is false.
1315 #
1316 # Returns: nothing.
1317 #
1318 # Example:
1319 #
1320 # -> { "execute": "xen-set-replication",
1321 # "arguments": {"enable": true, "primary": false} }
1322 # <- { "return": {} }
1323 #
1324 # Since: 2.9
1325 ##
1326 { 'command': 'xen-set-replication',
1327 'data': { 'enable': 'bool', 'primary': 'bool', '*failover' : 'bool' },
1328 'if': 'defined(CONFIG_REPLICATION)' }
1330 ##
1331 # @ReplicationStatus:
1332 #
1333 # The result format for 'query-xen-replication-status'.
1334 #
1335 # @error: true if an error happened, false if replication is normal.
1336 #
1337 # @desc: the human readable error description string, when
1338 # @error is 'true'.
1339 #
1340 # Since: 2.9
1341 ##
1342 { 'struct': 'ReplicationStatus',
1343 'data': { 'error': 'bool', '*desc': 'str' },
1344 'if': 'defined(CONFIG_REPLICATION)' }
1346 ##
1347 # @query-xen-replication-status:
1348 #
1349 # Query replication status while the vm is running.
1350 #
1351 # Returns: A @ReplicationResult object showing the status.
1352 #
1353 # Example:
1354 #
1355 # -> { "execute": "query-xen-replication-status" }
1356 # <- { "return": { "error": false } }
1357 #
1358 # Since: 2.9
1359 ##
1360 { 'command': 'query-xen-replication-status',
1361 'returns': 'ReplicationStatus',
1362 'if': 'defined(CONFIG_REPLICATION)' }
1364 ##
1365 # @xen-colo-do-checkpoint:
1366 #
1367 # Xen uses this command to notify replication to trigger a checkpoint.
1368 #
1369 # Returns: nothing.
1370 #
1371 # Example:
1372 #
1373 # -> { "execute": "xen-colo-do-checkpoint" }
1374 # <- { "return": {} }
1375 #
1376 # Since: 2.9
1377 ##
1378 { 'command': 'xen-colo-do-checkpoint',
1379 'if': 'defined(CONFIG_REPLICATION)' }
1381 ##
1382 # @COLOStatus:
1383 #
1384 # The result format for 'query-colo-status'.
1385 #
1386 # @mode: COLO running mode. If COLO is running, this field will return
1387 # 'primary' or 'secondary'.
1388 #
1389 # @last-mode: COLO last running mode. If COLO is running, this field
1390 # will return same like mode field, after failover we can
1391 # use this field to get last colo mode. (since 4.0)
1392 #
1393 # @reason: describes the reason for the COLO exit.
1394 #
1395 # Since: 3.1
1396 ##
1397 { 'struct': 'COLOStatus',
1398 'data': { 'mode': 'COLOMode', 'last-mode': 'COLOMode',
1399 'reason': 'COLOExitReason' } }
1401 ##
1402 # @query-colo-status:
1403 #
1404 # Query COLO status while the vm is running.
1405 #
1406 # Returns: A @COLOStatus object showing the status.
1407 #
1408 # Example:
1409 #
1410 # -> { "execute": "query-colo-status" }
1411 # <- { "return": { "mode": "primary", "reason": "request" } }
1412 #
1413 # Since: 3.1
1414 ##
1415 { 'command': 'query-colo-status',
1416 'returns': 'COLOStatus' }
1418 ##
1419 # @migrate-recover:
1420 #
1421 # Provide a recovery migration stream URI.
1422 #
1423 # @uri: the URI to be used for the recovery of migration stream.
1424 #
1425 # Returns: nothing.
1426 #
1427 # Example:
1428 #
1429 # -> { "execute": "migrate-recover",
1430 # "arguments": { "uri": "tcp:192.168.1.200:12345" } }
1431 # <- { "return": {} }
1432 #
1433 # Since: 3.0
1434 ##
1435 { 'command': 'migrate-recover',
1436 'data': { 'uri': 'str' },
1437 'allow-oob': true }
1439 ##
1440 # @migrate-pause:
1441 #
1442 # Pause a migration. Currently it only supports postcopy.
1443 #
1444 # Returns: nothing.
1445 #
1446 # Example:
1447 #
1448 # -> { "execute": "migrate-pause" }
1449 # <- { "return": {} }
1450 #
1451 # Since: 3.0
1452 ##
1453 { 'command': 'migrate-pause', 'allow-oob': true }
1455 ##
1456 # @UNPLUG_PRIMARY:
1457 #
1458 # Emitted from source side of a migration when migration state is
1459 # WAIT_UNPLUG. Device was unplugged by guest operating system.
1460 # Device resources in QEMU are kept on standby to be able to re-plug it in case
1461 # of migration failure.
1462 #
1463 # @device-id: QEMU device id of the unplugged device
1464 #
1465 # Since: 4.2
1466 #
1467 # Example:
1468 # {"event": "UNPLUG_PRIMARY", "data": {"device-id": "hostdev0"} }
1469 #
1470 ##
1471 { 'event': 'UNPLUG_PRIMARY',
1472 'data': { 'device-id': 'str' } }