8 { 'include': 'common.json' }
13 # Detailed migration status.
15 # @transferred: amount of bytes already transferred to the target VM
17 # @remaining: amount of bytes remaining to be transferred to the target VM
19 # @total: total amount of bytes involved in the migration process
21 # @duplicate: number of duplicate (zero) pages (since 1.2)
23 # @skipped: number of skipped zero pages (since 1.5)
25 # @normal: number of normal pages (since 1.2)
27 # @normal-bytes: number of normal bytes sent (since 1.2)
29 # @dirty-pages-rate: number of pages dirtied by second by the
32 # @mbps: throughput in megabits/sec. (since 1.6)
34 # @dirty-sync-count: number of times that dirty ram was synchronized (since 2.1)
36 # @postcopy-requests: The number of page requests received from the destination
39 # @page-size: The number of bytes per page for the various page-based
40 # statistics (since 2.10)
44 { 'struct': 'MigrationStats',
45 'data': {'transferred': 'int', 'remaining': 'int', 'total': 'int' ,
46 'duplicate': 'int', 'skipped': 'int', 'normal': 'int',
47 'normal-bytes': 'int', 'dirty-pages-rate' : 'int',
48 'mbps' : 'number', 'dirty-sync-count' : 'int',
49 'postcopy-requests' : 'int', 'page-size' : 'int' } }
54 # Detailed XBZRLE migration cache statistics
56 # @cache-size: XBZRLE cache size
58 # @bytes: amount of bytes already transferred to the target VM
60 # @pages: amount of pages transferred to the target VM
62 # @cache-miss: number of cache miss
64 # @cache-miss-rate: rate of cache miss (since 2.1)
66 # @overflow: number of overflows
70 { 'struct': 'XBZRLECacheStats',
71 'data': {'cache-size': 'int', 'bytes': 'int', 'pages': 'int',
72 'cache-miss': 'int', 'cache-miss-rate': 'number',
78 # An enumeration of migration status.
80 # @none: no migration has ever happened.
82 # @setup: migration process has been initiated.
84 # @cancelling: in the process of cancelling migration.
86 # @cancelled: cancelling migration is finished.
88 # @active: in the process of doing migration.
90 # @postcopy-active: like active, but now in postcopy mode. (since 2.5)
92 # @completed: migration is finished.
94 # @failed: some error occurred during migration process.
96 # @colo: VM is in the process of fault tolerance, VM can not get into this
97 # state unless colo capability is enabled for migration. (since 2.8)
102 { 'enum': 'MigrationStatus',
103 'data': [ 'none', 'setup', 'cancelling', 'cancelled',
104 'active', 'postcopy-active', 'completed', 'failed', 'colo' ] }
109 # Information about current migration process.
111 # @status: @MigrationStatus describing the current migration status.
112 # If this field is not returned, no migration process
115 # @ram: @MigrationStats containing detailed migration
116 # status, only returned if status is 'active' or
117 # 'completed'(since 1.2)
119 # @disk: @MigrationStats containing detailed disk migration
120 # status, only returned if status is 'active' and it is a block
123 # @xbzrle-cache: @XBZRLECacheStats containing detailed XBZRLE
124 # migration statistics, only returned if XBZRLE feature is on and
125 # status is 'active' or 'completed' (since 1.2)
127 # @total-time: total amount of milliseconds since migration started.
128 # If migration has ended, it returns the total migration
131 # @downtime: only present when migration finishes correctly
132 # total downtime in milliseconds for the guest.
135 # @expected-downtime: only present while migration is active
136 # expected downtime in milliseconds for the guest in last walk
137 # of the dirty bitmap. (since 1.3)
139 # @setup-time: amount of setup time in milliseconds _before_ the
140 # iterations begin but _after_ the QMP command is issued. This is designed
141 # to provide an accounting of any activities (such as RDMA pinning) which
142 # may be expensive, but do not actually occur during the iterative
143 # migration rounds themselves. (since 1.6)
145 # @cpu-throttle-percentage: percentage of time guest cpus are being
146 # throttled during auto-converge. This is only present when auto-converge
147 # has started throttling guest cpus. (Since 2.7)
149 # @error-desc: the human readable error description string, when
150 # @status is 'failed'. Clients should not attempt to parse the
151 # error strings. (Since 2.7)
155 { 'struct': 'MigrationInfo',
156 'data': {'*status': 'MigrationStatus', '*ram': 'MigrationStats',
157 '*disk': 'MigrationStats',
158 '*xbzrle-cache': 'XBZRLECacheStats',
159 '*total-time': 'int',
160 '*expected-downtime': 'int',
162 '*setup-time': 'int',
163 '*cpu-throttle-percentage': 'int',
164 '*error-desc': 'str'} }
169 # Returns information about current migration process. If migration
170 # is active there will be another json-object with RAM migration
171 # status and if block migration is active another one with block
174 # Returns: @MigrationInfo
180 # 1. Before the first migration
182 # -> { "execute": "query-migrate" }
183 # <- { "return": {} }
185 # 2. Migration is done and has succeeded
187 # -> { "execute": "query-migrate" }
189 # "status": "completed",
194 # "total-time":12345,
195 # "setup-time":12345,
199 # "normal-bytes":123456,
200 # "dirty-sync-count":15
205 # 3. Migration is done and has failed
207 # -> { "execute": "query-migrate" }
208 # <- { "return": { "status": "failed" } }
210 # 4. Migration is being performed and is not a block migration:
212 # -> { "execute": "query-migrate" }
220 # "total-time":12345,
221 # "setup-time":12345,
222 # "expected-downtime":12345,
225 # "normal-bytes":123456,
226 # "dirty-sync-count":15
231 # 5. Migration is being performed and is a block migration:
233 # -> { "execute": "query-migrate" }
239 # "remaining":1053304,
240 # "transferred":3720,
241 # "total-time":12345,
242 # "setup-time":12345,
243 # "expected-downtime":12345,
246 # "normal-bytes":123456,
247 # "dirty-sync-count":15
251 # "remaining":20880384,
252 # "transferred":91136
257 # 6. Migration is being performed and XBZRLE is active:
259 # -> { "execute": "query-migrate" }
263 # "capabilities" : [ { "capability": "xbzrle", "state" : true } ],
266 # "remaining":1053304,
267 # "transferred":3720,
268 # "total-time":12345,
269 # "setup-time":12345,
270 # "expected-downtime":12345,
273 # "normal-bytes":3412992,
274 # "dirty-sync-count":15
277 # "cache-size":67108864,
281 # "cache-miss-rate":0.123,
288 { 'command': 'query-migrate', 'returns': 'MigrationInfo' }
291 # @MigrationCapability:
293 # Migration capabilities enumeration
295 # @xbzrle: Migration supports xbzrle (Xor Based Zero Run Length Encoding).
296 # This feature allows us to minimize migration traffic for certain work
297 # loads, by sending compressed difference of the pages
299 # @rdma-pin-all: Controls whether or not the entire VM memory footprint is
300 # mlock()'d on demand or all at once. Refer to docs/rdma.txt for usage.
301 # Disabled by default. (since 2.0)
303 # @zero-blocks: During storage migration encode blocks of zeroes efficiently. This
304 # essentially saves 1MB of zeroes per block on the wire. Enabling requires
305 # source and target VM to support this feature. To enable it is sufficient
306 # to enable the capability on the source VM. The feature is disabled by
307 # default. (since 1.6)
309 # @compress: Use multiple compression threads to accelerate live migration.
310 # This feature can help to reduce the migration traffic, by sending
311 # compressed pages. Please note that if compress and xbzrle are both
312 # on, compress only takes effect in the ram bulk stage, after that,
313 # it will be disabled and only xbzrle takes effect, this can help to
314 # minimize migration traffic. The feature is disabled by default.
317 # @events: generate events for each migration state change
320 # @auto-converge: If enabled, QEMU will automatically throttle down the guest
321 # to speed up convergence of RAM migration. (since 1.6)
323 # @postcopy-ram: Start executing on the migration target before all of RAM has
324 # been migrated, pulling the remaining pages along as needed. NOTE: If
325 # the migration fails during postcopy the VM will fail. (since 2.6)
327 # @x-colo: If enabled, migration will never end, and the state of the VM on the
328 # primary side will be migrated continuously to the VM on secondary
329 # side, this process is called COarse-Grain LOck Stepping (COLO) for
330 # Non-stop Service. (since 2.8)
332 # @release-ram: if enabled, qemu will free the migrated ram pages on the source
333 # during postcopy-ram migration. (since 2.9)
335 # @block: If enabled, QEMU will also migrate the contents of all block
336 # devices. Default is disabled. A possible alternative uses
337 # mirror jobs to a builtin NBD server on the destination, which
338 # offers more flexibility.
341 # @return-path: If enabled, migration will use the return path even
342 # for precopy. (since 2.10)
344 # @x-multifd: Use more than one fd for migration (since 2.11)
348 { 'enum': 'MigrationCapability',
349 'data': ['xbzrle', 'rdma-pin-all', 'auto-converge', 'zero-blocks',
350 'compress', 'events', 'postcopy-ram', 'x-colo', 'release-ram',
351 'block', 'return-path', 'x-multifd' ] }
354 # @MigrationCapabilityStatus:
356 # Migration capability information
358 # @capability: capability enum
360 # @state: capability state bool
364 { 'struct': 'MigrationCapabilityStatus',
365 'data': { 'capability' : 'MigrationCapability', 'state' : 'bool' } }
368 # @migrate-set-capabilities:
370 # Enable/Disable the following migration capabilities (like xbzrle)
372 # @capabilities: json array of capability modifications to make
378 # -> { "execute": "migrate-set-capabilities" , "arguments":
379 # { "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
382 { 'command': 'migrate-set-capabilities',
383 'data': { 'capabilities': ['MigrationCapabilityStatus'] } }
386 # @query-migrate-capabilities:
388 # Returns information about the current migration capabilities status
390 # Returns: @MigrationCapabilitiesStatus
396 # -> { "execute": "query-migrate-capabilities" }
398 # {"state": false, "capability": "xbzrle"},
399 # {"state": false, "capability": "rdma-pin-all"},
400 # {"state": false, "capability": "auto-converge"},
401 # {"state": false, "capability": "zero-blocks"},
402 # {"state": false, "capability": "compress"},
403 # {"state": true, "capability": "events"},
404 # {"state": false, "capability": "postcopy-ram"},
405 # {"state": false, "capability": "x-colo"}
409 { 'command': 'query-migrate-capabilities', 'returns': ['MigrationCapabilityStatus']}
412 # @MigrationParameter:
414 # Migration parameters enumeration
416 # @compress-level: Set the compression level to be used in live migration,
417 # the compression level is an integer between 0 and 9, where 0 means
418 # no compression, 1 means the best compression speed, and 9 means best
419 # compression ratio which will consume more CPU.
421 # @compress-threads: Set compression thread count to be used in live migration,
422 # the compression thread count is an integer between 1 and 255.
424 # @decompress-threads: Set decompression thread count to be used in live
425 # migration, the decompression thread count is an integer between 1
426 # and 255. Usually, decompression is at least 4 times as fast as
427 # compression, so set the decompress-threads to the number about 1/4
428 # of compress-threads is adequate.
430 # @cpu-throttle-initial: Initial percentage of time guest cpus are throttled
431 # when migration auto-converge is activated. The
432 # default value is 20. (Since 2.7)
434 # @cpu-throttle-increment: throttle percentage increase each time
435 # auto-converge detects that migration is not making
436 # progress. The default value is 10. (Since 2.7)
438 # @tls-creds: ID of the 'tls-creds' object that provides credentials for
439 # establishing a TLS connection over the migration data channel.
440 # On the outgoing side of the migration, the credentials must
441 # be for a 'client' endpoint, while for the incoming side the
442 # credentials must be for a 'server' endpoint. Setting this
443 # will enable TLS for all migrations. The default is unset,
444 # resulting in unsecured migration at the QEMU level. (Since 2.7)
446 # @tls-hostname: hostname of the target host for the migration. This is
447 # required when using x509 based TLS credentials and the
448 # migration URI does not already include a hostname. For
449 # example if using fd: or exec: based migration, the
450 # hostname must be provided so that the server's x509
451 # certificate identity can be validated. (Since 2.7)
453 # @max-bandwidth: to set maximum speed for migration. maximum speed in
454 # bytes per second. (Since 2.8)
456 # @downtime-limit: set maximum tolerated downtime for migration. maximum
457 # downtime in milliseconds (Since 2.8)
459 # @x-checkpoint-delay: The delay time (in ms) between two COLO checkpoints in
460 # periodic mode. (Since 2.8)
462 # @block-incremental: Affects how much storage is migrated when the
463 # block migration capability is enabled. When false, the entire
464 # storage backing chain is migrated into a flattened image at
465 # the destination; when true, only the active qcow2 layer is
466 # migrated and the destination must already have access to the
467 # same backing chain as was used on the source. (since 2.10)
469 # @x-multifd-channels: Number of channels used to migrate data in
470 # parallel. This is the same number that the
471 # number of sockets used for migration. The
472 # default value is 2 (since 2.11)
476 { 'enum': 'MigrationParameter',
477 'data': ['compress-level', 'compress-threads', 'decompress-threads',
478 'cpu-throttle-initial', 'cpu-throttle-increment',
479 'tls-creds', 'tls-hostname', 'max-bandwidth',
480 'downtime-limit', 'x-checkpoint-delay', 'block-incremental',
481 'x-multifd-channels'] }
484 # @MigrateSetParameters:
486 # @compress-level: compression level
488 # @compress-threads: compression thread count
490 # @decompress-threads: decompression thread count
492 # @cpu-throttle-initial: Initial percentage of time guest cpus are
493 # throttled when migration auto-converge is activated.
494 # The default value is 20. (Since 2.7)
496 # @cpu-throttle-increment: throttle percentage increase each time
497 # auto-converge detects that migration is not making
498 # progress. The default value is 10. (Since 2.7)
500 # @tls-creds: ID of the 'tls-creds' object that provides credentials
501 # for establishing a TLS connection over the migration data
502 # channel. On the outgoing side of the migration, the credentials
503 # must be for a 'client' endpoint, while for the incoming side the
504 # credentials must be for a 'server' endpoint. Setting this
505 # to a non-empty string enables TLS for all migrations.
506 # An empty string means that QEMU will use plain text mode for
507 # migration, rather than TLS (Since 2.9)
508 # Previously (since 2.7), this was reported by omitting
511 # @tls-hostname: hostname of the target host for the migration. This
512 # is required when using x509 based TLS credentials and the
513 # migration URI does not already include a hostname. For
514 # example if using fd: or exec: based migration, the
515 # hostname must be provided so that the server's x509
516 # certificate identity can be validated. (Since 2.7)
517 # An empty string means that QEMU will use the hostname
518 # associated with the migration URI, if any. (Since 2.9)
519 # Previously (since 2.7), this was reported by omitting
520 # tls-hostname instead.
522 # @max-bandwidth: to set maximum speed for migration. maximum speed in
523 # bytes per second. (Since 2.8)
525 # @downtime-limit: set maximum tolerated downtime for migration. maximum
526 # downtime in milliseconds (Since 2.8)
528 # @x-checkpoint-delay: the delay time between two COLO checkpoints. (Since 2.8)
530 # @block-incremental: Affects how much storage is migrated when the
531 # block migration capability is enabled. When false, the entire
532 # storage backing chain is migrated into a flattened image at
533 # the destination; when true, only the active qcow2 layer is
534 # migrated and the destination must already have access to the
535 # same backing chain as was used on the source. (since 2.10)
537 # @x-multifd-channels: Number of channels used to migrate data in
538 # parallel. This is the same number that the
539 # number of sockets used for migration. The
540 # default value is 2 (since 2.11)
544 # TODO either fuse back into MigrationParameters, or make
545 # MigrationParameters members mandatory
546 { 'struct': 'MigrateSetParameters',
547 'data': { '*compress-level': 'int',
548 '*compress-threads': 'int',
549 '*decompress-threads': 'int',
550 '*cpu-throttle-initial': 'int',
551 '*cpu-throttle-increment': 'int',
552 '*tls-creds': 'StrOrNull',
553 '*tls-hostname': 'StrOrNull',
554 '*max-bandwidth': 'int',
555 '*downtime-limit': 'int',
556 '*x-checkpoint-delay': 'int',
557 '*block-incremental': 'bool',
558 '*x-multifd-channels': 'int' } }
561 # @migrate-set-parameters:
563 # Set various migration parameters.
569 # -> { "execute": "migrate-set-parameters" ,
570 # "arguments": { "compress-level": 1 } }
573 { 'command': 'migrate-set-parameters', 'boxed': true,
574 'data': 'MigrateSetParameters' }
577 # @MigrationParameters:
579 # The optional members aren't actually optional.
581 # @compress-level: compression level
583 # @compress-threads: compression thread count
585 # @decompress-threads: decompression thread count
587 # @cpu-throttle-initial: Initial percentage of time guest cpus are
588 # throttled when migration auto-converge is activated.
591 # @cpu-throttle-increment: throttle percentage increase each time
592 # auto-converge detects that migration is not making
593 # progress. (Since 2.7)
595 # @tls-creds: ID of the 'tls-creds' object that provides credentials
596 # for establishing a TLS connection over the migration data
597 # channel. On the outgoing side of the migration, the credentials
598 # must be for a 'client' endpoint, while for the incoming side the
599 # credentials must be for a 'server' endpoint.
600 # An empty string means that QEMU will use plain text mode for
601 # migration, rather than TLS (Since 2.7)
602 # Note: 2.8 reports this by omitting tls-creds instead.
604 # @tls-hostname: hostname of the target host for the migration. This
605 # is required when using x509 based TLS credentials and the
606 # migration URI does not already include a hostname. For
607 # example if using fd: or exec: based migration, the
608 # hostname must be provided so that the server's x509
609 # certificate identity can be validated. (Since 2.7)
610 # An empty string means that QEMU will use the hostname
611 # associated with the migration URI, if any. (Since 2.9)
612 # Note: 2.8 reports this by omitting tls-hostname instead.
614 # @max-bandwidth: to set maximum speed for migration. maximum speed in
615 # bytes per second. (Since 2.8)
617 # @downtime-limit: set maximum tolerated downtime for migration. maximum
618 # downtime in milliseconds (Since 2.8)
620 # @x-checkpoint-delay: the delay time between two COLO checkpoints. (Since 2.8)
622 # @block-incremental: Affects how much storage is migrated when the
623 # block migration capability is enabled. When false, the entire
624 # storage backing chain is migrated into a flattened image at
625 # the destination; when true, only the active qcow2 layer is
626 # migrated and the destination must already have access to the
627 # same backing chain as was used on the source. (since 2.10)
629 # @x-multifd-channels: Number of channels used to migrate data in
630 # parallel. This is the same number that the
631 # number of sockets used for migration.
632 # The default value is 2 (since 2.11)
636 { 'struct': 'MigrationParameters',
637 'data': { '*compress-level': 'int',
638 '*compress-threads': 'int',
639 '*decompress-threads': 'int',
640 '*cpu-throttle-initial': 'int',
641 '*cpu-throttle-increment': 'int',
643 '*tls-hostname': 'str',
644 '*max-bandwidth': 'int',
645 '*downtime-limit': 'int',
646 '*x-checkpoint-delay': 'int',
647 '*block-incremental': 'bool' ,
648 '*x-multifd-channels': 'int' } }
651 # @query-migrate-parameters:
653 # Returns information about the current migration parameters
655 # Returns: @MigrationParameters
661 # -> { "execute": "query-migrate-parameters" }
663 # "decompress-threads": 2,
664 # "cpu-throttle-increment": 10,
665 # "compress-threads": 8,
666 # "compress-level": 1,
667 # "cpu-throttle-initial": 20,
668 # "max-bandwidth": 33554432,
669 # "downtime-limit": 300
674 { 'command': 'query-migrate-parameters',
675 'returns': 'MigrationParameters' }
678 # @client_migrate_info:
680 # Set migration information for remote display. This makes the server
681 # ask the client to automatically reconnect using the new parameters
682 # once migration finished successfully. Only implemented for SPICE.
684 # @protocol: must be "spice"
685 # @hostname: migration target hostname
686 # @port: spice tcp port for plaintext channels
687 # @tls-port: spice tcp port for tls-secured channels
688 # @cert-subject: server certificate subject
694 # -> { "execute": "client_migrate_info",
695 # "arguments": { "protocol": "spice",
696 # "hostname": "virt42.lab.kraxel.org",
698 # <- { "return": {} }
701 { 'command': 'client_migrate_info',
702 'data': { 'protocol': 'str', 'hostname': 'str', '*port': 'int',
703 '*tls-port': 'int', '*cert-subject': 'str' } }
706 # @migrate-start-postcopy:
708 # Followup to a migration command to switch the migration to postcopy mode.
709 # The postcopy-ram capability must be set before the original migration
716 # -> { "execute": "migrate-start-postcopy" }
717 # <- { "return": {} }
720 { 'command': 'migrate-start-postcopy' }
725 # Emitted when a migration event happens
727 # @status: @MigrationStatus describing the current migration status.
733 # <- {"timestamp": {"seconds": 1432121972, "microseconds": 744001},
734 # "event": "MIGRATION",
735 # "data": {"status": "completed"} }
738 { 'event': 'MIGRATION',
739 'data': {'status': 'MigrationStatus'}}
744 # Emitted from the source side of a migration at the start of each pass
745 # (when it syncs the dirty bitmap)
747 # @pass: An incrementing count (starting at 1 on the first pass)
753 # { "timestamp": {"seconds": 1449669631, "microseconds": 239225},
754 # "event": "MIGRATION_PASS", "data": {"pass": 2} }
757 { 'event': 'MIGRATION_PASS',
758 'data': { 'pass': 'int' } }
763 # The message transmission between Primary side and Secondary side.
765 # @checkpoint-ready: Secondary VM (SVM) is ready for checkpointing
767 # @checkpoint-request: Primary VM (PVM) tells SVM to prepare for checkpointing
769 # @checkpoint-reply: SVM gets PVM's checkpoint request
771 # @vmstate-send: VM's state will be sent by PVM.
773 # @vmstate-size: The total size of VMstate.
775 # @vmstate-received: VM's state has been received by SVM.
777 # @vmstate-loaded: VM's state has been loaded by SVM.
781 { 'enum': 'COLOMessage',
782 'data': [ 'checkpoint-ready', 'checkpoint-request', 'checkpoint-reply',
783 'vmstate-send', 'vmstate-size', 'vmstate-received',
791 # @unknown: unknown mode
793 # @primary: master side
795 # @secondary: slave side
799 { 'enum': 'COLOMode',
800 'data': [ 'unknown', 'primary', 'secondary'] }
805 # An enumeration of COLO failover status
807 # @none: no failover has ever happened
809 # @require: got failover requirement but not handled
811 # @active: in the process of doing failover
813 # @completed: finish the process of failover
815 # @relaunch: restart the failover process, from 'none' -> 'completed' (Since 2.9)
819 { 'enum': 'FailoverStatus',
820 'data': [ 'none', 'require', 'active', 'completed', 'relaunch' ] }
823 # @x-colo-lost-heartbeat:
825 # Tell qemu that heartbeat is lost, request it to do takeover procedures.
826 # If this command is sent to the PVM, the Primary side will exit COLO mode.
827 # If sent to the Secondary, the Secondary side will run failover work,
828 # then takes over server operation to become the service VM.
834 # -> { "execute": "x-colo-lost-heartbeat" }
835 # <- { "return": {} }
838 { 'command': 'x-colo-lost-heartbeat' }
843 # Cancel the current executing migration process.
845 # Returns: nothing on success
847 # Notes: This command succeeds even if there is no migration process running.
853 # -> { "execute": "migrate_cancel" }
854 # <- { "return": {} }
857 { 'command': 'migrate_cancel' }
860 # @migrate_set_downtime:
862 # Set maximum tolerated downtime for migration.
864 # @value: maximum downtime in seconds
866 # Returns: nothing on success
868 # Notes: This command is deprecated in favor of 'migrate-set-parameters'
874 # -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
875 # <- { "return": {} }
878 { 'command': 'migrate_set_downtime', 'data': {'value': 'number'} }
881 # @migrate_set_speed:
883 # Set maximum speed for migration.
885 # @value: maximum speed in bytes per second.
887 # Returns: nothing on success
889 # Notes: This command is deprecated in favor of 'migrate-set-parameters'
895 # -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
896 # <- { "return": {} }
899 { 'command': 'migrate_set_speed', 'data': {'value': 'int'} }
902 # @migrate-set-cache-size:
904 # Set cache size to be used by XBZRLE migration
906 # @value: cache size in bytes
908 # The size will be rounded down to the nearest power of 2.
909 # The cache size can be modified before and during ongoing migration
911 # Returns: nothing on success
917 # -> { "execute": "migrate-set-cache-size",
918 # "arguments": { "value": 536870912 } }
919 # <- { "return": {} }
922 { 'command': 'migrate-set-cache-size', 'data': {'value': 'int'} }
925 # @query-migrate-cache-size:
927 # Query migration XBZRLE cache size
929 # Returns: XBZRLE cache size in bytes
935 # -> { "execute": "query-migrate-cache-size" }
936 # <- { "return": 67108864 }
939 { 'command': 'query-migrate-cache-size', 'returns': 'int' }
944 # Migrates the current running guest to another Virtual Machine.
946 # @uri: the Uniform Resource Identifier of the destination VM
948 # @blk: do block migration (full disk copy)
950 # @inc: incremental disk copy migration
952 # @detach: this argument exists only for compatibility reasons and
955 # Returns: nothing on success
961 # 1. The 'query-migrate' command should be used to check migration's progress
962 # and final result (this information is provided by the 'status' member)
964 # 2. All boolean arguments default to false
966 # 3. The user Monitor's "detach" argument is invalid in QMP and should not
971 # -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
972 # <- { "return": {} }
975 { 'command': 'migrate',
976 'data': {'uri': 'str', '*blk': 'bool', '*inc': 'bool', '*detach': 'bool' } }
981 # Start an incoming migration, the qemu must have been started
982 # with -incoming defer
984 # @uri: The Uniform Resource Identifier identifying the source or
985 # address to listen on
987 # Returns: nothing on success
993 # 1. It's a bad idea to use a string for the uri, but it needs to stay
994 # compatible with -incoming and the format of the uri is already exposed
997 # 2. QEMU must be started with -incoming defer to allow migrate-incoming to
1000 # 3. The uri format is the same as for -incoming
1004 # -> { "execute": "migrate-incoming",
1005 # "arguments": { "uri": "tcp::4446" } }
1006 # <- { "return": {} }
1009 { 'command': 'migrate-incoming', 'data': {'uri': 'str' } }
1012 # @xen-save-devices-state:
1014 # Save the state of all devices to file. The RAM and the block devices
1015 # of the VM are not saved by this command.
1017 # @filename: the file to save the state of the devices to as binary
1018 # data. See xen-save-devices-state.txt for a description of the binary
1021 # Returns: Nothing on success
1027 # -> { "execute": "xen-save-devices-state",
1028 # "arguments": { "filename": "/tmp/save" } }
1029 # <- { "return": {} }
1032 { 'command': 'xen-save-devices-state', 'data': {'filename': 'str'} }
1035 # @xen-set-replication:
1037 # Enable or disable replication.
1039 # @enable: true to enable, false to disable.
1041 # @primary: true for primary or false for secondary.
1043 # @failover: true to do failover, false to stop. but cannot be
1044 # specified if 'enable' is true. default value is false.
1050 # -> { "execute": "xen-set-replication",
1051 # "arguments": {"enable": true, "primary": false} }
1052 # <- { "return": {} }
1056 { 'command': 'xen-set-replication',
1057 'data': { 'enable': 'bool', 'primary': 'bool', '*failover' : 'bool' } }
1060 # @ReplicationStatus:
1062 # The result format for 'query-xen-replication-status'.
1064 # @error: true if an error happened, false if replication is normal.
1066 # @desc: the human readable error description string, when
1071 { 'struct': 'ReplicationStatus',
1072 'data': { 'error': 'bool', '*desc': 'str' } }
1075 # @query-xen-replication-status:
1077 # Query replication status while the vm is running.
1079 # Returns: A @ReplicationResult object showing the status.
1083 # -> { "execute": "query-xen-replication-status" }
1084 # <- { "return": { "error": false } }
1088 { 'command': 'query-xen-replication-status',
1089 'returns': 'ReplicationStatus' }
1092 # @xen-colo-do-checkpoint:
1094 # Xen uses this command to notify replication to trigger a checkpoint.
1100 # -> { "execute": "xen-colo-do-checkpoint" }
1101 # <- { "return": {} }
1105 { 'command': 'xen-colo-do-checkpoint' }