Lines Matching +full:- +full:- +full:disable +full:- +full:replication
1 # -*- Mode: Python -*-
28 # @normal-bytes: number of normal bytes sent (since 1.2)
30 # @dirty-pages-rate: number of pages dirtied by second by the guest
35 # @dirty-sync-count: number of times that dirty ram was synchronized
38 # @postcopy-requests: The number of page requests received from the
41 # @page-size: The number of bytes per page for the various page-based
44 # @multifd-bytes: The number of bytes sent through multifd (since 3.0)
46 # @pages-per-second: the number of memory pages transferred per second
49 # @precopy-bytes: The number of bytes sent in the pre-copy phase
52 # @downtime-bytes: The number of bytes sent while the guest is paused
55 # @postcopy-bytes: The number of bytes sent during the post-copy phase
58 # @dirty-sync-missed-zero-copy: Number of times dirty RAM
60 # between 0 and @dirty-sync-count * @multifd-channels. (since
69 'normal-bytes': 'int', 'dirty-pages-rate': 'int',
70 'mbps': 'number', 'dirty-sync-count': 'int',
71 'postcopy-requests': 'int', 'page-size': 'int',
72 'multifd-bytes': 'uint64', 'pages-per-second': 'uint64',
73 'precopy-bytes': 'uint64', 'downtime-bytes': 'uint64',
74 'postcopy-bytes': 'uint64',
75 'dirty-sync-missed-zero-copy': 'uint64' } }
82 # @cache-size: XBZRLE cache size
88 # @cache-miss: number of cache miss
90 # @cache-miss-rate: rate of cache miss (since 2.1)
92 # @encoding-rate: rate of encoded bytes (since 5.1)
99 'data': {'cache-size': 'size', 'bytes': 'int', 'pages': 'int',
100 'cache-miss': 'int', 'cache-miss-rate': 'number',
101 'encoding-rate': 'number', 'overflow': 'int' } }
113 # @busy-rate: rate of thread busy
115 # @compressed-size: amount of bytes after compression
117 # @compression-rate: rate of compressed size
122 'data': {'pages': 'int', 'busy': 'int', 'busy-rate': 'number',
123 'compressed-size': 'int', 'compression-rate': 'number' } }
140 # @postcopy-active: like active, but now in postcopy mode. (since
143 # @postcopy-paused: during postcopy but paused. (since 3.0)
145 # @postcopy-recover-setup: setup phase for a postcopy recovery
148 # @postcopy-recover: trying to recover from a paused postcopy. (since
159 # @pre-switchover: Paused before device serialisation. (since 2.11)
161 # @device: During device serialisation when pause-before-switchover is
164 # @wait-unplug: wait for device unplug request by guest OS to be
171 'active', 'postcopy-active', 'postcopy-paused',
172 'postcopy-recover-setup',
173 'postcopy-recover', 'completed', 'failed', 'colo',
174 'pre-switchover', 'device', 'wait-unplug' ] }
200 # @xbzrle-cache: @XBZRLECacheStats containing detailed XBZRLE
204 # @total-time: total amount of milliseconds since migration started.
211 # @expected-downtime: only present while migration is active expected
215 # @setup-time: amount of setup time in milliseconds *before* the
221 # @cpu-throttle-percentage: percentage of time guest cpus are being
222 # throttled during auto-converge. This is only present when
223 # auto-converge has started throttling guest cpus. (Since 2.7)
225 # @error-desc: the human readable error description string. Clients
228 # @postcopy-blocktime: total time when all vCPU were blocked during
230 # postcopy-blocktime migration capability is enabled. (Since 3.0)
232 # @postcopy-vcpu-blocktime: list of the postcopy blocktime per vCPU.
233 # This is only present when the postcopy-blocktime migration
236 # @socket-address: Only used for tcp, to know what the real port is
244 # @blocked-reasons: A list of reasons an outgoing migration is
245 # blocked. Present and non-empty when migration is blocked.
248 # @dirty-limit-throttle-time-per-round: Maximum throttle time (in
250 # shows how MigrationCapability dirty-limit affects the guest
253 # @dirty-limit-ring-full-time: Estimated average dirty ring full time
265 '*xbzrle-cache': 'XBZRLECacheStats',
266 '*total-time': 'int',
267 '*expected-downtime': 'int',
269 '*setup-time': 'int',
270 '*cpu-throttle-percentage': 'int',
271 '*error-desc': 'str',
272 '*blocked-reasons': ['str'],
273 '*postcopy-blocktime': 'uint32',
274 '*postcopy-vcpu-blocktime': ['uint32'],
275 '*socket-address': ['SocketAddress'],
276 '*dirty-limit-throttle-time-per-round': 'uint64',
277 '*dirty-limit-ring-full-time': 'uint64'} }
280 # @query-migrate:
283 # is active there will be another json-object with RAM migration
290 # .. qmp-example::
293 # -> { "execute": "query-migrate" }
294 # <- { "return": {} }
296 # .. qmp-example::
299 # -> { "execute": "query-migrate" }
300 # <- { "return": {
302 # "total-time":12345,
303 # "setup-time":12345,
311 # "normal-bytes":123456,
312 # "dirty-sync-count":15
317 # .. qmp-example::
320 # -> { "execute": "query-migrate" }
321 # <- { "return": { "status": "failed" } }
323 # .. qmp-example::
326 # -> { "execute": "query-migrate" }
327 # <- {
330 # "total-time":12345,
331 # "setup-time":12345,
332 # "expected-downtime":12345,
339 # "normal-bytes":123456,
340 # "dirty-sync-count":15
345 # .. qmp-example::
348 # -> { "execute": "query-migrate" }
349 # <- {
352 # "total-time":12345,
353 # "setup-time":12345,
354 # "expected-downtime":12345,
361 # "normal-bytes":3412992,
362 # "dirty-sync-count":15
364 # "xbzrle-cache":{
365 # "cache-size":67108864,
368 # "cache-miss":2244,
369 # "cache-miss-rate":0.123,
370 # "encoding-rate":80.1,
376 { 'command': 'query-migrate', 'returns': 'MigrationInfo' }
388 # @rdma-pin-all: Controls whether or not the entire VM memory
392 # @zero-blocks: During storage migration encode blocks of zeroes
401 # @auto-converge: If enabled, QEMU will automatically throttle down
404 # @postcopy-ram: Start executing on the migration target before all of
410 # @x-colo: If enabled, migration will never end, and the state of the
412 # on secondary side, this process is called COarse-Grain LOck
413 # Stepping (COLO) for Non-stop Service. (since 2.8)
415 # @release-ram: if enabled, qemu will free the migrated ram pages on
416 # the source during postcopy-ram migration. (since 2.9)
418 # @return-path: If enabled, migration will use the return path even
421 # @pause-before-switchover: Pause outgoing migration before
427 # @dirty-bitmaps: If enabled, QEMU will migrate named dirty bitmaps.
430 # @postcopy-blocktime: Calculate downtime for postcopy live migration
433 # @late-block-activate: If enabled, the destination will not activate
437 # @x-ignore-shared: If enabled, QEMU will not migrate shared memory
440 # @validate-uuid: Send the UUID of the source to allow the destination
443 # @background-snapshot: If enabled, the migration stream will be a
448 # @zero-copy-send: Controls behavior on sending memory pages on
449 # migration. When true, enables a zero-copy mechanism for sending
453 # @postcopy-preempt: If enabled, the migration process will allow
459 # @switchover-ack: If enabled, migration will not stop the source VM
466 # are present. 'return-path' capability must be enabled to use
469 # @dirty-limit: If enabled, migration will throttle vCPUs as needed to
470 # keep their dirty page rate within @vcpu-dirty-limit. This can
473 # with accelerator property "dirty-ring-size" set. (Since 8.1)
475 # @mapped-ram: Migrate using fixed offsets in the migration file for
481 # @unstable: Members @x-colo and @x-ignore-shared are experimental.
482 # @deprecated: Member @zero-blocks is deprecated as being part of
488 'data': ['xbzrle', 'rdma-pin-all', 'auto-converge',
489 { 'name': 'zero-blocks', 'features': [ 'deprecated' ] },
490 'events', 'postcopy-ram',
491 { 'name': 'x-colo', 'features': [ 'unstable' ] },
492 'release-ram',
493 'return-path', 'pause-before-switchover', 'multifd',
494 'dirty-bitmaps', 'postcopy-blocktime', 'late-block-activate',
495 { 'name': 'x-ignore-shared', 'features': [ 'unstable' ] },
496 'validate-uuid', 'background-snapshot',
497 'zero-copy-send', 'postcopy-preempt', 'switchover-ack',
498 'dirty-limit', 'mapped-ram'] }
515 # @migrate-set-capabilities:
517 # Enable/Disable the following migration capabilities (like xbzrle)
523 # .. qmp-example::
525 # -> { "execute": "migrate-set-capabilities" , "arguments":
527 # <- { "return": {} }
529 { 'command': 'migrate-set-capabilities',
533 # @query-migrate-capabilities:
541 # .. qmp-example::
543 # -> { "execute": "query-migrate-capabilities" }
544 # <- { "return": [
546 # {"state": false, "capability": "rdma-pin-all"},
547 # {"state": false, "capability": "auto-converge"},
548 # {"state": false, "capability": "zero-blocks"},
550 # {"state": false, "capability": "postcopy-ram"},
551 # {"state": false, "capability": "x-colo"}
554 { 'command': 'query-migrate-capabilities', 'returns': ['MigrationCapabilityStatus']}
571 # In-Memory Analytics Accelerator(IAA) accelerated compression and
591 # @cpr-reboot: The migrate command stops the VM and saves state to the
593 # -incoming.
605 # guest-suspend-ram to the QEMU guest agent.
608 # and the @x-ignore-shared migration capability is set, but this
613 # @cpr-reboot may not be used with postcopy, background-snapshot,
619 'data': [ 'normal', 'cpr-reboot' ] }
676 # @node-name: A block node name.
687 'node-name': 'str',
697 # @announce-initial: Initial delay (in milliseconds) before sending
700 # @announce-max: Maximum delay (in milliseconds) between packets in
703 # @announce-rounds: Number of self-announce packets sent after
706 # @announce-step: Increase in delay (in milliseconds) between
709 # @throttle-trigger-threshold: The ratio of bytes_dirty_period and
713 # @cpu-throttle-initial: Initial percentage of time guest cpus are
714 # throttled when migration auto-converge is activated. The
717 # @cpu-throttle-increment: throttle percentage increase each time
718 # auto-converge detects that migration is not making progress.
721 # @cpu-throttle-tailslow: Make CPU throttling slower at tail stage At
723 # percentage while the @cpu-throttle -increment is excessive
728 # specified by @cpu-throttle-increment and the one generated by
734 # @tls-creds: ID of the 'tls-creds' object that provides credentials
739 # non-empty string enables TLS for all migrations. An empty
743 # @tls-hostname: migration target's hostname for validating the
745 # hostname from the migration URI, if any. A non-empty value is
752 # @tls-authz: ID of the 'authz' object subclass that provides access
758 # @max-bandwidth: maximum speed for migration, in bytes per second.
761 # @avail-switchover-bandwidth: to set the available bandwidth that
772 # @downtime-limit: set maximum tolerated downtime for migration.
775 # @x-checkpoint-delay: The delay time (in ms) between two COLO
778 # @multifd-channels: Number of channels used to migrate data in
782 # @xbzrle-cache-size: cache size to be used by XBZRLE migration. It
786 # @max-postcopy-bandwidth: Background transfer bandwidth during
790 # @max-cpu-throttle: maximum cpu throttle percentage. Defaults to 99.
793 # @multifd-compression: Which compression method to use. Defaults to
796 # @multifd-zlib-level: Set the compression level to be used in live
802 # @multifd-qatzip-level: Set the compression level to be used in live
807 # @multifd-zstd-level: Set the compression level to be used in live
813 # @block-bitmap-mapping: Maps block nodes and bitmaps on them to
816 # The mapping must be one-to-one, but not necessarily complete: On
829 # @x-vcpu-dirty-limit-period: Periodic time (in milliseconds) of dirty
833 # @vcpu-dirty-limit: Dirtyrate limit (MB/s) during live migration.
839 # @zero-page-detection: Whether and how to detect zero pages.
843 # @direct-io: Open migration files with O_DIRECT when possible. This
844 # only has effect if the @mapped-ram capability is enabled.
849 # @unstable: Members @x-checkpoint-delay and
850 # @x-vcpu-dirty-limit-period are experimental.
855 'data': ['announce-initial', 'announce-max',
856 'announce-rounds', 'announce-step',
857 'throttle-trigger-threshold',
858 'cpu-throttle-initial', 'cpu-throttle-increment',
859 'cpu-throttle-tailslow',
860 'tls-creds', 'tls-hostname', 'tls-authz', 'max-bandwidth',
861 'avail-switchover-bandwidth', 'downtime-limit',
862 { 'name': 'x-checkpoint-delay', 'features': [ 'unstable' ] },
863 'multifd-channels',
864 'xbzrle-cache-size', 'max-postcopy-bandwidth',
865 'max-cpu-throttle', 'multifd-compression',
866 'multifd-zlib-level', 'multifd-zstd-level',
867 'multifd-qatzip-level',
868 'block-bitmap-mapping',
869 { 'name': 'x-vcpu-dirty-limit-period', 'features': ['unstable'] },
870 'vcpu-dirty-limit',
872 'zero-page-detection',
873 'direct-io'] }
878 # @announce-initial: Initial delay (in milliseconds) before sending
881 # @announce-max: Maximum delay (in milliseconds) between packets in
884 # @announce-rounds: Number of self-announce packets sent after
887 # @announce-step: Increase in delay (in milliseconds) between
890 # @throttle-trigger-threshold: The ratio of bytes_dirty_period and
894 # @cpu-throttle-initial: Initial percentage of time guest cpus are
895 # throttled when migration auto-converge is activated. The
898 # @cpu-throttle-increment: throttle percentage increase each time
899 # auto-converge detects that migration is not making progress.
902 # @cpu-throttle-tailslow: Make CPU throttling slower at tail stage At
904 # percentage while the @cpu-throttle -increment is excessive
909 # specified by @cpu-throttle-increment and the one generated by
915 # @tls-creds: ID of the 'tls-creds' object that provides credentials
920 # non-empty string enables TLS for all migrations. An empty
924 # @tls-hostname: migration target's hostname for validating the
926 # hostname from the migration URI, if any. A non-empty value is
933 # @tls-authz: ID of the 'authz' object subclass that provides access
939 # @max-bandwidth: maximum speed for migration, in bytes per second.
942 # @avail-switchover-bandwidth: to set the available bandwidth that
953 # @downtime-limit: set maximum tolerated downtime for migration.
956 # @x-checkpoint-delay: The delay time (in ms) between two COLO
959 # @multifd-channels: Number of channels used to migrate data in
963 # @xbzrle-cache-size: cache size to be used by XBZRLE migration. It
967 # @max-postcopy-bandwidth: Background transfer bandwidth during
971 # @max-cpu-throttle: maximum cpu throttle percentage. Defaults to 99.
974 # @multifd-compression: Which compression method to use. Defaults to
977 # @multifd-zlib-level: Set the compression level to be used in live
983 # @multifd-qatzip-level: Set the compression level to be used in live
988 # @multifd-zstd-level: Set the compression level to be used in live
994 # @block-bitmap-mapping: Maps block nodes and bitmaps on them to
997 # The mapping must be one-to-one, but not necessarily complete: On
1010 # @x-vcpu-dirty-limit-period: Periodic time (in milliseconds) of dirty
1014 # @vcpu-dirty-limit: Dirtyrate limit (MB/s) during live migration.
1020 # @zero-page-detection: Whether and how to detect zero pages.
1024 # @direct-io: Open migration files with O_DIRECT when possible. This
1025 # only has effect if the @mapped-ram capability is enabled.
1030 # @unstable: Members @x-checkpoint-delay and
1031 # @x-vcpu-dirty-limit-period are experimental.
1039 'data': { '*announce-initial': 'size',
1040 '*announce-max': 'size',
1041 '*announce-rounds': 'size',
1042 '*announce-step': 'size',
1043 '*throttle-trigger-threshold': 'uint8',
1044 '*cpu-throttle-initial': 'uint8',
1045 '*cpu-throttle-increment': 'uint8',
1046 '*cpu-throttle-tailslow': 'bool',
1047 '*tls-creds': 'StrOrNull',
1048 '*tls-hostname': 'StrOrNull',
1049 '*tls-authz': 'StrOrNull',
1050 '*max-bandwidth': 'size',
1051 '*avail-switchover-bandwidth': 'size',
1052 '*downtime-limit': 'uint64',
1053 '*x-checkpoint-delay': { 'type': 'uint32',
1055 '*multifd-channels': 'uint8',
1056 '*xbzrle-cache-size': 'size',
1057 '*max-postcopy-bandwidth': 'size',
1058 '*max-cpu-throttle': 'uint8',
1059 '*multifd-compression': 'MultiFDCompression',
1060 '*multifd-zlib-level': 'uint8',
1061 '*multifd-qatzip-level': 'uint8',
1062 '*multifd-zstd-level': 'uint8',
1063 '*block-bitmap-mapping': [ 'BitmapMigrationNodeAlias' ],
1064 '*x-vcpu-dirty-limit-period': { 'type': 'uint64',
1066 '*vcpu-dirty-limit': 'uint64',
1068 '*zero-page-detection': 'ZeroPageDetection',
1069 '*direct-io': 'bool' } }
1072 # @migrate-set-parameters:
1078 # .. qmp-example::
1080 # -> { "execute": "migrate-set-parameters" ,
1081 # "arguments": { "multifd-channels": 5 } }
1082 # <- { "return": {} }
1084 { 'command': 'migrate-set-parameters', 'boxed': true,
1092 # @announce-initial: Initial delay (in milliseconds) before sending
1095 # @announce-max: Maximum delay (in milliseconds) between packets in
1098 # @announce-rounds: Number of self-announce packets sent after
1101 # @announce-step: Increase in delay (in milliseconds) between
1104 # @throttle-trigger-threshold: The ratio of bytes_dirty_period and
1108 # @cpu-throttle-initial: Initial percentage of time guest cpus are
1109 # throttled when migration auto-converge is activated. (Since
1112 # @cpu-throttle-increment: throttle percentage increase each time
1113 # auto-converge detects that migration is not making progress.
1116 # @cpu-throttle-tailslow: Make CPU throttling slower at tail stage At
1118 # percentage while the @cpu-throttle -increment is excessive
1123 # specified by @cpu-throttle-increment and the one generated by
1129 # @tls-creds: ID of the 'tls-creds' object that provides credentials
1137 # Note: 2.8 omits empty @tls-creds instead.
1139 # @tls-hostname: migration target's hostname for validating the
1143 # Note: 2.8 omits empty @tls-hostname instead.
1145 # @tls-authz: ID of the 'authz' object subclass that provides access
1149 # @max-bandwidth: maximum speed for migration, in bytes per second.
1152 # @avail-switchover-bandwidth: to set the available bandwidth that
1163 # @downtime-limit: set maximum tolerated downtime for migration.
1166 # @x-checkpoint-delay: the delay time between two COLO checkpoints.
1169 # @multifd-channels: Number of channels used to migrate data in
1173 # @xbzrle-cache-size: cache size to be used by XBZRLE migration. It
1177 # @max-postcopy-bandwidth: Background transfer bandwidth during
1181 # @max-cpu-throttle: maximum cpu throttle percentage. Defaults to 99.
1184 # @multifd-compression: Which compression method to use. Defaults to
1187 # @multifd-zlib-level: Set the compression level to be used in live
1193 # @multifd-qatzip-level: Set the compression level to be used in live
1198 # @multifd-zstd-level: Set the compression level to be used in live
1204 # @block-bitmap-mapping: Maps block nodes and bitmaps on them to
1207 # The mapping must be one-to-one, but not necessarily complete: On
1220 # @x-vcpu-dirty-limit-period: Periodic time (in milliseconds) of dirty
1224 # @vcpu-dirty-limit: Dirtyrate limit (MB/s) during live migration.
1230 # @zero-page-detection: Whether and how to detect zero pages.
1234 # @direct-io: Open migration files with O_DIRECT when possible. This
1235 # only has effect if the @mapped-ram capability is enabled.
1240 # @unstable: Members @x-checkpoint-delay and
1241 # @x-vcpu-dirty-limit-period are experimental.
1246 'data': { '*announce-initial': 'size',
1247 '*announce-max': 'size',
1248 '*announce-rounds': 'size',
1249 '*announce-step': 'size',
1250 '*throttle-trigger-threshold': 'uint8',
1251 '*cpu-throttle-initial': 'uint8',
1252 '*cpu-throttle-increment': 'uint8',
1253 '*cpu-throttle-tailslow': 'bool',
1254 '*tls-creds': 'str',
1255 '*tls-hostname': 'str',
1256 '*tls-authz': 'str',
1257 '*max-bandwidth': 'size',
1258 '*avail-switchover-bandwidth': 'size',
1259 '*downtime-limit': 'uint64',
1260 '*x-checkpoint-delay': { 'type': 'uint32',
1262 '*multifd-channels': 'uint8',
1263 '*xbzrle-cache-size': 'size',
1264 '*max-postcopy-bandwidth': 'size',
1265 '*max-cpu-throttle': 'uint8',
1266 '*multifd-compression': 'MultiFDCompression',
1267 '*multifd-zlib-level': 'uint8',
1268 '*multifd-qatzip-level': 'uint8',
1269 '*multifd-zstd-level': 'uint8',
1270 '*block-bitmap-mapping': [ 'BitmapMigrationNodeAlias' ],
1271 '*x-vcpu-dirty-limit-period': { 'type': 'uint64',
1273 '*vcpu-dirty-limit': 'uint64',
1275 '*zero-page-detection': 'ZeroPageDetection',
1276 '*direct-io': 'bool' } }
1279 # @query-migrate-parameters:
1287 # .. qmp-example::
1289 # -> { "execute": "query-migrate-parameters" }
1290 # <- { "return": {
1291 # "multifd-channels": 2,
1292 # "cpu-throttle-increment": 10,
1293 # "cpu-throttle-initial": 20,
1294 # "max-bandwidth": 33554432,
1295 # "downtime-limit": 300
1299 { 'command': 'query-migrate-parameters',
1303 # @migrate-start-postcopy:
1306 # mode. The postcopy-ram capability must be set on both source and
1311 # .. qmp-example::
1313 # -> { "execute": "migrate-start-postcopy" }
1314 # <- { "return": {} }
1316 { 'command': 'migrate-start-postcopy' }
1327 # .. qmp-example::
1329 # <- {"timestamp": {"seconds": 1432121972, "microseconds": 744001},
1346 # .. qmp-example::
1348 # <- { "timestamp": {"seconds": 1449669631, "microseconds": 239225},
1359 # @checkpoint-ready: Secondary VM (SVM) is ready for checkpointing
1361 # @checkpoint-request: Primary VM (PVM) tells SVM to prepare for
1364 # @checkpoint-reply: SVM gets PVM's checkpoint request
1366 # @vmstate-send: VM's state will be sent by PVM.
1368 # @vmstate-size: The total size of VMstate.
1370 # @vmstate-received: VM's state has been received by SVM.
1372 # @vmstate-loaded: VM's state has been loaded by SVM.
1377 'data': [ 'checkpoint-ready', 'checkpoint-request', 'checkpoint-reply',
1378 'vmstate-send', 'vmstate-size', 'vmstate-received',
1379 'vmstate-loaded' ] }
1410 # @relaunch: restart the failover process, from 'none' -> 'completed'
1430 # .. qmp-example::
1432 # <- { "timestamp": {"seconds": 2032141960, "microseconds": 417172},
1445 # query-colo-status.
1459 # @x-colo-lost-heartbeat:
1473 # .. qmp-example::
1475 # -> { "execute": "x-colo-lost-heartbeat" }
1476 # <- { "return": {} }
1478 { 'command': 'x-colo-lost-heartbeat',
1492 # .. qmp-example::
1494 # -> { "execute": "migrate_cancel" }
1495 # <- { "return": {} }
1500 # @migrate-continue:
1508 # .. qmp-example::
1510 # -> { "execute": "migrate-continue" , "arguments":
1511 # { "state": "pre-switchover" } }
1512 # <- { "return": {} }
1514 { 'command': 'migrate-continue', 'data': {'state': 'MigrationStatus'} }
1578 # The migration channel-type request options.
1592 # @channel-type: Channel type for transferring packet information.
1600 'channel-type': 'MigrationChannelType',
1622 # 1. The 'query-migrate' command should be used to check
1641 # .. qmp-example::
1643 # -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
1644 # <- { "return": {} }
1646 # -> { "execute": "migrate",
1648 # "channels": [ { "channel-type": "main",
1653 # <- { "return": {} }
1655 # -> { "execute": "migrate",
1657 # "channels": [ { "channel-type": "main",
1659 # "args": [ "/bin/nc", "-p", "6000",
1661 # <- { "return": {} }
1663 # -> { "execute": "migrate",
1665 # "channels": [ { "channel-type": "main",
1669 # <- { "return": {} }
1671 # -> { "execute": "migrate",
1673 # "channels": [ { "channel-type": "main",
1677 # <- { "return": {} }
1685 # @migrate-incoming:
1688 # -incoming defer
1696 # @exit-on-error: Exit on incoming migration failure. Default true.
1698 # error details could be retrieved with query-migrate.
1706 # stay compatible with -incoming and the format of the uri is
1709 # 2. QEMU must be started with -incoming defer to allow
1710 # migrate-incoming to be used.
1712 # 3. The uri format is the same as for -incoming
1720 # .. qmp-example::
1722 # -> { "execute": "migrate-incoming",
1724 # <- { "return": {} }
1726 # -> { "execute": "migrate-incoming",
1728 # "channels": [ { "channel-type": "main",
1733 # <- { "return": {} }
1735 # -> { "execute": "migrate-incoming",
1737 # "channels": [ { "channel-type": "main",
1739 # "args": [ "/bin/nc", "-p", "6000",
1741 # <- { "return": {} }
1743 # -> { "execute": "migrate-incoming",
1745 # "channels": [ { "channel-type": "main",
1749 # <- { "return": {} }
1751 { 'command': 'migrate-incoming',
1754 '*exit-on-error': 'bool' } }
1757 # @xen-save-devices-state:
1763 # data. See xen-save-devices-state.txt for a description of the
1771 # .. qmp-example::
1773 # -> { "execute": "xen-save-devices-state",
1775 # <- { "return": {} }
1777 { 'command': 'xen-save-devices-state',
1781 # @xen-set-global-dirty-log:
1783 # Enable or disable the global dirty log mode.
1785 # @enable: true to enable, false to disable.
1789 # .. qmp-example::
1791 # -> { "execute": "xen-set-global-dirty-log",
1793 # <- { "return": {} }
1795 { 'command': 'xen-set-global-dirty-log', 'data': { 'enable': 'bool' } }
1798 # @xen-load-devices-state:
1804 # data. See xen-save-devices-state.txt for a description of the
1809 # .. qmp-example::
1811 # -> { "execute": "xen-load-devices-state",
1813 # <- { "return": {} }
1815 { 'command': 'xen-load-devices-state', 'data': {'filename': 'str'} }
1818 # @xen-set-replication:
1820 # Enable or disable replication.
1822 # @enable: true to enable, false to disable.
1829 # .. qmp-example::
1831 # -> { "execute": "xen-set-replication",
1833 # <- { "return": {} }
1837 { 'command': 'xen-set-replication',
1844 # The result format for 'query-xen-replication-status'.
1846 # @error: true if an error happened, false if replication is normal.
1858 # @query-xen-replication-status:
1860 # Query replication status while the vm is running.
1864 # .. qmp-example::
1866 # -> { "execute": "query-xen-replication-status" }
1867 # <- { "return": { "error": false } }
1871 { 'command': 'query-xen-replication-status',
1876 # @xen-colo-do-checkpoint:
1878 # Xen uses this command to notify replication to trigger a checkpoint.
1880 # .. qmp-example::
1882 # -> { "execute": "xen-colo-do-checkpoint" }
1883 # <- { "return": {} }
1887 { 'command': 'xen-colo-do-checkpoint',
1893 # The result format for 'query-colo-status'.
1898 # @last-mode: COLO last running mode. If COLO is running, this field
1907 'data': { 'mode': 'COLOMode', 'last-mode': 'COLOMode',
1912 # @query-colo-status:
1918 # .. qmp-example::
1920 # -> { "execute": "query-colo-status" }
1921 # <- { "return": { "mode": "primary", "last-mode": "none", "reason": "request" } }
1925 { 'command': 'query-colo-status',
1930 # @migrate-recover:
1936 # .. qmp-example::
1938 # -> { "execute": "migrate-recover",
1940 # <- { "return": {} }
1944 { 'command': 'migrate-recover',
1946 'allow-oob': true }
1949 # @migrate-pause:
1953 # .. qmp-example::
1955 # -> { "execute": "migrate-pause" }
1956 # <- { "return": {} }
1960 { 'command': 'migrate-pause', 'allow-oob': true }
1967 # Device resources in QEMU are kept on standby to be able to re-plug
1970 # @device-id: QEMU device id of the unplugged device
1974 # .. qmp-example::
1976 # <- { "event": "UNPLUG_PRIMARY",
1977 # "data": { "device-id": "hostdev0" },
1981 'data': { 'device-id': 'str' } }
1990 # @dirty-rate: dirty rate.
1995 'data': { 'id': 'int', 'dirty-rate': 'int64' } }
2017 # available methods are explained in @calc-dirty-rate.
2019 # @page-sampling: use page sampling
2021 # @dirty-ring: use dirty ring
2023 # @dirty-bitmap: use dirty bitmap
2028 'data': ['page-sampling', 'dirty-ring', 'dirty-bitmap'] }
2033 # Specifies unit in which time-related value is specified.
2049 # @dirty-rate: an estimate of the dirty page rate of the VM in units
2054 # @start-time: start time in units of second for calculation
2056 # @calc-time: time period for which dirty page rate was measured,
2057 # expressed and rounded down to @calc-time-unit.
2059 # @calc-time-unit: time unit of @calc-time (Since 8.2)
2061 # @sample-pages: number of sampled pages per GiB of guest memory.
2062 # Valid only in page-sampling mode (Since 6.1)
2066 # @vcpu-dirty-rate: dirty rate for each vCPU if dirty-ring mode was
2072 'data': {'*dirty-rate': 'int64',
2074 'start-time': 'int64',
2075 'calc-time': 'int64',
2076 'calc-time-unit': 'TimeUnit',
2077 'sample-pages': 'uint64',
2079 '*vcpu-dirty-rate': [ 'DirtyRateVcpu' ] } }
2082 # @calc-dirty-rate:
2085 # with @query-dirty-rate after measurements are completed.
2096 # only an estimate of its true value. Increasing @sample-pages
2104 # requires that KVM accelerator property "dirty-ring-size" is *not*
2110 # requires that KVM accelerator property "dirty-ring-size" is set.
2112 # @calc-time: time period for which dirty page rate is calculated. By
2114 # explicitly with @calc-time-unit. Note that larger @calc-time
2116 # page dirtying is a one-time event. Once some page is counted as
2117 # dirty during @calc-time period, further writes to this page will
2120 # @calc-time-unit: time unit in which @calc-time is specified. By
2123 # @sample-pages: number of sampled pages per each GiB of guest memory.
2129 # 'page-sampling'. Others are 'dirty-bitmap' and 'dirty-ring'.
2134 # .. qmp-example::
2136 # -> {"execute": "calc-dirty-rate", "arguments": {"calc-time": 1,
2137 # "sample-pages": 512} }
2138 # <- { "return": {} }
2140 # .. qmp-example::
2145 # -> {"execute": "calc-dirty-rate", "arguments": {"calc-time": 500,
2146 # "calc-time-unit": "millisecond", "mode": "dirty-bitmap"} }
2148 # <- { "return": {} }
2150 { 'command': 'calc-dirty-rate', 'data': {'calc-time': 'int64',
2151 '*calc-time-unit': 'TimeUnit',
2152 '*sample-pages': 'int',
2156 # @query-dirty-rate:
2158 # Query results of the most recent invocation of @calc-dirty-rate.
2160 # @calc-time-unit: time unit in which to report calculation time.
2165 # .. qmp-example::
2168 # <- {"status": "measuring", "sample-pages": 512,
2169 # "mode": "page-sampling", "start-time": 1693900454, "calc-time": 10,
2170 # "calc-time-unit": "second"}
2172 # .. qmp-example::
2175 # <- {"status": "measured", "sample-pages": 512, "dirty-rate": 108,
2176 # "mode": "page-sampling", "start-time": 1693900454, "calc-time": 10,
2177 # "calc-time-unit": "second"}
2179 { 'command': 'query-dirty-rate', 'data': {'*calc-time-unit': 'TimeUnit' },
2187 # @cpu-index: index of a virtual CPU.
2189 # @limit-rate: upper limit of dirty page rate (MB/s) for a virtual
2192 # @current-rate: current dirty page rate (MB/s) for a virtual CPU.
2197 'data': { 'cpu-index': 'int',
2198 'limit-rate': 'uint64',
2199 'current-rate': 'uint64' } }
2202 # @set-vcpu-dirty-limit:
2206 # Requires KVM with accelerator property "dirty-ring-size" set. A
2208 # observe dirty page rates, use @calc-dirty-rate.
2210 # @cpu-index: index of a virtual CPU, default is all.
2212 # @dirty-rate: upper limit of dirty page rate (MB/s) for virtual CPUs.
2216 # .. qmp-example::
2218 # -> {"execute": "set-vcpu-dirty-limit"}
2219 # "arguments": { "dirty-rate": 200,
2220 # "cpu-index": 1 } }
2221 # <- { "return": {} }
2223 { 'command': 'set-vcpu-dirty-limit',
2224 'data': { '*cpu-index': 'int',
2225 'dirty-rate': 'uint64' } }
2228 # @cancel-vcpu-dirty-limit:
2233 # set-vcpu-dirty-limit command. Note that this command requires
2234 # support from dirty ring, same as the "set-vcpu-dirty-limit".
2236 # @cpu-index: index of a virtual CPU, default is all.
2240 # .. qmp-example::
2242 # -> {"execute": "cancel-vcpu-dirty-limit"},
2243 # "arguments": { "cpu-index": 1 } }
2244 # <- { "return": {} }
2246 { 'command': 'cancel-vcpu-dirty-limit',
2247 'data': { '*cpu-index': 'int'} }
2250 # @query-vcpu-dirty-limit:
2257 # .. qmp-example::
2259 # -> {"execute": "query-vcpu-dirty-limit"}
2260 # <- {"return": [
2261 # { "limit-rate": 60, "current-rate": 3, "cpu-index": 0},
2262 # { "limit-rate": 60, "current-rate": 3, "cpu-index": 1}]}
2264 { 'command': 'query-vcpu-dirty-limit',
2274 # @thread-id: ID of the underlying host thread
2280 'thread-id': 'int'} }
2283 # @query-migrationthreads:
2295 { 'command': 'query-migrationthreads',
2300 # @snapshot-save:
2304 # @job-id: identifier for the newly created job
2326 # .. qmp-example::
2328 # -> { "execute": "snapshot-save",
2330 # "job-id": "snapsave0",
2331 # "tag": "my-snap",
2336 # <- { "return": { } }
2337 # <- {"event": "JOB_STATUS_CHANGE",
2340 # <- {"event": "JOB_STATUS_CHANGE",
2343 # <- {"event": "STOP",
2345 # <- {"event": "RESUME",
2347 # <- {"event": "JOB_STATUS_CHANGE",
2350 # <- {"event": "JOB_STATUS_CHANGE",
2353 # <- {"event": "JOB_STATUS_CHANGE",
2356 # -> {"execute": "query-jobs"}
2357 # <- {"return": [{"current-progress": 1,
2359 # "total-progress": 1,
2360 # "type": "snapshot-save",
2365 { 'command': 'snapshot-save',
2366 'data': { 'job-id': 'str',
2372 # @snapshot-load:
2376 # @job-id: identifier for the newly created job
2393 # device nodes that can have changed since the original @snapshot-save
2396 # .. qmp-example::
2398 # -> { "execute": "snapshot-load",
2400 # "job-id": "snapload0",
2401 # "tag": "my-snap",
2406 # <- { "return": { } }
2407 # <- {"event": "JOB_STATUS_CHANGE",
2410 # <- {"event": "JOB_STATUS_CHANGE",
2413 # <- {"event": "STOP",
2415 # <- {"event": "RESUME",
2417 # <- {"event": "JOB_STATUS_CHANGE",
2420 # <- {"event": "JOB_STATUS_CHANGE",
2423 # <- {"event": "JOB_STATUS_CHANGE",
2426 # -> {"execute": "query-jobs"}
2427 # <- {"return": [{"current-progress": 1,
2429 # "total-progress": 1,
2430 # "type": "snapshot-load",
2435 { 'command': 'snapshot-load',
2436 'data': { 'job-id': 'str',
2442 # @snapshot-delete:
2446 # @job-id: identifier for the newly created job
2457 # .. qmp-example::
2459 # -> { "execute": "snapshot-delete",
2461 # "job-id": "snapdelete0",
2462 # "tag": "my-snap",
2466 # <- { "return": { } }
2467 # <- {"event": "JOB_STATUS_CHANGE",
2470 # <- {"event": "JOB_STATUS_CHANGE",
2473 # <- {"event": "JOB_STATUS_CHANGE",
2476 # <- {"event": "JOB_STATUS_CHANGE",
2479 # <- {"event": "JOB_STATUS_CHANGE",
2482 # -> {"execute": "query-jobs"}
2483 # <- {"return": [{"current-progress": 1,
2485 # "total-progress": 1,
2486 # "type": "snapshot-delete",
2491 { 'command': 'snapshot-delete',
2492 'data': { 'job-id': 'str',