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)
99 # @pre-switchover: Paused before device serialisation. (since 2.11)
101 # @device: During device serialisation when pause-before-switchover is enabled
107 { 'enum': 'MigrationStatus',
108 'data': [ 'none', 'setup', 'cancelling', 'cancelled',
109 'active', 'postcopy-active', 'completed', 'failed', 'colo',
110 'pre-switchover', 'device' ] }
115 # Information about current migration process.
117 # @status: @MigrationStatus describing the current migration status.
118 # If this field is not returned, no migration process
121 # @ram: @MigrationStats containing detailed migration
122 # status, only returned if status is 'active' or
123 # 'completed'(since 1.2)
125 # @disk: @MigrationStats containing detailed disk migration
126 # status, only returned if status is 'active' and it is a block
129 # @xbzrle-cache: @XBZRLECacheStats containing detailed XBZRLE
130 # migration statistics, only returned if XBZRLE feature is on and
131 # status is 'active' or 'completed' (since 1.2)
133 # @total-time: total amount of milliseconds since migration started.
134 # If migration has ended, it returns the total migration
137 # @downtime: only present when migration finishes correctly
138 # total downtime in milliseconds for the guest.
141 # @expected-downtime: only present while migration is active
142 # expected downtime in milliseconds for the guest in last walk
143 # of the dirty bitmap. (since 1.3)
145 # @setup-time: amount of setup time in milliseconds _before_ the
146 # iterations begin but _after_ the QMP command is issued. This is designed
147 # to provide an accounting of any activities (such as RDMA pinning) which
148 # may be expensive, but do not actually occur during the iterative
149 # migration rounds themselves. (since 1.6)
151 # @cpu-throttle-percentage: percentage of time guest cpus are being
152 # throttled during auto-converge. This is only present when auto-converge
153 # has started throttling guest cpus. (Since 2.7)
155 # @error-desc: the human readable error description string, when
156 # @status is 'failed'. Clients should not attempt to parse the
157 # error strings. (Since 2.7)
159 # @postcopy-blocktime: total time when all vCPU were blocked during postcopy
160 # live migration (Since 2.12)
162 # @postcopy-vcpu-blocktime: list of the postcopy blocktime per vCPU (Since 2.12)
168 { 'struct': 'MigrationInfo',
169 'data': {'*status': 'MigrationStatus', '*ram': 'MigrationStats',
170 '*disk': 'MigrationStats',
171 '*xbzrle-cache': 'XBZRLECacheStats',
172 '*total-time': 'int',
173 '*expected-downtime': 'int',
175 '*setup-time': 'int',
176 '*cpu-throttle-percentage': 'int',
177 '*error-desc': 'str',
178 '*postcopy-blocktime' : 'int64',
179 '*postcopy-vcpu-blocktime': ['int64']} }
184 # Returns information about current migration process. If migration
185 # is active there will be another json-object with RAM migration
186 # status and if block migration is active another one with block
189 # Returns: @MigrationInfo
195 # 1. Before the first migration
197 # -> { "execute": "query-migrate" }
198 # <- { "return": {} }
200 # 2. Migration is done and has succeeded
202 # -> { "execute": "query-migrate" }
204 # "status": "completed",
209 # "total-time":12345,
210 # "setup-time":12345,
214 # "normal-bytes":123456,
215 # "dirty-sync-count":15
220 # 3. Migration is done and has failed
222 # -> { "execute": "query-migrate" }
223 # <- { "return": { "status": "failed" } }
225 # 4. Migration is being performed and is not a block migration:
227 # -> { "execute": "query-migrate" }
235 # "total-time":12345,
236 # "setup-time":12345,
237 # "expected-downtime":12345,
240 # "normal-bytes":123456,
241 # "dirty-sync-count":15
246 # 5. Migration is being performed and is a block migration:
248 # -> { "execute": "query-migrate" }
254 # "remaining":1053304,
255 # "transferred":3720,
256 # "total-time":12345,
257 # "setup-time":12345,
258 # "expected-downtime":12345,
261 # "normal-bytes":123456,
262 # "dirty-sync-count":15
266 # "remaining":20880384,
267 # "transferred":91136
272 # 6. Migration is being performed and XBZRLE is active:
274 # -> { "execute": "query-migrate" }
278 # "capabilities" : [ { "capability": "xbzrle", "state" : true } ],
281 # "remaining":1053304,
282 # "transferred":3720,
283 # "total-time":12345,
284 # "setup-time":12345,
285 # "expected-downtime":12345,
288 # "normal-bytes":3412992,
289 # "dirty-sync-count":15
292 # "cache-size":67108864,
296 # "cache-miss-rate":0.123,
303 { 'command': 'query-migrate', 'returns': 'MigrationInfo' }
306 # @MigrationCapability:
308 # Migration capabilities enumeration
310 # @xbzrle: Migration supports xbzrle (Xor Based Zero Run Length Encoding).
311 # This feature allows us to minimize migration traffic for certain work
312 # loads, by sending compressed difference of the pages
314 # @rdma-pin-all: Controls whether or not the entire VM memory footprint is
315 # mlock()'d on demand or all at once. Refer to docs/rdma.txt for usage.
316 # Disabled by default. (since 2.0)
318 # @zero-blocks: During storage migration encode blocks of zeroes efficiently. This
319 # essentially saves 1MB of zeroes per block on the wire. Enabling requires
320 # source and target VM to support this feature. To enable it is sufficient
321 # to enable the capability on the source VM. The feature is disabled by
322 # default. (since 1.6)
324 # @compress: Use multiple compression threads to accelerate live migration.
325 # This feature can help to reduce the migration traffic, by sending
326 # compressed pages. Please note that if compress and xbzrle are both
327 # on, compress only takes effect in the ram bulk stage, after that,
328 # it will be disabled and only xbzrle takes effect, this can help to
329 # minimize migration traffic. The feature is disabled by default.
332 # @events: generate events for each migration state change
335 # @auto-converge: If enabled, QEMU will automatically throttle down the guest
336 # to speed up convergence of RAM migration. (since 1.6)
338 # @postcopy-ram: Start executing on the migration target before all of RAM has
339 # been migrated, pulling the remaining pages along as needed. NOTE: If
340 # the migration fails during postcopy the VM will fail. (since 2.6)
342 # @x-colo: If enabled, migration will never end, and the state of the VM on the
343 # primary side will be migrated continuously to the VM on secondary
344 # side, this process is called COarse-Grain LOck Stepping (COLO) for
345 # Non-stop Service. (since 2.8)
347 # @release-ram: if enabled, qemu will free the migrated ram pages on the source
348 # during postcopy-ram migration. (since 2.9)
350 # @block: If enabled, QEMU will also migrate the contents of all block
351 # devices. Default is disabled. A possible alternative uses
352 # mirror jobs to a builtin NBD server on the destination, which
353 # offers more flexibility.
356 # @return-path: If enabled, migration will use the return path even
357 # for precopy. (since 2.10)
359 # @pause-before-switchover: Pause outgoing migration before serialising device
360 # state and before disabling block IO (since 2.11)
362 # @x-multifd: Use more than one fd for migration (since 2.11)
364 # @postcopy-blocktime: Calculate downtime for postcopy live migration
369 { 'enum': 'MigrationCapability',
370 'data': ['xbzrle', 'rdma-pin-all', 'auto-converge', 'zero-blocks',
371 'compress', 'events', 'postcopy-ram', 'x-colo', 'release-ram',
372 'block', 'return-path', 'pause-before-switchover', 'x-multifd',
373 'postcopy-blocktime' ] }
376 # @MigrationCapabilityStatus:
378 # Migration capability information
380 # @capability: capability enum
382 # @state: capability state bool
386 { 'struct': 'MigrationCapabilityStatus',
387 'data': { 'capability' : 'MigrationCapability', 'state' : 'bool' } }
390 # @migrate-set-capabilities:
392 # Enable/Disable the following migration capabilities (like xbzrle)
394 # @capabilities: json array of capability modifications to make
400 # -> { "execute": "migrate-set-capabilities" , "arguments":
401 # { "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
404 { 'command': 'migrate-set-capabilities',
405 'data': { 'capabilities': ['MigrationCapabilityStatus'] } }
408 # @query-migrate-capabilities:
410 # Returns information about the current migration capabilities status
412 # Returns: @MigrationCapabilitiesStatus
418 # -> { "execute": "query-migrate-capabilities" }
420 # {"state": false, "capability": "xbzrle"},
421 # {"state": false, "capability": "rdma-pin-all"},
422 # {"state": false, "capability": "auto-converge"},
423 # {"state": false, "capability": "zero-blocks"},
424 # {"state": false, "capability": "compress"},
425 # {"state": true, "capability": "events"},
426 # {"state": false, "capability": "postcopy-ram"},
427 # {"state": false, "capability": "x-colo"}
431 { 'command': 'query-migrate-capabilities', 'returns': ['MigrationCapabilityStatus']}
434 # @MigrationParameter:
436 # Migration parameters enumeration
438 # @compress-level: Set the compression level to be used in live migration,
439 # the compression level is an integer between 0 and 9, where 0 means
440 # no compression, 1 means the best compression speed, and 9 means best
441 # compression ratio which will consume more CPU.
443 # @compress-threads: Set compression thread count to be used in live migration,
444 # the compression thread count is an integer between 1 and 255.
446 # @decompress-threads: Set decompression thread count to be used in live
447 # migration, the decompression thread count is an integer between 1
448 # and 255. Usually, decompression is at least 4 times as fast as
449 # compression, so set the decompress-threads to the number about 1/4
450 # of compress-threads is adequate.
452 # @cpu-throttle-initial: Initial percentage of time guest cpus are throttled
453 # when migration auto-converge is activated. The
454 # default value is 20. (Since 2.7)
456 # @cpu-throttle-increment: throttle percentage increase each time
457 # auto-converge detects that migration is not making
458 # progress. The default value is 10. (Since 2.7)
460 # @tls-creds: ID of the 'tls-creds' object that provides credentials for
461 # establishing a TLS connection over the migration data channel.
462 # On the outgoing side of the migration, the credentials must
463 # be for a 'client' endpoint, while for the incoming side the
464 # credentials must be for a 'server' endpoint. Setting this
465 # will enable TLS for all migrations. The default is unset,
466 # resulting in unsecured migration at the QEMU level. (Since 2.7)
468 # @tls-hostname: hostname of the target host for the migration. This is
469 # required when using x509 based TLS credentials and the
470 # migration URI does not already include a hostname. For
471 # example if using fd: or exec: based migration, the
472 # hostname must be provided so that the server's x509
473 # certificate identity can be validated. (Since 2.7)
475 # @max-bandwidth: to set maximum speed for migration. maximum speed in
476 # bytes per second. (Since 2.8)
478 # @downtime-limit: set maximum tolerated downtime for migration. maximum
479 # downtime in milliseconds (Since 2.8)
481 # @x-checkpoint-delay: The delay time (in ms) between two COLO checkpoints in
482 # periodic mode. (Since 2.8)
484 # @block-incremental: Affects how much storage is migrated when the
485 # block migration capability is enabled. When false, the entire
486 # storage backing chain is migrated into a flattened image at
487 # the destination; when true, only the active qcow2 layer is
488 # migrated and the destination must already have access to the
489 # same backing chain as was used on the source. (since 2.10)
491 # @x-multifd-channels: Number of channels used to migrate data in
492 # parallel. This is the same number that the
493 # number of sockets used for migration. The
494 # default value is 2 (since 2.11)
496 # @x-multifd-page-count: Number of pages sent together to a thread.
497 # The default value is 16 (since 2.11)
499 # @xbzrle-cache-size: cache size to be used by XBZRLE migration. It
500 # needs to be a multiple of the target page size
506 { 'enum': 'MigrationParameter',
507 'data': ['compress-level', 'compress-threads', 'decompress-threads',
508 'cpu-throttle-initial', 'cpu-throttle-increment',
509 'tls-creds', 'tls-hostname', 'max-bandwidth',
510 'downtime-limit', 'x-checkpoint-delay', 'block-incremental',
511 'x-multifd-channels', 'x-multifd-page-count',
512 'xbzrle-cache-size' ] }
515 # @MigrateSetParameters:
517 # @compress-level: compression level
519 # @compress-threads: compression thread count
521 # @decompress-threads: decompression thread count
523 # @cpu-throttle-initial: Initial percentage of time guest cpus are
524 # throttled when migration auto-converge is activated.
525 # The default value is 20. (Since 2.7)
527 # @cpu-throttle-increment: throttle percentage increase each time
528 # auto-converge detects that migration is not making
529 # progress. The default value is 10. (Since 2.7)
531 # @tls-creds: ID of the 'tls-creds' object that provides credentials
532 # for establishing a TLS connection over the migration data
533 # channel. On the outgoing side of the migration, the credentials
534 # must be for a 'client' endpoint, while for the incoming side the
535 # credentials must be for a 'server' endpoint. Setting this
536 # to a non-empty string enables TLS for all migrations.
537 # An empty string means that QEMU will use plain text mode for
538 # migration, rather than TLS (Since 2.9)
539 # Previously (since 2.7), this was reported by omitting
542 # @tls-hostname: hostname of the target host for the migration. This
543 # is required when using x509 based TLS credentials and the
544 # migration URI does not already include a hostname. For
545 # example if using fd: or exec: based migration, the
546 # hostname must be provided so that the server's x509
547 # certificate identity can be validated. (Since 2.7)
548 # An empty string means that QEMU will use the hostname
549 # associated with the migration URI, if any. (Since 2.9)
550 # Previously (since 2.7), this was reported by omitting
551 # tls-hostname instead.
553 # @max-bandwidth: to set maximum speed for migration. maximum speed in
554 # bytes per second. (Since 2.8)
556 # @downtime-limit: set maximum tolerated downtime for migration. maximum
557 # downtime in milliseconds (Since 2.8)
559 # @x-checkpoint-delay: the delay time between two COLO checkpoints. (Since 2.8)
561 # @block-incremental: Affects how much storage is migrated when the
562 # block migration capability is enabled. When false, the entire
563 # storage backing chain is migrated into a flattened image at
564 # the destination; when true, only the active qcow2 layer is
565 # migrated and the destination must already have access to the
566 # same backing chain as was used on the source. (since 2.10)
568 # @x-multifd-channels: Number of channels used to migrate data in
569 # parallel. This is the same number that the
570 # number of sockets used for migration. The
571 # default value is 2 (since 2.11)
573 # @x-multifd-page-count: Number of pages sent together to a thread.
574 # The default value is 16 (since 2.11)
576 # @xbzrle-cache-size: cache size to be used by XBZRLE migration. It
577 # needs to be a multiple of the target page size
582 # TODO either fuse back into MigrationParameters, or make
583 # MigrationParameters members mandatory
584 { 'struct': 'MigrateSetParameters',
585 'data': { '*compress-level': 'int',
586 '*compress-threads': 'int',
587 '*decompress-threads': 'int',
588 '*cpu-throttle-initial': 'int',
589 '*cpu-throttle-increment': 'int',
590 '*tls-creds': 'StrOrNull',
591 '*tls-hostname': 'StrOrNull',
592 '*max-bandwidth': 'int',
593 '*downtime-limit': 'int',
594 '*x-checkpoint-delay': 'int',
595 '*block-incremental': 'bool',
596 '*x-multifd-channels': 'int',
597 '*x-multifd-page-count': 'int',
598 '*xbzrle-cache-size': 'size' } }
601 # @migrate-set-parameters:
603 # Set various migration parameters.
609 # -> { "execute": "migrate-set-parameters" ,
610 # "arguments": { "compress-level": 1 } }
613 { 'command': 'migrate-set-parameters', 'boxed': true,
614 'data': 'MigrateSetParameters' }
617 # @MigrationParameters:
619 # The optional members aren't actually optional.
621 # @compress-level: compression level
623 # @compress-threads: compression thread count
625 # @decompress-threads: decompression thread count
627 # @cpu-throttle-initial: Initial percentage of time guest cpus are
628 # throttled when migration auto-converge is activated.
631 # @cpu-throttle-increment: throttle percentage increase each time
632 # auto-converge detects that migration is not making
633 # progress. (Since 2.7)
635 # @tls-creds: ID of the 'tls-creds' object that provides credentials
636 # for establishing a TLS connection over the migration data
637 # channel. On the outgoing side of the migration, the credentials
638 # must be for a 'client' endpoint, while for the incoming side the
639 # credentials must be for a 'server' endpoint.
640 # An empty string means that QEMU will use plain text mode for
641 # migration, rather than TLS (Since 2.7)
642 # Note: 2.8 reports this by omitting tls-creds instead.
644 # @tls-hostname: hostname of the target host for the migration. This
645 # is required when using x509 based TLS credentials and the
646 # migration URI does not already include a hostname. For
647 # example if using fd: or exec: based migration, the
648 # hostname must be provided so that the server's x509
649 # certificate identity can be validated. (Since 2.7)
650 # An empty string means that QEMU will use the hostname
651 # associated with the migration URI, if any. (Since 2.9)
652 # Note: 2.8 reports this by omitting tls-hostname instead.
654 # @max-bandwidth: to set maximum speed for migration. maximum speed in
655 # bytes per second. (Since 2.8)
657 # @downtime-limit: set maximum tolerated downtime for migration. maximum
658 # downtime in milliseconds (Since 2.8)
660 # @x-checkpoint-delay: the delay time between two COLO checkpoints. (Since 2.8)
662 # @block-incremental: Affects how much storage is migrated when the
663 # block migration capability is enabled. When false, the entire
664 # storage backing chain is migrated into a flattened image at
665 # the destination; when true, only the active qcow2 layer is
666 # migrated and the destination must already have access to the
667 # same backing chain as was used on the source. (since 2.10)
669 # @x-multifd-channels: Number of channels used to migrate data in
670 # parallel. This is the same number that the
671 # number of sockets used for migration.
672 # The default value is 2 (since 2.11)
674 # @x-multifd-page-count: Number of pages sent together to a thread.
675 # The default value is 16 (since 2.11)
677 # @xbzrle-cache-size: cache size to be used by XBZRLE migration. It
678 # needs to be a multiple of the target page size
683 { 'struct': 'MigrationParameters',
684 'data': { '*compress-level': 'uint8',
685 '*compress-threads': 'uint8',
686 '*decompress-threads': 'uint8',
687 '*cpu-throttle-initial': 'uint8',
688 '*cpu-throttle-increment': 'uint8',
690 '*tls-hostname': 'str',
691 '*max-bandwidth': 'size',
692 '*downtime-limit': 'uint64',
693 '*x-checkpoint-delay': 'uint32',
694 '*block-incremental': 'bool' ,
695 '*x-multifd-channels': 'uint8',
696 '*x-multifd-page-count': 'uint32',
697 '*xbzrle-cache-size': 'size' } }
700 # @query-migrate-parameters:
702 # Returns information about the current migration parameters
704 # Returns: @MigrationParameters
710 # -> { "execute": "query-migrate-parameters" }
712 # "decompress-threads": 2,
713 # "cpu-throttle-increment": 10,
714 # "compress-threads": 8,
715 # "compress-level": 1,
716 # "cpu-throttle-initial": 20,
717 # "max-bandwidth": 33554432,
718 # "downtime-limit": 300
723 { 'command': 'query-migrate-parameters',
724 'returns': 'MigrationParameters' }
727 # @client_migrate_info:
729 # Set migration information for remote display. This makes the server
730 # ask the client to automatically reconnect using the new parameters
731 # once migration finished successfully. Only implemented for SPICE.
733 # @protocol: must be "spice"
734 # @hostname: migration target hostname
735 # @port: spice tcp port for plaintext channels
736 # @tls-port: spice tcp port for tls-secured channels
737 # @cert-subject: server certificate subject
743 # -> { "execute": "client_migrate_info",
744 # "arguments": { "protocol": "spice",
745 # "hostname": "virt42.lab.kraxel.org",
747 # <- { "return": {} }
750 { 'command': 'client_migrate_info',
751 'data': { 'protocol': 'str', 'hostname': 'str', '*port': 'int',
752 '*tls-port': 'int', '*cert-subject': 'str' } }
755 # @migrate-start-postcopy:
757 # Followup to a migration command to switch the migration to postcopy mode.
758 # The postcopy-ram capability must be set before the original migration
765 # -> { "execute": "migrate-start-postcopy" }
766 # <- { "return": {} }
769 { 'command': 'migrate-start-postcopy' }
774 # Emitted when a migration event happens
776 # @status: @MigrationStatus describing the current migration status.
782 # <- {"timestamp": {"seconds": 1432121972, "microseconds": 744001},
783 # "event": "MIGRATION",
784 # "data": {"status": "completed"} }
787 { 'event': 'MIGRATION',
788 'data': {'status': 'MigrationStatus'}}
793 # Emitted from the source side of a migration at the start of each pass
794 # (when it syncs the dirty bitmap)
796 # @pass: An incrementing count (starting at 1 on the first pass)
802 # { "timestamp": {"seconds": 1449669631, "microseconds": 239225},
803 # "event": "MIGRATION_PASS", "data": {"pass": 2} }
806 { 'event': 'MIGRATION_PASS',
807 'data': { 'pass': 'int' } }
812 # The message transmission between Primary side and Secondary side.
814 # @checkpoint-ready: Secondary VM (SVM) is ready for checkpointing
816 # @checkpoint-request: Primary VM (PVM) tells SVM to prepare for checkpointing
818 # @checkpoint-reply: SVM gets PVM's checkpoint request
820 # @vmstate-send: VM's state will be sent by PVM.
822 # @vmstate-size: The total size of VMstate.
824 # @vmstate-received: VM's state has been received by SVM.
826 # @vmstate-loaded: VM's state has been loaded by SVM.
830 { 'enum': 'COLOMessage',
831 'data': [ 'checkpoint-ready', 'checkpoint-request', 'checkpoint-reply',
832 'vmstate-send', 'vmstate-size', 'vmstate-received',
840 # @unknown: unknown mode
842 # @primary: master side
844 # @secondary: slave side
848 { 'enum': 'COLOMode',
849 'data': [ 'unknown', 'primary', 'secondary'] }
854 # An enumeration of COLO failover status
856 # @none: no failover has ever happened
858 # @require: got failover requirement but not handled
860 # @active: in the process of doing failover
862 # @completed: finish the process of failover
864 # @relaunch: restart the failover process, from 'none' -> 'completed' (Since 2.9)
868 { 'enum': 'FailoverStatus',
869 'data': [ 'none', 'require', 'active', 'completed', 'relaunch' ] }
872 # @x-colo-lost-heartbeat:
874 # Tell qemu that heartbeat is lost, request it to do takeover procedures.
875 # If this command is sent to the PVM, the Primary side will exit COLO mode.
876 # If sent to the Secondary, the Secondary side will run failover work,
877 # then takes over server operation to become the service VM.
883 # -> { "execute": "x-colo-lost-heartbeat" }
884 # <- { "return": {} }
887 { 'command': 'x-colo-lost-heartbeat' }
892 # Cancel the current executing migration process.
894 # Returns: nothing on success
896 # Notes: This command succeeds even if there is no migration process running.
902 # -> { "execute": "migrate_cancel" }
903 # <- { "return": {} }
906 { 'command': 'migrate_cancel' }
911 # Continue migration when it's in a paused state.
913 # @state: The state the migration is currently expected to be in
915 # Returns: nothing on success
919 # -> { "execute": "migrate-continue" , "arguments":
920 # { "state": "pre-switchover" } }
921 # <- { "return": {} }
923 { 'command': 'migrate-continue', 'data': {'state': 'MigrationStatus'} }
926 # @migrate_set_downtime:
928 # Set maximum tolerated downtime for migration.
930 # @value: maximum downtime in seconds
932 # Returns: nothing on success
934 # Notes: This command is deprecated in favor of 'migrate-set-parameters'
940 # -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
941 # <- { "return": {} }
944 { 'command': 'migrate_set_downtime', 'data': {'value': 'number'} }
947 # @migrate_set_speed:
949 # Set maximum speed for migration.
951 # @value: maximum speed in bytes per second.
953 # Returns: nothing on success
955 # Notes: This command is deprecated in favor of 'migrate-set-parameters'
961 # -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
962 # <- { "return": {} }
965 { 'command': 'migrate_set_speed', 'data': {'value': 'int'} }
968 # @migrate-set-cache-size:
970 # Set cache size to be used by XBZRLE migration
972 # @value: cache size in bytes
974 # The size will be rounded down to the nearest power of 2.
975 # The cache size can be modified before and during ongoing migration
977 # Returns: nothing on success
979 # Notes: This command is deprecated in favor of 'migrate-set-parameters'
985 # -> { "execute": "migrate-set-cache-size",
986 # "arguments": { "value": 536870912 } }
987 # <- { "return": {} }
990 { 'command': 'migrate-set-cache-size', 'data': {'value': 'int'} }
993 # @query-migrate-cache-size:
995 # Query migration XBZRLE cache size
997 # Returns: XBZRLE cache size in bytes
999 # Notes: This command is deprecated in favor of 'query-migrate-parameters'
1005 # -> { "execute": "query-migrate-cache-size" }
1006 # <- { "return": 67108864 }
1009 { 'command': 'query-migrate-cache-size', 'returns': 'int' }
1014 # Migrates the current running guest to another Virtual Machine.
1016 # @uri: the Uniform Resource Identifier of the destination VM
1018 # @blk: do block migration (full disk copy)
1020 # @inc: incremental disk copy migration
1022 # @detach: this argument exists only for compatibility reasons and
1023 # is ignored by QEMU
1025 # Returns: nothing on success
1031 # 1. The 'query-migrate' command should be used to check migration's progress
1032 # and final result (this information is provided by the 'status' member)
1034 # 2. All boolean arguments default to false
1036 # 3. The user Monitor's "detach" argument is invalid in QMP and should not
1041 # -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
1042 # <- { "return": {} }
1045 { 'command': 'migrate',
1046 'data': {'uri': 'str', '*blk': 'bool', '*inc': 'bool', '*detach': 'bool' } }
1049 # @migrate-incoming:
1051 # Start an incoming migration, the qemu must have been started
1052 # with -incoming defer
1054 # @uri: The Uniform Resource Identifier identifying the source or
1055 # address to listen on
1057 # Returns: nothing on success
1063 # 1. It's a bad idea to use a string for the uri, but it needs to stay
1064 # compatible with -incoming and the format of the uri is already exposed
1067 # 2. QEMU must be started with -incoming defer to allow migrate-incoming to
1070 # 3. The uri format is the same as for -incoming
1074 # -> { "execute": "migrate-incoming",
1075 # "arguments": { "uri": "tcp::4446" } }
1076 # <- { "return": {} }
1079 { 'command': 'migrate-incoming', 'data': {'uri': 'str' } }
1082 # @xen-save-devices-state:
1084 # Save the state of all devices to file. The RAM and the block devices
1085 # of the VM are not saved by this command.
1087 # @filename: the file to save the state of the devices to as binary
1088 # data. See xen-save-devices-state.txt for a description of the binary
1091 # @live: Optional argument to ask QEMU to treat this command as part of a live
1092 # migration. Default to true. (since 2.11)
1094 # Returns: Nothing on success
1100 # -> { "execute": "xen-save-devices-state",
1101 # "arguments": { "filename": "/tmp/save" } }
1102 # <- { "return": {} }
1105 { 'command': 'xen-save-devices-state',
1106 'data': {'filename': 'str', '*live':'bool' } }
1109 # @xen-set-replication:
1111 # Enable or disable replication.
1113 # @enable: true to enable, false to disable.
1115 # @primary: true for primary or false for secondary.
1117 # @failover: true to do failover, false to stop. but cannot be
1118 # specified if 'enable' is true. default value is false.
1124 # -> { "execute": "xen-set-replication",
1125 # "arguments": {"enable": true, "primary": false} }
1126 # <- { "return": {} }
1130 { 'command': 'xen-set-replication',
1131 'data': { 'enable': 'bool', 'primary': 'bool', '*failover' : 'bool' } }
1134 # @ReplicationStatus:
1136 # The result format for 'query-xen-replication-status'.
1138 # @error: true if an error happened, false if replication is normal.
1140 # @desc: the human readable error description string, when
1145 { 'struct': 'ReplicationStatus',
1146 'data': { 'error': 'bool', '*desc': 'str' } }
1149 # @query-xen-replication-status:
1151 # Query replication status while the vm is running.
1153 # Returns: A @ReplicationResult object showing the status.
1157 # -> { "execute": "query-xen-replication-status" }
1158 # <- { "return": { "error": false } }
1162 { 'command': 'query-xen-replication-status',
1163 'returns': 'ReplicationStatus' }
1166 # @xen-colo-do-checkpoint:
1168 # Xen uses this command to notify replication to trigger a checkpoint.
1174 # -> { "execute": "xen-colo-do-checkpoint" }
1175 # <- { "return": {} }
1179 { 'command': 'xen-colo-do-checkpoint' }