Lines Matching +full:- +full:- +full:disable +full:- +full:zstd
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']}
568 # @zstd: use zstd compression method.
574 # In-Memory Analytics Accelerator(IAA) accelerated compression and
584 { 'name': 'zstd', 'if': 'CONFIG_ZSTD' },
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
627 # command-line arguments to create the same machine, plus the
628 # -incoming option for the main migration channel, like normal
629 # live migration. In addition, the user adds a second -incoming
642 # a migrate-incoming command. It may only be specified on the
649 # Memory-backend objects must have the share=on attribute, but
650 # memory-backend-epc is not supported. The VM must be started
651 # with the '-machine aux-ram-share=on' option.
653 # When using -incoming defer, you must issue the migrate command
661 'data': [ 'normal', 'cpr-reboot', 'cpr-transfer' ] }
718 # @node-name: A block node name.
729 'node-name': 'str',
739 # @announce-initial: Initial delay (in milliseconds) before sending
742 # @announce-max: Maximum delay (in milliseconds) between packets in
745 # @announce-rounds: Number of self-announce packets sent after
748 # @announce-step: Increase in delay (in milliseconds) between
751 # @throttle-trigger-threshold: The ratio of bytes_dirty_period and
755 # @cpu-throttle-initial: Initial percentage of time guest cpus are
756 # throttled when migration auto-converge is activated. The
759 # @cpu-throttle-increment: throttle percentage increase each time
760 # auto-converge detects that migration is not making progress.
763 # @cpu-throttle-tailslow: Make CPU throttling slower at tail stage.
765 # CPU percentage while the @cpu-throttle -increment is excessive
770 # specified by @cpu-throttle-increment and the one generated by
776 # @tls-creds: ID of the 'tls-creds' object that provides credentials
781 # non-empty string enables TLS for all migrations. An empty
785 # @tls-hostname: migration target's hostname for validating the
787 # hostname from the migration URI, if any. A non-empty value is
794 # @tls-authz: ID of the 'authz' object subclass that provides access
800 # @max-bandwidth: maximum speed for migration, in bytes per second.
803 # @avail-switchover-bandwidth: to set the available bandwidth that
814 # @downtime-limit: set maximum tolerated downtime for migration.
817 # @x-checkpoint-delay: The delay time (in ms) between two COLO
820 # @multifd-channels: Number of channels used to migrate data in
824 # @xbzrle-cache-size: cache size to be used by XBZRLE migration. It
828 # @max-postcopy-bandwidth: Background transfer bandwidth during
832 # @max-cpu-throttle: maximum cpu throttle percentage. Defaults to 99.
835 # @multifd-compression: Which compression method to use. Defaults to
838 # @multifd-zlib-level: Set the compression level to be used in live
844 # @multifd-qatzip-level: Set the compression level to be used in live
849 # @multifd-zstd-level: Set the compression level to be used in live
855 # @block-bitmap-mapping: Maps block nodes and bitmaps on them to
858 # The mapping must be one-to-one, but not necessarily complete: On
871 # @x-vcpu-dirty-limit-period: Periodic time (in milliseconds) of dirty
875 # @vcpu-dirty-limit: Dirtyrate limit (MB/s) during live migration.
881 # @zero-page-detection: Whether and how to detect zero pages.
885 # @direct-io: Open migration files with O_DIRECT when possible. This
886 # only has effect if the @mapped-ram capability is enabled.
891 # @unstable: Members @x-checkpoint-delay and
892 # @x-vcpu-dirty-limit-period are experimental.
897 'data': ['announce-initial', 'announce-max',
898 'announce-rounds', 'announce-step',
899 'throttle-trigger-threshold',
900 'cpu-throttle-initial', 'cpu-throttle-increment',
901 'cpu-throttle-tailslow',
902 'tls-creds', 'tls-hostname', 'tls-authz', 'max-bandwidth',
903 'avail-switchover-bandwidth', 'downtime-limit',
904 { 'name': 'x-checkpoint-delay', 'features': [ 'unstable' ] },
905 'multifd-channels',
906 'xbzrle-cache-size', 'max-postcopy-bandwidth',
907 'max-cpu-throttle', 'multifd-compression',
908 'multifd-zlib-level', 'multifd-zstd-level',
909 'multifd-qatzip-level',
910 'block-bitmap-mapping',
911 { 'name': 'x-vcpu-dirty-limit-period', 'features': ['unstable'] },
912 'vcpu-dirty-limit',
914 'zero-page-detection',
915 'direct-io'] }
920 # @announce-initial: Initial delay (in milliseconds) before sending
923 # @announce-max: Maximum delay (in milliseconds) between packets in
926 # @announce-rounds: Number of self-announce packets sent after
929 # @announce-step: Increase in delay (in milliseconds) between
932 # @throttle-trigger-threshold: The ratio of bytes_dirty_period and
936 # @cpu-throttle-initial: Initial percentage of time guest cpus are
937 # throttled when migration auto-converge is activated. The
940 # @cpu-throttle-increment: throttle percentage increase each time
941 # auto-converge detects that migration is not making progress.
944 # @cpu-throttle-tailslow: Make CPU throttling slower at tail stage.
946 # CPU percentage while the @cpu-throttle -increment is excessive
951 # specified by @cpu-throttle-increment and the one generated by
957 # @tls-creds: ID of the 'tls-creds' object that provides credentials
962 # non-empty string enables TLS for all migrations. An empty
966 # @tls-hostname: migration target's hostname for validating the
968 # hostname from the migration URI, if any. A non-empty value is
975 # @tls-authz: ID of the 'authz' object subclass that provides access
981 # @max-bandwidth: maximum speed for migration, in bytes per second.
984 # @avail-switchover-bandwidth: to set the available bandwidth that
995 # @downtime-limit: set maximum tolerated downtime for migration.
998 # @x-checkpoint-delay: The delay time (in ms) between two COLO
1001 # @multifd-channels: Number of channels used to migrate data in
1005 # @xbzrle-cache-size: cache size to be used by XBZRLE migration. It
1009 # @max-postcopy-bandwidth: Background transfer bandwidth during
1013 # @max-cpu-throttle: maximum cpu throttle percentage. Defaults to 99.
1016 # @multifd-compression: Which compression method to use. Defaults to
1019 # @multifd-zlib-level: Set the compression level to be used in live
1025 # @multifd-qatzip-level: Set the compression level to be used in live
1030 # @multifd-zstd-level: Set the compression level to be used in live
1036 # @block-bitmap-mapping: Maps block nodes and bitmaps on them to
1039 # The mapping must be one-to-one, but not necessarily complete: On
1052 # @x-vcpu-dirty-limit-period: Periodic time (in milliseconds) of dirty
1056 # @vcpu-dirty-limit: Dirtyrate limit (MB/s) during live migration.
1062 # @zero-page-detection: Whether and how to detect zero pages.
1066 # @direct-io: Open migration files with O_DIRECT when possible. This
1067 # only has effect if the @mapped-ram capability is enabled.
1072 # @unstable: Members @x-checkpoint-delay and
1073 # @x-vcpu-dirty-limit-period are experimental.
1081 'data': { '*announce-initial': 'size',
1082 '*announce-max': 'size',
1083 '*announce-rounds': 'size',
1084 '*announce-step': 'size',
1085 '*throttle-trigger-threshold': 'uint8',
1086 '*cpu-throttle-initial': 'uint8',
1087 '*cpu-throttle-increment': 'uint8',
1088 '*cpu-throttle-tailslow': 'bool',
1089 '*tls-creds': 'StrOrNull',
1090 '*tls-hostname': 'StrOrNull',
1091 '*tls-authz': 'StrOrNull',
1092 '*max-bandwidth': 'size',
1093 '*avail-switchover-bandwidth': 'size',
1094 '*downtime-limit': 'uint64',
1095 '*x-checkpoint-delay': { 'type': 'uint32',
1097 '*multifd-channels': 'uint8',
1098 '*xbzrle-cache-size': 'size',
1099 '*max-postcopy-bandwidth': 'size',
1100 '*max-cpu-throttle': 'uint8',
1101 '*multifd-compression': 'MultiFDCompression',
1102 '*multifd-zlib-level': 'uint8',
1103 '*multifd-qatzip-level': 'uint8',
1104 '*multifd-zstd-level': 'uint8',
1105 '*block-bitmap-mapping': [ 'BitmapMigrationNodeAlias' ],
1106 '*x-vcpu-dirty-limit-period': { 'type': 'uint64',
1108 '*vcpu-dirty-limit': 'uint64',
1110 '*zero-page-detection': 'ZeroPageDetection',
1111 '*direct-io': 'bool' } }
1114 # @migrate-set-parameters:
1120 # .. qmp-example::
1122 # -> { "execute": "migrate-set-parameters" ,
1123 # "arguments": { "multifd-channels": 5 } }
1124 # <- { "return": {} }
1126 { 'command': 'migrate-set-parameters', 'boxed': true,
1134 # @announce-initial: Initial delay (in milliseconds) before sending
1137 # @announce-max: Maximum delay (in milliseconds) between packets in
1140 # @announce-rounds: Number of self-announce packets sent after
1143 # @announce-step: Increase in delay (in milliseconds) between
1146 # @throttle-trigger-threshold: The ratio of bytes_dirty_period and
1150 # @cpu-throttle-initial: Initial percentage of time guest cpus are
1151 # throttled when migration auto-converge is activated.
1154 # @cpu-throttle-increment: throttle percentage increase each time
1155 # auto-converge detects that migration is not making progress.
1158 # @cpu-throttle-tailslow: Make CPU throttling slower at tail stage.
1160 # CPU percentage while the @cpu-throttle -increment is excessive
1165 # specified by @cpu-throttle-increment and the one generated by
1171 # @tls-creds: ID of the 'tls-creds' object that provides credentials
1179 # Note: 2.8 omits empty @tls-creds instead.
1181 # @tls-hostname: migration target's hostname for validating the
1185 # Note: 2.8 omits empty @tls-hostname instead.
1187 # @tls-authz: ID of the 'authz' object subclass that provides access
1191 # @max-bandwidth: maximum speed for migration, in bytes per second.
1194 # @avail-switchover-bandwidth: to set the available bandwidth that
1205 # @downtime-limit: set maximum tolerated downtime for migration.
1208 # @x-checkpoint-delay: the delay time between two COLO checkpoints.
1211 # @multifd-channels: Number of channels used to migrate data in
1215 # @xbzrle-cache-size: cache size to be used by XBZRLE migration. It
1219 # @max-postcopy-bandwidth: Background transfer bandwidth during
1223 # @max-cpu-throttle: maximum cpu throttle percentage. Defaults to 99.
1226 # @multifd-compression: Which compression method to use. Defaults to
1229 # @multifd-zlib-level: Set the compression level to be used in live
1235 # @multifd-qatzip-level: Set the compression level to be used in live
1240 # @multifd-zstd-level: Set the compression level to be used in live
1246 # @block-bitmap-mapping: Maps block nodes and bitmaps on them to
1249 # The mapping must be one-to-one, but not necessarily complete: On
1262 # @x-vcpu-dirty-limit-period: Periodic time (in milliseconds) of dirty
1266 # @vcpu-dirty-limit: Dirtyrate limit (MB/s) during live migration.
1272 # @zero-page-detection: Whether and how to detect zero pages.
1276 # @direct-io: Open migration files with O_DIRECT when possible. This
1277 # only has effect if the @mapped-ram capability is enabled.
1282 # @unstable: Members @x-checkpoint-delay and
1283 # @x-vcpu-dirty-limit-period are experimental.
1288 'data': { '*announce-initial': 'size',
1289 '*announce-max': 'size',
1290 '*announce-rounds': 'size',
1291 '*announce-step': 'size',
1292 '*throttle-trigger-threshold': 'uint8',
1293 '*cpu-throttle-initial': 'uint8',
1294 '*cpu-throttle-increment': 'uint8',
1295 '*cpu-throttle-tailslow': 'bool',
1296 '*tls-creds': 'str',
1297 '*tls-hostname': 'str',
1298 '*tls-authz': 'str',
1299 '*max-bandwidth': 'size',
1300 '*avail-switchover-bandwidth': 'size',
1301 '*downtime-limit': 'uint64',
1302 '*x-checkpoint-delay': { 'type': 'uint32',
1304 '*multifd-channels': 'uint8',
1305 '*xbzrle-cache-size': 'size',
1306 '*max-postcopy-bandwidth': 'size',
1307 '*max-cpu-throttle': 'uint8',
1308 '*multifd-compression': 'MultiFDCompression',
1309 '*multifd-zlib-level': 'uint8',
1310 '*multifd-qatzip-level': 'uint8',
1311 '*multifd-zstd-level': 'uint8',
1312 '*block-bitmap-mapping': [ 'BitmapMigrationNodeAlias' ],
1313 '*x-vcpu-dirty-limit-period': { 'type': 'uint64',
1315 '*vcpu-dirty-limit': 'uint64',
1317 '*zero-page-detection': 'ZeroPageDetection',
1318 '*direct-io': 'bool' } }
1321 # @query-migrate-parameters:
1329 # .. qmp-example::
1331 # -> { "execute": "query-migrate-parameters" }
1332 # <- { "return": {
1333 # "multifd-channels": 2,
1334 # "cpu-throttle-increment": 10,
1335 # "cpu-throttle-initial": 20,
1336 # "max-bandwidth": 33554432,
1337 # "downtime-limit": 300
1341 { 'command': 'query-migrate-parameters',
1345 # @migrate-start-postcopy:
1348 # mode. The postcopy-ram capability must be set on both source and
1353 # .. qmp-example::
1355 # -> { "execute": "migrate-start-postcopy" }
1356 # <- { "return": {} }
1358 { 'command': 'migrate-start-postcopy' }
1369 # .. qmp-example::
1371 # <- {"timestamp": {"seconds": 1432121972, "microseconds": 744001},
1388 # .. qmp-example::
1390 # <- { "timestamp": {"seconds": 1449669631, "microseconds": 239225},
1401 # @checkpoint-ready: Secondary VM (SVM) is ready for checkpointing
1403 # @checkpoint-request: Primary VM (PVM) tells SVM to prepare for
1406 # @checkpoint-reply: SVM gets PVM's checkpoint request
1408 # @vmstate-send: VM's state will be sent by PVM.
1410 # @vmstate-size: The total size of VMstate.
1412 # @vmstate-received: VM's state has been received by SVM.
1414 # @vmstate-loaded: VM's state has been loaded by SVM.
1419 'data': [ 'checkpoint-ready', 'checkpoint-request', 'checkpoint-reply',
1420 'vmstate-send', 'vmstate-size', 'vmstate-received',
1421 'vmstate-loaded' ] }
1452 # @relaunch: restart the failover process, from 'none' -> 'completed'
1472 # .. qmp-example::
1474 # <- { "timestamp": {"seconds": 2032141960, "microseconds": 417172},
1487 # query-colo-status.
1501 # @x-colo-lost-heartbeat:
1515 # .. qmp-example::
1517 # -> { "execute": "x-colo-lost-heartbeat" }
1518 # <- { "return": {} }
1520 { 'command': 'x-colo-lost-heartbeat',
1528 # migration to be started right after. When postcopy-ram is in use,
1536 # .. qmp-example::
1538 # -> { "execute": "migrate_cancel" }
1539 # <- { "return": {} }
1544 # @migrate-continue:
1552 # .. qmp-example::
1554 # -> { "execute": "migrate-continue" , "arguments":
1555 # { "state": "pre-switchover" } }
1556 # <- { "return": {} }
1558 { 'command': 'migrate-continue', 'data': {'state': 'MigrationStatus'} }
1622 # The migration channel-type request options.
1637 # @channel-type: Channel type for transferring packet information.
1645 'channel-type': 'MigrationChannelType',
1671 # 1. The 'query-migrate' command should be used to check
1685 # .. qmp-example::
1687 # -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
1688 # <- { "return": {} }
1690 # -> { "execute": "migrate",
1692 # "channels": [ { "channel-type": "main",
1697 # <- { "return": {} }
1699 # -> { "execute": "migrate",
1701 # "channels": [ { "channel-type": "main",
1703 # "args": [ "/bin/nc", "-p", "6000",
1705 # <- { "return": {} }
1707 # -> { "execute": "migrate",
1709 # "channels": [ { "channel-type": "main",
1713 # <- { "return": {} }
1715 # -> { "execute": "migrate",
1717 # "channels": [ { "channel-type": "main",
1721 # <- { "return": {} }
1730 # @migrate-incoming:
1733 # -incoming defer.
1741 # @exit-on-error: Exit on incoming migration failure. Default true.
1743 # error details could be retrieved with query-migrate.
1751 # stay compatible with -incoming and the format of the uri is
1754 # 2. QEMU must be started with -incoming defer to allow
1755 # migrate-incoming to be used.
1757 # 3. The uri format is the same as for -incoming
1765 # .. qmp-example::
1767 # -> { "execute": "migrate-incoming",
1769 # <- { "return": {} }
1771 # -> { "execute": "migrate-incoming",
1773 # "channels": [ { "channel-type": "main",
1778 # <- { "return": {} }
1780 # -> { "execute": "migrate-incoming",
1782 # "channels": [ { "channel-type": "main",
1784 # "args": [ "/bin/nc", "-p", "6000",
1786 # <- { "return": {} }
1788 # -> { "execute": "migrate-incoming",
1790 # "channels": [ { "channel-type": "main",
1794 # <- { "return": {} }
1796 { 'command': 'migrate-incoming',
1799 '*exit-on-error': 'bool' } }
1802 # @xen-save-devices-state:
1808 # data. See xen-save-devices-state.txt for a description of the
1816 # .. qmp-example::
1818 # -> { "execute": "xen-save-devices-state",
1820 # <- { "return": {} }
1822 { 'command': 'xen-save-devices-state',
1826 # @xen-set-global-dirty-log:
1828 # Enable or disable the global dirty log mode.
1830 # @enable: true to enable, false to disable.
1834 # .. qmp-example::
1836 # -> { "execute": "xen-set-global-dirty-log",
1838 # <- { "return": {} }
1840 { 'command': 'xen-set-global-dirty-log', 'data': { 'enable': 'bool' } }
1843 # @xen-load-devices-state:
1849 # data. See xen-save-devices-state.txt for a description of the
1854 # .. qmp-example::
1856 # -> { "execute": "xen-load-devices-state",
1858 # <- { "return": {} }
1860 { 'command': 'xen-load-devices-state', 'data': {'filename': 'str'} }
1863 # @xen-set-replication:
1865 # Enable or disable replication.
1867 # @enable: true to enable, false to disable.
1874 # .. qmp-example::
1876 # -> { "execute": "xen-set-replication",
1878 # <- { "return": {} }
1882 { 'command': 'xen-set-replication',
1889 # The result format for 'query-xen-replication-status'.
1903 # @query-xen-replication-status:
1909 # .. qmp-example::
1911 # -> { "execute": "query-xen-replication-status" }
1912 # <- { "return": { "error": false } }
1916 { 'command': 'query-xen-replication-status',
1921 # @xen-colo-do-checkpoint:
1925 # .. qmp-example::
1927 # -> { "execute": "xen-colo-do-checkpoint" }
1928 # <- { "return": {} }
1932 { 'command': 'xen-colo-do-checkpoint',
1938 # The result format for 'query-colo-status'.
1943 # @last-mode: COLO last running mode. If COLO is running, this field
1952 'data': { 'mode': 'COLOMode', 'last-mode': 'COLOMode',
1957 # @query-colo-status:
1963 # .. qmp-example::
1965 # -> { "execute": "query-colo-status" }
1966 # <- { "return": { "mode": "primary", "last-mode": "none", "reason": "request" } }
1970 { 'command': 'query-colo-status',
1975 # @migrate-recover:
1981 # .. qmp-example::
1983 # -> { "execute": "migrate-recover",
1985 # <- { "return": {} }
1989 { 'command': 'migrate-recover',
1991 'allow-oob': true }
1994 # @migrate-pause:
1998 # .. qmp-example::
2000 # -> { "execute": "migrate-pause" }
2001 # <- { "return": {} }
2005 { 'command': 'migrate-pause', 'allow-oob': true }
2012 # Device resources in QEMU are kept on standby to be able to re-plug
2015 # @device-id: QEMU device id of the unplugged device
2019 # .. qmp-example::
2021 # <- { "event": "UNPLUG_PRIMARY",
2022 # "data": { "device-id": "hostdev0" },
2026 'data': { 'device-id': 'str' } }
2035 # @dirty-rate: dirty rate.
2040 'data': { 'id': 'int', 'dirty-rate': 'int64' } }
2062 # available methods are explained in @calc-dirty-rate.
2064 # @page-sampling: use page sampling
2066 # @dirty-ring: use dirty ring
2068 # @dirty-bitmap: use dirty bitmap
2073 'data': ['page-sampling', 'dirty-ring', 'dirty-bitmap'] }
2078 # Specifies unit in which time-related value is specified.
2094 # @dirty-rate: an estimate of the dirty page rate of the VM in units
2099 # @start-time: start time in units of second for calculation
2101 # @calc-time: time period for which dirty page rate was measured,
2102 # expressed and rounded down to @calc-time-unit.
2104 # @calc-time-unit: time unit of @calc-time (Since 8.2)
2106 # @sample-pages: number of sampled pages per GiB of guest memory.
2107 # Valid only in page-sampling mode (Since 6.1)
2111 # @vcpu-dirty-rate: dirty rate for each vCPU if dirty-ring mode was
2117 'data': {'*dirty-rate': 'int64',
2119 'start-time': 'int64',
2120 'calc-time': 'int64',
2121 'calc-time-unit': 'TimeUnit',
2122 'sample-pages': 'uint64',
2124 '*vcpu-dirty-rate': [ 'DirtyRateVcpu' ] } }
2127 # @calc-dirty-rate:
2130 # with @query-dirty-rate after measurements are completed.
2141 # only an estimate of its true value. Increasing @sample-pages
2149 # requires that KVM accelerator property "dirty-ring-size" is *not*
2155 # requires that KVM accelerator property "dirty-ring-size" is set.
2157 # @calc-time: time period for which dirty page rate is calculated. By
2159 # explicitly with @calc-time-unit. Note that larger @calc-time
2161 # page dirtying is a one-time event. Once some page is counted as
2162 # dirty during @calc-time period, further writes to this page will
2165 # @calc-time-unit: time unit in which @calc-time is specified. By
2168 # @sample-pages: number of sampled pages per each GiB of guest memory.
2174 # 'page-sampling'. Others are 'dirty-bitmap' and 'dirty-ring'.
2179 # .. qmp-example::
2181 # -> {"execute": "calc-dirty-rate", "arguments": {"calc-time": 1,
2182 # "sample-pages": 512} }
2183 # <- { "return": {} }
2185 # .. qmp-example::
2190 # -> {"execute": "calc-dirty-rate", "arguments": {"calc-time": 500,
2191 # "calc-time-unit": "millisecond", "mode": "dirty-bitmap"} }
2193 # <- { "return": {} }
2195 { 'command': 'calc-dirty-rate', 'data': {'calc-time': 'int64',
2196 '*calc-time-unit': 'TimeUnit',
2197 '*sample-pages': 'int',
2201 # @query-dirty-rate:
2203 # Query results of the most recent invocation of @calc-dirty-rate.
2205 # @calc-time-unit: time unit in which to report calculation time.
2210 # .. qmp-example::
2213 # <- {"status": "measuring", "sample-pages": 512,
2214 # "mode": "page-sampling", "start-time": 1693900454, "calc-time": 10,
2215 # "calc-time-unit": "second"}
2217 # .. qmp-example::
2220 # <- {"status": "measured", "sample-pages": 512, "dirty-rate": 108,
2221 # "mode": "page-sampling", "start-time": 1693900454, "calc-time": 10,
2222 # "calc-time-unit": "second"}
2224 { 'command': 'query-dirty-rate', 'data': {'*calc-time-unit': 'TimeUnit' },
2232 # @cpu-index: index of a virtual CPU.
2234 # @limit-rate: upper limit of dirty page rate (MB/s) for a virtual
2237 # @current-rate: current dirty page rate (MB/s) for a virtual CPU.
2242 'data': { 'cpu-index': 'int',
2243 'limit-rate': 'uint64',
2244 'current-rate': 'uint64' } }
2247 # @set-vcpu-dirty-limit:
2251 # Requires KVM with accelerator property "dirty-ring-size" set. A
2253 # observe dirty page rates, use @calc-dirty-rate.
2255 # @cpu-index: index of a virtual CPU, default is all.
2257 # @dirty-rate: upper limit of dirty page rate (MB/s) for virtual CPUs.
2261 # .. qmp-example::
2263 # -> {"execute": "set-vcpu-dirty-limit"}
2264 # "arguments": { "dirty-rate": 200,
2265 # "cpu-index": 1 } }
2266 # <- { "return": {} }
2268 { 'command': 'set-vcpu-dirty-limit',
2269 'data': { '*cpu-index': 'int',
2270 'dirty-rate': 'uint64' } }
2273 # @cancel-vcpu-dirty-limit:
2278 # set-vcpu-dirty-limit command. Note that this command requires
2279 # support from dirty ring, same as the "set-vcpu-dirty-limit".
2281 # @cpu-index: index of a virtual CPU, default is all.
2285 # .. qmp-example::
2287 # -> {"execute": "cancel-vcpu-dirty-limit"},
2288 # "arguments": { "cpu-index": 1 } }
2289 # <- { "return": {} }
2291 { 'command': 'cancel-vcpu-dirty-limit',
2292 'data': { '*cpu-index': 'int'} }
2295 # @query-vcpu-dirty-limit:
2302 # .. qmp-example::
2304 # -> {"execute": "query-vcpu-dirty-limit"}
2305 # <- {"return": [
2306 # { "limit-rate": 60, "current-rate": 3, "cpu-index": 0},
2307 # { "limit-rate": 60, "current-rate": 3, "cpu-index": 1}]}
2309 { 'command': 'query-vcpu-dirty-limit',
2319 # @thread-id: ID of the underlying host thread
2325 'thread-id': 'int'} }
2328 # @query-migrationthreads:
2340 { 'command': 'query-migrationthreads',
2345 # @snapshot-save:
2349 # @job-id: identifier for the newly created job
2371 # .. qmp-example::
2373 # -> { "execute": "snapshot-save",
2375 # "job-id": "snapsave0",
2376 # "tag": "my-snap",
2381 # <- { "return": { } }
2382 # <- {"event": "JOB_STATUS_CHANGE",
2385 # <- {"event": "JOB_STATUS_CHANGE",
2388 # <- {"event": "STOP",
2390 # <- {"event": "RESUME",
2392 # <- {"event": "JOB_STATUS_CHANGE",
2395 # <- {"event": "JOB_STATUS_CHANGE",
2398 # <- {"event": "JOB_STATUS_CHANGE",
2401 # -> {"execute": "query-jobs"}
2402 # <- {"return": [{"current-progress": 1,
2404 # "total-progress": 1,
2405 # "type": "snapshot-save",
2410 { 'command': 'snapshot-save',
2411 'data': { 'job-id': 'str',
2417 # @snapshot-load:
2421 # @job-id: identifier for the newly created job
2438 # device nodes that can have changed since the original @snapshot-save
2441 # .. qmp-example::
2443 # -> { "execute": "snapshot-load",
2445 # "job-id": "snapload0",
2446 # "tag": "my-snap",
2451 # <- { "return": { } }
2452 # <- {"event": "JOB_STATUS_CHANGE",
2455 # <- {"event": "JOB_STATUS_CHANGE",
2458 # <- {"event": "STOP",
2460 # <- {"event": "RESUME",
2462 # <- {"event": "JOB_STATUS_CHANGE",
2465 # <- {"event": "JOB_STATUS_CHANGE",
2468 # <- {"event": "JOB_STATUS_CHANGE",
2471 # -> {"execute": "query-jobs"}
2472 # <- {"return": [{"current-progress": 1,
2474 # "total-progress": 1,
2475 # "type": "snapshot-load",
2480 { 'command': 'snapshot-load',
2481 'data': { 'job-id': 'str',
2487 # @snapshot-delete:
2491 # @job-id: identifier for the newly created job
2502 # .. qmp-example::
2504 # -> { "execute": "snapshot-delete",
2506 # "job-id": "snapdelete0",
2507 # "tag": "my-snap",
2511 # <- { "return": { } }
2512 # <- {"event": "JOB_STATUS_CHANGE",
2515 # <- {"event": "JOB_STATUS_CHANGE",
2518 # <- {"event": "JOB_STATUS_CHANGE",
2521 # <- {"event": "JOB_STATUS_CHANGE",
2524 # <- {"event": "JOB_STATUS_CHANGE",
2527 # -> {"execute": "query-jobs"}
2528 # <- {"return": [{"current-progress": 1,
2530 # "total-progress": 1,
2531 # "type": "snapshot-delete",
2536 { 'command': 'snapshot-delete',
2537 'data': { 'job-id': 'str',