Lines Matching +full:suspend +full:- +full:to +full:- +full:ram
1 # -*- Mode: Python -*-
19 # @transferred: amount of bytes already transferred to the target VM
21 # @remaining: amount of bytes remaining to be transferred to the
30 # @normal-bytes: number of normal bytes sent (since 1.2)
32 # @dirty-pages-rate: number of pages dirtied by second by the guest
37 # @dirty-sync-count: number of times that dirty ram was synchronized
40 # @postcopy-requests: The number of page requests received from the
43 # @page-size: The number of bytes per page for the various page-based
46 # @multifd-bytes: The number of bytes sent through multifd (since 3.0)
48 # @pages-per-second: the number of memory pages transferred per second
51 # @precopy-bytes: The number of bytes sent in the pre-copy phase
54 # @downtime-bytes: The number of bytes sent while the guest is paused
57 # @postcopy-bytes: The number of bytes sent during the post-copy phase
60 # @dirty-sync-missed-zero-copy: Number of times dirty RAM
62 # between 0 and @dirty-sync-count * @multifd-channels.
71 'normal-bytes': 'int', 'dirty-pages-rate': 'int',
72 'mbps': 'number', 'dirty-sync-count': 'int',
73 'postcopy-requests': 'int', 'page-size': 'int',
74 'multifd-bytes': 'uint64', 'pages-per-second': 'uint64',
75 'precopy-bytes': 'uint64', 'downtime-bytes': 'uint64',
76 'postcopy-bytes': 'uint64',
77 'dirty-sync-missed-zero-copy': 'uint64' } }
84 # @cache-size: XBZRLE cache size
86 # @bytes: amount of bytes already transferred to the target VM
88 # @pages: amount of pages transferred to the target VM
90 # @cache-miss: number of cache miss
92 # @cache-miss-rate: rate of cache miss (since 2.1)
94 # @encoding-rate: rate of encoded bytes (since 5.1)
101 'data': {'cache-size': 'size', 'bytes': 'int', 'pages': 'int',
102 'cache-miss': 'int', 'cache-miss-rate': 'number',
103 'encoding-rate': 'number', 'overflow': 'int' } }
110 # @pages: amount of pages compressed and transferred to the target VM
112 # @busy: count of times that no free thread was available to compress
115 # @busy-rate: rate of thread busy
117 # @compressed-size: amount of bytes after compression
119 # @compression-rate: rate of compressed size
124 'data': {'pages': 'int', 'busy': 'int', 'busy-rate': 'number',
125 'compressed-size': 'int', 'compression-rate': 'number' } }
142 # @postcopy-active: like active, but now in postcopy mode.
145 # @postcopy-paused: during postcopy but paused. (since 3.0)
147 # @postcopy-recover-setup: setup phase for a postcopy recovery
148 # process, preparing for a recovery phase to start. (since 9.1)
150 # @postcopy-recover: trying to recover from a paused postcopy.
161 # @pre-switchover: Paused before device serialisation. (since 2.11)
165 # pre-switchover capability is enabled. After 10.0, this state will
169 # @wait-unplug: wait for device unplug request by guest OS to be
176 'active', 'postcopy-active', 'postcopy-paused',
177 'postcopy-recover-setup',
178 'postcopy-recover', 'completed', 'failed', 'colo',
179 'pre-switchover', 'device', 'wait-unplug' ] }
185 # @transferred: amount of bytes transferred to the target VM by VFIO
202 # @ram: `MigrationStats` containing detailed migration status, only
205 # @xbzrle-cache: `XBZRLECacheStats` containing detailed XBZRLE
209 # @total-time: total amount of milliseconds since migration started.
216 # @expected-downtime: only present while migration is active expected
220 # @setup-time: amount of setup time in milliseconds *before* the
222 # designed to provide an accounting of any activities (such as
226 # @cpu-throttle-percentage: percentage of time guest cpus are being
227 # throttled during auto-converge. This is only present when
228 # auto-converge has started throttling guest cpus. (Since 2.7)
230 # @error-desc: the human readable error description string. Clients
231 # should not attempt to parse the error strings. (Since 2.7)
233 # @postcopy-blocktime: total time when all vCPU were blocked during
235 # postcopy-blocktime migration capability is enabled. (Since 3.0)
237 # @postcopy-vcpu-blocktime: list of the postcopy blocktime per vCPU.
238 # This is only present when the postcopy-blocktime migration
241 # @postcopy-latency: average remote page fault latency (in ns). Note that
245 # postcopy-blocktime migration capability is enabled. (Since 10.1)
247 # @postcopy-latency-dist: remote page fault latency distributions. Each
249 # bucket period. For the N-th bucket (N>=0), the latency window is
252 # present when the postcopy-blocktime migration capability is enabled.
255 # @postcopy-vcpu-latency: average remote page fault latency per vCPU (in
256 # ns). It has the same definition of @postcopy-latency, but instead
257 # this is the per-vCPU statistics. This is only present when the
258 # postcopy-blocktime migration capability is enabled. (Since 10.1)
260 # @postcopy-non-vcpu-latency: average remote page fault latency for all
261 # faults happend in non-vCPU threads (in ns). It has the same
262 # definition of @postcopy-latency but this only provides statistics to
263 # non-vCPU faults. This is only present when the postcopy-blocktime
266 # @socket-address: Only used for tcp, to know what the real port is
274 # @blocked-reasons: A list of reasons an outgoing migration is
275 # blocked. Present and non-empty when migration is blocked.
278 # @dirty-limit-throttle-time-per-round: Maximum throttle time (in
280 # shows how `MigrationCapability` dirty-limit affects the guest
283 # @dirty-limit-ring-full-time: Estimated average dirty ring full time
286 # page rate of the virtual CPU, which can be used to observe the
292 # @unstable: Members @postcopy-latency, @postcopy-vcpu-latency,
293 # @postcopy-latency-dist, @postcopy-non-vcpu-latency are experimental.
298 'data': {'*status': 'MigrationStatus', '*ram': 'MigrationStats',
300 '*xbzrle-cache': 'XBZRLECacheStats',
301 '*total-time': 'int',
302 '*expected-downtime': 'int',
304 '*setup-time': 'int',
305 '*cpu-throttle-percentage': 'int',
306 '*error-desc': 'str',
307 '*blocked-reasons': ['str'],
308 '*postcopy-blocktime': 'uint32',
309 '*postcopy-vcpu-blocktime': ['uint32'],
310 '*postcopy-latency': {
312 '*postcopy-latency-dist': {
314 '*postcopy-vcpu-latency': {
316 '*postcopy-non-vcpu-latency': {
318 '*socket-address': ['SocketAddress'],
319 '*dirty-limit-throttle-time-per-round': 'uint64',
320 '*dirty-limit-ring-full-time': 'uint64'} }
323 # @query-migrate:
326 # is active there will be another json-object with RAM migration
331 # .. qmp-example::
334 # -> { "execute": "query-migrate" }
335 # <- { "return": {} }
337 # .. qmp-example::
340 # -> { "execute": "query-migrate" }
341 # <- { "return": {
343 # "total-time":12345,
344 # "setup-time":12345,
346 # "ram":{
352 # "normal-bytes":123456,
353 # "dirty-sync-count":15
358 # .. qmp-example::
361 # -> { "execute": "query-migrate" }
362 # <- { "return": { "status": "failed" } }
364 # .. qmp-example::
367 # -> { "execute": "query-migrate" }
368 # <- {
371 # "total-time":12345,
372 # "setup-time":12345,
373 # "expected-downtime":12345,
374 # "ram":{
380 # "normal-bytes":123456,
381 # "dirty-sync-count":15
386 # .. qmp-example::
389 # -> { "execute": "query-migrate" }
390 # <- {
393 # "total-time":12345,
394 # "setup-time":12345,
395 # "expected-downtime":12345,
396 # "ram":{
402 # "normal-bytes":3412992,
403 # "dirty-sync-count":15
405 # "xbzrle-cache":{
406 # "cache-size":67108864,
409 # "cache-miss":2244,
410 # "cache-miss-rate":0.123,
411 # "encoding-rate":80.1,
417 { 'command': 'query-migrate', 'returns': 'MigrationInfo' }
425 # Encoding). This feature allows us to minimize migration traffic
429 # @rdma-pin-all: Controls whether or not the entire VM memory
430 # footprint is mlock()'d on demand or all at once. Refer to
433 # @zero-blocks: During storage migration encode blocks of zeroes
435 # the wire. Enabling requires source and target VM to support
436 # this feature. To enable it is sufficient to enable the
442 # @auto-converge: If enabled, QEMU will automatically throttle down
443 # the guest to speed up convergence of RAM migration. (since 1.6)
445 # @postcopy-ram: Start executing on the migration target before all of
446 # RAM has been migrated, pulling the remaining pages along as
451 # @x-colo: If enabled, migration will never end, and the state of the
452 # VM on the primary side will be migrated continuously to the VM
453 # on secondary side, this process is called COarse-Grain LOck
454 # Stepping (COLO) for Non-stop Service. (since 2.8)
456 # @release-ram: if enabled, QEMU will free the migrated ram pages on
457 # the source during postcopy-ram migration. (since 2.9)
459 # @return-path: If enabled, migration will use the return path even
462 # @pause-before-switchover: Pause outgoing migration before
468 # @dirty-bitmaps: If enabled, QEMU will migrate named dirty bitmaps.
471 # @postcopy-blocktime: Calculate downtime for postcopy live migration
474 # @late-block-activate: If enabled, the destination will not activate
478 # @x-ignore-shared: If enabled, QEMU will not migrate shared memory
481 # @validate-uuid: Send the UUID of the source to allow the destination
482 # to ensure it is the same. (since 4.2)
484 # @background-snapshot: If enabled, the migration stream will be a
486 # procedure starts. The VM RAM is saved with running VM.
489 # @zero-copy-send: Controls behavior on sending memory pages on
490 # migration. When true, enables a zero-copy mechanism for sending
492 # permitted to use locked memory for guest RAM pages. (since 7.1)
494 # @postcopy-preempt: If enabled, the migration process will allow
495 # postcopy requests to preempt precopy stream, so postcopy
500 # @switchover-ack: If enabled, migration will not stop the source VM
502 # destination that it's OK to do so. Exactly when this ACK is
504 # example, a device can use it to make sure some of its data is
507 # are present. 'return-path' capability must be enabled to use
510 # @dirty-limit: If enabled, migration will throttle vCPUs as needed to
511 # keep their dirty page rate within @vcpu-dirty-limit. This can
514 # with accelerator property "dirty-ring-size" set. (Since 8.1)
516 # @mapped-ram: Migrate using fixed offsets in the migration file for
517 # each RAM page. Requires a migration URI that supports seeking,
522 # @unstable: Members @x-colo and @x-ignore-shared are experimental.
523 # @deprecated: Member @zero-blocks is deprecated as being part of
529 'data': ['xbzrle', 'rdma-pin-all', 'auto-converge',
530 { 'name': 'zero-blocks', 'features': [ 'deprecated' ] },
531 'events', 'postcopy-ram',
532 { 'name': 'x-colo', 'features': [ 'unstable' ] },
533 'release-ram',
534 'return-path', 'pause-before-switchover', 'multifd',
535 'dirty-bitmaps', 'postcopy-blocktime', 'late-block-activate',
536 { 'name': 'x-ignore-shared', 'features': [ 'unstable' ] },
537 'validate-uuid', 'background-snapshot',
538 'zero-copy-send', 'postcopy-preempt', 'switchover-ack',
539 'dirty-limit', 'mapped-ram'] }
556 # @migrate-set-capabilities:
560 # @capabilities: json array of capability modifications to make
564 # .. qmp-example::
566 # -> { "execute": "migrate-set-capabilities" , "arguments":
568 # <- { "return": {} }
570 { 'command': 'migrate-set-capabilities',
574 # @query-migrate-capabilities:
580 # .. qmp-example::
582 # -> { "execute": "query-migrate-capabilities" }
583 # <- { "return": [
585 # {"state": false, "capability": "rdma-pin-all"},
586 # {"state": false, "capability": "auto-converge"},
587 # {"state": false, "capability": "zero-blocks"},
589 # {"state": false, "capability": "postcopy-ram"},
590 # {"state": false, "capability": "x-colo"}
593 { 'command': 'query-migrate-capabilities', 'returns': ['MigrationCapabilityStatus']}
610 # In-Memory Analytics Accelerator(IAA) accelerated compression and
630 # @cpr-reboot: The `migrate` command stops the VM and saves state to the
632 # -incoming.
634 # This mode allows the user to quit QEMU, optionally update and
644 # `guest-suspend-ram` to the QEMU guest agent.
647 # and the @x-ignore-shared migration capability is set, but this
652 # @cpr-reboot may not be used with postcopy, background-snapshot,
657 # @cpr-transfer: This mode allows the user to transfer a guest to a
659 # time by preserving guest RAM in place.
665 # command-line arguments to create the same machine, plus the
666 # -incoming option for the main migration channel, like normal
667 # live migration. In addition, the user adds a second -incoming
672 # To initiate CPR, the user issues a migrate command to old QEMU,
674 # argument. Old QEMU stops the VM, saves state to the migration
680 # a `migrate-incoming` command. It may only be specified on the
687 # Memory-backend objects must have the share=on attribute, but
688 # memory-backend-epc is not supported. The VM must be started
689 # with the '-machine aux-ram-share=on' option.
691 # When using -incoming defer, you must issue the `migrate` command
692 # to old QEMU before issuing any monitor commands to new QEMU.
694 # until you issue the `migrate-incoming` command.
699 'data': [ 'normal', 'cpr-reboot', 'cpr-transfer' ] }
753 # Maps a block node name and the bitmaps it has to aliases for dirty
756 # @node-name: A block node name.
767 'node-name': 'str',
777 # @announce-initial: Initial delay (in milliseconds) before sending
780 # @announce-max: Maximum delay (in milliseconds) between packets in
783 # @announce-rounds: Number of self-announce packets sent after
786 # @announce-step: Increase in delay (in milliseconds) between
789 # @throttle-trigger-threshold: The ratio of bytes_dirty_period and
790 # bytes_xfer_period to trigger throttling. It is expressed as
793 # @cpu-throttle-initial: Initial percentage of time guest cpus are
794 # throttled when migration auto-converge is activated. The
797 # @cpu-throttle-increment: throttle percentage increase each time
798 # auto-converge detects that migration is not making progress.
801 # @cpu-throttle-tailslow: Make CPU throttling slower at tail stage.
802 # At the tail stage of throttling, the Guest is very sensitive to
803 # CPU percentage while the @cpu-throttle -increment is excessive
808 # specified by @cpu-throttle-increment and the one generated by
809 # ideal CPU percentage. Therefore, it is compatible to
814 # @tls-creds: ID of the 'tls-creds' object that provides credentials
818 # credentials must be for a 'server' endpoint. Setting this to a
819 # non-empty string enables TLS for all migrations. An empty
823 # @tls-hostname: migration target's hostname for validating the
825 # hostname from the migration URI, if any. A non-empty value is
832 # @tls-authz: ID of the 'authz' object subclass that provides access
836 # If missing, it will default to denying access (Since 4.0)
838 # @max-bandwidth: maximum speed for migration, in bytes per second.
841 # @avail-switchover-bandwidth: to set the available bandwidth that
844 # calculations when making decisions to switchover. By default,
847 # accurate, while the user is able to guarantee such bandwidth is
852 # @downtime-limit: set maximum tolerated downtime for migration.
855 # @x-checkpoint-delay: The delay time (in ms) between two COLO
858 # @multifd-channels: Number of channels used to migrate data in
862 # @xbzrle-cache-size: cache size to be used by XBZRLE migration. It
863 # needs to be a multiple of the target page size and a power of 2
866 # @max-postcopy-bandwidth: Background transfer bandwidth during
867 # postcopy. Defaults to 0 (unlimited). In bytes per second.
870 # @max-cpu-throttle: maximum cpu throttle percentage. Defaults to 99.
873 # @multifd-compression: Which compression method to use. Defaults to
876 # @multifd-zlib-level: Set the compression level to be used in live
880 # more CPU. Defaults to 1. (Since 5.0)
882 # @multifd-qatzip-level: Set the compression level to be used in live
885 # ratio which will consume more CPU. Defaults to 1. (Since 9.2)
887 # @multifd-zstd-level: Set the compression level to be used in live
891 # more CPU. Defaults to 1. (Since 5.0)
893 # @block-bitmap-mapping: Maps block nodes and bitmaps on them to
896 # The mapping must be one-to-one, but not necessarily complete: On
905 # has never been set), bitmap names are mapped to themselves.
906 # Nodes are mapped to their block device name if there is one, and
907 # to their node name otherwise. (Since 5.2)
909 # @x-vcpu-dirty-limit-period: Periodic time (in milliseconds) of dirty
910 # limit during live migration. Should be in the range 1 to
911 # 1000ms. Defaults to 1000ms. (Since 8.1)
913 # @vcpu-dirty-limit: Dirtyrate limit (MB/s) during live migration.
914 # Defaults to 1. (Since 8.1)
919 # @zero-page-detection: Whether and how to detect zero pages.
923 # @direct-io: Open migration files with O_DIRECT when possible. This
924 # only has effect if the @mapped-ram capability is enabled.
929 # @unstable: Members @x-checkpoint-delay and
930 # @x-vcpu-dirty-limit-period are experimental.
935 'data': ['announce-initial', 'announce-max',
936 'announce-rounds', 'announce-step',
937 'throttle-trigger-threshold',
938 'cpu-throttle-initial', 'cpu-throttle-increment',
939 'cpu-throttle-tailslow',
940 'tls-creds', 'tls-hostname', 'tls-authz', 'max-bandwidth',
941 'avail-switchover-bandwidth', 'downtime-limit',
942 { 'name': 'x-checkpoint-delay', 'features': [ 'unstable' ] },
943 'multifd-channels',
944 'xbzrle-cache-size', 'max-postcopy-bandwidth',
945 'max-cpu-throttle', 'multifd-compression',
946 'multifd-zlib-level', 'multifd-zstd-level',
947 'multifd-qatzip-level',
948 'block-bitmap-mapping',
949 { 'name': 'x-vcpu-dirty-limit-period', 'features': ['unstable'] },
950 'vcpu-dirty-limit',
952 'zero-page-detection',
953 'direct-io'] }
958 # @announce-initial: Initial delay (in milliseconds) before sending
961 # @announce-max: Maximum delay (in milliseconds) between packets in
964 # @announce-rounds: Number of self-announce packets sent after
967 # @announce-step: Increase in delay (in milliseconds) between
970 # @throttle-trigger-threshold: The ratio of bytes_dirty_period and
971 # bytes_xfer_period to trigger throttling. It is expressed as
974 # @cpu-throttle-initial: Initial percentage of time guest cpus are
975 # throttled when migration auto-converge is activated. The
978 # @cpu-throttle-increment: throttle percentage increase each time
979 # auto-converge detects that migration is not making progress.
982 # @cpu-throttle-tailslow: Make CPU throttling slower at tail stage.
983 # At the tail stage of throttling, the Guest is very sensitive to
984 # CPU percentage while the @cpu-throttle -increment is excessive
989 # specified by @cpu-throttle-increment and the one generated by
990 # ideal CPU percentage. Therefore, it is compatible to
995 # @tls-creds: ID of the 'tls-creds' object that provides credentials
999 # credentials must be for a 'server' endpoint. Setting this to a
1000 # non-empty string enables TLS for all migrations. An empty
1004 # @tls-hostname: migration target's hostname for validating the
1006 # hostname from the migration URI, if any. A non-empty value is
1013 # @tls-authz: ID of the 'authz' object subclass that provides access
1017 # If missing, it will default to denying access (Since 4.0)
1019 # @max-bandwidth: maximum speed for migration, in bytes per second.
1022 # @avail-switchover-bandwidth: to set the available bandwidth that
1025 # calculations when making decisions to switchover. By default,
1028 # accurate, while the user is able to guarantee such bandwidth is
1033 # @downtime-limit: set maximum tolerated downtime for migration.
1036 # @x-checkpoint-delay: The delay time (in ms) between two COLO
1039 # @multifd-channels: Number of channels used to migrate data in
1043 # @xbzrle-cache-size: cache size to be used by XBZRLE migration. It
1044 # needs to be a multiple of the target page size and a power of 2
1047 # @max-postcopy-bandwidth: Background transfer bandwidth during
1048 # postcopy. Defaults to 0 (unlimited). In bytes per second.
1051 # @max-cpu-throttle: maximum cpu throttle percentage. Defaults to 99.
1054 # @multifd-compression: Which compression method to use. Defaults to
1057 # @multifd-zlib-level: Set the compression level to be used in live
1061 # more CPU. Defaults to 1. (Since 5.0)
1063 # @multifd-qatzip-level: Set the compression level to be used in live
1066 # ratio which will consume more CPU. Defaults to 1. (Since 9.2)
1068 # @multifd-zstd-level: Set the compression level to be used in live
1072 # more CPU. Defaults to 1. (Since 5.0)
1074 # @block-bitmap-mapping: Maps block nodes and bitmaps on them to
1077 # The mapping must be one-to-one, but not necessarily complete: On
1086 # has never been set), bitmap names are mapped to themselves.
1087 # Nodes are mapped to their block device name if there is one, and
1088 # to their node name otherwise. (Since 5.2)
1090 # @x-vcpu-dirty-limit-period: Periodic time (in milliseconds) of dirty
1091 # limit during live migration. Should be in the range 1 to
1092 # 1000ms. Defaults to 1000ms. (Since 8.1)
1094 # @vcpu-dirty-limit: Dirtyrate limit (MB/s) during live migration.
1095 # Defaults to 1. (Since 8.1)
1100 # @zero-page-detection: Whether and how to detect zero pages.
1104 # @direct-io: Open migration files with O_DIRECT when possible. This
1105 # only has effect if the @mapped-ram capability is enabled.
1110 # @unstable: Members @x-checkpoint-delay and
1111 # @x-vcpu-dirty-limit-period are experimental.
1119 'data': { '*announce-initial': 'size',
1120 '*announce-max': 'size',
1121 '*announce-rounds': 'size',
1122 '*announce-step': 'size',
1123 '*throttle-trigger-threshold': 'uint8',
1124 '*cpu-throttle-initial': 'uint8',
1125 '*cpu-throttle-increment': 'uint8',
1126 '*cpu-throttle-tailslow': 'bool',
1127 '*tls-creds': 'StrOrNull',
1128 '*tls-hostname': 'StrOrNull',
1129 '*tls-authz': 'StrOrNull',
1130 '*max-bandwidth': 'size',
1131 '*avail-switchover-bandwidth': 'size',
1132 '*downtime-limit': 'uint64',
1133 '*x-checkpoint-delay': { 'type': 'uint32',
1135 '*multifd-channels': 'uint8',
1136 '*xbzrle-cache-size': 'size',
1137 '*max-postcopy-bandwidth': 'size',
1138 '*max-cpu-throttle': 'uint8',
1139 '*multifd-compression': 'MultiFDCompression',
1140 '*multifd-zlib-level': 'uint8',
1141 '*multifd-qatzip-level': 'uint8',
1142 '*multifd-zstd-level': 'uint8',
1143 '*block-bitmap-mapping': [ 'BitmapMigrationNodeAlias' ],
1144 '*x-vcpu-dirty-limit-period': { 'type': 'uint64',
1146 '*vcpu-dirty-limit': 'uint64',
1148 '*zero-page-detection': 'ZeroPageDetection',
1149 '*direct-io': 'bool' } }
1152 # @migrate-set-parameters:
1158 # .. qmp-example::
1160 # -> { "execute": "migrate-set-parameters" ,
1161 # "arguments": { "multifd-channels": 5 } }
1162 # <- { "return": {} }
1164 { 'command': 'migrate-set-parameters', 'boxed': true,
1172 # @announce-initial: Initial delay (in milliseconds) before sending
1175 # @announce-max: Maximum delay (in milliseconds) between packets in
1178 # @announce-rounds: Number of self-announce packets sent after
1181 # @announce-step: Increase in delay (in milliseconds) between
1184 # @throttle-trigger-threshold: The ratio of bytes_dirty_period and
1185 # bytes_xfer_period to trigger throttling. It is expressed as
1188 # @cpu-throttle-initial: Initial percentage of time guest cpus are
1189 # throttled when migration auto-converge is activated.
1192 # @cpu-throttle-increment: throttle percentage increase each time
1193 # auto-converge detects that migration is not making progress.
1196 # @cpu-throttle-tailslow: Make CPU throttling slower at tail stage.
1197 # At the tail stage of throttling, the Guest is very sensitive to
1198 # CPU percentage while the @cpu-throttle -increment is excessive
1203 # specified by @cpu-throttle-increment and the one generated by
1204 # ideal CPU percentage. Therefore, it is compatible to
1209 # @tls-creds: ID of the 'tls-creds' object that provides credentials
1217 # Note: 2.8 omits empty @tls-creds instead.
1219 # @tls-hostname: migration target's hostname for validating the
1223 # Note: 2.8 omits empty @tls-hostname instead.
1225 # @tls-authz: ID of the 'authz' object subclass that provides access
1229 # @max-bandwidth: maximum speed for migration, in bytes per second.
1232 # @avail-switchover-bandwidth: to set the available bandwidth that
1235 # calculations when making decisions to switchover. By default,
1238 # accurate, while the user is able to guarantee such bandwidth is
1243 # @downtime-limit: set maximum tolerated downtime for migration.
1246 # @x-checkpoint-delay: the delay time between two COLO checkpoints.
1249 # @multifd-channels: Number of channels used to migrate data in
1253 # @xbzrle-cache-size: cache size to be used by XBZRLE migration. It
1254 # needs to be a multiple of the target page size and a power of 2
1257 # @max-postcopy-bandwidth: Background transfer bandwidth during
1258 # postcopy. Defaults to 0 (unlimited). In bytes per second.
1261 # @max-cpu-throttle: maximum cpu throttle percentage. Defaults to 99.
1264 # @multifd-compression: Which compression method to use. Defaults to
1267 # @multifd-zlib-level: Set the compression level to be used in live
1271 # more CPU. Defaults to 1. (Since 5.0)
1273 # @multifd-qatzip-level: Set the compression level to be used in live
1276 # ratio which will consume more CPU. Defaults to 1. (Since 9.2)
1278 # @multifd-zstd-level: Set the compression level to be used in live
1282 # more CPU. Defaults to 1. (Since 5.0)
1284 # @block-bitmap-mapping: Maps block nodes and bitmaps on them to
1287 # The mapping must be one-to-one, but not necessarily complete: On
1296 # has never been set), bitmap names are mapped to themselves.
1297 # Nodes are mapped to their block device name if there is one, and
1298 # to their node name otherwise. (Since 5.2)
1300 # @x-vcpu-dirty-limit-period: Periodic time (in milliseconds) of dirty
1301 # limit during live migration. Should be in the range 1 to
1302 # 1000ms. Defaults to 1000ms. (Since 8.1)
1304 # @vcpu-dirty-limit: Dirtyrate limit (MB/s) during live migration.
1305 # Defaults to 1. (Since 8.1)
1310 # @zero-page-detection: Whether and how to detect zero pages.
1314 # @direct-io: Open migration files with O_DIRECT when possible. This
1315 # only has effect if the @mapped-ram capability is enabled.
1320 # @unstable: Members @x-checkpoint-delay and
1321 # @x-vcpu-dirty-limit-period are experimental.
1326 'data': { '*announce-initial': 'size',
1327 '*announce-max': 'size',
1328 '*announce-rounds': 'size',
1329 '*announce-step': 'size',
1330 '*throttle-trigger-threshold': 'uint8',
1331 '*cpu-throttle-initial': 'uint8',
1332 '*cpu-throttle-increment': 'uint8',
1333 '*cpu-throttle-tailslow': 'bool',
1334 '*tls-creds': 'str',
1335 '*tls-hostname': 'str',
1336 '*tls-authz': 'str',
1337 '*max-bandwidth': 'size',
1338 '*avail-switchover-bandwidth': 'size',
1339 '*downtime-limit': 'uint64',
1340 '*x-checkpoint-delay': { 'type': 'uint32',
1342 '*multifd-channels': 'uint8',
1343 '*xbzrle-cache-size': 'size',
1344 '*max-postcopy-bandwidth': 'size',
1345 '*max-cpu-throttle': 'uint8',
1346 '*multifd-compression': 'MultiFDCompression',
1347 '*multifd-zlib-level': 'uint8',
1348 '*multifd-qatzip-level': 'uint8',
1349 '*multifd-zstd-level': 'uint8',
1350 '*block-bitmap-mapping': [ 'BitmapMigrationNodeAlias' ],
1351 '*x-vcpu-dirty-limit-period': { 'type': 'uint64',
1353 '*vcpu-dirty-limit': 'uint64',
1355 '*zero-page-detection': 'ZeroPageDetection',
1356 '*direct-io': 'bool' } }
1359 # @query-migrate-parameters:
1365 # .. qmp-example::
1367 # -> { "execute": "query-migrate-parameters" }
1368 # <- { "return": {
1369 # "multifd-channels": 2,
1370 # "cpu-throttle-increment": 10,
1371 # "cpu-throttle-initial": 20,
1372 # "max-bandwidth": 33554432,
1373 # "downtime-limit": 300
1377 { 'command': 'query-migrate-parameters',
1381 # @migrate-start-postcopy:
1383 # Followup to a migration command to switch the migration to postcopy
1384 # mode. The postcopy-ram capability must be set on both source and
1389 # .. qmp-example::
1391 # -> { "execute": "migrate-start-postcopy" }
1392 # <- { "return": {} }
1394 { 'command': 'migrate-start-postcopy' }
1405 # .. qmp-example::
1407 # <- {"timestamp": {"seconds": 1432121972, "microseconds": 744001},
1424 # .. qmp-example::
1426 # <- { "timestamp": {"seconds": 1449669631, "microseconds": 239225},
1437 # @checkpoint-ready: Secondary VM (SVM) is ready for checkpointing
1439 # @checkpoint-request: Primary VM (PVM) tells SVM to prepare for
1442 # @checkpoint-reply: SVM gets PVM's checkpoint request
1444 # @vmstate-send: VM's state will be sent by PVM.
1446 # @vmstate-size: The total size of VMstate.
1448 # @vmstate-received: VM's state has been received by SVM.
1450 # @vmstate-loaded: VM's state has been loaded by SVM.
1455 'data': [ 'checkpoint-ready', 'checkpoint-request', 'checkpoint-reply',
1456 'vmstate-send', 'vmstate-size', 'vmstate-received',
1457 'vmstate-loaded' ] }
1488 # @relaunch: restart the failover process, from 'none' -> 'completed'
1499 # Emitted when VM finishes COLO mode due to some errors happening or
1508 # .. qmp-example::
1510 # <- { "timestamp": {"seconds": 2032141960, "microseconds": 417172},
1523 # `query-colo-status`.
1525 # @request: COLO exit is due to an external request.
1527 # @error: COLO exit is due to an internal error.
1537 # @x-colo-lost-heartbeat:
1539 # Tell QEMU that heartbeat is lost, request it to do takeover
1540 # procedures. If this command is sent to the PVM, the Primary side
1541 # will exit COLO mode. If sent to the Secondary, the Secondary side
1542 # will run failover work, then takes over server operation to become
1551 # .. qmp-example::
1553 # -> { "execute": "x-colo-lost-heartbeat" }
1554 # <- { "return": {} }
1556 { 'command': 'x-colo-lost-heartbeat',
1564 # migration to be started right after. When postcopy-ram is in use,
1572 # .. qmp-example::
1574 # -> { "execute": "migrate_cancel" }
1575 # <- { "return": {} }
1580 # @migrate-continue:
1584 # @state: The state the migration is currently expected to be in
1588 # .. qmp-example::
1590 # -> { "execute": "migrate-continue" , "arguments":
1591 # { "state": "pre-switchover" } }
1592 # <- { "return": {} }
1594 { 'command': 'migrate-continue', 'data': {'state': 'MigrationStatus'} }
1603 # @exec: Direct the migration stream to another process.
1607 # @file: Direct the migration stream to a file.
1617 # @filename: The file to receive the migration stream
1630 # @args: command (list head) and arguments to execute.
1658 # The migration channel-type request options.
1673 # @channel-type: Channel type for transferring packet information.
1681 'channel-type': 'MigrationChannelType',
1687 # Migrates the current running guest to another Virtual Machine.
1692 # list connected to a destination interface endpoint.
1707 # 1. The `query-migrate` command should be used to check
1712 # of default destination VM. This connection will be bound to
1715 # 3. For now, number of migration streams is restricted to one,
1721 # .. qmp-example::
1723 # -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
1724 # <- { "return": {} }
1726 # -> { "execute": "migrate",
1728 # "channels": [ { "channel-type": "main",
1733 # <- { "return": {} }
1735 # -> { "execute": "migrate",
1737 # "channels": [ { "channel-type": "main",
1739 # "args": [ "/bin/nc", "-p", "6000",
1741 # <- { "return": {} }
1743 # -> { "execute": "migrate",
1745 # "channels": [ { "channel-type": "main",
1749 # <- { "return": {} }
1751 # -> { "execute": "migrate",
1753 # "channels": [ { "channel-type": "main",
1757 # <- { "return": {} }
1766 # @migrate-incoming:
1769 # -incoming defer.
1772 # address to listen on
1775 # list connected to a destination interface endpoint.
1777 # @exit-on-error: Exit on incoming migration failure. Default true.
1778 # When set to false, the failure triggers a :qapi:event:`MIGRATION`
1779 # event, and error details could be retrieved with `query-migrate`.
1786 # 1. It's a bad idea to use a string for the uri, but it needs to
1787 # stay compatible with -incoming and the format of the uri is
1790 # 2. QEMU must be started with -incoming defer to allow
1791 # `migrate-incoming` to be used.
1793 # 3. The uri format is the same as for -incoming
1795 # 4. For now, number of migration streams is restricted to one,
1801 # .. qmp-example::
1803 # -> { "execute": "migrate-incoming",
1805 # <- { "return": {} }
1807 # -> { "execute": "migrate-incoming",
1809 # "channels": [ { "channel-type": "main",
1814 # <- { "return": {} }
1816 # -> { "execute": "migrate-incoming",
1818 # "channels": [ { "channel-type": "main",
1820 # "args": [ "/bin/nc", "-p", "6000",
1822 # <- { "return": {} }
1824 # -> { "execute": "migrate-incoming",
1826 # "channels": [ { "channel-type": "main",
1830 # <- { "return": {} }
1832 { 'command': 'migrate-incoming',
1835 '*exit-on-error': 'bool' } }
1838 # @xen-save-devices-state:
1840 # Save the state of all devices to file. The RAM and the block
1843 # @filename: the file to save the state of the devices to as binary
1844 # data. See `xen-save-devices-state`.txt for a description of the
1847 # @live: Optional argument to ask QEMU to treat this command as part
1848 # of a live migration. Default to true. (since 2.11)
1852 # .. qmp-example::
1854 # -> { "execute": "xen-save-devices-state",
1856 # <- { "return": {} }
1858 { 'command': 'xen-save-devices-state',
1862 # @xen-set-global-dirty-log:
1866 # @enable: true to enable, false to disable.
1870 # .. qmp-example::
1872 # -> { "execute": "xen-set-global-dirty-log",
1874 # <- { "return": {} }
1876 { 'command': 'xen-set-global-dirty-log', 'data': { 'enable': 'bool' } }
1879 # @xen-load-devices-state:
1881 # Load the state of all devices from file. The RAM and the block
1884 # @filename: the file to load the state of the devices from as binary
1885 # data. See `xen-save-devices-state`.txt for a description of the
1890 # .. qmp-example::
1892 # -> { "execute": "xen-load-devices-state",
1894 # <- { "return": {} }
1896 { 'command': 'xen-load-devices-state', 'data': {'filename': 'str'} }
1899 # @xen-set-replication:
1903 # @enable: true to enable, false to disable.
1907 # @failover: true to do failover, false to stop. Cannot be specified
1910 # .. qmp-example::
1912 # -> { "execute": "xen-set-replication",
1914 # <- { "return": {} }
1918 { 'command': 'xen-set-replication',
1925 # The result format for `query-xen-replication-status`.
1939 # @query-xen-replication-status:
1943 # TODO: This line is a hack to separate the example from the body
1945 # .. qmp-example::
1947 # -> { "execute": "query-xen-replication-status" }
1948 # <- { "return": { "error": false } }
1952 { 'command': 'query-xen-replication-status',
1957 # @xen-colo-do-checkpoint:
1959 # Xen uses this command to notify replication to trigger a checkpoint.
1961 # .. qmp-example::
1963 # -> { "execute": "xen-colo-do-checkpoint" }
1964 # <- { "return": {} }
1968 { 'command': 'xen-colo-do-checkpoint',
1974 # The result format for `query-colo-status`.
1979 # @last-mode: COLO last running mode. If COLO is running, this field
1981 # field to get last colo mode. (since 4.0)
1988 'data': { 'mode': 'COLOMode', 'last-mode': 'COLOMode',
1993 # @query-colo-status:
1997 # TODO: This line is a hack to separate the example from the body
1999 # .. qmp-example::
2001 # -> { "execute": "query-colo-status" }
2002 # <- { "return": { "mode": "primary", "last-mode": "none", "reason": "request" } }
2006 { 'command': 'query-colo-status',
2011 # @migrate-recover:
2015 # @uri: the URI to be used for the recovery of migration stream.
2017 # .. qmp-example::
2019 # -> { "execute": "migrate-recover",
2021 # <- { "return": {} }
2025 { 'command': 'migrate-recover',
2027 'allow-oob': true }
2030 # @migrate-pause:
2034 # .. qmp-example::
2036 # -> { "execute": "migrate-pause" }
2037 # <- { "return": {} }
2041 { 'command': 'migrate-pause', 'allow-oob': true }
2048 # Device resources in QEMU are kept on standby to be able to re-plug
2051 # @device-id: QEMU device id of the unplugged device
2055 # .. qmp-example::
2057 # <- { "event": "UNPLUG_PRIMARY",
2058 # "data": { "device-id": "hostdev0" },
2062 'data': { 'device-id': 'str' } }
2071 # @dirty-rate: dirty rate.
2076 'data': { 'id': 'int', 'dirty-rate': 'int64' } }
2097 # Method used to measure dirty page rate. Differences between
2098 # available methods are explained in `calc-dirty-rate`.
2100 # @page-sampling: use page sampling
2102 # @dirty-ring: use dirty ring
2104 # @dirty-bitmap: use dirty bitmap
2109 'data': ['page-sampling', 'dirty-ring', 'dirty-bitmap'] }
2114 # Specifies unit in which time-related value is specified.
2130 # @dirty-rate: an estimate of the dirty page rate of the VM in units
2135 # @start-time: start time in units of second for calculation
2137 # @calc-time: time period for which dirty page rate was measured,
2138 # expressed and rounded down to @calc-time-unit.
2140 # @calc-time-unit: time unit of @calc-time (Since 8.2)
2142 # @sample-pages: number of sampled pages per GiB of guest memory.
2143 # Valid only in page-sampling mode (Since 6.1)
2145 # @mode: mode that was used to measure dirty page rate (Since 6.2)
2147 # @vcpu-dirty-rate: dirty rate for each vCPU if dirty-ring mode was
2153 'data': {'*dirty-rate': 'int64',
2155 'start-time': 'int64',
2156 'calc-time': 'int64',
2157 'calc-time-unit': 'TimeUnit',
2158 'sample-pages': 'uint64',
2160 '*vcpu-dirty-rate': [ 'DirtyRateVcpu' ] } }
2163 # @calc-dirty-rate:
2166 # with `query-dirty-rate` after measurements are completed.
2177 # only an estimate of its true value. Increasing @sample-pages
2181 # 2. Dirty bitmap mode captures writes to memory (for example by
2182 # temporarily revoking write access to all pages) and counting page
2184 # bitmap, where each bit corresponds to one guest page. This mode
2185 # requires that KVM accelerator property "dirty-ring-size" is *not*
2188 # 3. Dirty ring mode is similar to dirty bitmap mode, but the
2191 # requires that KVM accelerator property "dirty-ring-size" is set.
2193 # @calc-time: time period for which dirty page rate is calculated. By
2195 # explicitly with @calc-time-unit. Note that larger @calc-time
2197 # page dirtying is a one-time event. Once some page is counted as
2198 # dirty during @calc-time period, further writes to this page will
2201 # @calc-time-unit: time unit in which @calc-time is specified. By
2204 # @sample-pages: number of sampled pages per each GiB of guest memory.
2205 # Default value is 512. For 4KiB guest pages this corresponds to
2210 # 'page-sampling'. Others are 'dirty-bitmap' and 'dirty-ring'.
2215 # .. qmp-example::
2217 # -> {"execute": "calc-dirty-rate", "arguments": {"calc-time": 1,
2218 # "sample-pages": 512} }
2219 # <- { "return": {} }
2221 # .. qmp-example::
2226 # -> {"execute": "calc-dirty-rate", "arguments": {"calc-time": 500,
2227 # "calc-time-unit": "millisecond", "mode": "dirty-bitmap"} }
2229 # <- { "return": {} }
2231 { 'command': 'calc-dirty-rate', 'data': {'calc-time': 'int64',
2232 '*calc-time-unit': 'TimeUnit',
2233 '*sample-pages': 'int',
2237 # @query-dirty-rate:
2239 # Query results of the most recent invocation of `calc-dirty-rate`.
2241 # @calc-time-unit: time unit in which to report calculation time.
2246 # .. qmp-example::
2249 # <- {"status": "measuring", "sample-pages": 512,
2250 # "mode": "page-sampling", "start-time": 1693900454, "calc-time": 10,
2251 # "calc-time-unit": "second"}
2253 # .. qmp-example::
2256 # <- {"status": "measured", "sample-pages": 512, "dirty-rate": 108,
2257 # "mode": "page-sampling", "start-time": 1693900454, "calc-time": 10,
2258 # "calc-time-unit": "second"}
2260 { 'command': 'query-dirty-rate', 'data': {'*calc-time-unit': 'TimeUnit' },
2268 # @cpu-index: index of a virtual CPU.
2270 # @limit-rate: upper limit of dirty page rate (MB/s) for a virtual
2273 # @current-rate: current dirty page rate (MB/s) for a virtual CPU.
2278 'data': { 'cpu-index': 'int',
2279 'limit-rate': 'uint64',
2280 'current-rate': 'uint64' } }
2283 # @set-vcpu-dirty-limit:
2287 # Requires KVM with accelerator property "dirty-ring-size" set. A
2288 # virtual CPU's dirty page rate is a measure of its memory load. To
2289 # observe dirty page rates, use `calc-dirty-rate`.
2291 # @cpu-index: index of a virtual CPU, default is all.
2293 # @dirty-rate: upper limit of dirty page rate (MB/s) for virtual CPUs.
2297 # .. qmp-example::
2299 # -> {"execute": "set-vcpu-dirty-limit"}
2300 # "arguments": { "dirty-rate": 200,
2301 # "cpu-index": 1 } }
2302 # <- { "return": {} }
2304 { 'command': 'set-vcpu-dirty-limit',
2305 'data': { '*cpu-index': 'int',
2306 'dirty-rate': 'uint64' } }
2309 # @cancel-vcpu-dirty-limit:
2314 # `set-vcpu-dirty-limit` command. Note that this command requires
2315 # support from dirty ring, same as the `set-vcpu-dirty-limit`.
2317 # @cpu-index: index of a virtual CPU, default is all.
2321 # .. qmp-example::
2323 # -> {"execute": "cancel-vcpu-dirty-limit"},
2324 # "arguments": { "cpu-index": 1 } }
2325 # <- { "return": {} }
2327 { 'command': 'cancel-vcpu-dirty-limit',
2328 'data': { '*cpu-index': 'int'} }
2331 # @query-vcpu-dirty-limit:
2338 # .. qmp-example::
2340 # -> {"execute": "query-vcpu-dirty-limit"}
2341 # <- {"return": [
2342 # { "limit-rate": 60, "current-rate": 3, "cpu-index": 0},
2343 # { "limit-rate": 60, "current-rate": 3, "cpu-index": 1}]}
2345 { 'command': 'query-vcpu-dirty-limit',
2355 # @thread-id: ID of the underlying host thread
2361 'thread-id': 'int'} }
2364 # @query-migrationthreads:
2374 { 'command': 'query-migrationthreads',
2379 # @snapshot-save:
2383 # @job-id: identifier for the newly created job
2385 # @tag: name of the snapshot to create
2387 # @vmstate: block device node name to save vmstate to
2389 # @devices: list of block device node names to save a snapshot to
2393 # to determine completion and to fetch details of any errors that
2397 # it takes to save the snapshot. A future version of QEMU may ensure
2405 # .. qmp-example::
2407 # -> { "execute": "snapshot-save",
2409 # "job-id": "snapsave0",
2410 # "tag": "my-snap",
2415 # <- { "return": { } }
2416 # <- {"event": "JOB_STATUS_CHANGE",
2419 # <- {"event": "JOB_STATUS_CHANGE",
2422 # <- {"event": "STOP",
2424 # <- {"event": "RESUME",
2426 # <- {"event": "JOB_STATUS_CHANGE",
2429 # <- {"event": "JOB_STATUS_CHANGE",
2432 # <- {"event": "JOB_STATUS_CHANGE",
2435 # -> {"execute": "query-jobs"}
2436 # <- {"return": [{"current-progress": 1,
2438 # "total-progress": 1,
2439 # "type": "snapshot-save",
2444 { 'command': 'snapshot-save',
2445 'data': { 'job-id': 'str',
2451 # @snapshot-load:
2455 # @job-id: identifier for the newly created job
2457 # @tag: name of the snapshot to load.
2459 # @vmstate: block device node name to load vmstate from
2461 # @devices: list of block device node names to load a snapshot from
2465 # to determine completion and to fetch details of any errors that
2469 # time it takes to load the snapshot.
2472 # device nodes that can have changed since the original `snapshot-save`
2475 # .. qmp-example::
2477 # -> { "execute": "snapshot-load",
2479 # "job-id": "snapload0",
2480 # "tag": "my-snap",
2485 # <- { "return": { } }
2486 # <- {"event": "JOB_STATUS_CHANGE",
2489 # <- {"event": "JOB_STATUS_CHANGE",
2492 # <- {"event": "STOP",
2494 # <- {"event": "RESUME",
2496 # <- {"event": "JOB_STATUS_CHANGE",
2499 # <- {"event": "JOB_STATUS_CHANGE",
2502 # <- {"event": "JOB_STATUS_CHANGE",
2505 # -> {"execute": "query-jobs"}
2506 # <- {"return": [{"current-progress": 1,
2508 # "total-progress": 1,
2509 # "type": "snapshot-load",
2514 { 'command': 'snapshot-load',
2515 'data': { 'job-id': 'str',
2521 # @snapshot-delete:
2525 # @job-id: identifier for the newly created job
2527 # @tag: name of the snapshot to delete.
2529 # @devices: list of block device node names to delete a snapshot from
2533 # to determine completion and to fetch details of any errors that
2536 # .. qmp-example::
2538 # -> { "execute": "snapshot-delete",
2540 # "job-id": "snapdelete0",
2541 # "tag": "my-snap",
2545 # <- { "return": { } }
2546 # <- {"event": "JOB_STATUS_CHANGE",
2549 # <- {"event": "JOB_STATUS_CHANGE",
2552 # <- {"event": "JOB_STATUS_CHANGE",
2555 # <- {"event": "JOB_STATUS_CHANGE",
2558 # <- {"event": "JOB_STATUS_CHANGE",
2561 # -> {"execute": "query-jobs"}
2562 # <- {"return": [{"current-progress": 1,
2564 # "total-progress": 1,
2565 # "type": "snapshot-delete",
2570 { 'command': 'snapshot-delete',
2571 'data': { 'job-id': 'str',