s390x: upgrade status of KVM cores to "supported"
[qemu/ar7.git] / qapi / migration.json
blob7a795ecc160f7f24c5ae985bc8be41d80c03508d
1 # -*- Mode: Python -*-
4 ##
5 # = Migration
6 ##
8 { 'include': 'common.json' }
11 # @MigrationStats:
13 # Detailed migration status.
15 # @transferred: amount of bytes already transferred to the target VM
17 # @remaining: amount of bytes remaining to be transferred to the target VM
19 # @total: total amount of bytes involved in the migration process
21 # @duplicate: number of duplicate (zero) pages (since 1.2)
23 # @skipped: number of skipped zero pages (since 1.5)
25 # @normal: number of normal pages (since 1.2)
27 # @normal-bytes: number of normal bytes sent (since 1.2)
29 # @dirty-pages-rate: number of pages dirtied by second by the
30 #        guest (since 1.3)
32 # @mbps: throughput in megabits/sec. (since 1.6)
34 # @dirty-sync-count: number of times that dirty ram was synchronized (since 2.1)
36 # @postcopy-requests: The number of page requests received from the destination
37 #        (since 2.7)
39 # @page-size: The number of bytes per page for the various page-based
40 #        statistics (since 2.10)
42 # @multifd-bytes: The number of bytes sent through multifd (since 3.0)
44 # @pages-per-second: the number of memory pages transferred per second
45 #        (Since 4.0)
47 # Since: 0.14.0
49 { 'struct': 'MigrationStats',
50   'data': {'transferred': 'int', 'remaining': 'int', 'total': 'int' ,
51            'duplicate': 'int', 'skipped': 'int', 'normal': 'int',
52            'normal-bytes': 'int', 'dirty-pages-rate' : 'int',
53            'mbps' : 'number', 'dirty-sync-count' : 'int',
54            'postcopy-requests' : 'int', 'page-size' : 'int',
55            'multifd-bytes' : 'uint64', 'pages-per-second' : 'uint64' } }
58 # @XBZRLECacheStats:
60 # Detailed XBZRLE migration cache statistics
62 # @cache-size: XBZRLE cache size
64 # @bytes: amount of bytes already transferred to the target VM
66 # @pages: amount of pages transferred to the target VM
68 # @cache-miss: number of cache miss
70 # @cache-miss-rate: rate of cache miss (since 2.1)
72 # @overflow: number of overflows
74 # Since: 1.2
76 { 'struct': 'XBZRLECacheStats',
77   'data': {'cache-size': 'int', 'bytes': 'int', 'pages': 'int',
78            'cache-miss': 'int', 'cache-miss-rate': 'number',
79            'overflow': 'int' } }
82 # @CompressionStats:
84 # Detailed migration compression statistics
86 # @pages: amount of pages compressed and transferred to the target VM
88 # @busy: count of times that no free thread was available to compress data
90 # @busy-rate: rate of thread busy
92 # @compressed-size: amount of bytes after compression
94 # @compression-rate: rate of compressed size
96 # Since: 3.1
98 { 'struct': 'CompressionStats',
99   'data': {'pages': 'int', 'busy': 'int', 'busy-rate': 'number',
100            'compressed-size': 'int', 'compression-rate': 'number' } }
103 # @MigrationStatus:
105 # An enumeration of migration status.
107 # @none: no migration has ever happened.
109 # @setup: migration process has been initiated.
111 # @cancelling: in the process of cancelling migration.
113 # @cancelled: cancelling migration is finished.
115 # @active: in the process of doing migration.
117 # @postcopy-active: like active, but now in postcopy mode. (since 2.5)
119 # @postcopy-paused: during postcopy but paused. (since 3.0)
121 # @postcopy-recover: trying to recover from a paused postcopy. (since 3.0)
123 # @completed: migration is finished.
125 # @failed: some error occurred during migration process.
127 # @colo: VM is in the process of fault tolerance, VM can not get into this
128 #        state unless colo capability is enabled for migration. (since 2.8)
130 # @pre-switchover: Paused before device serialisation. (since 2.11)
132 # @device: During device serialisation when pause-before-switchover is enabled
133 #        (since 2.11)
135 # Since: 2.3
138 { 'enum': 'MigrationStatus',
139   'data': [ 'none', 'setup', 'cancelling', 'cancelled',
140             'active', 'postcopy-active', 'postcopy-paused',
141             'postcopy-recover', 'completed', 'failed', 'colo',
142             'pre-switchover', 'device' ] }
145 # @MigrationInfo:
147 # Information about current migration process.
149 # @status: @MigrationStatus describing the current migration status.
150 #          If this field is not returned, no migration process
151 #          has been initiated
153 # @ram: @MigrationStats containing detailed migration
154 #       status, only returned if status is 'active' or
155 #       'completed'(since 1.2)
157 # @disk: @MigrationStats containing detailed disk migration
158 #        status, only returned if status is 'active' and it is a block
159 #        migration
161 # @xbzrle-cache: @XBZRLECacheStats containing detailed XBZRLE
162 #                migration statistics, only returned if XBZRLE feature is on and
163 #                status is 'active' or 'completed' (since 1.2)
165 # @total-time: total amount of milliseconds since migration started.
166 #        If migration has ended, it returns the total migration
167 #        time. (since 1.2)
169 # @downtime: only present when migration finishes correctly
170 #        total downtime in milliseconds for the guest.
171 #        (since 1.3)
173 # @expected-downtime: only present while migration is active
174 #        expected downtime in milliseconds for the guest in last walk
175 #        of the dirty bitmap. (since 1.3)
177 # @setup-time: amount of setup time in milliseconds _before_ the
178 #        iterations begin but _after_ the QMP command is issued. This is designed
179 #        to provide an accounting of any activities (such as RDMA pinning) which
180 #        may be expensive, but do not actually occur during the iterative
181 #        migration rounds themselves. (since 1.6)
183 # @cpu-throttle-percentage: percentage of time guest cpus are being
184 #        throttled during auto-converge. This is only present when auto-converge
185 #        has started throttling guest cpus. (Since 2.7)
187 # @error-desc: the human readable error description string, when
188 #              @status is 'failed'. Clients should not attempt to parse the
189 #              error strings. (Since 2.7)
191 # @postcopy-blocktime: total time when all vCPU were blocked during postcopy
192 #           live migration. This is only present when the postcopy-blocktime
193 #           migration capability is enabled. (Since 3.0)
195 # @postcopy-vcpu-blocktime: list of the postcopy blocktime per vCPU.  This is
196 #           only present when the postcopy-blocktime migration capability
197 #           is enabled. (Since 3.0)
199 # @compression: migration compression statistics, only returned if compression
200 #           feature is on and status is 'active' or 'completed' (Since 3.1)
202 # Since: 0.14.0
204 { 'struct': 'MigrationInfo',
205   'data': {'*status': 'MigrationStatus', '*ram': 'MigrationStats',
206            '*disk': 'MigrationStats',
207            '*xbzrle-cache': 'XBZRLECacheStats',
208            '*total-time': 'int',
209            '*expected-downtime': 'int',
210            '*downtime': 'int',
211            '*setup-time': 'int',
212            '*cpu-throttle-percentage': 'int',
213            '*error-desc': 'str',
214            '*postcopy-blocktime' : 'uint32',
215            '*postcopy-vcpu-blocktime': ['uint32'],
216            '*compression': 'CompressionStats'} }
219 # @query-migrate:
221 # Returns information about current migration process. If migration
222 # is active there will be another json-object with RAM migration
223 # status and if block migration is active another one with block
224 # migration status.
226 # Returns: @MigrationInfo
228 # Since: 0.14.0
230 # Example:
232 # 1. Before the first migration
234 # -> { "execute": "query-migrate" }
235 # <- { "return": {} }
237 # 2. Migration is done and has succeeded
239 # -> { "execute": "query-migrate" }
240 # <- { "return": {
241 #         "status": "completed",
242 #         "total-time":12345,
243 #         "setup-time":12345,
244 #         "downtime":12345,
245 #         "ram":{
246 #           "transferred":123,
247 #           "remaining":123,
248 #           "total":246,
249 #           "duplicate":123,
250 #           "normal":123,
251 #           "normal-bytes":123456,
252 #           "dirty-sync-count":15
253 #         }
254 #      }
255 #    }
257 # 3. Migration is done and has failed
259 # -> { "execute": "query-migrate" }
260 # <- { "return": { "status": "failed" } }
262 # 4. Migration is being performed and is not a block migration:
264 # -> { "execute": "query-migrate" }
265 # <- {
266 #       "return":{
267 #          "status":"active",
268 #          "total-time":12345,
269 #          "setup-time":12345,
270 #          "expected-downtime":12345,
271 #          "ram":{
272 #             "transferred":123,
273 #             "remaining":123,
274 #             "total":246,
275 #             "duplicate":123,
276 #             "normal":123,
277 #             "normal-bytes":123456,
278 #             "dirty-sync-count":15
279 #          }
280 #       }
281 #    }
283 # 5. Migration is being performed and is a block migration:
285 # -> { "execute": "query-migrate" }
286 # <- {
287 #       "return":{
288 #          "status":"active",
289 #          "total-time":12345,
290 #          "setup-time":12345,
291 #          "expected-downtime":12345,
292 #          "ram":{
293 #             "total":1057024,
294 #             "remaining":1053304,
295 #             "transferred":3720,
296 #             "duplicate":123,
297 #             "normal":123,
298 #             "normal-bytes":123456,
299 #             "dirty-sync-count":15
300 #          },
301 #          "disk":{
302 #             "total":20971520,
303 #             "remaining":20880384,
304 #             "transferred":91136
305 #          }
306 #       }
307 #    }
309 # 6. Migration is being performed and XBZRLE is active:
311 # -> { "execute": "query-migrate" }
312 # <- {
313 #       "return":{
314 #          "status":"active",
315 #          "total-time":12345,
316 #          "setup-time":12345,
317 #          "expected-downtime":12345,
318 #          "ram":{
319 #             "total":1057024,
320 #             "remaining":1053304,
321 #             "transferred":3720,
322 #             "duplicate":10,
323 #             "normal":3333,
324 #             "normal-bytes":3412992,
325 #             "dirty-sync-count":15
326 #          },
327 #          "xbzrle-cache":{
328 #             "cache-size":67108864,
329 #             "bytes":20971520,
330 #             "pages":2444343,
331 #             "cache-miss":2244,
332 #             "cache-miss-rate":0.123,
333 #             "overflow":34434
334 #          }
335 #       }
336 #    }
339 { 'command': 'query-migrate', 'returns': 'MigrationInfo' }
342 # @MigrationCapability:
344 # Migration capabilities enumeration
346 # @xbzrle: Migration supports xbzrle (Xor Based Zero Run Length Encoding).
347 #          This feature allows us to minimize migration traffic for certain work
348 #          loads, by sending compressed difference of the pages
350 # @rdma-pin-all: Controls whether or not the entire VM memory footprint is
351 #          mlock()'d on demand or all at once. Refer to docs/rdma.txt for usage.
352 #          Disabled by default. (since 2.0)
354 # @zero-blocks: During storage migration encode blocks of zeroes efficiently. This
355 #          essentially saves 1MB of zeroes per block on the wire. Enabling requires
356 #          source and target VM to support this feature. To enable it is sufficient
357 #          to enable the capability on the source VM. The feature is disabled by
358 #          default. (since 1.6)
360 # @compress: Use multiple compression threads to accelerate live migration.
361 #          This feature can help to reduce the migration traffic, by sending
362 #          compressed pages. Please note that if compress and xbzrle are both
363 #          on, compress only takes effect in the ram bulk stage, after that,
364 #          it will be disabled and only xbzrle takes effect, this can help to
365 #          minimize migration traffic. The feature is disabled by default.
366 #          (since 2.4 )
368 # @events: generate events for each migration state change
369 #          (since 2.4 )
371 # @auto-converge: If enabled, QEMU will automatically throttle down the guest
372 #          to speed up convergence of RAM migration. (since 1.6)
374 # @postcopy-ram: Start executing on the migration target before all of RAM has
375 #          been migrated, pulling the remaining pages along as needed. The
376 #          capacity must have the same setting on both source and target
377 #          or migration will not even start. NOTE: If the migration fails during
378 #          postcopy the VM will fail.  (since 2.6)
380 # @x-colo: If enabled, migration will never end, and the state of the VM on the
381 #        primary side will be migrated continuously to the VM on secondary
382 #        side, this process is called COarse-Grain LOck Stepping (COLO) for
383 #        Non-stop Service. (since 2.8)
385 # @release-ram: if enabled, qemu will free the migrated ram pages on the source
386 #        during postcopy-ram migration. (since 2.9)
388 # @block: If enabled, QEMU will also migrate the contents of all block
389 #          devices.  Default is disabled.  A possible alternative uses
390 #          mirror jobs to a builtin NBD server on the destination, which
391 #          offers more flexibility.
392 #          (Since 2.10)
394 # @return-path: If enabled, migration will use the return path even
395 #               for precopy. (since 2.10)
397 # @pause-before-switchover: Pause outgoing migration before serialising device
398 #          state and before disabling block IO (since 2.11)
400 # @x-multifd: Use more than one fd for migration (since 2.11)
402 # @dirty-bitmaps: If enabled, QEMU will migrate named dirty bitmaps.
403 #                 (since 2.12)
405 # @postcopy-blocktime: Calculate downtime for postcopy live migration
406 #                     (since 3.0)
408 # @late-block-activate: If enabled, the destination will not activate block
409 #           devices (and thus take locks) immediately at the end of migration.
410 #           (since 3.0)
412 # Since: 1.2
414 { 'enum': 'MigrationCapability',
415   'data': ['xbzrle', 'rdma-pin-all', 'auto-converge', 'zero-blocks',
416            'compress', 'events', 'postcopy-ram', 'x-colo', 'release-ram',
417            'block', 'return-path', 'pause-before-switchover', 'x-multifd',
418            'dirty-bitmaps', 'postcopy-blocktime', 'late-block-activate' ] }
421 # @MigrationCapabilityStatus:
423 # Migration capability information
425 # @capability: capability enum
427 # @state: capability state bool
429 # Since: 1.2
431 { 'struct': 'MigrationCapabilityStatus',
432   'data': { 'capability' : 'MigrationCapability', 'state' : 'bool' } }
435 # @migrate-set-capabilities:
437 # Enable/Disable the following migration capabilities (like xbzrle)
439 # @capabilities: json array of capability modifications to make
441 # Since: 1.2
443 # Example:
445 # -> { "execute": "migrate-set-capabilities" , "arguments":
446 #      { "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
449 { 'command': 'migrate-set-capabilities',
450   'data': { 'capabilities': ['MigrationCapabilityStatus'] } }
453 # @query-migrate-capabilities:
455 # Returns information about the current migration capabilities status
457 # Returns: @MigrationCapabilitiesStatus
459 # Since: 1.2
461 # Example:
463 # -> { "execute": "query-migrate-capabilities" }
464 # <- { "return": [
465 #       {"state": false, "capability": "xbzrle"},
466 #       {"state": false, "capability": "rdma-pin-all"},
467 #       {"state": false, "capability": "auto-converge"},
468 #       {"state": false, "capability": "zero-blocks"},
469 #       {"state": false, "capability": "compress"},
470 #       {"state": true, "capability": "events"},
471 #       {"state": false, "capability": "postcopy-ram"},
472 #       {"state": false, "capability": "x-colo"}
473 #    ]}
476 { 'command': 'query-migrate-capabilities', 'returns':   ['MigrationCapabilityStatus']}
479 # @MigrationParameter:
481 # Migration parameters enumeration
483 # @compress-level: Set the compression level to be used in live migration,
484 #          the compression level is an integer between 0 and 9, where 0 means
485 #          no compression, 1 means the best compression speed, and 9 means best
486 #          compression ratio which will consume more CPU.
488 # @compress-threads: Set compression thread count to be used in live migration,
489 #          the compression thread count is an integer between 1 and 255.
491 # @compress-wait-thread: Controls behavior when all compression threads are
492 #                        currently busy. If true (default), wait for a free
493 #                        compression thread to become available; otherwise,
494 #                        send the page uncompressed. (Since 3.1)
496 # @decompress-threads: Set decompression thread count to be used in live
497 #          migration, the decompression thread count is an integer between 1
498 #          and 255. Usually, decompression is at least 4 times as fast as
499 #          compression, so set the decompress-threads to the number about 1/4
500 #          of compress-threads is adequate.
502 # @cpu-throttle-initial: Initial percentage of time guest cpus are throttled
503 #                        when migration auto-converge is activated. The
504 #                        default value is 20. (Since 2.7)
506 # @cpu-throttle-increment: throttle percentage increase each time
507 #                          auto-converge detects that migration is not making
508 #                          progress. The default value is 10. (Since 2.7)
510 # @tls-creds: ID of the 'tls-creds' object that provides credentials for
511 #             establishing a TLS connection over the migration data channel.
512 #             On the outgoing side of the migration, the credentials must
513 #             be for a 'client' endpoint, while for the incoming side the
514 #             credentials must be for a 'server' endpoint. Setting this
515 #             will enable TLS for all migrations. The default is unset,
516 #             resulting in unsecured migration at the QEMU level. (Since 2.7)
518 # @tls-hostname: hostname of the target host for the migration. This is
519 #                required when using x509 based TLS credentials and the
520 #                migration URI does not already include a hostname. For
521 #                example if using fd: or exec: based migration, the
522 #                hostname must be provided so that the server's x509
523 #                certificate identity can be validated. (Since 2.7)
525 # @max-bandwidth: to set maximum speed for migration. maximum speed in
526 #                 bytes per second. (Since 2.8)
528 # @downtime-limit: set maximum tolerated downtime for migration. maximum
529 #                  downtime in milliseconds (Since 2.8)
531 # @x-checkpoint-delay: The delay time (in ms) between two COLO checkpoints in
532 #          periodic mode. (Since 2.8)
534 # @block-incremental: Affects how much storage is migrated when the
535 #       block migration capability is enabled.  When false, the entire
536 #       storage backing chain is migrated into a flattened image at
537 #       the destination; when true, only the active qcow2 layer is
538 #       migrated and the destination must already have access to the
539 #       same backing chain as was used on the source.  (since 2.10)
541 # @x-multifd-channels: Number of channels used to migrate data in
542 #                     parallel. This is the same number that the
543 #                     number of sockets used for migration.  The
544 #                     default value is 2 (since 2.11)
546 # @x-multifd-page-count: Number of pages sent together to a thread.
547 #                        The default value is 16 (since 2.11)
549 # @xbzrle-cache-size: cache size to be used by XBZRLE migration.  It
550 #                     needs to be a multiple of the target page size
551 #                     and a power of 2
552 #                     (Since 2.11)
554 # @max-postcopy-bandwidth: Background transfer bandwidth during postcopy.
555 #                     Defaults to 0 (unlimited).  In bytes per second.
556 #                     (Since 3.0)
558 # @max-cpu-throttle: maximum cpu throttle percentage.
559 #                    Defaults to 99. (Since 3.1)
560 # Since: 2.4
562 { 'enum': 'MigrationParameter',
563   'data': ['compress-level', 'compress-threads', 'decompress-threads',
564            'compress-wait-thread',
565            'cpu-throttle-initial', 'cpu-throttle-increment',
566            'tls-creds', 'tls-hostname', 'max-bandwidth',
567            'downtime-limit', 'x-checkpoint-delay', 'block-incremental',
568            'x-multifd-channels', 'x-multifd-page-count',
569            'xbzrle-cache-size', 'max-postcopy-bandwidth',
570            'max-cpu-throttle' ] }
573 # @MigrateSetParameters:
575 # @compress-level: compression level
577 # @compress-threads: compression thread count
579 # @compress-wait-thread: Controls behavior when all compression threads are
580 #                        currently busy. If true (default), wait for a free
581 #                        compression thread to become available; otherwise,
582 #                        send the page uncompressed. (Since 3.1)
584 # @decompress-threads: decompression thread count
586 # @cpu-throttle-initial: Initial percentage of time guest cpus are
587 #                        throttled when migration auto-converge is activated.
588 #                        The default value is 20. (Since 2.7)
590 # @cpu-throttle-increment: throttle percentage increase each time
591 #                          auto-converge detects that migration is not making
592 #                          progress. The default value is 10. (Since 2.7)
594 # @tls-creds: ID of the 'tls-creds' object that provides credentials
595 #             for establishing a TLS connection over the migration data
596 #             channel. On the outgoing side of the migration, the credentials
597 #             must be for a 'client' endpoint, while for the incoming side the
598 #             credentials must be for a 'server' endpoint. Setting this
599 #             to a non-empty string enables TLS for all migrations.
600 #             An empty string means that QEMU will use plain text mode for
601 #             migration, rather than TLS (Since 2.9)
602 #             Previously (since 2.7), this was reported by omitting
603 #             tls-creds instead.
605 # @tls-hostname: hostname of the target host for the migration. This
606 #                is required when using x509 based TLS credentials and the
607 #                migration URI does not already include a hostname. For
608 #                example if using fd: or exec: based migration, the
609 #                hostname must be provided so that the server's x509
610 #                certificate identity can be validated. (Since 2.7)
611 #                An empty string means that QEMU will use the hostname
612 #                associated with the migration URI, if any. (Since 2.9)
613 #                Previously (since 2.7), this was reported by omitting
614 #                tls-hostname instead.
616 # @max-bandwidth: to set maximum speed for migration. maximum speed in
617 #                 bytes per second. (Since 2.8)
619 # @downtime-limit: set maximum tolerated downtime for migration. maximum
620 #                  downtime in milliseconds (Since 2.8)
622 # @x-checkpoint-delay: the delay time between two COLO checkpoints. (Since 2.8)
624 # @block-incremental: Affects how much storage is migrated when the
625 #       block migration capability is enabled.  When false, the entire
626 #       storage backing chain is migrated into a flattened image at
627 #       the destination; when true, only the active qcow2 layer is
628 #       migrated and the destination must already have access to the
629 #       same backing chain as was used on the source.  (since 2.10)
631 # @x-multifd-channels: Number of channels used to migrate data in
632 #                     parallel. This is the same number that the
633 #                     number of sockets used for migration.  The
634 #                     default value is 2 (since 2.11)
636 # @x-multifd-page-count: Number of pages sent together to a thread.
637 #                        The default value is 16 (since 2.11)
639 # @xbzrle-cache-size: cache size to be used by XBZRLE migration.  It
640 #                     needs to be a multiple of the target page size
641 #                     and a power of 2
642 #                     (Since 2.11)
644 # @max-postcopy-bandwidth: Background transfer bandwidth during postcopy.
645 #                     Defaults to 0 (unlimited).  In bytes per second.
646 #                     (Since 3.0)
648 # @max-cpu-throttle: maximum cpu throttle percentage.
649 #                    The default value is 99. (Since 3.1)
651 # Since: 2.4
653 # TODO either fuse back into MigrationParameters, or make
654 # MigrationParameters members mandatory
655 { 'struct': 'MigrateSetParameters',
656   'data': { '*compress-level': 'int',
657             '*compress-threads': 'int',
658             '*compress-wait-thread': 'bool',
659             '*decompress-threads': 'int',
660             '*cpu-throttle-initial': 'int',
661             '*cpu-throttle-increment': 'int',
662             '*tls-creds': 'StrOrNull',
663             '*tls-hostname': 'StrOrNull',
664             '*max-bandwidth': 'int',
665             '*downtime-limit': 'int',
666             '*x-checkpoint-delay': 'int',
667             '*block-incremental': 'bool',
668             '*x-multifd-channels': 'int',
669             '*x-multifd-page-count': 'int',
670             '*xbzrle-cache-size': 'size',
671             '*max-postcopy-bandwidth': 'size',
672             '*max-cpu-throttle': 'int' } }
675 # @migrate-set-parameters:
677 # Set various migration parameters.
679 # Since: 2.4
681 # Example:
683 # -> { "execute": "migrate-set-parameters" ,
684 #      "arguments": { "compress-level": 1 } }
687 { 'command': 'migrate-set-parameters', 'boxed': true,
688   'data': 'MigrateSetParameters' }
691 # @MigrationParameters:
693 # The optional members aren't actually optional.
695 # @compress-level: compression level
697 # @compress-threads: compression thread count
699 # @compress-wait-thread: Controls behavior when all compression threads are
700 #                        currently busy. If true (default), wait for a free
701 #                        compression thread to become available; otherwise,
702 #                        send the page uncompressed. (Since 3.1)
704 # @decompress-threads: decompression thread count
706 # @cpu-throttle-initial: Initial percentage of time guest cpus are
707 #                        throttled when migration auto-converge is activated.
708 #                        (Since 2.7)
710 # @cpu-throttle-increment: throttle percentage increase each time
711 #                          auto-converge detects that migration is not making
712 #                          progress. (Since 2.7)
714 # @tls-creds: ID of the 'tls-creds' object that provides credentials
715 #             for establishing a TLS connection over the migration data
716 #             channel. On the outgoing side of the migration, the credentials
717 #             must be for a 'client' endpoint, while for the incoming side the
718 #             credentials must be for a 'server' endpoint.
719 #             An empty string means that QEMU will use plain text mode for
720 #             migration, rather than TLS (Since 2.7)
721 #             Note: 2.8 reports this by omitting tls-creds instead.
723 # @tls-hostname: hostname of the target host for the migration. This
724 #                is required when using x509 based TLS credentials and the
725 #                migration URI does not already include a hostname. For
726 #                example if using fd: or exec: based migration, the
727 #                hostname must be provided so that the server's x509
728 #                certificate identity can be validated. (Since 2.7)
729 #                An empty string means that QEMU will use the hostname
730 #                associated with the migration URI, if any. (Since 2.9)
731 #                Note: 2.8 reports this by omitting tls-hostname instead.
733 # @max-bandwidth: to set maximum speed for migration. maximum speed in
734 #                 bytes per second. (Since 2.8)
736 # @downtime-limit: set maximum tolerated downtime for migration. maximum
737 #                  downtime in milliseconds (Since 2.8)
739 # @x-checkpoint-delay: the delay time between two COLO checkpoints. (Since 2.8)
741 # @block-incremental: Affects how much storage is migrated when the
742 #       block migration capability is enabled.  When false, the entire
743 #       storage backing chain is migrated into a flattened image at
744 #       the destination; when true, only the active qcow2 layer is
745 #       migrated and the destination must already have access to the
746 #       same backing chain as was used on the source.  (since 2.10)
748 # @x-multifd-channels: Number of channels used to migrate data in
749 #                     parallel. This is the same number that the
750 #                     number of sockets used for migration.
751 #                     The default value is 2 (since 2.11)
753 # @x-multifd-page-count: Number of pages sent together to a thread.
754 #                        The default value is 16 (since 2.11)
756 # @xbzrle-cache-size: cache size to be used by XBZRLE migration.  It
757 #                     needs to be a multiple of the target page size
758 #                     and a power of 2
759 #                     (Since 2.11)
761 # @max-postcopy-bandwidth: Background transfer bandwidth during postcopy.
762 #                     Defaults to 0 (unlimited).  In bytes per second.
763 #                     (Since 3.0)
765 # @max-cpu-throttle: maximum cpu throttle percentage.
766 #                    Defaults to 99.
767 #                     (Since 3.1)
769 # Since: 2.4
771 { 'struct': 'MigrationParameters',
772   'data': { '*compress-level': 'uint8',
773             '*compress-threads': 'uint8',
774             '*compress-wait-thread': 'bool',
775             '*decompress-threads': 'uint8',
776             '*cpu-throttle-initial': 'uint8',
777             '*cpu-throttle-increment': 'uint8',
778             '*tls-creds': 'str',
779             '*tls-hostname': 'str',
780             '*max-bandwidth': 'size',
781             '*downtime-limit': 'uint64',
782             '*x-checkpoint-delay': 'uint32',
783             '*block-incremental': 'bool' ,
784             '*x-multifd-channels': 'uint8',
785             '*x-multifd-page-count': 'uint32',
786             '*xbzrle-cache-size': 'size',
787             '*max-postcopy-bandwidth': 'size',
788             '*max-cpu-throttle':'uint8'} }
791 # @query-migrate-parameters:
793 # Returns information about the current migration parameters
795 # Returns: @MigrationParameters
797 # Since: 2.4
799 # Example:
801 # -> { "execute": "query-migrate-parameters" }
802 # <- { "return": {
803 #          "decompress-threads": 2,
804 #          "cpu-throttle-increment": 10,
805 #          "compress-threads": 8,
806 #          "compress-level": 1,
807 #          "cpu-throttle-initial": 20,
808 #          "max-bandwidth": 33554432,
809 #          "downtime-limit": 300
810 #       }
811 #    }
814 { 'command': 'query-migrate-parameters',
815   'returns': 'MigrationParameters' }
818 # @client_migrate_info:
820 # Set migration information for remote display.  This makes the server
821 # ask the client to automatically reconnect using the new parameters
822 # once migration finished successfully.  Only implemented for SPICE.
824 # @protocol:     must be "spice"
825 # @hostname:     migration target hostname
826 # @port:         spice tcp port for plaintext channels
827 # @tls-port:     spice tcp port for tls-secured channels
828 # @cert-subject: server certificate subject
830 # Since: 0.14.0
832 # Example:
834 # -> { "execute": "client_migrate_info",
835 #      "arguments": { "protocol": "spice",
836 #                     "hostname": "virt42.lab.kraxel.org",
837 #                     "port": 1234 } }
838 # <- { "return": {} }
841 { 'command': 'client_migrate_info',
842   'data': { 'protocol': 'str', 'hostname': 'str', '*port': 'int',
843             '*tls-port': 'int', '*cert-subject': 'str' } }
846 # @migrate-start-postcopy:
848 # Followup to a migration command to switch the migration to postcopy mode.
849 # The postcopy-ram capability must be set on both source and destination
850 # before the original migration command.
852 # Since: 2.5
854 # Example:
856 # -> { "execute": "migrate-start-postcopy" }
857 # <- { "return": {} }
860 { 'command': 'migrate-start-postcopy' }
863 # @MIGRATION:
865 # Emitted when a migration event happens
867 # @status: @MigrationStatus describing the current migration status.
869 # Since: 2.4
871 # Example:
873 # <- {"timestamp": {"seconds": 1432121972, "microseconds": 744001},
874 #     "event": "MIGRATION",
875 #     "data": {"status": "completed"} }
878 { 'event': 'MIGRATION',
879   'data': {'status': 'MigrationStatus'}}
882 # @MIGRATION_PASS:
884 # Emitted from the source side of a migration at the start of each pass
885 # (when it syncs the dirty bitmap)
887 # @pass: An incrementing count (starting at 1 on the first pass)
889 # Since: 2.6
891 # Example:
893 # { "timestamp": {"seconds": 1449669631, "microseconds": 239225},
894 #   "event": "MIGRATION_PASS", "data": {"pass": 2} }
897 { 'event': 'MIGRATION_PASS',
898   'data': { 'pass': 'int' } }
901 # @COLOMessage:
903 # The message transmission between Primary side and Secondary side.
905 # @checkpoint-ready: Secondary VM (SVM) is ready for checkpointing
907 # @checkpoint-request: Primary VM (PVM) tells SVM to prepare for checkpointing
909 # @checkpoint-reply: SVM gets PVM's checkpoint request
911 # @vmstate-send: VM's state will be sent by PVM.
913 # @vmstate-size: The total size of VMstate.
915 # @vmstate-received: VM's state has been received by SVM.
917 # @vmstate-loaded: VM's state has been loaded by SVM.
919 # Since: 2.8
921 { 'enum': 'COLOMessage',
922   'data': [ 'checkpoint-ready', 'checkpoint-request', 'checkpoint-reply',
923             'vmstate-send', 'vmstate-size', 'vmstate-received',
924             'vmstate-loaded' ] }
927 # @COLOMode:
929 # The COLO current mode.
931 # @none: COLO is disabled.
933 # @primary: COLO node in primary side.
935 # @secondary: COLO node in slave side.
937 # Since: 2.8
939 { 'enum': 'COLOMode',
940   'data': [ 'none', 'primary', 'secondary'] }
943 # @FailoverStatus:
945 # An enumeration of COLO failover status
947 # @none: no failover has ever happened
949 # @require: got failover requirement but not handled
951 # @active: in the process of doing failover
953 # @completed: finish the process of failover
955 # @relaunch: restart the failover process, from 'none' -> 'completed' (Since 2.9)
957 # Since: 2.8
959 { 'enum': 'FailoverStatus',
960   'data': [ 'none', 'require', 'active', 'completed', 'relaunch' ] }
963 # @COLO_EXIT:
965 # Emitted when VM finishes COLO mode due to some errors happening or
966 # at the request of users.
968 # @mode: report COLO mode when COLO exited.
970 # @reason: describes the reason for the COLO exit.
972 # Since: 3.1
974 # Example:
976 # <- { "timestamp": {"seconds": 2032141960, "microseconds": 417172},
977 #      "event": "COLO_EXIT", "data": {"mode": "primary", "reason": "request" } }
980 { 'event': 'COLO_EXIT',
981   'data': {'mode': 'COLOMode', 'reason': 'COLOExitReason' } }
984 # @COLOExitReason:
986 # The reason for a COLO exit
988 # @none: no failover has ever happened. This can't occur in the
989 # COLO_EXIT event, only in the result of query-colo-status.
991 # @request: COLO exit is due to an external request
993 # @error: COLO exit is due to an internal error
995 # Since: 3.1
997 { 'enum': 'COLOExitReason',
998   'data': [ 'none', 'request', 'error' ] }
1001 # @x-colo-lost-heartbeat:
1003 # Tell qemu that heartbeat is lost, request it to do takeover procedures.
1004 # If this command is sent to the PVM, the Primary side will exit COLO mode.
1005 # If sent to the Secondary, the Secondary side will run failover work,
1006 # then takes over server operation to become the service VM.
1008 # Since: 2.8
1010 # Example:
1012 # -> { "execute": "x-colo-lost-heartbeat" }
1013 # <- { "return": {} }
1016 { 'command': 'x-colo-lost-heartbeat' }
1019 # @migrate_cancel:
1021 # Cancel the current executing migration process.
1023 # Returns: nothing on success
1025 # Notes: This command succeeds even if there is no migration process running.
1027 # Since: 0.14.0
1029 # Example:
1031 # -> { "execute": "migrate_cancel" }
1032 # <- { "return": {} }
1035 { 'command': 'migrate_cancel' }
1038 # @migrate-continue:
1040 # Continue migration when it's in a paused state.
1042 # @state: The state the migration is currently expected to be in
1044 # Returns: nothing on success
1045 # Since: 2.11
1046 # Example:
1048 # -> { "execute": "migrate-continue" , "arguments":
1049 #      { "state": "pre-switchover" } }
1050 # <- { "return": {} }
1052 { 'command': 'migrate-continue', 'data': {'state': 'MigrationStatus'} }
1055 # @migrate_set_downtime:
1057 # Set maximum tolerated downtime for migration.
1059 # @value: maximum downtime in seconds
1061 # Returns: nothing on success
1063 # Notes: This command is deprecated in favor of 'migrate-set-parameters'
1065 # Since: 0.14.0
1067 # Example:
1069 # -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
1070 # <- { "return": {} }
1073 { 'command': 'migrate_set_downtime', 'data': {'value': 'number'} }
1076 # @migrate_set_speed:
1078 # Set maximum speed for migration.
1080 # @value: maximum speed in bytes per second.
1082 # Returns: nothing on success
1084 # Notes: This command is deprecated in favor of 'migrate-set-parameters'
1086 # Since: 0.14.0
1088 # Example:
1090 # -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
1091 # <- { "return": {} }
1094 { 'command': 'migrate_set_speed', 'data': {'value': 'int'} }
1097 # @migrate-set-cache-size:
1099 # Set cache size to be used by XBZRLE migration
1101 # @value: cache size in bytes
1103 # The size will be rounded down to the nearest power of 2.
1104 # The cache size can be modified before and during ongoing migration
1106 # Returns: nothing on success
1108 # Notes: This command is deprecated in favor of 'migrate-set-parameters'
1110 # Since: 1.2
1112 # Example:
1114 # -> { "execute": "migrate-set-cache-size",
1115 #      "arguments": { "value": 536870912 } }
1116 # <- { "return": {} }
1119 { 'command': 'migrate-set-cache-size', 'data': {'value': 'int'} }
1122 # @query-migrate-cache-size:
1124 # Query migration XBZRLE cache size
1126 # Returns: XBZRLE cache size in bytes
1128 # Notes: This command is deprecated in favor of 'query-migrate-parameters'
1130 # Since: 1.2
1132 # Example:
1134 # -> { "execute": "query-migrate-cache-size" }
1135 # <- { "return": 67108864 }
1138 { 'command': 'query-migrate-cache-size', 'returns': 'int' }
1141 # @migrate:
1143 # Migrates the current running guest to another Virtual Machine.
1145 # @uri: the Uniform Resource Identifier of the destination VM
1147 # @blk: do block migration (full disk copy)
1149 # @inc: incremental disk copy migration
1151 # @detach: this argument exists only for compatibility reasons and
1152 #          is ignored by QEMU
1154 # @resume: resume one paused migration, default "off". (since 3.0)
1156 # Returns: nothing on success
1158 # Since: 0.14.0
1160 # Notes:
1162 # 1. The 'query-migrate' command should be used to check migration's progress
1163 #    and final result (this information is provided by the 'status' member)
1165 # 2. All boolean arguments default to false
1167 # 3. The user Monitor's "detach" argument is invalid in QMP and should not
1168 #    be used
1170 # Example:
1172 # -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
1173 # <- { "return": {} }
1176 { 'command': 'migrate',
1177   'data': {'uri': 'str', '*blk': 'bool', '*inc': 'bool',
1178            '*detach': 'bool', '*resume': 'bool' } }
1181 # @migrate-incoming:
1183 # Start an incoming migration, the qemu must have been started
1184 # with -incoming defer
1186 # @uri: The Uniform Resource Identifier identifying the source or
1187 #       address to listen on
1189 # Returns: nothing on success
1191 # Since: 2.3
1193 # Notes:
1195 # 1. It's a bad idea to use a string for the uri, but it needs to stay
1196 #    compatible with -incoming and the format of the uri is already exposed
1197 #    above libvirt.
1199 # 2. QEMU must be started with -incoming defer to allow migrate-incoming to
1200 #    be used.
1202 # 3. The uri format is the same as for -incoming
1204 # Example:
1206 # -> { "execute": "migrate-incoming",
1207 #      "arguments": { "uri": "tcp::4446" } }
1208 # <- { "return": {} }
1211 { 'command': 'migrate-incoming', 'data': {'uri': 'str' } }
1214 # @xen-save-devices-state:
1216 # Save the state of all devices to file. The RAM and the block devices
1217 # of the VM are not saved by this command.
1219 # @filename: the file to save the state of the devices to as binary
1220 # data. See xen-save-devices-state.txt for a description of the binary
1221 # format.
1223 # @live: Optional argument to ask QEMU to treat this command as part of a live
1224 # migration. Default to true. (since 2.11)
1226 # Returns: Nothing on success
1228 # Since: 1.1
1230 # Example:
1232 # -> { "execute": "xen-save-devices-state",
1233 #      "arguments": { "filename": "/tmp/save" } }
1234 # <- { "return": {} }
1237 { 'command': 'xen-save-devices-state',
1238   'data': {'filename': 'str', '*live':'bool' } }
1241 # @xen-set-replication:
1243 # Enable or disable replication.
1245 # @enable: true to enable, false to disable.
1247 # @primary: true for primary or false for secondary.
1249 # @failover: true to do failover, false to stop. but cannot be
1250 #            specified if 'enable' is true. default value is false.
1252 # Returns: nothing.
1254 # Example:
1256 # -> { "execute": "xen-set-replication",
1257 #      "arguments": {"enable": true, "primary": false} }
1258 # <- { "return": {} }
1260 # Since: 2.9
1262 { 'command': 'xen-set-replication',
1263   'data': { 'enable': 'bool', 'primary': 'bool', '*failover' : 'bool' },
1264   'if': 'defined(CONFIG_REPLICATION)' }
1267 # @ReplicationStatus:
1269 # The result format for 'query-xen-replication-status'.
1271 # @error: true if an error happened, false if replication is normal.
1273 # @desc: the human readable error description string, when
1274 #        @error is 'true'.
1276 # Since: 2.9
1278 { 'struct': 'ReplicationStatus',
1279   'data': { 'error': 'bool', '*desc': 'str' },
1280   'if': 'defined(CONFIG_REPLICATION)' }
1283 # @query-xen-replication-status:
1285 # Query replication status while the vm is running.
1287 # Returns: A @ReplicationResult object showing the status.
1289 # Example:
1291 # -> { "execute": "query-xen-replication-status" }
1292 # <- { "return": { "error": false } }
1294 # Since: 2.9
1296 { 'command': 'query-xen-replication-status',
1297   'returns': 'ReplicationStatus',
1298   'if': 'defined(CONFIG_REPLICATION)' }
1301 # @xen-colo-do-checkpoint:
1303 # Xen uses this command to notify replication to trigger a checkpoint.
1305 # Returns: nothing.
1307 # Example:
1309 # -> { "execute": "xen-colo-do-checkpoint" }
1310 # <- { "return": {} }
1312 # Since: 2.9
1314 { 'command': 'xen-colo-do-checkpoint',
1315   'if': 'defined(CONFIG_REPLICATION)' }
1318 # @COLOStatus:
1320 # The result format for 'query-colo-status'.
1322 # @mode: COLO running mode. If COLO is running, this field will return
1323 #        'primary' or 'secondary'.
1325 # @reason: describes the reason for the COLO exit.
1327 # Since: 3.1
1329 { 'struct': 'COLOStatus',
1330   'data': { 'mode': 'COLOMode', 'reason': 'COLOExitReason' } }
1333 # @query-colo-status:
1335 # Query COLO status while the vm is running.
1337 # Returns: A @COLOStatus object showing the status.
1339 # Example:
1341 # -> { "execute": "query-colo-status" }
1342 # <- { "return": { "mode": "primary", "active": true, "reason": "request" } }
1344 # Since: 3.1
1346 { 'command': 'query-colo-status',
1347   'returns': 'COLOStatus' }
1350 # @migrate-recover:
1352 # Provide a recovery migration stream URI.
1354 # @uri: the URI to be used for the recovery of migration stream.
1356 # Returns: nothing.
1358 # Example:
1360 # -> { "execute": "migrate-recover",
1361 #      "arguments": { "uri": "tcp:192.168.1.200:12345" } }
1362 # <- { "return": {} }
1364 # Since: 3.0
1366 { 'command': 'migrate-recover',
1367   'data': { 'uri': 'str' },
1368   'allow-oob': true }
1371 # @migrate-pause:
1373 # Pause a migration.  Currently it only supports postcopy.
1375 # Returns: nothing.
1377 # Example:
1379 # -> { "execute": "migrate-pause" }
1380 # <- { "return": {} }
1382 # Since: 3.0
1384 { 'command': 'migrate-pause', 'allow-oob': true }