1# -*- Mode: Python -*- 2# vim: filetype=python 3 4## 5# == Block core (VM unrelated) 6## 7 8{ 'include': 'common.json' } 9{ 'include': 'crypto.json' } 10{ 'include': 'job.json' } 11{ 'include': 'sockets.json' } 12 13## 14# @SnapshotInfo: 15# 16# @id: unique snapshot id 17# 18# @name: user chosen name 19# 20# @vm-state-size: size of the VM state 21# 22# @date-sec: UTC date of the snapshot in seconds 23# 24# @date-nsec: fractional part in nano seconds to be used with date-sec 25# 26# @vm-clock-sec: VM clock relative to boot in seconds 27# 28# @vm-clock-nsec: fractional part in nano seconds to be used with 29# vm-clock-sec 30# 31# @icount: Current instruction count. Appears when execution 32# record/replay is enabled. Used for "time-traveling" to match 33# the moment in the recorded execution with the snapshots. This 34# counter may be obtained through @query-replay command (since 35# 5.2) 36# 37# Since: 1.3 38## 39{ 'struct': 'SnapshotInfo', 40 'data': { 'id': 'str', 'name': 'str', 'vm-state-size': 'int', 41 'date-sec': 'int', 'date-nsec': 'int', 42 'vm-clock-sec': 'int', 'vm-clock-nsec': 'int', 43 '*icount': 'int' } } 44 45## 46# @ImageInfoSpecificQCow2EncryptionBase: 47# 48# @format: The encryption format 49# 50# Since: 2.10 51## 52{ 'struct': 'ImageInfoSpecificQCow2EncryptionBase', 53 'data': { 'format': 'BlockdevQcow2EncryptionFormat'}} 54 55## 56# @ImageInfoSpecificQCow2Encryption: 57# 58# Since: 2.10 59## 60{ 'union': 'ImageInfoSpecificQCow2Encryption', 61 'base': 'ImageInfoSpecificQCow2EncryptionBase', 62 'discriminator': 'format', 63 'data': { 'luks': 'QCryptoBlockInfoLUKS' } } 64 65## 66# @ImageInfoSpecificQCow2: 67# 68# @compat: compatibility level 69# 70# @data-file: the filename of the external data file that is stored in 71# the image and used as a default for opening the image 72# (since: 4.0) 73# 74# @data-file-raw: True if the external data file must stay valid as a 75# standalone (read-only) raw image without looking at qcow2 76# metadata (since: 4.0) 77# 78# @extended-l2: true if the image has extended L2 entries; only valid 79# for compat >= 1.1 (since 5.2) 80# 81# @lazy-refcounts: on or off; only valid for compat >= 1.1 82# 83# @corrupt: true if the image has been marked corrupt; only valid for 84# compat >= 1.1 (since 2.2) 85# 86# @refcount-bits: width of a refcount entry in bits (since 2.3) 87# 88# @encrypt: details about encryption parameters; only set if image is 89# encrypted (since 2.10) 90# 91# @bitmaps: A list of qcow2 bitmap details (since 4.0) 92# 93# @compression-type: the image cluster compression method (since 5.1) 94# 95# Since: 1.7 96## 97{ 'struct': 'ImageInfoSpecificQCow2', 98 'data': { 99 'compat': 'str', 100 '*data-file': 'str', 101 '*data-file-raw': 'bool', 102 '*extended-l2': 'bool', 103 '*lazy-refcounts': 'bool', 104 '*corrupt': 'bool', 105 'refcount-bits': 'int', 106 '*encrypt': 'ImageInfoSpecificQCow2Encryption', 107 '*bitmaps': ['Qcow2BitmapInfo'], 108 'compression-type': 'Qcow2CompressionType' 109 } } 110 111## 112# @ImageInfoSpecificVmdk: 113# 114# @create-type: The create type of VMDK image 115# 116# @cid: Content id of image 117# 118# @parent-cid: Parent VMDK image's cid 119# 120# @extents: List of extent files 121# 122# Since: 1.7 123## 124{ 'struct': 'ImageInfoSpecificVmdk', 125 'data': { 126 'create-type': 'str', 127 'cid': 'int', 128 'parent-cid': 'int', 129 'extents': ['VmdkExtentInfo'] 130 } } 131 132## 133# @VmdkExtentInfo: 134# 135# Information about a VMDK extent file 136# 137# @filename: Name of the extent file 138# 139# @format: Extent type (e.g. FLAT or SPARSE) 140# 141# @virtual-size: Number of bytes covered by this extent 142# 143# @cluster-size: Cluster size in bytes (for non-flat extents) 144# 145# @compressed: Whether this extent contains compressed data 146# 147# Since: 8.0 148## 149{ 'struct': 'VmdkExtentInfo', 150 'data': { 151 'filename': 'str', 152 'format': 'str', 153 'virtual-size': 'int', 154 '*cluster-size': 'int', 155 '*compressed': 'bool' 156 } } 157 158## 159# @ImageInfoSpecificRbd: 160# 161# @encryption-format: Image encryption format 162# 163# Since: 6.1 164## 165{ 'struct': 'ImageInfoSpecificRbd', 166 'data': { 167 '*encryption-format': 'RbdImageEncryptionFormat' 168 } } 169 170## 171# @ImageInfoSpecificFile: 172# 173# @extent-size-hint: Extent size hint (if available) 174# 175# Since: 8.0 176## 177{ 'struct': 'ImageInfoSpecificFile', 178 'data': { 179 '*extent-size-hint': 'size' 180 } } 181 182## 183# @ImageInfoSpecificKind: 184# 185# @luks: Since 2.7 186# 187# @rbd: Since 6.1 188# 189# @file: Since 8.0 190# 191# Since: 1.7 192## 193{ 'enum': 'ImageInfoSpecificKind', 194 'data': [ 'qcow2', 'vmdk', 'luks', 'rbd', 'file' ] } 195 196## 197# @ImageInfoSpecificQCow2Wrapper: 198# 199# Since: 1.7 200## 201{ 'struct': 'ImageInfoSpecificQCow2Wrapper', 202 'data': { 'data': 'ImageInfoSpecificQCow2' } } 203 204## 205# @ImageInfoSpecificVmdkWrapper: 206# 207# Since: 6.1 208## 209{ 'struct': 'ImageInfoSpecificVmdkWrapper', 210 'data': { 'data': 'ImageInfoSpecificVmdk' } } 211 212## 213# @ImageInfoSpecificLUKSWrapper: 214# 215# Since: 2.7 216## 217{ 'struct': 'ImageInfoSpecificLUKSWrapper', 218 'data': { 'data': 'QCryptoBlockInfoLUKS' } } 219# If we need to add block driver specific parameters for 220# LUKS in future, then we'll subclass QCryptoBlockInfoLUKS 221# to define a ImageInfoSpecificLUKS 222 223## 224# @ImageInfoSpecificRbdWrapper: 225# 226# Since: 6.1 227## 228{ 'struct': 'ImageInfoSpecificRbdWrapper', 229 'data': { 'data': 'ImageInfoSpecificRbd' } } 230 231## 232# @ImageInfoSpecificFileWrapper: 233# 234# Since: 8.0 235## 236{ 'struct': 'ImageInfoSpecificFileWrapper', 237 'data': { 'data': 'ImageInfoSpecificFile' } } 238 239## 240# @ImageInfoSpecific: 241# 242# A discriminated record of image format specific information 243# structures. 244# 245# Since: 1.7 246## 247{ 'union': 'ImageInfoSpecific', 248 'base': { 'type': 'ImageInfoSpecificKind' }, 249 'discriminator': 'type', 250 'data': { 251 'qcow2': 'ImageInfoSpecificQCow2Wrapper', 252 'vmdk': 'ImageInfoSpecificVmdkWrapper', 253 'luks': 'ImageInfoSpecificLUKSWrapper', 254 'rbd': 'ImageInfoSpecificRbdWrapper', 255 'file': 'ImageInfoSpecificFileWrapper' 256 } } 257 258## 259# @BlockNodeInfo: 260# 261# Information about a QEMU image file 262# 263# @filename: name of the image file 264# 265# @format: format of the image file 266# 267# @virtual-size: maximum capacity in bytes of the image 268# 269# @actual-size: actual size on disk in bytes of the image 270# 271# @dirty-flag: true if image is not cleanly closed 272# 273# @cluster-size: size of a cluster in bytes 274# 275# @encrypted: true if the image is encrypted 276# 277# @compressed: true if the image is compressed (Since 1.7) 278# 279# @backing-filename: name of the backing file 280# 281# @full-backing-filename: full path of the backing file 282# 283# @backing-filename-format: the format of the backing file 284# 285# @snapshots: list of VM snapshots 286# 287# @format-specific: structure supplying additional format-specific 288# information (since 1.7) 289# 290# Since: 8.0 291## 292{ 'struct': 'BlockNodeInfo', 293 'data': {'filename': 'str', 'format': 'str', '*dirty-flag': 'bool', 294 '*actual-size': 'int', 'virtual-size': 'int', 295 '*cluster-size': 'int', '*encrypted': 'bool', '*compressed': 'bool', 296 '*backing-filename': 'str', '*full-backing-filename': 'str', 297 '*backing-filename-format': 'str', '*snapshots': ['SnapshotInfo'], 298 '*format-specific': 'ImageInfoSpecific' } } 299 300## 301# @ImageInfo: 302# 303# Information about a QEMU image file, and potentially its backing 304# image 305# 306# @backing-image: info of the backing image 307# 308# Since: 1.3 309## 310{ 'struct': 'ImageInfo', 311 'base': 'BlockNodeInfo', 312 'data': { 313 '*backing-image': 'ImageInfo' 314 } } 315 316## 317# @BlockChildInfo: 318# 319# Information about all nodes in the block graph starting at some 320# node, annotated with information about that node in relation to its 321# parent. 322# 323# @name: Child name of the root node in the BlockGraphInfo struct, in 324# its role as the child of some undescribed parent node 325# 326# @info: Block graph information starting at this node 327# 328# Since: 8.0 329## 330{ 'struct': 'BlockChildInfo', 331 'data': { 332 'name': 'str', 333 'info': 'BlockGraphInfo' 334 } } 335 336## 337# @BlockGraphInfo: 338# 339# Information about all nodes in a block (sub)graph in the form of 340# BlockNodeInfo data. The base BlockNodeInfo struct contains the 341# information for the (sub)graph's root node. 342# 343# @children: Array of links to this node's child nodes' information 344# 345# Since: 8.0 346## 347{ 'struct': 'BlockGraphInfo', 348 'base': 'BlockNodeInfo', 349 'data': { 'children': ['BlockChildInfo'] } } 350 351## 352# @ImageCheck: 353# 354# Information about a QEMU image file check 355# 356# @filename: name of the image file checked 357# 358# @format: format of the image file checked 359# 360# @check-errors: number of unexpected errors occurred during check 361# 362# @image-end-offset: offset (in bytes) where the image ends, this 363# field is present if the driver for the image format supports it 364# 365# @corruptions: number of corruptions found during the check if any 366# 367# @leaks: number of leaks found during the check if any 368# 369# @corruptions-fixed: number of corruptions fixed during the check if 370# any 371# 372# @leaks-fixed: number of leaks fixed during the check if any 373# 374# @total-clusters: total number of clusters, this field is present if 375# the driver for the image format supports it 376# 377# @allocated-clusters: total number of allocated clusters, this field 378# is present if the driver for the image format supports it 379# 380# @fragmented-clusters: total number of fragmented clusters, this 381# field is present if the driver for the image format supports it 382# 383# @compressed-clusters: total number of compressed clusters, this 384# field is present if the driver for the image format supports it 385# 386# Since: 1.4 387## 388{ 'struct': 'ImageCheck', 389 'data': {'filename': 'str', 'format': 'str', 'check-errors': 'int', 390 '*image-end-offset': 'int', '*corruptions': 'int', '*leaks': 'int', 391 '*corruptions-fixed': 'int', '*leaks-fixed': 'int', 392 '*total-clusters': 'int', '*allocated-clusters': 'int', 393 '*fragmented-clusters': 'int', '*compressed-clusters': 'int' } } 394 395## 396# @MapEntry: 397# 398# Mapping information from a virtual block range to a host file range 399# 400# @start: virtual (guest) offset of the first byte described by this 401# entry 402# 403# @length: the number of bytes of the mapped virtual range 404# 405# @data: reading the image will actually read data from a file (in 406# particular, if @offset is present this means that the sectors 407# are not simply preallocated, but contain actual data in raw 408# format) 409# 410# @zero: whether the virtual blocks read as zeroes 411# 412# @depth: number of layers (0 = top image, 1 = top image's backing 413# file, ..., n - 1 = bottom image (where n is the number of images 414# in the chain)) before reaching one for which the range is 415# allocated 416# 417# @present: true if this layer provides the data, false if adding a 418# backing layer could impact this region (since 6.1) 419# 420# @offset: if present, the image file stores the data for this range 421# in raw format at the given (host) offset 422# 423# @filename: filename that is referred to by @offset 424# 425# Since: 2.6 426## 427{ 'struct': 'MapEntry', 428 'data': {'start': 'int', 'length': 'int', 'data': 'bool', 429 'zero': 'bool', 'depth': 'int', 'present': 'bool', 430 '*offset': 'int', '*filename': 'str' } } 431 432## 433# @BlockdevCacheInfo: 434# 435# Cache mode information for a block device 436# 437# @writeback: true if writeback mode is enabled 438# 439# @direct: true if the host page cache is bypassed (O_DIRECT) 440# 441# @no-flush: true if flush requests are ignored for the device 442# 443# Since: 2.3 444## 445{ 'struct': 'BlockdevCacheInfo', 446 'data': { 'writeback': 'bool', 447 'direct': 'bool', 448 'no-flush': 'bool' } } 449 450## 451# @BlockDeviceInfo: 452# 453# Information about the backing device for a block device. 454# 455# @file: the filename of the backing device 456# 457# @node-name: the name of the block driver node (Since 2.0) 458# 459# @ro: true if the backing device was open read-only 460# 461# @drv: the name of the block format used to open the backing device. 462# As of 0.14 this can be: 'blkdebug', 'bochs', 'cloop', 'cow', 463# 'dmg', 'file', 'file', 'ftp', 'ftps', 'host_cdrom', 464# 'host_device', 'http', 'https', 'luks', 'nbd', 'parallels', 465# 'qcow', 'qcow2', 'raw', 'vdi', 'vmdk', 'vpc', 'vvfat' 2.2: 466# 'archipelago' added, 'cow' dropped 2.3: 'host_floppy' deprecated 467# 2.5: 'host_floppy' dropped 2.6: 'luks' added 2.8: 'replication' 468# added, 'tftp' dropped 2.9: 'archipelago' dropped 469# 470# @backing_file: the name of the backing file (for copy-on-write) 471# 472# @backing_file_depth: number of files in the backing file chain 473# (since: 1.2) 474# 475# @encrypted: true if the backing device is encrypted 476# 477# @detect_zeroes: detect and optimize zero writes (Since 2.1) 478# 479# @bps: total throughput limit in bytes per second is specified 480# 481# @bps_rd: read throughput limit in bytes per second is specified 482# 483# @bps_wr: write throughput limit in bytes per second is specified 484# 485# @iops: total I/O operations per second is specified 486# 487# @iops_rd: read I/O operations per second is specified 488# 489# @iops_wr: write I/O operations per second is specified 490# 491# @image: the info of image used (since: 1.6) 492# 493# @bps_max: total throughput limit during bursts, in bytes (Since 1.7) 494# 495# @bps_rd_max: read throughput limit during bursts, in bytes (Since 496# 1.7) 497# 498# @bps_wr_max: write throughput limit during bursts, in bytes (Since 499# 1.7) 500# 501# @iops_max: total I/O operations per second during bursts, in bytes 502# (Since 1.7) 503# 504# @iops_rd_max: read I/O operations per second during bursts, in bytes 505# (Since 1.7) 506# 507# @iops_wr_max: write I/O operations per second during bursts, in 508# bytes (Since 1.7) 509# 510# @bps_max_length: maximum length of the @bps_max burst period, in 511# seconds. (Since 2.6) 512# 513# @bps_rd_max_length: maximum length of the @bps_rd_max burst period, 514# in seconds. (Since 2.6) 515# 516# @bps_wr_max_length: maximum length of the @bps_wr_max burst period, 517# in seconds. (Since 2.6) 518# 519# @iops_max_length: maximum length of the @iops burst period, in 520# seconds. (Since 2.6) 521# 522# @iops_rd_max_length: maximum length of the @iops_rd_max burst 523# period, in seconds. (Since 2.6) 524# 525# @iops_wr_max_length: maximum length of the @iops_wr_max burst 526# period, in seconds. (Since 2.6) 527# 528# @iops_size: an I/O size in bytes (Since 1.7) 529# 530# @group: throttle group name (Since 2.4) 531# 532# @cache: the cache mode used for the block device (since: 2.3) 533# 534# @write_threshold: configured write threshold for the device. 0 if 535# disabled. (Since 2.3) 536# 537# @dirty-bitmaps: dirty bitmaps information (only present if node has 538# one or more dirty bitmaps) (Since 4.2) 539# 540# Since: 0.14 541## 542{ 'struct': 'BlockDeviceInfo', 543 'data': { 'file': 'str', '*node-name': 'str', 'ro': 'bool', 'drv': 'str', 544 '*backing_file': 'str', 'backing_file_depth': 'int', 545 'encrypted': 'bool', 546 'detect_zeroes': 'BlockdevDetectZeroesOptions', 547 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int', 548 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int', 549 'image': 'ImageInfo', 550 '*bps_max': 'int', '*bps_rd_max': 'int', 551 '*bps_wr_max': 'int', '*iops_max': 'int', 552 '*iops_rd_max': 'int', '*iops_wr_max': 'int', 553 '*bps_max_length': 'int', '*bps_rd_max_length': 'int', 554 '*bps_wr_max_length': 'int', '*iops_max_length': 'int', 555 '*iops_rd_max_length': 'int', '*iops_wr_max_length': 'int', 556 '*iops_size': 'int', '*group': 'str', 'cache': 'BlockdevCacheInfo', 557 'write_threshold': 'int', '*dirty-bitmaps': ['BlockDirtyInfo'] } } 558 559## 560# @BlockDeviceIoStatus: 561# 562# An enumeration of block device I/O status. 563# 564# @ok: The last I/O operation has succeeded 565# 566# @failed: The last I/O operation has failed 567# 568# @nospace: The last I/O operation has failed due to a no-space 569# condition 570# 571# Since: 1.0 572## 573{ 'enum': 'BlockDeviceIoStatus', 'data': [ 'ok', 'failed', 'nospace' ] } 574 575## 576# @BlockDirtyInfo: 577# 578# Block dirty bitmap information. 579# 580# @name: the name of the dirty bitmap (Since 2.4) 581# 582# @count: number of dirty bytes according to the dirty bitmap 583# 584# @granularity: granularity of the dirty bitmap in bytes (since 1.4) 585# 586# @recording: true if the bitmap is recording new writes from the 587# guest. (since 4.0) 588# 589# @busy: true if the bitmap is in-use by some operation (NBD or jobs) 590# and cannot be modified via QMP or used by another operation. 591# (since 4.0) 592# 593# @persistent: true if the bitmap was stored on disk, is scheduled to 594# be stored on disk, or both. (since 4.0) 595# 596# @inconsistent: true if this is a persistent bitmap that was 597# improperly stored. Implies @persistent to be true; @recording 598# and @busy to be false. This bitmap cannot be used. To remove 599# it, use @block-dirty-bitmap-remove. (Since 4.0) 600# 601# Since: 1.3 602## 603{ 'struct': 'BlockDirtyInfo', 604 'data': {'*name': 'str', 'count': 'int', 'granularity': 'uint32', 605 'recording': 'bool', 'busy': 'bool', 606 'persistent': 'bool', '*inconsistent': 'bool' } } 607 608## 609# @Qcow2BitmapInfoFlags: 610# 611# An enumeration of flags that a bitmap can report to the user. 612# 613# @in-use: This flag is set by any process actively modifying the 614# qcow2 file, and cleared when the updated bitmap is flushed to 615# the qcow2 image. The presence of this flag in an offline image 616# means that the bitmap was not saved correctly after its last 617# usage, and may contain inconsistent data. 618# 619# @auto: The bitmap must reflect all changes of the virtual disk by 620# any application that would write to this qcow2 file. 621# 622# Since: 4.0 623## 624{ 'enum': 'Qcow2BitmapInfoFlags', 625 'data': ['in-use', 'auto'] } 626 627## 628# @Qcow2BitmapInfo: 629# 630# Qcow2 bitmap information. 631# 632# @name: the name of the bitmap 633# 634# @granularity: granularity of the bitmap in bytes 635# 636# @flags: flags of the bitmap 637# 638# Since: 4.0 639## 640{ 'struct': 'Qcow2BitmapInfo', 641 'data': {'name': 'str', 'granularity': 'uint32', 642 'flags': ['Qcow2BitmapInfoFlags'] } } 643 644## 645# @BlockLatencyHistogramInfo: 646# 647# Block latency histogram. 648# 649# @boundaries: list of interval boundary values in nanoseconds, all 650# greater than zero and in ascending order. For example, the list 651# [10, 50, 100] produces the following histogram intervals: [0, 652# 10), [10, 50), [50, 100), [100, +inf). 653# 654# @bins: list of io request counts corresponding to histogram 655# intervals. 656# len(@bins) = len(@boundaries) + 1 657# For the example above, @bins may be something like [3, 1, 5, 2], 658# and corresponding histogram looks like: 659# 660# :: 661# 662# 5| * 663# 4| * 664# 3| * * 665# 2| * * * 666# 1| * * * * 667# +------------------ 668# 10 50 100 669# 670# Since: 4.0 671## 672{ 'struct': 'BlockLatencyHistogramInfo', 673 'data': {'boundaries': ['uint64'], 'bins': ['uint64'] } } 674 675## 676# @BlockInfo: 677# 678# Block device information. This structure describes a virtual device 679# and the backing device associated with it. 680# 681# @device: The device name associated with the virtual device. 682# 683# @qdev: The qdev ID, or if no ID is assigned, the QOM path of the 684# block device. (since 2.10) 685# 686# @type: This field is returned only for compatibility reasons, it 687# should not be used (always returns 'unknown') 688# 689# @removable: True if the device supports removable media. 690# 691# @locked: True if the guest has locked this device from having its 692# media removed 693# 694# @tray_open: True if the device's tray is open (only present if it 695# has a tray) 696# 697# @io-status: @BlockDeviceIoStatus. Only present if the device 698# supports it and the VM is configured to stop on errors 699# (supported device models: virtio-blk, IDE, SCSI except 700# scsi-generic) 701# 702# @inserted: @BlockDeviceInfo describing the device if media is 703# present 704# 705# Since: 0.14 706## 707{ 'struct': 'BlockInfo', 708 'data': {'device': 'str', '*qdev': 'str', 'type': 'str', 'removable': 'bool', 709 'locked': 'bool', '*inserted': 'BlockDeviceInfo', 710 '*tray_open': 'bool', '*io-status': 'BlockDeviceIoStatus' } } 711 712## 713# @BlockMeasureInfo: 714# 715# Image file size calculation information. This structure describes 716# the size requirements for creating a new image file. 717# 718# The size requirements depend on the new image file format. File 719# size always equals virtual disk size for the 'raw' format, even for 720# sparse POSIX files. Compact formats such as 'qcow2' represent 721# unallocated and zero regions efficiently so file size may be smaller 722# than virtual disk size. 723# 724# The values are upper bounds that are guaranteed to fit the new image 725# file. Subsequent modification, such as internal snapshot or further 726# bitmap creation, may require additional space and is not covered 727# here. 728# 729# @required: Size required for a new image file, in bytes, when 730# copying just allocated guest-visible contents. 731# 732# @fully-allocated: Image file size, in bytes, once data has been 733# written to all sectors, when copying just guest-visible 734# contents. 735# 736# @bitmaps: Additional size required if all the top-level bitmap 737# metadata in the source image were to be copied to the 738# destination, present only when source and destination both 739# support persistent bitmaps. (since 5.1) 740# 741# Since: 2.10 742## 743{ 'struct': 'BlockMeasureInfo', 744 'data': {'required': 'int', 'fully-allocated': 'int', '*bitmaps': 'int'} } 745 746## 747# @query-block: 748# 749# Get a list of BlockInfo for all virtual block devices. 750# 751# Returns: a list of @BlockInfo describing each virtual block device. 752# Filter nodes that were created implicitly are skipped over. 753# 754# Since: 0.14 755# 756# Example: 757# 758# -> { "execute": "query-block" } 759# <- { 760# "return":[ 761# { 762# "io-status": "ok", 763# "device":"ide0-hd0", 764# "locked":false, 765# "removable":false, 766# "inserted":{ 767# "ro":false, 768# "drv":"qcow2", 769# "encrypted":false, 770# "file":"disks/test.qcow2", 771# "backing_file_depth":1, 772# "bps":1000000, 773# "bps_rd":0, 774# "bps_wr":0, 775# "iops":1000000, 776# "iops_rd":0, 777# "iops_wr":0, 778# "bps_max": 8000000, 779# "bps_rd_max": 0, 780# "bps_wr_max": 0, 781# "iops_max": 0, 782# "iops_rd_max": 0, 783# "iops_wr_max": 0, 784# "iops_size": 0, 785# "detect_zeroes": "on", 786# "write_threshold": 0, 787# "image":{ 788# "filename":"disks/test.qcow2", 789# "format":"qcow2", 790# "virtual-size":2048000, 791# "backing_file":"base.qcow2", 792# "full-backing-filename":"disks/base.qcow2", 793# "backing-filename-format":"qcow2", 794# "snapshots":[ 795# { 796# "id": "1", 797# "name": "snapshot1", 798# "vm-state-size": 0, 799# "date-sec": 10000200, 800# "date-nsec": 12, 801# "vm-clock-sec": 206, 802# "vm-clock-nsec": 30 803# } 804# ], 805# "backing-image":{ 806# "filename":"disks/base.qcow2", 807# "format":"qcow2", 808# "virtual-size":2048000 809# } 810# } 811# }, 812# "qdev": "ide_disk", 813# "type":"unknown" 814# }, 815# { 816# "io-status": "ok", 817# "device":"ide1-cd0", 818# "locked":false, 819# "removable":true, 820# "qdev": "/machine/unattached/device[23]", 821# "tray_open": false, 822# "type":"unknown" 823# }, 824# { 825# "device":"floppy0", 826# "locked":false, 827# "removable":true, 828# "qdev": "/machine/unattached/device[20]", 829# "type":"unknown" 830# }, 831# { 832# "device":"sd0", 833# "locked":false, 834# "removable":true, 835# "type":"unknown" 836# } 837# ] 838# } 839## 840{ 'command': 'query-block', 'returns': ['BlockInfo'], 841 'allow-preconfig': true } 842 843## 844# @BlockDeviceTimedStats: 845# 846# Statistics of a block device during a given interval of time. 847# 848# @interval_length: Interval used for calculating the statistics, in 849# seconds. 850# 851# @min_rd_latency_ns: Minimum latency of read operations in the 852# defined interval, in nanoseconds. 853# 854# @min_wr_latency_ns: Minimum latency of write operations in the 855# defined interval, in nanoseconds. 856# 857# @min_zone_append_latency_ns: Minimum latency of zone append operations 858# in the defined interval, in nanoseconds 859# (since 8.1) 860# 861# @min_flush_latency_ns: Minimum latency of flush operations in the 862# defined interval, in nanoseconds. 863# 864# @max_rd_latency_ns: Maximum latency of read operations in the 865# defined interval, in nanoseconds. 866# 867# @max_wr_latency_ns: Maximum latency of write operations in the 868# defined interval, in nanoseconds. 869# 870# @max_zone_append_latency_ns: Maximum latency of zone append operations 871# in the defined interval, in nanoseconds 872# (since 8.1) 873# 874# @max_flush_latency_ns: Maximum latency of flush operations in the 875# defined interval, in nanoseconds. 876# 877# @avg_rd_latency_ns: Average latency of read operations in the 878# defined interval, in nanoseconds. 879# 880# @avg_wr_latency_ns: Average latency of write operations in the 881# defined interval, in nanoseconds. 882# 883# @avg_zone_append_latency_ns: Average latency of zone append operations 884# in the defined interval, in nanoseconds 885# (since 8.1) 886# 887# @avg_flush_latency_ns: Average latency of flush operations in the 888# defined interval, in nanoseconds. 889# 890# @avg_rd_queue_depth: Average number of pending read operations in 891# the defined interval. 892# 893# @avg_wr_queue_depth: Average number of pending write operations in 894# the defined interval. 895# 896# @avg_zone_append_queue_depth: Average number of pending zone append 897# operations in the defined interval 898# (since 8.1). 899# 900# Since: 2.5 901## 902{ 'struct': 'BlockDeviceTimedStats', 903 'data': { 'interval_length': 'int', 'min_rd_latency_ns': 'int', 904 'max_rd_latency_ns': 'int', 'avg_rd_latency_ns': 'int', 905 'min_wr_latency_ns': 'int', 'max_wr_latency_ns': 'int', 906 'avg_wr_latency_ns': 'int', 'min_zone_append_latency_ns': 'int', 907 'max_zone_append_latency_ns': 'int', 908 'avg_zone_append_latency_ns': 'int', 909 'min_flush_latency_ns': 'int', 'max_flush_latency_ns': 'int', 910 'avg_flush_latency_ns': 'int', 'avg_rd_queue_depth': 'number', 911 'avg_wr_queue_depth': 'number', 912 'avg_zone_append_queue_depth': 'number' } } 913 914## 915# @BlockDeviceStats: 916# 917# Statistics of a virtual block device or a block backing device. 918# 919# @rd_bytes: The number of bytes read by the device. 920# 921# @wr_bytes: The number of bytes written by the device. 922# 923# @zone_append_bytes: The number of bytes appended by the zoned devices 924# (since 8.1) 925# 926# @unmap_bytes: The number of bytes unmapped by the device (Since 4.2) 927# 928# @rd_operations: The number of read operations performed by the 929# device. 930# 931# @wr_operations: The number of write operations performed by the 932# device. 933# 934# @zone_append_operations: The number of zone append operations performed 935# by the zoned devices (since 8.1) 936# 937# @flush_operations: The number of cache flush operations performed by 938# the device (since 0.15) 939# 940# @unmap_operations: The number of unmap operations performed by the 941# device (Since 4.2) 942# 943# @rd_total_time_ns: Total time spent on reads in nanoseconds (since 944# 0.15). 945# 946# @wr_total_time_ns: Total time spent on writes in nanoseconds (since 947# 0.15). 948# 949# @zone_append_total_time_ns: Total time spent on zone append writes 950# in nanoseconds (since 8.1) 951# 952# @flush_total_time_ns: Total time spent on cache flushes in 953# nanoseconds (since 0.15). 954# 955# @unmap_total_time_ns: Total time spent on unmap operations in 956# nanoseconds (Since 4.2) 957# 958# @wr_highest_offset: The offset after the greatest byte written to 959# the device. The intended use of this information is for 960# growable sparse files (like qcow2) that are used on top of a 961# physical device. 962# 963# @rd_merged: Number of read requests that have been merged into 964# another request (Since 2.3). 965# 966# @wr_merged: Number of write requests that have been merged into 967# another request (Since 2.3). 968# 969# @zone_append_merged: Number of zone append requests that have been merged 970# into another request (since 8.1) 971# 972# @unmap_merged: Number of unmap requests that have been merged into 973# another request (Since 4.2) 974# 975# @idle_time_ns: Time since the last I/O operation, in nanoseconds. 976# If the field is absent it means that there haven't been any 977# operations yet (Since 2.5). 978# 979# @failed_rd_operations: The number of failed read operations 980# performed by the device (Since 2.5) 981# 982# @failed_wr_operations: The number of failed write operations 983# performed by the device (Since 2.5) 984# 985# @failed_zone_append_operations: The number of failed zone append write 986# operations performed by the zoned devices 987# (since 8.1) 988# 989# @failed_flush_operations: The number of failed flush operations 990# performed by the device (Since 2.5) 991# 992# @failed_unmap_operations: The number of failed unmap operations 993# performed by the device (Since 4.2) 994# 995# @invalid_rd_operations: The number of invalid read operations 996# performed by the device (Since 2.5) 997# 998# @invalid_wr_operations: The number of invalid write operations 999# performed by the device (Since 2.5) 1000# 1001# @invalid_zone_append_operations: The number of invalid zone append operations 1002# performed by the zoned device (since 8.1) 1003# 1004# @invalid_flush_operations: The number of invalid flush operations 1005# performed by the device (Since 2.5) 1006# 1007# @invalid_unmap_operations: The number of invalid unmap operations 1008# performed by the device (Since 4.2) 1009# 1010# @account_invalid: Whether invalid operations are included in the 1011# last access statistics (Since 2.5) 1012# 1013# @account_failed: Whether failed operations are included in the 1014# latency and last access statistics (Since 2.5) 1015# 1016# @timed_stats: Statistics specific to the set of previously defined 1017# intervals of time (Since 2.5) 1018# 1019# @rd_latency_histogram: @BlockLatencyHistogramInfo. (Since 4.0) 1020# 1021# @wr_latency_histogram: @BlockLatencyHistogramInfo. (Since 4.0) 1022# 1023# @zone_append_latency_histogram: @BlockLatencyHistogramInfo. (since 8.1) 1024# 1025# @flush_latency_histogram: @BlockLatencyHistogramInfo. (Since 4.0) 1026# 1027# Since: 0.14 1028## 1029{ 'struct': 'BlockDeviceStats', 1030 'data': {'rd_bytes': 'int', 'wr_bytes': 'int', 'zone_append_bytes': 'int', 1031 'unmap_bytes' : 'int', 'rd_operations': 'int', 1032 'wr_operations': 'int', 'zone_append_operations': 'int', 1033 'flush_operations': 'int', 'unmap_operations': 'int', 1034 'rd_total_time_ns': 'int', 'wr_total_time_ns': 'int', 1035 'zone_append_total_time_ns': 'int', 'flush_total_time_ns': 'int', 1036 'unmap_total_time_ns': 'int', 'wr_highest_offset': 'int', 1037 'rd_merged': 'int', 'wr_merged': 'int', 'zone_append_merged': 'int', 1038 'unmap_merged': 'int', '*idle_time_ns': 'int', 1039 'failed_rd_operations': 'int', 'failed_wr_operations': 'int', 1040 'failed_zone_append_operations': 'int', 1041 'failed_flush_operations': 'int', 1042 'failed_unmap_operations': 'int', 'invalid_rd_operations': 'int', 1043 'invalid_wr_operations': 'int', 1044 'invalid_zone_append_operations': 'int', 1045 'invalid_flush_operations': 'int', 'invalid_unmap_operations': 'int', 1046 'account_invalid': 'bool', 'account_failed': 'bool', 1047 'timed_stats': ['BlockDeviceTimedStats'], 1048 '*rd_latency_histogram': 'BlockLatencyHistogramInfo', 1049 '*wr_latency_histogram': 'BlockLatencyHistogramInfo', 1050 '*zone_append_latency_histogram': 'BlockLatencyHistogramInfo', 1051 '*flush_latency_histogram': 'BlockLatencyHistogramInfo' } } 1052 1053## 1054# @BlockStatsSpecificFile: 1055# 1056# File driver statistics 1057# 1058# @discard-nb-ok: The number of successful discard operations 1059# performed by the driver. 1060# 1061# @discard-nb-failed: The number of failed discard operations 1062# performed by the driver. 1063# 1064# @discard-bytes-ok: The number of bytes discarded by the driver. 1065# 1066# Since: 4.2 1067## 1068{ 'struct': 'BlockStatsSpecificFile', 1069 'data': { 1070 'discard-nb-ok': 'uint64', 1071 'discard-nb-failed': 'uint64', 1072 'discard-bytes-ok': 'uint64' } } 1073 1074## 1075# @BlockStatsSpecificNvme: 1076# 1077# NVMe driver statistics 1078# 1079# @completion-errors: The number of completion errors. 1080# 1081# @aligned-accesses: The number of aligned accesses performed by the 1082# driver. 1083# 1084# @unaligned-accesses: The number of unaligned accesses performed by 1085# the driver. 1086# 1087# Since: 5.2 1088## 1089{ 'struct': 'BlockStatsSpecificNvme', 1090 'data': { 1091 'completion-errors': 'uint64', 1092 'aligned-accesses': 'uint64', 1093 'unaligned-accesses': 'uint64' } } 1094 1095## 1096# @BlockStatsSpecific: 1097# 1098# Block driver specific statistics 1099# 1100# Since: 4.2 1101## 1102{ 'union': 'BlockStatsSpecific', 1103 'base': { 'driver': 'BlockdevDriver' }, 1104 'discriminator': 'driver', 1105 'data': { 1106 'file': 'BlockStatsSpecificFile', 1107 'host_device': { 'type': 'BlockStatsSpecificFile', 1108 'if': 'HAVE_HOST_BLOCK_DEVICE' }, 1109 'nvme': 'BlockStatsSpecificNvme' } } 1110 1111## 1112# @BlockStats: 1113# 1114# Statistics of a virtual block device or a block backing device. 1115# 1116# @device: If the stats are for a virtual block device, the name 1117# corresponding to the virtual block device. 1118# 1119# @node-name: The node name of the device. (Since 2.3) 1120# 1121# @qdev: The qdev ID, or if no ID is assigned, the QOM path of the 1122# block device. (since 3.0) 1123# 1124# @stats: A @BlockDeviceStats for the device. 1125# 1126# @driver-specific: Optional driver-specific stats. (Since 4.2) 1127# 1128# @parent: This describes the file block device if it has one. 1129# Contains recursively the statistics of the underlying protocol 1130# (e.g. the host file for a qcow2 image). If there is no 1131# underlying protocol, this field is omitted 1132# 1133# @backing: This describes the backing block device if it has one. 1134# (Since 2.0) 1135# 1136# Since: 0.14 1137## 1138{ 'struct': 'BlockStats', 1139 'data': {'*device': 'str', '*qdev': 'str', '*node-name': 'str', 1140 'stats': 'BlockDeviceStats', 1141 '*driver-specific': 'BlockStatsSpecific', 1142 '*parent': 'BlockStats', 1143 '*backing': 'BlockStats'} } 1144 1145## 1146# @query-blockstats: 1147# 1148# Query the @BlockStats for all virtual block devices. 1149# 1150# @query-nodes: If true, the command will query all the block nodes 1151# that have a node name, in a list which will include "parent" 1152# information, but not "backing". If false or omitted, the 1153# behavior is as before - query all the device backends, 1154# recursively including their "parent" and "backing". Filter nodes 1155# that were created implicitly are skipped over in this mode. 1156# (Since 2.3) 1157# 1158# Returns: A list of @BlockStats for each virtual block devices. 1159# 1160# Since: 0.14 1161# 1162# Example: 1163# 1164# -> { "execute": "query-blockstats" } 1165# <- { 1166# "return":[ 1167# { 1168# "device":"ide0-hd0", 1169# "parent":{ 1170# "stats":{ 1171# "wr_highest_offset":3686448128, 1172# "wr_bytes":9786368, 1173# "wr_operations":751, 1174# "rd_bytes":122567168, 1175# "rd_operations":36772 1176# "wr_total_times_ns":313253456 1177# "rd_total_times_ns":3465673657 1178# "flush_total_times_ns":49653 1179# "flush_operations":61, 1180# "rd_merged":0, 1181# "wr_merged":0, 1182# "idle_time_ns":2953431879, 1183# "account_invalid":true, 1184# "account_failed":false 1185# } 1186# }, 1187# "stats":{ 1188# "wr_highest_offset":2821110784, 1189# "wr_bytes":9786368, 1190# "wr_operations":692, 1191# "rd_bytes":122739200, 1192# "rd_operations":36604 1193# "flush_operations":51, 1194# "wr_total_times_ns":313253456 1195# "rd_total_times_ns":3465673657 1196# "flush_total_times_ns":49653, 1197# "rd_merged":0, 1198# "wr_merged":0, 1199# "idle_time_ns":2953431879, 1200# "account_invalid":true, 1201# "account_failed":false 1202# }, 1203# "qdev": "/machine/unattached/device[23]" 1204# }, 1205# { 1206# "device":"ide1-cd0", 1207# "stats":{ 1208# "wr_highest_offset":0, 1209# "wr_bytes":0, 1210# "wr_operations":0, 1211# "rd_bytes":0, 1212# "rd_operations":0 1213# "flush_operations":0, 1214# "wr_total_times_ns":0 1215# "rd_total_times_ns":0 1216# "flush_total_times_ns":0, 1217# "rd_merged":0, 1218# "wr_merged":0, 1219# "account_invalid":false, 1220# "account_failed":false 1221# }, 1222# "qdev": "/machine/unattached/device[24]" 1223# }, 1224# { 1225# "device":"floppy0", 1226# "stats":{ 1227# "wr_highest_offset":0, 1228# "wr_bytes":0, 1229# "wr_operations":0, 1230# "rd_bytes":0, 1231# "rd_operations":0 1232# "flush_operations":0, 1233# "wr_total_times_ns":0 1234# "rd_total_times_ns":0 1235# "flush_total_times_ns":0, 1236# "rd_merged":0, 1237# "wr_merged":0, 1238# "account_invalid":false, 1239# "account_failed":false 1240# }, 1241# "qdev": "/machine/unattached/device[16]" 1242# }, 1243# { 1244# "device":"sd0", 1245# "stats":{ 1246# "wr_highest_offset":0, 1247# "wr_bytes":0, 1248# "wr_operations":0, 1249# "rd_bytes":0, 1250# "rd_operations":0 1251# "flush_operations":0, 1252# "wr_total_times_ns":0 1253# "rd_total_times_ns":0 1254# "flush_total_times_ns":0, 1255# "rd_merged":0, 1256# "wr_merged":0, 1257# "account_invalid":false, 1258# "account_failed":false 1259# } 1260# } 1261# ] 1262# } 1263## 1264{ 'command': 'query-blockstats', 1265 'data': { '*query-nodes': 'bool' }, 1266 'returns': ['BlockStats'], 1267 'allow-preconfig': true } 1268 1269## 1270# @BlockdevOnError: 1271# 1272# An enumeration of possible behaviors for errors on I/O operations. 1273# The exact meaning depends on whether the I/O was initiated by a 1274# guest or by a block job 1275# 1276# @report: for guest operations, report the error to the guest; for 1277# jobs, cancel the job 1278# 1279# @ignore: ignore the error, only report a QMP event (BLOCK_IO_ERROR 1280# or BLOCK_JOB_ERROR). The backup, mirror and commit block jobs 1281# retry the failing request later and may still complete 1282# successfully. The stream block job continues to stream and will 1283# complete with an error. 1284# 1285# @enospc: same as @stop on ENOSPC, same as @report otherwise. 1286# 1287# @stop: for guest operations, stop the virtual machine; for jobs, 1288# pause the job 1289# 1290# @auto: inherit the error handling policy of the backend (since: 2.7) 1291# 1292# Since: 1.3 1293## 1294{ 'enum': 'BlockdevOnError', 1295 'data': ['report', 'ignore', 'enospc', 'stop', 'auto'] } 1296 1297## 1298# @MirrorSyncMode: 1299# 1300# An enumeration of possible behaviors for the initial synchronization 1301# phase of storage mirroring. 1302# 1303# @top: copies data in the topmost image to the destination 1304# 1305# @full: copies data from all images to the destination 1306# 1307# @none: only copy data written from now on 1308# 1309# @incremental: only copy data described by the dirty bitmap. 1310# (since: 2.4) 1311# 1312# @bitmap: only copy data described by the dirty bitmap. (since: 4.2) 1313# Behavior on completion is determined by the BitmapSyncMode. 1314# 1315# Since: 1.3 1316## 1317{ 'enum': 'MirrorSyncMode', 1318 'data': ['top', 'full', 'none', 'incremental', 'bitmap'] } 1319 1320## 1321# @BitmapSyncMode: 1322# 1323# An enumeration of possible behaviors for the synchronization of a 1324# bitmap when used for data copy operations. 1325# 1326# @on-success: The bitmap is only synced when the operation is 1327# successful. This is the behavior always used for 'INCREMENTAL' 1328# backups. 1329# 1330# @never: The bitmap is never synchronized with the operation, and is 1331# treated solely as a read-only manifest of blocks to copy. 1332# 1333# @always: The bitmap is always synchronized with the operation, 1334# regardless of whether or not the operation was successful. 1335# 1336# Since: 4.2 1337## 1338{ 'enum': 'BitmapSyncMode', 1339 'data': ['on-success', 'never', 'always'] } 1340 1341## 1342# @MirrorCopyMode: 1343# 1344# An enumeration whose values tell the mirror block job when to 1345# trigger writes to the target. 1346# 1347# @background: copy data in background only. 1348# 1349# @write-blocking: when data is written to the source, write it 1350# (synchronously) to the target as well. In addition, data is 1351# copied in background just like in @background mode. 1352# 1353# Since: 3.0 1354## 1355{ 'enum': 'MirrorCopyMode', 1356 'data': ['background', 'write-blocking'] } 1357 1358## 1359# @BlockJobInfo: 1360# 1361# Information about a long-running block device operation. 1362# 1363# @type: the job type ('stream' for image streaming) 1364# 1365# @device: The job identifier. Originally the device name but other 1366# values are allowed since QEMU 2.7 1367# 1368# @len: Estimated @offset value at the completion of the job. This 1369# value can arbitrarily change while the job is running, in both 1370# directions. 1371# 1372# @offset: Progress made until now. The unit is arbitrary and the 1373# value can only meaningfully be used for the ratio of @offset to 1374# @len. The value is monotonically increasing. 1375# 1376# @busy: false if the job is known to be in a quiescent state, with no 1377# pending I/O. (Since 1.3) 1378# 1379# @paused: whether the job is paused or, if @busy is true, will pause 1380# itself as soon as possible. (Since 1.3) 1381# 1382# @speed: the rate limit, bytes per second 1383# 1384# @io-status: the status of the job (since 1.3) 1385# 1386# @ready: true if the job may be completed (since 2.2) 1387# 1388# @status: Current job state/status (since 2.12) 1389# 1390# @auto-finalize: Job will finalize itself when PENDING, moving to the 1391# CONCLUDED state. (since 2.12) 1392# 1393# @auto-dismiss: Job will dismiss itself when CONCLUDED, moving to the 1394# NULL state and disappearing from the query list. (since 2.12) 1395# 1396# @error: Error information if the job did not complete successfully. 1397# Not set if the job completed successfully. (since 2.12.1) 1398# 1399# Since: 1.1 1400## 1401{ 'struct': 'BlockJobInfo', 1402 'data': {'type': 'str', 'device': 'str', 'len': 'int', 1403 'offset': 'int', 'busy': 'bool', 'paused': 'bool', 'speed': 'int', 1404 'io-status': 'BlockDeviceIoStatus', 'ready': 'bool', 1405 'status': 'JobStatus', 1406 'auto-finalize': 'bool', 'auto-dismiss': 'bool', 1407 '*error': 'str' } } 1408 1409## 1410# @query-block-jobs: 1411# 1412# Return information about long-running block device operations. 1413# 1414# Returns: a list of @BlockJobInfo for each active block job 1415# 1416# Since: 1.1 1417## 1418{ 'command': 'query-block-jobs', 'returns': ['BlockJobInfo'], 1419 'allow-preconfig': true } 1420 1421## 1422# @block_resize: 1423# 1424# Resize a block image while a guest is running. 1425# 1426# Either @device or @node-name must be set but not both. 1427# 1428# @device: the name of the device to get the image resized 1429# 1430# @node-name: graph node name to get the image resized (Since 2.0) 1431# 1432# @size: new image size in bytes 1433# 1434# Returns: 1435# - nothing on success 1436# - If @device is not a valid block device, DeviceNotFound 1437# 1438# Since: 0.14 1439# 1440# Example: 1441# 1442# -> { "execute": "block_resize", 1443# "arguments": { "device": "scratch", "size": 1073741824 } } 1444# <- { "return": {} } 1445## 1446{ 'command': 'block_resize', 1447 'data': { '*device': 'str', 1448 '*node-name': 'str', 1449 'size': 'int' }, 1450 'coroutine': true, 1451 'allow-preconfig': true } 1452 1453## 1454# @NewImageMode: 1455# 1456# An enumeration that tells QEMU how to set the backing file path in a 1457# new image file. 1458# 1459# @existing: QEMU should look for an existing image file. 1460# 1461# @absolute-paths: QEMU should create a new image with absolute paths 1462# for the backing file. If there is no backing file available, 1463# the new image will not be backed either. 1464# 1465# Since: 1.1 1466## 1467{ 'enum': 'NewImageMode', 1468 'data': [ 'existing', 'absolute-paths' ] } 1469 1470## 1471# @BlockdevSnapshotSync: 1472# 1473# Either @device or @node-name must be set but not both. 1474# 1475# @device: the name of the device to take a snapshot of. 1476# 1477# @node-name: graph node name to generate the snapshot from (Since 1478# 2.0) 1479# 1480# @snapshot-file: the target of the new overlay image. If the file 1481# exists, or if it is a device, the overlay will be created in the 1482# existing file/device. Otherwise, a new file will be created. 1483# 1484# @snapshot-node-name: the graph node name of the new image (Since 1485# 2.0) 1486# 1487# @format: the format of the overlay image, default is 'qcow2'. 1488# 1489# @mode: whether and how QEMU should create a new image, default is 1490# 'absolute-paths'. 1491## 1492{ 'struct': 'BlockdevSnapshotSync', 1493 'data': { '*device': 'str', '*node-name': 'str', 1494 'snapshot-file': 'str', '*snapshot-node-name': 'str', 1495 '*format': 'str', '*mode': 'NewImageMode' } } 1496 1497## 1498# @BlockdevSnapshot: 1499# 1500# @node: device or node name that will have a snapshot taken. 1501# 1502# @overlay: reference to the existing block device that will become 1503# the overlay of @node, as part of taking the snapshot. It must 1504# not have a current backing file (this can be achieved by passing 1505# "backing": null to blockdev-add). 1506# 1507# Since: 2.5 1508## 1509{ 'struct': 'BlockdevSnapshot', 1510 'data': { 'node': 'str', 'overlay': 'str' } } 1511 1512## 1513# @BackupPerf: 1514# 1515# Optional parameters for backup. These parameters don't affect 1516# functionality, but may significantly affect performance. 1517# 1518# @use-copy-range: Use copy offloading. Default false. 1519# 1520# @max-workers: Maximum number of parallel requests for the sustained 1521# background copying process. Doesn't influence copy-before-write 1522# operations. Default 64. 1523# 1524# @max-chunk: Maximum request length for the sustained background 1525# copying process. Doesn't influence copy-before-write 1526# operations. 0 means unlimited. If max-chunk is non-zero then 1527# it should not be less than job cluster size which is calculated 1528# as maximum of target image cluster size and 64k. Default 0. 1529# 1530# Since: 6.0 1531## 1532{ 'struct': 'BackupPerf', 1533 'data': { '*use-copy-range': 'bool', 1534 '*max-workers': 'int', '*max-chunk': 'int64' } } 1535 1536## 1537# @BackupCommon: 1538# 1539# @job-id: identifier for the newly-created block job. If omitted, 1540# the device name will be used. (Since 2.7) 1541# 1542# @device: the device name or node-name of a root node which should be 1543# copied. 1544# 1545# @sync: what parts of the disk image should be copied to the 1546# destination (all the disk, only the sectors allocated in the 1547# topmost image, from a dirty bitmap, or only new I/O). 1548# 1549# @speed: the maximum speed, in bytes per second. The default is 0, 1550# for unlimited. 1551# 1552# @bitmap: The name of a dirty bitmap to use. Must be present if sync 1553# is "bitmap" or "incremental". Can be present if sync is "full" 1554# or "top". Must not be present otherwise. 1555# (Since 2.4 (drive-backup), 3.1 (blockdev-backup)) 1556# 1557# @bitmap-mode: Specifies the type of data the bitmap should contain 1558# after the operation concludes. Must be present if a bitmap was 1559# provided, Must NOT be present otherwise. (Since 4.2) 1560# 1561# @compress: true to compress data, if the target format supports it. 1562# (default: false) (since 2.8) 1563# 1564# @on-source-error: the action to take on an error on the source, 1565# default 'report'. 'stop' and 'enospc' can only be used if the 1566# block device supports io-status (see BlockInfo). 1567# 1568# @on-target-error: the action to take on an error on the target, 1569# default 'report' (no limitations, since this applies to a 1570# different block device than @device). 1571# 1572# @auto-finalize: When false, this job will wait in a PENDING state 1573# after it has finished its work, waiting for @block-job-finalize 1574# before making any block graph changes. When true, this job will 1575# automatically perform its abort or commit actions. Defaults to 1576# true. (Since 2.12) 1577# 1578# @auto-dismiss: When false, this job will wait in a CONCLUDED state 1579# after it has completely ceased all work, and awaits 1580# @block-job-dismiss. When true, this job will automatically 1581# disappear from the query list without user intervention. 1582# Defaults to true. (Since 2.12) 1583# 1584# @filter-node-name: the node name that should be assigned to the 1585# filter driver that the backup job inserts into the graph above 1586# node specified by @drive. If this option is not given, a node 1587# name is autogenerated. (Since: 4.2) 1588# 1589# @x-perf: Performance options. (Since 6.0) 1590# 1591# Features: 1592# 1593# @unstable: Member @x-perf is experimental. 1594# 1595# Note: @on-source-error and @on-target-error only affect background 1596# I/O. If an error occurs during a guest write request, the 1597# device's rerror/werror actions will be used. 1598# 1599# Since: 4.2 1600## 1601{ 'struct': 'BackupCommon', 1602 'data': { '*job-id': 'str', 'device': 'str', 1603 'sync': 'MirrorSyncMode', '*speed': 'int', 1604 '*bitmap': 'str', '*bitmap-mode': 'BitmapSyncMode', 1605 '*compress': 'bool', 1606 '*on-source-error': 'BlockdevOnError', 1607 '*on-target-error': 'BlockdevOnError', 1608 '*auto-finalize': 'bool', '*auto-dismiss': 'bool', 1609 '*filter-node-name': 'str', 1610 '*x-perf': { 'type': 'BackupPerf', 1611 'features': [ 'unstable' ] } } } 1612 1613## 1614# @DriveBackup: 1615# 1616# @target: the target of the new image. If the file exists, or if it 1617# is a device, the existing file/device will be used as the new 1618# destination. If it does not exist, a new file will be created. 1619# 1620# @format: the format of the new destination, default is to probe if 1621# @mode is 'existing', else the format of the source 1622# 1623# @mode: whether and how QEMU should create a new image, default is 1624# 'absolute-paths'. 1625# 1626# Since: 1.6 1627## 1628{ 'struct': 'DriveBackup', 1629 'base': 'BackupCommon', 1630 'data': { 'target': 'str', 1631 '*format': 'str', 1632 '*mode': 'NewImageMode' } } 1633 1634## 1635# @BlockdevBackup: 1636# 1637# @target: the device name or node-name of the backup target node. 1638# 1639# Since: 2.3 1640## 1641{ 'struct': 'BlockdevBackup', 1642 'base': 'BackupCommon', 1643 'data': { 'target': 'str' } } 1644 1645## 1646# @blockdev-snapshot-sync: 1647# 1648# Takes a synchronous snapshot of a block device. 1649# 1650# For the arguments, see the documentation of BlockdevSnapshotSync. 1651# 1652# Returns: 1653# - nothing on success 1654# - If @device is not a valid block device, DeviceNotFound 1655# 1656# Since: 0.14 1657# 1658# Example: 1659# 1660# -> { "execute": "blockdev-snapshot-sync", 1661# "arguments": { "device": "ide-hd0", 1662# "snapshot-file": 1663# "/some/place/my-image", 1664# "format": "qcow2" } } 1665# <- { "return": {} } 1666## 1667{ 'command': 'blockdev-snapshot-sync', 1668 'data': 'BlockdevSnapshotSync', 1669 'allow-preconfig': true } 1670 1671## 1672# @blockdev-snapshot: 1673# 1674# Takes a snapshot of a block device. 1675# 1676# Take a snapshot, by installing 'node' as the backing image of 1677# 'overlay'. Additionally, if 'node' is associated with a block 1678# device, the block device changes to using 'overlay' as its new 1679# active image. 1680# 1681# For the arguments, see the documentation of BlockdevSnapshot. 1682# 1683# Features: 1684# 1685# @allow-write-only-overlay: If present, the check whether this 1686# operation is safe was relaxed so that it can be used to change 1687# backing file of a destination of a blockdev-mirror. (since 5.0) 1688# 1689# Since: 2.5 1690# 1691# Example: 1692# 1693# -> { "execute": "blockdev-add", 1694# "arguments": { "driver": "qcow2", 1695# "node-name": "node1534", 1696# "file": { "driver": "file", 1697# "filename": "hd1.qcow2" }, 1698# "backing": null } } 1699# 1700# <- { "return": {} } 1701# 1702# -> { "execute": "blockdev-snapshot", 1703# "arguments": { "node": "ide-hd0", 1704# "overlay": "node1534" } } 1705# <- { "return": {} } 1706## 1707{ 'command': 'blockdev-snapshot', 1708 'data': 'BlockdevSnapshot', 1709 'features': [ 'allow-write-only-overlay' ], 1710 'allow-preconfig': true } 1711 1712## 1713# @change-backing-file: 1714# 1715# Change the backing file in the image file metadata. This does not 1716# cause QEMU to reopen the image file to reparse the backing filename 1717# (it may, however, perform a reopen to change permissions from r/o -> 1718# r/w -> r/o, if needed). The new backing file string is written into 1719# the image file metadata, and the QEMU internal strings are updated. 1720# 1721# @image-node-name: The name of the block driver state node of the 1722# image to modify. The "device" argument is used to verify 1723# "image-node-name" is in the chain described by "device". 1724# 1725# @device: The device name or node-name of the root node that owns 1726# image-node-name. 1727# 1728# @backing-file: The string to write as the backing file. This string 1729# is not validated, so care should be taken when specifying the 1730# string or the image chain may not be able to be reopened again. 1731# 1732# Returns: 1733# - Nothing on success 1734# - If "device" does not exist or cannot be determined, 1735# DeviceNotFound 1736# 1737# Since: 2.1 1738## 1739{ 'command': 'change-backing-file', 1740 'data': { 'device': 'str', 'image-node-name': 'str', 1741 'backing-file': 'str' }, 1742 'allow-preconfig': true } 1743 1744## 1745# @block-commit: 1746# 1747# Live commit of data from overlay image nodes into backing nodes - 1748# i.e., writes data between 'top' and 'base' into 'base'. 1749# 1750# If top == base, that is an error. If top has no overlays on top of 1751# it, or if it is in use by a writer, the job will not be completed by 1752# itself. The user needs to complete the job with the 1753# block-job-complete command after getting the ready event. (Since 1754# 2.0) 1755# 1756# If the base image is smaller than top, then the base image will be 1757# resized to be the same size as top. If top is smaller than the base 1758# image, the base will not be truncated. If you want the base image 1759# size to match the size of the smaller top, you can safely truncate 1760# it yourself once the commit operation successfully completes. 1761# 1762# @job-id: identifier for the newly-created block job. If omitted, 1763# the device name will be used. (Since 2.7) 1764# 1765# @device: the device name or node-name of a root node 1766# 1767# @base-node: The node name of the backing image to write data into. 1768# If not specified, this is the deepest backing image. 1769# (since: 3.1) 1770# 1771# @base: Same as @base-node, except that it is a file name rather than 1772# a node name. This must be the exact filename string that was 1773# used to open the node; other strings, even if addressing the 1774# same file, are not accepted 1775# 1776# @top-node: The node name of the backing image within the image chain 1777# which contains the topmost data to be committed down. If not 1778# specified, this is the active layer. (since: 3.1) 1779# 1780# @top: Same as @top-node, except that it is a file name rather than a 1781# node name. This must be the exact filename string that was used 1782# to open the node; other strings, even if addressing the same 1783# file, are not accepted 1784# 1785# @backing-file: The backing file string to write into the overlay 1786# image of 'top'. If 'top' does not have an overlay image, or if 1787# 'top' is in use by a writer, specifying a backing file string is 1788# an error. 1789# 1790# This filename is not validated. If a pathname string is such 1791# that it cannot be resolved by QEMU, that means that subsequent 1792# QMP or HMP commands must use node-names for the image in 1793# question, as filename lookup methods will fail. 1794# 1795# If not specified, QEMU will automatically determine the backing 1796# file string to use, or error out if there is no obvious choice. 1797# Care should be taken when specifying the string, to specify a 1798# valid filename or protocol. (Since 2.1) 1799# 1800# @speed: the maximum speed, in bytes per second 1801# 1802# @on-error: the action to take on an error. 'ignore' means that the 1803# request should be retried. (default: report; Since: 5.0) 1804# 1805# @filter-node-name: the node name that should be assigned to the 1806# filter driver that the commit job inserts into the graph above 1807# @top. If this option is not given, a node name is 1808# autogenerated. (Since: 2.9) 1809# 1810# @auto-finalize: When false, this job will wait in a PENDING state 1811# after it has finished its work, waiting for @block-job-finalize 1812# before making any block graph changes. When true, this job will 1813# automatically perform its abort or commit actions. Defaults to 1814# true. (Since 3.1) 1815# 1816# @auto-dismiss: When false, this job will wait in a CONCLUDED state 1817# after it has completely ceased all work, and awaits 1818# @block-job-dismiss. When true, this job will automatically 1819# disappear from the query list without user intervention. 1820# Defaults to true. (Since 3.1) 1821# 1822# Features: 1823# 1824# @deprecated: Members @base and @top are deprecated. Use @base-node 1825# and @top-node instead. 1826# 1827# Returns: 1828# - Nothing on success 1829# - If @device does not exist, DeviceNotFound 1830# - Any other error returns a GenericError. 1831# 1832# Since: 1.3 1833# 1834# Example: 1835# 1836# -> { "execute": "block-commit", 1837# "arguments": { "device": "virtio0", 1838# "top": "/tmp/snap1.qcow2" } } 1839# <- { "return": {} } 1840## 1841{ 'command': 'block-commit', 1842 'data': { '*job-id': 'str', 'device': 'str', '*base-node': 'str', 1843 '*base': { 'type': 'str', 'features': [ 'deprecated' ] }, 1844 '*top-node': 'str', 1845 '*top': { 'type': 'str', 'features': [ 'deprecated' ] }, 1846 '*backing-file': 'str', '*speed': 'int', 1847 '*on-error': 'BlockdevOnError', 1848 '*filter-node-name': 'str', 1849 '*auto-finalize': 'bool', '*auto-dismiss': 'bool' }, 1850 'allow-preconfig': true } 1851 1852## 1853# @drive-backup: 1854# 1855# Start a point-in-time copy of a block device to a new destination. 1856# The status of ongoing drive-backup operations can be checked with 1857# query-block-jobs where the BlockJobInfo.type field has the value 1858# 'backup'. The operation can be stopped before it has completed using 1859# the block-job-cancel command. 1860# 1861# Features: 1862# 1863# @deprecated: This command is deprecated. Use @blockdev-backup 1864# instead. 1865# 1866# Returns: 1867# - nothing on success 1868# - If @device is not a valid block device, GenericError 1869# 1870# Since: 1.6 1871# 1872# Example: 1873# 1874# -> { "execute": "drive-backup", 1875# "arguments": { "device": "drive0", 1876# "sync": "full", 1877# "target": "backup.img" } } 1878# <- { "return": {} } 1879## 1880{ 'command': 'drive-backup', 'boxed': true, 1881 'data': 'DriveBackup', 'features': ['deprecated'], 1882 'allow-preconfig': true } 1883 1884## 1885# @blockdev-backup: 1886# 1887# Start a point-in-time copy of a block device to a new destination. 1888# The status of ongoing blockdev-backup operations can be checked with 1889# query-block-jobs where the BlockJobInfo.type field has the value 1890# 'backup'. The operation can be stopped before it has completed using 1891# the block-job-cancel command. 1892# 1893# Returns: 1894# - nothing on success 1895# - If @device is not a valid block device, DeviceNotFound 1896# 1897# Since: 2.3 1898# 1899# Example: 1900# 1901# -> { "execute": "blockdev-backup", 1902# "arguments": { "device": "src-id", 1903# "sync": "full", 1904# "target": "tgt-id" } } 1905# <- { "return": {} } 1906## 1907{ 'command': 'blockdev-backup', 'boxed': true, 1908 'data': 'BlockdevBackup', 1909 'allow-preconfig': true } 1910 1911## 1912# @query-named-block-nodes: 1913# 1914# Get the named block driver list 1915# 1916# @flat: Omit the nested data about backing image ("backing-image" 1917# key) if true. Default is false (Since 5.0) 1918# 1919# Returns: the list of BlockDeviceInfo 1920# 1921# Since: 2.0 1922# 1923# Example: 1924# 1925# -> { "execute": "query-named-block-nodes" } 1926# <- { "return": [ { "ro":false, 1927# "drv":"qcow2", 1928# "encrypted":false, 1929# "file":"disks/test.qcow2", 1930# "node-name": "my-node", 1931# "backing_file_depth":1, 1932# "detect_zeroes":"off", 1933# "bps":1000000, 1934# "bps_rd":0, 1935# "bps_wr":0, 1936# "iops":1000000, 1937# "iops_rd":0, 1938# "iops_wr":0, 1939# "bps_max": 8000000, 1940# "bps_rd_max": 0, 1941# "bps_wr_max": 0, 1942# "iops_max": 0, 1943# "iops_rd_max": 0, 1944# "iops_wr_max": 0, 1945# "iops_size": 0, 1946# "write_threshold": 0, 1947# "image":{ 1948# "filename":"disks/test.qcow2", 1949# "format":"qcow2", 1950# "virtual-size":2048000, 1951# "backing_file":"base.qcow2", 1952# "full-backing-filename":"disks/base.qcow2", 1953# "backing-filename-format":"qcow2", 1954# "snapshots":[ 1955# { 1956# "id": "1", 1957# "name": "snapshot1", 1958# "vm-state-size": 0, 1959# "date-sec": 10000200, 1960# "date-nsec": 12, 1961# "vm-clock-sec": 206, 1962# "vm-clock-nsec": 30 1963# } 1964# ], 1965# "backing-image":{ 1966# "filename":"disks/base.qcow2", 1967# "format":"qcow2", 1968# "virtual-size":2048000 1969# } 1970# } } ] } 1971## 1972{ 'command': 'query-named-block-nodes', 1973 'returns': [ 'BlockDeviceInfo' ], 1974 'data': { '*flat': 'bool' }, 1975 'allow-preconfig': true } 1976 1977## 1978# @XDbgBlockGraphNodeType: 1979# 1980# @block-backend: corresponds to BlockBackend 1981# 1982# @block-job: corresponds to BlockJob 1983# 1984# @block-driver: corresponds to BlockDriverState 1985# 1986# Since: 4.0 1987## 1988{ 'enum': 'XDbgBlockGraphNodeType', 1989 'data': [ 'block-backend', 'block-job', 'block-driver' ] } 1990 1991## 1992# @XDbgBlockGraphNode: 1993# 1994# @id: Block graph node identifier. This @id is generated only for 1995# x-debug-query-block-graph and does not relate to any other 1996# identifiers in Qemu. 1997# 1998# @type: Type of graph node. Can be one of block-backend, block-job 1999# or block-driver-state. 2000# 2001# @name: Human readable name of the node. Corresponds to node-name 2002# for block-driver-state nodes; is not guaranteed to be unique in 2003# the whole graph (with block-jobs and block-backends). 2004# 2005# Since: 4.0 2006## 2007{ 'struct': 'XDbgBlockGraphNode', 2008 'data': { 'id': 'uint64', 'type': 'XDbgBlockGraphNodeType', 'name': 'str' } } 2009 2010## 2011# @BlockPermission: 2012# 2013# Enum of base block permissions. 2014# 2015# @consistent-read: A user that has the "permission" of consistent 2016# reads is guaranteed that their view of the contents of the block 2017# device is complete and self-consistent, representing the 2018# contents of a disk at a specific point. For most block devices 2019# (including their backing files) this is true, but the property 2020# cannot be maintained in a few situations like for intermediate 2021# nodes of a commit block job. 2022# 2023# @write: This permission is required to change the visible disk 2024# contents. 2025# 2026# @write-unchanged: This permission (which is weaker than 2027# BLK_PERM_WRITE) is both enough and required for writes to the 2028# block node when the caller promises that the visible disk 2029# content doesn't change. As the BLK_PERM_WRITE permission is 2030# strictly stronger, either is sufficient to perform an unchanging 2031# write. 2032# 2033# @resize: This permission is required to change the size of a block 2034# node. 2035# 2036# Since: 4.0 2037## 2038{ 'enum': 'BlockPermission', 2039 'data': [ 'consistent-read', 'write', 'write-unchanged', 'resize' ] } 2040 2041## 2042# @XDbgBlockGraphEdge: 2043# 2044# Block Graph edge description for x-debug-query-block-graph. 2045# 2046# @parent: parent id 2047# 2048# @child: child id 2049# 2050# @name: name of the relation (examples are 'file' and 'backing') 2051# 2052# @perm: granted permissions for the parent operating on the child 2053# 2054# @shared-perm: permissions that can still be granted to other users 2055# of the child while it is still attached to this parent 2056# 2057# Since: 4.0 2058## 2059{ 'struct': 'XDbgBlockGraphEdge', 2060 'data': { 'parent': 'uint64', 'child': 'uint64', 2061 'name': 'str', 'perm': [ 'BlockPermission' ], 2062 'shared-perm': [ 'BlockPermission' ] } } 2063 2064## 2065# @XDbgBlockGraph: 2066# 2067# Block Graph - list of nodes and list of edges. 2068# 2069# Since: 4.0 2070## 2071{ 'struct': 'XDbgBlockGraph', 2072 'data': { 'nodes': ['XDbgBlockGraphNode'], 'edges': ['XDbgBlockGraphEdge'] } } 2073 2074## 2075# @x-debug-query-block-graph: 2076# 2077# Get the block graph. 2078# 2079# Features: 2080# 2081# @unstable: This command is meant for debugging. 2082# 2083# Since: 4.0 2084## 2085{ 'command': 'x-debug-query-block-graph', 'returns': 'XDbgBlockGraph', 2086 'features': [ 'unstable' ], 2087 'allow-preconfig': true } 2088 2089## 2090# @drive-mirror: 2091# 2092# Start mirroring a block device's writes to a new destination. 2093# target specifies the target of the new image. If the file exists, 2094# or if it is a device, it will be used as the new destination for 2095# writes. If it does not exist, a new file will be created. format 2096# specifies the format of the mirror image, default is to probe if 2097# mode='existing', else the format of the source. 2098# 2099# Returns: 2100# - nothing on success 2101# - If @device is not a valid block device, GenericError 2102# 2103# Since: 1.3 2104# 2105# Example: 2106# 2107# -> { "execute": "drive-mirror", 2108# "arguments": { "device": "ide-hd0", 2109# "target": "/some/place/my-image", 2110# "sync": "full", 2111# "format": "qcow2" } } 2112# <- { "return": {} } 2113## 2114{ 'command': 'drive-mirror', 'boxed': true, 2115 'data': 'DriveMirror', 2116 'allow-preconfig': true } 2117 2118## 2119# @DriveMirror: 2120# 2121# A set of parameters describing drive mirror setup. 2122# 2123# @job-id: identifier for the newly-created block job. If omitted, 2124# the device name will be used. (Since 2.7) 2125# 2126# @device: the device name or node-name of a root node whose writes 2127# should be mirrored. 2128# 2129# @target: the target of the new image. If the file exists, or if it 2130# is a device, the existing file/device will be used as the new 2131# destination. If it does not exist, a new file will be created. 2132# 2133# @format: the format of the new destination, default is to probe if 2134# @mode is 'existing', else the format of the source 2135# 2136# @node-name: the new block driver state node name in the graph (Since 2137# 2.1) 2138# 2139# @replaces: with sync=full graph node name to be replaced by the new 2140# image when a whole image copy is done. This can be used to 2141# repair broken Quorum files. By default, @device is replaced, 2142# although implicitly created filters on it are kept. (Since 2.1) 2143# 2144# @mode: whether and how QEMU should create a new image, default is 2145# 'absolute-paths'. 2146# 2147# @speed: the maximum speed, in bytes per second 2148# 2149# @sync: what parts of the disk image should be copied to the 2150# destination (all the disk, only the sectors allocated in the 2151# topmost image, or only new I/O). 2152# 2153# @granularity: granularity of the dirty bitmap, default is 64K if the 2154# image format doesn't have clusters, 4K if the clusters are 2155# smaller than that, else the cluster size. Must be a power of 2 2156# between 512 and 64M (since 1.4). 2157# 2158# @buf-size: maximum amount of data in flight from source to target 2159# (since 1.4). 2160# 2161# @on-source-error: the action to take on an error on the source, 2162# default 'report'. 'stop' and 'enospc' can only be used if the 2163# block device supports io-status (see BlockInfo). 2164# 2165# @on-target-error: the action to take on an error on the target, 2166# default 'report' (no limitations, since this applies to a 2167# different block device than @device). 2168# 2169# @unmap: Whether to try to unmap target sectors where source has only 2170# zero. If true, and target unallocated sectors will read as 2171# zero, target image sectors will be unmapped; otherwise, zeroes 2172# will be written. Both will result in identical contents. 2173# Default is true. (Since 2.4) 2174# 2175# @copy-mode: when to copy data to the destination; defaults to 2176# 'background' (Since: 3.0) 2177# 2178# @auto-finalize: When false, this job will wait in a PENDING state 2179# after it has finished its work, waiting for @block-job-finalize 2180# before making any block graph changes. When true, this job will 2181# automatically perform its abort or commit actions. Defaults to 2182# true. (Since 3.1) 2183# 2184# @auto-dismiss: When false, this job will wait in a CONCLUDED state 2185# after it has completely ceased all work, and awaits 2186# @block-job-dismiss. When true, this job will automatically 2187# disappear from the query list without user intervention. 2188# Defaults to true. (Since 3.1) 2189# 2190# Since: 1.3 2191## 2192{ 'struct': 'DriveMirror', 2193 'data': { '*job-id': 'str', 'device': 'str', 'target': 'str', 2194 '*format': 'str', '*node-name': 'str', '*replaces': 'str', 2195 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode', 2196 '*speed': 'int', '*granularity': 'uint32', 2197 '*buf-size': 'int', '*on-source-error': 'BlockdevOnError', 2198 '*on-target-error': 'BlockdevOnError', 2199 '*unmap': 'bool', '*copy-mode': 'MirrorCopyMode', 2200 '*auto-finalize': 'bool', '*auto-dismiss': 'bool' } } 2201 2202## 2203# @BlockDirtyBitmap: 2204# 2205# @node: name of device/node which the bitmap is tracking 2206# 2207# @name: name of the dirty bitmap 2208# 2209# Since: 2.4 2210## 2211{ 'struct': 'BlockDirtyBitmap', 2212 'data': { 'node': 'str', 'name': 'str' } } 2213 2214## 2215# @BlockDirtyBitmapAdd: 2216# 2217# @node: name of device/node which the bitmap is tracking 2218# 2219# @name: name of the dirty bitmap (must be less than 1024 bytes) 2220# 2221# @granularity: the bitmap granularity, default is 64k for 2222# block-dirty-bitmap-add 2223# 2224# @persistent: the bitmap is persistent, i.e. it will be saved to the 2225# corresponding block device image file on its close. For now 2226# only Qcow2 disks support persistent bitmaps. Default is false 2227# for block-dirty-bitmap-add. (Since: 2.10) 2228# 2229# @disabled: the bitmap is created in the disabled state, which means 2230# that it will not track drive changes. The bitmap may be enabled 2231# with block-dirty-bitmap-enable. Default is false. (Since: 4.0) 2232# 2233# Since: 2.4 2234## 2235{ 'struct': 'BlockDirtyBitmapAdd', 2236 'data': { 'node': 'str', 'name': 'str', '*granularity': 'uint32', 2237 '*persistent': 'bool', '*disabled': 'bool' } } 2238 2239## 2240# @BlockDirtyBitmapOrStr: 2241# 2242# @local: name of the bitmap, attached to the same node as target 2243# bitmap. 2244# 2245# @external: bitmap with specified node 2246# 2247# Since: 4.1 2248## 2249{ 'alternate': 'BlockDirtyBitmapOrStr', 2250 'data': { 'local': 'str', 2251 'external': 'BlockDirtyBitmap' } } 2252 2253## 2254# @BlockDirtyBitmapMerge: 2255# 2256# @node: name of device/node which the @target bitmap is tracking 2257# 2258# @target: name of the destination dirty bitmap 2259# 2260# @bitmaps: name(s) of the source dirty bitmap(s) at @node and/or 2261# fully specified BlockDirtyBitmap elements. The latter are 2262# supported since 4.1. 2263# 2264# Since: 4.0 2265## 2266{ 'struct': 'BlockDirtyBitmapMerge', 2267 'data': { 'node': 'str', 'target': 'str', 2268 'bitmaps': ['BlockDirtyBitmapOrStr'] } } 2269 2270## 2271# @block-dirty-bitmap-add: 2272# 2273# Create a dirty bitmap with a name on the node, and start tracking 2274# the writes. 2275# 2276# Returns: 2277# - nothing on success 2278# - If @node is not a valid block device or node, DeviceNotFound 2279# - If @name is already taken, GenericError with an explanation 2280# 2281# Since: 2.4 2282# 2283# Example: 2284# 2285# -> { "execute": "block-dirty-bitmap-add", 2286# "arguments": { "node": "drive0", "name": "bitmap0" } } 2287# <- { "return": {} } 2288## 2289{ 'command': 'block-dirty-bitmap-add', 2290 'data': 'BlockDirtyBitmapAdd', 2291 'allow-preconfig': true } 2292 2293## 2294# @block-dirty-bitmap-remove: 2295# 2296# Stop write tracking and remove the dirty bitmap that was created 2297# with block-dirty-bitmap-add. If the bitmap is persistent, remove it 2298# from its storage too. 2299# 2300# Returns: 2301# - nothing on success 2302# - If @node is not a valid block device or node, DeviceNotFound 2303# - If @name is not found, GenericError with an explanation 2304# - if @name is frozen by an operation, GenericError 2305# 2306# Since: 2.4 2307# 2308# Example: 2309# 2310# -> { "execute": "block-dirty-bitmap-remove", 2311# "arguments": { "node": "drive0", "name": "bitmap0" } } 2312# <- { "return": {} } 2313## 2314{ 'command': 'block-dirty-bitmap-remove', 2315 'data': 'BlockDirtyBitmap', 2316 'allow-preconfig': true } 2317 2318## 2319# @block-dirty-bitmap-clear: 2320# 2321# Clear (reset) a dirty bitmap on the device, so that an incremental 2322# backup from this point in time forward will only backup clusters 2323# modified after this clear operation. 2324# 2325# Returns: 2326# - nothing on success 2327# - If @node is not a valid block device, DeviceNotFound 2328# - If @name is not found, GenericError with an explanation 2329# 2330# Since: 2.4 2331# 2332# Example: 2333# 2334# -> { "execute": "block-dirty-bitmap-clear", 2335# "arguments": { "node": "drive0", "name": "bitmap0" } } 2336# <- { "return": {} } 2337## 2338{ 'command': 'block-dirty-bitmap-clear', 2339 'data': 'BlockDirtyBitmap', 2340 'allow-preconfig': true } 2341 2342## 2343# @block-dirty-bitmap-enable: 2344# 2345# Enables a dirty bitmap so that it will begin tracking disk changes. 2346# 2347# Returns: 2348# - nothing on success 2349# - If @node is not a valid block device, DeviceNotFound 2350# - If @name is not found, GenericError with an explanation 2351# 2352# Since: 4.0 2353# 2354# Example: 2355# 2356# -> { "execute": "block-dirty-bitmap-enable", 2357# "arguments": { "node": "drive0", "name": "bitmap0" } } 2358# <- { "return": {} } 2359## 2360{ 'command': 'block-dirty-bitmap-enable', 2361 'data': 'BlockDirtyBitmap', 2362 'allow-preconfig': true } 2363 2364## 2365# @block-dirty-bitmap-disable: 2366# 2367# Disables a dirty bitmap so that it will stop tracking disk changes. 2368# 2369# Returns: 2370# - nothing on success 2371# - If @node is not a valid block device, DeviceNotFound 2372# - If @name is not found, GenericError with an explanation 2373# 2374# Since: 4.0 2375# 2376# Example: 2377# 2378# -> { "execute": "block-dirty-bitmap-disable", 2379# "arguments": { "node": "drive0", "name": "bitmap0" } } 2380# <- { "return": {} } 2381## 2382{ 'command': 'block-dirty-bitmap-disable', 2383 'data': 'BlockDirtyBitmap', 2384 'allow-preconfig': true } 2385 2386## 2387# @block-dirty-bitmap-merge: 2388# 2389# Merge dirty bitmaps listed in @bitmaps to the @target dirty bitmap. 2390# Dirty bitmaps in @bitmaps will be unchanged, except if it also 2391# appears as the @target bitmap. Any bits already set in @target will 2392# still be set after the merge, i.e., this operation does not clear 2393# the target. On error, @target is unchanged. 2394# 2395# The resulting bitmap will count as dirty any clusters that were 2396# dirty in any of the source bitmaps. This can be used to achieve 2397# backup checkpoints, or in simpler usages, to copy bitmaps. 2398# 2399# Returns: 2400# - nothing on success 2401# - If @node is not a valid block device, DeviceNotFound 2402# - If any bitmap in @bitmaps or @target is not found, 2403# GenericError 2404# - If any of the bitmaps have different sizes or granularities, 2405# GenericError 2406# 2407# Since: 4.0 2408# 2409# Example: 2410# 2411# -> { "execute": "block-dirty-bitmap-merge", 2412# "arguments": { "node": "drive0", "target": "bitmap0", 2413# "bitmaps": ["bitmap1"] } } 2414# <- { "return": {} } 2415## 2416{ 'command': 'block-dirty-bitmap-merge', 2417 'data': 'BlockDirtyBitmapMerge', 2418 'allow-preconfig': true } 2419 2420## 2421# @BlockDirtyBitmapSha256: 2422# 2423# SHA256 hash of dirty bitmap data 2424# 2425# @sha256: ASCII representation of SHA256 bitmap hash 2426# 2427# Since: 2.10 2428## 2429{ 'struct': 'BlockDirtyBitmapSha256', 2430 'data': {'sha256': 'str'} } 2431 2432## 2433# @x-debug-block-dirty-bitmap-sha256: 2434# 2435# Get bitmap SHA256. 2436# 2437# Features: 2438# 2439# @unstable: This command is meant for debugging. 2440# 2441# Returns: 2442# - BlockDirtyBitmapSha256 on success 2443# - If @node is not a valid block device, DeviceNotFound 2444# - If @name is not found or if hashing has failed, GenericError 2445# with an explanation 2446# 2447# Since: 2.10 2448## 2449{ 'command': 'x-debug-block-dirty-bitmap-sha256', 2450 'data': 'BlockDirtyBitmap', 'returns': 'BlockDirtyBitmapSha256', 2451 'features': [ 'unstable' ], 2452 'allow-preconfig': true } 2453 2454## 2455# @blockdev-mirror: 2456# 2457# Start mirroring a block device's writes to a new destination. 2458# 2459# @job-id: identifier for the newly-created block job. If omitted, 2460# the device name will be used. (Since 2.7) 2461# 2462# @device: The device name or node-name of a root node whose writes 2463# should be mirrored. 2464# 2465# @target: the id or node-name of the block device to mirror to. This 2466# mustn't be attached to guest. 2467# 2468# @replaces: with sync=full graph node name to be replaced by the new 2469# image when a whole image copy is done. This can be used to 2470# repair broken Quorum files. By default, @device is replaced, 2471# although implicitly created filters on it are kept. 2472# 2473# @speed: the maximum speed, in bytes per second 2474# 2475# @sync: what parts of the disk image should be copied to the 2476# destination (all the disk, only the sectors allocated in the 2477# topmost image, or only new I/O). 2478# 2479# @granularity: granularity of the dirty bitmap, default is 64K if the 2480# image format doesn't have clusters, 4K if the clusters are 2481# smaller than that, else the cluster size. Must be a power of 2 2482# between 512 and 64M 2483# 2484# @buf-size: maximum amount of data in flight from source to target 2485# 2486# @on-source-error: the action to take on an error on the source, 2487# default 'report'. 'stop' and 'enospc' can only be used if the 2488# block device supports io-status (see BlockInfo). 2489# 2490# @on-target-error: the action to take on an error on the target, 2491# default 'report' (no limitations, since this applies to a 2492# different block device than @device). 2493# 2494# @filter-node-name: the node name that should be assigned to the 2495# filter driver that the mirror job inserts into the graph above 2496# @device. If this option is not given, a node name is 2497# autogenerated. (Since: 2.9) 2498# 2499# @copy-mode: when to copy data to the destination; defaults to 2500# 'background' (Since: 3.0) 2501# 2502# @auto-finalize: When false, this job will wait in a PENDING state 2503# after it has finished its work, waiting for @block-job-finalize 2504# before making any block graph changes. When true, this job will 2505# automatically perform its abort or commit actions. Defaults to 2506# true. (Since 3.1) 2507# 2508# @auto-dismiss: When false, this job will wait in a CONCLUDED state 2509# after it has completely ceased all work, and awaits 2510# @block-job-dismiss. When true, this job will automatically 2511# disappear from the query list without user intervention. 2512# Defaults to true. (Since 3.1) 2513# 2514# Returns: nothing on success. 2515# 2516# Since: 2.6 2517# 2518# Example: 2519# 2520# -> { "execute": "blockdev-mirror", 2521# "arguments": { "device": "ide-hd0", 2522# "target": "target0", 2523# "sync": "full" } } 2524# <- { "return": {} } 2525## 2526{ 'command': 'blockdev-mirror', 2527 'data': { '*job-id': 'str', 'device': 'str', 'target': 'str', 2528 '*replaces': 'str', 2529 'sync': 'MirrorSyncMode', 2530 '*speed': 'int', '*granularity': 'uint32', 2531 '*buf-size': 'int', '*on-source-error': 'BlockdevOnError', 2532 '*on-target-error': 'BlockdevOnError', 2533 '*filter-node-name': 'str', 2534 '*copy-mode': 'MirrorCopyMode', 2535 '*auto-finalize': 'bool', '*auto-dismiss': 'bool' }, 2536 'allow-preconfig': true } 2537 2538## 2539# @BlockIOThrottle: 2540# 2541# A set of parameters describing block throttling. 2542# 2543# @device: Block device name 2544# 2545# @id: The name or QOM path of the guest device (since: 2.8) 2546# 2547# @bps: total throughput limit in bytes per second 2548# 2549# @bps_rd: read throughput limit in bytes per second 2550# 2551# @bps_wr: write throughput limit in bytes per second 2552# 2553# @iops: total I/O operations per second 2554# 2555# @iops_rd: read I/O operations per second 2556# 2557# @iops_wr: write I/O operations per second 2558# 2559# @bps_max: total throughput limit during bursts, in bytes (Since 1.7) 2560# 2561# @bps_rd_max: read throughput limit during bursts, in bytes (Since 2562# 1.7) 2563# 2564# @bps_wr_max: write throughput limit during bursts, in bytes (Since 2565# 1.7) 2566# 2567# @iops_max: total I/O operations per second during bursts, in bytes 2568# (Since 1.7) 2569# 2570# @iops_rd_max: read I/O operations per second during bursts, in bytes 2571# (Since 1.7) 2572# 2573# @iops_wr_max: write I/O operations per second during bursts, in 2574# bytes (Since 1.7) 2575# 2576# @bps_max_length: maximum length of the @bps_max burst period, in 2577# seconds. It must only be set if @bps_max is set as well. 2578# Defaults to 1. (Since 2.6) 2579# 2580# @bps_rd_max_length: maximum length of the @bps_rd_max burst period, 2581# in seconds. It must only be set if @bps_rd_max is set as well. 2582# Defaults to 1. (Since 2.6) 2583# 2584# @bps_wr_max_length: maximum length of the @bps_wr_max burst period, 2585# in seconds. It must only be set if @bps_wr_max is set as well. 2586# Defaults to 1. (Since 2.6) 2587# 2588# @iops_max_length: maximum length of the @iops burst period, in 2589# seconds. It must only be set if @iops_max is set as well. 2590# Defaults to 1. (Since 2.6) 2591# 2592# @iops_rd_max_length: maximum length of the @iops_rd_max burst 2593# period, in seconds. It must only be set if @iops_rd_max is set 2594# as well. Defaults to 1. (Since 2.6) 2595# 2596# @iops_wr_max_length: maximum length of the @iops_wr_max burst 2597# period, in seconds. It must only be set if @iops_wr_max is set 2598# as well. Defaults to 1. (Since 2.6) 2599# 2600# @iops_size: an I/O size in bytes (Since 1.7) 2601# 2602# @group: throttle group name (Since 2.4) 2603# 2604# Features: 2605# 2606# @deprecated: Member @device is deprecated. Use @id instead. 2607# 2608# Since: 1.1 2609## 2610{ 'struct': 'BlockIOThrottle', 2611 'data': { '*device': { 'type': 'str', 'features': [ 'deprecated' ] }, 2612 '*id': 'str', 'bps': 'int', 'bps_rd': 'int', 2613 'bps_wr': 'int', 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int', 2614 '*bps_max': 'int', '*bps_rd_max': 'int', 2615 '*bps_wr_max': 'int', '*iops_max': 'int', 2616 '*iops_rd_max': 'int', '*iops_wr_max': 'int', 2617 '*bps_max_length': 'int', '*bps_rd_max_length': 'int', 2618 '*bps_wr_max_length': 'int', '*iops_max_length': 'int', 2619 '*iops_rd_max_length': 'int', '*iops_wr_max_length': 'int', 2620 '*iops_size': 'int', '*group': 'str' } } 2621 2622## 2623# @ThrottleLimits: 2624# 2625# Limit parameters for throttling. Since some limit combinations are 2626# illegal, limits should always be set in one transaction. All fields 2627# are optional. When setting limits, if a field is missing the 2628# current value is not changed. 2629# 2630# @iops-total: limit total I/O operations per second 2631# 2632# @iops-total-max: I/O operations burst 2633# 2634# @iops-total-max-length: length of the iops-total-max burst period, 2635# in seconds It must only be set if @iops-total-max is set as 2636# well. 2637# 2638# @iops-read: limit read operations per second 2639# 2640# @iops-read-max: I/O operations read burst 2641# 2642# @iops-read-max-length: length of the iops-read-max burst period, in 2643# seconds It must only be set if @iops-read-max is set as well. 2644# 2645# @iops-write: limit write operations per second 2646# 2647# @iops-write-max: I/O operations write burst 2648# 2649# @iops-write-max-length: length of the iops-write-max burst period, 2650# in seconds It must only be set if @iops-write-max is set as 2651# well. 2652# 2653# @bps-total: limit total bytes per second 2654# 2655# @bps-total-max: total bytes burst 2656# 2657# @bps-total-max-length: length of the bps-total-max burst period, in 2658# seconds. It must only be set if @bps-total-max is set as well. 2659# 2660# @bps-read: limit read bytes per second 2661# 2662# @bps-read-max: total bytes read burst 2663# 2664# @bps-read-max-length: length of the bps-read-max burst period, in 2665# seconds It must only be set if @bps-read-max is set as well. 2666# 2667# @bps-write: limit write bytes per second 2668# 2669# @bps-write-max: total bytes write burst 2670# 2671# @bps-write-max-length: length of the bps-write-max burst period, in 2672# seconds It must only be set if @bps-write-max is set as well. 2673# 2674# @iops-size: when limiting by iops max size of an I/O in bytes 2675# 2676# Since: 2.11 2677## 2678{ 'struct': 'ThrottleLimits', 2679 'data': { '*iops-total' : 'int', '*iops-total-max' : 'int', 2680 '*iops-total-max-length' : 'int', '*iops-read' : 'int', 2681 '*iops-read-max' : 'int', '*iops-read-max-length' : 'int', 2682 '*iops-write' : 'int', '*iops-write-max' : 'int', 2683 '*iops-write-max-length' : 'int', '*bps-total' : 'int', 2684 '*bps-total-max' : 'int', '*bps-total-max-length' : 'int', 2685 '*bps-read' : 'int', '*bps-read-max' : 'int', 2686 '*bps-read-max-length' : 'int', '*bps-write' : 'int', 2687 '*bps-write-max' : 'int', '*bps-write-max-length' : 'int', 2688 '*iops-size' : 'int' } } 2689 2690## 2691# @ThrottleGroupProperties: 2692# 2693# Properties for throttle-group objects. 2694# 2695# @limits: limits to apply for this throttle group 2696# 2697# Features: 2698# 2699# @unstable: All members starting with x- are aliases for the same key 2700# without x- in the @limits object. This is not a stable 2701# interface and may be removed or changed incompatibly in the 2702# future. Use @limits for a supported stable interface. 2703# 2704# Since: 2.11 2705## 2706{ 'struct': 'ThrottleGroupProperties', 2707 'data': { '*limits': 'ThrottleLimits', 2708 '*x-iops-total': { 'type': 'int', 2709 'features': [ 'unstable' ] }, 2710 '*x-iops-total-max': { 'type': 'int', 2711 'features': [ 'unstable' ] }, 2712 '*x-iops-total-max-length': { 'type': 'int', 2713 'features': [ 'unstable' ] }, 2714 '*x-iops-read': { 'type': 'int', 2715 'features': [ 'unstable' ] }, 2716 '*x-iops-read-max': { 'type': 'int', 2717 'features': [ 'unstable' ] }, 2718 '*x-iops-read-max-length': { 'type': 'int', 2719 'features': [ 'unstable' ] }, 2720 '*x-iops-write': { 'type': 'int', 2721 'features': [ 'unstable' ] }, 2722 '*x-iops-write-max': { 'type': 'int', 2723 'features': [ 'unstable' ] }, 2724 '*x-iops-write-max-length': { 'type': 'int', 2725 'features': [ 'unstable' ] }, 2726 '*x-bps-total': { 'type': 'int', 2727 'features': [ 'unstable' ] }, 2728 '*x-bps-total-max': { 'type': 'int', 2729 'features': [ 'unstable' ] }, 2730 '*x-bps-total-max-length': { 'type': 'int', 2731 'features': [ 'unstable' ] }, 2732 '*x-bps-read': { 'type': 'int', 2733 'features': [ 'unstable' ] }, 2734 '*x-bps-read-max': { 'type': 'int', 2735 'features': [ 'unstable' ] }, 2736 '*x-bps-read-max-length': { 'type': 'int', 2737 'features': [ 'unstable' ] }, 2738 '*x-bps-write': { 'type': 'int', 2739 'features': [ 'unstable' ] }, 2740 '*x-bps-write-max': { 'type': 'int', 2741 'features': [ 'unstable' ] }, 2742 '*x-bps-write-max-length': { 'type': 'int', 2743 'features': [ 'unstable' ] }, 2744 '*x-iops-size': { 'type': 'int', 2745 'features': [ 'unstable' ] } } } 2746 2747## 2748# @block-stream: 2749# 2750# Copy data from a backing file into a block device. 2751# 2752# The block streaming operation is performed in the background until 2753# the entire backing file has been copied. This command returns 2754# immediately once streaming has started. The status of ongoing block 2755# streaming operations can be checked with query-block-jobs. The 2756# operation can be stopped before it has completed using the 2757# block-job-cancel command. 2758# 2759# The node that receives the data is called the top image, can be 2760# located in any part of the chain (but always above the base image; 2761# see below) and can be specified using its device or node name. 2762# Earlier qemu versions only allowed 'device' to name the top level 2763# node; presence of the 'base-node' parameter during introspection can 2764# be used as a witness of the enhanced semantics of 'device'. 2765# 2766# If a base file is specified then sectors are not copied from that 2767# base file and its backing chain. This can be used to stream a 2768# subset of the backing file chain instead of flattening the entire 2769# image. When streaming completes the image file will have the base 2770# file as its backing file, unless that node was changed while the job 2771# was running. In that case, base's parent's backing (or filtered, 2772# whichever exists) child (i.e., base at the beginning of the job) 2773# will be the new backing file. 2774# 2775# On successful completion the image file is updated to drop the 2776# backing file and the BLOCK_JOB_COMPLETED event is emitted. 2777# 2778# In case @device is a filter node, block-stream modifies the first 2779# non-filter overlay node below it to point to the new backing node 2780# instead of modifying @device itself. 2781# 2782# @job-id: identifier for the newly-created block job. If omitted, 2783# the device name will be used. (Since 2.7) 2784# 2785# @device: the device or node name of the top image 2786# 2787# @base: the common backing file name. It cannot be set if @base-node 2788# or @bottom is also set. 2789# 2790# @base-node: the node name of the backing file. It cannot be set if 2791# @base or @bottom is also set. (Since 2.8) 2792# 2793# @bottom: the last node in the chain that should be streamed into 2794# top. It cannot be set if @base or @base-node is also set. It 2795# cannot be filter node. (Since 6.0) 2796# 2797# @backing-file: The backing file string to write into the top image. 2798# This filename is not validated. 2799# 2800# If a pathname string is such that it cannot be resolved by QEMU, 2801# that means that subsequent QMP or HMP commands must use 2802# node-names for the image in question, as filename lookup methods 2803# will fail. 2804# 2805# If not specified, QEMU will automatically determine the backing 2806# file string to use, or error out if there is no obvious choice. 2807# Care should be taken when specifying the string, to specify a 2808# valid filename or protocol. (Since 2.1) 2809# 2810# @speed: the maximum speed, in bytes per second 2811# 2812# @on-error: the action to take on an error (default report). 'stop' 2813# and 'enospc' can only be used if the block device supports 2814# io-status (see BlockInfo). (Since 1.3) 2815# 2816# @filter-node-name: the node name that should be assigned to the 2817# filter driver that the stream job inserts into the graph above 2818# @device. If this option is not given, a node name is 2819# autogenerated. (Since: 6.0) 2820# 2821# @auto-finalize: When false, this job will wait in a PENDING state 2822# after it has finished its work, waiting for @block-job-finalize 2823# before making any block graph changes. When true, this job will 2824# automatically perform its abort or commit actions. Defaults to 2825# true. (Since 3.1) 2826# 2827# @auto-dismiss: When false, this job will wait in a CONCLUDED state 2828# after it has completely ceased all work, and awaits 2829# @block-job-dismiss. When true, this job will automatically 2830# disappear from the query list without user intervention. 2831# Defaults to true. (Since 3.1) 2832# 2833# Returns: 2834# - Nothing on success. 2835# - If @device does not exist, DeviceNotFound. 2836# 2837# Since: 1.1 2838# 2839# Example: 2840# 2841# -> { "execute": "block-stream", 2842# "arguments": { "device": "virtio0", 2843# "base": "/tmp/master.qcow2" } } 2844# <- { "return": {} } 2845## 2846{ 'command': 'block-stream', 2847 'data': { '*job-id': 'str', 'device': 'str', '*base': 'str', 2848 '*base-node': 'str', '*backing-file': 'str', '*bottom': 'str', 2849 '*speed': 'int', '*on-error': 'BlockdevOnError', 2850 '*filter-node-name': 'str', 2851 '*auto-finalize': 'bool', '*auto-dismiss': 'bool' }, 2852 'allow-preconfig': true } 2853 2854## 2855# @block-job-set-speed: 2856# 2857# Set maximum speed for a background block operation. 2858# 2859# This command can only be issued when there is an active block job. 2860# 2861# Throttling can be disabled by setting the speed to 0. 2862# 2863# @device: The job identifier. This used to be a device name (hence 2864# the name of the parameter), but since QEMU 2.7 it can have other 2865# values. 2866# 2867# @speed: the maximum speed, in bytes per second, or 0 for unlimited. 2868# Defaults to 0. 2869# 2870# Returns: 2871# - Nothing on success 2872# - If no background operation is active on this device, 2873# DeviceNotActive 2874# 2875# Since: 1.1 2876## 2877{ 'command': 'block-job-set-speed', 2878 'data': { 'device': 'str', 'speed': 'int' }, 2879 'allow-preconfig': true } 2880 2881## 2882# @block-job-cancel: 2883# 2884# Stop an active background block operation. 2885# 2886# This command returns immediately after marking the active background 2887# block operation for cancellation. It is an error to call this 2888# command if no operation is in progress. 2889# 2890# The operation will cancel as soon as possible and then emit the 2891# BLOCK_JOB_CANCELLED event. Before that happens the job is still 2892# visible when enumerated using query-block-jobs. 2893# 2894# Note that if you issue 'block-job-cancel' after 'drive-mirror' has 2895# indicated (via the event BLOCK_JOB_READY) that the source and 2896# destination are synchronized, then the event triggered by this 2897# command changes to BLOCK_JOB_COMPLETED, to indicate that the 2898# mirroring has ended and the destination now has a point-in-time copy 2899# tied to the time of the cancellation. 2900# 2901# For streaming, the image file retains its backing file unless the 2902# streaming operation happens to complete just as it is being 2903# cancelled. A new streaming operation can be started at a later time 2904# to finish copying all data from the backing file. 2905# 2906# @device: The job identifier. This used to be a device name (hence 2907# the name of the parameter), but since QEMU 2.7 it can have other 2908# values. 2909# 2910# @force: If true, and the job has already emitted the event 2911# BLOCK_JOB_READY, abandon the job immediately (even if it is 2912# paused) instead of waiting for the destination to complete its 2913# final synchronization (since 1.3) 2914# 2915# Returns: 2916# - Nothing on success 2917# - If no background operation is active on this device, 2918# DeviceNotActive 2919# 2920# Since: 1.1 2921## 2922{ 'command': 'block-job-cancel', 'data': { 'device': 'str', '*force': 'bool' }, 2923 'allow-preconfig': true } 2924 2925## 2926# @block-job-pause: 2927# 2928# Pause an active background block operation. 2929# 2930# This command returns immediately after marking the active background 2931# block operation for pausing. It is an error to call this command if 2932# no operation is in progress or if the job is already paused. 2933# 2934# The operation will pause as soon as possible. No event is emitted 2935# when the operation is actually paused. Cancelling a paused job 2936# automatically resumes it. 2937# 2938# @device: The job identifier. This used to be a device name (hence 2939# the name of the parameter), but since QEMU 2.7 it can have other 2940# values. 2941# 2942# Returns: 2943# - Nothing on success 2944# - If no background operation is active on this device, 2945# DeviceNotActive 2946# 2947# Since: 1.3 2948## 2949{ 'command': 'block-job-pause', 'data': { 'device': 'str' }, 2950 'allow-preconfig': true } 2951 2952## 2953# @block-job-resume: 2954# 2955# Resume an active background block operation. 2956# 2957# This command returns immediately after resuming a paused background 2958# block operation. It is an error to call this command if no 2959# operation is in progress or if the job is not paused. 2960# 2961# This command also clears the error status of the job. 2962# 2963# @device: The job identifier. This used to be a device name (hence 2964# the name of the parameter), but since QEMU 2.7 it can have other 2965# values. 2966# 2967# Returns: 2968# - Nothing on success 2969# - If no background operation is active on this device, 2970# DeviceNotActive 2971# 2972# Since: 1.3 2973## 2974{ 'command': 'block-job-resume', 'data': { 'device': 'str' }, 2975 'allow-preconfig': true } 2976 2977## 2978# @block-job-complete: 2979# 2980# Manually trigger completion of an active background block operation. 2981# This is supported for drive mirroring, where it also switches the 2982# device to write to the target path only. The ability to complete is 2983# signaled with a BLOCK_JOB_READY event. 2984# 2985# This command completes an active background block operation 2986# synchronously. The ordering of this command's return with the 2987# BLOCK_JOB_COMPLETED event is not defined. Note that if an I/O error 2988# occurs during the processing of this command: 1) the command itself 2989# will fail; 2) the error will be processed according to the 2990# rerror/werror arguments that were specified when starting the 2991# operation. 2992# 2993# A cancelled or paused job cannot be completed. 2994# 2995# @device: The job identifier. This used to be a device name (hence 2996# the name of the parameter), but since QEMU 2.7 it can have other 2997# values. 2998# 2999# Returns: 3000# - Nothing on success 3001# - If no background operation is active on this device, 3002# DeviceNotActive 3003# 3004# Since: 1.3 3005## 3006{ 'command': 'block-job-complete', 'data': { 'device': 'str' }, 3007 'allow-preconfig': true } 3008 3009## 3010# @block-job-dismiss: 3011# 3012# For jobs that have already concluded, remove them from the 3013# block-job-query list. This command only needs to be run for jobs 3014# which were started with QEMU 2.12+ job lifetime management 3015# semantics. 3016# 3017# This command will refuse to operate on any job that has not yet 3018# reached its terminal state, JOB_STATUS_CONCLUDED. For jobs that make 3019# use of the BLOCK_JOB_READY event, block-job-cancel or 3020# block-job-complete will still need to be used as appropriate. 3021# 3022# @id: The job identifier. 3023# 3024# Returns: Nothing on success 3025# 3026# Since: 2.12 3027## 3028{ 'command': 'block-job-dismiss', 'data': { 'id': 'str' }, 3029 'allow-preconfig': true } 3030 3031## 3032# @block-job-finalize: 3033# 3034# Once a job that has manual=true reaches the pending state, it can be 3035# instructed to finalize any graph changes and do any necessary 3036# cleanup via this command. For jobs in a transaction, instructing 3037# one job to finalize will force ALL jobs in the transaction to 3038# finalize, so it is only necessary to instruct a single member job to 3039# finalize. 3040# 3041# @id: The job identifier. 3042# 3043# Returns: Nothing on success 3044# 3045# Since: 2.12 3046## 3047{ 'command': 'block-job-finalize', 'data': { 'id': 'str' }, 3048 'allow-preconfig': true } 3049 3050## 3051# @BlockdevDiscardOptions: 3052# 3053# Determines how to handle discard requests. 3054# 3055# @ignore: Ignore the request 3056# 3057# @unmap: Forward as an unmap request 3058# 3059# Since: 2.9 3060## 3061{ 'enum': 'BlockdevDiscardOptions', 3062 'data': [ 'ignore', 'unmap' ] } 3063 3064## 3065# @BlockdevDetectZeroesOptions: 3066# 3067# Describes the operation mode for the automatic conversion of plain 3068# zero writes by the OS to driver specific optimized zero write 3069# commands. 3070# 3071# @off: Disabled (default) 3072# 3073# @on: Enabled 3074# 3075# @unmap: Enabled and even try to unmap blocks if possible. This 3076# requires also that @BlockdevDiscardOptions is set to unmap for 3077# this device. 3078# 3079# Since: 2.1 3080## 3081{ 'enum': 'BlockdevDetectZeroesOptions', 3082 'data': [ 'off', 'on', 'unmap' ] } 3083 3084## 3085# @BlockdevAioOptions: 3086# 3087# Selects the AIO backend to handle I/O requests 3088# 3089# @threads: Use qemu's thread pool 3090# 3091# @native: Use native AIO backend (only Linux and Windows) 3092# 3093# @io_uring: Use linux io_uring (since 5.0) 3094# 3095# Since: 2.9 3096## 3097{ 'enum': 'BlockdevAioOptions', 3098 'data': [ 'threads', 'native', 3099 { 'name': 'io_uring', 'if': 'CONFIG_LINUX_IO_URING' } ] } 3100 3101## 3102# @BlockdevCacheOptions: 3103# 3104# Includes cache-related options for block devices 3105# 3106# @direct: enables use of O_DIRECT (bypass the host page cache; 3107# default: false) 3108# 3109# @no-flush: ignore any flush requests for the device (default: false) 3110# 3111# Since: 2.9 3112## 3113{ 'struct': 'BlockdevCacheOptions', 3114 'data': { '*direct': 'bool', 3115 '*no-flush': 'bool' } } 3116 3117## 3118# @BlockdevDriver: 3119# 3120# Drivers that are supported in block device operations. 3121# 3122# @throttle: Since 2.11 3123# 3124# @nvme: Since 2.12 3125# 3126# @copy-on-read: Since 3.0 3127# 3128# @blklogwrites: Since 3.0 3129# 3130# @blkreplay: Since 4.2 3131# 3132# @compress: Since 5.0 3133# 3134# @copy-before-write: Since 6.2 3135# 3136# @snapshot-access: Since 7.0 3137# 3138# Since: 2.9 3139## 3140{ 'enum': 'BlockdevDriver', 3141 'data': [ 'blkdebug', 'blklogwrites', 'blkreplay', 'blkverify', 'bochs', 3142 'cloop', 'compress', 'copy-before-write', 'copy-on-read', 'dmg', 3143 'file', 'snapshot-access', 'ftp', 'ftps', 'gluster', 3144 {'name': 'host_cdrom', 'if': 'HAVE_HOST_BLOCK_DEVICE' }, 3145 {'name': 'host_device', 'if': 'HAVE_HOST_BLOCK_DEVICE' }, 3146 'http', 'https', 3147 { 'name': 'io_uring', 'if': 'CONFIG_BLKIO' }, 3148 'iscsi', 3149 'luks', 'nbd', 'nfs', 'null-aio', 'null-co', 'nvme', 3150 { 'name': 'nvme-io_uring', 'if': 'CONFIG_BLKIO' }, 3151 'parallels', 'preallocate', 'qcow', 'qcow2', 'qed', 'quorum', 3152 'raw', 'rbd', 3153 { 'name': 'replication', 'if': 'CONFIG_REPLICATION' }, 3154 'ssh', 'throttle', 'vdi', 'vhdx', 3155 { 'name': 'virtio-blk-vfio-pci', 'if': 'CONFIG_BLKIO' }, 3156 { 'name': 'virtio-blk-vhost-user', 'if': 'CONFIG_BLKIO' }, 3157 { 'name': 'virtio-blk-vhost-vdpa', 'if': 'CONFIG_BLKIO' }, 3158 'vmdk', 'vpc', 'vvfat' ] } 3159 3160## 3161# @BlockdevOptionsFile: 3162# 3163# Driver specific block device options for the file backend. 3164# 3165# @filename: path to the image file 3166# 3167# @pr-manager: the id for the object that will handle persistent 3168# reservations for this device (default: none, forward the 3169# commands via SG_IO; since 2.11) 3170# 3171# @aio: AIO backend (default: threads) (since: 2.8) 3172# 3173# @aio-max-batch: maximum number of requests to batch together into a 3174# single submission in the AIO backend. The smallest value 3175# between this and the aio-max-batch value of the IOThread object 3176# is chosen. 0 means that the AIO backend will handle it 3177# automatically. (default: 0, since 6.2) 3178# 3179# @locking: whether to enable file locking. If set to 'auto', only 3180# enable when Open File Descriptor (OFD) locking API is available 3181# (default: auto, since 2.10) 3182# 3183# @drop-cache: invalidate page cache during live migration. This 3184# prevents stale data on the migration destination with 3185# cache.direct=off. Currently only supported on Linux hosts. 3186# (default: on, since: 4.0) 3187# 3188# @x-check-cache-dropped: whether to check that page cache was dropped 3189# on live migration. May cause noticeable delays if the image 3190# file is large, do not use in production. (default: off) 3191# (since: 3.0) 3192# 3193# Features: 3194# 3195# @dynamic-auto-read-only: If present, enabled auto-read-only means 3196# that the driver will open the image read-only at first, 3197# dynamically reopen the image file read-write when the first 3198# writer is attached to the node and reopen read-only when the 3199# last writer is detached. This allows giving QEMU write 3200# permissions only on demand when an operation actually needs 3201# write access. 3202# 3203# @unstable: Member x-check-cache-dropped is meant for debugging. 3204# 3205# Since: 2.9 3206## 3207{ 'struct': 'BlockdevOptionsFile', 3208 'data': { 'filename': 'str', 3209 '*pr-manager': 'str', 3210 '*locking': 'OnOffAuto', 3211 '*aio': 'BlockdevAioOptions', 3212 '*aio-max-batch': 'int', 3213 '*drop-cache': {'type': 'bool', 3214 'if': 'CONFIG_LINUX'}, 3215 '*x-check-cache-dropped': { 'type': 'bool', 3216 'features': [ 'unstable' ] } }, 3217 'features': [ { 'name': 'dynamic-auto-read-only', 3218 'if': 'CONFIG_POSIX' } ] } 3219 3220## 3221# @BlockdevOptionsNull: 3222# 3223# Driver specific block device options for the null backend. 3224# 3225# @size: size of the device in bytes. 3226# 3227# @latency-ns: emulated latency (in nanoseconds) in processing 3228# requests. Default to zero which completes requests immediately. 3229# (Since 2.4) 3230# 3231# @read-zeroes: if true, reads from the device produce zeroes; if 3232# false, the buffer is left unchanged. 3233# (default: false; since: 4.1) 3234# 3235# Since: 2.9 3236## 3237{ 'struct': 'BlockdevOptionsNull', 3238 'data': { '*size': 'int', '*latency-ns': 'uint64', '*read-zeroes': 'bool' } } 3239 3240## 3241# @BlockdevOptionsNVMe: 3242# 3243# Driver specific block device options for the NVMe backend. 3244# 3245# @device: PCI controller address of the NVMe device in format 3246# hhhh:bb:ss.f (host:bus:slot.function) 3247# 3248# @namespace: namespace number of the device, starting from 1. 3249# 3250# Note that the PCI @device must have been unbound from any host 3251# kernel driver before instructing QEMU to add the blockdev. 3252# 3253# Since: 2.12 3254## 3255{ 'struct': 'BlockdevOptionsNVMe', 3256 'data': { 'device': 'str', 'namespace': 'int' } } 3257 3258## 3259# @BlockdevOptionsVVFAT: 3260# 3261# Driver specific block device options for the vvfat protocol. 3262# 3263# @dir: directory to be exported as FAT image 3264# 3265# @fat-type: FAT type: 12, 16 or 32 3266# 3267# @floppy: whether to export a floppy image (true) or partitioned hard 3268# disk (false; default) 3269# 3270# @label: set the volume label, limited to 11 bytes. FAT16 and FAT32 3271# traditionally have some restrictions on labels, which are 3272# ignored by most operating systems. Defaults to "QEMU VVFAT". 3273# (since 2.4) 3274# 3275# @rw: whether to allow write operations (default: false) 3276# 3277# Since: 2.9 3278## 3279{ 'struct': 'BlockdevOptionsVVFAT', 3280 'data': { 'dir': 'str', '*fat-type': 'int', '*floppy': 'bool', 3281 '*label': 'str', '*rw': 'bool' } } 3282 3283## 3284# @BlockdevOptionsGenericFormat: 3285# 3286# Driver specific block device options for image format that have no 3287# option besides their data source. 3288# 3289# @file: reference to or definition of the data source block device 3290# 3291# Since: 2.9 3292## 3293{ 'struct': 'BlockdevOptionsGenericFormat', 3294 'data': { 'file': 'BlockdevRef' } } 3295 3296## 3297# @BlockdevOptionsLUKS: 3298# 3299# Driver specific block device options for LUKS. 3300# 3301# @key-secret: the ID of a QCryptoSecret object providing the 3302# decryption key (since 2.6). Mandatory except when doing a 3303# metadata-only probe of the image. 3304# 3305# Since: 2.9 3306## 3307{ 'struct': 'BlockdevOptionsLUKS', 3308 'base': 'BlockdevOptionsGenericFormat', 3309 'data': { '*key-secret': 'str' } } 3310 3311## 3312# @BlockdevOptionsGenericCOWFormat: 3313# 3314# Driver specific block device options for image format that have no 3315# option besides their data source and an optional backing file. 3316# 3317# @backing: reference to or definition of the backing file block 3318# device, null disables the backing file entirely. Defaults to 3319# the backing file stored the image file. 3320# 3321# Since: 2.9 3322## 3323{ 'struct': 'BlockdevOptionsGenericCOWFormat', 3324 'base': 'BlockdevOptionsGenericFormat', 3325 'data': { '*backing': 'BlockdevRefOrNull' } } 3326 3327## 3328# @Qcow2OverlapCheckMode: 3329# 3330# General overlap check modes. 3331# 3332# @none: Do not perform any checks 3333# 3334# @constant: Perform only checks which can be done in constant time 3335# and without reading anything from disk 3336# 3337# @cached: Perform only checks which can be done without reading 3338# anything from disk 3339# 3340# @all: Perform all available overlap checks 3341# 3342# Since: 2.9 3343## 3344{ 'enum': 'Qcow2OverlapCheckMode', 3345 'data': [ 'none', 'constant', 'cached', 'all' ] } 3346 3347## 3348# @Qcow2OverlapCheckFlags: 3349# 3350# Structure of flags for each metadata structure. Setting a field to 3351# 'true' makes qemu guard that structure against unintended 3352# overwriting. The default value is chosen according to the template 3353# given. 3354# 3355# @template: Specifies a template mode which can be adjusted using the 3356# other flags, defaults to 'cached' 3357# 3358# @bitmap-directory: since 3.0 3359# 3360# Since: 2.9 3361## 3362{ 'struct': 'Qcow2OverlapCheckFlags', 3363 'data': { '*template': 'Qcow2OverlapCheckMode', 3364 '*main-header': 'bool', 3365 '*active-l1': 'bool', 3366 '*active-l2': 'bool', 3367 '*refcount-table': 'bool', 3368 '*refcount-block': 'bool', 3369 '*snapshot-table': 'bool', 3370 '*inactive-l1': 'bool', 3371 '*inactive-l2': 'bool', 3372 '*bitmap-directory': 'bool' } } 3373 3374## 3375# @Qcow2OverlapChecks: 3376# 3377# Specifies which metadata structures should be guarded against 3378# unintended overwriting. 3379# 3380# @flags: set of flags for separate specification of each metadata 3381# structure type 3382# 3383# @mode: named mode which chooses a specific set of flags 3384# 3385# Since: 2.9 3386## 3387{ 'alternate': 'Qcow2OverlapChecks', 3388 'data': { 'flags': 'Qcow2OverlapCheckFlags', 3389 'mode': 'Qcow2OverlapCheckMode' } } 3390 3391## 3392# @BlockdevQcowEncryptionFormat: 3393# 3394# @aes: AES-CBC with plain64 initialization vectors 3395# 3396# Since: 2.10 3397## 3398{ 'enum': 'BlockdevQcowEncryptionFormat', 3399 'data': [ 'aes' ] } 3400 3401## 3402# @BlockdevQcowEncryption: 3403# 3404# Since: 2.10 3405## 3406{ 'union': 'BlockdevQcowEncryption', 3407 'base': { 'format': 'BlockdevQcowEncryptionFormat' }, 3408 'discriminator': 'format', 3409 'data': { 'aes': 'QCryptoBlockOptionsQCow' } } 3410 3411## 3412# @BlockdevOptionsQcow: 3413# 3414# Driver specific block device options for qcow. 3415# 3416# @encrypt: Image decryption options. Mandatory for encrypted images, 3417# except when doing a metadata-only probe of the image. 3418# 3419# Since: 2.10 3420## 3421{ 'struct': 'BlockdevOptionsQcow', 3422 'base': 'BlockdevOptionsGenericCOWFormat', 3423 'data': { '*encrypt': 'BlockdevQcowEncryption' } } 3424 3425## 3426# @BlockdevQcow2EncryptionFormat: 3427# 3428# @aes: AES-CBC with plain64 initialization vectors 3429# 3430# Since: 2.10 3431## 3432{ 'enum': 'BlockdevQcow2EncryptionFormat', 3433 'data': [ 'aes', 'luks' ] } 3434 3435## 3436# @BlockdevQcow2Encryption: 3437# 3438# Since: 2.10 3439## 3440{ 'union': 'BlockdevQcow2Encryption', 3441 'base': { 'format': 'BlockdevQcow2EncryptionFormat' }, 3442 'discriminator': 'format', 3443 'data': { 'aes': 'QCryptoBlockOptionsQCow', 3444 'luks': 'QCryptoBlockOptionsLUKS'} } 3445 3446## 3447# @BlockdevOptionsPreallocate: 3448# 3449# Filter driver intended to be inserted between format and protocol 3450# node and do preallocation in protocol node on write. 3451# 3452# @prealloc-align: on preallocation, align file length to this number, 3453# default 1048576 (1M) 3454# 3455# @prealloc-size: how much to preallocate, default 134217728 (128M) 3456# 3457# Since: 6.0 3458## 3459{ 'struct': 'BlockdevOptionsPreallocate', 3460 'base': 'BlockdevOptionsGenericFormat', 3461 'data': { '*prealloc-align': 'int', '*prealloc-size': 'int' } } 3462 3463## 3464# @BlockdevOptionsQcow2: 3465# 3466# Driver specific block device options for qcow2. 3467# 3468# @lazy-refcounts: whether to enable the lazy refcounts feature 3469# (default is taken from the image file) 3470# 3471# @pass-discard-request: whether discard requests to the qcow2 device 3472# should be forwarded to the data source 3473# 3474# @pass-discard-snapshot: whether discard requests for the data source 3475# should be issued when a snapshot operation (e.g. deleting a 3476# snapshot) frees clusters in the qcow2 file 3477# 3478# @pass-discard-other: whether discard requests for the data source 3479# should be issued on other occasions where a cluster gets freed 3480# 3481# @overlap-check: which overlap checks to perform for writes to the 3482# image, defaults to 'cached' (since 2.2) 3483# 3484# @cache-size: the maximum total size of the L2 table and refcount 3485# block caches in bytes (since 2.2) 3486# 3487# @l2-cache-size: the maximum size of the L2 table cache in bytes 3488# (since 2.2) 3489# 3490# @l2-cache-entry-size: the size of each entry in the L2 cache in 3491# bytes. It must be a power of two between 512 and the cluster 3492# size. The default value is the cluster size (since 2.12) 3493# 3494# @refcount-cache-size: the maximum size of the refcount block cache 3495# in bytes (since 2.2) 3496# 3497# @cache-clean-interval: clean unused entries in the L2 and refcount 3498# caches. The interval is in seconds. The default value is 600 3499# on supporting platforms, and 0 on other platforms. 0 disables 3500# this feature. (since 2.5) 3501# 3502# @encrypt: Image decryption options. Mandatory for encrypted images, 3503# except when doing a metadata-only probe of the image. (since 3504# 2.10) 3505# 3506# @data-file: reference to or definition of the external data file. 3507# This may only be specified for images that require an external 3508# data file. If it is not specified for such an image, the data 3509# file name is loaded from the image file. (since 4.0) 3510# 3511# Since: 2.9 3512## 3513{ 'struct': 'BlockdevOptionsQcow2', 3514 'base': 'BlockdevOptionsGenericCOWFormat', 3515 'data': { '*lazy-refcounts': 'bool', 3516 '*pass-discard-request': 'bool', 3517 '*pass-discard-snapshot': 'bool', 3518 '*pass-discard-other': 'bool', 3519 '*overlap-check': 'Qcow2OverlapChecks', 3520 '*cache-size': 'int', 3521 '*l2-cache-size': 'int', 3522 '*l2-cache-entry-size': 'int', 3523 '*refcount-cache-size': 'int', 3524 '*cache-clean-interval': 'int', 3525 '*encrypt': 'BlockdevQcow2Encryption', 3526 '*data-file': 'BlockdevRef' } } 3527 3528## 3529# @SshHostKeyCheckMode: 3530# 3531# @none: Don't check the host key at all 3532# 3533# @hash: Compare the host key with a given hash 3534# 3535# @known_hosts: Check the host key against the known_hosts file 3536# 3537# Since: 2.12 3538## 3539{ 'enum': 'SshHostKeyCheckMode', 3540 'data': [ 'none', 'hash', 'known_hosts' ] } 3541 3542## 3543# @SshHostKeyCheckHashType: 3544# 3545# @md5: The given hash is an md5 hash 3546# 3547# @sha1: The given hash is an sha1 hash 3548# 3549# @sha256: The given hash is an sha256 hash 3550# 3551# Since: 2.12 3552## 3553{ 'enum': 'SshHostKeyCheckHashType', 3554 'data': [ 'md5', 'sha1', 'sha256' ] } 3555 3556## 3557# @SshHostKeyHash: 3558# 3559# @type: The hash algorithm used for the hash 3560# 3561# @hash: The expected hash value 3562# 3563# Since: 2.12 3564## 3565{ 'struct': 'SshHostKeyHash', 3566 'data': { 'type': 'SshHostKeyCheckHashType', 3567 'hash': 'str' }} 3568 3569## 3570# @SshHostKeyCheck: 3571# 3572# Since: 2.12 3573## 3574{ 'union': 'SshHostKeyCheck', 3575 'base': { 'mode': 'SshHostKeyCheckMode' }, 3576 'discriminator': 'mode', 3577 'data': { 'hash': 'SshHostKeyHash' } } 3578 3579## 3580# @BlockdevOptionsSsh: 3581# 3582# @server: host address 3583# 3584# @path: path to the image on the host 3585# 3586# @user: user as which to connect, defaults to current local user name 3587# 3588# @host-key-check: Defines how and what to check the host key against 3589# (default: known_hosts) 3590# 3591# Since: 2.9 3592## 3593{ 'struct': 'BlockdevOptionsSsh', 3594 'data': { 'server': 'InetSocketAddress', 3595 'path': 'str', 3596 '*user': 'str', 3597 '*host-key-check': 'SshHostKeyCheck' } } 3598 3599## 3600# @BlkdebugEvent: 3601# 3602# Trigger events supported by blkdebug. 3603# 3604# @l1_shrink_write_table: write zeros to the l1 table to shrink image. 3605# (since 2.11) 3606# 3607# @l1_shrink_free_l2_clusters: discard the l2 tables. (since 2.11) 3608# 3609# @cor_write: a write due to copy-on-read (since 2.11) 3610# 3611# @cluster_alloc_space: an allocation of file space for a cluster 3612# (since 4.1) 3613# 3614# @none: triggers once at creation of the blkdebug node (since 4.1) 3615# 3616# Since: 2.9 3617## 3618{ 'enum': 'BlkdebugEvent', 'prefix': 'BLKDBG', 3619 'data': [ 'l1_update', 'l1_grow_alloc_table', 'l1_grow_write_table', 3620 'l1_grow_activate_table', 'l2_load', 'l2_update', 3621 'l2_update_compressed', 'l2_alloc_cow_read', 'l2_alloc_write', 3622 'read_aio', 'read_backing_aio', 'read_compressed', 'write_aio', 3623 'write_compressed', 'vmstate_load', 'vmstate_save', 'cow_read', 3624 'cow_write', 'reftable_load', 'reftable_grow', 'reftable_update', 3625 'refblock_load', 'refblock_update', 'refblock_update_part', 3626 'refblock_alloc', 'refblock_alloc_hookup', 'refblock_alloc_write', 3627 'refblock_alloc_write_blocks', 'refblock_alloc_write_table', 3628 'refblock_alloc_switch_table', 'cluster_alloc', 3629 'cluster_alloc_bytes', 'cluster_free', 'flush_to_os', 3630 'flush_to_disk', 'pwritev_rmw_head', 'pwritev_rmw_after_head', 3631 'pwritev_rmw_tail', 'pwritev_rmw_after_tail', 'pwritev', 3632 'pwritev_zero', 'pwritev_done', 'empty_image_prepare', 3633 'l1_shrink_write_table', 'l1_shrink_free_l2_clusters', 3634 'cor_write', 'cluster_alloc_space', 'none'] } 3635 3636## 3637# @BlkdebugIOType: 3638# 3639# Kinds of I/O that blkdebug can inject errors in. 3640# 3641# @read: .bdrv_co_preadv() 3642# 3643# @write: .bdrv_co_pwritev() 3644# 3645# @write-zeroes: .bdrv_co_pwrite_zeroes() 3646# 3647# @discard: .bdrv_co_pdiscard() 3648# 3649# @flush: .bdrv_co_flush_to_disk() 3650# 3651# @block-status: .bdrv_co_block_status() 3652# 3653# Since: 4.1 3654## 3655{ 'enum': 'BlkdebugIOType', 'prefix': 'BLKDEBUG_IO_TYPE', 3656 'data': [ 'read', 'write', 'write-zeroes', 'discard', 'flush', 3657 'block-status' ] } 3658 3659## 3660# @BlkdebugInjectErrorOptions: 3661# 3662# Describes a single error injection for blkdebug. 3663# 3664# @event: trigger event 3665# 3666# @state: the state identifier blkdebug needs to be in to actually 3667# trigger the event; defaults to "any" 3668# 3669# @iotype: the type of I/O operations on which this error should be 3670# injected; defaults to "all read, write, write-zeroes, discard, 3671# and flush operations" (since: 4.1) 3672# 3673# @errno: error identifier (errno) to be returned; defaults to EIO 3674# 3675# @sector: specifies the sector index which has to be affected in 3676# order to actually trigger the event; defaults to "any sector" 3677# 3678# @once: disables further events after this one has been triggered; 3679# defaults to false 3680# 3681# @immediately: fail immediately; defaults to false 3682# 3683# Since: 2.9 3684## 3685{ 'struct': 'BlkdebugInjectErrorOptions', 3686 'data': { 'event': 'BlkdebugEvent', 3687 '*state': 'int', 3688 '*iotype': 'BlkdebugIOType', 3689 '*errno': 'int', 3690 '*sector': 'int', 3691 '*once': 'bool', 3692 '*immediately': 'bool' } } 3693 3694## 3695# @BlkdebugSetStateOptions: 3696# 3697# Describes a single state-change event for blkdebug. 3698# 3699# @event: trigger event 3700# 3701# @state: the current state identifier blkdebug needs to be in; 3702# defaults to "any" 3703# 3704# @new_state: the state identifier blkdebug is supposed to assume if 3705# this event is triggered 3706# 3707# Since: 2.9 3708## 3709{ 'struct': 'BlkdebugSetStateOptions', 3710 'data': { 'event': 'BlkdebugEvent', 3711 '*state': 'int', 3712 'new_state': 'int' } } 3713 3714## 3715# @BlockdevOptionsBlkdebug: 3716# 3717# Driver specific block device options for blkdebug. 3718# 3719# @image: underlying raw block device (or image file) 3720# 3721# @config: filename of the configuration file 3722# 3723# @align: required alignment for requests in bytes, must be positive 3724# power of 2, or 0 for default 3725# 3726# @max-transfer: maximum size for I/O transfers in bytes, must be 3727# positive multiple of @align and of the underlying file's request 3728# alignment (but need not be a power of 2), or 0 for default 3729# (since 2.10) 3730# 3731# @opt-write-zero: preferred alignment for write zero requests in 3732# bytes, must be positive multiple of @align and of the underlying 3733# file's request alignment (but need not be a power of 2), or 0 3734# for default (since 2.10) 3735# 3736# @max-write-zero: maximum size for write zero requests in bytes, must 3737# be positive multiple of @align, of @opt-write-zero, and of the 3738# underlying file's request alignment (but need not be a power of 3739# 2), or 0 for default (since 2.10) 3740# 3741# @opt-discard: preferred alignment for discard requests in bytes, 3742# must be positive multiple of @align and of the underlying file's 3743# request alignment (but need not be a power of 2), or 0 for 3744# default (since 2.10) 3745# 3746# @max-discard: maximum size for discard requests in bytes, must be 3747# positive multiple of @align, of @opt-discard, and of the 3748# underlying file's request alignment (but need not be a power of 3749# 2), or 0 for default (since 2.10) 3750# 3751# @inject-error: array of error injection descriptions 3752# 3753# @set-state: array of state-change descriptions 3754# 3755# @take-child-perms: Permissions to take on @image in addition to what 3756# is necessary anyway (which depends on how the blkdebug node is 3757# used). Defaults to none. (since 5.0) 3758# 3759# @unshare-child-perms: Permissions not to share on @image in addition 3760# to what cannot be shared anyway (which depends on how the 3761# blkdebug node is used). Defaults to none. (since 5.0) 3762# 3763# Since: 2.9 3764## 3765{ 'struct': 'BlockdevOptionsBlkdebug', 3766 'data': { 'image': 'BlockdevRef', 3767 '*config': 'str', 3768 '*align': 'int', '*max-transfer': 'int32', 3769 '*opt-write-zero': 'int32', '*max-write-zero': 'int32', 3770 '*opt-discard': 'int32', '*max-discard': 'int32', 3771 '*inject-error': ['BlkdebugInjectErrorOptions'], 3772 '*set-state': ['BlkdebugSetStateOptions'], 3773 '*take-child-perms': ['BlockPermission'], 3774 '*unshare-child-perms': ['BlockPermission'] } } 3775 3776## 3777# @BlockdevOptionsBlklogwrites: 3778# 3779# Driver specific block device options for blklogwrites. 3780# 3781# @file: block device 3782# 3783# @log: block device used to log writes to @file 3784# 3785# @log-sector-size: sector size used in logging writes to @file, 3786# determines granularity of offsets and sizes of writes 3787# (default: 512) 3788# 3789# @log-append: append to an existing log (default: false) 3790# 3791# @log-super-update-interval: interval of write requests after which 3792# the log super block is updated to disk (default: 4096) 3793# 3794# Since: 3.0 3795## 3796{ 'struct': 'BlockdevOptionsBlklogwrites', 3797 'data': { 'file': 'BlockdevRef', 3798 'log': 'BlockdevRef', 3799 '*log-sector-size': 'uint32', 3800 '*log-append': 'bool', 3801 '*log-super-update-interval': 'uint64' } } 3802 3803## 3804# @BlockdevOptionsBlkverify: 3805# 3806# Driver specific block device options for blkverify. 3807# 3808# @test: block device to be tested 3809# 3810# @raw: raw image used for verification 3811# 3812# Since: 2.9 3813## 3814{ 'struct': 'BlockdevOptionsBlkverify', 3815 'data': { 'test': 'BlockdevRef', 3816 'raw': 'BlockdevRef' } } 3817 3818## 3819# @BlockdevOptionsBlkreplay: 3820# 3821# Driver specific block device options for blkreplay. 3822# 3823# @image: disk image which should be controlled with blkreplay 3824# 3825# Since: 4.2 3826## 3827{ 'struct': 'BlockdevOptionsBlkreplay', 3828 'data': { 'image': 'BlockdevRef' } } 3829 3830## 3831# @QuorumReadPattern: 3832# 3833# An enumeration of quorum read patterns. 3834# 3835# @quorum: read all the children and do a quorum vote on reads 3836# 3837# @fifo: read only from the first child that has not failed 3838# 3839# Since: 2.9 3840## 3841{ 'enum': 'QuorumReadPattern', 'data': [ 'quorum', 'fifo' ] } 3842 3843## 3844# @BlockdevOptionsQuorum: 3845# 3846# Driver specific block device options for Quorum 3847# 3848# @blkverify: true if the driver must print content mismatch set to 3849# false by default 3850# 3851# @children: the children block devices to use 3852# 3853# @vote-threshold: the vote limit under which a read will fail 3854# 3855# @rewrite-corrupted: rewrite corrupted data when quorum is reached 3856# (Since 2.1) 3857# 3858# @read-pattern: choose read pattern and set to quorum by default 3859# (Since 2.2) 3860# 3861# Since: 2.9 3862## 3863{ 'struct': 'BlockdevOptionsQuorum', 3864 'data': { '*blkverify': 'bool', 3865 'children': [ 'BlockdevRef' ], 3866 'vote-threshold': 'int', 3867 '*rewrite-corrupted': 'bool', 3868 '*read-pattern': 'QuorumReadPattern' } } 3869 3870## 3871# @BlockdevOptionsGluster: 3872# 3873# Driver specific block device options for Gluster 3874# 3875# @volume: name of gluster volume where VM image resides 3876# 3877# @path: absolute path to image file in gluster volume 3878# 3879# @server: gluster servers description 3880# 3881# @debug: libgfapi log level (default '4' which is Error) (Since 2.8) 3882# 3883# @logfile: libgfapi log file (default /dev/stderr) (Since 2.8) 3884# 3885# Since: 2.9 3886## 3887{ 'struct': 'BlockdevOptionsGluster', 3888 'data': { 'volume': 'str', 3889 'path': 'str', 3890 'server': ['SocketAddress'], 3891 '*debug': 'int', 3892 '*logfile': 'str' } } 3893 3894## 3895# @BlockdevOptionsIoUring: 3896# 3897# Driver specific block device options for the io_uring backend. 3898# 3899# @filename: path to the image file 3900# 3901# Since: 7.2 3902## 3903{ 'struct': 'BlockdevOptionsIoUring', 3904 'data': { 'filename': 'str' }, 3905 'if': 'CONFIG_BLKIO' } 3906 3907## 3908# @BlockdevOptionsNvmeIoUring: 3909# 3910# Driver specific block device options for the nvme-io_uring backend. 3911# 3912# @path: path to the NVMe namespace's character device (e.g. 3913# /dev/ng0n1). 3914# 3915# Since: 7.2 3916## 3917{ 'struct': 'BlockdevOptionsNvmeIoUring', 3918 'data': { 'path': 'str' }, 3919 'if': 'CONFIG_BLKIO' } 3920 3921## 3922# @BlockdevOptionsVirtioBlkVfioPci: 3923# 3924# Driver specific block device options for the virtio-blk-vfio-pci 3925# backend. 3926# 3927# @path: path to the PCI device's sysfs directory (e.g. 3928# /sys/bus/pci/devices/0000:00:01.0). 3929# 3930# Since: 7.2 3931## 3932{ 'struct': 'BlockdevOptionsVirtioBlkVfioPci', 3933 'data': { 'path': 'str' }, 3934 'if': 'CONFIG_BLKIO' } 3935 3936## 3937# @BlockdevOptionsVirtioBlkVhostUser: 3938# 3939# Driver specific block device options for the virtio-blk-vhost-user 3940# backend. 3941# 3942# @path: path to the vhost-user UNIX domain socket. 3943# 3944# Since: 7.2 3945## 3946{ 'struct': 'BlockdevOptionsVirtioBlkVhostUser', 3947 'data': { 'path': 'str' }, 3948 'if': 'CONFIG_BLKIO' } 3949 3950## 3951# @BlockdevOptionsVirtioBlkVhostVdpa: 3952# 3953# Driver specific block device options for the virtio-blk-vhost-vdpa 3954# backend. 3955# 3956# @path: path to the vhost-vdpa character device. 3957# 3958# Features: 3959# @fdset: Member @path supports the special "/dev/fdset/N" path 3960# (since 8.1) 3961# 3962# Since: 7.2 3963## 3964{ 'struct': 'BlockdevOptionsVirtioBlkVhostVdpa', 3965 'data': { 'path': 'str' }, 3966 'features': [ { 'name' :'fdset', 3967 'if': 'CONFIG_BLKIO_VHOST_VDPA_FD' } ], 3968 'if': 'CONFIG_BLKIO' } 3969 3970## 3971# @IscsiTransport: 3972# 3973# An enumeration of libiscsi transport types 3974# 3975# Since: 2.9 3976## 3977{ 'enum': 'IscsiTransport', 3978 'data': [ 'tcp', 'iser' ] } 3979 3980## 3981# @IscsiHeaderDigest: 3982# 3983# An enumeration of header digests supported by libiscsi 3984# 3985# Since: 2.9 3986## 3987{ 'enum': 'IscsiHeaderDigest', 3988 'prefix': 'QAPI_ISCSI_HEADER_DIGEST', 3989 'data': [ 'crc32c', 'none', 'crc32c-none', 'none-crc32c' ] } 3990 3991## 3992# @BlockdevOptionsIscsi: 3993# 3994# @transport: The iscsi transport type 3995# 3996# @portal: The address of the iscsi portal 3997# 3998# @target: The target iqn name 3999# 4000# @lun: LUN to connect to. Defaults to 0. 4001# 4002# @user: User name to log in with. If omitted, no CHAP authentication 4003# is performed. 4004# 4005# @password-secret: The ID of a QCryptoSecret object providing the 4006# password for the login. This option is required if @user is 4007# specified. 4008# 4009# @initiator-name: The iqn name we want to identify to the target as. 4010# If this option is not specified, an initiator name is generated 4011# automatically. 4012# 4013# @header-digest: The desired header digest. Defaults to none-crc32c. 4014# 4015# @timeout: Timeout in seconds after which a request will timeout. 0 4016# means no timeout and is the default. 4017# 4018# Driver specific block device options for iscsi 4019# 4020# Since: 2.9 4021## 4022{ 'struct': 'BlockdevOptionsIscsi', 4023 'data': { 'transport': 'IscsiTransport', 4024 'portal': 'str', 4025 'target': 'str', 4026 '*lun': 'int', 4027 '*user': 'str', 4028 '*password-secret': 'str', 4029 '*initiator-name': 'str', 4030 '*header-digest': 'IscsiHeaderDigest', 4031 '*timeout': 'int' } } 4032 4033## 4034# @RbdAuthMode: 4035# 4036# Since: 3.0 4037## 4038{ 'enum': 'RbdAuthMode', 4039 'data': [ 'cephx', 'none' ] } 4040 4041## 4042# @RbdImageEncryptionFormat: 4043# 4044# @luks-any: Used for opening either luks or luks2 (Since 8.0) 4045# 4046# Since: 6.1 4047## 4048{ 'enum': 'RbdImageEncryptionFormat', 4049 'data': [ 'luks', 'luks2', 'luks-any' ] } 4050 4051## 4052# @RbdEncryptionOptionsLUKSBase: 4053# 4054# @key-secret: ID of a QCryptoSecret object providing a passphrase for 4055# unlocking the encryption 4056# 4057# Since: 6.1 4058## 4059{ 'struct': 'RbdEncryptionOptionsLUKSBase', 4060 'data': { 'key-secret': 'str' } } 4061 4062## 4063# @RbdEncryptionCreateOptionsLUKSBase: 4064# 4065# @cipher-alg: The encryption algorithm 4066# 4067# Since: 6.1 4068## 4069{ 'struct': 'RbdEncryptionCreateOptionsLUKSBase', 4070 'base': 'RbdEncryptionOptionsLUKSBase', 4071 'data': { '*cipher-alg': 'QCryptoCipherAlgorithm' } } 4072 4073## 4074# @RbdEncryptionOptionsLUKS: 4075# 4076# Since: 6.1 4077## 4078{ 'struct': 'RbdEncryptionOptionsLUKS', 4079 'base': 'RbdEncryptionOptionsLUKSBase', 4080 'data': { } } 4081 4082## 4083# @RbdEncryptionOptionsLUKS2: 4084# 4085# Since: 6.1 4086## 4087{ 'struct': 'RbdEncryptionOptionsLUKS2', 4088 'base': 'RbdEncryptionOptionsLUKSBase', 4089 'data': { } } 4090 4091## 4092# @RbdEncryptionOptionsLUKSAny: 4093# 4094# Since: 8.0 4095## 4096{ 'struct': 'RbdEncryptionOptionsLUKSAny', 4097 'base': 'RbdEncryptionOptionsLUKSBase', 4098 'data': { } } 4099 4100## 4101# @RbdEncryptionCreateOptionsLUKS: 4102# 4103# Since: 6.1 4104## 4105{ 'struct': 'RbdEncryptionCreateOptionsLUKS', 4106 'base': 'RbdEncryptionCreateOptionsLUKSBase', 4107 'data': { } } 4108 4109## 4110# @RbdEncryptionCreateOptionsLUKS2: 4111# 4112# Since: 6.1 4113## 4114{ 'struct': 'RbdEncryptionCreateOptionsLUKS2', 4115 'base': 'RbdEncryptionCreateOptionsLUKSBase', 4116 'data': { } } 4117 4118## 4119# @RbdEncryptionOptions: 4120# 4121# @format: Encryption format. 4122# 4123# @parent: Parent image encryption options (for cloned images). Can 4124# be left unspecified if this cloned image is encrypted using the 4125# same format and secret as its parent image (i.e. not explicitly 4126# formatted) or if its parent image is not encrypted. (Since 8.0) 4127# 4128# Since: 6.1 4129## 4130{ 'union': 'RbdEncryptionOptions', 4131 'base': { 'format': 'RbdImageEncryptionFormat', 4132 '*parent': 'RbdEncryptionOptions' }, 4133 'discriminator': 'format', 4134 'data': { 'luks': 'RbdEncryptionOptionsLUKS', 4135 'luks2': 'RbdEncryptionOptionsLUKS2', 4136 'luks-any': 'RbdEncryptionOptionsLUKSAny'} } 4137 4138## 4139# @RbdEncryptionCreateOptions: 4140# 4141# Since: 6.1 4142## 4143{ 'union': 'RbdEncryptionCreateOptions', 4144 'base': { 'format': 'RbdImageEncryptionFormat' }, 4145 'discriminator': 'format', 4146 'data': { 'luks': 'RbdEncryptionCreateOptionsLUKS', 4147 'luks2': 'RbdEncryptionCreateOptionsLUKS2' } } 4148 4149## 4150# @BlockdevOptionsRbd: 4151# 4152# @pool: Ceph pool name. 4153# 4154# @namespace: Rados namespace name in the Ceph pool. (Since 5.0) 4155# 4156# @image: Image name in the Ceph pool. 4157# 4158# @conf: path to Ceph configuration file. Values in the configuration 4159# file will be overridden by options specified via QAPI. 4160# 4161# @snapshot: Ceph snapshot name. 4162# 4163# @encrypt: Image encryption options. (Since 6.1) 4164# 4165# @user: Ceph id name. 4166# 4167# @auth-client-required: Acceptable authentication modes. This maps 4168# to Ceph configuration option "auth_client_required". (Since 4169# 3.0) 4170# 4171# @key-secret: ID of a QCryptoSecret object providing a key for cephx 4172# authentication. This maps to Ceph configuration option "key". 4173# (Since 3.0) 4174# 4175# @server: Monitor host address and port. This maps to the "mon_host" 4176# Ceph option. 4177# 4178# Since: 2.9 4179## 4180{ 'struct': 'BlockdevOptionsRbd', 4181 'data': { 'pool': 'str', 4182 '*namespace': 'str', 4183 'image': 'str', 4184 '*conf': 'str', 4185 '*snapshot': 'str', 4186 '*encrypt': 'RbdEncryptionOptions', 4187 '*user': 'str', 4188 '*auth-client-required': ['RbdAuthMode'], 4189 '*key-secret': 'str', 4190 '*server': ['InetSocketAddressBase'] } } 4191 4192## 4193# @ReplicationMode: 4194# 4195# An enumeration of replication modes. 4196# 4197# @primary: Primary mode, the vm's state will be sent to secondary 4198# QEMU. 4199# 4200# @secondary: Secondary mode, receive the vm's state from primary 4201# QEMU. 4202# 4203# Since: 2.9 4204## 4205{ 'enum' : 'ReplicationMode', 'data' : [ 'primary', 'secondary' ], 4206 'if': 'CONFIG_REPLICATION' } 4207 4208## 4209# @BlockdevOptionsReplication: 4210# 4211# Driver specific block device options for replication 4212# 4213# @mode: the replication mode 4214# 4215# @top-id: In secondary mode, node name or device ID of the root node 4216# who owns the replication node chain. Must not be given in 4217# primary mode. 4218# 4219# Since: 2.9 4220## 4221{ 'struct': 'BlockdevOptionsReplication', 4222 'base': 'BlockdevOptionsGenericFormat', 4223 'data': { 'mode': 'ReplicationMode', 4224 '*top-id': 'str' }, 4225 'if': 'CONFIG_REPLICATION' } 4226 4227## 4228# @NFSTransport: 4229# 4230# An enumeration of NFS transport types 4231# 4232# @inet: TCP transport 4233# 4234# Since: 2.9 4235## 4236{ 'enum': 'NFSTransport', 4237 'data': [ 'inet' ] } 4238 4239## 4240# @NFSServer: 4241# 4242# Captures the address of the socket 4243# 4244# @type: transport type used for NFS (only TCP supported) 4245# 4246# @host: host address for NFS server 4247# 4248# Since: 2.9 4249## 4250{ 'struct': 'NFSServer', 4251 'data': { 'type': 'NFSTransport', 4252 'host': 'str' } } 4253 4254## 4255# @BlockdevOptionsNfs: 4256# 4257# Driver specific block device option for NFS 4258# 4259# @server: host address 4260# 4261# @path: path of the image on the host 4262# 4263# @user: UID value to use when talking to the server (defaults to 4264# 65534 on Windows and getuid() on unix) 4265# 4266# @group: GID value to use when talking to the server (defaults to 4267# 65534 on Windows and getgid() in unix) 4268# 4269# @tcp-syn-count: number of SYNs during the session establishment 4270# (defaults to libnfs default) 4271# 4272# @readahead-size: set the readahead size in bytes (defaults to libnfs 4273# default) 4274# 4275# @page-cache-size: set the pagecache size in bytes (defaults to 4276# libnfs default) 4277# 4278# @debug: set the NFS debug level (max 2) (defaults to libnfs default) 4279# 4280# Since: 2.9 4281## 4282{ 'struct': 'BlockdevOptionsNfs', 4283 'data': { 'server': 'NFSServer', 4284 'path': 'str', 4285 '*user': 'int', 4286 '*group': 'int', 4287 '*tcp-syn-count': 'int', 4288 '*readahead-size': 'int', 4289 '*page-cache-size': 'int', 4290 '*debug': 'int' } } 4291 4292## 4293# @BlockdevOptionsCurlBase: 4294# 4295# Driver specific block device options shared by all protocols 4296# supported by the curl backend. 4297# 4298# @url: URL of the image file 4299# 4300# @readahead: Size of the read-ahead cache; must be a multiple of 512 4301# (defaults to 256 kB) 4302# 4303# @timeout: Timeout for connections, in seconds (defaults to 5) 4304# 4305# @username: Username for authentication (defaults to none) 4306# 4307# @password-secret: ID of a QCryptoSecret object providing a password 4308# for authentication (defaults to no password) 4309# 4310# @proxy-username: Username for proxy authentication (defaults to 4311# none) 4312# 4313# @proxy-password-secret: ID of a QCryptoSecret object providing a 4314# password for proxy authentication (defaults to no password) 4315# 4316# Since: 2.9 4317## 4318{ 'struct': 'BlockdevOptionsCurlBase', 4319 'data': { 'url': 'str', 4320 '*readahead': 'int', 4321 '*timeout': 'int', 4322 '*username': 'str', 4323 '*password-secret': 'str', 4324 '*proxy-username': 'str', 4325 '*proxy-password-secret': 'str' } } 4326 4327## 4328# @BlockdevOptionsCurlHttp: 4329# 4330# Driver specific block device options for HTTP connections over the 4331# curl backend. URLs must start with "http://". 4332# 4333# @cookie: List of cookies to set; format is "name1=content1; 4334# name2=content2;" as explained by CURLOPT_COOKIE(3). Defaults to 4335# no cookies. 4336# 4337# @cookie-secret: ID of a QCryptoSecret object providing the cookie 4338# data in a secure way. See @cookie for the format. (since 2.10) 4339# 4340# Since: 2.9 4341## 4342{ 'struct': 'BlockdevOptionsCurlHttp', 4343 'base': 'BlockdevOptionsCurlBase', 4344 'data': { '*cookie': 'str', 4345 '*cookie-secret': 'str'} } 4346 4347## 4348# @BlockdevOptionsCurlHttps: 4349# 4350# Driver specific block device options for HTTPS connections over the 4351# curl backend. URLs must start with "https://". 4352# 4353# @cookie: List of cookies to set; format is "name1=content1; 4354# name2=content2;" as explained by CURLOPT_COOKIE(3). Defaults to 4355# no cookies. 4356# 4357# @sslverify: Whether to verify the SSL certificate's validity 4358# (defaults to true) 4359# 4360# @cookie-secret: ID of a QCryptoSecret object providing the cookie 4361# data in a secure way. See @cookie for the format. (since 2.10) 4362# 4363# Since: 2.9 4364## 4365{ 'struct': 'BlockdevOptionsCurlHttps', 4366 'base': 'BlockdevOptionsCurlBase', 4367 'data': { '*cookie': 'str', 4368 '*sslverify': 'bool', 4369 '*cookie-secret': 'str'} } 4370 4371## 4372# @BlockdevOptionsCurlFtp: 4373# 4374# Driver specific block device options for FTP connections over the 4375# curl backend. URLs must start with "ftp://". 4376# 4377# Since: 2.9 4378## 4379{ 'struct': 'BlockdevOptionsCurlFtp', 4380 'base': 'BlockdevOptionsCurlBase', 4381 'data': { } } 4382 4383## 4384# @BlockdevOptionsCurlFtps: 4385# 4386# Driver specific block device options for FTPS connections over the 4387# curl backend. URLs must start with "ftps://". 4388# 4389# @sslverify: Whether to verify the SSL certificate's validity 4390# (defaults to true) 4391# 4392# Since: 2.9 4393## 4394{ 'struct': 'BlockdevOptionsCurlFtps', 4395 'base': 'BlockdevOptionsCurlBase', 4396 'data': { '*sslverify': 'bool' } } 4397 4398## 4399# @BlockdevOptionsNbd: 4400# 4401# Driver specific block device options for NBD. 4402# 4403# @server: NBD server address 4404# 4405# @export: export name 4406# 4407# @tls-creds: TLS credentials ID 4408# 4409# @tls-hostname: TLS hostname override for certificate validation 4410# (Since 7.0) 4411# 4412# @x-dirty-bitmap: A metadata context name such as 4413# "qemu:dirty-bitmap:NAME" or "qemu:allocation-depth" to query in 4414# place of the traditional "base:allocation" block status (see 4415# NBD_OPT_LIST_META_CONTEXT in the NBD protocol; and yes, naming 4416# this option x-context would have made more sense) (since 3.0) 4417# 4418# @reconnect-delay: On an unexpected disconnect, the nbd client tries 4419# to connect again until succeeding or encountering a serious 4420# error. During the first @reconnect-delay seconds, all requests 4421# are paused and will be rerun on a successful reconnect. After 4422# that time, any delayed requests and all future requests before a 4423# successful reconnect will immediately fail. Default 0 (Since 4424# 4.2) 4425# 4426# @open-timeout: In seconds. If zero, the nbd driver tries the 4427# connection only once, and fails to open if the connection fails. 4428# If non-zero, the nbd driver will repeat connection attempts 4429# until successful or until @open-timeout seconds have elapsed. 4430# Default 0 (Since 7.0) 4431# 4432# Features: 4433# 4434# @unstable: Member @x-dirty-bitmap is experimental. 4435# 4436# Since: 2.9 4437## 4438{ 'struct': 'BlockdevOptionsNbd', 4439 'data': { 'server': 'SocketAddress', 4440 '*export': 'str', 4441 '*tls-creds': 'str', 4442 '*tls-hostname': 'str', 4443 '*x-dirty-bitmap': { 'type': 'str', 'features': [ 'unstable' ] }, 4444 '*reconnect-delay': 'uint32', 4445 '*open-timeout': 'uint32' } } 4446 4447## 4448# @BlockdevOptionsRaw: 4449# 4450# Driver specific block device options for the raw driver. 4451# 4452# @offset: position where the block device starts 4453# 4454# @size: the assumed size of the device 4455# 4456# Since: 2.9 4457## 4458{ 'struct': 'BlockdevOptionsRaw', 4459 'base': 'BlockdevOptionsGenericFormat', 4460 'data': { '*offset': 'int', '*size': 'int' } } 4461 4462## 4463# @BlockdevOptionsThrottle: 4464# 4465# Driver specific block device options for the throttle driver 4466# 4467# @throttle-group: the name of the throttle-group object to use. It 4468# must already exist. 4469# 4470# @file: reference to or definition of the data source block device 4471# 4472# Since: 2.11 4473## 4474{ 'struct': 'BlockdevOptionsThrottle', 4475 'data': { 'throttle-group': 'str', 4476 'file' : 'BlockdevRef' 4477 } } 4478 4479## 4480# @BlockdevOptionsCor: 4481# 4482# Driver specific block device options for the copy-on-read driver. 4483# 4484# @bottom: The name of a non-filter node (allocation-bearing layer) 4485# that limits the COR operations in the backing chain (inclusive), 4486# so that no data below this node will be copied by this filter. 4487# If option is absent, the limit is not applied, so that data from 4488# all backing layers may be copied. 4489# 4490# Since: 6.0 4491## 4492{ 'struct': 'BlockdevOptionsCor', 4493 'base': 'BlockdevOptionsGenericFormat', 4494 'data': { '*bottom': 'str' } } 4495 4496## 4497# @OnCbwError: 4498# 4499# An enumeration of possible behaviors for copy-before-write operation 4500# failures. 4501# 4502# @break-guest-write: report the error to the guest. This way, the 4503# guest will not be able to overwrite areas that cannot be backed 4504# up, so the backup process remains valid. 4505# 4506# @break-snapshot: continue guest write. Doing so will make the 4507# provided snapshot state invalid and any backup or export process 4508# based on it will finally fail. 4509# 4510# Since: 7.1 4511## 4512{ 'enum': 'OnCbwError', 4513 'data': [ 'break-guest-write', 'break-snapshot' ] } 4514 4515## 4516# @BlockdevOptionsCbw: 4517# 4518# Driver specific block device options for the copy-before-write 4519# driver, which does so called copy-before-write operations: when data 4520# is written to the filter, the filter first reads corresponding 4521# blocks from its file child and copies them to @target child. After 4522# successfully copying, the write request is propagated to file child. 4523# If copying fails, the original write request is failed too and no 4524# data is written to file child. 4525# 4526# @target: The target for copy-before-write operations. 4527# 4528# @bitmap: If specified, copy-before-write filter will do 4529# copy-before-write operations only for dirty regions of the 4530# bitmap. Bitmap size must be equal to length of file and target 4531# child of the filter. Note also, that bitmap is used only to 4532# initialize internal bitmap of the process, so further 4533# modifications (or removing) of specified bitmap doesn't 4534# influence the filter. (Since 7.0) 4535# 4536# @on-cbw-error: Behavior on failure of copy-before-write operation. 4537# Default is @break-guest-write. (Since 7.1) 4538# 4539# @cbw-timeout: Zero means no limit. Non-zero sets the timeout in 4540# seconds for copy-before-write operation. When a timeout occurs, 4541# the respective copy-before-write operation will fail, and the 4542# @on-cbw-error parameter will decide how this failure is handled. 4543# Default 0. (Since 7.1) 4544# 4545# Since: 6.2 4546## 4547{ 'struct': 'BlockdevOptionsCbw', 4548 'base': 'BlockdevOptionsGenericFormat', 4549 'data': { 'target': 'BlockdevRef', '*bitmap': 'BlockDirtyBitmap', 4550 '*on-cbw-error': 'OnCbwError', '*cbw-timeout': 'uint32' } } 4551 4552## 4553# @BlockdevOptions: 4554# 4555# Options for creating a block device. Many options are available for 4556# all block devices, independent of the block driver: 4557# 4558# @driver: block driver name 4559# 4560# @node-name: the node name of the new node (Since 2.0). This option 4561# is required on the top level of blockdev-add. Valid node names 4562# start with an alphabetic character and may contain only 4563# alphanumeric characters, '-', '.' and '_'. Their maximum length 4564# is 31 characters. 4565# 4566# @discard: discard-related options (default: ignore) 4567# 4568# @cache: cache-related options 4569# 4570# @read-only: whether the block device should be read-only (default: 4571# false). Note that some block drivers support only read-only 4572# access, either generally or in certain configurations. In this 4573# case, the default value does not work and the option must be 4574# specified explicitly. 4575# 4576# @auto-read-only: if true and @read-only is false, QEMU may 4577# automatically decide not to open the image read-write as 4578# requested, but fall back to read-only instead (and switch 4579# between the modes later), e.g. depending on whether the image 4580# file is writable or whether a writing user is attached to the 4581# node (default: false, since 3.1) 4582# 4583# @detect-zeroes: detect and optimize zero writes (Since 2.1) 4584# (default: off) 4585# 4586# @force-share: force share all permission on added nodes. Requires 4587# read-only=true. (Since 2.10) 4588# 4589# Remaining options are determined by the block driver. 4590# 4591# Since: 2.9 4592## 4593{ 'union': 'BlockdevOptions', 4594 'base': { 'driver': 'BlockdevDriver', 4595 '*node-name': 'str', 4596 '*discard': 'BlockdevDiscardOptions', 4597 '*cache': 'BlockdevCacheOptions', 4598 '*read-only': 'bool', 4599 '*auto-read-only': 'bool', 4600 '*force-share': 'bool', 4601 '*detect-zeroes': 'BlockdevDetectZeroesOptions' }, 4602 'discriminator': 'driver', 4603 'data': { 4604 'blkdebug': 'BlockdevOptionsBlkdebug', 4605 'blklogwrites':'BlockdevOptionsBlklogwrites', 4606 'blkverify': 'BlockdevOptionsBlkverify', 4607 'blkreplay': 'BlockdevOptionsBlkreplay', 4608 'bochs': 'BlockdevOptionsGenericFormat', 4609 'cloop': 'BlockdevOptionsGenericFormat', 4610 'compress': 'BlockdevOptionsGenericFormat', 4611 'copy-before-write':'BlockdevOptionsCbw', 4612 'copy-on-read':'BlockdevOptionsCor', 4613 'dmg': 'BlockdevOptionsGenericFormat', 4614 'file': 'BlockdevOptionsFile', 4615 'ftp': 'BlockdevOptionsCurlFtp', 4616 'ftps': 'BlockdevOptionsCurlFtps', 4617 'gluster': 'BlockdevOptionsGluster', 4618 'host_cdrom': { 'type': 'BlockdevOptionsFile', 4619 'if': 'HAVE_HOST_BLOCK_DEVICE' }, 4620 'host_device': { 'type': 'BlockdevOptionsFile', 4621 'if': 'HAVE_HOST_BLOCK_DEVICE' }, 4622 'http': 'BlockdevOptionsCurlHttp', 4623 'https': 'BlockdevOptionsCurlHttps', 4624 'io_uring': { 'type': 'BlockdevOptionsIoUring', 4625 'if': 'CONFIG_BLKIO' }, 4626 'iscsi': 'BlockdevOptionsIscsi', 4627 'luks': 'BlockdevOptionsLUKS', 4628 'nbd': 'BlockdevOptionsNbd', 4629 'nfs': 'BlockdevOptionsNfs', 4630 'null-aio': 'BlockdevOptionsNull', 4631 'null-co': 'BlockdevOptionsNull', 4632 'nvme': 'BlockdevOptionsNVMe', 4633 'nvme-io_uring': { 'type': 'BlockdevOptionsNvmeIoUring', 4634 'if': 'CONFIG_BLKIO' }, 4635 'parallels': 'BlockdevOptionsGenericFormat', 4636 'preallocate':'BlockdevOptionsPreallocate', 4637 'qcow2': 'BlockdevOptionsQcow2', 4638 'qcow': 'BlockdevOptionsQcow', 4639 'qed': 'BlockdevOptionsGenericCOWFormat', 4640 'quorum': 'BlockdevOptionsQuorum', 4641 'raw': 'BlockdevOptionsRaw', 4642 'rbd': 'BlockdevOptionsRbd', 4643 'replication': { 'type': 'BlockdevOptionsReplication', 4644 'if': 'CONFIG_REPLICATION' }, 4645 'snapshot-access': 'BlockdevOptionsGenericFormat', 4646 'ssh': 'BlockdevOptionsSsh', 4647 'throttle': 'BlockdevOptionsThrottle', 4648 'vdi': 'BlockdevOptionsGenericFormat', 4649 'vhdx': 'BlockdevOptionsGenericFormat', 4650 'virtio-blk-vfio-pci': 4651 { 'type': 'BlockdevOptionsVirtioBlkVfioPci', 4652 'if': 'CONFIG_BLKIO' }, 4653 'virtio-blk-vhost-user': 4654 { 'type': 'BlockdevOptionsVirtioBlkVhostUser', 4655 'if': 'CONFIG_BLKIO' }, 4656 'virtio-blk-vhost-vdpa': 4657 { 'type': 'BlockdevOptionsVirtioBlkVhostVdpa', 4658 'if': 'CONFIG_BLKIO' }, 4659 'vmdk': 'BlockdevOptionsGenericCOWFormat', 4660 'vpc': 'BlockdevOptionsGenericFormat', 4661 'vvfat': 'BlockdevOptionsVVFAT' 4662 } } 4663 4664## 4665# @BlockdevRef: 4666# 4667# Reference to a block device. 4668# 4669# @definition: defines a new block device inline 4670# 4671# @reference: references the ID of an existing block device 4672# 4673# Since: 2.9 4674## 4675{ 'alternate': 'BlockdevRef', 4676 'data': { 'definition': 'BlockdevOptions', 4677 'reference': 'str' } } 4678 4679## 4680# @BlockdevRefOrNull: 4681# 4682# Reference to a block device. 4683# 4684# @definition: defines a new block device inline 4685# 4686# @reference: references the ID of an existing block device. An empty 4687# string means that no block device should be referenced. 4688# Deprecated; use null instead. 4689# 4690# @null: No block device should be referenced (since 2.10) 4691# 4692# Since: 2.9 4693## 4694{ 'alternate': 'BlockdevRefOrNull', 4695 'data': { 'definition': 'BlockdevOptions', 4696 'reference': 'str', 4697 'null': 'null' } } 4698 4699## 4700# @blockdev-add: 4701# 4702# Creates a new block device. 4703# 4704# Since: 2.9 4705# 4706# Examples: 4707# 4708# -> { "execute": "blockdev-add", 4709# "arguments": { 4710# "driver": "qcow2", 4711# "node-name": "test1", 4712# "file": { 4713# "driver": "file", 4714# "filename": "test.qcow2" 4715# } 4716# } 4717# } 4718# <- { "return": {} } 4719# 4720# -> { "execute": "blockdev-add", 4721# "arguments": { 4722# "driver": "qcow2", 4723# "node-name": "node0", 4724# "discard": "unmap", 4725# "cache": { 4726# "direct": true 4727# }, 4728# "file": { 4729# "driver": "file", 4730# "filename": "/tmp/test.qcow2" 4731# }, 4732# "backing": { 4733# "driver": "raw", 4734# "file": { 4735# "driver": "file", 4736# "filename": "/dev/fdset/4" 4737# } 4738# } 4739# } 4740# } 4741# 4742# <- { "return": {} } 4743## 4744{ 'command': 'blockdev-add', 'data': 'BlockdevOptions', 'boxed': true, 4745 'allow-preconfig': true } 4746 4747## 4748# @blockdev-reopen: 4749# 4750# Reopens one or more block devices using the given set of options. 4751# Any option not specified will be reset to its default value 4752# regardless of its previous status. If an option cannot be changed 4753# or a particular driver does not support reopening then the command 4754# will return an error. All devices in the list are reopened in one 4755# transaction, so if one of them fails then the whole transaction is 4756# cancelled. 4757# 4758# The command receives a list of block devices to reopen. For each 4759# one of them, the top-level @node-name option (from BlockdevOptions) 4760# must be specified and is used to select the block device to be 4761# reopened. Other @node-name options must be either omitted or set to 4762# the current name of the appropriate node. This command won't change 4763# any node name and any attempt to do it will result in an error. 4764# 4765# In the case of options that refer to child nodes, the behavior of 4766# this command depends on the value: 4767# 4768# 1) A set of options (BlockdevOptions): the child is reopened with 4769# the specified set of options. 4770# 4771# 2) A reference to the current child: the child is reopened using 4772# its existing set of options. 4773# 4774# 3) A reference to a different node: the current child is replaced 4775# with the specified one. 4776# 4777# 4) NULL: the current child (if any) is detached. 4778# 4779# Options (1) and (2) are supported in all cases. Option (3) is 4780# supported for @file and @backing, and option (4) for @backing only. 4781# 4782# Unlike with blockdev-add, the @backing option must always be present 4783# unless the node being reopened does not have a backing file and its 4784# image does not have a default backing file name as part of its 4785# metadata. 4786# 4787# Since: 6.1 4788## 4789{ 'command': 'blockdev-reopen', 4790 'data': { 'options': ['BlockdevOptions'] }, 4791 'allow-preconfig': true } 4792 4793## 4794# @blockdev-del: 4795# 4796# Deletes a block device that has been added using blockdev-add. The 4797# command will fail if the node is attached to a device or is 4798# otherwise being used. 4799# 4800# @node-name: Name of the graph node to delete. 4801# 4802# Since: 2.9 4803# 4804# Example: 4805# 4806# -> { "execute": "blockdev-add", 4807# "arguments": { 4808# "driver": "qcow2", 4809# "node-name": "node0", 4810# "file": { 4811# "driver": "file", 4812# "filename": "test.qcow2" 4813# } 4814# } 4815# } 4816# <- { "return": {} } 4817# 4818# -> { "execute": "blockdev-del", 4819# "arguments": { "node-name": "node0" } 4820# } 4821# <- { "return": {} } 4822## 4823{ 'command': 'blockdev-del', 'data': { 'node-name': 'str' }, 4824 'allow-preconfig': true } 4825 4826## 4827# @BlockdevCreateOptionsFile: 4828# 4829# Driver specific image creation options for file. 4830# 4831# @filename: Filename for the new image file 4832# 4833# @size: Size of the virtual disk in bytes 4834# 4835# @preallocation: Preallocation mode for the new image (default: off; 4836# allowed values: off, falloc (if CONFIG_POSIX_FALLOCATE), full 4837# (if CONFIG_POSIX)) 4838# 4839# @nocow: Turn off copy-on-write (valid only on btrfs; default: off) 4840# 4841# @extent-size-hint: Extent size hint to add to the image file; 0 for 4842# not adding an extent size hint (default: 1 MB, since 5.1) 4843# 4844# Since: 2.12 4845## 4846{ 'struct': 'BlockdevCreateOptionsFile', 4847 'data': { 'filename': 'str', 4848 'size': 'size', 4849 '*preallocation': 'PreallocMode', 4850 '*nocow': 'bool', 4851 '*extent-size-hint': 'size'} } 4852 4853## 4854# @BlockdevCreateOptionsGluster: 4855# 4856# Driver specific image creation options for gluster. 4857# 4858# @location: Where to store the new image file 4859# 4860# @size: Size of the virtual disk in bytes 4861# 4862# @preallocation: Preallocation mode for the new image (default: off; 4863# allowed values: off, falloc (if CONFIG_GLUSTERFS_FALLOCATE), 4864# full (if CONFIG_GLUSTERFS_ZEROFILL)) 4865# 4866# Since: 2.12 4867## 4868{ 'struct': 'BlockdevCreateOptionsGluster', 4869 'data': { 'location': 'BlockdevOptionsGluster', 4870 'size': 'size', 4871 '*preallocation': 'PreallocMode' } } 4872 4873## 4874# @BlockdevCreateOptionsLUKS: 4875# 4876# Driver specific image creation options for LUKS. 4877# 4878# @file: Node to create the image format on 4879# 4880# @size: Size of the virtual disk in bytes 4881# 4882# @preallocation: Preallocation mode for the new image (since: 4.2) 4883# (default: off; allowed values: off, metadata, falloc, full) 4884# 4885# Since: 2.12 4886## 4887{ 'struct': 'BlockdevCreateOptionsLUKS', 4888 'base': 'QCryptoBlockCreateOptionsLUKS', 4889 'data': { 'file': 'BlockdevRef', 4890 'size': 'size', 4891 '*preallocation': 'PreallocMode' } } 4892 4893## 4894# @BlockdevCreateOptionsNfs: 4895# 4896# Driver specific image creation options for NFS. 4897# 4898# @location: Where to store the new image file 4899# 4900# @size: Size of the virtual disk in bytes 4901# 4902# Since: 2.12 4903## 4904{ 'struct': 'BlockdevCreateOptionsNfs', 4905 'data': { 'location': 'BlockdevOptionsNfs', 4906 'size': 'size' } } 4907 4908## 4909# @BlockdevCreateOptionsParallels: 4910# 4911# Driver specific image creation options for parallels. 4912# 4913# @file: Node to create the image format on 4914# 4915# @size: Size of the virtual disk in bytes 4916# 4917# @cluster-size: Cluster size in bytes (default: 1 MB) 4918# 4919# Since: 2.12 4920## 4921{ 'struct': 'BlockdevCreateOptionsParallels', 4922 'data': { 'file': 'BlockdevRef', 4923 'size': 'size', 4924 '*cluster-size': 'size' } } 4925 4926## 4927# @BlockdevCreateOptionsQcow: 4928# 4929# Driver specific image creation options for qcow. 4930# 4931# @file: Node to create the image format on 4932# 4933# @size: Size of the virtual disk in bytes 4934# 4935# @backing-file: File name of the backing file if a backing file 4936# should be used 4937# 4938# @encrypt: Encryption options if the image should be encrypted 4939# 4940# Since: 2.12 4941## 4942{ 'struct': 'BlockdevCreateOptionsQcow', 4943 'data': { 'file': 'BlockdevRef', 4944 'size': 'size', 4945 '*backing-file': 'str', 4946 '*encrypt': 'QCryptoBlockCreateOptions' } } 4947 4948## 4949# @BlockdevQcow2Version: 4950# 4951# @v2: The original QCOW2 format as introduced in qemu 0.10 (version 4952# 2) 4953# 4954# @v3: The extended QCOW2 format as introduced in qemu 1.1 (version 3) 4955# 4956# Since: 2.12 4957## 4958{ 'enum': 'BlockdevQcow2Version', 4959 'data': [ 'v2', 'v3' ] } 4960 4961## 4962# @Qcow2CompressionType: 4963# 4964# Compression type used in qcow2 image file 4965# 4966# @zlib: zlib compression, see <http://zlib.net/> 4967# 4968# @zstd: zstd compression, see <http://github.com/facebook/zstd> 4969# 4970# Since: 5.1 4971## 4972{ 'enum': 'Qcow2CompressionType', 4973 'data': [ 'zlib', { 'name': 'zstd', 'if': 'CONFIG_ZSTD' } ] } 4974 4975## 4976# @BlockdevCreateOptionsQcow2: 4977# 4978# Driver specific image creation options for qcow2. 4979# 4980# @file: Node to create the image format on 4981# 4982# @data-file: Node to use as an external data file in which all guest 4983# data is stored so that only metadata remains in the qcow2 file 4984# (since: 4.0) 4985# 4986# @data-file-raw: True if the external data file must stay valid as a 4987# standalone (read-only) raw image without looking at qcow2 4988# metadata (default: false; since: 4.0) 4989# 4990# @extended-l2: True to make the image have extended L2 entries 4991# (default: false; since 5.2) 4992# 4993# @size: Size of the virtual disk in bytes 4994# 4995# @version: Compatibility level (default: v3) 4996# 4997# @backing-file: File name of the backing file if a backing file 4998# should be used 4999# 5000# @backing-fmt: Name of the block driver to use for the backing file 5001# 5002# @encrypt: Encryption options if the image should be encrypted 5003# 5004# @cluster-size: qcow2 cluster size in bytes (default: 65536) 5005# 5006# @preallocation: Preallocation mode for the new image (default: off; 5007# allowed values: off, falloc, full, metadata) 5008# 5009# @lazy-refcounts: True if refcounts may be updated lazily 5010# (default: off) 5011# 5012# @refcount-bits: Width of reference counts in bits (default: 16) 5013# 5014# @compression-type: The image cluster compression method 5015# (default: zlib, since 5.1) 5016# 5017# Since: 2.12 5018## 5019{ 'struct': 'BlockdevCreateOptionsQcow2', 5020 'data': { 'file': 'BlockdevRef', 5021 '*data-file': 'BlockdevRef', 5022 '*data-file-raw': 'bool', 5023 '*extended-l2': 'bool', 5024 'size': 'size', 5025 '*version': 'BlockdevQcow2Version', 5026 '*backing-file': 'str', 5027 '*backing-fmt': 'BlockdevDriver', 5028 '*encrypt': 'QCryptoBlockCreateOptions', 5029 '*cluster-size': 'size', 5030 '*preallocation': 'PreallocMode', 5031 '*lazy-refcounts': 'bool', 5032 '*refcount-bits': 'int', 5033 '*compression-type':'Qcow2CompressionType' } } 5034 5035## 5036# @BlockdevCreateOptionsQed: 5037# 5038# Driver specific image creation options for qed. 5039# 5040# @file: Node to create the image format on 5041# 5042# @size: Size of the virtual disk in bytes 5043# 5044# @backing-file: File name of the backing file if a backing file 5045# should be used 5046# 5047# @backing-fmt: Name of the block driver to use for the backing file 5048# 5049# @cluster-size: Cluster size in bytes (default: 65536) 5050# 5051# @table-size: L1/L2 table size (in clusters) 5052# 5053# Since: 2.12 5054## 5055{ 'struct': 'BlockdevCreateOptionsQed', 5056 'data': { 'file': 'BlockdevRef', 5057 'size': 'size', 5058 '*backing-file': 'str', 5059 '*backing-fmt': 'BlockdevDriver', 5060 '*cluster-size': 'size', 5061 '*table-size': 'int' } } 5062 5063## 5064# @BlockdevCreateOptionsRbd: 5065# 5066# Driver specific image creation options for rbd/Ceph. 5067# 5068# @location: Where to store the new image file. This location cannot 5069# point to a snapshot. 5070# 5071# @size: Size of the virtual disk in bytes 5072# 5073# @cluster-size: RBD object size 5074# 5075# @encrypt: Image encryption options. (Since 6.1) 5076# 5077# Since: 2.12 5078## 5079{ 'struct': 'BlockdevCreateOptionsRbd', 5080 'data': { 'location': 'BlockdevOptionsRbd', 5081 'size': 'size', 5082 '*cluster-size' : 'size', 5083 '*encrypt' : 'RbdEncryptionCreateOptions' } } 5084 5085## 5086# @BlockdevVmdkSubformat: 5087# 5088# Subformat options for VMDK images 5089# 5090# @monolithicSparse: Single file image with sparse cluster allocation 5091# 5092# @monolithicFlat: Single flat data image and a descriptor file 5093# 5094# @twoGbMaxExtentSparse: Data is split into 2GB (per virtual LBA) 5095# sparse extent files, in addition to a descriptor file 5096# 5097# @twoGbMaxExtentFlat: Data is split into 2GB (per virtual LBA) flat 5098# extent files, in addition to a descriptor file 5099# 5100# @streamOptimized: Single file image sparse cluster allocation, 5101# optimized for streaming over network. 5102# 5103# Since: 4.0 5104## 5105{ 'enum': 'BlockdevVmdkSubformat', 5106 'data': [ 'monolithicSparse', 'monolithicFlat', 'twoGbMaxExtentSparse', 5107 'twoGbMaxExtentFlat', 'streamOptimized'] } 5108 5109## 5110# @BlockdevVmdkAdapterType: 5111# 5112# Adapter type info for VMDK images 5113# 5114# Since: 4.0 5115## 5116{ 'enum': 'BlockdevVmdkAdapterType', 5117 'data': [ 'ide', 'buslogic', 'lsilogic', 'legacyESX'] } 5118 5119## 5120# @BlockdevCreateOptionsVmdk: 5121# 5122# Driver specific image creation options for VMDK. 5123# 5124# @file: Where to store the new image file. This refers to the image 5125# file for monolithcSparse and streamOptimized format, or the 5126# descriptor file for other formats. 5127# 5128# @size: Size of the virtual disk in bytes 5129# 5130# @extents: Where to store the data extents. Required for 5131# monolithcFlat, twoGbMaxExtentSparse and twoGbMaxExtentFlat 5132# formats. For monolithicFlat, only one entry is required; for 5133# twoGbMaxExtent* formats, the number of entries required is 5134# calculated as extent_number = virtual_size / 2GB. Providing more 5135# extents than will be used is an error. 5136# 5137# @subformat: The subformat of the VMDK image. Default: 5138# "monolithicSparse". 5139# 5140# @backing-file: The path of backing file. Default: no backing file 5141# is used. 5142# 5143# @adapter-type: The adapter type used to fill in the descriptor. 5144# Default: ide. 5145# 5146# @hwversion: Hardware version. The meaningful options are "4" or 5147# "6". Default: "4". 5148# 5149# @toolsversion: VMware guest tools version. Default: "2147483647" 5150# (Since 6.2) 5151# 5152# @zeroed-grain: Whether to enable zeroed-grain feature for sparse 5153# subformats. Default: false. 5154# 5155# Since: 4.0 5156## 5157{ 'struct': 'BlockdevCreateOptionsVmdk', 5158 'data': { 'file': 'BlockdevRef', 5159 'size': 'size', 5160 '*extents': ['BlockdevRef'], 5161 '*subformat': 'BlockdevVmdkSubformat', 5162 '*backing-file': 'str', 5163 '*adapter-type': 'BlockdevVmdkAdapterType', 5164 '*hwversion': 'str', 5165 '*toolsversion': 'str', 5166 '*zeroed-grain': 'bool' } } 5167 5168## 5169# @BlockdevCreateOptionsSsh: 5170# 5171# Driver specific image creation options for SSH. 5172# 5173# @location: Where to store the new image file 5174# 5175# @size: Size of the virtual disk in bytes 5176# 5177# Since: 2.12 5178## 5179{ 'struct': 'BlockdevCreateOptionsSsh', 5180 'data': { 'location': 'BlockdevOptionsSsh', 5181 'size': 'size' } } 5182 5183## 5184# @BlockdevCreateOptionsVdi: 5185# 5186# Driver specific image creation options for VDI. 5187# 5188# @file: Node to create the image format on 5189# 5190# @size: Size of the virtual disk in bytes 5191# 5192# @preallocation: Preallocation mode for the new image (default: off; 5193# allowed values: off, metadata) 5194# 5195# Since: 2.12 5196## 5197{ 'struct': 'BlockdevCreateOptionsVdi', 5198 'data': { 'file': 'BlockdevRef', 5199 'size': 'size', 5200 '*preallocation': 'PreallocMode' } } 5201 5202## 5203# @BlockdevVhdxSubformat: 5204# 5205# @dynamic: Growing image file 5206# 5207# @fixed: Preallocated fixed-size image file 5208# 5209# Since: 2.12 5210## 5211{ 'enum': 'BlockdevVhdxSubformat', 5212 'data': [ 'dynamic', 'fixed' ] } 5213 5214## 5215# @BlockdevCreateOptionsVhdx: 5216# 5217# Driver specific image creation options for vhdx. 5218# 5219# @file: Node to create the image format on 5220# 5221# @size: Size of the virtual disk in bytes 5222# 5223# @log-size: Log size in bytes, must be a multiple of 1 MB (default: 1 5224# MB) 5225# 5226# @block-size: Block size in bytes, must be a multiple of 1 MB and not 5227# larger than 256 MB (default: automatically choose a block size 5228# depending on the image size) 5229# 5230# @subformat: vhdx subformat (default: dynamic) 5231# 5232# @block-state-zero: Force use of payload blocks of type 5233# 'ZERO'. Non-standard, but default. Do not set to 'off' when 5234# using 'qemu-img convert' with subformat=dynamic. 5235# 5236# Since: 2.12 5237## 5238{ 'struct': 'BlockdevCreateOptionsVhdx', 5239 'data': { 'file': 'BlockdevRef', 5240 'size': 'size', 5241 '*log-size': 'size', 5242 '*block-size': 'size', 5243 '*subformat': 'BlockdevVhdxSubformat', 5244 '*block-state-zero': 'bool' } } 5245 5246## 5247# @BlockdevVpcSubformat: 5248# 5249# @dynamic: Growing image file 5250# 5251# @fixed: Preallocated fixed-size image file 5252# 5253# Since: 2.12 5254## 5255{ 'enum': 'BlockdevVpcSubformat', 5256 'data': [ 'dynamic', 'fixed' ] } 5257 5258## 5259# @BlockdevCreateOptionsVpc: 5260# 5261# Driver specific image creation options for vpc (VHD). 5262# 5263# @file: Node to create the image format on 5264# 5265# @size: Size of the virtual disk in bytes 5266# 5267# @subformat: vhdx subformat (default: dynamic) 5268# 5269# @force-size: Force use of the exact byte size instead of rounding to 5270# the next size that can be represented in CHS geometry 5271# (default: false) 5272# 5273# Since: 2.12 5274## 5275{ 'struct': 'BlockdevCreateOptionsVpc', 5276 'data': { 'file': 'BlockdevRef', 5277 'size': 'size', 5278 '*subformat': 'BlockdevVpcSubformat', 5279 '*force-size': 'bool' } } 5280 5281## 5282# @BlockdevCreateOptions: 5283# 5284# Options for creating an image format on a given node. 5285# 5286# @driver: block driver to create the image format 5287# 5288# Since: 2.12 5289## 5290{ 'union': 'BlockdevCreateOptions', 5291 'base': { 5292 'driver': 'BlockdevDriver' }, 5293 'discriminator': 'driver', 5294 'data': { 5295 'file': 'BlockdevCreateOptionsFile', 5296 'gluster': 'BlockdevCreateOptionsGluster', 5297 'luks': 'BlockdevCreateOptionsLUKS', 5298 'nfs': 'BlockdevCreateOptionsNfs', 5299 'parallels': 'BlockdevCreateOptionsParallels', 5300 'qcow': 'BlockdevCreateOptionsQcow', 5301 'qcow2': 'BlockdevCreateOptionsQcow2', 5302 'qed': 'BlockdevCreateOptionsQed', 5303 'rbd': 'BlockdevCreateOptionsRbd', 5304 'ssh': 'BlockdevCreateOptionsSsh', 5305 'vdi': 'BlockdevCreateOptionsVdi', 5306 'vhdx': 'BlockdevCreateOptionsVhdx', 5307 'vmdk': 'BlockdevCreateOptionsVmdk', 5308 'vpc': 'BlockdevCreateOptionsVpc' 5309 } } 5310 5311## 5312# @blockdev-create: 5313# 5314# Starts a job to create an image format on a given node. The job is 5315# automatically finalized, but a manual job-dismiss is required. 5316# 5317# @job-id: Identifier for the newly created job. 5318# 5319# @options: Options for the image creation. 5320# 5321# Since: 3.0 5322## 5323{ 'command': 'blockdev-create', 5324 'data': { 'job-id': 'str', 5325 'options': 'BlockdevCreateOptions' }, 5326 'allow-preconfig': true } 5327 5328## 5329# @BlockdevAmendOptionsLUKS: 5330# 5331# Driver specific image amend options for LUKS. 5332# 5333# Since: 5.1 5334## 5335{ 'struct': 'BlockdevAmendOptionsLUKS', 5336 'base': 'QCryptoBlockAmendOptionsLUKS', 5337 'data': { } 5338} 5339 5340## 5341# @BlockdevAmendOptionsQcow2: 5342# 5343# Driver specific image amend options for qcow2. For now, only 5344# encryption options can be amended 5345# 5346# @encrypt: Encryption options to be amended 5347# 5348# Since: 5.1 5349## 5350{ 'struct': 'BlockdevAmendOptionsQcow2', 5351 'data': { '*encrypt': 'QCryptoBlockAmendOptions' } } 5352 5353## 5354# @BlockdevAmendOptions: 5355# 5356# Options for amending an image format 5357# 5358# @driver: Block driver of the node to amend. 5359# 5360# Since: 5.1 5361## 5362{ 'union': 'BlockdevAmendOptions', 5363 'base': { 5364 'driver': 'BlockdevDriver' }, 5365 'discriminator': 'driver', 5366 'data': { 5367 'luks': 'BlockdevAmendOptionsLUKS', 5368 'qcow2': 'BlockdevAmendOptionsQcow2' } } 5369 5370## 5371# @x-blockdev-amend: 5372# 5373# Starts a job to amend format specific options of an existing open 5374# block device The job is automatically finalized, but a manual 5375# job-dismiss is required. 5376# 5377# @job-id: Identifier for the newly created job. 5378# 5379# @node-name: Name of the block node to work on 5380# 5381# @options: Options (driver specific) 5382# 5383# @force: Allow unsafe operations, format specific For luks that 5384# allows erase of the last active keyslot (permanent loss of 5385# data), and replacement of an active keyslot (possible loss of 5386# data if IO error happens) 5387# 5388# Features: 5389# 5390# @unstable: This command is experimental. 5391# 5392# Since: 5.1 5393## 5394{ 'command': 'x-blockdev-amend', 5395 'data': { 'job-id': 'str', 5396 'node-name': 'str', 5397 'options': 'BlockdevAmendOptions', 5398 '*force': 'bool' }, 5399 'features': [ 'unstable' ], 5400 'allow-preconfig': true } 5401 5402## 5403# @BlockErrorAction: 5404# 5405# An enumeration of action that has been taken when a DISK I/O occurs 5406# 5407# @ignore: error has been ignored 5408# 5409# @report: error has been reported to the device 5410# 5411# @stop: error caused VM to be stopped 5412# 5413# Since: 2.1 5414## 5415{ 'enum': 'BlockErrorAction', 5416 'data': [ 'ignore', 'report', 'stop' ] } 5417 5418## 5419# @BLOCK_IMAGE_CORRUPTED: 5420# 5421# Emitted when a disk image is being marked corrupt. The image can be 5422# identified by its device or node name. The 'device' field is always 5423# present for compatibility reasons, but it can be empty ("") if the 5424# image does not have a device name associated. 5425# 5426# @device: device name. This is always present for compatibility 5427# reasons, but it can be empty ("") if the image does not have a 5428# device name associated. 5429# 5430# @node-name: node name (Since: 2.4) 5431# 5432# @msg: informative message for human consumption, such as the kind of 5433# corruption being detected. It should not be parsed by machine 5434# as it is not guaranteed to be stable 5435# 5436# @offset: if the corruption resulted from an image access, this is 5437# the host's access offset into the image 5438# 5439# @size: if the corruption resulted from an image access, this is the 5440# access size 5441# 5442# @fatal: if set, the image is marked corrupt and therefore unusable 5443# after this event and must be repaired (Since 2.2; before, every 5444# BLOCK_IMAGE_CORRUPTED event was fatal) 5445# 5446# Note: If action is "stop", a STOP event will eventually follow the 5447# BLOCK_IO_ERROR event. 5448# 5449# Example: 5450# 5451# <- { "event": "BLOCK_IMAGE_CORRUPTED", 5452# "data": { "device": "", "node-name": "drive", "fatal": false, 5453# "msg": "L2 table offset 0x2a2a2a00 unaligned (L1 index: 0)" }, 5454# "timestamp": { "seconds": 1648243240, "microseconds": 906060 } } 5455# 5456# Since: 1.7 5457## 5458{ 'event': 'BLOCK_IMAGE_CORRUPTED', 5459 'data': { 'device' : 'str', 5460 '*node-name' : 'str', 5461 'msg' : 'str', 5462 '*offset' : 'int', 5463 '*size' : 'int', 5464 'fatal' : 'bool' } } 5465 5466## 5467# @BLOCK_IO_ERROR: 5468# 5469# Emitted when a disk I/O error occurs 5470# 5471# @device: device name. This is always present for compatibility 5472# reasons, but it can be empty ("") if the image does not have a 5473# device name associated. 5474# 5475# @node-name: node name. Note that errors may be reported for the 5476# root node that is directly attached to a guest device rather 5477# than for the node where the error occurred. The node name is 5478# not present if the drive is empty. (Since: 2.8) 5479# 5480# @operation: I/O operation 5481# 5482# @action: action that has been taken 5483# 5484# @nospace: true if I/O error was caused due to a no-space condition. 5485# This key is only present if query-block's io-status is present, 5486# please see query-block documentation for more information 5487# (since: 2.2) 5488# 5489# @reason: human readable string describing the error cause. (This 5490# field is a debugging aid for humans, it should not be parsed by 5491# applications) (since: 2.2) 5492# 5493# Note: If action is "stop", a STOP event will eventually follow the 5494# BLOCK_IO_ERROR event 5495# 5496# Since: 0.13 5497# 5498# Example: 5499# 5500# <- { "event": "BLOCK_IO_ERROR", 5501# "data": { "device": "ide0-hd1", 5502# "node-name": "#block212", 5503# "operation": "write", 5504# "action": "stop", 5505# "reason": "No space left on device" }, 5506# "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } 5507## 5508{ 'event': 'BLOCK_IO_ERROR', 5509 'data': { 'device': 'str', '*node-name': 'str', 5510 'operation': 'IoOperationType', 5511 'action': 'BlockErrorAction', '*nospace': 'bool', 5512 'reason': 'str' } } 5513 5514## 5515# @BLOCK_JOB_COMPLETED: 5516# 5517# Emitted when a block job has completed 5518# 5519# @type: job type 5520# 5521# @device: The job identifier. Originally the device name but other 5522# values are allowed since QEMU 2.7 5523# 5524# @len: maximum progress value 5525# 5526# @offset: current progress value. On success this is equal to len. 5527# On failure this is less than len 5528# 5529# @speed: rate limit, bytes per second 5530# 5531# @error: error message. Only present on failure. This field 5532# contains a human-readable error message. There are no semantics 5533# other than that streaming has failed and clients should not try 5534# to interpret the error string 5535# 5536# Since: 1.1 5537# 5538# Example: 5539# 5540# <- { "event": "BLOCK_JOB_COMPLETED", 5541# "data": { "type": "stream", "device": "virtio-disk0", 5542# "len": 10737418240, "offset": 10737418240, 5543# "speed": 0 }, 5544# "timestamp": { "seconds": 1267061043, "microseconds": 959568 } } 5545## 5546{ 'event': 'BLOCK_JOB_COMPLETED', 5547 'data': { 'type' : 'JobType', 5548 'device': 'str', 5549 'len' : 'int', 5550 'offset': 'int', 5551 'speed' : 'int', 5552 '*error': 'str' } } 5553 5554## 5555# @BLOCK_JOB_CANCELLED: 5556# 5557# Emitted when a block job has been cancelled 5558# 5559# @type: job type 5560# 5561# @device: The job identifier. Originally the device name but other 5562# values are allowed since QEMU 2.7 5563# 5564# @len: maximum progress value 5565# 5566# @offset: current progress value. On success this is equal to len. 5567# On failure this is less than len 5568# 5569# @speed: rate limit, bytes per second 5570# 5571# Since: 1.1 5572# 5573# Example: 5574# 5575# <- { "event": "BLOCK_JOB_CANCELLED", 5576# "data": { "type": "stream", "device": "virtio-disk0", 5577# "len": 10737418240, "offset": 134217728, 5578# "speed": 0 }, 5579# "timestamp": { "seconds": 1267061043, "microseconds": 959568 } } 5580## 5581{ 'event': 'BLOCK_JOB_CANCELLED', 5582 'data': { 'type' : 'JobType', 5583 'device': 'str', 5584 'len' : 'int', 5585 'offset': 'int', 5586 'speed' : 'int' } } 5587 5588## 5589# @BLOCK_JOB_ERROR: 5590# 5591# Emitted when a block job encounters an error 5592# 5593# @device: The job identifier. Originally the device name but other 5594# values are allowed since QEMU 2.7 5595# 5596# @operation: I/O operation 5597# 5598# @action: action that has been taken 5599# 5600# Since: 1.3 5601# 5602# Example: 5603# 5604# <- { "event": "BLOCK_JOB_ERROR", 5605# "data": { "device": "ide0-hd1", 5606# "operation": "write", 5607# "action": "stop" }, 5608# "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } 5609## 5610{ 'event': 'BLOCK_JOB_ERROR', 5611 'data': { 'device' : 'str', 5612 'operation': 'IoOperationType', 5613 'action' : 'BlockErrorAction' } } 5614 5615## 5616# @BLOCK_JOB_READY: 5617# 5618# Emitted when a block job is ready to complete 5619# 5620# @type: job type 5621# 5622# @device: The job identifier. Originally the device name but other 5623# values are allowed since QEMU 2.7 5624# 5625# @len: maximum progress value 5626# 5627# @offset: current progress value. On success this is equal to len. 5628# On failure this is less than len 5629# 5630# @speed: rate limit, bytes per second 5631# 5632# Note: The "ready to complete" status is always reset by a 5633# @BLOCK_JOB_ERROR event 5634# 5635# Since: 1.3 5636# 5637# Example: 5638# 5639# <- { "event": "BLOCK_JOB_READY", 5640# "data": { "device": "drive0", "type": "mirror", "speed": 0, 5641# "len": 2097152, "offset": 2097152 }, 5642# "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } 5643## 5644{ 'event': 'BLOCK_JOB_READY', 5645 'data': { 'type' : 'JobType', 5646 'device': 'str', 5647 'len' : 'int', 5648 'offset': 'int', 5649 'speed' : 'int' } } 5650 5651## 5652# @BLOCK_JOB_PENDING: 5653# 5654# Emitted when a block job is awaiting explicit authorization to 5655# finalize graph changes via @block-job-finalize. If this job is part 5656# of a transaction, it will not emit this event until the transaction 5657# has converged first. 5658# 5659# @type: job type 5660# 5661# @id: The job identifier. 5662# 5663# Since: 2.12 5664# 5665# Example: 5666# 5667# <- { "event": "BLOCK_JOB_PENDING", 5668# "data": { "type": "mirror", "id": "backup_1" }, 5669# "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } 5670## 5671{ 'event': 'BLOCK_JOB_PENDING', 5672 'data': { 'type' : 'JobType', 5673 'id' : 'str' } } 5674 5675## 5676# @PreallocMode: 5677# 5678# Preallocation mode of QEMU image file 5679# 5680# @off: no preallocation 5681# 5682# @metadata: preallocate only for metadata 5683# 5684# @falloc: like @full preallocation but allocate disk space by 5685# posix_fallocate() rather than writing data. 5686# 5687# @full: preallocate all data by writing it to the device to ensure 5688# disk space is really available. This data may or may not be 5689# zero, depending on the image format and storage. @full 5690# preallocation also sets up metadata correctly. 5691# 5692# Since: 2.2 5693## 5694{ 'enum': 'PreallocMode', 5695 'data': [ 'off', 'metadata', 'falloc', 'full' ] } 5696 5697## 5698# @BLOCK_WRITE_THRESHOLD: 5699# 5700# Emitted when writes on block device reaches or exceeds the 5701# configured write threshold. For thin-provisioned devices, this 5702# means the device should be extended to avoid pausing for disk 5703# exhaustion. The event is one shot. Once triggered, it needs to be 5704# re-registered with another block-set-write-threshold command. 5705# 5706# @node-name: graph node name on which the threshold was exceeded. 5707# 5708# @amount-exceeded: amount of data which exceeded the threshold, in 5709# bytes. 5710# 5711# @write-threshold: last configured threshold, in bytes. 5712# 5713# Since: 2.3 5714## 5715{ 'event': 'BLOCK_WRITE_THRESHOLD', 5716 'data': { 'node-name': 'str', 5717 'amount-exceeded': 'uint64', 5718 'write-threshold': 'uint64' } } 5719 5720## 5721# @block-set-write-threshold: 5722# 5723# Change the write threshold for a block drive. An event will be 5724# delivered if a write to this block drive crosses the configured 5725# threshold. The threshold is an offset, thus must be non-negative. 5726# Default is no write threshold. Setting the threshold to zero 5727# disables it. 5728# 5729# This is useful to transparently resize thin-provisioned drives 5730# without the guest OS noticing. 5731# 5732# @node-name: graph node name on which the threshold must be set. 5733# 5734# @write-threshold: configured threshold for the block device, bytes. 5735# Use 0 to disable the threshold. 5736# 5737# Since: 2.3 5738# 5739# Example: 5740# 5741# -> { "execute": "block-set-write-threshold", 5742# "arguments": { "node-name": "mydev", 5743# "write-threshold": 17179869184 } } 5744# <- { "return": {} } 5745## 5746{ 'command': 'block-set-write-threshold', 5747 'data': { 'node-name': 'str', 'write-threshold': 'uint64' }, 5748 'allow-preconfig': true } 5749 5750## 5751# @x-blockdev-change: 5752# 5753# Dynamically reconfigure the block driver state graph. It can be 5754# used to add, remove, insert or replace a graph node. Currently only 5755# the Quorum driver implements this feature to add or remove its 5756# child. This is useful to fix a broken quorum child. 5757# 5758# If @node is specified, it will be inserted under @parent. @child 5759# may not be specified in this case. If both @parent and @child are 5760# specified but @node is not, @child will be detached from @parent. 5761# 5762# @parent: the id or name of the parent node. 5763# 5764# @child: the name of a child under the given parent node. 5765# 5766# @node: the name of the node that will be added. 5767# 5768# Features: 5769# 5770# @unstable: This command is experimental, and its API is not stable. 5771# It does not support all kinds of operations, all kinds of 5772# children, nor all block drivers. 5773# 5774# FIXME Removing children from a quorum node means introducing 5775# gaps in the child indices. This cannot be represented in the 5776# 'children' list of BlockdevOptionsQuorum, as returned by 5777# .bdrv_refresh_filename(). 5778# 5779# Warning: The data in a new quorum child MUST be consistent with 5780# that of the rest of the array. 5781# 5782# Since: 2.7 5783# 5784# Examples: 5785# 5786# 1. Add a new node to a quorum 5787# 5788# -> { "execute": "blockdev-add", 5789# "arguments": { 5790# "driver": "raw", 5791# "node-name": "new_node", 5792# "file": { "driver": "file", 5793# "filename": "test.raw" } } } 5794# <- { "return": {} } 5795# -> { "execute": "x-blockdev-change", 5796# "arguments": { "parent": "disk1", 5797# "node": "new_node" } } 5798# <- { "return": {} } 5799# 5800# 2. Delete a quorum's node 5801# 5802# -> { "execute": "x-blockdev-change", 5803# "arguments": { "parent": "disk1", 5804# "child": "children.1" } } 5805# <- { "return": {} } 5806## 5807{ 'command': 'x-blockdev-change', 5808 'data' : { 'parent': 'str', 5809 '*child': 'str', 5810 '*node': 'str' }, 5811 'features': [ 'unstable' ], 5812 'allow-preconfig': true } 5813 5814## 5815# @x-blockdev-set-iothread: 5816# 5817# Move @node and its children into the @iothread. If @iothread is 5818# null then move @node and its children into the main loop. 5819# 5820# The node must not be attached to a BlockBackend. 5821# 5822# @node-name: the name of the block driver node 5823# 5824# @iothread: the name of the IOThread object or null for the main loop 5825# 5826# @force: true if the node and its children should be moved when a 5827# BlockBackend is already attached 5828# 5829# Features: 5830# 5831# @unstable: This command is experimental and intended for test cases 5832# that need control over IOThreads only. 5833# 5834# Since: 2.12 5835# 5836# Examples: 5837# 5838# 1. Move a node into an IOThread 5839# 5840# -> { "execute": "x-blockdev-set-iothread", 5841# "arguments": { "node-name": "disk1", 5842# "iothread": "iothread0" } } 5843# <- { "return": {} } 5844# 5845# 2. Move a node into the main loop 5846# 5847# -> { "execute": "x-blockdev-set-iothread", 5848# "arguments": { "node-name": "disk1", 5849# "iothread": null } } 5850# <- { "return": {} } 5851## 5852{ 'command': 'x-blockdev-set-iothread', 5853 'data' : { 'node-name': 'str', 5854 'iothread': 'StrOrNull', 5855 '*force': 'bool' }, 5856 'features': [ 'unstable' ], 5857 'allow-preconfig': true } 5858 5859## 5860# @QuorumOpType: 5861# 5862# An enumeration of the quorum operation types 5863# 5864# @read: read operation 5865# 5866# @write: write operation 5867# 5868# @flush: flush operation 5869# 5870# Since: 2.6 5871## 5872{ 'enum': 'QuorumOpType', 5873 'data': [ 'read', 'write', 'flush' ] } 5874 5875## 5876# @QUORUM_FAILURE: 5877# 5878# Emitted by the Quorum block driver if it fails to establish a quorum 5879# 5880# @reference: device name if defined else node name 5881# 5882# @sector-num: number of the first sector of the failed read operation 5883# 5884# @sectors-count: failed read operation sector count 5885# 5886# Note: This event is rate-limited. 5887# 5888# Since: 2.0 5889# 5890# Example: 5891# 5892# <- { "event": "QUORUM_FAILURE", 5893# "data": { "reference": "usr1", "sector-num": 345435, "sectors-count": 5 }, 5894# "timestamp": { "seconds": 1344522075, "microseconds": 745528 } } 5895## 5896{ 'event': 'QUORUM_FAILURE', 5897 'data': { 'reference': 'str', 'sector-num': 'int', 'sectors-count': 'int' } } 5898 5899## 5900# @QUORUM_REPORT_BAD: 5901# 5902# Emitted to report a corruption of a Quorum file 5903# 5904# @type: quorum operation type (Since 2.6) 5905# 5906# @error: error message. Only present on failure. This field 5907# contains a human-readable error message. There are no semantics 5908# other than that the block layer reported an error and clients 5909# should not try to interpret the error string. 5910# 5911# @node-name: the graph node name of the block driver state 5912# 5913# @sector-num: number of the first sector of the failed read operation 5914# 5915# @sectors-count: failed read operation sector count 5916# 5917# Note: This event is rate-limited. 5918# 5919# Since: 2.0 5920# 5921# Examples: 5922# 5923# 1. Read operation 5924# 5925# <- { "event": "QUORUM_REPORT_BAD", 5926# "data": { "node-name": "node0", "sector-num": 345435, "sectors-count": 5, 5927# "type": "read" }, 5928# "timestamp": { "seconds": 1344522075, "microseconds": 745528 } } 5929# 5930# 2. Flush operation 5931# 5932# <- { "event": "QUORUM_REPORT_BAD", 5933# "data": { "node-name": "node0", "sector-num": 0, "sectors-count": 2097120, 5934# "type": "flush", "error": "Broken pipe" }, 5935# "timestamp": { "seconds": 1456406829, "microseconds": 291763 } } 5936## 5937{ 'event': 'QUORUM_REPORT_BAD', 5938 'data': { 'type': 'QuorumOpType', '*error': 'str', 'node-name': 'str', 5939 'sector-num': 'int', 'sectors-count': 'int' } } 5940 5941## 5942# @BlockdevSnapshotInternal: 5943# 5944# @device: the device name or node-name of a root node to generate the 5945# snapshot from 5946# 5947# @name: the name of the internal snapshot to be created 5948# 5949# Notes: In transaction, if @name is empty, or any snapshot matching 5950# @name exists, the operation will fail. Only some image formats 5951# support it, for example, qcow2, and rbd. 5952# 5953# Since: 1.7 5954## 5955{ 'struct': 'BlockdevSnapshotInternal', 5956 'data': { 'device': 'str', 'name': 'str' } } 5957 5958## 5959# @blockdev-snapshot-internal-sync: 5960# 5961# Synchronously take an internal snapshot of a block device, when the 5962# format of the image used supports it. If the name is an empty 5963# string, or a snapshot with name already exists, the operation will 5964# fail. 5965# 5966# For the arguments, see the documentation of 5967# BlockdevSnapshotInternal. 5968# 5969# Returns: 5970# - nothing on success 5971# - If @device is not a valid block device, GenericError 5972# - If any snapshot matching @name exists, or @name is empty, 5973# GenericError 5974# - If the format of the image used does not support it, 5975# GenericError 5976# 5977# Since: 1.7 5978# 5979# Example: 5980# 5981# -> { "execute": "blockdev-snapshot-internal-sync", 5982# "arguments": { "device": "ide-hd0", 5983# "name": "snapshot0" } 5984# } 5985# <- { "return": {} } 5986## 5987{ 'command': 'blockdev-snapshot-internal-sync', 5988 'data': 'BlockdevSnapshotInternal', 5989 'allow-preconfig': true } 5990 5991## 5992# @blockdev-snapshot-delete-internal-sync: 5993# 5994# Synchronously delete an internal snapshot of a block device, when 5995# the format of the image used support it. The snapshot is identified 5996# by name or id or both. One of the name or id is required. Return 5997# SnapshotInfo for the successfully deleted snapshot. 5998# 5999# @device: the device name or node-name of a root node to delete the 6000# snapshot from 6001# 6002# @id: optional the snapshot's ID to be deleted 6003# 6004# @name: optional the snapshot's name to be deleted 6005# 6006# Returns: 6007# - SnapshotInfo on success 6008# - If @device is not a valid block device, GenericError 6009# - If snapshot not found, GenericError 6010# - If the format of the image used does not support it, 6011# GenericError 6012# - If @id and @name are both not specified, GenericError 6013# 6014# Since: 1.7 6015# 6016# Example: 6017# 6018# -> { "execute": "blockdev-snapshot-delete-internal-sync", 6019# "arguments": { "device": "ide-hd0", 6020# "name": "snapshot0" } 6021# } 6022# <- { "return": { 6023# "id": "1", 6024# "name": "snapshot0", 6025# "vm-state-size": 0, 6026# "date-sec": 1000012, 6027# "date-nsec": 10, 6028# "vm-clock-sec": 100, 6029# "vm-clock-nsec": 20, 6030# "icount": 220414 6031# } 6032# } 6033## 6034{ 'command': 'blockdev-snapshot-delete-internal-sync', 6035 'data': { 'device': 'str', '*id': 'str', '*name': 'str'}, 6036 'returns': 'SnapshotInfo', 6037 'allow-preconfig': true } 6038 6039## 6040# @DummyBlockCoreForceArrays: 6041# 6042# Not used by QMP; hack to let us use BlockGraphInfoList internally 6043# 6044# Since: 8.0 6045## 6046{ 'struct': 'DummyBlockCoreForceArrays', 6047 'data': { 'unused-block-graph-info': ['BlockGraphInfo'] } } 6048