4 # == Block core (VM unrelated)
7 { 'include': 'common.json' }
8 { 'include': 'crypto.json' }
9 { 'include': 'sockets.json' }
14 # @id: unique snapshot id
16 # @name: user chosen name
18 # @vm-state-size: size of the VM state
20 # @date-sec: UTC date of the snapshot in seconds
22 # @date-nsec: fractional part in nano seconds to be used with date-sec
24 # @vm-clock-sec: VM clock relative to boot in seconds
26 # @vm-clock-nsec: fractional part in nano seconds to be used with vm-clock-sec
31 { 'struct': 'SnapshotInfo',
32 'data': { 'id': 'str', 'name': 'str', 'vm-state-size': 'int',
33 'date-sec': 'int', 'date-nsec': 'int',
34 'vm-clock-sec': 'int', 'vm-clock-nsec': 'int' } }
37 # @ImageInfoSpecificQCow2EncryptionBase:
39 # @format: The encryption format
43 { 'struct': 'ImageInfoSpecificQCow2EncryptionBase',
44 'data': { 'format': 'BlockdevQcow2EncryptionFormat'}}
47 # @ImageInfoSpecificQCow2Encryption:
51 { 'union': 'ImageInfoSpecificQCow2Encryption',
52 'base': 'ImageInfoSpecificQCow2EncryptionBase',
53 'discriminator': 'format',
54 'data': { 'aes': 'QCryptoBlockInfoQCow',
55 'luks': 'QCryptoBlockInfoLUKS' } }
58 # @ImageInfoSpecificQCow2:
60 # @compat: compatibility level
62 # @lazy-refcounts: on or off; only valid for compat >= 1.1
64 # @corrupt: true if the image has been marked corrupt; only valid for
65 # compat >= 1.1 (since 2.2)
67 # @refcount-bits: width of a refcount entry in bits (since 2.3)
69 # @encrypt: details about encryption parameters; only set if image
70 # is encrypted (since 2.10)
74 { 'struct': 'ImageInfoSpecificQCow2',
77 '*lazy-refcounts': 'bool',
79 'refcount-bits': 'int',
80 '*encrypt': 'ImageInfoSpecificQCow2Encryption'
84 # @ImageInfoSpecificVmdk:
86 # @create-type: The create type of VMDK image
88 # @cid: Content id of image
90 # @parent-cid: Parent VMDK image's cid
92 # @extents: List of extent files
96 { 'struct': 'ImageInfoSpecificVmdk',
101 'extents': ['ImageInfo']
105 # @ImageInfoSpecific:
107 # A discriminated record of image format specific information structures.
111 { 'union': 'ImageInfoSpecific',
113 'qcow2': 'ImageInfoSpecificQCow2',
114 'vmdk': 'ImageInfoSpecificVmdk',
115 # If we need to add block driver specific parameters for
116 # LUKS in future, then we'll subclass QCryptoBlockInfoLUKS
117 # to define a ImageInfoSpecificLUKS
118 'luks': 'QCryptoBlockInfoLUKS'
124 # Information about a QEMU image file
126 # @filename: name of the image file
128 # @format: format of the image file
130 # @virtual-size: maximum capacity in bytes of the image
132 # @actual-size: actual size on disk in bytes of the image
134 # @dirty-flag: true if image is not cleanly closed
136 # @cluster-size: size of a cluster in bytes
138 # @encrypted: true if the image is encrypted
140 # @compressed: true if the image is compressed (Since 1.7)
142 # @backing-filename: name of the backing file
144 # @full-backing-filename: full path of the backing file
146 # @backing-filename-format: the format of the backing file
148 # @snapshots: list of VM snapshots
150 # @backing-image: info of the backing image (since 1.6)
152 # @format-specific: structure supplying additional format-specific
153 # information (since 1.7)
158 { 'struct': 'ImageInfo',
159 'data': {'filename': 'str', 'format': 'str', '*dirty-flag': 'bool',
160 '*actual-size': 'int', 'virtual-size': 'int',
161 '*cluster-size': 'int', '*encrypted': 'bool', '*compressed': 'bool',
162 '*backing-filename': 'str', '*full-backing-filename': 'str',
163 '*backing-filename-format': 'str', '*snapshots': ['SnapshotInfo'],
164 '*backing-image': 'ImageInfo',
165 '*format-specific': 'ImageInfoSpecific' } }
170 # Information about a QEMU image file check
172 # @filename: name of the image file checked
174 # @format: format of the image file checked
176 # @check-errors: number of unexpected errors occurred during check
178 # @image-end-offset: offset (in bytes) where the image ends, this
179 # field is present if the driver for the image format
182 # @corruptions: number of corruptions found during the check if any
184 # @leaks: number of leaks found during the check if any
186 # @corruptions-fixed: number of corruptions fixed during the check
189 # @leaks-fixed: number of leaks fixed during the check if any
191 # @total-clusters: total number of clusters, this field is present
192 # if the driver for the image format supports it
194 # @allocated-clusters: total number of allocated clusters, this
195 # field is present if the driver for the image format
198 # @fragmented-clusters: total number of fragmented clusters, this
199 # field is present if the driver for the image format
202 # @compressed-clusters: total number of compressed clusters, this
203 # field is present if the driver for the image format
209 { 'struct': 'ImageCheck',
210 'data': {'filename': 'str', 'format': 'str', 'check-errors': 'int',
211 '*image-end-offset': 'int', '*corruptions': 'int', '*leaks': 'int',
212 '*corruptions-fixed': 'int', '*leaks-fixed': 'int',
213 '*total-clusters': 'int', '*allocated-clusters': 'int',
214 '*fragmented-clusters': 'int', '*compressed-clusters': 'int' } }
219 # Mapping information from a virtual block range to a host file range
221 # @start: the start byte of the mapped virtual range
223 # @length: the number of bytes of the mapped virtual range
225 # @data: whether the mapped range has data
227 # @zero: whether the virtual blocks are zeroed
229 # @depth: the depth of the mapping
231 # @offset: the offset in file that the virtual sectors are mapped to
233 # @filename: filename that is referred to by @offset
238 { 'struct': 'MapEntry',
239 'data': {'start': 'int', 'length': 'int', 'data': 'bool',
240 'zero': 'bool', 'depth': 'int', '*offset': 'int',
241 '*filename': 'str' } }
244 # @BlockdevCacheInfo:
246 # Cache mode information for a block device
248 # @writeback: true if writeback mode is enabled
249 # @direct: true if the host page cache is bypassed (O_DIRECT)
250 # @no-flush: true if flush requests are ignored for the device
254 { 'struct': 'BlockdevCacheInfo',
255 'data': { 'writeback': 'bool',
257 'no-flush': 'bool' } }
262 # Information about the backing device for a block device.
264 # @file: the filename of the backing device
266 # @node-name: the name of the block driver node (Since 2.0)
268 # @ro: true if the backing device was open read-only
270 # @drv: the name of the block format used to open the backing device. As of
271 # 0.14.0 this can be: 'blkdebug', 'bochs', 'cloop', 'cow', 'dmg',
272 # 'file', 'file', 'ftp', 'ftps', 'host_cdrom', 'host_device',
273 # 'http', 'https', 'luks', 'nbd', 'parallels', 'qcow',
274 # 'qcow2', 'raw', 'vdi', 'vmdk', 'vpc', 'vvfat'
275 # 2.2: 'archipelago' added, 'cow' dropped
276 # 2.3: 'host_floppy' deprecated
277 # 2.5: 'host_floppy' dropped
279 # 2.8: 'replication' added, 'tftp' dropped
280 # 2.9: 'archipelago' dropped
282 # @backing_file: the name of the backing file (for copy-on-write)
284 # @backing_file_depth: number of files in the backing file chain (since: 1.2)
286 # @encrypted: true if the backing device is encrypted
288 # @encryption_key_missing: Deprecated; always false
290 # @detect_zeroes: detect and optimize zero writes (Since 2.1)
292 # @bps: total throughput limit in bytes per second is specified
294 # @bps_rd: read throughput limit in bytes per second is specified
296 # @bps_wr: write throughput limit in bytes per second is specified
298 # @iops: total I/O operations per second is specified
300 # @iops_rd: read I/O operations per second is specified
302 # @iops_wr: write I/O operations per second is specified
304 # @image: the info of image used (since: 1.6)
306 # @bps_max: total throughput limit during bursts,
307 # in bytes (Since 1.7)
309 # @bps_rd_max: read throughput limit during bursts,
310 # in bytes (Since 1.7)
312 # @bps_wr_max: write throughput limit during bursts,
313 # in bytes (Since 1.7)
315 # @iops_max: total I/O operations per second during bursts,
316 # in bytes (Since 1.7)
318 # @iops_rd_max: read I/O operations per second during bursts,
319 # in bytes (Since 1.7)
321 # @iops_wr_max: write I/O operations per second during bursts,
322 # in bytes (Since 1.7)
324 # @bps_max_length: maximum length of the @bps_max burst
325 # period, in seconds. (Since 2.6)
327 # @bps_rd_max_length: maximum length of the @bps_rd_max
328 # burst period, in seconds. (Since 2.6)
330 # @bps_wr_max_length: maximum length of the @bps_wr_max
331 # burst period, in seconds. (Since 2.6)
333 # @iops_max_length: maximum length of the @iops burst
334 # period, in seconds. (Since 2.6)
336 # @iops_rd_max_length: maximum length of the @iops_rd_max
337 # burst period, in seconds. (Since 2.6)
339 # @iops_wr_max_length: maximum length of the @iops_wr_max
340 # burst period, in seconds. (Since 2.6)
342 # @iops_size: an I/O size in bytes (Since 1.7)
344 # @group: throttle group name (Since 2.4)
346 # @cache: the cache mode used for the block device (since: 2.3)
348 # @write_threshold: configured write threshold for the device.
349 # 0 if disabled. (Since 2.3)
354 { 'struct': 'BlockDeviceInfo',
355 'data': { 'file': 'str', '*node-name': 'str', 'ro': 'bool', 'drv': 'str',
356 '*backing_file': 'str', 'backing_file_depth': 'int',
357 'encrypted': 'bool', 'encryption_key_missing': 'bool',
358 'detect_zeroes': 'BlockdevDetectZeroesOptions',
359 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
360 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
361 'image': 'ImageInfo',
362 '*bps_max': 'int', '*bps_rd_max': 'int',
363 '*bps_wr_max': 'int', '*iops_max': 'int',
364 '*iops_rd_max': 'int', '*iops_wr_max': 'int',
365 '*bps_max_length': 'int', '*bps_rd_max_length': 'int',
366 '*bps_wr_max_length': 'int', '*iops_max_length': 'int',
367 '*iops_rd_max_length': 'int', '*iops_wr_max_length': 'int',
368 '*iops_size': 'int', '*group': 'str', 'cache': 'BlockdevCacheInfo',
369 'write_threshold': 'int' } }
372 # @BlockDeviceIoStatus:
374 # An enumeration of block device I/O status.
376 # @ok: The last I/O operation has succeeded
378 # @failed: The last I/O operation has failed
380 # @nospace: The last I/O operation has failed due to a no-space condition
384 { 'enum': 'BlockDeviceIoStatus', 'data': [ 'ok', 'failed', 'nospace' ] }
387 # @BlockDeviceMapEntry:
389 # Entry in the metadata map of the device (returned by "qemu-img map")
391 # @start: Offset in the image of the first byte described by this entry
394 # @length: Length of the range described by this entry (in bytes)
396 # @depth: Number of layers (0 = top image, 1 = top image's backing file, etc.)
397 # before reaching one for which the range is allocated. The value is
398 # in the range 0 to the depth of the image chain - 1.
400 # @zero: the sectors in this range read as zeros
402 # @data: reading the image will actually read data from a file (in particular,
403 # if @offset is present this means that the sectors are not simply
404 # preallocated, but contain actual data in raw format)
406 # @offset: if present, the image file stores the data for this range in
407 # raw format at the given offset.
411 { 'struct': 'BlockDeviceMapEntry',
412 'data': { 'start': 'int', 'length': 'int', 'depth': 'int', 'zero': 'bool',
413 'data': 'bool', '*offset': 'int' } }
416 # @DirtyBitmapStatus:
418 # An enumeration of possible states that a dirty bitmap can report to the user.
420 # @frozen: The bitmap is currently in-use by a backup operation or block job,
423 # @disabled: The bitmap is currently in-use by an internal operation and is
424 # read-only. It can still be deleted.
426 # @active: The bitmap is actively monitoring for new writes, and can be cleared,
427 # deleted, or used for backup operations.
429 # @locked: The bitmap is currently in-use by some operation and can not be
430 # cleared, deleted, or used for backup operations. (Since 2.12)
434 { 'enum': 'DirtyBitmapStatus',
435 'data': ['active', 'disabled', 'frozen', 'locked'] }
440 # Block dirty bitmap information.
442 # @name: the name of the dirty bitmap (Since 2.4)
444 # @count: number of dirty bytes according to the dirty bitmap
446 # @granularity: granularity of the dirty bitmap in bytes (since 1.4)
448 # @status: current status of the dirty bitmap (since 2.4)
452 { 'struct': 'BlockDirtyInfo',
453 'data': {'*name': 'str', 'count': 'int', 'granularity': 'uint32',
454 'status': 'DirtyBitmapStatus'} }
457 # @BlockLatencyHistogramInfo:
459 # Block latency histogram.
461 # @boundaries: list of interval boundary values in nanoseconds, all greater
462 # than zero and in ascending order.
463 # For example, the list [10, 50, 100] produces the following
464 # histogram intervals: [0, 10), [10, 50), [50, 100), [100, +inf).
466 # @bins: list of io request counts corresponding to histogram intervals.
467 # len(@bins) = len(@boundaries) + 1
468 # For the example above, @bins may be something like [3, 1, 5, 2],
469 # and corresponding histogram looks like:
476 # +------------------
481 { 'struct': 'BlockLatencyHistogramInfo',
482 'data': {'boundaries': ['uint64'], 'bins': ['uint64'] } }
485 # @x-block-latency-histogram-set:
487 # Manage read, write and flush latency histograms for the device.
489 # If only @device parameter is specified, remove all present latency histograms
490 # for the device. Otherwise, add/reset some of (or all) latency histograms.
492 # @device: device name to set latency histogram for.
494 # @boundaries: list of interval boundary values (see description in
495 # BlockLatencyHistogramInfo definition). If specified, all
496 # latency histograms are removed, and empty ones created for all
497 # io types with intervals corresponding to @boundaries (except for
498 # io types, for which specific boundaries are set through the
499 # following parameters).
501 # @boundaries-read: list of interval boundary values for read latency
502 # histogram. If specified, old read latency histogram is
503 # removed, and empty one created with intervals
504 # corresponding to @boundaries-read. The parameter has higher
505 # priority then @boundaries.
507 # @boundaries-write: list of interval boundary values for write latency
510 # @boundaries-flush: list of interval boundary values for flush latency
513 # Returns: error if device is not found or any boundary arrays are invalid.
517 # Example: set new histograms for all io types with intervals
518 # [0, 10), [10, 50), [50, 100), [100, +inf):
520 # -> { "execute": "block-latency-histogram-set",
521 # "arguments": { "device": "drive0",
522 # "boundaries": [10, 50, 100] } }
523 # <- { "return": {} }
525 # Example: set new histogram only for write, other histograms will remain
526 # not changed (or not created):
528 # -> { "execute": "block-latency-histogram-set",
529 # "arguments": { "device": "drive0",
530 # "boundaries-write": [10, 50, 100] } }
531 # <- { "return": {} }
533 # Example: set new histograms with the following intervals:
534 # read, flush: [0, 10), [10, 50), [50, 100), [100, +inf)
535 # write: [0, 1000), [1000, 5000), [5000, +inf)
537 # -> { "execute": "block-latency-histogram-set",
538 # "arguments": { "device": "drive0",
539 # "boundaries": [10, 50, 100],
540 # "boundaries-write": [1000, 5000] } }
541 # <- { "return": {} }
543 # Example: remove all latency histograms:
545 # -> { "execute": "block-latency-histogram-set",
546 # "arguments": { "device": "drive0" } }
547 # <- { "return": {} }
549 { 'command': 'x-block-latency-histogram-set',
550 'data': {'device': 'str',
551 '*boundaries': ['uint64'],
552 '*boundaries-read': ['uint64'],
553 '*boundaries-write': ['uint64'],
554 '*boundaries-flush': ['uint64'] } }
559 # Block device information. This structure describes a virtual device and
560 # the backing device associated with it.
562 # @device: The device name associated with the virtual device.
564 # @qdev: The qdev ID, or if no ID is assigned, the QOM path of the block
565 # device. (since 2.10)
567 # @type: This field is returned only for compatibility reasons, it should
568 # not be used (always returns 'unknown')
570 # @removable: True if the device supports removable media.
572 # @locked: True if the guest has locked this device from having its media
575 # @tray_open: True if the device's tray is open
576 # (only present if it has a tray)
578 # @dirty-bitmaps: dirty bitmaps information (only present if the
579 # driver has one or more dirty bitmaps) (Since 2.0)
581 # @io-status: @BlockDeviceIoStatus. Only present if the device
582 # supports it and the VM is configured to stop on errors
583 # (supported device models: virtio-blk, IDE, SCSI except
586 # @inserted: @BlockDeviceInfo describing the device if media is
591 { 'struct': 'BlockInfo',
592 'data': {'device': 'str', '*qdev': 'str', 'type': 'str', 'removable': 'bool',
593 'locked': 'bool', '*inserted': 'BlockDeviceInfo',
594 '*tray_open': 'bool', '*io-status': 'BlockDeviceIoStatus',
595 '*dirty-bitmaps': ['BlockDirtyInfo'] } }
600 # Image file size calculation information. This structure describes the size
601 # requirements for creating a new image file.
603 # The size requirements depend on the new image file format. File size always
604 # equals virtual disk size for the 'raw' format, even for sparse POSIX files.
605 # Compact formats such as 'qcow2' represent unallocated and zero regions
606 # efficiently so file size may be smaller than virtual disk size.
608 # The values are upper bounds that are guaranteed to fit the new image file.
609 # Subsequent modification, such as internal snapshot or bitmap creation, may
610 # require additional space and is not covered here.
612 # @required: Size required for a new image file, in bytes.
614 # @fully-allocated: Image file size, in bytes, once data has been written
619 { 'struct': 'BlockMeasureInfo',
620 'data': {'required': 'int', 'fully-allocated': 'int'} }
625 # Get a list of BlockInfo for all virtual block devices.
627 # Returns: a list of @BlockInfo describing each virtual block device. Filter
628 # nodes that were created implicitly are skipped over.
634 # -> { "execute": "query-block" }
639 # "device":"ide0-hd0",
646 # "file":"disks/test.qcow2",
647 # "backing_file_depth":1,
654 # "bps_max": 8000000,
661 # "detect_zeroes": "on",
662 # "write_threshold": 0,
664 # "filename":"disks/test.qcow2",
666 # "virtual-size":2048000,
667 # "backing_file":"base.qcow2",
668 # "full-backing-filename":"disks/base.qcow2",
669 # "backing-filename-format":"qcow2",
673 # "name": "snapshot1",
674 # "vm-state-size": 0,
675 # "date-sec": 10000200,
677 # "vm-clock-sec": 206,
678 # "vm-clock-nsec": 30
682 # "filename":"disks/base.qcow2",
684 # "virtual-size":2048000
688 # "qdev": "ide_disk",
693 # "device":"ide1-cd0",
696 # "qdev": "/machine/unattached/device[23]",
697 # "tray_open": false,
701 # "device":"floppy0",
704 # "qdev": "/machine/unattached/device[20]",
717 { 'command': 'query-block', 'returns': ['BlockInfo'] }
721 # @BlockDeviceTimedStats:
723 # Statistics of a block device during a given interval of time.
725 # @interval_length: Interval used for calculating the statistics,
728 # @min_rd_latency_ns: Minimum latency of read operations in the
729 # defined interval, in nanoseconds.
731 # @min_wr_latency_ns: Minimum latency of write operations in the
732 # defined interval, in nanoseconds.
734 # @min_flush_latency_ns: Minimum latency of flush operations in the
735 # defined interval, in nanoseconds.
737 # @max_rd_latency_ns: Maximum latency of read operations in the
738 # defined interval, in nanoseconds.
740 # @max_wr_latency_ns: Maximum latency of write operations in the
741 # defined interval, in nanoseconds.
743 # @max_flush_latency_ns: Maximum latency of flush operations in the
744 # defined interval, in nanoseconds.
746 # @avg_rd_latency_ns: Average latency of read operations in the
747 # defined interval, in nanoseconds.
749 # @avg_wr_latency_ns: Average latency of write operations in the
750 # defined interval, in nanoseconds.
752 # @avg_flush_latency_ns: Average latency of flush operations in the
753 # defined interval, in nanoseconds.
755 # @avg_rd_queue_depth: Average number of pending read operations
756 # in the defined interval.
758 # @avg_wr_queue_depth: Average number of pending write operations
759 # in the defined interval.
763 { 'struct': 'BlockDeviceTimedStats',
764 'data': { 'interval_length': 'int', 'min_rd_latency_ns': 'int',
765 'max_rd_latency_ns': 'int', 'avg_rd_latency_ns': 'int',
766 'min_wr_latency_ns': 'int', 'max_wr_latency_ns': 'int',
767 'avg_wr_latency_ns': 'int', 'min_flush_latency_ns': 'int',
768 'max_flush_latency_ns': 'int', 'avg_flush_latency_ns': 'int',
769 'avg_rd_queue_depth': 'number', 'avg_wr_queue_depth': 'number' } }
774 # Statistics of a virtual block device or a block backing device.
776 # @rd_bytes: The number of bytes read by the device.
778 # @wr_bytes: The number of bytes written by the device.
780 # @rd_operations: The number of read operations performed by the device.
782 # @wr_operations: The number of write operations performed by the device.
784 # @flush_operations: The number of cache flush operations performed by the
785 # device (since 0.15.0)
787 # @flush_total_time_ns: Total time spend on cache flushes in nano-seconds
790 # @wr_total_time_ns: Total time spend on writes in nano-seconds (since 0.15.0).
792 # @rd_total_time_ns: Total_time_spend on reads in nano-seconds (since 0.15.0).
794 # @wr_highest_offset: The offset after the greatest byte written to the
795 # device. The intended use of this information is for
796 # growable sparse files (like qcow2) that are used on top
797 # of a physical device.
799 # @rd_merged: Number of read requests that have been merged into another
800 # request (Since 2.3).
802 # @wr_merged: Number of write requests that have been merged into another
803 # request (Since 2.3).
805 # @idle_time_ns: Time since the last I/O operation, in
806 # nanoseconds. If the field is absent it means that
807 # there haven't been any operations yet (Since 2.5).
809 # @failed_rd_operations: The number of failed read operations
810 # performed by the device (Since 2.5)
812 # @failed_wr_operations: The number of failed write operations
813 # performed by the device (Since 2.5)
815 # @failed_flush_operations: The number of failed flush operations
816 # performed by the device (Since 2.5)
818 # @invalid_rd_operations: The number of invalid read operations
819 # performed by the device (Since 2.5)
821 # @invalid_wr_operations: The number of invalid write operations
822 # performed by the device (Since 2.5)
824 # @invalid_flush_operations: The number of invalid flush operations
825 # performed by the device (Since 2.5)
827 # @account_invalid: Whether invalid operations are included in the
828 # last access statistics (Since 2.5)
830 # @account_failed: Whether failed operations are included in the
831 # latency and last access statistics (Since 2.5)
833 # @timed_stats: Statistics specific to the set of previously defined
834 # intervals of time (Since 2.5)
836 # @x_rd_latency_histogram: @BlockLatencyHistogramInfo. (Since 2.12)
838 # @x_wr_latency_histogram: @BlockLatencyHistogramInfo. (Since 2.12)
840 # @x_flush_latency_histogram: @BlockLatencyHistogramInfo. (Since 2.12)
844 { 'struct': 'BlockDeviceStats',
845 'data': {'rd_bytes': 'int', 'wr_bytes': 'int', 'rd_operations': 'int',
846 'wr_operations': 'int', 'flush_operations': 'int',
847 'flush_total_time_ns': 'int', 'wr_total_time_ns': 'int',
848 'rd_total_time_ns': 'int', 'wr_highest_offset': 'int',
849 'rd_merged': 'int', 'wr_merged': 'int', '*idle_time_ns': 'int',
850 'failed_rd_operations': 'int', 'failed_wr_operations': 'int',
851 'failed_flush_operations': 'int', 'invalid_rd_operations': 'int',
852 'invalid_wr_operations': 'int', 'invalid_flush_operations': 'int',
853 'account_invalid': 'bool', 'account_failed': 'bool',
854 'timed_stats': ['BlockDeviceTimedStats'],
855 '*x_rd_latency_histogram': 'BlockLatencyHistogramInfo',
856 '*x_wr_latency_histogram': 'BlockLatencyHistogramInfo',
857 '*x_flush_latency_histogram': 'BlockLatencyHistogramInfo' } }
862 # Statistics of a virtual block device or a block backing device.
864 # @device: If the stats are for a virtual block device, the name
865 # corresponding to the virtual block device.
867 # @node-name: The node name of the device. (Since 2.3)
869 # @stats: A @BlockDeviceStats for the device.
871 # @parent: This describes the file block device if it has one.
872 # Contains recursively the statistics of the underlying
873 # protocol (e.g. the host file for a qcow2 image). If there is
874 # no underlying protocol, this field is omitted
876 # @backing: This describes the backing block device if it has one.
881 { 'struct': 'BlockStats',
882 'data': {'*device': 'str', '*node-name': 'str',
883 'stats': 'BlockDeviceStats',
884 '*parent': 'BlockStats',
885 '*backing': 'BlockStats'} }
890 # Query the @BlockStats for all virtual block devices.
892 # @query-nodes: If true, the command will query all the block nodes
893 # that have a node name, in a list which will include "parent"
894 # information, but not "backing".
895 # If false or omitted, the behavior is as before - query all the
896 # device backends, recursively including their "parent" and
897 # "backing". Filter nodes that were created implicitly are
898 # skipped over in this mode. (Since 2.3)
900 # Returns: A list of @BlockStats for each virtual block devices.
906 # -> { "execute": "query-blockstats" }
910 # "device":"ide0-hd0",
913 # "wr_highest_offset":3686448128,
914 # "wr_bytes":9786368,
915 # "wr_operations":751,
916 # "rd_bytes":122567168,
917 # "rd_operations":36772
918 # "wr_total_times_ns":313253456
919 # "rd_total_times_ns":3465673657
920 # "flush_total_times_ns":49653
921 # "flush_operations":61,
924 # "idle_time_ns":2953431879,
925 # "account_invalid":true,
926 # "account_failed":false
930 # "wr_highest_offset":2821110784,
931 # "wr_bytes":9786368,
932 # "wr_operations":692,
933 # "rd_bytes":122739200,
934 # "rd_operations":36604
935 # "flush_operations":51,
936 # "wr_total_times_ns":313253456
937 # "rd_total_times_ns":3465673657
938 # "flush_total_times_ns":49653,
941 # "idle_time_ns":2953431879,
942 # "account_invalid":true,
943 # "account_failed":false
947 # "device":"ide1-cd0",
949 # "wr_highest_offset":0,
954 # "flush_operations":0,
955 # "wr_total_times_ns":0
956 # "rd_total_times_ns":0
957 # "flush_total_times_ns":0,
960 # "account_invalid":false,
961 # "account_failed":false
965 # "device":"floppy0",
967 # "wr_highest_offset":0,
972 # "flush_operations":0,
973 # "wr_total_times_ns":0
974 # "rd_total_times_ns":0
975 # "flush_total_times_ns":0,
978 # "account_invalid":false,
979 # "account_failed":false
985 # "wr_highest_offset":0,
990 # "flush_operations":0,
991 # "wr_total_times_ns":0
992 # "rd_total_times_ns":0
993 # "flush_total_times_ns":0,
996 # "account_invalid":false,
997 # "account_failed":false
1004 { 'command': 'query-blockstats',
1005 'data': { '*query-nodes': 'bool' },
1006 'returns': ['BlockStats'] }
1011 # An enumeration of possible behaviors for errors on I/O operations.
1012 # The exact meaning depends on whether the I/O was initiated by a guest
1015 # @report: for guest operations, report the error to the guest;
1016 # for jobs, cancel the job
1018 # @ignore: ignore the error, only report a QMP event (BLOCK_IO_ERROR
1019 # or BLOCK_JOB_ERROR)
1021 # @enospc: same as @stop on ENOSPC, same as @report otherwise.
1023 # @stop: for guest operations, stop the virtual machine;
1024 # for jobs, pause the job
1026 # @auto: inherit the error handling policy of the backend (since: 2.7)
1030 { 'enum': 'BlockdevOnError',
1031 'data': ['report', 'ignore', 'enospc', 'stop', 'auto'] }
1036 # An enumeration of possible behaviors for the initial synchronization
1037 # phase of storage mirroring.
1039 # @top: copies data in the topmost image to the destination
1041 # @full: copies data from all images to the destination
1043 # @none: only copy data written from now on
1045 # @incremental: only copy data described by the dirty bitmap. Since: 2.4
1049 { 'enum': 'MirrorSyncMode',
1050 'data': ['top', 'full', 'none', 'incremental'] }
1055 # Type of a block job.
1057 # @commit: block commit job type, see "block-commit"
1059 # @stream: block stream job type, see "block-stream"
1061 # @mirror: drive mirror job type, see "drive-mirror"
1063 # @backup: drive backup job type, see "drive-backup"
1067 { 'enum': 'BlockJobType',
1068 'data': ['commit', 'stream', 'mirror', 'backup'] }
1073 # Represents command verbs that can be applied to a blockjob.
1075 # @cancel: see @block-job-cancel
1077 # @pause: see @block-job-pause
1079 # @resume: see @block-job-resume
1081 # @set-speed: see @block-job-set-speed
1083 # @complete: see @block-job-complete
1085 # @dismiss: see @block-job-dismiss
1087 # @finalize: see @block-job-finalize
1091 { 'enum': 'BlockJobVerb',
1092 'data': ['cancel', 'pause', 'resume', 'set-speed', 'complete', 'dismiss',
1098 # Indicates the present state of a given blockjob in its lifetime.
1100 # @undefined: Erroneous, default state. Should not ever be visible.
1102 # @created: The job has been created, but not yet started.
1104 # @running: The job is currently running.
1106 # @paused: The job is running, but paused. The pause may be requested by
1107 # either the QMP user or by internal processes.
1109 # @ready: The job is running, but is ready for the user to signal completion.
1110 # This is used for long-running jobs like mirror that are designed to
1113 # @standby: The job is ready, but paused. This is nearly identical to @paused.
1114 # The job may return to @ready or otherwise be canceled.
1116 # @waiting: The job is waiting for other jobs in the transaction to converge
1117 # to the waiting state. This status will likely not be visible for
1118 # the last job in a transaction.
1120 # @pending: The job has finished its work, but has finalization steps that it
1121 # needs to make prior to completing. These changes may require
1122 # manual intervention by the management process if manual was set
1123 # to true. These changes may still fail.
1125 # @aborting: The job is in the process of being aborted, and will finish with
1126 # an error. The job will afterwards report that it is @concluded.
1127 # This status may not be visible to the management process.
1129 # @concluded: The job has finished all work. If manual was set to true, the job
1130 # will remain in the query list until it is dismissed.
1132 # @null: The job is in the process of being dismantled. This state should not
1133 # ever be visible externally.
1137 { 'enum': 'BlockJobStatus',
1138 'data': ['undefined', 'created', 'running', 'paused', 'ready', 'standby',
1139 'waiting', 'pending', 'aborting', 'concluded', 'null' ] }
1144 # Information about a long-running block device operation.
1146 # @type: the job type ('stream' for image streaming)
1148 # @device: The job identifier. Originally the device name but other
1149 # values are allowed since QEMU 2.7
1151 # @len: the maximum progress value
1153 # @busy: false if the job is known to be in a quiescent state, with
1154 # no pending I/O. Since 1.3.
1156 # @paused: whether the job is paused or, if @busy is true, will
1157 # pause itself as soon as possible. Since 1.3.
1159 # @offset: the current progress value
1161 # @speed: the rate limit, bytes per second
1163 # @io-status: the status of the job (since 1.3)
1165 # @ready: true if the job may be completed (since 2.2)
1167 # @status: Current job state/status (since 2.12)
1169 # @auto-finalize: Job will finalize itself when PENDING, moving to
1170 # the CONCLUDED state. (since 2.12)
1172 # @auto-dismiss: Job will dismiss itself when CONCLUDED, moving to the NULL
1173 # state and disappearing from the query list. (since 2.12)
1177 { 'struct': 'BlockJobInfo',
1178 'data': {'type': 'str', 'device': 'str', 'len': 'int',
1179 'offset': 'int', 'busy': 'bool', 'paused': 'bool', 'speed': 'int',
1180 'io-status': 'BlockDeviceIoStatus', 'ready': 'bool',
1181 'status': 'BlockJobStatus',
1182 'auto-finalize': 'bool', 'auto-dismiss': 'bool' } }
1185 # @query-block-jobs:
1187 # Return information about long-running block device operations.
1189 # Returns: a list of @BlockJobInfo for each active block job
1193 { 'command': 'query-block-jobs', 'returns': ['BlockJobInfo'] }
1198 # This command sets the password of a block device that has not been open
1199 # with a password and requires one.
1201 # This command is now obsolete and will always return an error since 2.10
1204 { 'command': 'block_passwd', 'data': {'*device': 'str',
1205 '*node-name': 'str', 'password': 'str'} }
1210 # Resize a block image while a guest is running.
1212 # Either @device or @node-name must be set but not both.
1214 # @device: the name of the device to get the image resized
1216 # @node-name: graph node name to get the image resized (Since 2.0)
1218 # @size: new image size in bytes
1220 # Returns: nothing on success
1221 # If @device is not a valid block device, DeviceNotFound
1227 # -> { "execute": "block_resize",
1228 # "arguments": { "device": "scratch", "size": 1073741824 } }
1229 # <- { "return": {} }
1232 { 'command': 'block_resize', 'data': { '*device': 'str',
1233 '*node-name': 'str',
1239 # An enumeration that tells QEMU how to set the backing file path in
1242 # @existing: QEMU should look for an existing image file.
1244 # @absolute-paths: QEMU should create a new image with absolute paths
1245 # for the backing file. If there is no backing file available, the new
1246 # image will not be backed either.
1250 { 'enum': 'NewImageMode',
1251 'data': [ 'existing', 'absolute-paths' ] }
1254 # @BlockdevSnapshotSync:
1256 # Either @device or @node-name must be set but not both.
1258 # @device: the name of the device to generate the snapshot from.
1260 # @node-name: graph node name to generate the snapshot from (Since 2.0)
1262 # @snapshot-file: the target of the new image. If the file exists, or
1263 # if it is a device, the snapshot will be created in the existing
1264 # file/device. Otherwise, a new file will be created.
1266 # @snapshot-node-name: the graph node name of the new image (Since 2.0)
1268 # @format: the format of the snapshot image, default is 'qcow2'.
1270 # @mode: whether and how QEMU should create a new image, default is
1273 { 'struct': 'BlockdevSnapshotSync',
1274 'data': { '*device': 'str', '*node-name': 'str',
1275 'snapshot-file': 'str', '*snapshot-node-name': 'str',
1276 '*format': 'str', '*mode': 'NewImageMode' } }
1279 # @BlockdevSnapshot:
1281 # @node: device or node name that will have a snapshot created.
1283 # @overlay: reference to the existing block device that will become
1284 # the overlay of @node, as part of creating the snapshot.
1285 # It must not have a current backing file (this can be
1286 # achieved by passing "backing": null to blockdev-add).
1290 { 'struct': 'BlockdevSnapshot',
1291 'data': { 'node': 'str', 'overlay': 'str' } }
1296 # @job-id: identifier for the newly-created block job. If
1297 # omitted, the device name will be used. (Since 2.7)
1299 # @device: the device name or node-name of a root node which should be copied.
1301 # @target: the target of the new image. If the file exists, or if it
1302 # is a device, the existing file/device will be used as the new
1303 # destination. If it does not exist, a new file will be created.
1305 # @format: the format of the new destination, default is to
1306 # probe if @mode is 'existing', else the format of the source
1308 # @sync: what parts of the disk image should be copied to the destination
1309 # (all the disk, only the sectors allocated in the topmost image, from a
1310 # dirty bitmap, or only new I/O).
1312 # @mode: whether and how QEMU should create a new image, default is
1315 # @speed: the maximum speed, in bytes per second
1317 # @bitmap: the name of dirty bitmap if sync is "incremental".
1318 # Must be present if sync is "incremental", must NOT be present
1319 # otherwise. (Since 2.4)
1321 # @compress: true to compress data, if the target format supports it.
1322 # (default: false) (since 2.8)
1324 # @on-source-error: the action to take on an error on the source,
1325 # default 'report'. 'stop' and 'enospc' can only be used
1326 # if the block device supports io-status (see BlockInfo).
1328 # @on-target-error: the action to take on an error on the target,
1329 # default 'report' (no limitations, since this applies to
1330 # a different block device than @device).
1332 # @auto-finalize: When false, this job will wait in a PENDING state after it has
1333 # finished its work, waiting for @block-job-finalize.
1334 # When true, this job will automatically perform its abort or
1336 # Defaults to true. (Since 2.12)
1338 # @auto-dismiss: When false, this job will wait in a CONCLUDED state after it
1339 # has completed ceased all work, and wait for @block-job-dismiss.
1340 # When true, this job will automatically disappear from the query
1341 # list without user intervention.
1342 # Defaults to true. (Since 2.12)
1344 # Note: @on-source-error and @on-target-error only affect background
1345 # I/O. If an error occurs during a guest write request, the device's
1346 # rerror/werror actions will be used.
1350 { 'struct': 'DriveBackup',
1351 'data': { '*job-id': 'str', 'device': 'str', 'target': 'str',
1352 '*format': 'str', 'sync': 'MirrorSyncMode',
1353 '*mode': 'NewImageMode', '*speed': 'int',
1354 '*bitmap': 'str', '*compress': 'bool',
1355 '*on-source-error': 'BlockdevOnError',
1356 '*on-target-error': 'BlockdevOnError',
1357 '*auto-finalize': 'bool', '*auto-dismiss': 'bool' } }
1362 # @job-id: identifier for the newly-created block job. If
1363 # omitted, the device name will be used. (Since 2.7)
1365 # @device: the device name or node-name of a root node which should be copied.
1367 # @target: the device name or node-name of the backup target node.
1369 # @sync: what parts of the disk image should be copied to the destination
1370 # (all the disk, only the sectors allocated in the topmost image, or
1373 # @speed: the maximum speed, in bytes per second. The default is 0,
1376 # @compress: true to compress data, if the target format supports it.
1377 # (default: false) (since 2.8)
1379 # @on-source-error: the action to take on an error on the source,
1380 # default 'report'. 'stop' and 'enospc' can only be used
1381 # if the block device supports io-status (see BlockInfo).
1383 # @on-target-error: the action to take on an error on the target,
1384 # default 'report' (no limitations, since this applies to
1385 # a different block device than @device).
1387 # @auto-finalize: When false, this job will wait in a PENDING state after it has
1388 # finished its work, waiting for @block-job-finalize.
1389 # When true, this job will automatically perform its abort or
1391 # Defaults to true. (Since 2.12)
1393 # @auto-dismiss: When false, this job will wait in a CONCLUDED state after it
1394 # has completed ceased all work, and wait for @block-job-dismiss.
1395 # When true, this job will automatically disappear from the query
1396 # list without user intervention.
1397 # Defaults to true. (Since 2.12)
1399 # Note: @on-source-error and @on-target-error only affect background
1400 # I/O. If an error occurs during a guest write request, the device's
1401 # rerror/werror actions will be used.
1405 { 'struct': 'BlockdevBackup',
1406 'data': { '*job-id': 'str', 'device': 'str', 'target': 'str',
1407 'sync': 'MirrorSyncMode', '*speed': 'int', '*compress': 'bool',
1408 '*on-source-error': 'BlockdevOnError',
1409 '*on-target-error': 'BlockdevOnError',
1410 '*auto-finalize': 'bool', '*auto-dismiss': 'bool' } }
1413 # @blockdev-snapshot-sync:
1415 # Generates a synchronous snapshot of a block device.
1417 # For the arguments, see the documentation of BlockdevSnapshotSync.
1419 # Returns: nothing on success
1420 # If @device is not a valid block device, DeviceNotFound
1426 # -> { "execute": "blockdev-snapshot-sync",
1427 # "arguments": { "device": "ide-hd0",
1429 # "/some/place/my-image",
1430 # "format": "qcow2" } }
1431 # <- { "return": {} }
1434 { 'command': 'blockdev-snapshot-sync',
1435 'data': 'BlockdevSnapshotSync' }
1439 # @blockdev-snapshot:
1441 # Generates a snapshot of a block device.
1443 # Create a snapshot, by installing 'node' as the backing image of
1444 # 'overlay'. Additionally, if 'node' is associated with a block
1445 # device, the block device changes to using 'overlay' as its new active
1448 # For the arguments, see the documentation of BlockdevSnapshot.
1454 # -> { "execute": "blockdev-add",
1455 # "arguments": { "driver": "qcow2",
1456 # "node-name": "node1534",
1457 # "file": { "driver": "file",
1458 # "filename": "hd1.qcow2" },
1459 # "backing": null } }
1461 # <- { "return": {} }
1463 # -> { "execute": "blockdev-snapshot",
1464 # "arguments": { "node": "ide-hd0",
1465 # "overlay": "node1534" } }
1466 # <- { "return": {} }
1469 { 'command': 'blockdev-snapshot',
1470 'data': 'BlockdevSnapshot' }
1473 # @change-backing-file:
1475 # Change the backing file in the image file metadata. This does not
1476 # cause QEMU to reopen the image file to reparse the backing filename
1477 # (it may, however, perform a reopen to change permissions from
1478 # r/o -> r/w -> r/o, if needed). The new backing file string is written
1479 # into the image file metadata, and the QEMU internal strings are
1482 # @image-node-name: The name of the block driver state node of the
1483 # image to modify. The "device" argument is used
1484 # to verify "image-node-name" is in the chain
1485 # described by "device".
1487 # @device: The device name or node-name of the root node that owns
1490 # @backing-file: The string to write as the backing file. This
1491 # string is not validated, so care should be taken
1492 # when specifying the string or the image chain may
1493 # not be able to be reopened again.
1495 # Returns: Nothing on success
1497 # If "device" does not exist or cannot be determined, DeviceNotFound
1501 { 'command': 'change-backing-file',
1502 'data': { 'device': 'str', 'image-node-name': 'str',
1503 'backing-file': 'str' } }
1508 # Live commit of data from overlay image nodes into backing nodes - i.e.,
1509 # writes data between 'top' and 'base' into 'base'.
1511 # @job-id: identifier for the newly-created block job. If
1512 # omitted, the device name will be used. (Since 2.7)
1514 # @device: the device name or node-name of a root node
1516 # @base: The file name of the backing image to write data into.
1517 # If not specified, this is the deepest backing image.
1519 # @top: The file name of the backing image within the image chain,
1520 # which contains the topmost data to be committed down. If
1521 # not specified, this is the active layer.
1523 # @backing-file: The backing file string to write into the overlay
1524 # image of 'top'. If 'top' is the active layer,
1525 # specifying a backing file string is an error. This
1526 # filename is not validated.
1528 # If a pathname string is such that it cannot be
1529 # resolved by QEMU, that means that subsequent QMP or
1530 # HMP commands must use node-names for the image in
1531 # question, as filename lookup methods will fail.
1533 # If not specified, QEMU will automatically determine
1534 # the backing file string to use, or error out if
1535 # there is no obvious choice. Care should be taken
1536 # when specifying the string, to specify a valid
1537 # filename or protocol.
1540 # If top == base, that is an error.
1541 # If top == active, the job will not be completed by itself,
1542 # user needs to complete the job with the block-job-complete
1543 # command after getting the ready event. (Since 2.0)
1545 # If the base image is smaller than top, then the base image
1546 # will be resized to be the same size as top. If top is
1547 # smaller than the base image, the base will not be
1548 # truncated. If you want the base image size to match the
1549 # size of the smaller top, you can safely truncate it
1550 # yourself once the commit operation successfully completes.
1552 # @speed: the maximum speed, in bytes per second
1554 # @filter-node-name: the node name that should be assigned to the
1555 # filter driver that the commit job inserts into the graph
1556 # above @top. If this option is not given, a node name is
1557 # autogenerated. (Since: 2.9)
1559 # Returns: Nothing on success
1560 # If commit or stream is already active on this device, DeviceInUse
1561 # If @device does not exist, DeviceNotFound
1562 # If image commit is not supported by this device, NotSupported
1563 # If @base or @top is invalid, a generic error is returned
1564 # If @speed is invalid, InvalidParameter
1570 # -> { "execute": "block-commit",
1571 # "arguments": { "device": "virtio0",
1572 # "top": "/tmp/snap1.qcow2" } }
1573 # <- { "return": {} }
1576 { 'command': 'block-commit',
1577 'data': { '*job-id': 'str', 'device': 'str', '*base': 'str', '*top': 'str',
1578 '*backing-file': 'str', '*speed': 'int',
1579 '*filter-node-name': 'str' } }
1584 # Start a point-in-time copy of a block device to a new destination. The
1585 # status of ongoing drive-backup operations can be checked with
1586 # query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
1587 # The operation can be stopped before it has completed using the
1588 # block-job-cancel command.
1590 # Returns: nothing on success
1591 # If @device is not a valid block device, GenericError
1597 # -> { "execute": "drive-backup",
1598 # "arguments": { "device": "drive0",
1600 # "target": "backup.img" } }
1601 # <- { "return": {} }
1604 { 'command': 'drive-backup', 'boxed': true,
1605 'data': 'DriveBackup' }
1610 # Start a point-in-time copy of a block device to a new destination. The
1611 # status of ongoing blockdev-backup operations can be checked with
1612 # query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
1613 # The operation can be stopped before it has completed using the
1614 # block-job-cancel command.
1616 # Returns: nothing on success
1617 # If @device is not a valid block device, DeviceNotFound
1622 # -> { "execute": "blockdev-backup",
1623 # "arguments": { "device": "src-id",
1625 # "target": "tgt-id" } }
1626 # <- { "return": {} }
1629 { 'command': 'blockdev-backup', 'boxed': true,
1630 'data': 'BlockdevBackup' }
1634 # @query-named-block-nodes:
1636 # Get the named block driver list
1638 # Returns: the list of BlockDeviceInfo
1644 # -> { "execute": "query-named-block-nodes" }
1645 # <- { "return": [ { "ro":false,
1647 # "encrypted":false,
1648 # "file":"disks/test.qcow2",
1649 # "node-name": "my-node",
1650 # "backing_file_depth":1,
1657 # "bps_max": 8000000,
1664 # "write_threshold": 0,
1666 # "filename":"disks/test.qcow2",
1668 # "virtual-size":2048000,
1669 # "backing_file":"base.qcow2",
1670 # "full-backing-filename":"disks/base.qcow2",
1671 # "backing-filename-format":"qcow2",
1675 # "name": "snapshot1",
1676 # "vm-state-size": 0,
1677 # "date-sec": 10000200,
1679 # "vm-clock-sec": 206,
1680 # "vm-clock-nsec": 30
1684 # "filename":"disks/base.qcow2",
1686 # "virtual-size":2048000
1691 { 'command': 'query-named-block-nodes', 'returns': [ 'BlockDeviceInfo' ] }
1696 # Start mirroring a block device's writes to a new destination. target
1697 # specifies the target of the new image. If the file exists, or if it
1698 # is a device, it will be used as the new destination for writes. If
1699 # it does not exist, a new file will be created. format specifies the
1700 # format of the mirror image, default is to probe if mode='existing',
1701 # else the format of the source.
1703 # Returns: nothing on success
1704 # If @device is not a valid block device, GenericError
1710 # -> { "execute": "drive-mirror",
1711 # "arguments": { "device": "ide-hd0",
1712 # "target": "/some/place/my-image",
1714 # "format": "qcow2" } }
1715 # <- { "return": {} }
1718 { 'command': 'drive-mirror', 'boxed': true,
1719 'data': 'DriveMirror' }
1724 # A set of parameters describing drive mirror setup.
1726 # @job-id: identifier for the newly-created block job. If
1727 # omitted, the device name will be used. (Since 2.7)
1729 # @device: the device name or node-name of a root node whose writes should be
1732 # @target: the target of the new image. If the file exists, or if it
1733 # is a device, the existing file/device will be used as the new
1734 # destination. If it does not exist, a new file will be created.
1736 # @format: the format of the new destination, default is to
1737 # probe if @mode is 'existing', else the format of the source
1739 # @node-name: the new block driver state node name in the graph
1742 # @replaces: with sync=full graph node name to be replaced by the new
1743 # image when a whole image copy is done. This can be used to repair
1744 # broken Quorum files. (Since 2.1)
1746 # @mode: whether and how QEMU should create a new image, default is
1749 # @speed: the maximum speed, in bytes per second
1751 # @sync: what parts of the disk image should be copied to the destination
1752 # (all the disk, only the sectors allocated in the topmost image, or
1755 # @granularity: granularity of the dirty bitmap, default is 64K
1756 # if the image format doesn't have clusters, 4K if the clusters
1757 # are smaller than that, else the cluster size. Must be a
1758 # power of 2 between 512 and 64M (since 1.4).
1760 # @buf-size: maximum amount of data in flight from source to
1761 # target (since 1.4).
1763 # @on-source-error: the action to take on an error on the source,
1764 # default 'report'. 'stop' and 'enospc' can only be used
1765 # if the block device supports io-status (see BlockInfo).
1767 # @on-target-error: the action to take on an error on the target,
1768 # default 'report' (no limitations, since this applies to
1769 # a different block device than @device).
1770 # @unmap: Whether to try to unmap target sectors where source has
1771 # only zero. If true, and target unallocated sectors will read as zero,
1772 # target image sectors will be unmapped; otherwise, zeroes will be
1773 # written. Both will result in identical contents.
1774 # Default is true. (Since 2.4)
1778 { 'struct': 'DriveMirror',
1779 'data': { '*job-id': 'str', 'device': 'str', 'target': 'str',
1780 '*format': 'str', '*node-name': 'str', '*replaces': 'str',
1781 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
1782 '*speed': 'int', '*granularity': 'uint32',
1783 '*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
1784 '*on-target-error': 'BlockdevOnError',
1785 '*unmap': 'bool' } }
1788 # @BlockDirtyBitmap:
1790 # @node: name of device/node which the bitmap is tracking
1792 # @name: name of the dirty bitmap
1796 { 'struct': 'BlockDirtyBitmap',
1797 'data': { 'node': 'str', 'name': 'str' } }
1800 # @BlockDirtyBitmapAdd:
1802 # @node: name of device/node which the bitmap is tracking
1804 # @name: name of the dirty bitmap
1806 # @granularity: the bitmap granularity, default is 64k for
1807 # block-dirty-bitmap-add
1809 # @persistent: the bitmap is persistent, i.e. it will be saved to the
1810 # corresponding block device image file on its close. For now only
1811 # Qcow2 disks support persistent bitmaps. Default is false for
1812 # block-dirty-bitmap-add. (Since: 2.10)
1814 # @autoload: ignored and deprecated since 2.12.
1815 # Currently, all dirty tracking bitmaps are loaded from Qcow2 on
1820 { 'struct': 'BlockDirtyBitmapAdd',
1821 'data': { 'node': 'str', 'name': 'str', '*granularity': 'uint32',
1822 '*persistent': 'bool', '*autoload': 'bool' } }
1825 # @block-dirty-bitmap-add:
1827 # Create a dirty bitmap with a name on the node, and start tracking the writes.
1829 # Returns: nothing on success
1830 # If @node is not a valid block device or node, DeviceNotFound
1831 # If @name is already taken, GenericError with an explanation
1837 # -> { "execute": "block-dirty-bitmap-add",
1838 # "arguments": { "node": "drive0", "name": "bitmap0" } }
1839 # <- { "return": {} }
1842 { 'command': 'block-dirty-bitmap-add',
1843 'data': 'BlockDirtyBitmapAdd' }
1846 # @block-dirty-bitmap-remove:
1848 # Stop write tracking and remove the dirty bitmap that was created
1849 # with block-dirty-bitmap-add. If the bitmap is persistent, remove it from its
1852 # Returns: nothing on success
1853 # If @node is not a valid block device or node, DeviceNotFound
1854 # If @name is not found, GenericError with an explanation
1855 # if @name is frozen by an operation, GenericError
1861 # -> { "execute": "block-dirty-bitmap-remove",
1862 # "arguments": { "node": "drive0", "name": "bitmap0" } }
1863 # <- { "return": {} }
1866 { 'command': 'block-dirty-bitmap-remove',
1867 'data': 'BlockDirtyBitmap' }
1870 # @block-dirty-bitmap-clear:
1872 # Clear (reset) a dirty bitmap on the device, so that an incremental
1873 # backup from this point in time forward will only backup clusters
1874 # modified after this clear operation.
1876 # Returns: nothing on success
1877 # If @node is not a valid block device, DeviceNotFound
1878 # If @name is not found, GenericError with an explanation
1884 # -> { "execute": "block-dirty-bitmap-clear",
1885 # "arguments": { "node": "drive0", "name": "bitmap0" } }
1886 # <- { "return": {} }
1889 { 'command': 'block-dirty-bitmap-clear',
1890 'data': 'BlockDirtyBitmap' }
1893 # @BlockDirtyBitmapSha256:
1895 # SHA256 hash of dirty bitmap data
1897 # @sha256: ASCII representation of SHA256 bitmap hash
1901 { 'struct': 'BlockDirtyBitmapSha256',
1902 'data': {'sha256': 'str'} }
1905 # @x-debug-block-dirty-bitmap-sha256:
1909 # Returns: BlockDirtyBitmapSha256 on success
1910 # If @node is not a valid block device, DeviceNotFound
1911 # If @name is not found or if hashing has failed, GenericError with an
1916 { 'command': 'x-debug-block-dirty-bitmap-sha256',
1917 'data': 'BlockDirtyBitmap', 'returns': 'BlockDirtyBitmapSha256' }
1922 # Start mirroring a block device's writes to a new destination.
1924 # @job-id: identifier for the newly-created block job. If
1925 # omitted, the device name will be used. (Since 2.7)
1927 # @device: The device name or node-name of a root node whose writes should be
1930 # @target: the id or node-name of the block device to mirror to. This mustn't be
1931 # attached to guest.
1933 # @replaces: with sync=full graph node name to be replaced by the new
1934 # image when a whole image copy is done. This can be used to repair
1935 # broken Quorum files.
1937 # @speed: the maximum speed, in bytes per second
1939 # @sync: what parts of the disk image should be copied to the destination
1940 # (all the disk, only the sectors allocated in the topmost image, or
1943 # @granularity: granularity of the dirty bitmap, default is 64K
1944 # if the image format doesn't have clusters, 4K if the clusters
1945 # are smaller than that, else the cluster size. Must be a
1946 # power of 2 between 512 and 64M
1948 # @buf-size: maximum amount of data in flight from source to
1951 # @on-source-error: the action to take on an error on the source,
1952 # default 'report'. 'stop' and 'enospc' can only be used
1953 # if the block device supports io-status (see BlockInfo).
1955 # @on-target-error: the action to take on an error on the target,
1956 # default 'report' (no limitations, since this applies to
1957 # a different block device than @device).
1959 # @filter-node-name: the node name that should be assigned to the
1960 # filter driver that the mirror job inserts into the graph
1961 # above @device. If this option is not given, a node name is
1962 # autogenerated. (Since: 2.9)
1964 # Returns: nothing on success.
1970 # -> { "execute": "blockdev-mirror",
1971 # "arguments": { "device": "ide-hd0",
1972 # "target": "target0",
1973 # "sync": "full" } }
1974 # <- { "return": {} }
1977 { 'command': 'blockdev-mirror',
1978 'data': { '*job-id': 'str', 'device': 'str', 'target': 'str',
1980 'sync': 'MirrorSyncMode',
1981 '*speed': 'int', '*granularity': 'uint32',
1982 '*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
1983 '*on-target-error': 'BlockdevOnError',
1984 '*filter-node-name': 'str' } }
1987 # @block_set_io_throttle:
1989 # Change I/O throttle limits for a block drive.
1991 # Since QEMU 2.4, each device with I/O limits is member of a throttle
1994 # If two or more devices are members of the same group, the limits
1995 # will apply to the combined I/O of the whole group in a round-robin
1996 # fashion. Therefore, setting new I/O limits to a device will affect
1999 # The name of the group can be specified using the 'group' parameter.
2000 # If the parameter is unset, it is assumed to be the current group of
2001 # that device. If it's not in any group yet, the name of the device
2002 # will be used as the name for its group.
2004 # The 'group' parameter can also be used to move a device to a
2005 # different group. In this case the limits specified in the parameters
2006 # will be applied to the new group only.
2008 # I/O limits can be disabled by setting all of them to 0. In this case
2009 # the device will be removed from its group and the rest of its
2010 # members will not be affected. The 'group' parameter is ignored.
2012 # Returns: Nothing on success
2013 # If @device is not a valid block device, DeviceNotFound
2019 # -> { "execute": "block_set_io_throttle",
2020 # "arguments": { "id": "virtio-blk-pci0/virtio-backend",
2033 # "bps_max_length": 0,
2034 # "iops_size": 0 } }
2035 # <- { "return": {} }
2037 # -> { "execute": "block_set_io_throttle",
2038 # "arguments": { "id": "ide0-1-0",
2045 # "bps_max": 8000000,
2051 # "bps_max_length": 60,
2052 # "iops_size": 0 } }
2053 # <- { "return": {} }
2055 { 'command': 'block_set_io_throttle', 'boxed': true,
2056 'data': 'BlockIOThrottle' }
2061 # A set of parameters describing block throttling.
2063 # @device: Block device name (deprecated, use @id instead)
2065 # @id: The name or QOM path of the guest device (since: 2.8)
2067 # @bps: total throughput limit in bytes per second
2069 # @bps_rd: read throughput limit in bytes per second
2071 # @bps_wr: write throughput limit in bytes per second
2073 # @iops: total I/O operations per second
2075 # @iops_rd: read I/O operations per second
2077 # @iops_wr: write I/O operations per second
2079 # @bps_max: total throughput limit during bursts,
2080 # in bytes (Since 1.7)
2082 # @bps_rd_max: read throughput limit during bursts,
2083 # in bytes (Since 1.7)
2085 # @bps_wr_max: write throughput limit during bursts,
2086 # in bytes (Since 1.7)
2088 # @iops_max: total I/O operations per second during bursts,
2089 # in bytes (Since 1.7)
2091 # @iops_rd_max: read I/O operations per second during bursts,
2092 # in bytes (Since 1.7)
2094 # @iops_wr_max: write I/O operations per second during bursts,
2095 # in bytes (Since 1.7)
2097 # @bps_max_length: maximum length of the @bps_max burst
2098 # period, in seconds. It must only
2099 # be set if @bps_max is set as well.
2100 # Defaults to 1. (Since 2.6)
2102 # @bps_rd_max_length: maximum length of the @bps_rd_max
2103 # burst period, in seconds. It must only
2104 # be set if @bps_rd_max is set as well.
2105 # Defaults to 1. (Since 2.6)
2107 # @bps_wr_max_length: maximum length of the @bps_wr_max
2108 # burst period, in seconds. It must only
2109 # be set if @bps_wr_max is set as well.
2110 # Defaults to 1. (Since 2.6)
2112 # @iops_max_length: maximum length of the @iops burst
2113 # period, in seconds. It must only
2114 # be set if @iops_max is set as well.
2115 # Defaults to 1. (Since 2.6)
2117 # @iops_rd_max_length: maximum length of the @iops_rd_max
2118 # burst period, in seconds. It must only
2119 # be set if @iops_rd_max is set as well.
2120 # Defaults to 1. (Since 2.6)
2122 # @iops_wr_max_length: maximum length of the @iops_wr_max
2123 # burst period, in seconds. It must only
2124 # be set if @iops_wr_max is set as well.
2125 # Defaults to 1. (Since 2.6)
2127 # @iops_size: an I/O size in bytes (Since 1.7)
2129 # @group: throttle group name (Since 2.4)
2133 { 'struct': 'BlockIOThrottle',
2134 'data': { '*device': 'str', '*id': 'str', 'bps': 'int', 'bps_rd': 'int',
2135 'bps_wr': 'int', 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
2136 '*bps_max': 'int', '*bps_rd_max': 'int',
2137 '*bps_wr_max': 'int', '*iops_max': 'int',
2138 '*iops_rd_max': 'int', '*iops_wr_max': 'int',
2139 '*bps_max_length': 'int', '*bps_rd_max_length': 'int',
2140 '*bps_wr_max_length': 'int', '*iops_max_length': 'int',
2141 '*iops_rd_max_length': 'int', '*iops_wr_max_length': 'int',
2142 '*iops_size': 'int', '*group': 'str' } }
2147 # Limit parameters for throttling.
2148 # Since some limit combinations are illegal, limits should always be set in one
2149 # transaction. All fields are optional. When setting limits, if a field is
2150 # missing the current value is not changed.
2152 # @iops-total: limit total I/O operations per second
2153 # @iops-total-max: I/O operations burst
2154 # @iops-total-max-length: length of the iops-total-max burst period, in seconds
2155 # It must only be set if @iops-total-max is set as well.
2156 # @iops-read: limit read operations per second
2157 # @iops-read-max: I/O operations read burst
2158 # @iops-read-max-length: length of the iops-read-max burst period, in seconds
2159 # It must only be set if @iops-read-max is set as well.
2160 # @iops-write: limit write operations per second
2161 # @iops-write-max: I/O operations write burst
2162 # @iops-write-max-length: length of the iops-write-max burst period, in seconds
2163 # It must only be set if @iops-write-max is set as well.
2164 # @bps-total: limit total bytes per second
2165 # @bps-total-max: total bytes burst
2166 # @bps-total-max-length: length of the bps-total-max burst period, in seconds.
2167 # It must only be set if @bps-total-max is set as well.
2168 # @bps-read: limit read bytes per second
2169 # @bps-read-max: total bytes read burst
2170 # @bps-read-max-length: length of the bps-read-max burst period, in seconds
2171 # It must only be set if @bps-read-max is set as well.
2172 # @bps-write: limit write bytes per second
2173 # @bps-write-max: total bytes write burst
2174 # @bps-write-max-length: length of the bps-write-max burst period, in seconds
2175 # It must only be set if @bps-write-max is set as well.
2176 # @iops-size: when limiting by iops max size of an I/O in bytes
2180 { 'struct': 'ThrottleLimits',
2181 'data': { '*iops-total' : 'int', '*iops-total-max' : 'int',
2182 '*iops-total-max-length' : 'int', '*iops-read' : 'int',
2183 '*iops-read-max' : 'int', '*iops-read-max-length' : 'int',
2184 '*iops-write' : 'int', '*iops-write-max' : 'int',
2185 '*iops-write-max-length' : 'int', '*bps-total' : 'int',
2186 '*bps-total-max' : 'int', '*bps-total-max-length' : 'int',
2187 '*bps-read' : 'int', '*bps-read-max' : 'int',
2188 '*bps-read-max-length' : 'int', '*bps-write' : 'int',
2189 '*bps-write-max' : 'int', '*bps-write-max-length' : 'int',
2190 '*iops-size' : 'int' } }
2195 # Copy data from a backing file into a block device.
2197 # The block streaming operation is performed in the background until the entire
2198 # backing file has been copied. This command returns immediately once streaming
2199 # has started. The status of ongoing block streaming operations can be checked
2200 # with query-block-jobs. The operation can be stopped before it has completed
2201 # using the block-job-cancel command.
2203 # The node that receives the data is called the top image, can be located in
2204 # any part of the chain (but always above the base image; see below) and can be
2205 # specified using its device or node name. Earlier qemu versions only allowed
2206 # 'device' to name the top level node; presence of the 'base-node' parameter
2207 # during introspection can be used as a witness of the enhanced semantics
2210 # If a base file is specified then sectors are not copied from that base file and
2211 # its backing chain. When streaming completes the image file will have the base
2212 # file as its backing file. This can be used to stream a subset of the backing
2213 # file chain instead of flattening the entire image.
2215 # On successful completion the image file is updated to drop the backing file
2216 # and the BLOCK_JOB_COMPLETED event is emitted.
2218 # @job-id: identifier for the newly-created block job. If
2219 # omitted, the device name will be used. (Since 2.7)
2221 # @device: the device or node name of the top image
2223 # @base: the common backing file name.
2224 # It cannot be set if @base-node is also set.
2226 # @base-node: the node name of the backing file.
2227 # It cannot be set if @base is also set. (Since 2.8)
2229 # @backing-file: The backing file string to write into the top
2230 # image. This filename is not validated.
2232 # If a pathname string is such that it cannot be
2233 # resolved by QEMU, that means that subsequent QMP or
2234 # HMP commands must use node-names for the image in
2235 # question, as filename lookup methods will fail.
2237 # If not specified, QEMU will automatically determine
2238 # the backing file string to use, or error out if there
2239 # is no obvious choice. Care should be taken when
2240 # specifying the string, to specify a valid filename or
2244 # @speed: the maximum speed, in bytes per second
2246 # @on-error: the action to take on an error (default report).
2247 # 'stop' and 'enospc' can only be used if the block device
2248 # supports io-status (see BlockInfo). Since 1.3.
2250 # Returns: Nothing on success. If @device does not exist, DeviceNotFound.
2256 # -> { "execute": "block-stream",
2257 # "arguments": { "device": "virtio0",
2258 # "base": "/tmp/master.qcow2" } }
2259 # <- { "return": {} }
2262 { 'command': 'block-stream',
2263 'data': { '*job-id': 'str', 'device': 'str', '*base': 'str',
2264 '*base-node': 'str', '*backing-file': 'str', '*speed': 'int',
2265 '*on-error': 'BlockdevOnError' } }
2268 # @block-job-set-speed:
2270 # Set maximum speed for a background block operation.
2272 # This command can only be issued when there is an active block job.
2274 # Throttling can be disabled by setting the speed to 0.
2276 # @device: The job identifier. This used to be a device name (hence
2277 # the name of the parameter), but since QEMU 2.7 it can have
2280 # @speed: the maximum speed, in bytes per second, or 0 for unlimited.
2283 # Returns: Nothing on success
2284 # If no background operation is active on this device, DeviceNotActive
2288 { 'command': 'block-job-set-speed',
2289 'data': { 'device': 'str', 'speed': 'int' } }
2292 # @block-job-cancel:
2294 # Stop an active background block operation.
2296 # This command returns immediately after marking the active background block
2297 # operation for cancellation. It is an error to call this command if no
2298 # operation is in progress.
2300 # The operation will cancel as soon as possible and then emit the
2301 # BLOCK_JOB_CANCELLED event. Before that happens the job is still visible when
2302 # enumerated using query-block-jobs.
2304 # Note that if you issue 'block-job-cancel' after 'drive-mirror' has indicated
2305 # (via the event BLOCK_JOB_READY) that the source and destination are
2306 # synchronized, then the event triggered by this command changes to
2307 # BLOCK_JOB_COMPLETED, to indicate that the mirroring has ended and the
2308 # destination now has a point-in-time copy tied to the time of the cancellation.
2310 # For streaming, the image file retains its backing file unless the streaming
2311 # operation happens to complete just as it is being cancelled. A new streaming
2312 # operation can be started at a later time to finish copying all data from the
2315 # @device: The job identifier. This used to be a device name (hence
2316 # the name of the parameter), but since QEMU 2.7 it can have
2319 # @force: If true, and the job has already emitted the event BLOCK_JOB_READY,
2320 # abandon the job immediately (even if it is paused) instead of waiting
2321 # for the destination to complete its final synchronization (since 1.3)
2323 # Returns: Nothing on success
2324 # If no background operation is active on this device, DeviceNotActive
2328 { 'command': 'block-job-cancel', 'data': { 'device': 'str', '*force': 'bool' } }
2333 # Pause an active background block operation.
2335 # This command returns immediately after marking the active background block
2336 # operation for pausing. It is an error to call this command if no
2337 # operation is in progress. Pausing an already paused job has no cumulative
2338 # effect; a single block-job-resume command will resume the job.
2340 # The operation will pause as soon as possible. No event is emitted when
2341 # the operation is actually paused. Cancelling a paused job automatically
2344 # @device: The job identifier. This used to be a device name (hence
2345 # the name of the parameter), but since QEMU 2.7 it can have
2348 # Returns: Nothing on success
2349 # If no background operation is active on this device, DeviceNotActive
2353 { 'command': 'block-job-pause', 'data': { 'device': 'str' } }
2356 # @block-job-resume:
2358 # Resume an active background block operation.
2360 # This command returns immediately after resuming a paused background block
2361 # operation. It is an error to call this command if no operation is in
2362 # progress. Resuming an already running job is not an error.
2364 # This command also clears the error status of the job.
2366 # @device: The job identifier. This used to be a device name (hence
2367 # the name of the parameter), but since QEMU 2.7 it can have
2370 # Returns: Nothing on success
2371 # If no background operation is active on this device, DeviceNotActive
2375 { 'command': 'block-job-resume', 'data': { 'device': 'str' } }
2378 # @block-job-complete:
2380 # Manually trigger completion of an active background block operation. This
2381 # is supported for drive mirroring, where it also switches the device to
2382 # write to the target path only. The ability to complete is signaled with
2383 # a BLOCK_JOB_READY event.
2385 # This command completes an active background block operation synchronously.
2386 # The ordering of this command's return with the BLOCK_JOB_COMPLETED event
2387 # is not defined. Note that if an I/O error occurs during the processing of
2388 # this command: 1) the command itself will fail; 2) the error will be processed
2389 # according to the rerror/werror arguments that were specified when starting
2392 # A cancelled or paused job cannot be completed.
2394 # @device: The job identifier. This used to be a device name (hence
2395 # the name of the parameter), but since QEMU 2.7 it can have
2398 # Returns: Nothing on success
2399 # If no background operation is active on this device, DeviceNotActive
2403 { 'command': 'block-job-complete', 'data': { 'device': 'str' } }
2406 # @block-job-dismiss:
2408 # For jobs that have already concluded, remove them from the block-job-query
2409 # list. This command only needs to be run for jobs which were started with
2410 # QEMU 2.12+ job lifetime management semantics.
2412 # This command will refuse to operate on any job that has not yet reached
2413 # its terminal state, BLOCK_JOB_STATUS_CONCLUDED. For jobs that make use of
2414 # BLOCK_JOB_READY event, block-job-cancel or block-job-complete will still need
2415 # to be used as appropriate.
2417 # @id: The job identifier.
2419 # Returns: Nothing on success
2423 { 'command': 'block-job-dismiss', 'data': { 'id': 'str' } }
2426 # @block-job-finalize:
2428 # Once a job that has manual=true reaches the pending state, it can be
2429 # instructed to finalize any graph changes and do any necessary cleanup
2431 # For jobs in a transaction, instructing one job to finalize will force
2432 # ALL jobs in the transaction to finalize, so it is only necessary to instruct
2433 # a single member job to finalize.
2435 # @id: The job identifier.
2437 # Returns: Nothing on success
2441 { 'command': 'block-job-finalize', 'data': { 'id': 'str' } }
2444 # @BlockdevDiscardOptions:
2446 # Determines how to handle discard requests.
2448 # @ignore: Ignore the request
2449 # @unmap: Forward as an unmap request
2453 { 'enum': 'BlockdevDiscardOptions',
2454 'data': [ 'ignore', 'unmap' ] }
2457 # @BlockdevDetectZeroesOptions:
2459 # Describes the operation mode for the automatic conversion of plain
2460 # zero writes by the OS to driver specific optimized zero write commands.
2462 # @off: Disabled (default)
2464 # @unmap: Enabled and even try to unmap blocks if possible. This requires
2465 # also that @BlockdevDiscardOptions is set to unmap for this device.
2469 { 'enum': 'BlockdevDetectZeroesOptions',
2470 'data': [ 'off', 'on', 'unmap' ] }
2473 # @BlockdevAioOptions:
2475 # Selects the AIO backend to handle I/O requests
2477 # @threads: Use qemu's thread pool
2478 # @native: Use native AIO backend (only Linux and Windows)
2482 { 'enum': 'BlockdevAioOptions',
2483 'data': [ 'threads', 'native' ] }
2486 # @BlockdevCacheOptions:
2488 # Includes cache-related options for block devices
2490 # @direct: enables use of O_DIRECT (bypass the host page cache;
2492 # @no-flush: ignore any flush requests for the device (default:
2497 { 'struct': 'BlockdevCacheOptions',
2498 'data': { '*direct': 'bool',
2499 '*no-flush': 'bool' } }
2504 # Drivers that are supported in block device operations.
2507 # @throttle: Since 2.11
2512 { 'enum': 'BlockdevDriver',
2513 'data': [ 'blkdebug', 'blkverify', 'bochs', 'cloop',
2514 'dmg', 'file', 'ftp', 'ftps', 'gluster', 'host_cdrom',
2515 'host_device', 'http', 'https', 'iscsi', 'luks', 'nbd', 'nfs',
2516 'null-aio', 'null-co', 'nvme', 'parallels', 'qcow', 'qcow2', 'qed',
2517 'quorum', 'raw', 'rbd', 'replication', 'sheepdog', 'ssh',
2518 'throttle', 'vdi', 'vhdx', 'vmdk', 'vpc', 'vvfat', 'vxhs' ] }
2521 # @BlockdevOptionsFile:
2523 # Driver specific block device options for the file backend.
2525 # @filename: path to the image file
2526 # @pr-manager: the id for the object that will handle persistent reservations
2527 # for this device (default: none, forward the commands via SG_IO;
2529 # @aio: AIO backend (default: threads) (since: 2.8)
2530 # @locking: whether to enable file locking. If set to 'auto', only enable
2531 # when Open File Descriptor (OFD) locking API is available
2532 # (default: auto, since 2.10)
2536 { 'struct': 'BlockdevOptionsFile',
2537 'data': { 'filename': 'str',
2538 '*pr-manager': 'str',
2539 '*locking': 'OnOffAuto',
2540 '*aio': 'BlockdevAioOptions' } }
2543 # @BlockdevOptionsNull:
2545 # Driver specific block device options for the null backend.
2547 # @size: size of the device in bytes.
2548 # @latency-ns: emulated latency (in nanoseconds) in processing
2549 # requests. Default to zero which completes requests immediately.
2554 { 'struct': 'BlockdevOptionsNull',
2555 'data': { '*size': 'int', '*latency-ns': 'uint64' } }
2558 # @BlockdevOptionsNVMe:
2560 # Driver specific block device options for the NVMe backend.
2562 # @device: controller address of the NVMe device.
2563 # @namespace: namespace number of the device, starting from 1.
2567 { 'struct': 'BlockdevOptionsNVMe',
2568 'data': { 'device': 'str', 'namespace': 'int' } }
2571 # @BlockdevOptionsVVFAT:
2573 # Driver specific block device options for the vvfat protocol.
2575 # @dir: directory to be exported as FAT image
2576 # @fat-type: FAT type: 12, 16 or 32
2577 # @floppy: whether to export a floppy image (true) or
2578 # partitioned hard disk (false; default)
2579 # @label: set the volume label, limited to 11 bytes. FAT16 and
2580 # FAT32 traditionally have some restrictions on labels, which are
2581 # ignored by most operating systems. Defaults to "QEMU VVFAT".
2583 # @rw: whether to allow write operations (default: false)
2587 { 'struct': 'BlockdevOptionsVVFAT',
2588 'data': { 'dir': 'str', '*fat-type': 'int', '*floppy': 'bool',
2589 '*label': 'str', '*rw': 'bool' } }
2592 # @BlockdevOptionsGenericFormat:
2594 # Driver specific block device options for image format that have no option
2595 # besides their data source.
2597 # @file: reference to or definition of the data source block device
2601 { 'struct': 'BlockdevOptionsGenericFormat',
2602 'data': { 'file': 'BlockdevRef' } }
2605 # @BlockdevOptionsLUKS:
2607 # Driver specific block device options for LUKS.
2609 # @key-secret: the ID of a QCryptoSecret object providing
2610 # the decryption key (since 2.6). Mandatory except when
2611 # doing a metadata-only probe of the image.
2615 { 'struct': 'BlockdevOptionsLUKS',
2616 'base': 'BlockdevOptionsGenericFormat',
2617 'data': { '*key-secret': 'str' } }
2621 # @BlockdevOptionsGenericCOWFormat:
2623 # Driver specific block device options for image format that have no option
2624 # besides their data source and an optional backing file.
2626 # @backing: reference to or definition of the backing file block
2627 # device, null disables the backing file entirely.
2628 # Defaults to the backing file stored the image file.
2632 { 'struct': 'BlockdevOptionsGenericCOWFormat',
2633 'base': 'BlockdevOptionsGenericFormat',
2634 'data': { '*backing': 'BlockdevRefOrNull' } }
2637 # @Qcow2OverlapCheckMode:
2639 # General overlap check modes.
2641 # @none: Do not perform any checks
2643 # @constant: Perform only checks which can be done in constant time and
2644 # without reading anything from disk
2646 # @cached: Perform only checks which can be done without reading anything
2649 # @all: Perform all available overlap checks
2653 { 'enum': 'Qcow2OverlapCheckMode',
2654 'data': [ 'none', 'constant', 'cached', 'all' ] }
2657 # @Qcow2OverlapCheckFlags:
2659 # Structure of flags for each metadata structure. Setting a field to 'true'
2660 # makes qemu guard that structure against unintended overwriting. The default
2661 # value is chosen according to the template given.
2663 # @template: Specifies a template mode which can be adjusted using the other
2664 # flags, defaults to 'cached'
2668 { 'struct': 'Qcow2OverlapCheckFlags',
2669 'data': { '*template': 'Qcow2OverlapCheckMode',
2670 '*main-header': 'bool',
2671 '*active-l1': 'bool',
2672 '*active-l2': 'bool',
2673 '*refcount-table': 'bool',
2674 '*refcount-block': 'bool',
2675 '*snapshot-table': 'bool',
2676 '*inactive-l1': 'bool',
2677 '*inactive-l2': 'bool' } }
2680 # @Qcow2OverlapChecks:
2682 # Specifies which metadata structures should be guarded against unintended
2685 # @flags: set of flags for separate specification of each metadata structure
2688 # @mode: named mode which chooses a specific set of flags
2692 { 'alternate': 'Qcow2OverlapChecks',
2693 'data': { 'flags': 'Qcow2OverlapCheckFlags',
2694 'mode': 'Qcow2OverlapCheckMode' } }
2697 # @BlockdevQcowEncryptionFormat:
2699 # @aes: AES-CBC with plain64 initialization vectors
2703 { 'enum': 'BlockdevQcowEncryptionFormat',
2707 # @BlockdevQcowEncryption:
2711 { 'union': 'BlockdevQcowEncryption',
2712 'base': { 'format': 'BlockdevQcowEncryptionFormat' },
2713 'discriminator': 'format',
2714 'data': { 'aes': 'QCryptoBlockOptionsQCow' } }
2717 # @BlockdevOptionsQcow:
2719 # Driver specific block device options for qcow.
2721 # @encrypt: Image decryption options. Mandatory for
2722 # encrypted images, except when doing a metadata-only
2723 # probe of the image.
2727 { 'struct': 'BlockdevOptionsQcow',
2728 'base': 'BlockdevOptionsGenericCOWFormat',
2729 'data': { '*encrypt': 'BlockdevQcowEncryption' } }
2734 # @BlockdevQcow2EncryptionFormat:
2735 # @aes: AES-CBC with plain64 initialization venctors
2739 { 'enum': 'BlockdevQcow2EncryptionFormat',
2740 'data': [ 'aes', 'luks' ] }
2743 # @BlockdevQcow2Encryption:
2747 { 'union': 'BlockdevQcow2Encryption',
2748 'base': { 'format': 'BlockdevQcow2EncryptionFormat' },
2749 'discriminator': 'format',
2750 'data': { 'aes': 'QCryptoBlockOptionsQCow',
2751 'luks': 'QCryptoBlockOptionsLUKS'} }
2754 # @BlockdevOptionsQcow2:
2756 # Driver specific block device options for qcow2.
2758 # @lazy-refcounts: whether to enable the lazy refcounts
2759 # feature (default is taken from the image file)
2761 # @pass-discard-request: whether discard requests to the qcow2
2762 # device should be forwarded to the data source
2764 # @pass-discard-snapshot: whether discard requests for the data source
2765 # should be issued when a snapshot operation (e.g.
2766 # deleting a snapshot) frees clusters in the qcow2 file
2768 # @pass-discard-other: whether discard requests for the data source
2769 # should be issued on other occasions where a cluster
2772 # @overlap-check: which overlap checks to perform for writes
2773 # to the image, defaults to 'cached' (since 2.2)
2775 # @cache-size: the maximum total size of the L2 table and
2776 # refcount block caches in bytes (since 2.2)
2778 # @l2-cache-size: the maximum size of the L2 table cache in
2781 # @l2-cache-entry-size: the size of each entry in the L2 cache in
2782 # bytes. It must be a power of two between 512
2783 # and the cluster size. The default value is
2784 # the cluster size (since 2.12)
2786 # @refcount-cache-size: the maximum size of the refcount block cache
2787 # in bytes (since 2.2)
2789 # @cache-clean-interval: clean unused entries in the L2 and refcount
2790 # caches. The interval is in seconds. The default value
2791 # is 0 and it disables this feature (since 2.5)
2792 # @encrypt: Image decryption options. Mandatory for
2793 # encrypted images, except when doing a metadata-only
2794 # probe of the image. (since 2.10)
2798 { 'struct': 'BlockdevOptionsQcow2',
2799 'base': 'BlockdevOptionsGenericCOWFormat',
2800 'data': { '*lazy-refcounts': 'bool',
2801 '*pass-discard-request': 'bool',
2802 '*pass-discard-snapshot': 'bool',
2803 '*pass-discard-other': 'bool',
2804 '*overlap-check': 'Qcow2OverlapChecks',
2805 '*cache-size': 'int',
2806 '*l2-cache-size': 'int',
2807 '*l2-cache-entry-size': 'int',
2808 '*refcount-cache-size': 'int',
2809 '*cache-clean-interval': 'int',
2810 '*encrypt': 'BlockdevQcow2Encryption' } }
2813 # @SshHostKeyCheckMode:
2815 # @none Don't check the host key at all
2816 # @hash Compare the host key with a given hash
2817 # @known_hosts Check the host key against the known_hosts file
2821 { 'enum': 'SshHostKeyCheckMode',
2822 'data': [ 'none', 'hash', 'known_hosts' ] }
2825 # @SshHostKeyCheckHashType:
2827 # @md5 The given hash is an md5 hash
2828 # @sha1 The given hash is an sha1 hash
2832 { 'enum': 'SshHostKeyCheckHashType',
2833 'data': [ 'md5', 'sha1' ] }
2838 # @type The hash algorithm used for the hash
2839 # @hash The expected hash value
2843 { 'struct': 'SshHostKeyHash',
2844 'data': { 'type': 'SshHostKeyCheckHashType',
2850 # For those union branches that don't need additional fields.
2854 { 'struct': 'SshHostKeyDummy',
2862 { 'union': 'SshHostKeyCheck',
2863 'base': { 'mode': 'SshHostKeyCheckMode' },
2864 'discriminator': 'mode',
2865 'data': { 'none': 'SshHostKeyDummy',
2866 'hash': 'SshHostKeyHash',
2867 'known_hosts': 'SshHostKeyDummy' } }
2870 # @BlockdevOptionsSsh:
2872 # @server: host address
2874 # @path: path to the image on the host
2876 # @user: user as which to connect, defaults to current
2879 # @host-key-check: Defines how and what to check the host key against
2880 # (default: known_hosts)
2884 { 'struct': 'BlockdevOptionsSsh',
2885 'data': { 'server': 'InetSocketAddress',
2888 '*host-key-check': 'SshHostKeyCheck' } }
2894 # Trigger events supported by blkdebug.
2896 # @l1_shrink_write_table: write zeros to the l1 table to shrink image.
2899 # @l1_shrink_free_l2_clusters: discard the l2 tables. (since 2.11)
2901 # @cor_write: a write due to copy-on-read (since 2.11)
2905 { 'enum': 'BlkdebugEvent', 'prefix': 'BLKDBG',
2906 'data': [ 'l1_update', 'l1_grow_alloc_table', 'l1_grow_write_table',
2907 'l1_grow_activate_table', 'l2_load', 'l2_update',
2908 'l2_update_compressed', 'l2_alloc_cow_read', 'l2_alloc_write',
2909 'read_aio', 'read_backing_aio', 'read_compressed', 'write_aio',
2910 'write_compressed', 'vmstate_load', 'vmstate_save', 'cow_read',
2911 'cow_write', 'reftable_load', 'reftable_grow', 'reftable_update',
2912 'refblock_load', 'refblock_update', 'refblock_update_part',
2913 'refblock_alloc', 'refblock_alloc_hookup', 'refblock_alloc_write',
2914 'refblock_alloc_write_blocks', 'refblock_alloc_write_table',
2915 'refblock_alloc_switch_table', 'cluster_alloc',
2916 'cluster_alloc_bytes', 'cluster_free', 'flush_to_os',
2917 'flush_to_disk', 'pwritev_rmw_head', 'pwritev_rmw_after_head',
2918 'pwritev_rmw_tail', 'pwritev_rmw_after_tail', 'pwritev',
2919 'pwritev_zero', 'pwritev_done', 'empty_image_prepare',
2920 'l1_shrink_write_table', 'l1_shrink_free_l2_clusters',
2924 # @BlkdebugInjectErrorOptions:
2926 # Describes a single error injection for blkdebug.
2928 # @event: trigger event
2930 # @state: the state identifier blkdebug needs to be in to
2931 # actually trigger the event; defaults to "any"
2933 # @errno: error identifier (errno) to be returned; defaults to
2936 # @sector: specifies the sector index which has to be affected
2937 # in order to actually trigger the event; defaults to "any
2940 # @once: disables further events after this one has been
2941 # triggered; defaults to false
2943 # @immediately: fail immediately; defaults to false
2947 { 'struct': 'BlkdebugInjectErrorOptions',
2948 'data': { 'event': 'BlkdebugEvent',
2953 '*immediately': 'bool' } }
2956 # @BlkdebugSetStateOptions:
2958 # Describes a single state-change event for blkdebug.
2960 # @event: trigger event
2962 # @state: the current state identifier blkdebug needs to be in;
2965 # @new_state: the state identifier blkdebug is supposed to assume if
2966 # this event is triggered
2970 { 'struct': 'BlkdebugSetStateOptions',
2971 'data': { 'event': 'BlkdebugEvent',
2973 'new_state': 'int' } }
2976 # @BlockdevOptionsBlkdebug:
2978 # Driver specific block device options for blkdebug.
2980 # @image: underlying raw block device (or image file)
2982 # @config: filename of the configuration file
2984 # @align: required alignment for requests in bytes, must be
2985 # positive power of 2, or 0 for default
2987 # @max-transfer: maximum size for I/O transfers in bytes, must be
2988 # positive multiple of @align and of the underlying
2989 # file's request alignment (but need not be a power of
2990 # 2), or 0 for default (since 2.10)
2992 # @opt-write-zero: preferred alignment for write zero requests in bytes,
2993 # must be positive multiple of @align and of the
2994 # underlying file's request alignment (but need not be a
2995 # power of 2), or 0 for default (since 2.10)
2997 # @max-write-zero: maximum size for write zero requests in bytes, must be
2998 # positive multiple of @align, of @opt-write-zero, and of
2999 # the underlying file's request alignment (but need not
3000 # be a power of 2), or 0 for default (since 2.10)
3002 # @opt-discard: preferred alignment for discard requests in bytes, must
3003 # be positive multiple of @align and of the underlying
3004 # file's request alignment (but need not be a power of
3005 # 2), or 0 for default (since 2.10)
3007 # @max-discard: maximum size for discard requests in bytes, must be
3008 # positive multiple of @align, of @opt-discard, and of
3009 # the underlying file's request alignment (but need not
3010 # be a power of 2), or 0 for default (since 2.10)
3012 # @inject-error: array of error injection descriptions
3014 # @set-state: array of state-change descriptions
3018 { 'struct': 'BlockdevOptionsBlkdebug',
3019 'data': { 'image': 'BlockdevRef',
3021 '*align': 'int', '*max-transfer': 'int32',
3022 '*opt-write-zero': 'int32', '*max-write-zero': 'int32',
3023 '*opt-discard': 'int32', '*max-discard': 'int32',
3024 '*inject-error': ['BlkdebugInjectErrorOptions'],
3025 '*set-state': ['BlkdebugSetStateOptions'] } }
3028 # @BlockdevOptionsBlkverify:
3030 # Driver specific block device options for blkverify.
3032 # @test: block device to be tested
3034 # @raw: raw image used for verification
3038 { 'struct': 'BlockdevOptionsBlkverify',
3039 'data': { 'test': 'BlockdevRef',
3040 'raw': 'BlockdevRef' } }
3043 # @QuorumReadPattern:
3045 # An enumeration of quorum read patterns.
3047 # @quorum: read all the children and do a quorum vote on reads
3049 # @fifo: read only from the first child that has not failed
3053 { 'enum': 'QuorumReadPattern', 'data': [ 'quorum', 'fifo' ] }
3056 # @BlockdevOptionsQuorum:
3058 # Driver specific block device options for Quorum
3060 # @blkverify: true if the driver must print content mismatch
3061 # set to false by default
3063 # @children: the children block devices to use
3065 # @vote-threshold: the vote limit under which a read will fail
3067 # @rewrite-corrupted: rewrite corrupted data when quorum is reached
3070 # @read-pattern: choose read pattern and set to quorum by default
3075 { 'struct': 'BlockdevOptionsQuorum',
3076 'data': { '*blkverify': 'bool',
3077 'children': [ 'BlockdevRef' ],
3078 'vote-threshold': 'int',
3079 '*rewrite-corrupted': 'bool',
3080 '*read-pattern': 'QuorumReadPattern' } }
3083 # @BlockdevOptionsGluster:
3085 # Driver specific block device options for Gluster
3087 # @volume: name of gluster volume where VM image resides
3089 # @path: absolute path to image file in gluster volume
3091 # @server: gluster servers description
3093 # @debug: libgfapi log level (default '4' which is Error)
3096 # @logfile: libgfapi log file (default /dev/stderr) (Since 2.8)
3100 { 'struct': 'BlockdevOptionsGluster',
3101 'data': { 'volume': 'str',
3103 'server': ['SocketAddress'],
3105 '*logfile': 'str' } }
3110 # An enumeration of libiscsi transport types
3114 { 'enum': 'IscsiTransport',
3115 'data': [ 'tcp', 'iser' ] }
3118 # @IscsiHeaderDigest:
3120 # An enumeration of header digests supported by libiscsi
3124 { 'enum': 'IscsiHeaderDigest',
3125 'prefix': 'QAPI_ISCSI_HEADER_DIGEST',
3126 'data': [ 'crc32c', 'none', 'crc32c-none', 'none-crc32c' ] }
3129 # @BlockdevOptionsIscsi:
3131 # @transport: The iscsi transport type
3133 # @portal: The address of the iscsi portal
3135 # @target: The target iqn name
3137 # @lun: LUN to connect to. Defaults to 0.
3139 # @user: User name to log in with. If omitted, no CHAP
3140 # authentication is performed.
3142 # @password-secret: The ID of a QCryptoSecret object providing
3143 # the password for the login. This option is required if
3144 # @user is specified.
3146 # @initiator-name: The iqn name we want to identify to the target
3147 # as. If this option is not specified, an initiator name is
3148 # generated automatically.
3150 # @header-digest: The desired header digest. Defaults to
3153 # @timeout: Timeout in seconds after which a request will
3154 # timeout. 0 means no timeout and is the default.
3156 # Driver specific block device options for iscsi
3160 { 'struct': 'BlockdevOptionsIscsi',
3161 'data': { 'transport': 'IscsiTransport',
3166 '*password-secret': 'str',
3167 '*initiator-name': 'str',
3168 '*header-digest': 'IscsiHeaderDigest',
3169 '*timeout': 'int' } }
3173 # @BlockdevOptionsRbd:
3175 # @pool: Ceph pool name.
3177 # @image: Image name in the Ceph pool.
3179 # @conf: path to Ceph configuration file. Values
3180 # in the configuration file will be overridden by
3181 # options specified via QAPI.
3183 # @snapshot: Ceph snapshot name.
3185 # @user: Ceph id name.
3187 # @server: Monitor host address and port. This maps
3188 # to the "mon_host" Ceph option.
3192 { 'struct': 'BlockdevOptionsRbd',
3193 'data': { 'pool': 'str',
3198 '*server': ['InetSocketAddressBase'] } }
3201 # @BlockdevOptionsSheepdog:
3203 # Driver specific block device options for sheepdog
3205 # @vdi: Virtual disk image name
3206 # @server: The Sheepdog server to connect to
3207 # @snap-id: Snapshot ID
3208 # @tag: Snapshot tag name
3210 # Only one of @snap-id and @tag may be present.
3214 { 'struct': 'BlockdevOptionsSheepdog',
3215 'data': { 'server': 'SocketAddress',
3217 '*snap-id': 'uint32',
3223 # An enumeration of replication modes.
3225 # @primary: Primary mode, the vm's state will be sent to secondary QEMU.
3227 # @secondary: Secondary mode, receive the vm's state from primary QEMU.
3231 { 'enum' : 'ReplicationMode', 'data' : [ 'primary', 'secondary' ] }
3234 # @BlockdevOptionsReplication:
3236 # Driver specific block device options for replication
3238 # @mode: the replication mode
3240 # @top-id: In secondary mode, node name or device ID of the root
3241 # node who owns the replication node chain. Must not be given in
3246 { 'struct': 'BlockdevOptionsReplication',
3247 'base': 'BlockdevOptionsGenericFormat',
3248 'data': { 'mode': 'ReplicationMode',
3249 '*top-id': 'str' } }
3254 # An enumeration of NFS transport types
3256 # @inet: TCP transport
3260 { 'enum': 'NFSTransport',
3261 'data': [ 'inet' ] }
3266 # Captures the address of the socket
3268 # @type: transport type used for NFS (only TCP supported)
3270 # @host: host address for NFS server
3274 { 'struct': 'NFSServer',
3275 'data': { 'type': 'NFSTransport',
3279 # @BlockdevOptionsNfs:
3281 # Driver specific block device option for NFS
3283 # @server: host address
3285 # @path: path of the image on the host
3287 # @user: UID value to use when talking to the
3288 # server (defaults to 65534 on Windows and getuid()
3291 # @group: GID value to use when talking to the
3292 # server (defaults to 65534 on Windows and getgid()
3295 # @tcp-syn-count: number of SYNs during the session
3296 # establishment (defaults to libnfs default)
3298 # @readahead-size: set the readahead size in bytes (defaults
3299 # to libnfs default)
3301 # @page-cache-size: set the pagecache size in bytes (defaults
3302 # to libnfs default)
3304 # @debug: set the NFS debug level (max 2) (defaults
3305 # to libnfs default)
3309 { 'struct': 'BlockdevOptionsNfs',
3310 'data': { 'server': 'NFSServer',
3314 '*tcp-syn-count': 'int',
3315 '*readahead-size': 'int',
3316 '*page-cache-size': 'int',
3320 # @BlockdevOptionsCurlBase:
3322 # Driver specific block device options shared by all protocols supported by the
3325 # @url: URL of the image file
3327 # @readahead: Size of the read-ahead cache; must be a multiple of
3328 # 512 (defaults to 256 kB)
3330 # @timeout: Timeout for connections, in seconds (defaults to 5)
3332 # @username: Username for authentication (defaults to none)
3334 # @password-secret: ID of a QCryptoSecret object providing a password
3335 # for authentication (defaults to no password)
3337 # @proxy-username: Username for proxy authentication (defaults to none)
3339 # @proxy-password-secret: ID of a QCryptoSecret object providing a password
3340 # for proxy authentication (defaults to no password)
3344 { 'struct': 'BlockdevOptionsCurlBase',
3345 'data': { 'url': 'str',
3346 '*readahead': 'int',
3349 '*password-secret': 'str',
3350 '*proxy-username': 'str',
3351 '*proxy-password-secret': 'str' } }
3354 # @BlockdevOptionsCurlHttp:
3356 # Driver specific block device options for HTTP connections over the curl
3357 # backend. URLs must start with "http://".
3359 # @cookie: List of cookies to set; format is
3360 # "name1=content1; name2=content2;" as explained by
3361 # CURLOPT_COOKIE(3). Defaults to no cookies.
3363 # @cookie-secret: ID of a QCryptoSecret object providing the cookie data in a
3364 # secure way. See @cookie for the format. (since 2.10)
3368 { 'struct': 'BlockdevOptionsCurlHttp',
3369 'base': 'BlockdevOptionsCurlBase',
3370 'data': { '*cookie': 'str',
3371 '*cookie-secret': 'str'} }
3374 # @BlockdevOptionsCurlHttps:
3376 # Driver specific block device options for HTTPS connections over the curl
3377 # backend. URLs must start with "https://".
3379 # @cookie: List of cookies to set; format is
3380 # "name1=content1; name2=content2;" as explained by
3381 # CURLOPT_COOKIE(3). Defaults to no cookies.
3383 # @sslverify: Whether to verify the SSL certificate's validity (defaults to
3386 # @cookie-secret: ID of a QCryptoSecret object providing the cookie data in a
3387 # secure way. See @cookie for the format. (since 2.10)
3391 { 'struct': 'BlockdevOptionsCurlHttps',
3392 'base': 'BlockdevOptionsCurlBase',
3393 'data': { '*cookie': 'str',
3394 '*sslverify': 'bool',
3395 '*cookie-secret': 'str'} }
3398 # @BlockdevOptionsCurlFtp:
3400 # Driver specific block device options for FTP connections over the curl
3401 # backend. URLs must start with "ftp://".
3405 { 'struct': 'BlockdevOptionsCurlFtp',
3406 'base': 'BlockdevOptionsCurlBase',
3410 # @BlockdevOptionsCurlFtps:
3412 # Driver specific block device options for FTPS connections over the curl
3413 # backend. URLs must start with "ftps://".
3415 # @sslverify: Whether to verify the SSL certificate's validity (defaults to
3420 { 'struct': 'BlockdevOptionsCurlFtps',
3421 'base': 'BlockdevOptionsCurlBase',
3422 'data': { '*sslverify': 'bool' } }
3425 # @BlockdevOptionsNbd:
3427 # Driver specific block device options for NBD.
3429 # @server: NBD server address
3431 # @export: export name
3433 # @tls-creds: TLS credentials ID
3437 { 'struct': 'BlockdevOptionsNbd',
3438 'data': { 'server': 'SocketAddress',
3440 '*tls-creds': 'str' } }
3443 # @BlockdevOptionsRaw:
3445 # Driver specific block device options for the raw driver.
3447 # @offset: position where the block device starts
3448 # @size: the assumed size of the device
3452 { 'struct': 'BlockdevOptionsRaw',
3453 'base': 'BlockdevOptionsGenericFormat',
3454 'data': { '*offset': 'int', '*size': 'int' } }
3457 # @BlockdevOptionsVxHS:
3459 # Driver specific block device options for VxHS
3461 # @vdisk-id: UUID of VxHS volume
3462 # @server: vxhs server IP, port
3463 # @tls-creds: TLS credentials ID
3467 { 'struct': 'BlockdevOptionsVxHS',
3468 'data': { 'vdisk-id': 'str',
3469 'server': 'InetSocketAddressBase',
3470 '*tls-creds': 'str' } }
3473 # @BlockdevOptionsThrottle:
3475 # Driver specific block device options for the throttle driver
3477 # @throttle-group: the name of the throttle-group object to use. It
3478 # must already exist.
3479 # @file: reference to or definition of the data source block device
3482 { 'struct': 'BlockdevOptionsThrottle',
3483 'data': { 'throttle-group': 'str',
3484 'file' : 'BlockdevRef'
3489 # Options for creating a block device. Many options are available for all
3490 # block devices, independent of the block driver:
3492 # @driver: block driver name
3493 # @node-name: the node name of the new node (Since 2.0).
3494 # This option is required on the top level of blockdev-add.
3495 # @discard: discard-related options (default: ignore)
3496 # @cache: cache-related options
3497 # @read-only: whether the block device should be read-only (default: false).
3498 # Note that some block drivers support only read-only access,
3499 # either generally or in certain configurations. In this case,
3500 # the default value does not work and the option must be
3501 # specified explicitly.
3502 # @detect-zeroes: detect and optimize zero writes (Since 2.1)
3504 # @force-share: force share all permission on added nodes.
3505 # Requires read-only=true. (Since 2.10)
3507 # Remaining options are determined by the block driver.
3511 { 'union': 'BlockdevOptions',
3512 'base': { 'driver': 'BlockdevDriver',
3513 '*node-name': 'str',
3514 '*discard': 'BlockdevDiscardOptions',
3515 '*cache': 'BlockdevCacheOptions',
3516 '*read-only': 'bool',
3517 '*force-share': 'bool',
3518 '*detect-zeroes': 'BlockdevDetectZeroesOptions' },
3519 'discriminator': 'driver',
3521 'blkdebug': 'BlockdevOptionsBlkdebug',
3522 'blkverify': 'BlockdevOptionsBlkverify',
3523 'bochs': 'BlockdevOptionsGenericFormat',
3524 'cloop': 'BlockdevOptionsGenericFormat',
3525 'dmg': 'BlockdevOptionsGenericFormat',
3526 'file': 'BlockdevOptionsFile',
3527 'ftp': 'BlockdevOptionsCurlFtp',
3528 'ftps': 'BlockdevOptionsCurlFtps',
3529 'gluster': 'BlockdevOptionsGluster',
3530 'host_cdrom': 'BlockdevOptionsFile',
3531 'host_device':'BlockdevOptionsFile',
3532 'http': 'BlockdevOptionsCurlHttp',
3533 'https': 'BlockdevOptionsCurlHttps',
3534 'iscsi': 'BlockdevOptionsIscsi',
3535 'luks': 'BlockdevOptionsLUKS',
3536 'nbd': 'BlockdevOptionsNbd',
3537 'nfs': 'BlockdevOptionsNfs',
3538 'null-aio': 'BlockdevOptionsNull',
3539 'null-co': 'BlockdevOptionsNull',
3540 'nvme': 'BlockdevOptionsNVMe',
3541 'parallels': 'BlockdevOptionsGenericFormat',
3542 'qcow2': 'BlockdevOptionsQcow2',
3543 'qcow': 'BlockdevOptionsQcow',
3544 'qed': 'BlockdevOptionsGenericCOWFormat',
3545 'quorum': 'BlockdevOptionsQuorum',
3546 'raw': 'BlockdevOptionsRaw',
3547 'rbd': 'BlockdevOptionsRbd',
3548 'replication':'BlockdevOptionsReplication',
3549 'sheepdog': 'BlockdevOptionsSheepdog',
3550 'ssh': 'BlockdevOptionsSsh',
3551 'throttle': 'BlockdevOptionsThrottle',
3552 'vdi': 'BlockdevOptionsGenericFormat',
3553 'vhdx': 'BlockdevOptionsGenericFormat',
3554 'vmdk': 'BlockdevOptionsGenericCOWFormat',
3555 'vpc': 'BlockdevOptionsGenericFormat',
3556 'vvfat': 'BlockdevOptionsVVFAT',
3557 'vxhs': 'BlockdevOptionsVxHS'
3563 # Reference to a block device.
3565 # @definition: defines a new block device inline
3566 # @reference: references the ID of an existing block device
3570 { 'alternate': 'BlockdevRef',
3571 'data': { 'definition': 'BlockdevOptions',
3572 'reference': 'str' } }
3575 # @BlockdevRefOrNull:
3577 # Reference to a block device.
3579 # @definition: defines a new block device inline
3580 # @reference: references the ID of an existing block device.
3581 # An empty string means that no block device should
3582 # be referenced. Deprecated; use null instead.
3583 # @null: No block device should be referenced (since 2.10)
3587 { 'alternate': 'BlockdevRefOrNull',
3588 'data': { 'definition': 'BlockdevOptions',
3595 # Creates a new block device. If the @id option is given at the top level, a
3596 # BlockBackend will be created; otherwise, @node-name is mandatory at the top
3597 # level and no BlockBackend will be created.
3604 # -> { "execute": "blockdev-add",
3606 # "driver": "qcow2",
3607 # "node-name": "test1",
3610 # "filename": "test.qcow2"
3614 # <- { "return": {} }
3617 # -> { "execute": "blockdev-add",
3619 # "driver": "qcow2",
3620 # "node-name": "node0",
3621 # "discard": "unmap",
3627 # "filename": "/tmp/test.qcow2"
3633 # "filename": "/dev/fdset/4"
3639 # <- { "return": {} }
3642 { 'command': 'blockdev-add', 'data': 'BlockdevOptions', 'boxed': true }
3647 # Deletes a block device that has been added using blockdev-add.
3648 # The command will fail if the node is attached to a device or is
3649 # otherwise being used.
3651 # @node-name: Name of the graph node to delete.
3657 # -> { "execute": "blockdev-add",
3659 # "driver": "qcow2",
3660 # "node-name": "node0",
3663 # "filename": "test.qcow2"
3667 # <- { "return": {} }
3669 # -> { "execute": "blockdev-del",
3670 # "arguments": { "node-name": "node0" }
3672 # <- { "return": {} }
3675 { 'command': 'blockdev-del', 'data': { 'node-name': 'str' } }
3678 # @BlockdevCreateOptionsFile:
3680 # Driver specific image creation options for file.
3682 # @filename Filename for the new image file
3683 # @size Size of the virtual disk in bytes
3684 # @preallocation Preallocation mode for the new image (default: off)
3685 # @nocow Turn off copy-on-write (valid only on btrfs; default: off)
3689 { 'struct': 'BlockdevCreateOptionsFile',
3690 'data': { 'filename': 'str',
3692 '*preallocation': 'PreallocMode',
3693 '*nocow': 'bool' } }
3696 # @BlockdevCreateOptionsGluster:
3698 # Driver specific image creation options for gluster.
3700 # @location Where to store the new image file
3701 # @size Size of the virtual disk in bytes
3702 # @preallocation Preallocation mode for the new image (default: off)
3706 { 'struct': 'BlockdevCreateOptionsGluster',
3707 'data': { 'location': 'BlockdevOptionsGluster',
3709 '*preallocation': 'PreallocMode' } }
3712 # @BlockdevCreateOptionsLUKS:
3714 # Driver specific image creation options for LUKS.
3716 # @file Node to create the image format on
3717 # @size Size of the virtual disk in bytes
3721 { 'struct': 'BlockdevCreateOptionsLUKS',
3722 'base': 'QCryptoBlockCreateOptionsLUKS',
3723 'data': { 'file': 'BlockdevRef',
3727 # @BlockdevCreateOptionsNfs:
3729 # Driver specific image creation options for NFS.
3731 # @location Where to store the new image file
3732 # @size Size of the virtual disk in bytes
3736 { 'struct': 'BlockdevCreateOptionsNfs',
3737 'data': { 'location': 'BlockdevOptionsNfs',
3741 # @BlockdevCreateOptionsParallels:
3743 # Driver specific image creation options for parallels.
3745 # @file Node to create the image format on
3746 # @size Size of the virtual disk in bytes
3747 # @cluster-size Cluster size in bytes (default: 1 MB)
3751 { 'struct': 'BlockdevCreateOptionsParallels',
3752 'data': { 'file': 'BlockdevRef',
3754 '*cluster-size': 'size' } }
3757 # @BlockdevCreateOptionsQcow:
3759 # Driver specific image creation options for qcow.
3761 # @file Node to create the image format on
3762 # @size Size of the virtual disk in bytes
3763 # @backing-file File name of the backing file if a backing file
3765 # @encrypt Encryption options if the image should be encrypted
3769 { 'struct': 'BlockdevCreateOptionsQcow',
3770 'data': { 'file': 'BlockdevRef',
3772 '*backing-file': 'str',
3773 '*encrypt': 'QCryptoBlockCreateOptions' } }
3776 # @BlockdevQcow2Version:
3778 # @v2: The original QCOW2 format as introduced in qemu 0.10 (version 2)
3779 # @v3: The extended QCOW2 format as introduced in qemu 1.1 (version 3)
3783 { 'enum': 'BlockdevQcow2Version',
3784 'data': [ 'v2', 'v3' ] }
3788 # @BlockdevCreateOptionsQcow2:
3790 # Driver specific image creation options for qcow2.
3792 # @file Node to create the image format on
3793 # @size Size of the virtual disk in bytes
3794 # @version Compatibility level (default: v3)
3795 # @backing-file File name of the backing file if a backing file
3797 # @backing-fmt Name of the block driver to use for the backing file
3798 # @encrypt Encryption options if the image should be encrypted
3799 # @cluster-size qcow2 cluster size in bytes (default: 65536)
3800 # @preallocation Preallocation mode for the new image (default: off)
3801 # @lazy-refcounts True if refcounts may be updated lazily (default: off)
3802 # @refcount-bits Width of reference counts in bits (default: 16)
3806 { 'struct': 'BlockdevCreateOptionsQcow2',
3807 'data': { 'file': 'BlockdevRef',
3809 '*version': 'BlockdevQcow2Version',
3810 '*backing-file': 'str',
3811 '*backing-fmt': 'BlockdevDriver',
3812 '*encrypt': 'QCryptoBlockCreateOptions',
3813 '*cluster-size': 'size',
3814 '*preallocation': 'PreallocMode',
3815 '*lazy-refcounts': 'bool',
3816 '*refcount-bits': 'int' } }
3819 # @BlockdevCreateOptionsQed:
3821 # Driver specific image creation options for qed.
3823 # @file Node to create the image format on
3824 # @size Size of the virtual disk in bytes
3825 # @backing-file File name of the backing file if a backing file
3827 # @backing-fmt Name of the block driver to use for the backing file
3828 # @cluster-size Cluster size in bytes (default: 65536)
3829 # @table-size L1/L2 table size (in clusters)
3833 { 'struct': 'BlockdevCreateOptionsQed',
3834 'data': { 'file': 'BlockdevRef',
3836 '*backing-file': 'str',
3837 '*backing-fmt': 'BlockdevDriver',
3838 '*cluster-size': 'size',
3839 '*table-size': 'int' } }
3842 # @BlockdevCreateOptionsRbd:
3844 # Driver specific image creation options for rbd/Ceph.
3846 # @location Where to store the new image file. This location cannot
3847 # point to a snapshot.
3848 # @size Size of the virtual disk in bytes
3849 # @cluster-size RBD object size
3853 { 'struct': 'BlockdevCreateOptionsRbd',
3854 'data': { 'location': 'BlockdevOptionsRbd',
3856 '*cluster-size' : 'size' } }
3859 # @SheepdogRedundancyType:
3861 # @full Create a fully replicated vdi with x copies
3862 # @erasure-coded Create an erasure coded vdi with x data strips and
3867 { 'enum': 'SheepdogRedundancyType',
3868 'data': [ 'full', 'erasure-coded' ] }
3871 # @SheepdogRedundancyFull:
3873 # @copies Number of copies to use (between 1 and 31)
3877 { 'struct': 'SheepdogRedundancyFull',
3878 'data': { 'copies': 'int' }}
3881 # @SheepdogRedundancyErasureCoded:
3883 # @data-strips Number of data strips to use (one of {2,4,8,16})
3884 # @parity-strips Number of parity strips to use (between 1 and 15)
3888 { 'struct': 'SheepdogRedundancyErasureCoded',
3889 'data': { 'data-strips': 'int',
3890 'parity-strips': 'int' }}
3893 # @SheepdogRedundancy:
3897 { 'union': 'SheepdogRedundancy',
3898 'base': { 'type': 'SheepdogRedundancyType' },
3899 'discriminator': 'type',
3900 'data': { 'full': 'SheepdogRedundancyFull',
3901 'erasure-coded': 'SheepdogRedundancyErasureCoded' } }
3904 # @BlockdevCreateOptionsSheepdog:
3906 # Driver specific image creation options for Sheepdog.
3908 # @location Where to store the new image file
3909 # @size Size of the virtual disk in bytes
3910 # @backing-file File name of a base image
3911 # @preallocation Preallocation mode (allowed values: off, full)
3912 # @redundancy Redundancy of the image
3913 # @object-size Object size of the image
3917 { 'struct': 'BlockdevCreateOptionsSheepdog',
3918 'data': { 'location': 'BlockdevOptionsSheepdog',
3920 '*backing-file': 'str',
3921 '*preallocation': 'PreallocMode',
3922 '*redundancy': 'SheepdogRedundancy',
3923 '*object-size': 'size' } }
3926 # @BlockdevCreateOptionsSsh:
3928 # Driver specific image creation options for SSH.
3930 # @location Where to store the new image file
3931 # @size Size of the virtual disk in bytes
3935 { 'struct': 'BlockdevCreateOptionsSsh',
3936 'data': { 'location': 'BlockdevOptionsSsh',
3940 # @BlockdevCreateOptionsVdi:
3942 # Driver specific image creation options for VDI.
3944 # @file Node to create the image format on
3945 # @size Size of the virtual disk in bytes
3946 # @preallocation Preallocation mode for the new image (allowed values: off,
3947 # metadata; default: off)
3951 { 'struct': 'BlockdevCreateOptionsVdi',
3952 'data': { 'file': 'BlockdevRef',
3954 '*preallocation': 'PreallocMode' } }
3957 # @BlockdevVhdxSubformat:
3959 # @dynamic: Growing image file
3960 # @fixed: Preallocated fixed-size image file
3964 { 'enum': 'BlockdevVhdxSubformat',
3965 'data': [ 'dynamic', 'fixed' ] }
3968 # @BlockdevCreateOptionsVhdx:
3970 # Driver specific image creation options for vhdx.
3972 # @file Node to create the image format on
3973 # @size Size of the virtual disk in bytes
3974 # @log-size Log size in bytes, must be a multiple of 1 MB
3976 # @block-size Block size in bytes, must be a multiple of 1 MB and not
3977 # larger than 256 MB (default: automatically choose a block
3978 # size depending on the image size)
3979 # @subformat vhdx subformat (default: dynamic)
3980 # @block-state-zero Force use of payload blocks of type 'ZERO'. Non-standard,
3981 # but default. Do not set to 'off' when using 'qemu-img
3982 # convert' with subformat=dynamic.
3986 { 'struct': 'BlockdevCreateOptionsVhdx',
3987 'data': { 'file': 'BlockdevRef',
3989 '*log-size': 'size',
3990 '*block-size': 'size',
3991 '*subformat': 'BlockdevVhdxSubformat',
3992 '*block-state-zero': 'bool' } }
3995 # @BlockdevVpcSubformat:
3997 # @dynamic: Growing image file
3998 # @fixed: Preallocated fixed-size image file
4002 { 'enum': 'BlockdevVpcSubformat',
4003 'data': [ 'dynamic', 'fixed' ] }
4006 # @BlockdevCreateOptionsVpc:
4008 # Driver specific image creation options for vpc (VHD).
4010 # @file Node to create the image format on
4011 # @size Size of the virtual disk in bytes
4012 # @subformat vhdx subformat (default: dynamic)
4013 # @force-size Force use of the exact byte size instead of rounding to the
4014 # next size that can be represented in CHS geometry
4019 { 'struct': 'BlockdevCreateOptionsVpc',
4020 'data': { 'file': 'BlockdevRef',
4022 '*subformat': 'BlockdevVpcSubformat',
4023 '*force-size': 'bool' } }
4026 # @BlockdevCreateNotSupported:
4028 # This is used for all drivers that don't support creating images.
4032 { 'struct': 'BlockdevCreateNotSupported', 'data': {}}
4035 # @BlockdevCreateOptions:
4037 # Options for creating an image format on a given node.
4039 # @driver block driver to create the image format
4043 { 'union': 'BlockdevCreateOptions',
4045 'driver': 'BlockdevDriver' },
4046 'discriminator': 'driver',
4048 'blkdebug': 'BlockdevCreateNotSupported',
4049 'blkverify': 'BlockdevCreateNotSupported',
4050 'bochs': 'BlockdevCreateNotSupported',
4051 'cloop': 'BlockdevCreateNotSupported',
4052 'dmg': 'BlockdevCreateNotSupported',
4053 'file': 'BlockdevCreateOptionsFile',
4054 'ftp': 'BlockdevCreateNotSupported',
4055 'ftps': 'BlockdevCreateNotSupported',
4056 'gluster': 'BlockdevCreateOptionsGluster',
4057 'host_cdrom': 'BlockdevCreateNotSupported',
4058 'host_device': 'BlockdevCreateNotSupported',
4059 'http': 'BlockdevCreateNotSupported',
4060 'https': 'BlockdevCreateNotSupported',
4061 'iscsi': 'BlockdevCreateNotSupported',
4062 'luks': 'BlockdevCreateOptionsLUKS',
4063 'nbd': 'BlockdevCreateNotSupported',
4064 'nfs': 'BlockdevCreateOptionsNfs',
4065 'null-aio': 'BlockdevCreateNotSupported',
4066 'null-co': 'BlockdevCreateNotSupported',
4067 'nvme': 'BlockdevCreateNotSupported',
4068 'parallels': 'BlockdevCreateOptionsParallels',
4069 'qcow': 'BlockdevCreateOptionsQcow',
4070 'qcow2': 'BlockdevCreateOptionsQcow2',
4071 'qed': 'BlockdevCreateOptionsQed',
4072 'quorum': 'BlockdevCreateNotSupported',
4073 'raw': 'BlockdevCreateNotSupported',
4074 'rbd': 'BlockdevCreateOptionsRbd',
4075 'replication': 'BlockdevCreateNotSupported',
4076 'sheepdog': 'BlockdevCreateOptionsSheepdog',
4077 'ssh': 'BlockdevCreateOptionsSsh',
4078 'throttle': 'BlockdevCreateNotSupported',
4079 'vdi': 'BlockdevCreateOptionsVdi',
4080 'vhdx': 'BlockdevCreateOptionsVhdx',
4081 'vmdk': 'BlockdevCreateNotSupported',
4082 'vpc': 'BlockdevCreateOptionsVpc',
4083 'vvfat': 'BlockdevCreateNotSupported',
4084 'vxhs': 'BlockdevCreateNotSupported'
4088 # @x-blockdev-create:
4090 # Create an image format on a given node.
4091 # TODO Replace with something asynchronous (block job?)
4095 { 'command': 'x-blockdev-create',
4096 'data': 'BlockdevCreateOptions',
4100 # @blockdev-open-tray:
4102 # Opens a block device's tray. If there is a block driver state tree inserted as
4103 # a medium, it will become inaccessible to the guest (but it will remain
4104 # associated to the block device, so closing the tray will make it accessible
4107 # If the tray was already open before, this will be a no-op.
4109 # Once the tray opens, a DEVICE_TRAY_MOVED event is emitted. There are cases in
4110 # which no such event will be generated, these include:
4111 # - if the guest has locked the tray, @force is false and the guest does not
4112 # respond to the eject request
4113 # - if the BlockBackend denoted by @device does not have a guest device attached
4115 # - if the guest device does not have an actual tray
4117 # @device: Block device name (deprecated, use @id instead)
4119 # @id: The name or QOM path of the guest device (since: 2.8)
4121 # @force: if false (the default), an eject request will be sent to
4122 # the guest if it has locked the tray (and the tray will not be opened
4123 # immediately); if true, the tray will be opened regardless of whether
4130 # -> { "execute": "blockdev-open-tray",
4131 # "arguments": { "id": "ide0-1-0" } }
4133 # <- { "timestamp": { "seconds": 1418751016,
4134 # "microseconds": 716996 },
4135 # "event": "DEVICE_TRAY_MOVED",
4136 # "data": { "device": "ide1-cd0",
4138 # "tray-open": true } }
4140 # <- { "return": {} }
4143 { 'command': 'blockdev-open-tray',
4144 'data': { '*device': 'str',
4146 '*force': 'bool' } }
4149 # @blockdev-close-tray:
4151 # Closes a block device's tray. If there is a block driver state tree associated
4152 # with the block device (which is currently ejected), that tree will be loaded
4155 # If the tray was already closed before, this will be a no-op.
4157 # @device: Block device name (deprecated, use @id instead)
4159 # @id: The name or QOM path of the guest device (since: 2.8)
4165 # -> { "execute": "blockdev-close-tray",
4166 # "arguments": { "id": "ide0-1-0" } }
4168 # <- { "timestamp": { "seconds": 1418751345,
4169 # "microseconds": 272147 },
4170 # "event": "DEVICE_TRAY_MOVED",
4171 # "data": { "device": "ide1-cd0",
4173 # "tray-open": false } }
4175 # <- { "return": {} }
4178 { 'command': 'blockdev-close-tray',
4179 'data': { '*device': 'str',
4183 # @blockdev-remove-medium:
4185 # Removes a medium (a block driver state tree) from a block device. That block
4186 # device's tray must currently be open (unless there is no attached guest
4189 # If the tray is open and there is no medium inserted, this will be a no-op.
4191 # @id: The name or QOM path of the guest device
4197 # -> { "execute": "blockdev-remove-medium",
4198 # "arguments": { "id": "ide0-1-0" } }
4200 # <- { "error": { "class": "GenericError",
4201 # "desc": "Tray of device 'ide0-1-0' is not open" } }
4203 # -> { "execute": "blockdev-open-tray",
4204 # "arguments": { "id": "ide0-1-0" } }
4206 # <- { "timestamp": { "seconds": 1418751627,
4207 # "microseconds": 549958 },
4208 # "event": "DEVICE_TRAY_MOVED",
4209 # "data": { "device": "ide1-cd0",
4211 # "tray-open": true } }
4213 # <- { "return": {} }
4215 # -> { "execute": "blockdev-remove-medium",
4216 # "arguments": { "id": "ide0-1-0" } }
4218 # <- { "return": {} }
4221 { 'command': 'blockdev-remove-medium',
4222 'data': { 'id': 'str' } }
4225 # @blockdev-insert-medium:
4227 # Inserts a medium (a block driver state tree) into a block device. That block
4228 # device's tray must currently be open (unless there is no attached guest
4229 # device) and there must be no medium inserted already.
4231 # @id: The name or QOM path of the guest device
4233 # @node-name: name of a node in the block driver state graph
4239 # -> { "execute": "blockdev-add",
4241 # "node-name": "node0",
4243 # "file": { "driver": "file",
4244 # "filename": "fedora.iso" } } }
4245 # <- { "return": {} }
4247 # -> { "execute": "blockdev-insert-medium",
4248 # "arguments": { "id": "ide0-1-0",
4249 # "node-name": "node0" } }
4251 # <- { "return": {} }
4254 { 'command': 'blockdev-insert-medium',
4255 'data': { 'id': 'str',
4256 'node-name': 'str'} }
4260 # @BlockdevChangeReadOnlyMode:
4262 # Specifies the new read-only mode of a block device subject to the
4263 # @blockdev-change-medium command.
4265 # @retain: Retains the current read-only mode
4267 # @read-only: Makes the device read-only
4269 # @read-write: Makes the device writable
4274 { 'enum': 'BlockdevChangeReadOnlyMode',
4275 'data': ['retain', 'read-only', 'read-write'] }
4279 # @blockdev-change-medium:
4281 # Changes the medium inserted into a block device by ejecting the current medium
4282 # and loading a new image file which is inserted as the new medium (this command
4283 # combines blockdev-open-tray, blockdev-remove-medium, blockdev-insert-medium
4284 # and blockdev-close-tray).
4286 # @device: Block device name (deprecated, use @id instead)
4288 # @id: The name or QOM path of the guest device
4291 # @filename: filename of the new image to be loaded
4293 # @format: format to open the new image with (defaults to
4294 # the probed format)
4296 # @read-only-mode: change the read-only mode of the device; defaults
4303 # 1. Change a removable medium
4305 # -> { "execute": "blockdev-change-medium",
4306 # "arguments": { "id": "ide0-1-0",
4307 # "filename": "/srv/images/Fedora-12-x86_64-DVD.iso",
4308 # "format": "raw" } }
4309 # <- { "return": {} }
4311 # 2. Load a read-only medium into a writable drive
4313 # -> { "execute": "blockdev-change-medium",
4314 # "arguments": { "id": "floppyA",
4315 # "filename": "/srv/images/ro.img",
4317 # "read-only-mode": "retain" } }
4320 # { "class": "GenericError",
4321 # "desc": "Could not open '/srv/images/ro.img': Permission denied" } }
4323 # -> { "execute": "blockdev-change-medium",
4324 # "arguments": { "id": "floppyA",
4325 # "filename": "/srv/images/ro.img",
4327 # "read-only-mode": "read-only" } }
4329 # <- { "return": {} }
4332 { 'command': 'blockdev-change-medium',
4333 'data': { '*device': 'str',
4337 '*read-only-mode': 'BlockdevChangeReadOnlyMode' } }
4341 # @BlockErrorAction:
4343 # An enumeration of action that has been taken when a DISK I/O occurs
4345 # @ignore: error has been ignored
4347 # @report: error has been reported to the device
4349 # @stop: error caused VM to be stopped
4353 { 'enum': 'BlockErrorAction',
4354 'data': [ 'ignore', 'report', 'stop' ] }
4358 # @BLOCK_IMAGE_CORRUPTED:
4360 # Emitted when a disk image is being marked corrupt. The image can be
4361 # identified by its device or node name. The 'device' field is always
4362 # present for compatibility reasons, but it can be empty ("") if the
4363 # image does not have a device name associated.
4365 # @device: device name. This is always present for compatibility
4366 # reasons, but it can be empty ("") if the image does not
4367 # have a device name associated.
4369 # @node-name: node name (Since: 2.4)
4371 # @msg: informative message for human consumption, such as the kind of
4372 # corruption being detected. It should not be parsed by machine as it is
4373 # not guaranteed to be stable
4375 # @offset: if the corruption resulted from an image access, this is
4376 # the host's access offset into the image
4378 # @size: if the corruption resulted from an image access, this is
4381 # @fatal: if set, the image is marked corrupt and therefore unusable after this
4382 # event and must be repaired (Since 2.2; before, every
4383 # BLOCK_IMAGE_CORRUPTED event was fatal)
4385 # Note: If action is "stop", a STOP event will eventually follow the
4386 # BLOCK_IO_ERROR event.
4390 # <- { "event": "BLOCK_IMAGE_CORRUPTED",
4391 # "data": { "device": "ide0-hd0", "node-name": "node0",
4392 # "msg": "Prevented active L1 table overwrite", "offset": 196608,
4394 # "timestamp": { "seconds": 1378126126, "microseconds": 966463 } }
4398 { 'event': 'BLOCK_IMAGE_CORRUPTED',
4399 'data': { 'device' : 'str',
4400 '*node-name' : 'str',
4404 'fatal' : 'bool' } }
4409 # Emitted when a disk I/O error occurs
4411 # @device: device name. This is always present for compatibility
4412 # reasons, but it can be empty ("") if the image does not
4413 # have a device name associated.
4415 # @node-name: node name. Note that errors may be reported for the root node
4416 # that is directly attached to a guest device rather than for the
4417 # node where the error occurred. The node name is not present if
4418 # the drive is empty. (Since: 2.8)
4420 # @operation: I/O operation
4422 # @action: action that has been taken
4424 # @nospace: true if I/O error was caused due to a no-space
4425 # condition. This key is only present if query-block's
4426 # io-status is present, please see query-block documentation
4427 # for more information (since: 2.2)
4429 # @reason: human readable string describing the error cause.
4430 # (This field is a debugging aid for humans, it should not
4431 # be parsed by applications) (since: 2.2)
4433 # Note: If action is "stop", a STOP event will eventually follow the
4434 # BLOCK_IO_ERROR event
4440 # <- { "event": "BLOCK_IO_ERROR",
4441 # "data": { "device": "ide0-hd1",
4442 # "node-name": "#block212",
4443 # "operation": "write",
4444 # "action": "stop" },
4445 # "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
4448 { 'event': 'BLOCK_IO_ERROR',
4449 'data': { 'device': 'str', '*node-name': 'str',
4450 'operation': 'IoOperationType',
4451 'action': 'BlockErrorAction', '*nospace': 'bool',
4455 # @BLOCK_JOB_COMPLETED:
4457 # Emitted when a block job has completed
4461 # @device: The job identifier. Originally the device name but other
4462 # values are allowed since QEMU 2.7
4464 # @len: maximum progress value
4466 # @offset: current progress value. On success this is equal to len.
4467 # On failure this is less than len
4469 # @speed: rate limit, bytes per second
4471 # @error: error message. Only present on failure. This field
4472 # contains a human-readable error message. There are no semantics
4473 # other than that streaming has failed and clients should not try to
4474 # interpret the error string
4480 # <- { "event": "BLOCK_JOB_COMPLETED",
4481 # "data": { "type": "stream", "device": "virtio-disk0",
4482 # "len": 10737418240, "offset": 10737418240,
4484 # "timestamp": { "seconds": 1267061043, "microseconds": 959568 } }
4487 { 'event': 'BLOCK_JOB_COMPLETED',
4488 'data': { 'type' : 'BlockJobType',
4496 # @BLOCK_JOB_CANCELLED:
4498 # Emitted when a block job has been cancelled
4502 # @device: The job identifier. Originally the device name but other
4503 # values are allowed since QEMU 2.7
4505 # @len: maximum progress value
4507 # @offset: current progress value. On success this is equal to len.
4508 # On failure this is less than len
4510 # @speed: rate limit, bytes per second
4516 # <- { "event": "BLOCK_JOB_CANCELLED",
4517 # "data": { "type": "stream", "device": "virtio-disk0",
4518 # "len": 10737418240, "offset": 134217728,
4520 # "timestamp": { "seconds": 1267061043, "microseconds": 959568 } }
4523 { 'event': 'BLOCK_JOB_CANCELLED',
4524 'data': { 'type' : 'BlockJobType',
4533 # Emitted when a block job encounters an error
4535 # @device: The job identifier. Originally the device name but other
4536 # values are allowed since QEMU 2.7
4538 # @operation: I/O operation
4540 # @action: action that has been taken
4546 # <- { "event": "BLOCK_JOB_ERROR",
4547 # "data": { "device": "ide0-hd1",
4548 # "operation": "write",
4549 # "action": "stop" },
4550 # "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
4553 { 'event': 'BLOCK_JOB_ERROR',
4554 'data': { 'device' : 'str',
4555 'operation': 'IoOperationType',
4556 'action' : 'BlockErrorAction' } }
4561 # Emitted when a block job is ready to complete
4565 # @device: The job identifier. Originally the device name but other
4566 # values are allowed since QEMU 2.7
4568 # @len: maximum progress value
4570 # @offset: current progress value. On success this is equal to len.
4571 # On failure this is less than len
4573 # @speed: rate limit, bytes per second
4575 # Note: The "ready to complete" status is always reset by a @BLOCK_JOB_ERROR
4582 # <- { "event": "BLOCK_JOB_READY",
4583 # "data": { "device": "drive0", "type": "mirror", "speed": 0,
4584 # "len": 2097152, "offset": 2097152 }
4585 # "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
4588 { 'event': 'BLOCK_JOB_READY',
4589 'data': { 'type' : 'BlockJobType',
4596 # @BLOCK_JOB_PENDING:
4598 # Emitted when a block job is awaiting explicit authorization to finalize graph
4599 # changes via @block-job-finalize. If this job is part of a transaction, it will
4600 # not emit this event until the transaction has converged first.
4604 # @id: The job identifier.
4610 # <- { "event": "BLOCK_JOB_WAITING",
4611 # "data": { "device": "drive0", "type": "mirror" },
4612 # "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
4615 { 'event': 'BLOCK_JOB_PENDING',
4616 'data': { 'type' : 'BlockJobType',
4622 # Preallocation mode of QEMU image file
4624 # @off: no preallocation
4625 # @metadata: preallocate only for metadata
4626 # @falloc: like @full preallocation but allocate disk space by
4627 # posix_fallocate() rather than writing zeros.
4628 # @full: preallocate all data by writing zeros to device to ensure disk
4629 # space is really available. @full preallocation also sets up
4630 # metadata correctly.
4634 { 'enum': 'PreallocMode',
4635 'data': [ 'off', 'metadata', 'falloc', 'full' ] }
4638 # @BLOCK_WRITE_THRESHOLD:
4640 # Emitted when writes on block device reaches or exceeds the
4641 # configured write threshold. For thin-provisioned devices, this
4642 # means the device should be extended to avoid pausing for
4644 # The event is one shot. Once triggered, it needs to be
4645 # re-registered with another block-set-write-threshold command.
4647 # @node-name: graph node name on which the threshold was exceeded.
4649 # @amount-exceeded: amount of data which exceeded the threshold, in bytes.
4651 # @write-threshold: last configured threshold, in bytes.
4655 { 'event': 'BLOCK_WRITE_THRESHOLD',
4656 'data': { 'node-name': 'str',
4657 'amount-exceeded': 'uint64',
4658 'write-threshold': 'uint64' } }
4661 # @block-set-write-threshold:
4663 # Change the write threshold for a block drive. An event will be
4664 # delivered if a write to this block drive crosses the configured
4665 # threshold. The threshold is an offset, thus must be
4666 # non-negative. Default is no write threshold. Setting the threshold
4667 # to zero disables it.
4669 # This is useful to transparently resize thin-provisioned drives without
4670 # the guest OS noticing.
4672 # @node-name: graph node name on which the threshold must be set.
4674 # @write-threshold: configured threshold for the block device, bytes.
4675 # Use 0 to disable the threshold.
4681 # -> { "execute": "block-set-write-threshold",
4682 # "arguments": { "node-name": "mydev",
4683 # "write-threshold": 17179869184 } }
4684 # <- { "return": {} }
4687 { 'command': 'block-set-write-threshold',
4688 'data': { 'node-name': 'str', 'write-threshold': 'uint64' } }
4691 # @x-blockdev-change:
4693 # Dynamically reconfigure the block driver state graph. It can be used
4694 # to add, remove, insert or replace a graph node. Currently only the
4695 # Quorum driver implements this feature to add or remove its child. This
4696 # is useful to fix a broken quorum child.
4698 # If @node is specified, it will be inserted under @parent. @child
4699 # may not be specified in this case. If both @parent and @child are
4700 # specified but @node is not, @child will be detached from @parent.
4702 # @parent: the id or name of the parent node.
4704 # @child: the name of a child under the given parent node.
4706 # @node: the name of the node that will be added.
4708 # Note: this command is experimental, and its API is not stable. It
4709 # does not support all kinds of operations, all kinds of children, nor
4710 # all block drivers.
4712 # FIXME Removing children from a quorum node means introducing gaps in the
4713 # child indices. This cannot be represented in the 'children' list of
4714 # BlockdevOptionsQuorum, as returned by .bdrv_refresh_filename().
4716 # Warning: The data in a new quorum child MUST be consistent with that of
4717 # the rest of the array.
4723 # 1. Add a new node to a quorum
4724 # -> { "execute": "blockdev-add",
4727 # "node-name": "new_node",
4728 # "file": { "driver": "file",
4729 # "filename": "test.raw" } } }
4730 # <- { "return": {} }
4731 # -> { "execute": "x-blockdev-change",
4732 # "arguments": { "parent": "disk1",
4733 # "node": "new_node" } }
4734 # <- { "return": {} }
4736 # 2. Delete a quorum's node
4737 # -> { "execute": "x-blockdev-change",
4738 # "arguments": { "parent": "disk1",
4739 # "child": "children.1" } }
4740 # <- { "return": {} }
4743 { 'command': 'x-blockdev-change',
4744 'data' : { 'parent': 'str',
4749 # @x-blockdev-set-iothread:
4751 # Move @node and its children into the @iothread. If @iothread is null then
4752 # move @node and its children into the main loop.
4754 # The node must not be attached to a BlockBackend.
4756 # @node-name: the name of the block driver node
4758 # @iothread: the name of the IOThread object or null for the main loop
4760 # @force: true if the node and its children should be moved when a BlockBackend
4761 # is already attached
4763 # Note: this command is experimental and intended for test cases that need
4764 # control over IOThreads only.
4770 # 1. Move a node into an IOThread
4771 # -> { "execute": "x-blockdev-set-iothread",
4772 # "arguments": { "node-name": "disk1",
4773 # "iothread": "iothread0" } }
4774 # <- { "return": {} }
4776 # 2. Move a node into the main loop
4777 # -> { "execute": "x-blockdev-set-iothread",
4778 # "arguments": { "node-name": "disk1",
4779 # "iothread": null } }
4780 # <- { "return": {} }
4783 { 'command': 'x-blockdev-set-iothread',
4784 'data' : { 'node-name': 'str',
4785 'iothread': 'StrOrNull',
4786 '*force': 'bool' } }