Lines Matching +full:- +full:- +full:disable +full:- +full:uuid
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.
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.
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.
159 # @pre-switchover: Paused before device serialisation. (since 2.11)
163 # pre-switchover capability is enabled. After 10.0, this state will
167 # @wait-unplug: wait for device unplug request by guest OS to be
174 'active', 'postcopy-active', 'postcopy-paused',
175 'postcopy-recover-setup',
176 'postcopy-recover', 'completed', 'failed', 'colo',
177 'pre-switchover', 'device', 'wait-unplug' ] }
203 # @xbzrle-cache: @XBZRLECacheStats containing detailed XBZRLE
207 # @total-time: total amount of milliseconds since migration started.
214 # @expected-downtime: only present while migration is active expected
218 # @setup-time: amount of setup time in milliseconds *before* the
224 # @cpu-throttle-percentage: percentage of time guest cpus are being
225 # throttled during auto-converge. This is only present when
226 # auto-converge has started throttling guest cpus. (Since 2.7)
228 # @error-desc: the human readable error description string. Clients
231 # @postcopy-blocktime: total time when all vCPU were blocked during
233 # postcopy-blocktime migration capability is enabled. (Since 3.0)
235 # @postcopy-vcpu-blocktime: list of the postcopy blocktime per vCPU.
236 # This is only present when the postcopy-blocktime migration
239 # @socket-address: Only used for tcp, to know what the real port is
247 # @blocked-reasons: A list of reasons an outgoing migration is
248 # blocked. Present and non-empty when migration is blocked.
251 # @dirty-limit-throttle-time-per-round: Maximum throttle time (in
253 # shows how MigrationCapability dirty-limit affects the guest
256 # @dirty-limit-ring-full-time: Estimated average dirty ring full time
268 '*xbzrle-cache': 'XBZRLECacheStats',
269 '*total-time': 'int',
270 '*expected-downtime': 'int',
272 '*setup-time': 'int',
273 '*cpu-throttle-percentage': 'int',
274 '*error-desc': 'str',
275 '*blocked-reasons': ['str'],
276 '*postcopy-blocktime': 'uint32',
277 '*postcopy-vcpu-blocktime': ['uint32'],
278 '*socket-address': ['SocketAddress'],
279 '*dirty-limit-throttle-time-per-round': 'uint64',
280 '*dirty-limit-ring-full-time': 'uint64'} }
283 # @query-migrate:
286 # is active there will be another json-object with RAM migration
293 # .. qmp-example::
296 # -> { "execute": "query-migrate" }
297 # <- { "return": {} }
299 # .. qmp-example::
302 # -> { "execute": "query-migrate" }
303 # <- { "return": {
305 # "total-time":12345,
306 # "setup-time":12345,
314 # "normal-bytes":123456,
315 # "dirty-sync-count":15
320 # .. qmp-example::
323 # -> { "execute": "query-migrate" }
324 # <- { "return": { "status": "failed" } }
326 # .. qmp-example::
329 # -> { "execute": "query-migrate" }
330 # <- {
333 # "total-time":12345,
334 # "setup-time":12345,
335 # "expected-downtime":12345,
342 # "normal-bytes":123456,
343 # "dirty-sync-count":15
348 # .. qmp-example::
351 # -> { "execute": "query-migrate" }
352 # <- {
355 # "total-time":12345,
356 # "setup-time":12345,
357 # "expected-downtime":12345,
364 # "normal-bytes":3412992,
365 # "dirty-sync-count":15
367 # "xbzrle-cache":{
368 # "cache-size":67108864,
371 # "cache-miss":2244,
372 # "cache-miss-rate":0.123,
373 # "encoding-rate":80.1,
379 { 'command': 'query-migrate', 'returns': 'MigrationInfo' }
391 # @rdma-pin-all: Controls whether or not the entire VM memory
395 # @zero-blocks: During storage migration encode blocks of zeroes
404 # @auto-converge: If enabled, QEMU will automatically throttle down
407 # @postcopy-ram: Start executing on the migration target before all of
413 # @x-colo: If enabled, migration will never end, and the state of the
415 # on secondary side, this process is called COarse-Grain LOck
416 # Stepping (COLO) for Non-stop Service. (since 2.8)
418 # @release-ram: if enabled, QEMU will free the migrated ram pages on
419 # the source during postcopy-ram migration. (since 2.9)
421 # @return-path: If enabled, migration will use the return path even
424 # @pause-before-switchover: Pause outgoing migration before
430 # @dirty-bitmaps: If enabled, QEMU will migrate named dirty bitmaps.
433 # @postcopy-blocktime: Calculate downtime for postcopy live migration
436 # @late-block-activate: If enabled, the destination will not activate
440 # @x-ignore-shared: If enabled, QEMU will not migrate shared memory
443 # @validate-uuid: Send the UUID of the source to allow the destination
446 # @background-snapshot: If enabled, the migration stream will be a
451 # @zero-copy-send: Controls behavior on sending memory pages on
452 # migration. When true, enables a zero-copy mechanism for sending
456 # @postcopy-preempt: If enabled, the migration process will allow
462 # @switchover-ack: If enabled, migration will not stop the source VM
469 # are present. 'return-path' capability must be enabled to use
472 # @dirty-limit: If enabled, migration will throttle vCPUs as needed to
473 # keep their dirty page rate within @vcpu-dirty-limit. This can
476 # with accelerator property "dirty-ring-size" set. (Since 8.1)
478 # @mapped-ram: Migrate using fixed offsets in the migration file for
484 # @unstable: Members @x-colo and @x-ignore-shared are experimental.
485 # @deprecated: Member @zero-blocks is deprecated as being part of
491 'data': ['xbzrle', 'rdma-pin-all', 'auto-converge',
492 { 'name': 'zero-blocks', 'features': [ 'deprecated' ] },
493 'events', 'postcopy-ram',
494 { 'name': 'x-colo', 'features': [ 'unstable' ] },
495 'release-ram',
496 'return-path', 'pause-before-switchover', 'multifd',
497 'dirty-bitmaps', 'postcopy-blocktime', 'late-block-activate',
498 { 'name': 'x-ignore-shared', 'features': [ 'unstable' ] },
499 'validate-uuid', 'background-snapshot',
500 'zero-copy-send', 'postcopy-preempt', 'switchover-ack',
501 'dirty-limit', 'mapped-ram'] }
518 # @migrate-set-capabilities:
520 # Enable/Disable the following migration capabilities (like xbzrle)
526 # .. qmp-example::
528 # -> { "execute": "migrate-set-capabilities" , "arguments":
530 # <- { "return": {} }
532 { 'command': 'migrate-set-capabilities',
536 # @query-migrate-capabilities:
544 # .. qmp-example::
546 # -> { "execute": "query-migrate-capabilities" }
547 # <- { "return": [
549 # {"state": false, "capability": "rdma-pin-all"},
550 # {"state": false, "capability": "auto-converge"},
551 # {"state": false, "capability": "zero-blocks"},
553 # {"state": false, "capability": "postcopy-ram"},
554 # {"state": false, "capability": "x-colo"}
557 { 'command': 'query-migrate-capabilities', 'returns': ['MigrationCapabilityStatus']}
574 # In-Memory Analytics Accelerator(IAA) accelerated compression and
594 # @cpr-reboot: The migrate command stops the VM and saves state to the
596 # -incoming.
608 # guest-suspend-ram to the QEMU guest agent.
611 # and the @x-ignore-shared migration capability is set, but this
616 # @cpr-reboot may not be used with postcopy, background-snapshot,
621 # @cpr-transfer: This mode allows the user to transfer a guest to a
629 # command-line arguments to create the same machine, plus the
630 # -incoming option for the main migration channel, like normal
631 # live migration. In addition, the user adds a second -incoming
644 # a migrate-incoming command. It may only be specified on the
651 # Memory-backend objects must have the share=on attribute, but
652 # memory-backend-epc is not supported. The VM must be started
653 # with the '-machine aux-ram-share=on' option.
655 # When using -incoming defer, you must issue the migrate command
663 'data': [ 'normal', 'cpr-reboot', 'cpr-transfer' ] }
720 # @node-name: A block node name.
731 'node-name': 'str',
741 # @announce-initial: Initial delay (in milliseconds) before sending
744 # @announce-max: Maximum delay (in milliseconds) between packets in
747 # @announce-rounds: Number of self-announce packets sent after
750 # @announce-step: Increase in delay (in milliseconds) between
753 # @throttle-trigger-threshold: The ratio of bytes_dirty_period and
757 # @cpu-throttle-initial: Initial percentage of time guest cpus are
758 # throttled when migration auto-converge is activated. The
761 # @cpu-throttle-increment: throttle percentage increase each time
762 # auto-converge detects that migration is not making progress.
765 # @cpu-throttle-tailslow: Make CPU throttling slower at tail stage.
767 # CPU percentage while the @cpu-throttle -increment is excessive
772 # specified by @cpu-throttle-increment and the one generated by
778 # @tls-creds: ID of the 'tls-creds' object that provides credentials
783 # non-empty string enables TLS for all migrations. An empty
787 # @tls-hostname: migration target's hostname for validating the
789 # hostname from the migration URI, if any. A non-empty value is
796 # @tls-authz: ID of the 'authz' object subclass that provides access
802 # @max-bandwidth: maximum speed for migration, in bytes per second.
805 # @avail-switchover-bandwidth: to set the available bandwidth that
816 # @downtime-limit: set maximum tolerated downtime for migration.
819 # @x-checkpoint-delay: The delay time (in ms) between two COLO
822 # @multifd-channels: Number of channels used to migrate data in
826 # @xbzrle-cache-size: cache size to be used by XBZRLE migration. It
830 # @max-postcopy-bandwidth: Background transfer bandwidth during
834 # @max-cpu-throttle: maximum cpu throttle percentage. Defaults to 99.
837 # @multifd-compression: Which compression method to use. Defaults to
840 # @multifd-zlib-level: Set the compression level to be used in live
846 # @multifd-qatzip-level: Set the compression level to be used in live
851 # @multifd-zstd-level: Set the compression level to be used in live
857 # @block-bitmap-mapping: Maps block nodes and bitmaps on them to
860 # The mapping must be one-to-one, but not necessarily complete: On
873 # @x-vcpu-dirty-limit-period: Periodic time (in milliseconds) of dirty
877 # @vcpu-dirty-limit: Dirtyrate limit (MB/s) during live migration.
883 # @zero-page-detection: Whether and how to detect zero pages.
887 # @direct-io: Open migration files with O_DIRECT when possible. This
888 # only has effect if the @mapped-ram capability is enabled.
893 # @unstable: Members @x-checkpoint-delay and
894 # @x-vcpu-dirty-limit-period are experimental.
899 'data': ['announce-initial', 'announce-max',
900 'announce-rounds', 'announce-step',
901 'throttle-trigger-threshold',
902 'cpu-throttle-initial', 'cpu-throttle-increment',
903 'cpu-throttle-tailslow',
904 'tls-creds', 'tls-hostname', 'tls-authz', 'max-bandwidth',
905 'avail-switchover-bandwidth', 'downtime-limit',
906 { 'name': 'x-checkpoint-delay', 'features': [ 'unstable' ] },
907 'multifd-channels',
908 'xbzrle-cache-size', 'max-postcopy-bandwidth',
909 'max-cpu-throttle', 'multifd-compression',
910 'multifd-zlib-level', 'multifd-zstd-level',
911 'multifd-qatzip-level',
912 'block-bitmap-mapping',
913 { 'name': 'x-vcpu-dirty-limit-period', 'features': ['unstable'] },
914 'vcpu-dirty-limit',
916 'zero-page-detection',
917 'direct-io'] }
922 # @announce-initial: Initial delay (in milliseconds) before sending
925 # @announce-max: Maximum delay (in milliseconds) between packets in
928 # @announce-rounds: Number of self-announce packets sent after
931 # @announce-step: Increase in delay (in milliseconds) between
934 # @throttle-trigger-threshold: The ratio of bytes_dirty_period and
938 # @cpu-throttle-initial: Initial percentage of time guest cpus are
939 # throttled when migration auto-converge is activated. The
942 # @cpu-throttle-increment: throttle percentage increase each time
943 # auto-converge detects that migration is not making progress.
946 # @cpu-throttle-tailslow: Make CPU throttling slower at tail stage.
948 # CPU percentage while the @cpu-throttle -increment is excessive
953 # specified by @cpu-throttle-increment and the one generated by
959 # @tls-creds: ID of the 'tls-creds' object that provides credentials
964 # non-empty string enables TLS for all migrations. An empty
968 # @tls-hostname: migration target's hostname for validating the
970 # hostname from the migration URI, if any. A non-empty value is
977 # @tls-authz: ID of the 'authz' object subclass that provides access
983 # @max-bandwidth: maximum speed for migration, in bytes per second.
986 # @avail-switchover-bandwidth: to set the available bandwidth that
997 # @downtime-limit: set maximum tolerated downtime for migration.
1000 # @x-checkpoint-delay: The delay time (in ms) between two COLO
1003 # @multifd-channels: Number of channels used to migrate data in
1007 # @xbzrle-cache-size: cache size to be used by XBZRLE migration. It
1011 # @max-postcopy-bandwidth: Background transfer bandwidth during
1015 # @max-cpu-throttle: maximum cpu throttle percentage. Defaults to 99.
1018 # @multifd-compression: Which compression method to use. Defaults to
1021 # @multifd-zlib-level: Set the compression level to be used in live
1027 # @multifd-qatzip-level: Set the compression level to be used in live
1032 # @multifd-zstd-level: Set the compression level to be used in live
1038 # @block-bitmap-mapping: Maps block nodes and bitmaps on them to
1041 # The mapping must be one-to-one, but not necessarily complete: On
1054 # @x-vcpu-dirty-limit-period: Periodic time (in milliseconds) of dirty
1058 # @vcpu-dirty-limit: Dirtyrate limit (MB/s) during live migration.
1064 # @zero-page-detection: Whether and how to detect zero pages.
1068 # @direct-io: Open migration files with O_DIRECT when possible. This
1069 # only has effect if the @mapped-ram capability is enabled.
1074 # @unstable: Members @x-checkpoint-delay and
1075 # @x-vcpu-dirty-limit-period are experimental.
1083 'data': { '*announce-initial': 'size',
1084 '*announce-max': 'size',
1085 '*announce-rounds': 'size',
1086 '*announce-step': 'size',
1087 '*throttle-trigger-threshold': 'uint8',
1088 '*cpu-throttle-initial': 'uint8',
1089 '*cpu-throttle-increment': 'uint8',
1090 '*cpu-throttle-tailslow': 'bool',
1091 '*tls-creds': 'StrOrNull',
1092 '*tls-hostname': 'StrOrNull',
1093 '*tls-authz': 'StrOrNull',
1094 '*max-bandwidth': 'size',
1095 '*avail-switchover-bandwidth': 'size',
1096 '*downtime-limit': 'uint64',
1097 '*x-checkpoint-delay': { 'type': 'uint32',
1099 '*multifd-channels': 'uint8',
1100 '*xbzrle-cache-size': 'size',
1101 '*max-postcopy-bandwidth': 'size',
1102 '*max-cpu-throttle': 'uint8',
1103 '*multifd-compression': 'MultiFDCompression',
1104 '*multifd-zlib-level': 'uint8',
1105 '*multifd-qatzip-level': 'uint8',
1106 '*multifd-zstd-level': 'uint8',
1107 '*block-bitmap-mapping': [ 'BitmapMigrationNodeAlias' ],
1108 '*x-vcpu-dirty-limit-period': { 'type': 'uint64',
1110 '*vcpu-dirty-limit': 'uint64',
1112 '*zero-page-detection': 'ZeroPageDetection',
1113 '*direct-io': 'bool' } }
1116 # @migrate-set-parameters:
1122 # .. qmp-example::
1124 # -> { "execute": "migrate-set-parameters" ,
1125 # "arguments": { "multifd-channels": 5 } }
1126 # <- { "return": {} }
1128 { 'command': 'migrate-set-parameters', 'boxed': true,
1136 # @announce-initial: Initial delay (in milliseconds) before sending
1139 # @announce-max: Maximum delay (in milliseconds) between packets in
1142 # @announce-rounds: Number of self-announce packets sent after
1145 # @announce-step: Increase in delay (in milliseconds) between
1148 # @throttle-trigger-threshold: The ratio of bytes_dirty_period and
1152 # @cpu-throttle-initial: Initial percentage of time guest cpus are
1153 # throttled when migration auto-converge is activated.
1156 # @cpu-throttle-increment: throttle percentage increase each time
1157 # auto-converge detects that migration is not making progress.
1160 # @cpu-throttle-tailslow: Make CPU throttling slower at tail stage.
1162 # CPU percentage while the @cpu-throttle -increment is excessive
1167 # specified by @cpu-throttle-increment and the one generated by
1173 # @tls-creds: ID of the 'tls-creds' object that provides credentials
1181 # Note: 2.8 omits empty @tls-creds instead.
1183 # @tls-hostname: migration target's hostname for validating the
1187 # Note: 2.8 omits empty @tls-hostname instead.
1189 # @tls-authz: ID of the 'authz' object subclass that provides access
1193 # @max-bandwidth: maximum speed for migration, in bytes per second.
1196 # @avail-switchover-bandwidth: to set the available bandwidth that
1207 # @downtime-limit: set maximum tolerated downtime for migration.
1210 # @x-checkpoint-delay: the delay time between two COLO checkpoints.
1213 # @multifd-channels: Number of channels used to migrate data in
1217 # @xbzrle-cache-size: cache size to be used by XBZRLE migration. It
1221 # @max-postcopy-bandwidth: Background transfer bandwidth during
1225 # @max-cpu-throttle: maximum cpu throttle percentage. Defaults to 99.
1228 # @multifd-compression: Which compression method to use. Defaults to
1231 # @multifd-zlib-level: Set the compression level to be used in live
1237 # @multifd-qatzip-level: Set the compression level to be used in live
1242 # @multifd-zstd-level: Set the compression level to be used in live
1248 # @block-bitmap-mapping: Maps block nodes and bitmaps on them to
1251 # The mapping must be one-to-one, but not necessarily complete: On
1264 # @x-vcpu-dirty-limit-period: Periodic time (in milliseconds) of dirty
1268 # @vcpu-dirty-limit: Dirtyrate limit (MB/s) during live migration.
1274 # @zero-page-detection: Whether and how to detect zero pages.
1278 # @direct-io: Open migration files with O_DIRECT when possible. This
1279 # only has effect if the @mapped-ram capability is enabled.
1284 # @unstable: Members @x-checkpoint-delay and
1285 # @x-vcpu-dirty-limit-period are experimental.
1290 'data': { '*announce-initial': 'size',
1291 '*announce-max': 'size',
1292 '*announce-rounds': 'size',
1293 '*announce-step': 'size',
1294 '*throttle-trigger-threshold': 'uint8',
1295 '*cpu-throttle-initial': 'uint8',
1296 '*cpu-throttle-increment': 'uint8',
1297 '*cpu-throttle-tailslow': 'bool',
1298 '*tls-creds': 'str',
1299 '*tls-hostname': 'str',
1300 '*tls-authz': 'str',
1301 '*max-bandwidth': 'size',
1302 '*avail-switchover-bandwidth': 'size',
1303 '*downtime-limit': 'uint64',
1304 '*x-checkpoint-delay': { 'type': 'uint32',
1306 '*multifd-channels': 'uint8',
1307 '*xbzrle-cache-size': 'size',
1308 '*max-postcopy-bandwidth': 'size',
1309 '*max-cpu-throttle': 'uint8',
1310 '*multifd-compression': 'MultiFDCompression',
1311 '*multifd-zlib-level': 'uint8',
1312 '*multifd-qatzip-level': 'uint8',
1313 '*multifd-zstd-level': 'uint8',
1314 '*block-bitmap-mapping': [ 'BitmapMigrationNodeAlias' ],
1315 '*x-vcpu-dirty-limit-period': { 'type': 'uint64',
1317 '*vcpu-dirty-limit': 'uint64',
1319 '*zero-page-detection': 'ZeroPageDetection',
1320 '*direct-io': 'bool' } }
1323 # @query-migrate-parameters:
1331 # .. qmp-example::
1333 # -> { "execute": "query-migrate-parameters" }
1334 # <- { "return": {
1335 # "multifd-channels": 2,
1336 # "cpu-throttle-increment": 10,
1337 # "cpu-throttle-initial": 20,
1338 # "max-bandwidth": 33554432,
1339 # "downtime-limit": 300
1343 { 'command': 'query-migrate-parameters',
1347 # @migrate-start-postcopy:
1350 # mode. The postcopy-ram capability must be set on both source and
1355 # .. qmp-example::
1357 # -> { "execute": "migrate-start-postcopy" }
1358 # <- { "return": {} }
1360 { 'command': 'migrate-start-postcopy' }
1371 # .. qmp-example::
1373 # <- {"timestamp": {"seconds": 1432121972, "microseconds": 744001},
1390 # .. qmp-example::
1392 # <- { "timestamp": {"seconds": 1449669631, "microseconds": 239225},
1403 # @checkpoint-ready: Secondary VM (SVM) is ready for checkpointing
1405 # @checkpoint-request: Primary VM (PVM) tells SVM to prepare for
1408 # @checkpoint-reply: SVM gets PVM's checkpoint request
1410 # @vmstate-send: VM's state will be sent by PVM.
1412 # @vmstate-size: The total size of VMstate.
1414 # @vmstate-received: VM's state has been received by SVM.
1416 # @vmstate-loaded: VM's state has been loaded by SVM.
1421 'data': [ 'checkpoint-ready', 'checkpoint-request', 'checkpoint-reply',
1422 'vmstate-send', 'vmstate-size', 'vmstate-received',
1423 'vmstate-loaded' ] }
1454 # @relaunch: restart the failover process, from 'none' -> 'completed'
1474 # .. qmp-example::
1476 # <- { "timestamp": {"seconds": 2032141960, "microseconds": 417172},
1489 # query-colo-status.
1503 # @x-colo-lost-heartbeat:
1517 # .. qmp-example::
1519 # -> { "execute": "x-colo-lost-heartbeat" }
1520 # <- { "return": {} }
1522 { 'command': 'x-colo-lost-heartbeat',
1530 # migration to be started right after. When postcopy-ram is in use,
1538 # .. qmp-example::
1540 # -> { "execute": "migrate_cancel" }
1541 # <- { "return": {} }
1546 # @migrate-continue:
1554 # .. qmp-example::
1556 # -> { "execute": "migrate-continue" , "arguments":
1557 # { "state": "pre-switchover" } }
1558 # <- { "return": {} }
1560 { 'command': 'migrate-continue', 'data': {'state': 'MigrationStatus'} }
1624 # The migration channel-type request options.
1639 # @channel-type: Channel type for transferring packet information.
1647 'channel-type': 'MigrationChannelType',
1673 # 1. The 'query-migrate' command should be used to check
1687 # .. qmp-example::
1689 # -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
1690 # <- { "return": {} }
1692 # -> { "execute": "migrate",
1694 # "channels": [ { "channel-type": "main",
1699 # <- { "return": {} }
1701 # -> { "execute": "migrate",
1703 # "channels": [ { "channel-type": "main",
1705 # "args": [ "/bin/nc", "-p", "6000",
1707 # <- { "return": {} }
1709 # -> { "execute": "migrate",
1711 # "channels": [ { "channel-type": "main",
1715 # <- { "return": {} }
1717 # -> { "execute": "migrate",
1719 # "channels": [ { "channel-type": "main",
1723 # <- { "return": {} }
1732 # @migrate-incoming:
1735 # -incoming defer.
1743 # @exit-on-error: Exit on incoming migration failure. Default true.
1745 # error details could be retrieved with query-migrate.
1753 # stay compatible with -incoming and the format of the uri is
1756 # 2. QEMU must be started with -incoming defer to allow
1757 # migrate-incoming to be used.
1759 # 3. The uri format is the same as for -incoming
1767 # .. qmp-example::
1769 # -> { "execute": "migrate-incoming",
1771 # <- { "return": {} }
1773 # -> { "execute": "migrate-incoming",
1775 # "channels": [ { "channel-type": "main",
1780 # <- { "return": {} }
1782 # -> { "execute": "migrate-incoming",
1784 # "channels": [ { "channel-type": "main",
1786 # "args": [ "/bin/nc", "-p", "6000",
1788 # <- { "return": {} }
1790 # -> { "execute": "migrate-incoming",
1792 # "channels": [ { "channel-type": "main",
1796 # <- { "return": {} }
1798 { 'command': 'migrate-incoming',
1801 '*exit-on-error': 'bool' } }
1804 # @xen-save-devices-state:
1810 # data. See xen-save-devices-state.txt for a description of the
1818 # .. qmp-example::
1820 # -> { "execute": "xen-save-devices-state",
1822 # <- { "return": {} }
1824 { 'command': 'xen-save-devices-state',
1828 # @xen-set-global-dirty-log:
1830 # Enable or disable the global dirty log mode.
1832 # @enable: true to enable, false to disable.
1836 # .. qmp-example::
1838 # -> { "execute": "xen-set-global-dirty-log",
1840 # <- { "return": {} }
1842 { 'command': 'xen-set-global-dirty-log', 'data': { 'enable': 'bool' } }
1845 # @xen-load-devices-state:
1851 # data. See xen-save-devices-state.txt for a description of the
1856 # .. qmp-example::
1858 # -> { "execute": "xen-load-devices-state",
1860 # <- { "return": {} }
1862 { 'command': 'xen-load-devices-state', 'data': {'filename': 'str'} }
1865 # @xen-set-replication:
1867 # Enable or disable replication.
1869 # @enable: true to enable, false to disable.
1876 # .. qmp-example::
1878 # -> { "execute": "xen-set-replication",
1880 # <- { "return": {} }
1884 { 'command': 'xen-set-replication',
1891 # The result format for 'query-xen-replication-status'.
1905 # @query-xen-replication-status:
1911 # .. qmp-example::
1913 # -> { "execute": "query-xen-replication-status" }
1914 # <- { "return": { "error": false } }
1918 { 'command': 'query-xen-replication-status',
1923 # @xen-colo-do-checkpoint:
1927 # .. qmp-example::
1929 # -> { "execute": "xen-colo-do-checkpoint" }
1930 # <- { "return": {} }
1934 { 'command': 'xen-colo-do-checkpoint',
1940 # The result format for 'query-colo-status'.
1945 # @last-mode: COLO last running mode. If COLO is running, this field
1954 'data': { 'mode': 'COLOMode', 'last-mode': 'COLOMode',
1959 # @query-colo-status:
1965 # .. qmp-example::
1967 # -> { "execute": "query-colo-status" }
1968 # <- { "return": { "mode": "primary", "last-mode": "none", "reason": "request" } }
1972 { 'command': 'query-colo-status',
1977 # @migrate-recover:
1983 # .. qmp-example::
1985 # -> { "execute": "migrate-recover",
1987 # <- { "return": {} }
1991 { 'command': 'migrate-recover',
1993 'allow-oob': true }
1996 # @migrate-pause:
2000 # .. qmp-example::
2002 # -> { "execute": "migrate-pause" }
2003 # <- { "return": {} }
2007 { 'command': 'migrate-pause', 'allow-oob': true }
2014 # Device resources in QEMU are kept on standby to be able to re-plug
2017 # @device-id: QEMU device id of the unplugged device
2021 # .. qmp-example::
2023 # <- { "event": "UNPLUG_PRIMARY",
2024 # "data": { "device-id": "hostdev0" },
2028 'data': { 'device-id': 'str' } }
2037 # @dirty-rate: dirty rate.
2042 'data': { 'id': 'int', 'dirty-rate': 'int64' } }
2064 # available methods are explained in @calc-dirty-rate.
2066 # @page-sampling: use page sampling
2068 # @dirty-ring: use dirty ring
2070 # @dirty-bitmap: use dirty bitmap
2075 'data': ['page-sampling', 'dirty-ring', 'dirty-bitmap'] }
2080 # Specifies unit in which time-related value is specified.
2096 # @dirty-rate: an estimate of the dirty page rate of the VM in units
2101 # @start-time: start time in units of second for calculation
2103 # @calc-time: time period for which dirty page rate was measured,
2104 # expressed and rounded down to @calc-time-unit.
2106 # @calc-time-unit: time unit of @calc-time (Since 8.2)
2108 # @sample-pages: number of sampled pages per GiB of guest memory.
2109 # Valid only in page-sampling mode (Since 6.1)
2113 # @vcpu-dirty-rate: dirty rate for each vCPU if dirty-ring mode was
2119 'data': {'*dirty-rate': 'int64',
2121 'start-time': 'int64',
2122 'calc-time': 'int64',
2123 'calc-time-unit': 'TimeUnit',
2124 'sample-pages': 'uint64',
2126 '*vcpu-dirty-rate': [ 'DirtyRateVcpu' ] } }
2129 # @calc-dirty-rate:
2132 # with @query-dirty-rate after measurements are completed.
2143 # only an estimate of its true value. Increasing @sample-pages
2151 # requires that KVM accelerator property "dirty-ring-size" is *not*
2157 # requires that KVM accelerator property "dirty-ring-size" is set.
2159 # @calc-time: time period for which dirty page rate is calculated. By
2161 # explicitly with @calc-time-unit. Note that larger @calc-time
2163 # page dirtying is a one-time event. Once some page is counted as
2164 # dirty during @calc-time period, further writes to this page will
2167 # @calc-time-unit: time unit in which @calc-time is specified. By
2170 # @sample-pages: number of sampled pages per each GiB of guest memory.
2176 # 'page-sampling'. Others are 'dirty-bitmap' and 'dirty-ring'.
2181 # .. qmp-example::
2183 # -> {"execute": "calc-dirty-rate", "arguments": {"calc-time": 1,
2184 # "sample-pages": 512} }
2185 # <- { "return": {} }
2187 # .. qmp-example::
2192 # -> {"execute": "calc-dirty-rate", "arguments": {"calc-time": 500,
2193 # "calc-time-unit": "millisecond", "mode": "dirty-bitmap"} }
2195 # <- { "return": {} }
2197 { 'command': 'calc-dirty-rate', 'data': {'calc-time': 'int64',
2198 '*calc-time-unit': 'TimeUnit',
2199 '*sample-pages': 'int',
2203 # @query-dirty-rate:
2205 # Query results of the most recent invocation of @calc-dirty-rate.
2207 # @calc-time-unit: time unit in which to report calculation time.
2212 # .. qmp-example::
2215 # <- {"status": "measuring", "sample-pages": 512,
2216 # "mode": "page-sampling", "start-time": 1693900454, "calc-time": 10,
2217 # "calc-time-unit": "second"}
2219 # .. qmp-example::
2222 # <- {"status": "measured", "sample-pages": 512, "dirty-rate": 108,
2223 # "mode": "page-sampling", "start-time": 1693900454, "calc-time": 10,
2224 # "calc-time-unit": "second"}
2226 { 'command': 'query-dirty-rate', 'data': {'*calc-time-unit': 'TimeUnit' },
2234 # @cpu-index: index of a virtual CPU.
2236 # @limit-rate: upper limit of dirty page rate (MB/s) for a virtual
2239 # @current-rate: current dirty page rate (MB/s) for a virtual CPU.
2244 'data': { 'cpu-index': 'int',
2245 'limit-rate': 'uint64',
2246 'current-rate': 'uint64' } }
2249 # @set-vcpu-dirty-limit:
2253 # Requires KVM with accelerator property "dirty-ring-size" set. A
2255 # observe dirty page rates, use @calc-dirty-rate.
2257 # @cpu-index: index of a virtual CPU, default is all.
2259 # @dirty-rate: upper limit of dirty page rate (MB/s) for virtual CPUs.
2263 # .. qmp-example::
2265 # -> {"execute": "set-vcpu-dirty-limit"}
2266 # "arguments": { "dirty-rate": 200,
2267 # "cpu-index": 1 } }
2268 # <- { "return": {} }
2270 { 'command': 'set-vcpu-dirty-limit',
2271 'data': { '*cpu-index': 'int',
2272 'dirty-rate': 'uint64' } }
2275 # @cancel-vcpu-dirty-limit:
2280 # set-vcpu-dirty-limit command. Note that this command requires
2281 # support from dirty ring, same as the "set-vcpu-dirty-limit".
2283 # @cpu-index: index of a virtual CPU, default is all.
2287 # .. qmp-example::
2289 # -> {"execute": "cancel-vcpu-dirty-limit"},
2290 # "arguments": { "cpu-index": 1 } }
2291 # <- { "return": {} }
2293 { 'command': 'cancel-vcpu-dirty-limit',
2294 'data': { '*cpu-index': 'int'} }
2297 # @query-vcpu-dirty-limit:
2304 # .. qmp-example::
2306 # -> {"execute": "query-vcpu-dirty-limit"}
2307 # <- {"return": [
2308 # { "limit-rate": 60, "current-rate": 3, "cpu-index": 0},
2309 # { "limit-rate": 60, "current-rate": 3, "cpu-index": 1}]}
2311 { 'command': 'query-vcpu-dirty-limit',
2321 # @thread-id: ID of the underlying host thread
2327 'thread-id': 'int'} }
2330 # @query-migrationthreads:
2342 { 'command': 'query-migrationthreads',
2347 # @snapshot-save:
2351 # @job-id: identifier for the newly created job
2373 # .. qmp-example::
2375 # -> { "execute": "snapshot-save",
2377 # "job-id": "snapsave0",
2378 # "tag": "my-snap",
2383 # <- { "return": { } }
2384 # <- {"event": "JOB_STATUS_CHANGE",
2387 # <- {"event": "JOB_STATUS_CHANGE",
2390 # <- {"event": "STOP",
2392 # <- {"event": "RESUME",
2394 # <- {"event": "JOB_STATUS_CHANGE",
2397 # <- {"event": "JOB_STATUS_CHANGE",
2400 # <- {"event": "JOB_STATUS_CHANGE",
2403 # -> {"execute": "query-jobs"}
2404 # <- {"return": [{"current-progress": 1,
2406 # "total-progress": 1,
2407 # "type": "snapshot-save",
2412 { 'command': 'snapshot-save',
2413 'data': { 'job-id': 'str',
2419 # @snapshot-load:
2423 # @job-id: identifier for the newly created job
2440 # device nodes that can have changed since the original @snapshot-save
2443 # .. qmp-example::
2445 # -> { "execute": "snapshot-load",
2447 # "job-id": "snapload0",
2448 # "tag": "my-snap",
2453 # <- { "return": { } }
2454 # <- {"event": "JOB_STATUS_CHANGE",
2457 # <- {"event": "JOB_STATUS_CHANGE",
2460 # <- {"event": "STOP",
2462 # <- {"event": "RESUME",
2464 # <- {"event": "JOB_STATUS_CHANGE",
2467 # <- {"event": "JOB_STATUS_CHANGE",
2470 # <- {"event": "JOB_STATUS_CHANGE",
2473 # -> {"execute": "query-jobs"}
2474 # <- {"return": [{"current-progress": 1,
2476 # "total-progress": 1,
2477 # "type": "snapshot-load",
2482 { 'command': 'snapshot-load',
2483 'data': { 'job-id': 'str',
2489 # @snapshot-delete:
2493 # @job-id: identifier for the newly created job
2504 # .. qmp-example::
2506 # -> { "execute": "snapshot-delete",
2508 # "job-id": "snapdelete0",
2509 # "tag": "my-snap",
2513 # <- { "return": { } }
2514 # <- {"event": "JOB_STATUS_CHANGE",
2517 # <- {"event": "JOB_STATUS_CHANGE",
2520 # <- {"event": "JOB_STATUS_CHANGE",
2523 # <- {"event": "JOB_STATUS_CHANGE",
2526 # <- {"event": "JOB_STATUS_CHANGE",
2529 # -> {"execute": "query-jobs"}
2530 # <- {"return": [{"current-progress": 1,
2532 # "total-progress": 1,
2533 # "type": "snapshot-delete",
2538 { 'command': 'snapshot-delete',
2539 'data': { 'job-id': 'str',