2017-08-24 21:14:01 +02:00
|
|
|
# -*- Mode: Python -*-
|
2020-07-29 20:50:24 +02:00
|
|
|
# vim: filetype=python
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
|
|
|
|
|
|
|
##
|
|
|
|
# = Migration
|
|
|
|
##
|
|
|
|
|
|
|
|
{ 'include': 'common.json' }
|
2019-02-27 11:51:27 +01:00
|
|
|
{ 'include': 'sockets.json' }
|
2017-08-24 21:14:01 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @MigrationStats:
|
|
|
|
#
|
|
|
|
# Detailed migration status.
|
|
|
|
#
|
|
|
|
# @transferred: amount of bytes already transferred to the target VM
|
|
|
|
#
|
|
|
|
# @remaining: amount of bytes remaining to be transferred to the target VM
|
|
|
|
#
|
|
|
|
# @total: total amount of bytes involved in the migration process
|
|
|
|
#
|
|
|
|
# @duplicate: number of duplicate (zero) pages (since 1.2)
|
|
|
|
#
|
|
|
|
# @skipped: number of skipped zero pages (since 1.5)
|
|
|
|
#
|
|
|
|
# @normal: number of normal pages (since 1.2)
|
|
|
|
#
|
|
|
|
# @normal-bytes: number of normal bytes sent (since 1.2)
|
|
|
|
#
|
|
|
|
# @dirty-pages-rate: number of pages dirtied by second by the
|
2020-02-13 18:56:26 +01:00
|
|
|
# guest (since 1.3)
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
|
|
|
# @mbps: throughput in megabits/sec. (since 1.6)
|
|
|
|
#
|
|
|
|
# @dirty-sync-count: number of times that dirty ram was synchronized (since 2.1)
|
|
|
|
#
|
|
|
|
# @postcopy-requests: The number of page requests received from the destination
|
2020-02-13 18:56:26 +01:00
|
|
|
# (since 2.7)
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
|
|
|
# @page-size: The number of bytes per page for the various page-based
|
2020-02-13 18:56:26 +01:00
|
|
|
# statistics (since 2.10)
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
2018-06-26 15:20:11 +02:00
|
|
|
# @multifd-bytes: The number of bytes sent through multifd (since 3.0)
|
|
|
|
#
|
2019-01-11 07:37:30 +01:00
|
|
|
# @pages-per-second: the number of memory pages transferred per second
|
2020-02-13 18:56:26 +01:00
|
|
|
# (Since 4.0)
|
2019-01-11 07:37:30 +01:00
|
|
|
#
|
2020-11-18 07:41:58 +01:00
|
|
|
# Since: 0.14
|
2017-08-24 21:14:01 +02:00
|
|
|
##
|
|
|
|
{ 'struct': 'MigrationStats',
|
|
|
|
'data': {'transferred': 'int', 'remaining': 'int', 'total': 'int' ,
|
|
|
|
'duplicate': 'int', 'skipped': 'int', 'normal': 'int',
|
|
|
|
'normal-bytes': 'int', 'dirty-pages-rate' : 'int',
|
|
|
|
'mbps' : 'number', 'dirty-sync-count' : 'int',
|
2018-06-26 15:20:11 +02:00
|
|
|
'postcopy-requests' : 'int', 'page-size' : 'int',
|
2019-01-11 07:37:30 +01:00
|
|
|
'multifd-bytes' : 'uint64', 'pages-per-second' : 'uint64' } }
|
2017-08-24 21:14:01 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @XBZRLECacheStats:
|
|
|
|
#
|
|
|
|
# Detailed XBZRLE migration cache statistics
|
|
|
|
#
|
|
|
|
# @cache-size: XBZRLE cache size
|
|
|
|
#
|
|
|
|
# @bytes: amount of bytes already transferred to the target VM
|
|
|
|
#
|
|
|
|
# @pages: amount of pages transferred to the target VM
|
|
|
|
#
|
|
|
|
# @cache-miss: number of cache miss
|
|
|
|
#
|
|
|
|
# @cache-miss-rate: rate of cache miss (since 2.1)
|
|
|
|
#
|
2020-04-30 02:59:35 +02:00
|
|
|
# @encoding-rate: rate of encoded bytes (since 5.1)
|
|
|
|
#
|
2017-08-24 21:14:01 +02:00
|
|
|
# @overflow: number of overflows
|
|
|
|
#
|
|
|
|
# Since: 1.2
|
|
|
|
##
|
|
|
|
{ 'struct': 'XBZRLECacheStats',
|
2021-02-02 15:17:32 +01:00
|
|
|
'data': {'cache-size': 'size', 'bytes': 'int', 'pages': 'int',
|
2017-08-24 21:14:01 +02:00
|
|
|
'cache-miss': 'int', 'cache-miss-rate': 'number',
|
2020-04-30 02:59:35 +02:00
|
|
|
'encoding-rate': 'number', 'overflow': 'int' } }
|
2017-08-24 21:14:01 +02:00
|
|
|
|
2018-09-06 09:01:00 +02:00
|
|
|
##
|
|
|
|
# @CompressionStats:
|
|
|
|
#
|
|
|
|
# Detailed migration compression statistics
|
|
|
|
#
|
|
|
|
# @pages: amount of pages compressed and transferred to the target VM
|
|
|
|
#
|
|
|
|
# @busy: count of times that no free thread was available to compress data
|
|
|
|
#
|
|
|
|
# @busy-rate: rate of thread busy
|
|
|
|
#
|
|
|
|
# @compressed-size: amount of bytes after compression
|
|
|
|
#
|
|
|
|
# @compression-rate: rate of compressed size
|
|
|
|
#
|
|
|
|
# Since: 3.1
|
|
|
|
##
|
|
|
|
{ 'struct': 'CompressionStats',
|
|
|
|
'data': {'pages': 'int', 'busy': 'int', 'busy-rate': 'number',
|
2020-02-13 18:56:27 +01:00
|
|
|
'compressed-size': 'int', 'compression-rate': 'number' } }
|
2018-09-06 09:01:00 +02:00
|
|
|
|
2017-08-24 21:14:01 +02:00
|
|
|
##
|
|
|
|
# @MigrationStatus:
|
|
|
|
#
|
|
|
|
# An enumeration of migration status.
|
|
|
|
#
|
|
|
|
# @none: no migration has ever happened.
|
|
|
|
#
|
|
|
|
# @setup: migration process has been initiated.
|
|
|
|
#
|
|
|
|
# @cancelling: in the process of cancelling migration.
|
|
|
|
#
|
|
|
|
# @cancelled: cancelling migration is finished.
|
|
|
|
#
|
|
|
|
# @active: in the process of doing migration.
|
|
|
|
#
|
|
|
|
# @postcopy-active: like active, but now in postcopy mode. (since 2.5)
|
|
|
|
#
|
2018-05-22 12:39:56 +02:00
|
|
|
# @postcopy-paused: during postcopy but paused. (since 3.0)
|
2018-05-02 12:47:18 +02:00
|
|
|
#
|
2018-05-22 12:39:56 +02:00
|
|
|
# @postcopy-recover: trying to recover from a paused postcopy. (since 3.0)
|
2018-05-02 12:47:25 +02:00
|
|
|
#
|
2017-08-24 21:14:01 +02:00
|
|
|
# @completed: migration is finished.
|
|
|
|
#
|
|
|
|
# @failed: some error occurred during migration process.
|
|
|
|
#
|
|
|
|
# @colo: VM is in the process of fault tolerance, VM can not get into this
|
|
|
|
# state unless colo capability is enabled for migration. (since 2.8)
|
|
|
|
#
|
2017-10-20 11:05:51 +02:00
|
|
|
# @pre-switchover: Paused before device serialisation. (since 2.11)
|
|
|
|
#
|
|
|
|
# @device: During device serialisation when pause-before-switchover is enabled
|
2020-02-13 18:56:26 +01:00
|
|
|
# (since 2.11)
|
2017-10-20 11:05:51 +02:00
|
|
|
#
|
2019-10-29 12:49:02 +01:00
|
|
|
# @wait-unplug: wait for device unplug request by guest OS to be completed.
|
|
|
|
# (since 4.2)
|
|
|
|
#
|
2017-08-24 21:14:01 +02:00
|
|
|
# Since: 2.3
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'enum': 'MigrationStatus',
|
|
|
|
'data': [ 'none', 'setup', 'cancelling', 'cancelled',
|
2018-05-02 12:47:18 +02:00
|
|
|
'active', 'postcopy-active', 'postcopy-paused',
|
2018-05-02 12:47:25 +02:00
|
|
|
'postcopy-recover', 'completed', 'failed', 'colo',
|
2019-10-29 12:49:02 +01:00
|
|
|
'pre-switchover', 'device', 'wait-unplug' ] }
|
2020-10-26 10:36:27 +01:00
|
|
|
##
|
|
|
|
# @VfioStats:
|
|
|
|
#
|
|
|
|
# Detailed VFIO devices migration statistics
|
|
|
|
#
|
|
|
|
# @transferred: amount of bytes transferred to the target VM by VFIO devices
|
|
|
|
#
|
|
|
|
# Since: 5.2
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'struct': 'VfioStats',
|
|
|
|
'data': {'transferred': 'int' } }
|
2017-08-24 21:14:01 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @MigrationInfo:
|
|
|
|
#
|
|
|
|
# Information about current migration process.
|
|
|
|
#
|
|
|
|
# @status: @MigrationStatus describing the current migration status.
|
|
|
|
# If this field is not returned, no migration process
|
|
|
|
# has been initiated
|
|
|
|
#
|
|
|
|
# @ram: @MigrationStats containing detailed migration
|
|
|
|
# status, only returned if status is 'active' or
|
|
|
|
# 'completed'(since 1.2)
|
|
|
|
#
|
|
|
|
# @disk: @MigrationStats containing detailed disk migration
|
|
|
|
# status, only returned if status is 'active' and it is a block
|
|
|
|
# migration
|
|
|
|
#
|
|
|
|
# @xbzrle-cache: @XBZRLECacheStats containing detailed XBZRLE
|
|
|
|
# migration statistics, only returned if XBZRLE feature is on and
|
|
|
|
# status is 'active' or 'completed' (since 1.2)
|
|
|
|
#
|
|
|
|
# @total-time: total amount of milliseconds since migration started.
|
2020-02-13 18:56:26 +01:00
|
|
|
# If migration has ended, it returns the total migration
|
|
|
|
# time. (since 1.2)
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
|
|
|
# @downtime: only present when migration finishes correctly
|
2020-02-13 18:56:26 +01:00
|
|
|
# total downtime in milliseconds for the guest.
|
|
|
|
# (since 1.3)
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
|
|
|
# @expected-downtime: only present while migration is active
|
2020-02-13 18:56:26 +01:00
|
|
|
# expected downtime in milliseconds for the guest in last walk
|
|
|
|
# of the dirty bitmap. (since 1.3)
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
2020-02-13 18:56:34 +01:00
|
|
|
# @setup-time: amount of setup time in milliseconds *before* the
|
|
|
|
# iterations begin but *after* the QMP command is issued. This is designed
|
2020-02-13 18:56:26 +01:00
|
|
|
# to provide an accounting of any activities (such as RDMA pinning) which
|
|
|
|
# may be expensive, but do not actually occur during the iterative
|
|
|
|
# migration rounds themselves. (since 1.6)
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
|
|
|
# @cpu-throttle-percentage: percentage of time guest cpus are being
|
2020-02-13 18:56:26 +01:00
|
|
|
# throttled during auto-converge. This is only present when auto-converge
|
|
|
|
# has started throttling guest cpus. (Since 2.7)
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
|
|
|
# @error-desc: the human readable error description string, when
|
|
|
|
# @status is 'failed'. Clients should not attempt to parse the
|
|
|
|
# error strings. (Since 2.7)
|
2018-03-22 19:17:27 +01:00
|
|
|
#
|
|
|
|
# @postcopy-blocktime: total time when all vCPU were blocked during postcopy
|
2020-02-13 18:56:26 +01:00
|
|
|
# live migration. This is only present when the postcopy-blocktime
|
|
|
|
# migration capability is enabled. (Since 3.0)
|
2018-03-22 19:17:27 +01:00
|
|
|
#
|
2018-04-27 13:15:02 +02:00
|
|
|
# @postcopy-vcpu-blocktime: list of the postcopy blocktime per vCPU. This is
|
2020-02-13 18:56:26 +01:00
|
|
|
# only present when the postcopy-blocktime migration capability
|
|
|
|
# is enabled. (Since 3.0)
|
2018-03-22 19:17:27 +01:00
|
|
|
#
|
2018-09-06 09:01:00 +02:00
|
|
|
# @compression: migration compression statistics, only returned if compression
|
2020-02-13 18:56:26 +01:00
|
|
|
# feature is on and status is 'active' or 'completed' (Since 3.1)
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
2019-02-27 11:51:27 +01:00
|
|
|
# @socket-address: Only used for tcp, to know what the real port is (Since 4.0)
|
|
|
|
#
|
2020-10-26 10:36:27 +01:00
|
|
|
# @vfio: @VfioStats containing detailed VFIO devices migration statistics,
|
|
|
|
# only returned if VFIO device is present, migration is supported by all
|
|
|
|
# VFIO devices and status is 'active' or 'completed' (since 5.2)
|
|
|
|
#
|
2021-04-20 07:19:06 +02:00
|
|
|
# @blocked-reasons: A list of reasons an outgoing migration is blocked.
|
|
|
|
# Present and non-empty when migration is blocked.
|
|
|
|
# (since 6.0)
|
|
|
|
#
|
2020-11-18 07:41:58 +01:00
|
|
|
# Since: 0.14
|
2017-08-24 21:14:01 +02:00
|
|
|
##
|
|
|
|
{ 'struct': 'MigrationInfo',
|
|
|
|
'data': {'*status': 'MigrationStatus', '*ram': 'MigrationStats',
|
|
|
|
'*disk': 'MigrationStats',
|
2020-10-26 10:36:27 +01:00
|
|
|
'*vfio': 'VfioStats',
|
2017-08-24 21:14:01 +02:00
|
|
|
'*xbzrle-cache': 'XBZRLECacheStats',
|
|
|
|
'*total-time': 'int',
|
|
|
|
'*expected-downtime': 'int',
|
|
|
|
'*downtime': 'int',
|
|
|
|
'*setup-time': 'int',
|
|
|
|
'*cpu-throttle-percentage': 'int',
|
2018-03-22 19:17:27 +01:00
|
|
|
'*error-desc': 'str',
|
2021-02-02 14:55:21 +01:00
|
|
|
'*blocked-reasons': ['str'],
|
2018-03-22 19:17:27 +01:00
|
|
|
'*postcopy-blocktime' : 'uint32',
|
2018-09-06 09:01:00 +02:00
|
|
|
'*postcopy-vcpu-blocktime': ['uint32'],
|
2019-02-27 11:51:27 +01:00
|
|
|
'*compression': 'CompressionStats',
|
|
|
|
'*socket-address': ['SocketAddress'] } }
|
2017-08-24 21:14:01 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @query-migrate:
|
|
|
|
#
|
|
|
|
# Returns information about current migration process. If migration
|
|
|
|
# is active there will be another json-object with RAM migration
|
|
|
|
# status and if block migration is active another one with block
|
|
|
|
# migration status.
|
|
|
|
#
|
|
|
|
# Returns: @MigrationInfo
|
|
|
|
#
|
2020-11-18 07:41:58 +01:00
|
|
|
# Since: 0.14
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# 1. Before the first migration
|
|
|
|
#
|
|
|
|
# -> { "execute": "query-migrate" }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
|
|
|
# 2. Migration is done and has succeeded
|
|
|
|
#
|
|
|
|
# -> { "execute": "query-migrate" }
|
|
|
|
# <- { "return": {
|
|
|
|
# "status": "completed",
|
2018-08-21 14:39:26 +02:00
|
|
|
# "total-time":12345,
|
|
|
|
# "setup-time":12345,
|
|
|
|
# "downtime":12345,
|
2017-08-24 21:14:01 +02:00
|
|
|
# "ram":{
|
|
|
|
# "transferred":123,
|
|
|
|
# "remaining":123,
|
|
|
|
# "total":246,
|
|
|
|
# "duplicate":123,
|
|
|
|
# "normal":123,
|
|
|
|
# "normal-bytes":123456,
|
|
|
|
# "dirty-sync-count":15
|
|
|
|
# }
|
|
|
|
# }
|
|
|
|
# }
|
|
|
|
#
|
|
|
|
# 3. Migration is done and has failed
|
|
|
|
#
|
|
|
|
# -> { "execute": "query-migrate" }
|
|
|
|
# <- { "return": { "status": "failed" } }
|
|
|
|
#
|
|
|
|
# 4. Migration is being performed and is not a block migration:
|
|
|
|
#
|
|
|
|
# -> { "execute": "query-migrate" }
|
|
|
|
# <- {
|
|
|
|
# "return":{
|
|
|
|
# "status":"active",
|
2018-08-21 14:39:26 +02:00
|
|
|
# "total-time":12345,
|
|
|
|
# "setup-time":12345,
|
|
|
|
# "expected-downtime":12345,
|
2017-08-24 21:14:01 +02:00
|
|
|
# "ram":{
|
|
|
|
# "transferred":123,
|
|
|
|
# "remaining":123,
|
|
|
|
# "total":246,
|
|
|
|
# "duplicate":123,
|
|
|
|
# "normal":123,
|
|
|
|
# "normal-bytes":123456,
|
|
|
|
# "dirty-sync-count":15
|
|
|
|
# }
|
|
|
|
# }
|
|
|
|
# }
|
|
|
|
#
|
|
|
|
# 5. Migration is being performed and is a block migration:
|
|
|
|
#
|
|
|
|
# -> { "execute": "query-migrate" }
|
|
|
|
# <- {
|
|
|
|
# "return":{
|
|
|
|
# "status":"active",
|
2018-08-21 14:39:26 +02:00
|
|
|
# "total-time":12345,
|
|
|
|
# "setup-time":12345,
|
|
|
|
# "expected-downtime":12345,
|
2017-08-24 21:14:01 +02:00
|
|
|
# "ram":{
|
|
|
|
# "total":1057024,
|
|
|
|
# "remaining":1053304,
|
|
|
|
# "transferred":3720,
|
|
|
|
# "duplicate":123,
|
|
|
|
# "normal":123,
|
|
|
|
# "normal-bytes":123456,
|
|
|
|
# "dirty-sync-count":15
|
|
|
|
# },
|
|
|
|
# "disk":{
|
|
|
|
# "total":20971520,
|
|
|
|
# "remaining":20880384,
|
|
|
|
# "transferred":91136
|
|
|
|
# }
|
|
|
|
# }
|
|
|
|
# }
|
|
|
|
#
|
|
|
|
# 6. Migration is being performed and XBZRLE is active:
|
|
|
|
#
|
|
|
|
# -> { "execute": "query-migrate" }
|
|
|
|
# <- {
|
|
|
|
# "return":{
|
|
|
|
# "status":"active",
|
2018-08-21 14:39:26 +02:00
|
|
|
# "total-time":12345,
|
|
|
|
# "setup-time":12345,
|
|
|
|
# "expected-downtime":12345,
|
2017-08-24 21:14:01 +02:00
|
|
|
# "ram":{
|
|
|
|
# "total":1057024,
|
|
|
|
# "remaining":1053304,
|
|
|
|
# "transferred":3720,
|
|
|
|
# "duplicate":10,
|
|
|
|
# "normal":3333,
|
|
|
|
# "normal-bytes":3412992,
|
|
|
|
# "dirty-sync-count":15
|
|
|
|
# },
|
|
|
|
# "xbzrle-cache":{
|
|
|
|
# "cache-size":67108864,
|
|
|
|
# "bytes":20971520,
|
|
|
|
# "pages":2444343,
|
|
|
|
# "cache-miss":2244,
|
|
|
|
# "cache-miss-rate":0.123,
|
2020-04-30 02:59:35 +02:00
|
|
|
# "encoding-rate":80.1,
|
2017-08-24 21:14:01 +02:00
|
|
|
# "overflow":34434
|
|
|
|
# }
|
|
|
|
# }
|
|
|
|
# }
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'command': 'query-migrate', 'returns': 'MigrationInfo' }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @MigrationCapability:
|
|
|
|
#
|
|
|
|
# Migration capabilities enumeration
|
|
|
|
#
|
|
|
|
# @xbzrle: Migration supports xbzrle (Xor Based Zero Run Length Encoding).
|
|
|
|
# This feature allows us to minimize migration traffic for certain work
|
|
|
|
# loads, by sending compressed difference of the pages
|
|
|
|
#
|
|
|
|
# @rdma-pin-all: Controls whether or not the entire VM memory footprint is
|
2020-02-13 18:56:26 +01:00
|
|
|
# mlock()'d on demand or all at once. Refer to docs/rdma.txt for usage.
|
|
|
|
# Disabled by default. (since 2.0)
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
|
|
|
# @zero-blocks: During storage migration encode blocks of zeroes efficiently. This
|
2020-02-13 18:56:26 +01:00
|
|
|
# essentially saves 1MB of zeroes per block on the wire. Enabling requires
|
|
|
|
# source and target VM to support this feature. To enable it is sufficient
|
|
|
|
# to enable the capability on the source VM. The feature is disabled by
|
|
|
|
# default. (since 1.6)
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
|
|
|
# @compress: Use multiple compression threads to accelerate live migration.
|
2020-02-13 18:56:26 +01:00
|
|
|
# This feature can help to reduce the migration traffic, by sending
|
|
|
|
# compressed pages. Please note that if compress and xbzrle are both
|
|
|
|
# on, compress only takes effect in the ram bulk stage, after that,
|
|
|
|
# it will be disabled and only xbzrle takes effect, this can help to
|
|
|
|
# minimize migration traffic. The feature is disabled by default.
|
|
|
|
# (since 2.4 )
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
|
|
|
# @events: generate events for each migration state change
|
|
|
|
# (since 2.4 )
|
|
|
|
#
|
|
|
|
# @auto-converge: If enabled, QEMU will automatically throttle down the guest
|
2020-02-13 18:56:26 +01:00
|
|
|
# to speed up convergence of RAM migration. (since 1.6)
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
|
|
|
# @postcopy-ram: Start executing on the migration target before all of RAM has
|
2020-02-13 18:56:26 +01:00
|
|
|
# been migrated, pulling the remaining pages along as needed. The
|
|
|
|
# capacity must have the same setting on both source and target
|
|
|
|
# or migration will not even start. NOTE: If the migration fails during
|
|
|
|
# postcopy the VM will fail. (since 2.6)
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
|
|
|
# @x-colo: If enabled, migration will never end, and the state of the VM on the
|
2020-02-13 18:56:26 +01:00
|
|
|
# primary side will be migrated continuously to the VM on secondary
|
|
|
|
# side, this process is called COarse-Grain LOck Stepping (COLO) for
|
|
|
|
# Non-stop Service. (since 2.8)
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
|
|
|
# @release-ram: if enabled, qemu will free the migrated ram pages on the source
|
2020-02-13 18:56:26 +01:00
|
|
|
# during postcopy-ram migration. (since 2.9)
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
|
|
|
# @block: If enabled, QEMU will also migrate the contents of all block
|
2020-02-13 18:56:26 +01:00
|
|
|
# devices. Default is disabled. A possible alternative uses
|
|
|
|
# mirror jobs to a builtin NBD server on the destination, which
|
|
|
|
# offers more flexibility.
|
|
|
|
# (Since 2.10)
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
|
|
|
# @return-path: If enabled, migration will use the return path even
|
|
|
|
# for precopy. (since 2.10)
|
|
|
|
#
|
2017-10-20 11:05:50 +02:00
|
|
|
# @pause-before-switchover: Pause outgoing migration before serialising device
|
2020-02-13 18:56:26 +01:00
|
|
|
# state and before disabling block IO (since 2.11)
|
2017-10-20 11:05:50 +02:00
|
|
|
#
|
2019-02-06 13:54:06 +01:00
|
|
|
# @multifd: Use more than one fd for migration (since 4.0)
|
2016-01-14 12:23:00 +01:00
|
|
|
#
|
2018-03-13 20:34:00 +01:00
|
|
|
# @dirty-bitmaps: If enabled, QEMU will migrate named dirty bitmaps.
|
|
|
|
# (since 2.12)
|
|
|
|
#
|
2018-03-22 19:17:22 +01:00
|
|
|
# @postcopy-blocktime: Calculate downtime for postcopy live migration
|
2020-02-13 18:56:26 +01:00
|
|
|
# (since 3.0)
|
2018-03-22 19:17:22 +01:00
|
|
|
#
|
2018-04-16 19:09:30 +02:00
|
|
|
# @late-block-activate: If enabled, the destination will not activate block
|
2020-02-13 18:56:26 +01:00
|
|
|
# devices (and thus take locks) immediately at the end of migration.
|
|
|
|
# (since 3.0)
|
2018-04-16 19:09:30 +02:00
|
|
|
#
|
2019-02-15 18:45:45 +01:00
|
|
|
# @x-ignore-shared: If enabled, QEMU will not migrate shared memory (since 4.0)
|
|
|
|
#
|
2019-09-03 18:22:44 +02:00
|
|
|
# @validate-uuid: Send the UUID of the source to allow the destination
|
|
|
|
# to ensure it is the same. (since 4.2)
|
|
|
|
#
|
2021-01-29 11:14:03 +01:00
|
|
|
# @background-snapshot: If enabled, the migration stream will be a snapshot
|
|
|
|
# of the VM exactly at the point when the migration
|
|
|
|
# procedure starts. The VM RAM is saved with running VM.
|
|
|
|
# (since 6.0)
|
|
|
|
#
|
2021-10-28 12:25:13 +02:00
|
|
|
# Features:
|
|
|
|
# @unstable: Members @x-colo and @x-ignore-shared are experimental.
|
|
|
|
#
|
2017-08-24 21:14:01 +02:00
|
|
|
# Since: 1.2
|
|
|
|
##
|
|
|
|
{ 'enum': 'MigrationCapability',
|
|
|
|
'data': ['xbzrle', 'rdma-pin-all', 'auto-converge', 'zero-blocks',
|
2021-10-28 12:25:13 +02:00
|
|
|
'compress', 'events', 'postcopy-ram',
|
|
|
|
{ 'name': 'x-colo', 'features': [ 'unstable' ] },
|
|
|
|
'release-ram',
|
2019-02-06 13:54:06 +01:00
|
|
|
'block', 'return-path', 'pause-before-switchover', 'multifd',
|
2019-02-15 18:45:45 +01:00
|
|
|
'dirty-bitmaps', 'postcopy-blocktime', 'late-block-activate',
|
2021-10-28 12:25:13 +02:00
|
|
|
{ 'name': 'x-ignore-shared', 'features': [ 'unstable' ] },
|
|
|
|
'validate-uuid', 'background-snapshot'] }
|
2017-08-24 21:14:01 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @MigrationCapabilityStatus:
|
|
|
|
#
|
|
|
|
# Migration capability information
|
|
|
|
#
|
|
|
|
# @capability: capability enum
|
|
|
|
#
|
|
|
|
# @state: capability state bool
|
|
|
|
#
|
|
|
|
# Since: 1.2
|
|
|
|
##
|
|
|
|
{ 'struct': 'MigrationCapabilityStatus',
|
|
|
|
'data': { 'capability' : 'MigrationCapability', 'state' : 'bool' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @migrate-set-capabilities:
|
|
|
|
#
|
|
|
|
# Enable/Disable the following migration capabilities (like xbzrle)
|
|
|
|
#
|
|
|
|
# @capabilities: json array of capability modifications to make
|
|
|
|
#
|
|
|
|
# Since: 1.2
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "migrate-set-capabilities" , "arguments":
|
|
|
|
# { "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'command': 'migrate-set-capabilities',
|
|
|
|
'data': { 'capabilities': ['MigrationCapabilityStatus'] } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @query-migrate-capabilities:
|
|
|
|
#
|
|
|
|
# Returns information about the current migration capabilities status
|
|
|
|
#
|
|
|
|
# Returns: @MigrationCapabilitiesStatus
|
|
|
|
#
|
|
|
|
# Since: 1.2
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "query-migrate-capabilities" }
|
|
|
|
# <- { "return": [
|
|
|
|
# {"state": false, "capability": "xbzrle"},
|
|
|
|
# {"state": false, "capability": "rdma-pin-all"},
|
|
|
|
# {"state": false, "capability": "auto-converge"},
|
|
|
|
# {"state": false, "capability": "zero-blocks"},
|
|
|
|
# {"state": false, "capability": "compress"},
|
|
|
|
# {"state": true, "capability": "events"},
|
|
|
|
# {"state": false, "capability": "postcopy-ram"},
|
|
|
|
# {"state": false, "capability": "x-colo"}
|
|
|
|
# ]}
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'command': 'query-migrate-capabilities', 'returns': ['MigrationCapabilityStatus']}
|
|
|
|
|
2019-01-16 10:35:55 +01:00
|
|
|
##
|
|
|
|
# @MultiFDCompression:
|
|
|
|
#
|
|
|
|
# An enumeration of multifd compression methods.
|
|
|
|
#
|
|
|
|
# @none: no compression.
|
2019-01-04 15:30:06 +01:00
|
|
|
# @zlib: use zlib compression method.
|
2019-12-13 13:47:14 +01:00
|
|
|
# @zstd: use zstd compression method.
|
2019-01-16 10:35:55 +01:00
|
|
|
#
|
|
|
|
# Since: 5.0
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'enum': 'MultiFDCompression',
|
2019-12-13 13:47:14 +01:00
|
|
|
'data': [ 'none', 'zlib',
|
2021-08-04 10:31:05 +02:00
|
|
|
{ 'name': 'zstd', 'if': 'CONFIG_ZSTD' } ] }
|
2019-01-16 10:35:55 +01:00
|
|
|
|
2021-02-12 18:34:24 +01:00
|
|
|
##
|
|
|
|
# @BitmapMigrationBitmapAliasTransform:
|
|
|
|
#
|
|
|
|
# @persistent: If present, the bitmap will be made persistent
|
|
|
|
# or transient depending on this parameter.
|
|
|
|
#
|
|
|
|
# Since: 6.0
|
|
|
|
##
|
|
|
|
{ 'struct': 'BitmapMigrationBitmapAliasTransform',
|
|
|
|
'data': {
|
|
|
|
'*persistent': 'bool'
|
|
|
|
} }
|
|
|
|
|
2020-08-20 17:07:23 +02:00
|
|
|
##
|
|
|
|
# @BitmapMigrationBitmapAlias:
|
|
|
|
#
|
|
|
|
# @name: The name of the bitmap.
|
|
|
|
#
|
|
|
|
# @alias: An alias name for migration (for example the bitmap name on
|
|
|
|
# the opposite site).
|
|
|
|
#
|
2021-02-12 18:34:24 +01:00
|
|
|
# @transform: Allows the modification of the migrated bitmap.
|
|
|
|
# (since 6.0)
|
|
|
|
#
|
2020-08-20 17:07:23 +02:00
|
|
|
# Since: 5.2
|
|
|
|
##
|
|
|
|
{ 'struct': 'BitmapMigrationBitmapAlias',
|
|
|
|
'data': {
|
|
|
|
'name': 'str',
|
2021-02-12 18:34:24 +01:00
|
|
|
'alias': 'str',
|
|
|
|
'*transform': 'BitmapMigrationBitmapAliasTransform'
|
2020-08-20 17:07:23 +02:00
|
|
|
} }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @BitmapMigrationNodeAlias:
|
|
|
|
#
|
|
|
|
# Maps a block node name and the bitmaps it has to aliases for dirty
|
|
|
|
# bitmap migration.
|
|
|
|
#
|
|
|
|
# @node-name: A block node name.
|
|
|
|
#
|
|
|
|
# @alias: An alias block node name for migration (for example the
|
|
|
|
# node name on the opposite site).
|
|
|
|
#
|
|
|
|
# @bitmaps: Mappings for the bitmaps on this node.
|
|
|
|
#
|
|
|
|
# Since: 5.2
|
|
|
|
##
|
|
|
|
{ 'struct': 'BitmapMigrationNodeAlias',
|
|
|
|
'data': {
|
|
|
|
'node-name': 'str',
|
|
|
|
'alias': 'str',
|
|
|
|
'bitmaps': [ 'BitmapMigrationBitmapAlias' ]
|
|
|
|
} }
|
|
|
|
|
2017-08-24 21:14:01 +02:00
|
|
|
##
|
|
|
|
# @MigrationParameter:
|
|
|
|
#
|
|
|
|
# Migration parameters enumeration
|
|
|
|
#
|
2019-02-27 14:24:06 +01:00
|
|
|
# @announce-initial: Initial delay (in milliseconds) before sending the first
|
2020-02-13 18:56:26 +01:00
|
|
|
# announce (Since 4.0)
|
2019-02-27 14:24:06 +01:00
|
|
|
#
|
|
|
|
# @announce-max: Maximum delay (in milliseconds) between packets in the
|
2020-02-13 18:56:26 +01:00
|
|
|
# announcement (Since 4.0)
|
2019-02-27 14:24:06 +01:00
|
|
|
#
|
|
|
|
# @announce-rounds: Number of self-announce packets sent after migration
|
2020-02-13 18:56:26 +01:00
|
|
|
# (Since 4.0)
|
2019-02-27 14:24:06 +01:00
|
|
|
#
|
|
|
|
# @announce-step: Increase in delay (in milliseconds) between subsequent
|
2020-02-13 18:56:26 +01:00
|
|
|
# packets in the announcement (Since 4.0)
|
2019-02-27 14:24:06 +01:00
|
|
|
#
|
2017-08-24 21:14:01 +02:00
|
|
|
# @compress-level: Set the compression level to be used in live migration,
|
2020-02-13 18:56:26 +01:00
|
|
|
# the compression level is an integer between 0 and 9, where 0 means
|
|
|
|
# no compression, 1 means the best compression speed, and 9 means best
|
|
|
|
# compression ratio which will consume more CPU.
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
|
|
|
# @compress-threads: Set compression thread count to be used in live migration,
|
2020-02-13 18:56:26 +01:00
|
|
|
# the compression thread count is an integer between 1 and 255.
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
2018-08-21 10:10:20 +02:00
|
|
|
# @compress-wait-thread: Controls behavior when all compression threads are
|
|
|
|
# currently busy. If true (default), wait for a free
|
|
|
|
# compression thread to become available; otherwise,
|
|
|
|
# send the page uncompressed. (Since 3.1)
|
|
|
|
#
|
2017-08-24 21:14:01 +02:00
|
|
|
# @decompress-threads: Set decompression thread count to be used in live
|
2020-02-13 18:56:26 +01:00
|
|
|
# migration, the decompression thread count is an integer between 1
|
|
|
|
# and 255. Usually, decompression is at least 4 times as fast as
|
|
|
|
# compression, so set the decompress-threads to the number about 1/4
|
|
|
|
# of compress-threads is adequate.
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
2020-02-24 03:31:42 +01:00
|
|
|
# @throttle-trigger-threshold: The ratio of bytes_dirty_period and bytes_xfer_period
|
|
|
|
# to trigger throttling. It is expressed as percentage.
|
|
|
|
# The default value is 50. (Since 5.0)
|
|
|
|
#
|
2017-08-24 21:14:01 +02:00
|
|
|
# @cpu-throttle-initial: Initial percentage of time guest cpus are throttled
|
|
|
|
# when migration auto-converge is activated. The
|
|
|
|
# default value is 20. (Since 2.7)
|
|
|
|
#
|
|
|
|
# @cpu-throttle-increment: throttle percentage increase each time
|
|
|
|
# auto-converge detects that migration is not making
|
|
|
|
# progress. The default value is 10. (Since 2.7)
|
|
|
|
#
|
2020-04-13 12:15:08 +02:00
|
|
|
# @cpu-throttle-tailslow: Make CPU throttling slower at tail stage
|
|
|
|
# At the tail stage of throttling, the Guest is very
|
|
|
|
# sensitive to CPU percentage while the @cpu-throttle
|
|
|
|
# -increment is excessive usually at tail stage.
|
|
|
|
# If this parameter is true, we will compute the ideal
|
|
|
|
# CPU percentage used by the Guest, which may exactly make
|
|
|
|
# the dirty rate match the dirty rate threshold. Then we
|
|
|
|
# will choose a smaller throttle increment between the
|
|
|
|
# one specified by @cpu-throttle-increment and the one
|
|
|
|
# generated by ideal CPU percentage.
|
|
|
|
# Therefore, it is compatible to traditional throttling,
|
|
|
|
# meanwhile the throttle increment won't be excessive
|
|
|
|
# at tail stage.
|
|
|
|
# The default value is false. (Since 5.1)
|
|
|
|
#
|
2017-08-24 21:14:01 +02:00
|
|
|
# @tls-creds: ID of the 'tls-creds' object that provides credentials for
|
|
|
|
# establishing a TLS connection over the migration data channel.
|
|
|
|
# On the outgoing side of the migration, the credentials must
|
|
|
|
# be for a 'client' endpoint, while for the incoming side the
|
|
|
|
# credentials must be for a 'server' endpoint. Setting this
|
|
|
|
# will enable TLS for all migrations. The default is unset,
|
|
|
|
# resulting in unsecured migration at the QEMU level. (Since 2.7)
|
|
|
|
#
|
|
|
|
# @tls-hostname: hostname of the target host for the migration. This is
|
|
|
|
# required when using x509 based TLS credentials and the
|
|
|
|
# migration URI does not already include a hostname. For
|
|
|
|
# example if using fd: or exec: based migration, the
|
|
|
|
# hostname must be provided so that the server's x509
|
|
|
|
# certificate identity can be validated. (Since 2.7)
|
|
|
|
#
|
migration: add support for a "tls-authz" migration parameter
The QEMU instance that runs as the server for the migration data
transport (ie the target QEMU) needs to be able to configure access
control so it can prevent unauthorized clients initiating an incoming
migration. This adds a new 'tls-authz' migration parameter that is used
to provide the QOM ID of a QAuthZ subclass instance that provides the
access control check. This is checked against the x509 certificate
obtained during the TLS handshake.
For example, when starting a QEMU for incoming migration, it is
possible to give an example identity of the source QEMU that is
intended to be connecting later:
$QEMU \
-monitor stdio \
-incoming defer \
...other args...
(qemu) object_add tls-creds-x509,id=tls0,dir=/home/berrange/qemutls,\
endpoint=server,verify-peer=yes \
(qemu) object_add authz-simple,id=auth0,identity=CN=laptop.example.com,,\
O=Example Org,,L=London,,ST=London,,C=GB \
(qemu) migrate_incoming tcp:localhost:9000
Reviewed-by: Juan Quintela <quintela@redhat.com>
Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
Signed-off-by: Juan Quintela <quintela@redhat.com>
2019-02-27 15:53:24 +01:00
|
|
|
# @tls-authz: ID of the 'authz' object subclass that provides access control
|
|
|
|
# checking of the TLS x509 certificate distinguished name.
|
|
|
|
# This object is only resolved at time of use, so can be deleted
|
|
|
|
# and recreated on the fly while the migration server is active.
|
|
|
|
# If missing, it will default to denying access (Since 4.0)
|
|
|
|
#
|
2017-08-24 21:14:01 +02:00
|
|
|
# @max-bandwidth: to set maximum speed for migration. maximum speed in
|
|
|
|
# bytes per second. (Since 2.8)
|
|
|
|
#
|
|
|
|
# @downtime-limit: set maximum tolerated downtime for migration. maximum
|
|
|
|
# downtime in milliseconds (Since 2.8)
|
|
|
|
#
|
|
|
|
# @x-checkpoint-delay: The delay time (in ms) between two COLO checkpoints in
|
2020-02-13 18:56:26 +01:00
|
|
|
# periodic mode. (Since 2.8)
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
|
|
|
# @block-incremental: Affects how much storage is migrated when the
|
2020-02-13 18:56:26 +01:00
|
|
|
# block migration capability is enabled. When false, the entire
|
|
|
|
# storage backing chain is migrated into a flattened image at
|
|
|
|
# the destination; when true, only the active qcow2 layer is
|
|
|
|
# migrated and the destination must already have access to the
|
|
|
|
# same backing chain as was used on the source. (since 2.10)
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
2019-02-06 13:54:06 +01:00
|
|
|
# @multifd-channels: Number of channels used to migrate data in
|
|
|
|
# parallel. This is the same number that the
|
|
|
|
# number of sockets used for migration. The
|
|
|
|
# default value is 2 (since 4.0)
|
2016-01-15 08:56:17 +01:00
|
|
|
#
|
2017-10-05 21:30:10 +02:00
|
|
|
# @xbzrle-cache-size: cache size to be used by XBZRLE migration. It
|
|
|
|
# needs to be a multiple of the target page size
|
|
|
|
# and a power of 2
|
|
|
|
# (Since 2.11)
|
|
|
|
#
|
2018-06-13 12:26:40 +02:00
|
|
|
# @max-postcopy-bandwidth: Background transfer bandwidth during postcopy.
|
2020-02-13 18:56:26 +01:00
|
|
|
# Defaults to 0 (unlimited). In bytes per second.
|
|
|
|
# (Since 3.0)
|
2018-08-01 15:00:20 +02:00
|
|
|
#
|
|
|
|
# @max-cpu-throttle: maximum cpu throttle percentage.
|
|
|
|
# Defaults to 99. (Since 3.1)
|
2019-02-27 14:24:06 +01:00
|
|
|
#
|
2019-01-16 10:35:55 +01:00
|
|
|
# @multifd-compression: Which compression method to use.
|
|
|
|
# Defaults to none. (Since 5.0)
|
|
|
|
#
|
2020-01-23 17:08:52 +01:00
|
|
|
# @multifd-zlib-level: Set the compression level to be used in live
|
2020-08-10 21:50:00 +02:00
|
|
|
# migration, the compression level is an integer between 0
|
|
|
|
# and 9, where 0 means no compression, 1 means the best
|
|
|
|
# compression speed, and 9 means best compression ratio which
|
|
|
|
# will consume more CPU.
|
|
|
|
# Defaults to 1. (Since 5.0)
|
2020-01-23 17:08:52 +01:00
|
|
|
#
|
2020-01-23 17:41:36 +01:00
|
|
|
# @multifd-zstd-level: Set the compression level to be used in live
|
2020-08-10 21:50:00 +02:00
|
|
|
# migration, the compression level is an integer between 0
|
|
|
|
# and 20, where 0 means no compression, 1 means the best
|
|
|
|
# compression speed, and 20 means best compression ratio which
|
|
|
|
# will consume more CPU.
|
|
|
|
# Defaults to 1. (Since 5.0)
|
2020-01-23 17:41:36 +01:00
|
|
|
#
|
2020-08-20 17:07:23 +02:00
|
|
|
# @block-bitmap-mapping: Maps block nodes and bitmaps on them to
|
2020-09-25 18:22:56 +02:00
|
|
|
# aliases for the purpose of dirty bitmap migration. Such
|
|
|
|
# aliases may for example be the corresponding names on the
|
|
|
|
# opposite site.
|
|
|
|
# The mapping must be one-to-one, but not necessarily
|
|
|
|
# complete: On the source, unmapped bitmaps and all bitmaps
|
|
|
|
# on unmapped nodes will be ignored. On the destination,
|
|
|
|
# encountering an unmapped alias in the incoming migration
|
|
|
|
# stream will result in a report, and all further bitmap
|
|
|
|
# migration data will then be discarded.
|
|
|
|
# Note that the destination does not know about bitmaps it
|
|
|
|
# does not receive, so there is no limitation or requirement
|
|
|
|
# regarding the number of bitmaps received, or how they are
|
|
|
|
# named, or on which nodes they are placed.
|
|
|
|
# By default (when this parameter has never been set), bitmap
|
|
|
|
# names are mapped to themselves. Nodes are mapped to their
|
|
|
|
# block device name if there is one, and to their node name
|
|
|
|
# otherwise. (Since 5.2)
|
2020-08-20 17:07:23 +02:00
|
|
|
#
|
2021-10-28 12:25:13 +02:00
|
|
|
# Features:
|
|
|
|
# @unstable: Member @x-checkpoint-delay is experimental.
|
|
|
|
#
|
2017-08-24 21:14:01 +02:00
|
|
|
# Since: 2.4
|
|
|
|
##
|
|
|
|
{ 'enum': 'MigrationParameter',
|
2019-02-27 14:24:06 +01:00
|
|
|
'data': ['announce-initial', 'announce-max',
|
|
|
|
'announce-rounds', 'announce-step',
|
|
|
|
'compress-level', 'compress-threads', 'decompress-threads',
|
2020-02-24 03:31:42 +01:00
|
|
|
'compress-wait-thread', 'throttle-trigger-threshold',
|
2017-08-24 21:14:01 +02:00
|
|
|
'cpu-throttle-initial', 'cpu-throttle-increment',
|
2020-04-13 12:15:08 +02:00
|
|
|
'cpu-throttle-tailslow',
|
migration: add support for a "tls-authz" migration parameter
The QEMU instance that runs as the server for the migration data
transport (ie the target QEMU) needs to be able to configure access
control so it can prevent unauthorized clients initiating an incoming
migration. This adds a new 'tls-authz' migration parameter that is used
to provide the QOM ID of a QAuthZ subclass instance that provides the
access control check. This is checked against the x509 certificate
obtained during the TLS handshake.
For example, when starting a QEMU for incoming migration, it is
possible to give an example identity of the source QEMU that is
intended to be connecting later:
$QEMU \
-monitor stdio \
-incoming defer \
...other args...
(qemu) object_add tls-creds-x509,id=tls0,dir=/home/berrange/qemutls,\
endpoint=server,verify-peer=yes \
(qemu) object_add authz-simple,id=auth0,identity=CN=laptop.example.com,,\
O=Example Org,,L=London,,ST=London,,C=GB \
(qemu) migrate_incoming tcp:localhost:9000
Reviewed-by: Juan Quintela <quintela@redhat.com>
Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
Signed-off-by: Juan Quintela <quintela@redhat.com>
2019-02-27 15:53:24 +01:00
|
|
|
'tls-creds', 'tls-hostname', 'tls-authz', 'max-bandwidth',
|
2021-10-28 12:25:13 +02:00
|
|
|
'downtime-limit',
|
|
|
|
{ 'name': 'x-checkpoint-delay', 'features': [ 'unstable' ] },
|
|
|
|
'block-incremental',
|
2019-02-06 13:54:06 +01:00
|
|
|
'multifd-channels',
|
2018-08-01 15:00:20 +02:00
|
|
|
'xbzrle-cache-size', 'max-postcopy-bandwidth',
|
2020-01-23 17:08:52 +01:00
|
|
|
'max-cpu-throttle', 'multifd-compression',
|
2020-08-20 17:07:23 +02:00
|
|
|
'multifd-zlib-level' ,'multifd-zstd-level',
|
|
|
|
'block-bitmap-mapping' ] }
|
2017-08-24 21:14:01 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @MigrateSetParameters:
|
|
|
|
#
|
2019-02-27 14:24:06 +01:00
|
|
|
# @announce-initial: Initial delay (in milliseconds) before sending the first
|
2020-02-13 18:56:26 +01:00
|
|
|
# announce (Since 4.0)
|
2019-02-27 14:24:06 +01:00
|
|
|
#
|
|
|
|
# @announce-max: Maximum delay (in milliseconds) between packets in the
|
2020-02-13 18:56:26 +01:00
|
|
|
# announcement (Since 4.0)
|
2019-02-27 14:24:06 +01:00
|
|
|
#
|
|
|
|
# @announce-rounds: Number of self-announce packets sent after migration
|
2020-02-13 18:56:26 +01:00
|
|
|
# (Since 4.0)
|
2019-02-27 14:24:06 +01:00
|
|
|
#
|
|
|
|
# @announce-step: Increase in delay (in milliseconds) between subsequent
|
2020-02-13 18:56:26 +01:00
|
|
|
# packets in the announcement (Since 4.0)
|
2019-02-27 14:24:06 +01:00
|
|
|
#
|
2017-08-24 21:14:01 +02:00
|
|
|
# @compress-level: compression level
|
|
|
|
#
|
|
|
|
# @compress-threads: compression thread count
|
|
|
|
#
|
2018-08-21 10:10:20 +02:00
|
|
|
# @compress-wait-thread: Controls behavior when all compression threads are
|
|
|
|
# currently busy. If true (default), wait for a free
|
|
|
|
# compression thread to become available; otherwise,
|
|
|
|
# send the page uncompressed. (Since 3.1)
|
|
|
|
#
|
2017-08-24 21:14:01 +02:00
|
|
|
# @decompress-threads: decompression thread count
|
|
|
|
#
|
2020-02-24 03:31:42 +01:00
|
|
|
# @throttle-trigger-threshold: The ratio of bytes_dirty_period and bytes_xfer_period
|
|
|
|
# to trigger throttling. It is expressed as percentage.
|
|
|
|
# The default value is 50. (Since 5.0)
|
|
|
|
#
|
2017-08-24 21:14:01 +02:00
|
|
|
# @cpu-throttle-initial: Initial percentage of time guest cpus are
|
|
|
|
# throttled when migration auto-converge is activated.
|
|
|
|
# The default value is 20. (Since 2.7)
|
|
|
|
#
|
|
|
|
# @cpu-throttle-increment: throttle percentage increase each time
|
|
|
|
# auto-converge detects that migration is not making
|
|
|
|
# progress. The default value is 10. (Since 2.7)
|
|
|
|
#
|
2020-04-13 12:15:08 +02:00
|
|
|
# @cpu-throttle-tailslow: Make CPU throttling slower at tail stage
|
|
|
|
# At the tail stage of throttling, the Guest is very
|
|
|
|
# sensitive to CPU percentage while the @cpu-throttle
|
|
|
|
# -increment is excessive usually at tail stage.
|
|
|
|
# If this parameter is true, we will compute the ideal
|
|
|
|
# CPU percentage used by the Guest, which may exactly make
|
|
|
|
# the dirty rate match the dirty rate threshold. Then we
|
|
|
|
# will choose a smaller throttle increment between the
|
|
|
|
# one specified by @cpu-throttle-increment and the one
|
|
|
|
# generated by ideal CPU percentage.
|
|
|
|
# Therefore, it is compatible to traditional throttling,
|
|
|
|
# meanwhile the throttle increment won't be excessive
|
|
|
|
# at tail stage.
|
|
|
|
# The default value is false. (Since 5.1)
|
|
|
|
#
|
2017-08-24 21:14:01 +02:00
|
|
|
# @tls-creds: ID of the 'tls-creds' object that provides credentials
|
|
|
|
# for establishing a TLS connection over the migration data
|
|
|
|
# channel. On the outgoing side of the migration, the credentials
|
|
|
|
# must be for a 'client' endpoint, while for the incoming side the
|
|
|
|
# credentials must be for a 'server' endpoint. Setting this
|
|
|
|
# to a non-empty string enables TLS for all migrations.
|
|
|
|
# An empty string means that QEMU will use plain text mode for
|
|
|
|
# migration, rather than TLS (Since 2.9)
|
|
|
|
# Previously (since 2.7), this was reported by omitting
|
|
|
|
# tls-creds instead.
|
|
|
|
#
|
|
|
|
# @tls-hostname: hostname of the target host for the migration. This
|
|
|
|
# is required when using x509 based TLS credentials and the
|
|
|
|
# migration URI does not already include a hostname. For
|
|
|
|
# example if using fd: or exec: based migration, the
|
|
|
|
# hostname must be provided so that the server's x509
|
|
|
|
# certificate identity can be validated. (Since 2.7)
|
|
|
|
# An empty string means that QEMU will use the hostname
|
|
|
|
# associated with the migration URI, if any. (Since 2.9)
|
|
|
|
# Previously (since 2.7), this was reported by omitting
|
|
|
|
# tls-hostname instead.
|
|
|
|
#
|
|
|
|
# @max-bandwidth: to set maximum speed for migration. maximum speed in
|
|
|
|
# bytes per second. (Since 2.8)
|
|
|
|
#
|
|
|
|
# @downtime-limit: set maximum tolerated downtime for migration. maximum
|
|
|
|
# downtime in milliseconds (Since 2.8)
|
|
|
|
#
|
|
|
|
# @x-checkpoint-delay: the delay time between two COLO checkpoints. (Since 2.8)
|
|
|
|
#
|
|
|
|
# @block-incremental: Affects how much storage is migrated when the
|
2020-02-13 18:56:26 +01:00
|
|
|
# block migration capability is enabled. When false, the entire
|
|
|
|
# storage backing chain is migrated into a flattened image at
|
|
|
|
# the destination; when true, only the active qcow2 layer is
|
|
|
|
# migrated and the destination must already have access to the
|
|
|
|
# same backing chain as was used on the source. (since 2.10)
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
2019-02-06 13:54:06 +01:00
|
|
|
# @multifd-channels: Number of channels used to migrate data in
|
|
|
|
# parallel. This is the same number that the
|
|
|
|
# number of sockets used for migration. The
|
|
|
|
# default value is 2 (since 4.0)
|
2016-01-15 08:56:17 +01:00
|
|
|
#
|
2017-10-05 21:30:10 +02:00
|
|
|
# @xbzrle-cache-size: cache size to be used by XBZRLE migration. It
|
|
|
|
# needs to be a multiple of the target page size
|
|
|
|
# and a power of 2
|
|
|
|
# (Since 2.11)
|
2018-06-13 12:26:40 +02:00
|
|
|
#
|
|
|
|
# @max-postcopy-bandwidth: Background transfer bandwidth during postcopy.
|
2020-02-13 18:56:26 +01:00
|
|
|
# Defaults to 0 (unlimited). In bytes per second.
|
|
|
|
# (Since 3.0)
|
2018-08-01 15:00:20 +02:00
|
|
|
#
|
|
|
|
# @max-cpu-throttle: maximum cpu throttle percentage.
|
|
|
|
# The default value is 99. (Since 3.1)
|
|
|
|
#
|
2019-01-16 10:35:55 +01:00
|
|
|
# @multifd-compression: Which compression method to use.
|
|
|
|
# Defaults to none. (Since 5.0)
|
|
|
|
#
|
2020-01-23 17:08:52 +01:00
|
|
|
# @multifd-zlib-level: Set the compression level to be used in live
|
2020-08-10 21:50:00 +02:00
|
|
|
# migration, the compression level is an integer between 0
|
|
|
|
# and 9, where 0 means no compression, 1 means the best
|
|
|
|
# compression speed, and 9 means best compression ratio which
|
|
|
|
# will consume more CPU.
|
|
|
|
# Defaults to 1. (Since 5.0)
|
2020-01-23 17:08:52 +01:00
|
|
|
#
|
2020-01-23 17:41:36 +01:00
|
|
|
# @multifd-zstd-level: Set the compression level to be used in live
|
2020-08-10 21:50:00 +02:00
|
|
|
# migration, the compression level is an integer between 0
|
|
|
|
# and 20, where 0 means no compression, 1 means the best
|
|
|
|
# compression speed, and 20 means best compression ratio which
|
|
|
|
# will consume more CPU.
|
|
|
|
# Defaults to 1. (Since 5.0)
|
2020-01-23 17:41:36 +01:00
|
|
|
#
|
2020-08-20 17:07:23 +02:00
|
|
|
# @block-bitmap-mapping: Maps block nodes and bitmaps on them to
|
2020-09-25 18:22:56 +02:00
|
|
|
# aliases for the purpose of dirty bitmap migration. Such
|
|
|
|
# aliases may for example be the corresponding names on the
|
|
|
|
# opposite site.
|
|
|
|
# The mapping must be one-to-one, but not necessarily
|
|
|
|
# complete: On the source, unmapped bitmaps and all bitmaps
|
|
|
|
# on unmapped nodes will be ignored. On the destination,
|
|
|
|
# encountering an unmapped alias in the incoming migration
|
|
|
|
# stream will result in a report, and all further bitmap
|
|
|
|
# migration data will then be discarded.
|
|
|
|
# Note that the destination does not know about bitmaps it
|
|
|
|
# does not receive, so there is no limitation or requirement
|
|
|
|
# regarding the number of bitmaps received, or how they are
|
|
|
|
# named, or on which nodes they are placed.
|
|
|
|
# By default (when this parameter has never been set), bitmap
|
|
|
|
# names are mapped to themselves. Nodes are mapped to their
|
|
|
|
# block device name if there is one, and to their node name
|
|
|
|
# otherwise. (Since 5.2)
|
2020-08-20 17:07:23 +02:00
|
|
|
#
|
2021-10-28 12:25:13 +02:00
|
|
|
# Features:
|
|
|
|
# @unstable: Member @x-checkpoint-delay is experimental.
|
|
|
|
#
|
2017-08-24 21:14:01 +02:00
|
|
|
# Since: 2.4
|
|
|
|
##
|
|
|
|
# TODO either fuse back into MigrationParameters, or make
|
|
|
|
# MigrationParameters members mandatory
|
|
|
|
{ 'struct': 'MigrateSetParameters',
|
2019-02-27 14:24:06 +01:00
|
|
|
'data': { '*announce-initial': 'size',
|
|
|
|
'*announce-max': 'size',
|
|
|
|
'*announce-rounds': 'size',
|
|
|
|
'*announce-step': 'size',
|
2021-02-02 15:17:31 +01:00
|
|
|
'*compress-level': 'uint8',
|
|
|
|
'*compress-threads': 'uint8',
|
2018-08-21 10:10:20 +02:00
|
|
|
'*compress-wait-thread': 'bool',
|
2021-02-02 15:17:31 +01:00
|
|
|
'*decompress-threads': 'uint8',
|
|
|
|
'*throttle-trigger-threshold': 'uint8',
|
|
|
|
'*cpu-throttle-initial': 'uint8',
|
|
|
|
'*cpu-throttle-increment': 'uint8',
|
2020-04-13 12:15:08 +02:00
|
|
|
'*cpu-throttle-tailslow': 'bool',
|
2017-08-24 21:14:01 +02:00
|
|
|
'*tls-creds': 'StrOrNull',
|
|
|
|
'*tls-hostname': 'StrOrNull',
|
migration: add support for a "tls-authz" migration parameter
The QEMU instance that runs as the server for the migration data
transport (ie the target QEMU) needs to be able to configure access
control so it can prevent unauthorized clients initiating an incoming
migration. This adds a new 'tls-authz' migration parameter that is used
to provide the QOM ID of a QAuthZ subclass instance that provides the
access control check. This is checked against the x509 certificate
obtained during the TLS handshake.
For example, when starting a QEMU for incoming migration, it is
possible to give an example identity of the source QEMU that is
intended to be connecting later:
$QEMU \
-monitor stdio \
-incoming defer \
...other args...
(qemu) object_add tls-creds-x509,id=tls0,dir=/home/berrange/qemutls,\
endpoint=server,verify-peer=yes \
(qemu) object_add authz-simple,id=auth0,identity=CN=laptop.example.com,,\
O=Example Org,,L=London,,ST=London,,C=GB \
(qemu) migrate_incoming tcp:localhost:9000
Reviewed-by: Juan Quintela <quintela@redhat.com>
Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
Signed-off-by: Juan Quintela <quintela@redhat.com>
2019-02-27 15:53:24 +01:00
|
|
|
'*tls-authz': 'StrOrNull',
|
2021-02-02 15:17:31 +01:00
|
|
|
'*max-bandwidth': 'size',
|
|
|
|
'*downtime-limit': 'uint64',
|
2021-10-28 12:25:13 +02:00
|
|
|
'*x-checkpoint-delay': { 'type': 'uint32',
|
|
|
|
'features': [ 'unstable' ] },
|
2016-01-15 08:56:17 +01:00
|
|
|
'*block-incremental': 'bool',
|
2021-02-02 15:17:31 +01:00
|
|
|
'*multifd-channels': 'uint8',
|
2018-06-13 12:26:40 +02:00
|
|
|
'*xbzrle-cache-size': 'size',
|
2018-08-01 15:00:20 +02:00
|
|
|
'*max-postcopy-bandwidth': 'size',
|
2021-02-02 15:17:31 +01:00
|
|
|
'*max-cpu-throttle': 'uint8',
|
2020-01-23 17:08:52 +01:00
|
|
|
'*multifd-compression': 'MultiFDCompression',
|
2021-02-02 15:17:31 +01:00
|
|
|
'*multifd-zlib-level': 'uint8',
|
|
|
|
'*multifd-zstd-level': 'uint8',
|
2020-08-20 17:07:23 +02:00
|
|
|
'*block-bitmap-mapping': [ 'BitmapMigrationNodeAlias' ] } }
|
2017-08-24 21:14:01 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @migrate-set-parameters:
|
|
|
|
#
|
|
|
|
# Set various migration parameters.
|
|
|
|
#
|
|
|
|
# Since: 2.4
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "migrate-set-parameters" ,
|
|
|
|
# "arguments": { "compress-level": 1 } }
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'command': 'migrate-set-parameters', 'boxed': true,
|
|
|
|
'data': 'MigrateSetParameters' }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @MigrationParameters:
|
|
|
|
#
|
|
|
|
# The optional members aren't actually optional.
|
|
|
|
#
|
2019-02-27 14:24:06 +01:00
|
|
|
# @announce-initial: Initial delay (in milliseconds) before sending the
|
2020-02-13 18:56:26 +01:00
|
|
|
# first announce (Since 4.0)
|
2019-02-27 14:24:06 +01:00
|
|
|
#
|
|
|
|
# @announce-max: Maximum delay (in milliseconds) between packets in the
|
2020-02-13 18:56:26 +01:00
|
|
|
# announcement (Since 4.0)
|
2019-02-27 14:24:06 +01:00
|
|
|
#
|
|
|
|
# @announce-rounds: Number of self-announce packets sent after migration
|
2020-02-13 18:56:26 +01:00
|
|
|
# (Since 4.0)
|
2019-02-27 14:24:06 +01:00
|
|
|
#
|
|
|
|
# @announce-step: Increase in delay (in milliseconds) between subsequent
|
2020-02-13 18:56:26 +01:00
|
|
|
# packets in the announcement (Since 4.0)
|
2019-02-27 14:24:06 +01:00
|
|
|
#
|
2017-08-24 21:14:01 +02:00
|
|
|
# @compress-level: compression level
|
|
|
|
#
|
|
|
|
# @compress-threads: compression thread count
|
|
|
|
#
|
2018-08-21 10:10:20 +02:00
|
|
|
# @compress-wait-thread: Controls behavior when all compression threads are
|
|
|
|
# currently busy. If true (default), wait for a free
|
|
|
|
# compression thread to become available; otherwise,
|
|
|
|
# send the page uncompressed. (Since 3.1)
|
|
|
|
#
|
2017-08-24 21:14:01 +02:00
|
|
|
# @decompress-threads: decompression thread count
|
|
|
|
#
|
2020-02-24 03:31:42 +01:00
|
|
|
# @throttle-trigger-threshold: The ratio of bytes_dirty_period and bytes_xfer_period
|
|
|
|
# to trigger throttling. It is expressed as percentage.
|
|
|
|
# The default value is 50. (Since 5.0)
|
|
|
|
#
|
2017-08-24 21:14:01 +02:00
|
|
|
# @cpu-throttle-initial: Initial percentage of time guest cpus are
|
|
|
|
# throttled when migration auto-converge is activated.
|
|
|
|
# (Since 2.7)
|
|
|
|
#
|
|
|
|
# @cpu-throttle-increment: throttle percentage increase each time
|
|
|
|
# auto-converge detects that migration is not making
|
|
|
|
# progress. (Since 2.7)
|
|
|
|
#
|
2020-04-13 12:15:08 +02:00
|
|
|
# @cpu-throttle-tailslow: Make CPU throttling slower at tail stage
|
|
|
|
# At the tail stage of throttling, the Guest is very
|
|
|
|
# sensitive to CPU percentage while the @cpu-throttle
|
|
|
|
# -increment is excessive usually at tail stage.
|
|
|
|
# If this parameter is true, we will compute the ideal
|
|
|
|
# CPU percentage used by the Guest, which may exactly make
|
|
|
|
# the dirty rate match the dirty rate threshold. Then we
|
|
|
|
# will choose a smaller throttle increment between the
|
|
|
|
# one specified by @cpu-throttle-increment and the one
|
|
|
|
# generated by ideal CPU percentage.
|
|
|
|
# Therefore, it is compatible to traditional throttling,
|
|
|
|
# meanwhile the throttle increment won't be excessive
|
|
|
|
# at tail stage.
|
|
|
|
# The default value is false. (Since 5.1)
|
|
|
|
#
|
2017-08-24 21:14:01 +02:00
|
|
|
# @tls-creds: ID of the 'tls-creds' object that provides credentials
|
|
|
|
# for establishing a TLS connection over the migration data
|
|
|
|
# channel. On the outgoing side of the migration, the credentials
|
|
|
|
# must be for a 'client' endpoint, while for the incoming side the
|
|
|
|
# credentials must be for a 'server' endpoint.
|
|
|
|
# An empty string means that QEMU will use plain text mode for
|
|
|
|
# migration, rather than TLS (Since 2.7)
|
|
|
|
# Note: 2.8 reports this by omitting tls-creds instead.
|
|
|
|
#
|
|
|
|
# @tls-hostname: hostname of the target host for the migration. This
|
|
|
|
# is required when using x509 based TLS credentials and the
|
|
|
|
# migration URI does not already include a hostname. For
|
|
|
|
# example if using fd: or exec: based migration, the
|
|
|
|
# hostname must be provided so that the server's x509
|
|
|
|
# certificate identity can be validated. (Since 2.7)
|
|
|
|
# An empty string means that QEMU will use the hostname
|
|
|
|
# associated with the migration URI, if any. (Since 2.9)
|
|
|
|
# Note: 2.8 reports this by omitting tls-hostname instead.
|
|
|
|
#
|
migration: add support for a "tls-authz" migration parameter
The QEMU instance that runs as the server for the migration data
transport (ie the target QEMU) needs to be able to configure access
control so it can prevent unauthorized clients initiating an incoming
migration. This adds a new 'tls-authz' migration parameter that is used
to provide the QOM ID of a QAuthZ subclass instance that provides the
access control check. This is checked against the x509 certificate
obtained during the TLS handshake.
For example, when starting a QEMU for incoming migration, it is
possible to give an example identity of the source QEMU that is
intended to be connecting later:
$QEMU \
-monitor stdio \
-incoming defer \
...other args...
(qemu) object_add tls-creds-x509,id=tls0,dir=/home/berrange/qemutls,\
endpoint=server,verify-peer=yes \
(qemu) object_add authz-simple,id=auth0,identity=CN=laptop.example.com,,\
O=Example Org,,L=London,,ST=London,,C=GB \
(qemu) migrate_incoming tcp:localhost:9000
Reviewed-by: Juan Quintela <quintela@redhat.com>
Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
Signed-off-by: Juan Quintela <quintela@redhat.com>
2019-02-27 15:53:24 +01:00
|
|
|
# @tls-authz: ID of the 'authz' object subclass that provides access control
|
|
|
|
# checking of the TLS x509 certificate distinguished name. (Since
|
|
|
|
# 4.0)
|
|
|
|
#
|
2017-08-24 21:14:01 +02:00
|
|
|
# @max-bandwidth: to set maximum speed for migration. maximum speed in
|
|
|
|
# bytes per second. (Since 2.8)
|
|
|
|
#
|
|
|
|
# @downtime-limit: set maximum tolerated downtime for migration. maximum
|
|
|
|
# downtime in milliseconds (Since 2.8)
|
|
|
|
#
|
|
|
|
# @x-checkpoint-delay: the delay time between two COLO checkpoints. (Since 2.8)
|
|
|
|
#
|
|
|
|
# @block-incremental: Affects how much storage is migrated when the
|
2020-02-13 18:56:26 +01:00
|
|
|
# block migration capability is enabled. When false, the entire
|
|
|
|
# storage backing chain is migrated into a flattened image at
|
|
|
|
# the destination; when true, only the active qcow2 layer is
|
|
|
|
# migrated and the destination must already have access to the
|
|
|
|
# same backing chain as was used on the source. (since 2.10)
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
2019-02-06 13:54:06 +01:00
|
|
|
# @multifd-channels: Number of channels used to migrate data in
|
|
|
|
# parallel. This is the same number that the
|
|
|
|
# number of sockets used for migration.
|
|
|
|
# The default value is 2 (since 4.0)
|
2016-01-15 08:56:17 +01:00
|
|
|
#
|
2017-10-05 21:30:10 +02:00
|
|
|
# @xbzrle-cache-size: cache size to be used by XBZRLE migration. It
|
|
|
|
# needs to be a multiple of the target page size
|
|
|
|
# and a power of 2
|
|
|
|
# (Since 2.11)
|
2018-06-13 12:26:40 +02:00
|
|
|
#
|
|
|
|
# @max-postcopy-bandwidth: Background transfer bandwidth during postcopy.
|
2020-02-13 18:56:26 +01:00
|
|
|
# Defaults to 0 (unlimited). In bytes per second.
|
|
|
|
# (Since 3.0)
|
2018-08-01 15:00:20 +02:00
|
|
|
#
|
|
|
|
# @max-cpu-throttle: maximum cpu throttle percentage.
|
|
|
|
# Defaults to 99.
|
2020-02-13 18:56:26 +01:00
|
|
|
# (Since 3.1)
|
2018-08-01 15:00:20 +02:00
|
|
|
#
|
2019-01-16 10:35:55 +01:00
|
|
|
# @multifd-compression: Which compression method to use.
|
|
|
|
# Defaults to none. (Since 5.0)
|
|
|
|
#
|
2020-01-23 17:08:52 +01:00
|
|
|
# @multifd-zlib-level: Set the compression level to be used in live
|
2020-08-10 21:50:00 +02:00
|
|
|
# migration, the compression level is an integer between 0
|
|
|
|
# and 9, where 0 means no compression, 1 means the best
|
|
|
|
# compression speed, and 9 means best compression ratio which
|
|
|
|
# will consume more CPU.
|
|
|
|
# Defaults to 1. (Since 5.0)
|
2020-01-23 17:08:52 +01:00
|
|
|
#
|
2020-01-23 17:41:36 +01:00
|
|
|
# @multifd-zstd-level: Set the compression level to be used in live
|
2020-08-10 21:50:00 +02:00
|
|
|
# migration, the compression level is an integer between 0
|
|
|
|
# and 20, where 0 means no compression, 1 means the best
|
|
|
|
# compression speed, and 20 means best compression ratio which
|
|
|
|
# will consume more CPU.
|
|
|
|
# Defaults to 1. (Since 5.0)
|
2020-01-23 17:41:36 +01:00
|
|
|
#
|
2020-08-20 17:07:23 +02:00
|
|
|
# @block-bitmap-mapping: Maps block nodes and bitmaps on them to
|
2020-09-25 18:22:56 +02:00
|
|
|
# aliases for the purpose of dirty bitmap migration. Such
|
|
|
|
# aliases may for example be the corresponding names on the
|
|
|
|
# opposite site.
|
|
|
|
# The mapping must be one-to-one, but not necessarily
|
|
|
|
# complete: On the source, unmapped bitmaps and all bitmaps
|
|
|
|
# on unmapped nodes will be ignored. On the destination,
|
|
|
|
# encountering an unmapped alias in the incoming migration
|
|
|
|
# stream will result in a report, and all further bitmap
|
|
|
|
# migration data will then be discarded.
|
|
|
|
# Note that the destination does not know about bitmaps it
|
|
|
|
# does not receive, so there is no limitation or requirement
|
|
|
|
# regarding the number of bitmaps received, or how they are
|
|
|
|
# named, or on which nodes they are placed.
|
|
|
|
# By default (when this parameter has never been set), bitmap
|
|
|
|
# names are mapped to themselves. Nodes are mapped to their
|
|
|
|
# block device name if there is one, and to their node name
|
|
|
|
# otherwise. (Since 5.2)
|
2020-08-20 17:07:23 +02:00
|
|
|
#
|
2021-10-28 12:25:13 +02:00
|
|
|
# Features:
|
|
|
|
# @unstable: Member @x-checkpoint-delay is experimental.
|
|
|
|
#
|
2017-08-24 21:14:01 +02:00
|
|
|
# Since: 2.4
|
|
|
|
##
|
|
|
|
{ 'struct': 'MigrationParameters',
|
2019-02-27 14:24:06 +01:00
|
|
|
'data': { '*announce-initial': 'size',
|
|
|
|
'*announce-max': 'size',
|
|
|
|
'*announce-rounds': 'size',
|
|
|
|
'*announce-step': 'size',
|
|
|
|
'*compress-level': 'uint8',
|
2017-12-01 13:08:38 +01:00
|
|
|
'*compress-threads': 'uint8',
|
2018-08-21 10:10:20 +02:00
|
|
|
'*compress-wait-thread': 'bool',
|
2017-12-01 13:08:38 +01:00
|
|
|
'*decompress-threads': 'uint8',
|
2020-02-24 03:31:42 +01:00
|
|
|
'*throttle-trigger-threshold': 'uint8',
|
2017-12-01 13:08:38 +01:00
|
|
|
'*cpu-throttle-initial': 'uint8',
|
|
|
|
'*cpu-throttle-increment': 'uint8',
|
2020-04-13 12:15:08 +02:00
|
|
|
'*cpu-throttle-tailslow': 'bool',
|
2017-08-24 21:14:01 +02:00
|
|
|
'*tls-creds': 'str',
|
|
|
|
'*tls-hostname': 'str',
|
migration: add support for a "tls-authz" migration parameter
The QEMU instance that runs as the server for the migration data
transport (ie the target QEMU) needs to be able to configure access
control so it can prevent unauthorized clients initiating an incoming
migration. This adds a new 'tls-authz' migration parameter that is used
to provide the QOM ID of a QAuthZ subclass instance that provides the
access control check. This is checked against the x509 certificate
obtained during the TLS handshake.
For example, when starting a QEMU for incoming migration, it is
possible to give an example identity of the source QEMU that is
intended to be connecting later:
$QEMU \
-monitor stdio \
-incoming defer \
...other args...
(qemu) object_add tls-creds-x509,id=tls0,dir=/home/berrange/qemutls,\
endpoint=server,verify-peer=yes \
(qemu) object_add authz-simple,id=auth0,identity=CN=laptop.example.com,,\
O=Example Org,,L=London,,ST=London,,C=GB \
(qemu) migrate_incoming tcp:localhost:9000
Reviewed-by: Juan Quintela <quintela@redhat.com>
Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
Signed-off-by: Juan Quintela <quintela@redhat.com>
2019-02-27 15:53:24 +01:00
|
|
|
'*tls-authz': 'str',
|
2017-12-01 13:08:38 +01:00
|
|
|
'*max-bandwidth': 'size',
|
|
|
|
'*downtime-limit': 'uint64',
|
2021-10-28 12:25:13 +02:00
|
|
|
'*x-checkpoint-delay': { 'type': 'uint32',
|
|
|
|
'features': [ 'unstable' ] },
|
2021-02-02 15:17:31 +01:00
|
|
|
'*block-incremental': 'bool',
|
2019-02-06 13:54:06 +01:00
|
|
|
'*multifd-channels': 'uint8',
|
2018-06-13 12:26:40 +02:00
|
|
|
'*xbzrle-cache-size': 'size',
|
2020-02-13 18:56:27 +01:00
|
|
|
'*max-postcopy-bandwidth': 'size',
|
2019-01-16 10:35:55 +01:00
|
|
|
'*max-cpu-throttle': 'uint8',
|
2020-01-23 17:08:52 +01:00
|
|
|
'*multifd-compression': 'MultiFDCompression',
|
2020-01-23 17:41:36 +01:00
|
|
|
'*multifd-zlib-level': 'uint8',
|
2020-08-20 17:07:23 +02:00
|
|
|
'*multifd-zstd-level': 'uint8',
|
|
|
|
'*block-bitmap-mapping': [ 'BitmapMigrationNodeAlias' ] } }
|
2017-08-24 21:14:01 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @query-migrate-parameters:
|
|
|
|
#
|
|
|
|
# Returns information about the current migration parameters
|
|
|
|
#
|
|
|
|
# Returns: @MigrationParameters
|
|
|
|
#
|
|
|
|
# Since: 2.4
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "query-migrate-parameters" }
|
|
|
|
# <- { "return": {
|
|
|
|
# "decompress-threads": 2,
|
|
|
|
# "cpu-throttle-increment": 10,
|
|
|
|
# "compress-threads": 8,
|
|
|
|
# "compress-level": 1,
|
|
|
|
# "cpu-throttle-initial": 20,
|
|
|
|
# "max-bandwidth": 33554432,
|
|
|
|
# "downtime-limit": 300
|
|
|
|
# }
|
|
|
|
# }
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'command': 'query-migrate-parameters',
|
|
|
|
'returns': 'MigrationParameters' }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @client_migrate_info:
|
|
|
|
#
|
|
|
|
# Set migration information for remote display. This makes the server
|
|
|
|
# ask the client to automatically reconnect using the new parameters
|
|
|
|
# once migration finished successfully. Only implemented for SPICE.
|
|
|
|
#
|
|
|
|
# @protocol: must be "spice"
|
|
|
|
# @hostname: migration target hostname
|
|
|
|
# @port: spice tcp port for plaintext channels
|
|
|
|
# @tls-port: spice tcp port for tls-secured channels
|
|
|
|
# @cert-subject: server certificate subject
|
|
|
|
#
|
2020-11-18 07:41:58 +01:00
|
|
|
# Since: 0.14
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "client_migrate_info",
|
|
|
|
# "arguments": { "protocol": "spice",
|
|
|
|
# "hostname": "virt42.lab.kraxel.org",
|
|
|
|
# "port": 1234 } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'command': 'client_migrate_info',
|
|
|
|
'data': { 'protocol': 'str', 'hostname': 'str', '*port': 'int',
|
|
|
|
'*tls-port': 'int', '*cert-subject': 'str' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @migrate-start-postcopy:
|
|
|
|
#
|
|
|
|
# Followup to a migration command to switch the migration to postcopy mode.
|
2018-02-07 16:41:43 +01:00
|
|
|
# The postcopy-ram capability must be set on both source and destination
|
|
|
|
# before the original migration command.
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
|
|
|
# Since: 2.5
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "migrate-start-postcopy" }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'command': 'migrate-start-postcopy' }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @MIGRATION:
|
|
|
|
#
|
|
|
|
# Emitted when a migration event happens
|
|
|
|
#
|
|
|
|
# @status: @MigrationStatus describing the current migration status.
|
|
|
|
#
|
|
|
|
# Since: 2.4
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# <- {"timestamp": {"seconds": 1432121972, "microseconds": 744001},
|
|
|
|
# "event": "MIGRATION",
|
|
|
|
# "data": {"status": "completed"} }
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'event': 'MIGRATION',
|
|
|
|
'data': {'status': 'MigrationStatus'}}
|
|
|
|
|
|
|
|
##
|
|
|
|
# @MIGRATION_PASS:
|
|
|
|
#
|
|
|
|
# Emitted from the source side of a migration at the start of each pass
|
|
|
|
# (when it syncs the dirty bitmap)
|
|
|
|
#
|
|
|
|
# @pass: An incrementing count (starting at 1 on the first pass)
|
|
|
|
#
|
|
|
|
# Since: 2.6
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# { "timestamp": {"seconds": 1449669631, "microseconds": 239225},
|
|
|
|
# "event": "MIGRATION_PASS", "data": {"pass": 2} }
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'event': 'MIGRATION_PASS',
|
|
|
|
'data': { 'pass': 'int' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @COLOMessage:
|
|
|
|
#
|
|
|
|
# The message transmission between Primary side and Secondary side.
|
|
|
|
#
|
|
|
|
# @checkpoint-ready: Secondary VM (SVM) is ready for checkpointing
|
|
|
|
#
|
|
|
|
# @checkpoint-request: Primary VM (PVM) tells SVM to prepare for checkpointing
|
|
|
|
#
|
|
|
|
# @checkpoint-reply: SVM gets PVM's checkpoint request
|
|
|
|
#
|
|
|
|
# @vmstate-send: VM's state will be sent by PVM.
|
|
|
|
#
|
|
|
|
# @vmstate-size: The total size of VMstate.
|
|
|
|
#
|
|
|
|
# @vmstate-received: VM's state has been received by SVM.
|
|
|
|
#
|
|
|
|
# @vmstate-loaded: VM's state has been loaded by SVM.
|
|
|
|
#
|
|
|
|
# Since: 2.8
|
|
|
|
##
|
|
|
|
{ 'enum': 'COLOMessage',
|
|
|
|
'data': [ 'checkpoint-ready', 'checkpoint-request', 'checkpoint-reply',
|
|
|
|
'vmstate-send', 'vmstate-size', 'vmstate-received',
|
|
|
|
'vmstate-loaded' ] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @COLOMode:
|
|
|
|
#
|
2018-09-03 06:38:52 +02:00
|
|
|
# The COLO current mode.
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
2018-09-03 06:38:52 +02:00
|
|
|
# @none: COLO is disabled.
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
2018-09-03 06:38:52 +02:00
|
|
|
# @primary: COLO node in primary side.
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
2018-09-03 06:38:52 +02:00
|
|
|
# @secondary: COLO node in slave side.
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
|
|
|
# Since: 2.8
|
|
|
|
##
|
|
|
|
{ 'enum': 'COLOMode',
|
2018-09-03 06:38:52 +02:00
|
|
|
'data': [ 'none', 'primary', 'secondary'] }
|
2017-08-24 21:14:01 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @FailoverStatus:
|
|
|
|
#
|
|
|
|
# An enumeration of COLO failover status
|
|
|
|
#
|
|
|
|
# @none: no failover has ever happened
|
|
|
|
#
|
|
|
|
# @require: got failover requirement but not handled
|
|
|
|
#
|
|
|
|
# @active: in the process of doing failover
|
|
|
|
#
|
|
|
|
# @completed: finish the process of failover
|
|
|
|
#
|
|
|
|
# @relaunch: restart the failover process, from 'none' -> 'completed' (Since 2.9)
|
|
|
|
#
|
|
|
|
# Since: 2.8
|
|
|
|
##
|
|
|
|
{ 'enum': 'FailoverStatus',
|
|
|
|
'data': [ 'none', 'require', 'active', 'completed', 'relaunch' ] }
|
|
|
|
|
2018-09-03 06:38:51 +02:00
|
|
|
##
|
|
|
|
# @COLO_EXIT:
|
|
|
|
#
|
|
|
|
# Emitted when VM finishes COLO mode due to some errors happening or
|
|
|
|
# at the request of users.
|
|
|
|
#
|
|
|
|
# @mode: report COLO mode when COLO exited.
|
|
|
|
#
|
|
|
|
# @reason: describes the reason for the COLO exit.
|
|
|
|
#
|
|
|
|
# Since: 3.1
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# <- { "timestamp": {"seconds": 2032141960, "microseconds": 417172},
|
|
|
|
# "event": "COLO_EXIT", "data": {"mode": "primary", "reason": "request" } }
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'event': 'COLO_EXIT',
|
|
|
|
'data': {'mode': 'COLOMode', 'reason': 'COLOExitReason' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @COLOExitReason:
|
|
|
|
#
|
2019-03-22 11:13:31 +01:00
|
|
|
# The reason for a COLO exit.
|
2018-09-03 06:38:51 +02:00
|
|
|
#
|
2019-03-22 11:13:31 +01:00
|
|
|
# @none: failover has never happened. This state does not occur
|
2020-02-13 18:56:26 +01:00
|
|
|
# in the COLO_EXIT event, and is only visible in the result of
|
|
|
|
# query-colo-status.
|
2018-09-03 06:38:51 +02:00
|
|
|
#
|
2019-03-22 11:13:31 +01:00
|
|
|
# @request: COLO exit is due to an external request.
|
2018-09-03 06:38:51 +02:00
|
|
|
#
|
2019-03-22 11:13:31 +01:00
|
|
|
# @error: COLO exit is due to an internal error.
|
|
|
|
#
|
|
|
|
# @processing: COLO is currently handling a failover (since 4.0).
|
2018-09-03 06:38:51 +02:00
|
|
|
#
|
|
|
|
# Since: 3.1
|
|
|
|
##
|
|
|
|
{ 'enum': 'COLOExitReason',
|
2019-03-22 11:13:31 +01:00
|
|
|
'data': [ 'none', 'request', 'error' , 'processing' ] }
|
2018-09-03 06:38:51 +02:00
|
|
|
|
2017-08-24 21:14:01 +02:00
|
|
|
##
|
|
|
|
# @x-colo-lost-heartbeat:
|
|
|
|
#
|
|
|
|
# Tell qemu that heartbeat is lost, request it to do takeover procedures.
|
|
|
|
# If this command is sent to the PVM, the Primary side will exit COLO mode.
|
|
|
|
# If sent to the Secondary, the Secondary side will run failover work,
|
|
|
|
# then takes over server operation to become the service VM.
|
|
|
|
#
|
2021-10-28 12:25:13 +02:00
|
|
|
# Features:
|
|
|
|
# @unstable: This command is experimental.
|
|
|
|
#
|
2017-08-24 21:14:01 +02:00
|
|
|
# Since: 2.8
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "x-colo-lost-heartbeat" }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
|
|
|
##
|
2021-10-28 12:25:13 +02:00
|
|
|
{ 'command': 'x-colo-lost-heartbeat',
|
|
|
|
'features': [ 'unstable' ] }
|
2017-08-24 21:14:01 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @migrate_cancel:
|
|
|
|
#
|
|
|
|
# Cancel the current executing migration process.
|
|
|
|
#
|
|
|
|
# Returns: nothing on success
|
|
|
|
#
|
|
|
|
# Notes: This command succeeds even if there is no migration process running.
|
|
|
|
#
|
2020-11-18 07:41:58 +01:00
|
|
|
# Since: 0.14
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "migrate_cancel" }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'command': 'migrate_cancel' }
|
|
|
|
|
2017-10-20 11:05:53 +02:00
|
|
|
##
|
|
|
|
# @migrate-continue:
|
|
|
|
#
|
|
|
|
# Continue migration when it's in a paused state.
|
|
|
|
#
|
|
|
|
# @state: The state the migration is currently expected to be in
|
|
|
|
#
|
|
|
|
# Returns: nothing on success
|
|
|
|
# Since: 2.11
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "migrate-continue" , "arguments":
|
|
|
|
# { "state": "pre-switchover" } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
##
|
|
|
|
{ 'command': 'migrate-continue', 'data': {'state': 'MigrationStatus'} }
|
|
|
|
|
2017-08-24 21:14:01 +02:00
|
|
|
##
|
|
|
|
# @migrate:
|
|
|
|
#
|
|
|
|
# Migrates the current running guest to another Virtual Machine.
|
|
|
|
#
|
|
|
|
# @uri: the Uniform Resource Identifier of the destination VM
|
|
|
|
#
|
|
|
|
# @blk: do block migration (full disk copy)
|
|
|
|
#
|
|
|
|
# @inc: incremental disk copy migration
|
|
|
|
#
|
|
|
|
# @detach: this argument exists only for compatibility reasons and
|
|
|
|
# is ignored by QEMU
|
|
|
|
#
|
2018-05-22 12:39:56 +02:00
|
|
|
# @resume: resume one paused migration, default "off". (since 3.0)
|
2018-05-02 12:47:23 +02:00
|
|
|
#
|
2017-08-24 21:14:01 +02:00
|
|
|
# Returns: nothing on success
|
|
|
|
#
|
2020-11-18 07:41:58 +01:00
|
|
|
# Since: 0.14
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
|
|
|
# Notes:
|
|
|
|
#
|
|
|
|
# 1. The 'query-migrate' command should be used to check migration's progress
|
|
|
|
# and final result (this information is provided by the 'status' member)
|
|
|
|
#
|
|
|
|
# 2. All boolean arguments default to false
|
|
|
|
#
|
|
|
|
# 3. The user Monitor's "detach" argument is invalid in QMP and should not
|
|
|
|
# be used
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'command': 'migrate',
|
2018-05-02 12:47:23 +02:00
|
|
|
'data': {'uri': 'str', '*blk': 'bool', '*inc': 'bool',
|
|
|
|
'*detach': 'bool', '*resume': 'bool' } }
|
2017-08-24 21:14:01 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @migrate-incoming:
|
|
|
|
#
|
|
|
|
# Start an incoming migration, the qemu must have been started
|
|
|
|
# with -incoming defer
|
|
|
|
#
|
|
|
|
# @uri: The Uniform Resource Identifier identifying the source or
|
|
|
|
# address to listen on
|
|
|
|
#
|
|
|
|
# Returns: nothing on success
|
|
|
|
#
|
|
|
|
# Since: 2.3
|
|
|
|
#
|
|
|
|
# Notes:
|
|
|
|
#
|
|
|
|
# 1. It's a bad idea to use a string for the uri, but it needs to stay
|
|
|
|
# compatible with -incoming and the format of the uri is already exposed
|
|
|
|
# above libvirt.
|
|
|
|
#
|
|
|
|
# 2. QEMU must be started with -incoming defer to allow migrate-incoming to
|
|
|
|
# be used.
|
|
|
|
#
|
|
|
|
# 3. The uri format is the same as for -incoming
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "migrate-incoming",
|
|
|
|
# "arguments": { "uri": "tcp::4446" } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'command': 'migrate-incoming', 'data': {'uri': 'str' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @xen-save-devices-state:
|
|
|
|
#
|
|
|
|
# Save the state of all devices to file. The RAM and the block devices
|
|
|
|
# of the VM are not saved by this command.
|
|
|
|
#
|
|
|
|
# @filename: the file to save the state of the devices to as binary
|
2020-02-13 18:56:26 +01:00
|
|
|
# data. See xen-save-devices-state.txt for a description of the binary
|
|
|
|
# format.
|
2017-08-24 21:14:01 +02:00
|
|
|
#
|
2017-11-16 16:14:19 +01:00
|
|
|
# @live: Optional argument to ask QEMU to treat this command as part of a live
|
2020-02-13 18:56:26 +01:00
|
|
|
# migration. Default to true. (since 2.11)
|
2017-11-16 16:14:19 +01:00
|
|
|
#
|
2017-08-24 21:14:01 +02:00
|
|
|
# Returns: Nothing on success
|
|
|
|
#
|
|
|
|
# Since: 1.1
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "xen-save-devices-state",
|
|
|
|
# "arguments": { "filename": "/tmp/save" } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
|
|
|
##
|
2017-11-16 16:14:19 +01:00
|
|
|
{ 'command': 'xen-save-devices-state',
|
|
|
|
'data': {'filename': 'str', '*live':'bool' } }
|
2017-08-24 21:14:01 +02:00
|
|
|
|
2020-10-12 14:15:36 +02:00
|
|
|
##
|
|
|
|
# @xen-set-global-dirty-log:
|
|
|
|
#
|
|
|
|
# Enable or disable the global dirty log mode.
|
|
|
|
#
|
|
|
|
# @enable: true to enable, false to disable.
|
|
|
|
#
|
|
|
|
# Returns: nothing
|
|
|
|
#
|
|
|
|
# Since: 1.3
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "xen-set-global-dirty-log",
|
|
|
|
# "arguments": { "enable": true } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'command': 'xen-set-global-dirty-log', 'data': { 'enable': 'bool' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @xen-load-devices-state:
|
|
|
|
#
|
|
|
|
# Load the state of all devices from file. The RAM and the block devices
|
|
|
|
# of the VM are not loaded by this command.
|
|
|
|
#
|
|
|
|
# @filename: the file to load the state of the devices from as binary
|
|
|
|
# data. See xen-save-devices-state.txt for a description of the binary
|
|
|
|
# format.
|
|
|
|
#
|
|
|
|
# Since: 2.7
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "xen-load-devices-state",
|
|
|
|
# "arguments": { "filename": "/tmp/resume" } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'command': 'xen-load-devices-state', 'data': {'filename': 'str'} }
|
|
|
|
|
2017-08-24 21:14:01 +02:00
|
|
|
##
|
|
|
|
# @xen-set-replication:
|
|
|
|
#
|
|
|
|
# Enable or disable replication.
|
|
|
|
#
|
|
|
|
# @enable: true to enable, false to disable.
|
|
|
|
#
|
|
|
|
# @primary: true for primary or false for secondary.
|
|
|
|
#
|
|
|
|
# @failover: true to do failover, false to stop. but cannot be
|
|
|
|
# specified if 'enable' is true. default value is false.
|
|
|
|
#
|
|
|
|
# Returns: nothing.
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "xen-set-replication",
|
|
|
|
# "arguments": {"enable": true, "primary": false} }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
|
|
|
# Since: 2.9
|
|
|
|
##
|
|
|
|
{ 'command': 'xen-set-replication',
|
2018-12-13 13:37:24 +01:00
|
|
|
'data': { 'enable': 'bool', 'primary': 'bool', '*failover' : 'bool' },
|
2021-08-04 10:31:05 +02:00
|
|
|
'if': 'CONFIG_REPLICATION' }
|
2017-08-24 21:14:01 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @ReplicationStatus:
|
|
|
|
#
|
|
|
|
# The result format for 'query-xen-replication-status'.
|
|
|
|
#
|
|
|
|
# @error: true if an error happened, false if replication is normal.
|
|
|
|
#
|
|
|
|
# @desc: the human readable error description string, when
|
|
|
|
# @error is 'true'.
|
|
|
|
#
|
|
|
|
# Since: 2.9
|
|
|
|
##
|
|
|
|
{ 'struct': 'ReplicationStatus',
|
2018-12-13 13:37:24 +01:00
|
|
|
'data': { 'error': 'bool', '*desc': 'str' },
|
2021-08-04 10:31:05 +02:00
|
|
|
'if': 'CONFIG_REPLICATION' }
|
2017-08-24 21:14:01 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @query-xen-replication-status:
|
|
|
|
#
|
|
|
|
# Query replication status while the vm is running.
|
|
|
|
#
|
|
|
|
# Returns: A @ReplicationResult object showing the status.
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "query-xen-replication-status" }
|
|
|
|
# <- { "return": { "error": false } }
|
|
|
|
#
|
|
|
|
# Since: 2.9
|
|
|
|
##
|
|
|
|
{ 'command': 'query-xen-replication-status',
|
2018-12-13 13:37:24 +01:00
|
|
|
'returns': 'ReplicationStatus',
|
2021-08-04 10:31:05 +02:00
|
|
|
'if': 'CONFIG_REPLICATION' }
|
2017-08-24 21:14:01 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @xen-colo-do-checkpoint:
|
|
|
|
#
|
|
|
|
# Xen uses this command to notify replication to trigger a checkpoint.
|
|
|
|
#
|
|
|
|
# Returns: nothing.
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "xen-colo-do-checkpoint" }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
|
|
|
# Since: 2.9
|
|
|
|
##
|
2018-12-13 13:37:24 +01:00
|
|
|
{ 'command': 'xen-colo-do-checkpoint',
|
2021-08-04 10:31:05 +02:00
|
|
|
'if': 'CONFIG_REPLICATION' }
|
2018-05-02 12:47:36 +02:00
|
|
|
|
2018-09-03 06:38:53 +02:00
|
|
|
##
|
|
|
|
# @COLOStatus:
|
|
|
|
#
|
|
|
|
# The result format for 'query-colo-status'.
|
|
|
|
#
|
|
|
|
# @mode: COLO running mode. If COLO is running, this field will return
|
|
|
|
# 'primary' or 'secondary'.
|
|
|
|
#
|
2019-04-02 10:55:21 +02:00
|
|
|
# @last-mode: COLO last running mode. If COLO is running, this field
|
2019-03-22 11:13:33 +01:00
|
|
|
# will return same like mode field, after failover we can
|
2019-03-26 18:45:10 +01:00
|
|
|
# use this field to get last colo mode. (since 4.0)
|
2019-03-22 11:13:33 +01:00
|
|
|
#
|
2018-09-03 06:38:53 +02:00
|
|
|
# @reason: describes the reason for the COLO exit.
|
|
|
|
#
|
2018-10-22 18:41:18 +02:00
|
|
|
# Since: 3.1
|
2018-09-03 06:38:53 +02:00
|
|
|
##
|
|
|
|
{ 'struct': 'COLOStatus',
|
2019-04-02 10:55:21 +02:00
|
|
|
'data': { 'mode': 'COLOMode', 'last-mode': 'COLOMode',
|
2019-03-22 11:13:33 +01:00
|
|
|
'reason': 'COLOExitReason' } }
|
2018-09-03 06:38:53 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @query-colo-status:
|
|
|
|
#
|
|
|
|
# Query COLO status while the vm is running.
|
|
|
|
#
|
|
|
|
# Returns: A @COLOStatus object showing the status.
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "query-colo-status" }
|
2019-03-03 15:50:19 +01:00
|
|
|
# <- { "return": { "mode": "primary", "reason": "request" } }
|
2018-09-03 06:38:53 +02:00
|
|
|
#
|
2018-10-22 18:41:18 +02:00
|
|
|
# Since: 3.1
|
2018-09-03 06:38:53 +02:00
|
|
|
##
|
|
|
|
{ 'command': 'query-colo-status',
|
|
|
|
'returns': 'COLOStatus' }
|
|
|
|
|
2018-05-02 12:47:36 +02:00
|
|
|
##
|
|
|
|
# @migrate-recover:
|
|
|
|
#
|
|
|
|
# Provide a recovery migration stream URI.
|
|
|
|
#
|
|
|
|
# @uri: the URI to be used for the recovery of migration stream.
|
|
|
|
#
|
|
|
|
# Returns: nothing.
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "migrate-recover",
|
|
|
|
# "arguments": { "uri": "tcp:192.168.1.200:12345" } }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
2018-05-22 12:39:56 +02:00
|
|
|
# Since: 3.0
|
2018-05-02 12:47:36 +02:00
|
|
|
##
|
2018-12-08 12:16:04 +01:00
|
|
|
{ 'command': 'migrate-recover',
|
|
|
|
'data': { 'uri': 'str' },
|
2018-05-02 12:47:36 +02:00
|
|
|
'allow-oob': true }
|
2018-05-02 12:47:39 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @migrate-pause:
|
|
|
|
#
|
|
|
|
# Pause a migration. Currently it only supports postcopy.
|
|
|
|
#
|
|
|
|
# Returns: nothing.
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "migrate-pause" }
|
|
|
|
# <- { "return": {} }
|
|
|
|
#
|
2018-05-22 12:39:56 +02:00
|
|
|
# Since: 3.0
|
2018-05-02 12:47:39 +02:00
|
|
|
##
|
|
|
|
{ 'command': 'migrate-pause', 'allow-oob': true }
|
2019-10-29 12:48:59 +01:00
|
|
|
|
|
|
|
##
|
|
|
|
# @UNPLUG_PRIMARY:
|
|
|
|
#
|
|
|
|
# Emitted from source side of a migration when migration state is
|
|
|
|
# WAIT_UNPLUG. Device was unplugged by guest operating system.
|
|
|
|
# Device resources in QEMU are kept on standby to be able to re-plug it in case
|
|
|
|
# of migration failure.
|
|
|
|
#
|
|
|
|
# @device-id: QEMU device id of the unplugged device
|
|
|
|
#
|
|
|
|
# Since: 4.2
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
# {"event": "UNPLUG_PRIMARY", "data": {"device-id": "hostdev0"} }
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'event': 'UNPLUG_PRIMARY',
|
|
|
|
'data': { 'device-id': 'str' } }
|
2020-09-16 08:21:57 +02:00
|
|
|
|
2021-06-29 18:01:20 +02:00
|
|
|
##
|
|
|
|
# @DirtyRateVcpu:
|
|
|
|
#
|
|
|
|
# Dirty rate of vcpu.
|
|
|
|
#
|
|
|
|
# @id: vcpu index.
|
|
|
|
#
|
|
|
|
# @dirty-rate: dirty rate.
|
|
|
|
#
|
|
|
|
# Since: 6.1
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'struct': 'DirtyRateVcpu',
|
|
|
|
'data': { 'id': 'int', 'dirty-rate': 'int64' } }
|
|
|
|
|
2020-09-16 08:21:57 +02:00
|
|
|
##
|
|
|
|
# @DirtyRateStatus:
|
|
|
|
#
|
|
|
|
# An enumeration of dirtyrate status.
|
|
|
|
#
|
|
|
|
# @unstarted: the dirtyrate thread has not been started.
|
|
|
|
#
|
|
|
|
# @measuring: the dirtyrate thread is measuring.
|
|
|
|
#
|
|
|
|
# @measured: the dirtyrate thread has measured and results are available.
|
|
|
|
#
|
|
|
|
# Since: 5.2
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'enum': 'DirtyRateStatus',
|
|
|
|
'data': [ 'unstarted', 'measuring', 'measured'] }
|
2020-09-16 08:22:06 +02:00
|
|
|
|
2021-06-29 18:01:20 +02:00
|
|
|
##
|
|
|
|
# @DirtyRateMeasureMode:
|
|
|
|
#
|
|
|
|
# An enumeration of mode of measuring dirtyrate.
|
|
|
|
#
|
|
|
|
# @page-sampling: calculate dirtyrate by sampling pages.
|
|
|
|
#
|
|
|
|
# @dirty-ring: calculate dirtyrate by via dirty ring.
|
|
|
|
#
|
|
|
|
# Since: 6.1
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'enum': 'DirtyRateMeasureMode',
|
|
|
|
'data': ['page-sampling', 'dirty-ring'] }
|
|
|
|
|
2020-09-16 08:22:06 +02:00
|
|
|
##
|
|
|
|
# @DirtyRateInfo:
|
|
|
|
#
|
|
|
|
# Information about current dirty page rate of vm.
|
|
|
|
#
|
migration/dirtyrate: present dirty rate only when querying the rate has completed
Make dirty_rate field optional, present dirty rate only when querying
the rate has completed.
The qmp results is shown as follow:
@unstarted:
{"return":{"status":"unstarted","start-time":0,"calc-time":0},"id":"libvirt-12"}
@measuring:
{"return":{"status":"measuring","start-time":102931,"calc-time":1},"id":"libvirt-85"}
@measured:
{"return":{"status":"measured","dirty-rate":4,"start-time":150146,"calc-time":1},"id":"libvirt-15"}
Signed-off-by: Chuan Zheng <zhengchuan@huawei.com>
Reviewed-by: David Edmondson <david.edmondson@oracle.com>
Message-Id: <1601350938-128320-3-git-send-email-zhengchuan@huawei.com>
Signed-off-by: Dr. David Alan Gilbert <dgilbert@redhat.com>
2020-09-29 05:42:18 +02:00
|
|
|
# @dirty-rate: an estimate of the dirty page rate of the VM in units of
|
|
|
|
# MB/s, present only when estimating the rate has completed.
|
2020-09-16 08:22:06 +02:00
|
|
|
#
|
|
|
|
# @status: status containing dirtyrate query status includes
|
|
|
|
# 'unstarted' or 'measuring' or 'measured'
|
|
|
|
#
|
|
|
|
# @start-time: start time in units of second for calculation
|
|
|
|
#
|
|
|
|
# @calc-time: time in units of second for sample dirty pages
|
|
|
|
#
|
2021-06-07 03:11:34 +02:00
|
|
|
# @sample-pages: page count per GB for sample dirty pages
|
|
|
|
# the default value is 512 (since 6.1)
|
|
|
|
#
|
2021-06-29 18:01:23 +02:00
|
|
|
# @mode: mode containing method of calculate dirtyrate includes
|
|
|
|
# 'page-sampling' and 'dirty-ring' (Since 6.1)
|
|
|
|
#
|
|
|
|
# @vcpu-dirty-rate: dirtyrate for each vcpu if dirty-ring
|
|
|
|
# mode specified (Since 6.1)
|
|
|
|
#
|
2020-09-16 08:22:06 +02:00
|
|
|
# Since: 5.2
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'struct': 'DirtyRateInfo',
|
migration/dirtyrate: present dirty rate only when querying the rate has completed
Make dirty_rate field optional, present dirty rate only when querying
the rate has completed.
The qmp results is shown as follow:
@unstarted:
{"return":{"status":"unstarted","start-time":0,"calc-time":0},"id":"libvirt-12"}
@measuring:
{"return":{"status":"measuring","start-time":102931,"calc-time":1},"id":"libvirt-85"}
@measured:
{"return":{"status":"measured","dirty-rate":4,"start-time":150146,"calc-time":1},"id":"libvirt-15"}
Signed-off-by: Chuan Zheng <zhengchuan@huawei.com>
Reviewed-by: David Edmondson <david.edmondson@oracle.com>
Message-Id: <1601350938-128320-3-git-send-email-zhengchuan@huawei.com>
Signed-off-by: Dr. David Alan Gilbert <dgilbert@redhat.com>
2020-09-29 05:42:18 +02:00
|
|
|
'data': {'*dirty-rate': 'int64',
|
2020-09-16 08:22:06 +02:00
|
|
|
'status': 'DirtyRateStatus',
|
|
|
|
'start-time': 'int64',
|
2021-06-07 03:11:34 +02:00
|
|
|
'calc-time': 'int64',
|
2021-06-29 18:01:23 +02:00
|
|
|
'sample-pages': 'uint64',
|
|
|
|
'mode': 'DirtyRateMeasureMode',
|
|
|
|
'*vcpu-dirty-rate': [ 'DirtyRateVcpu' ] } }
|
2020-09-16 08:22:06 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @calc-dirty-rate:
|
|
|
|
#
|
|
|
|
# start calculating dirty page rate for vm
|
|
|
|
#
|
|
|
|
# @calc-time: time in units of second for sample dirty pages
|
|
|
|
#
|
2021-06-07 03:11:34 +02:00
|
|
|
# @sample-pages: page count per GB for sample dirty pages
|
|
|
|
# the default value is 512 (since 6.1)
|
|
|
|
#
|
2021-06-29 18:01:23 +02:00
|
|
|
# @mode: mechanism of calculating dirtyrate includes
|
|
|
|
# 'page-sampling' and 'dirty-ring' (Since 6.1)
|
|
|
|
#
|
2020-09-16 08:22:06 +02:00
|
|
|
# Since: 5.2
|
|
|
|
#
|
|
|
|
# Example:
|
2021-06-07 03:11:34 +02:00
|
|
|
# {"command": "calc-dirty-rate", "data": {"calc-time": 1,
|
|
|
|
# 'sample-pages': 512} }
|
2020-09-16 08:22:06 +02:00
|
|
|
#
|
|
|
|
##
|
2021-06-07 03:11:34 +02:00
|
|
|
{ 'command': 'calc-dirty-rate', 'data': {'calc-time': 'int64',
|
2021-06-29 18:01:23 +02:00
|
|
|
'*sample-pages': 'int',
|
|
|
|
'*mode': 'DirtyRateMeasureMode'} }
|
2020-09-16 08:22:06 +02:00
|
|
|
|
|
|
|
##
|
|
|
|
# @query-dirty-rate:
|
|
|
|
#
|
|
|
|
# query dirty page rate in units of MB/s for vm
|
|
|
|
#
|
|
|
|
# Since: 5.2
|
|
|
|
##
|
|
|
|
{ 'command': 'query-dirty-rate', 'returns': 'DirtyRateInfo' }
|
migration: introduce snapshot-{save, load, delete} QMP commands
savevm, loadvm and delvm are some of the few HMP commands that have never
been converted to use QMP. The reasons for the lack of conversion are
that they blocked execution of the event thread, and the semantics
around choice of disks were ill-defined.
Despite this downside, however, libvirt and applications using libvirt
have used these commands for as long as QMP has existed, via the
"human-monitor-command" passthrough command. IOW, while it is clearly
desirable to be able to fix the problems, they are not a blocker to
all real world usage.
Meanwhile there is a need for other features which involve adding new
parameters to the commands. This is possible with HMP passthrough, but
it provides no reliable way for apps to introspect features, so using
QAPI modelling is highly desirable.
This patch thus introduces new snapshot-{load,save,delete} commands to
QMP that are intended to replace the old HMP counterparts. The new
commands are given different names, because they will be using the new
QEMU job framework and thus will have diverging behaviour from the HMP
originals. It would thus be misleading to keep the same name.
While this design uses the generic job framework, the current impl is
still blocking. The intention that the blocking problem is fixed later.
None the less applications using these new commands should assume that
they are asynchronous and thus wait for the job status change event to
indicate completion.
In addition to using the job framework, the new commands require the
caller to be explicit about all the block device nodes used in the
snapshot operations, with no built-in default heuristics in use.
Note that the existing "query-named-block-nodes" can be used to query
what snapshots currently exist for block nodes.
Acked-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
Message-Id: <20210204124834.774401-13-berrange@redhat.com>
Signed-off-by: Dr. David Alan Gilbert <dgilbert@redhat.com>
dgilbert: removed tests for now, the output ordering isn't
deterministic
2021-02-04 13:48:34 +01:00
|
|
|
|
|
|
|
##
|
|
|
|
# @snapshot-save:
|
|
|
|
#
|
|
|
|
# Save a VM snapshot
|
|
|
|
#
|
|
|
|
# @job-id: identifier for the newly created job
|
|
|
|
# @tag: name of the snapshot to create
|
|
|
|
# @vmstate: block device node name to save vmstate to
|
|
|
|
# @devices: list of block device node names to save a snapshot to
|
|
|
|
#
|
|
|
|
# Applications should not assume that the snapshot save is complete
|
|
|
|
# when this command returns. The job commands / events must be used
|
|
|
|
# to determine completion and to fetch details of any errors that arise.
|
|
|
|
#
|
|
|
|
# Note that execution of the guest CPUs may be stopped during the
|
|
|
|
# time it takes to save the snapshot. A future version of QEMU
|
|
|
|
# may ensure CPUs are executing continuously.
|
|
|
|
#
|
|
|
|
# It is strongly recommended that @devices contain all writable
|
|
|
|
# block device nodes if a consistent snapshot is required.
|
|
|
|
#
|
|
|
|
# If @tag already exists, an error will be reported
|
|
|
|
#
|
|
|
|
# Returns: nothing
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "snapshot-save",
|
|
|
|
# "data": {
|
|
|
|
# "job-id": "snapsave0",
|
|
|
|
# "tag": "my-snap",
|
|
|
|
# "vmstate": "disk0",
|
|
|
|
# "devices": ["disk0", "disk1"]
|
|
|
|
# }
|
|
|
|
# }
|
|
|
|
# <- { "return": { } }
|
|
|
|
# <- {"event": "JOB_STATUS_CHANGE",
|
|
|
|
# "data": {"status": "created", "id": "snapsave0"}}
|
|
|
|
# <- {"event": "JOB_STATUS_CHANGE",
|
|
|
|
# "data": {"status": "running", "id": "snapsave0"}}
|
|
|
|
# <- {"event": "STOP"}
|
|
|
|
# <- {"event": "RESUME"}
|
|
|
|
# <- {"event": "JOB_STATUS_CHANGE",
|
|
|
|
# "data": {"status": "waiting", "id": "snapsave0"}}
|
|
|
|
# <- {"event": "JOB_STATUS_CHANGE",
|
|
|
|
# "data": {"status": "pending", "id": "snapsave0"}}
|
|
|
|
# <- {"event": "JOB_STATUS_CHANGE",
|
|
|
|
# "data": {"status": "concluded", "id": "snapsave0"}}
|
|
|
|
# -> {"execute": "query-jobs"}
|
|
|
|
# <- {"return": [{"current-progress": 1,
|
|
|
|
# "status": "concluded",
|
|
|
|
# "total-progress": 1,
|
|
|
|
# "type": "snapshot-save",
|
|
|
|
# "id": "snapsave0"}]}
|
|
|
|
#
|
|
|
|
# Since: 6.0
|
|
|
|
##
|
|
|
|
{ 'command': 'snapshot-save',
|
|
|
|
'data': { 'job-id': 'str',
|
|
|
|
'tag': 'str',
|
|
|
|
'vmstate': 'str',
|
|
|
|
'devices': ['str'] } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @snapshot-load:
|
|
|
|
#
|
|
|
|
# Load a VM snapshot
|
|
|
|
#
|
|
|
|
# @job-id: identifier for the newly created job
|
|
|
|
# @tag: name of the snapshot to load.
|
|
|
|
# @vmstate: block device node name to load vmstate from
|
|
|
|
# @devices: list of block device node names to load a snapshot from
|
|
|
|
#
|
|
|
|
# Applications should not assume that the snapshot load is complete
|
|
|
|
# when this command returns. The job commands / events must be used
|
|
|
|
# to determine completion and to fetch details of any errors that arise.
|
|
|
|
#
|
|
|
|
# Note that execution of the guest CPUs will be stopped during the
|
|
|
|
# time it takes to load the snapshot.
|
|
|
|
#
|
|
|
|
# It is strongly recommended that @devices contain all writable
|
|
|
|
# block device nodes that can have changed since the original
|
|
|
|
# @snapshot-save command execution.
|
|
|
|
#
|
|
|
|
# Returns: nothing
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "snapshot-load",
|
|
|
|
# "data": {
|
|
|
|
# "job-id": "snapload0",
|
|
|
|
# "tag": "my-snap",
|
|
|
|
# "vmstate": "disk0",
|
|
|
|
# "devices": ["disk0", "disk1"]
|
|
|
|
# }
|
|
|
|
# }
|
|
|
|
# <- { "return": { } }
|
|
|
|
# <- {"event": "JOB_STATUS_CHANGE",
|
|
|
|
# "data": {"status": "created", "id": "snapload0"}}
|
|
|
|
# <- {"event": "JOB_STATUS_CHANGE",
|
|
|
|
# "data": {"status": "running", "id": "snapload0"}}
|
|
|
|
# <- {"event": "STOP"}
|
|
|
|
# <- {"event": "RESUME"}
|
|
|
|
# <- {"event": "JOB_STATUS_CHANGE",
|
|
|
|
# "data": {"status": "waiting", "id": "snapload0"}}
|
|
|
|
# <- {"event": "JOB_STATUS_CHANGE",
|
|
|
|
# "data": {"status": "pending", "id": "snapload0"}}
|
|
|
|
# <- {"event": "JOB_STATUS_CHANGE",
|
|
|
|
# "data": {"status": "concluded", "id": "snapload0"}}
|
|
|
|
# -> {"execute": "query-jobs"}
|
|
|
|
# <- {"return": [{"current-progress": 1,
|
|
|
|
# "status": "concluded",
|
|
|
|
# "total-progress": 1,
|
|
|
|
# "type": "snapshot-load",
|
|
|
|
# "id": "snapload0"}]}
|
|
|
|
#
|
|
|
|
# Since: 6.0
|
|
|
|
##
|
|
|
|
{ 'command': 'snapshot-load',
|
|
|
|
'data': { 'job-id': 'str',
|
|
|
|
'tag': 'str',
|
|
|
|
'vmstate': 'str',
|
|
|
|
'devices': ['str'] } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @snapshot-delete:
|
|
|
|
#
|
|
|
|
# Delete a VM snapshot
|
|
|
|
#
|
|
|
|
# @job-id: identifier for the newly created job
|
|
|
|
# @tag: name of the snapshot to delete.
|
|
|
|
# @devices: list of block device node names to delete a snapshot from
|
|
|
|
#
|
|
|
|
# Applications should not assume that the snapshot delete is complete
|
|
|
|
# when this command returns. The job commands / events must be used
|
|
|
|
# to determine completion and to fetch details of any errors that arise.
|
|
|
|
#
|
|
|
|
# Returns: nothing
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "snapshot-delete",
|
|
|
|
# "data": {
|
|
|
|
# "job-id": "snapdelete0",
|
|
|
|
# "tag": "my-snap",
|
|
|
|
# "devices": ["disk0", "disk1"]
|
|
|
|
# }
|
|
|
|
# }
|
|
|
|
# <- { "return": { } }
|
|
|
|
# <- {"event": "JOB_STATUS_CHANGE",
|
|
|
|
# "data": {"status": "created", "id": "snapdelete0"}}
|
|
|
|
# <- {"event": "JOB_STATUS_CHANGE",
|
|
|
|
# "data": {"status": "running", "id": "snapdelete0"}}
|
|
|
|
# <- {"event": "JOB_STATUS_CHANGE",
|
|
|
|
# "data": {"status": "waiting", "id": "snapdelete0"}}
|
|
|
|
# <- {"event": "JOB_STATUS_CHANGE",
|
|
|
|
# "data": {"status": "pending", "id": "snapdelete0"}}
|
|
|
|
# <- {"event": "JOB_STATUS_CHANGE",
|
|
|
|
# "data": {"status": "concluded", "id": "snapdelete0"}}
|
|
|
|
# -> {"execute": "query-jobs"}
|
|
|
|
# <- {"return": [{"current-progress": 1,
|
|
|
|
# "status": "concluded",
|
|
|
|
# "total-progress": 1,
|
|
|
|
# "type": "snapshot-delete",
|
|
|
|
# "id": "snapdelete0"}]}
|
|
|
|
#
|
|
|
|
# Since: 6.0
|
|
|
|
##
|
|
|
|
{ 'command': 'snapshot-delete',
|
|
|
|
'data': { 'job-id': 'str',
|
|
|
|
'tag': 'str',
|
|
|
|
'devices': ['str'] } }
|