3 # QAPI block core definitions (vm unrelated)
5 # QAPI common definitions
6 { 'include': 'common.json' }
11 # @id: unique snapshot id
13 # @name: user chosen name
15 # @vm-state-size: size of the VM state
17 # @date-sec: UTC date of the snapshot in seconds
19 # @date-nsec: fractional part in nano seconds to be used with date-sec
21 # @vm-clock-sec: VM clock relative to boot in seconds
23 # @vm-clock-nsec: fractional part in nano seconds to be used with vm-clock-sec
28 { 'struct': 'SnapshotInfo',
29 'data': { 'id': 'str', 'name': 'str', 'vm-state-size': 'int',
30 'date-sec': 'int', 'date-nsec': 'int',
31 'vm-clock-sec': 'int', 'vm-clock-nsec': 'int' } }
34 # @ImageInfoSpecificQCow2:
36 # @compat: compatibility level
38 # @lazy-refcounts: #optional on or off; only valid for compat >= 1.1
40 # @corrupt: #optional true if the image has been marked corrupt; only valid for
41 # compat >= 1.1 (since 2.2)
43 # @refcount-bits: width of a refcount entry in bits (since 2.3)
47 { 'struct': 'ImageInfoSpecificQCow2',
50 '*lazy-refcounts': 'bool',
52 'refcount-bits': 'int'
56 # @ImageInfoSpecificVmdk:
58 # @create-type: The create type of VMDK image
60 # @cid: Content id of image
62 # @parent-cid: Parent VMDK image's cid
64 # @extents: List of extent files
68 { 'struct': 'ImageInfoSpecificVmdk',
73 'extents': ['ImageInfo']
79 # A discriminated record of image format specific information structures.
83 { 'union': 'ImageInfoSpecific',
85 'qcow2': 'ImageInfoSpecificQCow2',
86 'vmdk': 'ImageInfoSpecificVmdk',
87 # If we need to add block driver specific parameters for
88 # LUKS in future, then we'll subclass QCryptoBlockInfoLUKS
89 # to define a ImageInfoSpecificLUKS
90 'luks': 'QCryptoBlockInfoLUKS'
96 # Information about a QEMU image file
98 # @filename: name of the image file
100 # @format: format of the image file
102 # @virtual-size: maximum capacity in bytes of the image
104 # @actual-size: #optional actual size on disk in bytes of the image
106 # @dirty-flag: #optional true if image is not cleanly closed
108 # @cluster-size: #optional size of a cluster in bytes
110 # @encrypted: #optional true if the image is encrypted
112 # @compressed: #optional true if the image is compressed (Since 1.7)
114 # @backing-filename: #optional name of the backing file
116 # @full-backing-filename: #optional full path of the backing file
118 # @backing-filename-format: #optional the format of the backing file
120 # @snapshots: #optional list of VM snapshots
122 # @backing-image: #optional info of the backing image (since 1.6)
124 # @format-specific: #optional structure supplying additional format-specific
125 # information (since 1.7)
130 { 'struct': 'ImageInfo',
131 'data': {'filename': 'str', 'format': 'str', '*dirty-flag': 'bool',
132 '*actual-size': 'int', 'virtual-size': 'int',
133 '*cluster-size': 'int', '*encrypted': 'bool', '*compressed': 'bool',
134 '*backing-filename': 'str', '*full-backing-filename': 'str',
135 '*backing-filename-format': 'str', '*snapshots': ['SnapshotInfo'],
136 '*backing-image': 'ImageInfo',
137 '*format-specific': 'ImageInfoSpecific' } }
142 # Information about a QEMU image file check
144 # @filename: name of the image file checked
146 # @format: format of the image file checked
148 # @check-errors: number of unexpected errors occurred during check
150 # @image-end-offset: #optional offset (in bytes) where the image ends, this
151 # field is present if the driver for the image format
154 # @corruptions: #optional number of corruptions found during the check if any
156 # @leaks: #optional number of leaks found during the check if any
158 # @corruptions-fixed: #optional number of corruptions fixed during the check
161 # @leaks-fixed: #optional number of leaks fixed during the check if any
163 # @total-clusters: #optional total number of clusters, this field is present
164 # if the driver for the image format supports it
166 # @allocated-clusters: #optional total number of allocated clusters, this
167 # field is present if the driver for the image format
170 # @fragmented-clusters: #optional total number of fragmented clusters, this
171 # field is present if the driver for the image format
174 # @compressed-clusters: #optional total number of compressed clusters, this
175 # field is present if the driver for the image format
181 { 'struct': 'ImageCheck',
182 'data': {'filename': 'str', 'format': 'str', 'check-errors': 'int',
183 '*image-end-offset': 'int', '*corruptions': 'int', '*leaks': 'int',
184 '*corruptions-fixed': 'int', '*leaks-fixed': 'int',
185 '*total-clusters': 'int', '*allocated-clusters': 'int',
186 '*fragmented-clusters': 'int', '*compressed-clusters': 'int' } }
191 # Mapping information from a virtual block range to a host file range
193 # @start: the start byte of the mapped virtual range
195 # @length: the number of bytes of the mapped virtual range
197 # @data: whether the mapped range has data
199 # @zero: whether the virtual blocks are zeroed
201 # @depth: the depth of the mapping
203 # @offset: #optional the offset in file that the virtual sectors are mapped to
205 # @filename: #optional filename that is referred to by @offset
210 { 'struct': 'MapEntry',
211 'data': {'start': 'int', 'length': 'int', 'data': 'bool',
212 'zero': 'bool', 'depth': 'int', '*offset': 'int',
213 '*filename': 'str' } }
218 # Cache mode information for a block device
220 # @writeback: true if writeback mode is enabled
221 # @direct: true if the host page cache is bypassed (O_DIRECT)
222 # @no-flush: true if flush requests are ignored for the device
226 { 'struct': 'BlockdevCacheInfo',
227 'data': { 'writeback': 'bool',
229 'no-flush': 'bool' } }
234 # Information about the backing device for a block device.
236 # @file: the filename of the backing device
238 # @node-name: #optional the name of the block driver node (Since 2.0)
240 # @ro: true if the backing device was open read-only
242 # @drv: the name of the block format used to open the backing device. As of
243 # 0.14.0 this can be: 'blkdebug', 'bochs', 'cloop', 'cow', 'dmg',
244 # 'file', 'file', 'ftp', 'ftps', 'host_cdrom', 'host_device',
245 # 'http', 'https', 'luks', 'nbd', 'parallels', 'qcow',
246 # 'qcow2', 'raw', 'vdi', 'vmdk', 'vpc', 'vvfat'
247 # 2.2: 'archipelago' added, 'cow' dropped
248 # 2.3: 'host_floppy' deprecated
249 # 2.5: 'host_floppy' dropped
251 # 2.8: 'replication' added, 'tftp' dropped
253 # @backing_file: #optional the name of the backing file (for copy-on-write)
255 # @backing_file_depth: number of files in the backing file chain (since: 1.2)
257 # @encrypted: true if the backing device is encrypted
259 # @encryption_key_missing: true if the backing device is encrypted but an
260 # valid encryption key is missing
262 # @detect_zeroes: detect and optimize zero writes (Since 2.1)
264 # @bps: total throughput limit in bytes per second is specified
266 # @bps_rd: read throughput limit in bytes per second is specified
268 # @bps_wr: write throughput limit in bytes per second is specified
270 # @iops: total I/O operations per second is specified
272 # @iops_rd: read I/O operations per second is specified
274 # @iops_wr: write I/O operations per second is specified
276 # @image: the info of image used (since: 1.6)
278 # @bps_max: #optional total throughput limit during bursts,
279 # in bytes (Since 1.7)
281 # @bps_rd_max: #optional read throughput limit during bursts,
282 # in bytes (Since 1.7)
284 # @bps_wr_max: #optional write throughput limit during bursts,
285 # in bytes (Since 1.7)
287 # @iops_max: #optional total I/O operations per second during bursts,
288 # in bytes (Since 1.7)
290 # @iops_rd_max: #optional read I/O operations per second during bursts,
291 # in bytes (Since 1.7)
293 # @iops_wr_max: #optional write I/O operations per second during bursts,
294 # in bytes (Since 1.7)
296 # @bps_max_length: #optional maximum length of the @bps_max burst
297 # period, in seconds. (Since 2.6)
299 # @bps_rd_max_length: #optional maximum length of the @bps_rd_max
300 # burst period, in seconds. (Since 2.6)
302 # @bps_wr_max_length: #optional maximum length of the @bps_wr_max
303 # burst period, in seconds. (Since 2.6)
305 # @iops_max_length: #optional maximum length of the @iops burst
306 # period, in seconds. (Since 2.6)
308 # @iops_rd_max_length: #optional maximum length of the @iops_rd_max
309 # burst period, in seconds. (Since 2.6)
311 # @iops_wr_max_length: #optional maximum length of the @iops_wr_max
312 # burst period, in seconds. (Since 2.6)
314 # @iops_size: #optional an I/O size in bytes (Since 1.7)
316 # @group: #optional throttle group name (Since 2.4)
318 # @cache: the cache mode used for the block device (since: 2.3)
320 # @write_threshold: configured write threshold for the device.
321 # 0 if disabled. (Since 2.3)
326 { 'struct': 'BlockDeviceInfo',
327 'data': { 'file': 'str', '*node-name': 'str', 'ro': 'bool', 'drv': 'str',
328 '*backing_file': 'str', 'backing_file_depth': 'int',
329 'encrypted': 'bool', 'encryption_key_missing': 'bool',
330 'detect_zeroes': 'BlockdevDetectZeroesOptions',
331 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
332 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
333 'image': 'ImageInfo',
334 '*bps_max': 'int', '*bps_rd_max': 'int',
335 '*bps_wr_max': 'int', '*iops_max': 'int',
336 '*iops_rd_max': 'int', '*iops_wr_max': 'int',
337 '*bps_max_length': 'int', '*bps_rd_max_length': 'int',
338 '*bps_wr_max_length': 'int', '*iops_max_length': 'int',
339 '*iops_rd_max_length': 'int', '*iops_wr_max_length': 'int',
340 '*iops_size': 'int', '*group': 'str', 'cache': 'BlockdevCacheInfo',
341 'write_threshold': 'int' } }
344 # @BlockDeviceIoStatus:
346 # An enumeration of block device I/O status.
348 # @ok: The last I/O operation has succeeded
350 # @failed: The last I/O operation has failed
352 # @nospace: The last I/O operation has failed due to a no-space condition
356 { 'enum': 'BlockDeviceIoStatus', 'data': [ 'ok', 'failed', 'nospace' ] }
359 # @BlockDeviceMapEntry:
361 # Entry in the metadata map of the device (returned by "qemu-img map")
363 # @start: Offset in the image of the first byte described by this entry
366 # @length: Length of the range described by this entry (in bytes)
368 # @depth: Number of layers (0 = top image, 1 = top image's backing file, etc.)
369 # before reaching one for which the range is allocated. The value is
370 # in the range 0 to the depth of the image chain - 1.
372 # @zero: the sectors in this range read as zeros
374 # @data: reading the image will actually read data from a file (in particular,
375 # if @offset is present this means that the sectors are not simply
376 # preallocated, but contain actual data in raw format)
378 # @offset: if present, the image file stores the data for this range in
379 # raw format at the given offset.
383 { 'struct': 'BlockDeviceMapEntry',
384 'data': { 'start': 'int', 'length': 'int', 'depth': 'int', 'zero': 'bool',
385 'data': 'bool', '*offset': 'int' } }
388 # @DirtyBitmapStatus:
390 # An enumeration of possible states that a dirty bitmap can report to the user.
392 # @frozen: The bitmap is currently in-use by a backup operation or block job,
395 # @disabled: The bitmap is currently in-use by an internal operation and is
396 # read-only. It can still be deleted.
398 # @active: The bitmap is actively monitoring for new writes, and can be cleared,
399 # deleted, or used for backup operations.
403 { 'enum': 'DirtyBitmapStatus',
404 'data': ['active', 'disabled', 'frozen'] }
409 # Block dirty bitmap information.
411 # @name: #optional the name of the dirty bitmap (Since 2.4)
413 # @count: number of dirty bytes according to the dirty bitmap
415 # @granularity: granularity of the dirty bitmap in bytes (since 1.4)
417 # @status: current status of the dirty bitmap (since 2.4)
421 { 'struct': 'BlockDirtyInfo',
422 'data': {'*name': 'str', 'count': 'int', 'granularity': 'uint32',
423 'status': 'DirtyBitmapStatus'} }
428 # Block device information. This structure describes a virtual device and
429 # the backing device associated with it.
431 # @device: The device name associated with the virtual device.
433 # @type: This field is returned only for compatibility reasons, it should
434 # not be used (always returns 'unknown')
436 # @removable: True if the device supports removable media.
438 # @locked: True if the guest has locked this device from having its media
441 # @tray_open: #optional True if the device's tray is open
442 # (only present if it has a tray)
444 # @dirty-bitmaps: #optional dirty bitmaps information (only present if the
445 # driver has one or more dirty bitmaps) (Since 2.0)
447 # @io-status: #optional @BlockDeviceIoStatus. Only present if the device
448 # supports it and the VM is configured to stop on errors
449 # (supported device models: virtio-blk, ide, scsi-disk)
451 # @inserted: #optional @BlockDeviceInfo describing the device if media is
456 { 'struct': 'BlockInfo',
457 'data': {'device': 'str', 'type': 'str', 'removable': 'bool',
458 'locked': 'bool', '*inserted': 'BlockDeviceInfo',
459 '*tray_open': 'bool', '*io-status': 'BlockDeviceIoStatus',
460 '*dirty-bitmaps': ['BlockDirtyInfo'] } }
465 # Get a list of BlockInfo for all virtual block devices.
467 # Returns: a list of @BlockInfo describing each virtual block device
471 { 'command': 'query-block', 'returns': ['BlockInfo'] }
475 # @BlockDeviceTimedStats:
477 # Statistics of a block device during a given interval of time.
479 # @interval_length: Interval used for calculating the statistics,
482 # @min_rd_latency_ns: Minimum latency of read operations in the
483 # defined interval, in nanoseconds.
485 # @min_wr_latency_ns: Minimum latency of write operations in the
486 # defined interval, in nanoseconds.
488 # @min_flush_latency_ns: Minimum latency of flush operations in the
489 # defined interval, in nanoseconds.
491 # @max_rd_latency_ns: Maximum latency of read operations in the
492 # defined interval, in nanoseconds.
494 # @max_wr_latency_ns: Maximum latency of write operations in the
495 # defined interval, in nanoseconds.
497 # @max_flush_latency_ns: Maximum latency of flush operations in the
498 # defined interval, in nanoseconds.
500 # @avg_rd_latency_ns: Average latency of read operations in the
501 # defined interval, in nanoseconds.
503 # @avg_wr_latency_ns: Average latency of write operations in the
504 # defined interval, in nanoseconds.
506 # @avg_flush_latency_ns: Average latency of flush operations in the
507 # defined interval, in nanoseconds.
509 # @avg_rd_queue_depth: Average number of pending read operations
510 # in the defined interval.
512 # @avg_wr_queue_depth: Average number of pending write operations
513 # in the defined interval.
517 { 'struct': 'BlockDeviceTimedStats',
518 'data': { 'interval_length': 'int', 'min_rd_latency_ns': 'int',
519 'max_rd_latency_ns': 'int', 'avg_rd_latency_ns': 'int',
520 'min_wr_latency_ns': 'int', 'max_wr_latency_ns': 'int',
521 'avg_wr_latency_ns': 'int', 'min_flush_latency_ns': 'int',
522 'max_flush_latency_ns': 'int', 'avg_flush_latency_ns': 'int',
523 'avg_rd_queue_depth': 'number', 'avg_wr_queue_depth': 'number' } }
528 # Statistics of a virtual block device or a block backing device.
530 # @rd_bytes: The number of bytes read by the device.
532 # @wr_bytes: The number of bytes written by the device.
534 # @rd_operations: The number of read operations performed by the device.
536 # @wr_operations: The number of write operations performed by the device.
538 # @flush_operations: The number of cache flush operations performed by the
539 # device (since 0.15.0)
541 # @flush_total_time_ns: Total time spend on cache flushes in nano-seconds
544 # @wr_total_time_ns: Total time spend on writes in nano-seconds (since 0.15.0).
546 # @rd_total_time_ns: Total_time_spend on reads in nano-seconds (since 0.15.0).
548 # @wr_highest_offset: The offset after the greatest byte written to the
549 # device. The intended use of this information is for
550 # growable sparse files (like qcow2) that are used on top
551 # of a physical device.
553 # @rd_merged: Number of read requests that have been merged into another
554 # request (Since 2.3).
556 # @wr_merged: Number of write requests that have been merged into another
557 # request (Since 2.3).
559 # @idle_time_ns: #optional Time since the last I/O operation, in
560 # nanoseconds. If the field is absent it means that
561 # there haven't been any operations yet (Since 2.5).
563 # @failed_rd_operations: The number of failed read operations
564 # performed by the device (Since 2.5)
566 # @failed_wr_operations: The number of failed write operations
567 # performed by the device (Since 2.5)
569 # @failed_flush_operations: The number of failed flush operations
570 # performed by the device (Since 2.5)
572 # @invalid_rd_operations: The number of invalid read operations
573 # performed by the device (Since 2.5)
575 # @invalid_wr_operations: The number of invalid write operations
576 # performed by the device (Since 2.5)
578 # @invalid_flush_operations: The number of invalid flush operations
579 # performed by the device (Since 2.5)
581 # @account_invalid: Whether invalid operations are included in the
582 # last access statistics (Since 2.5)
584 # @account_failed: Whether failed operations are included in the
585 # latency and last access statistics (Since 2.5)
587 # @timed_stats: Statistics specific to the set of previously defined
588 # intervals of time (Since 2.5)
592 { 'struct': 'BlockDeviceStats',
593 'data': {'rd_bytes': 'int', 'wr_bytes': 'int', 'rd_operations': 'int',
594 'wr_operations': 'int', 'flush_operations': 'int',
595 'flush_total_time_ns': 'int', 'wr_total_time_ns': 'int',
596 'rd_total_time_ns': 'int', 'wr_highest_offset': 'int',
597 'rd_merged': 'int', 'wr_merged': 'int', '*idle_time_ns': 'int',
598 'failed_rd_operations': 'int', 'failed_wr_operations': 'int',
599 'failed_flush_operations': 'int', 'invalid_rd_operations': 'int',
600 'invalid_wr_operations': 'int', 'invalid_flush_operations': 'int',
601 'account_invalid': 'bool', 'account_failed': 'bool',
602 'timed_stats': ['BlockDeviceTimedStats'] } }
607 # Statistics of a virtual block device or a block backing device.
609 # @device: #optional If the stats are for a virtual block device, the name
610 # corresponding to the virtual block device.
612 # @node-name: #optional The node name of the device. (Since 2.3)
614 # @stats: A @BlockDeviceStats for the device.
616 # @parent: #optional This describes the file block device if it has one.
618 # @backing: #optional This describes the backing block device if it has one.
623 { 'struct': 'BlockStats',
624 'data': {'*device': 'str', '*node-name': 'str',
625 'stats': 'BlockDeviceStats',
626 '*parent': 'BlockStats',
627 '*backing': 'BlockStats'} }
632 # Query the @BlockStats for all virtual block devices.
634 # @query-nodes: #optional If true, the command will query all the block nodes
635 # that have a node name, in a list which will include "parent"
636 # information, but not "backing".
637 # If false or omitted, the behavior is as before - query all the
638 # device backends, recursively including their "parent" and
639 # "backing". (Since 2.3)
641 # Returns: A list of @BlockStats for each virtual block devices.
645 { 'command': 'query-blockstats',
646 'data': { '*query-nodes': 'bool' },
647 'returns': ['BlockStats'] }
652 # An enumeration of possible behaviors for errors on I/O operations.
653 # The exact meaning depends on whether the I/O was initiated by a guest
656 # @report: for guest operations, report the error to the guest;
657 # for jobs, cancel the job
659 # @ignore: ignore the error, only report a QMP event (BLOCK_IO_ERROR
660 # or BLOCK_JOB_ERROR)
662 # @enospc: same as @stop on ENOSPC, same as @report otherwise.
664 # @stop: for guest operations, stop the virtual machine;
665 # for jobs, pause the job
667 # @auto: inherit the error handling policy of the backend (since: 2.7)
671 { 'enum': 'BlockdevOnError',
672 'data': ['report', 'ignore', 'enospc', 'stop', 'auto'] }
677 # An enumeration of possible behaviors for the initial synchronization
678 # phase of storage mirroring.
680 # @top: copies data in the topmost image to the destination
682 # @full: copies data from all images to the destination
684 # @none: only copy data written from now on
686 # @incremental: only copy data described by the dirty bitmap. Since: 2.4
690 { 'enum': 'MirrorSyncMode',
691 'data': ['top', 'full', 'none', 'incremental'] }
696 # Type of a block job.
698 # @commit: block commit job type, see "block-commit"
700 # @stream: block stream job type, see "block-stream"
702 # @mirror: drive mirror job type, see "drive-mirror"
704 # @backup: drive backup job type, see "drive-backup"
708 { 'enum': 'BlockJobType',
709 'data': ['commit', 'stream', 'mirror', 'backup'] }
714 # Information about a long-running block device operation.
716 # @type: the job type ('stream' for image streaming)
718 # @device: The job identifier. Originally the device name but other
719 # values are allowed since QEMU 2.7
721 # @len: the maximum progress value
723 # @busy: false if the job is known to be in a quiescent state, with
724 # no pending I/O. Since 1.3.
726 # @paused: whether the job is paused or, if @busy is true, will
727 # pause itself as soon as possible. Since 1.3.
729 # @offset: the current progress value
731 # @speed: the rate limit, bytes per second
733 # @io-status: the status of the job (since 1.3)
735 # @ready: true if the job may be completed (since 2.2)
739 { 'struct': 'BlockJobInfo',
740 'data': {'type': 'str', 'device': 'str', 'len': 'int',
741 'offset': 'int', 'busy': 'bool', 'paused': 'bool', 'speed': 'int',
742 'io-status': 'BlockDeviceIoStatus', 'ready': 'bool'} }
747 # Return information about long-running block device operations.
749 # Returns: a list of @BlockJobInfo for each active block job
753 { 'command': 'query-block-jobs', 'returns': ['BlockJobInfo'] }
758 # This command sets the password of a block device that has not been open
759 # with a password and requires one.
761 # The two cases where this can happen are a block device is created through
762 # QEMU's initial command line or a block device is changed through the legacy
765 # In the event that the block device is created through the initial command
766 # line, the VM will start in the stopped state regardless of whether '-S' is
767 # used. The intention is for a management tool to query the block devices to
768 # determine which ones are encrypted, set the passwords with this command, and
769 # then start the guest with the @cont command.
771 # Either @device or @node-name must be set but not both.
773 # @device: #optional the name of the block backend device to set the password on
775 # @node-name: #optional graph node name to set the password on (Since 2.0)
777 # @password: the password to use for the device
779 # Returns: nothing on success
780 # If @device is not a valid block device, DeviceNotFound
781 # If @device is not encrypted, DeviceNotEncrypted
783 # Notes: Not all block formats support encryption and some that do are not
784 # able to validate that a password is correct. Disk corruption may
785 # occur if an invalid password is specified.
789 { 'command': 'block_passwd', 'data': {'*device': 'str',
790 '*node-name': 'str', 'password': 'str'} }
795 # Resize a block image while a guest is running.
797 # Either @device or @node-name must be set but not both.
799 # @device: #optional the name of the device to get the image resized
801 # @node-name: #optional graph node name to get the image resized (Since 2.0)
803 # @size: new image size in bytes
805 # Returns: nothing on success
806 # If @device is not a valid block device, DeviceNotFound
810 { 'command': 'block_resize', 'data': { '*device': 'str',
817 # An enumeration that tells QEMU how to set the backing file path in
820 # @existing: QEMU should look for an existing image file.
822 # @absolute-paths: QEMU should create a new image with absolute paths
823 # for the backing file. If there is no backing file available, the new
824 # image will not be backed either.
828 { 'enum': 'NewImageMode',
829 'data': [ 'existing', 'absolute-paths' ] }
832 # @BlockdevSnapshotSync
834 # Either @device or @node-name must be set but not both.
836 # @device: #optional the name of the device to generate the snapshot from.
838 # @node-name: #optional graph node name to generate the snapshot from (Since 2.0)
840 # @snapshot-file: the target of the new image. A new file will be created.
842 # @snapshot-node-name: #optional the graph node name of the new image (Since 2.0)
844 # @format: #optional the format of the snapshot image, default is 'qcow2'.
846 # @mode: #optional whether and how QEMU should create a new image, default is
849 { 'struct': 'BlockdevSnapshotSync',
850 'data': { '*device': 'str', '*node-name': 'str',
851 'snapshot-file': 'str', '*snapshot-node-name': 'str',
852 '*format': 'str', '*mode': 'NewImageMode' } }
857 # @node: device or node name that will have a snapshot created.
859 # @overlay: reference to the existing block device that will become
860 # the overlay of @node, as part of creating the snapshot.
861 # It must not have a current backing file (this can be
862 # achieved by passing "backing": "" to blockdev-add).
866 { 'struct': 'BlockdevSnapshot',
867 'data': { 'node': 'str', 'overlay': 'str' } }
872 # @job-id: #optional identifier for the newly-created block job. If
873 # omitted, the device name will be used. (Since 2.7)
875 # @device: the device name or node-name of a root node which should be copied.
877 # @target: the target of the new image. If the file exists, or if it
878 # is a device, the existing file/device will be used as the new
879 # destination. If it does not exist, a new file will be created.
881 # @format: #optional the format of the new destination, default is to
882 # probe if @mode is 'existing', else the format of the source
884 # @sync: what parts of the disk image should be copied to the destination
885 # (all the disk, only the sectors allocated in the topmost image, from a
886 # dirty bitmap, or only new I/O).
888 # @mode: #optional whether and how QEMU should create a new image, default is
891 # @speed: #optional the maximum speed, in bytes per second
893 # @bitmap: #optional the name of dirty bitmap if sync is "incremental".
894 # Must be present if sync is "incremental", must NOT be present
895 # otherwise. (Since 2.4)
897 # @compress: #optional true to compress data, if the target format supports it.
898 # (default: false) (since 2.8)
900 # @on-source-error: #optional the action to take on an error on the source,
901 # default 'report'. 'stop' and 'enospc' can only be used
902 # if the block device supports io-status (see BlockInfo).
904 # @on-target-error: #optional the action to take on an error on the target,
905 # default 'report' (no limitations, since this applies to
906 # a different block device than @device).
908 # Note that @on-source-error and @on-target-error only affect background I/O.
909 # If an error occurs during a guest write request, the device's rerror/werror
910 # actions will be used.
914 { 'struct': 'DriveBackup',
915 'data': { '*job-id': 'str', 'device': 'str', 'target': 'str',
916 '*format': 'str', 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
917 '*speed': 'int', '*bitmap': 'str', '*compress': 'bool',
918 '*on-source-error': 'BlockdevOnError',
919 '*on-target-error': 'BlockdevOnError' } }
924 # @job-id: #optional identifier for the newly-created block job. If
925 # omitted, the device name will be used. (Since 2.7)
927 # @device: the device name or node-name of a root node which should be copied.
929 # @target: the device name or node-name of the backup target node.
931 # @sync: what parts of the disk image should be copied to the destination
932 # (all the disk, only the sectors allocated in the topmost image, or
935 # @speed: #optional the maximum speed, in bytes per second. The default is 0,
938 # @compress: #optional true to compress data, if the target format supports it.
939 # (default: false) (since 2.8)
941 # @on-source-error: #optional the action to take on an error on the source,
942 # default 'report'. 'stop' and 'enospc' can only be used
943 # if the block device supports io-status (see BlockInfo).
945 # @on-target-error: #optional the action to take on an error on the target,
946 # default 'report' (no limitations, since this applies to
947 # a different block device than @device).
949 # Note that @on-source-error and @on-target-error only affect background I/O.
950 # If an error occurs during a guest write request, the device's rerror/werror
951 # actions will be used.
955 { 'struct': 'BlockdevBackup',
956 'data': { '*job-id': 'str', 'device': 'str', 'target': 'str',
957 'sync': 'MirrorSyncMode',
960 '*on-source-error': 'BlockdevOnError',
961 '*on-target-error': 'BlockdevOnError' } }
964 # @blockdev-snapshot-sync
966 # Generates a synchronous snapshot of a block device.
968 # For the arguments, see the documentation of BlockdevSnapshotSync.
970 # Returns: nothing on success
971 # If @device is not a valid block device, DeviceNotFound
975 { 'command': 'blockdev-snapshot-sync',
976 'data': 'BlockdevSnapshotSync' }
982 # Generates a snapshot of a block device.
984 # For the arguments, see the documentation of BlockdevSnapshot.
988 { 'command': 'blockdev-snapshot',
989 'data': 'BlockdevSnapshot' }
992 # @change-backing-file
994 # Change the backing file in the image file metadata. This does not
995 # cause QEMU to reopen the image file to reparse the backing filename
996 # (it may, however, perform a reopen to change permissions from
997 # r/o -> r/w -> r/o, if needed). The new backing file string is written
998 # into the image file metadata, and the QEMU internal strings are
1001 # @image-node-name: The name of the block driver state node of the
1004 # @device: The device name or node-name of the root node that owns
1007 # @backing-file: The string to write as the backing file. This
1008 # string is not validated, so care should be taken
1009 # when specifying the string or the image chain may
1010 # not be able to be reopened again.
1014 { 'command': 'change-backing-file',
1015 'data': { 'device': 'str', 'image-node-name': 'str',
1016 'backing-file': 'str' } }
1021 # Live commit of data from overlay image nodes into backing nodes - i.e.,
1022 # writes data between 'top' and 'base' into 'base'.
1024 # @job-id: #optional identifier for the newly-created block job. If
1025 # omitted, the device name will be used. (Since 2.7)
1027 # @device: the device name or node-name of a root node
1029 # @base: #optional The file name of the backing image to write data into.
1030 # If not specified, this is the deepest backing image
1032 # @top: #optional The file name of the backing image within the image chain,
1033 # which contains the topmost data to be committed down. If
1034 # not specified, this is the active layer.
1036 # @backing-file: #optional The backing file string to write into the overlay
1037 # image of 'top'. If 'top' is the active layer,
1038 # specifying a backing file string is an error. This
1039 # filename is not validated.
1041 # If a pathname string is such that it cannot be
1042 # resolved by QEMU, that means that subsequent QMP or
1043 # HMP commands must use node-names for the image in
1044 # question, as filename lookup methods will fail.
1046 # If not specified, QEMU will automatically determine
1047 # the backing file string to use, or error out if
1048 # there is no obvious choice. Care should be taken
1049 # when specifying the string, to specify a valid
1050 # filename or protocol.
1053 # If top == base, that is an error.
1054 # If top == active, the job will not be completed by itself,
1055 # user needs to complete the job with the block-job-complete
1056 # command after getting the ready event. (Since 2.0)
1058 # If the base image is smaller than top, then the base image
1059 # will be resized to be the same size as top. If top is
1060 # smaller than the base image, the base will not be
1061 # truncated. If you want the base image size to match the
1062 # size of the smaller top, you can safely truncate it
1063 # yourself once the commit operation successfully completes.
1065 # @speed: #optional the maximum speed, in bytes per second
1067 # Returns: Nothing on success
1068 # If commit or stream is already active on this device, DeviceInUse
1069 # If @device does not exist, DeviceNotFound
1070 # If image commit is not supported by this device, NotSupported
1071 # If @base or @top is invalid, a generic error is returned
1072 # If @speed is invalid, InvalidParameter
1077 { 'command': 'block-commit',
1078 'data': { '*job-id': 'str', 'device': 'str', '*base': 'str', '*top': 'str',
1079 '*backing-file': 'str', '*speed': 'int' } }
1084 # Start a point-in-time copy of a block device to a new destination. The
1085 # status of ongoing drive-backup operations can be checked with
1086 # query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
1087 # The operation can be stopped before it has completed using the
1088 # block-job-cancel command.
1090 # For the arguments, see the documentation of DriveBackup.
1092 # Returns: nothing on success
1093 # If @device is not a valid block device, GenericError
1097 { 'command': 'drive-backup', 'boxed': true,
1098 'data': 'DriveBackup' }
1103 # Start a point-in-time copy of a block device to a new destination. The
1104 # status of ongoing blockdev-backup operations can be checked with
1105 # query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
1106 # The operation can be stopped before it has completed using the
1107 # block-job-cancel command.
1109 # For the arguments, see the documentation of BlockdevBackup.
1111 # Returns: nothing on success
1112 # If @device is not a valid block device, DeviceNotFound
1116 { 'command': 'blockdev-backup', 'boxed': true,
1117 'data': 'BlockdevBackup' }
1121 # @query-named-block-nodes
1123 # Get the named block driver list
1125 # Returns: the list of BlockDeviceInfo
1129 { 'command': 'query-named-block-nodes', 'returns': [ 'BlockDeviceInfo' ] }
1134 # Start mirroring a block device's writes to a new destination.
1136 # See DriveMirror for parameter descriptions
1138 # Returns: nothing on success
1139 # If @device is not a valid block device, GenericError
1143 { 'command': 'drive-mirror', 'boxed': true,
1144 'data': 'DriveMirror' }
1149 # A set of parameters describing drive mirror setup.
1151 # @job-id: #optional identifier for the newly-created block job. If
1152 # omitted, the device name will be used. (Since 2.7)
1154 # @device: the device name or node-name of a root node whose writes should be
1157 # @target: the target of the new image. If the file exists, or if it
1158 # is a device, the existing file/device will be used as the new
1159 # destination. If it does not exist, a new file will be created.
1161 # @format: #optional the format of the new destination, default is to
1162 # probe if @mode is 'existing', else the format of the source
1164 # @node-name: #optional the new block driver state node name in the graph
1167 # @replaces: #optional with sync=full graph node name to be replaced by the new
1168 # image when a whole image copy is done. This can be used to repair
1169 # broken Quorum files. (Since 2.1)
1171 # @mode: #optional whether and how QEMU should create a new image, default is
1174 # @speed: #optional the maximum speed, in bytes per second
1176 # @sync: what parts of the disk image should be copied to the destination
1177 # (all the disk, only the sectors allocated in the topmost image, or
1180 # @granularity: #optional granularity of the dirty bitmap, default is 64K
1181 # if the image format doesn't have clusters, 4K if the clusters
1182 # are smaller than that, else the cluster size. Must be a
1183 # power of 2 between 512 and 64M (since 1.4).
1185 # @buf-size: #optional maximum amount of data in flight from source to
1186 # target (since 1.4).
1188 # @on-source-error: #optional the action to take on an error on the source,
1189 # default 'report'. 'stop' and 'enospc' can only be used
1190 # if the block device supports io-status (see BlockInfo).
1192 # @on-target-error: #optional the action to take on an error on the target,
1193 # default 'report' (no limitations, since this applies to
1194 # a different block device than @device).
1195 # @unmap: #optional Whether to try to unmap target sectors where source has
1196 # only zero. If true, and target unallocated sectors will read as zero,
1197 # target image sectors will be unmapped; otherwise, zeroes will be
1198 # written. Both will result in identical contents.
1199 # Default is true. (Since 2.4)
1203 { 'struct': 'DriveMirror',
1204 'data': { '*job-id': 'str', 'device': 'str', 'target': 'str',
1205 '*format': 'str', '*node-name': 'str', '*replaces': 'str',
1206 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
1207 '*speed': 'int', '*granularity': 'uint32',
1208 '*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
1209 '*on-target-error': 'BlockdevOnError',
1210 '*unmap': 'bool' } }
1215 # @node: name of device/node which the bitmap is tracking
1217 # @name: name of the dirty bitmap
1221 { 'struct': 'BlockDirtyBitmap',
1222 'data': { 'node': 'str', 'name': 'str' } }
1225 # @BlockDirtyBitmapAdd
1227 # @node: name of device/node which the bitmap is tracking
1229 # @name: name of the dirty bitmap
1231 # @granularity: #optional the bitmap granularity, default is 64k for
1232 # block-dirty-bitmap-add
1236 { 'struct': 'BlockDirtyBitmapAdd',
1237 'data': { 'node': 'str', 'name': 'str', '*granularity': 'uint32' } }
1240 # @block-dirty-bitmap-add
1242 # Create a dirty bitmap with a name on the node
1244 # Returns: nothing on success
1245 # If @node is not a valid block device or node, DeviceNotFound
1246 # If @name is already taken, GenericError with an explanation
1250 { 'command': 'block-dirty-bitmap-add',
1251 'data': 'BlockDirtyBitmapAdd' }
1254 # @block-dirty-bitmap-remove
1256 # Remove a dirty bitmap on the node
1258 # Returns: nothing on success
1259 # If @node is not a valid block device or node, DeviceNotFound
1260 # If @name is not found, GenericError with an explanation
1261 # if @name is frozen by an operation, GenericError
1265 { 'command': 'block-dirty-bitmap-remove',
1266 'data': 'BlockDirtyBitmap' }
1269 # @block-dirty-bitmap-clear
1271 # Clear (reset) a dirty bitmap on the device
1273 # Returns: nothing on success
1274 # If @node is not a valid block device, DeviceNotFound
1275 # If @name is not found, GenericError with an explanation
1279 { 'command': 'block-dirty-bitmap-clear',
1280 'data': 'BlockDirtyBitmap' }
1285 # Start mirroring a block device's writes to a new destination.
1287 # @job-id: #optional identifier for the newly-created block job. If
1288 # omitted, the device name will be used. (Since 2.7)
1290 # @device: The device name or node-name of a root node whose writes should be
1293 # @target: the id or node-name of the block device to mirror to. This mustn't be
1294 # attached to guest.
1296 # @replaces: #optional with sync=full graph node name to be replaced by the new
1297 # image when a whole image copy is done. This can be used to repair
1298 # broken Quorum files.
1300 # @speed: #optional the maximum speed, in bytes per second
1302 # @sync: what parts of the disk image should be copied to the destination
1303 # (all the disk, only the sectors allocated in the topmost image, or
1306 # @granularity: #optional granularity of the dirty bitmap, default is 64K
1307 # if the image format doesn't have clusters, 4K if the clusters
1308 # are smaller than that, else the cluster size. Must be a
1309 # power of 2 between 512 and 64M
1311 # @buf-size: #optional maximum amount of data in flight from source to
1314 # @on-source-error: #optional the action to take on an error on the source,
1315 # default 'report'. 'stop' and 'enospc' can only be used
1316 # if the block device supports io-status (see BlockInfo).
1318 # @on-target-error: #optional the action to take on an error on the target,
1319 # default 'report' (no limitations, since this applies to
1320 # a different block device than @device).
1322 # Returns: nothing on success.
1326 { 'command': 'blockdev-mirror',
1327 'data': { '*job-id': 'str', 'device': 'str', 'target': 'str',
1329 'sync': 'MirrorSyncMode',
1330 '*speed': 'int', '*granularity': 'uint32',
1331 '*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
1332 '*on-target-error': 'BlockdevOnError' } }
1335 # @block_set_io_throttle:
1337 # Change I/O throttle limits for a block drive.
1339 # Since QEMU 2.4, each device with I/O limits is member of a throttle
1342 # If two or more devices are members of the same group, the limits
1343 # will apply to the combined I/O of the whole group in a round-robin
1344 # fashion. Therefore, setting new I/O limits to a device will affect
1347 # The name of the group can be specified using the 'group' parameter.
1348 # If the parameter is unset, it is assumed to be the current group of
1349 # that device. If it's not in any group yet, the name of the device
1350 # will be used as the name for its group.
1352 # The 'group' parameter can also be used to move a device to a
1353 # different group. In this case the limits specified in the parameters
1354 # will be applied to the new group only.
1356 # I/O limits can be disabled by setting all of them to 0. In this case
1357 # the device will be removed from its group and the rest of its
1358 # members will not be affected. The 'group' parameter is ignored.
1360 # See BlockIOThrottle for parameter descriptions.
1362 # Returns: Nothing on success
1363 # If @device is not a valid block device, DeviceNotFound
1367 { 'command': 'block_set_io_throttle', 'boxed': true,
1368 'data': 'BlockIOThrottle' }
1373 # A set of parameters describing block throttling.
1375 # @device: #optional Block device name (deprecated, use @id instead)
1377 # @id: #optional The name or QOM path of the guest device (since: 2.8)
1379 # @bps: total throughput limit in bytes per second
1381 # @bps_rd: read throughput limit in bytes per second
1383 # @bps_wr: write throughput limit in bytes per second
1385 # @iops: total I/O operations per second
1387 # @iops_rd: read I/O operations per second
1389 # @iops_wr: write I/O operations per second
1391 # @bps_max: #optional total throughput limit during bursts,
1392 # in bytes (Since 1.7)
1394 # @bps_rd_max: #optional read throughput limit during bursts,
1395 # in bytes (Since 1.7)
1397 # @bps_wr_max: #optional write throughput limit during bursts,
1398 # in bytes (Since 1.7)
1400 # @iops_max: #optional total I/O operations per second during bursts,
1401 # in bytes (Since 1.7)
1403 # @iops_rd_max: #optional read I/O operations per second during bursts,
1404 # in bytes (Since 1.7)
1406 # @iops_wr_max: #optional write I/O operations per second during bursts,
1407 # in bytes (Since 1.7)
1409 # @bps_max_length: #optional maximum length of the @bps_max burst
1410 # period, in seconds. It must only
1411 # be set if @bps_max is set as well.
1412 # Defaults to 1. (Since 2.6)
1414 # @bps_rd_max_length: #optional maximum length of the @bps_rd_max
1415 # burst period, in seconds. It must only
1416 # be set if @bps_rd_max is set as well.
1417 # Defaults to 1. (Since 2.6)
1419 # @bps_wr_max_length: #optional maximum length of the @bps_wr_max
1420 # burst period, in seconds. It must only
1421 # be set if @bps_wr_max is set as well.
1422 # Defaults to 1. (Since 2.6)
1424 # @iops_max_length: #optional maximum length of the @iops burst
1425 # period, in seconds. It must only
1426 # be set if @iops_max is set as well.
1427 # Defaults to 1. (Since 2.6)
1429 # @iops_rd_max_length: #optional maximum length of the @iops_rd_max
1430 # burst period, in seconds. It must only
1431 # be set if @iops_rd_max is set as well.
1432 # Defaults to 1. (Since 2.6)
1434 # @iops_wr_max_length: #optional maximum length of the @iops_wr_max
1435 # burst period, in seconds. It must only
1436 # be set if @iops_wr_max is set as well.
1437 # Defaults to 1. (Since 2.6)
1439 # @iops_size: #optional an I/O size in bytes (Since 1.7)
1441 # @group: #optional throttle group name (Since 2.4)
1445 { 'struct': 'BlockIOThrottle',
1446 'data': { '*device': 'str', '*id': 'str', 'bps': 'int', 'bps_rd': 'int',
1447 'bps_wr': 'int', 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
1448 '*bps_max': 'int', '*bps_rd_max': 'int',
1449 '*bps_wr_max': 'int', '*iops_max': 'int',
1450 '*iops_rd_max': 'int', '*iops_wr_max': 'int',
1451 '*bps_max_length': 'int', '*bps_rd_max_length': 'int',
1452 '*bps_wr_max_length': 'int', '*iops_max_length': 'int',
1453 '*iops_rd_max_length': 'int', '*iops_wr_max_length': 'int',
1454 '*iops_size': 'int', '*group': 'str' } }
1459 # Copy data from a backing file into a block device.
1461 # The block streaming operation is performed in the background until the entire
1462 # backing file has been copied. This command returns immediately once streaming
1463 # has started. The status of ongoing block streaming operations can be checked
1464 # with query-block-jobs. The operation can be stopped before it has completed
1465 # using the block-job-cancel command.
1467 # The node that receives the data is called the top image, can be located in
1468 # any part of the chain (but always above the base image; see below) and can be
1469 # specified using its device or node name. Earlier qemu versions only allowed
1470 # 'device' to name the top level node; presence of the 'base-node' parameter
1471 # during introspection can be used as a witness of the enhanced semantics
1474 # If a base file is specified then sectors are not copied from that base file and
1475 # its backing chain. When streaming completes the image file will have the base
1476 # file as its backing file. This can be used to stream a subset of the backing
1477 # file chain instead of flattening the entire image.
1479 # On successful completion the image file is updated to drop the backing file
1480 # and the BLOCK_JOB_COMPLETED event is emitted.
1482 # @job-id: #optional identifier for the newly-created block job. If
1483 # omitted, the device name will be used. (Since 2.7)
1485 # @device: the device or node name of the top image
1487 # @base: #optional the common backing file name.
1488 # It cannot be set if @base-node is also set.
1490 # @base-node: #optional the node name of the backing file.
1491 # It cannot be set if @base is also set. (Since 2.8)
1493 # @backing-file: #optional The backing file string to write into the top
1494 # image. This filename is not validated.
1496 # If a pathname string is such that it cannot be
1497 # resolved by QEMU, that means that subsequent QMP or
1498 # HMP commands must use node-names for the image in
1499 # question, as filename lookup methods will fail.
1501 # If not specified, QEMU will automatically determine
1502 # the backing file string to use, or error out if there
1503 # is no obvious choice. Care should be taken when
1504 # specifying the string, to specify a valid filename or
1508 # @speed: #optional the maximum speed, in bytes per second
1510 # @on-error: #optional the action to take on an error (default report).
1511 # 'stop' and 'enospc' can only be used if the block device
1512 # supports io-status (see BlockInfo). Since 1.3.
1516 { 'command': 'block-stream',
1517 'data': { '*job-id': 'str', 'device': 'str', '*base': 'str',
1518 '*base-node': 'str', '*backing-file': 'str', '*speed': 'int',
1519 '*on-error': 'BlockdevOnError' } }
1522 # @block-job-set-speed:
1524 # Set maximum speed for a background block operation.
1526 # This command can only be issued when there is an active block job.
1528 # Throttling can be disabled by setting the speed to 0.
1530 # @device: The job identifier. This used to be a device name (hence
1531 # the name of the parameter), but since QEMU 2.7 it can have
1534 # @speed: the maximum speed, in bytes per second, or 0 for unlimited.
1537 # Returns: Nothing on success
1538 # If no background operation is active on this device, DeviceNotActive
1542 { 'command': 'block-job-set-speed',
1543 'data': { 'device': 'str', 'speed': 'int' } }
1546 # @block-job-cancel:
1548 # Stop an active background block operation.
1550 # This command returns immediately after marking the active background block
1551 # operation for cancellation. It is an error to call this command if no
1552 # operation is in progress.
1554 # The operation will cancel as soon as possible and then emit the
1555 # BLOCK_JOB_CANCELLED event. Before that happens the job is still visible when
1556 # enumerated using query-block-jobs.
1558 # For streaming, the image file retains its backing file unless the streaming
1559 # operation happens to complete just as it is being cancelled. A new streaming
1560 # operation can be started at a later time to finish copying all data from the
1563 # @device: The job identifier. This used to be a device name (hence
1564 # the name of the parameter), but since QEMU 2.7 it can have
1567 # @force: #optional whether to allow cancellation of a paused job (default
1568 # false). Since 1.3.
1570 # Returns: Nothing on success
1571 # If no background operation is active on this device, DeviceNotActive
1575 { 'command': 'block-job-cancel', 'data': { 'device': 'str', '*force': 'bool' } }
1580 # Pause an active background block operation.
1582 # This command returns immediately after marking the active background block
1583 # operation for pausing. It is an error to call this command if no
1584 # operation is in progress. Pausing an already paused job has no cumulative
1585 # effect; a single block-job-resume command will resume the job.
1587 # The operation will pause as soon as possible. No event is emitted when
1588 # the operation is actually paused. Cancelling a paused job automatically
1591 # @device: The job identifier. This used to be a device name (hence
1592 # the name of the parameter), but since QEMU 2.7 it can have
1595 # Returns: Nothing on success
1596 # If no background operation is active on this device, DeviceNotActive
1600 { 'command': 'block-job-pause', 'data': { 'device': 'str' } }
1603 # @block-job-resume:
1605 # Resume an active background block operation.
1607 # This command returns immediately after resuming a paused background block
1608 # operation. It is an error to call this command if no operation is in
1609 # progress. Resuming an already running job is not an error.
1611 # This command also clears the error status of the job.
1613 # @device: The job identifier. This used to be a device name (hence
1614 # the name of the parameter), but since QEMU 2.7 it can have
1617 # Returns: Nothing on success
1618 # If no background operation is active on this device, DeviceNotActive
1622 { 'command': 'block-job-resume', 'data': { 'device': 'str' } }
1625 # @block-job-complete:
1627 # Manually trigger completion of an active background block operation. This
1628 # is supported for drive mirroring, where it also switches the device to
1629 # write to the target path only. The ability to complete is signaled with
1630 # a BLOCK_JOB_READY event.
1632 # This command completes an active background block operation synchronously.
1633 # The ordering of this command's return with the BLOCK_JOB_COMPLETED event
1634 # is not defined. Note that if an I/O error occurs during the processing of
1635 # this command: 1) the command itself will fail; 2) the error will be processed
1636 # according to the rerror/werror arguments that were specified when starting
1639 # A cancelled or paused job cannot be completed.
1641 # @device: The job identifier. This used to be a device name (hence
1642 # the name of the parameter), but since QEMU 2.7 it can have
1645 # Returns: Nothing on success
1646 # If no background operation is active on this device, DeviceNotActive
1650 { 'command': 'block-job-complete', 'data': { 'device': 'str' } }
1653 # @BlockdevDiscardOptions
1655 # Determines how to handle discard requests.
1657 # @ignore: Ignore the request
1658 # @unmap: Forward as an unmap request
1662 { 'enum': 'BlockdevDiscardOptions',
1663 'data': [ 'ignore', 'unmap' ] }
1666 # @BlockdevDetectZeroesOptions
1668 # Describes the operation mode for the automatic conversion of plain
1669 # zero writes by the OS to driver specific optimized zero write commands.
1671 # @off: Disabled (default)
1673 # @unmap: Enabled and even try to unmap blocks if possible. This requires
1674 # also that @BlockdevDiscardOptions is set to unmap for this device.
1678 { 'enum': 'BlockdevDetectZeroesOptions',
1679 'data': [ 'off', 'on', 'unmap' ] }
1682 # @BlockdevAioOptions
1684 # Selects the AIO backend to handle I/O requests
1686 # @threads: Use qemu's thread pool
1687 # @native: Use native AIO backend (only Linux and Windows)
1691 { 'enum': 'BlockdevAioOptions',
1692 'data': [ 'threads', 'native' ] }
1695 # @BlockdevCacheOptions
1697 # Includes cache-related options for block devices
1699 # @direct: #optional enables use of O_DIRECT (bypass the host page cache;
1701 # @no-flush: #optional ignore any flush requests for the device (default:
1706 { 'struct': 'BlockdevCacheOptions',
1707 'data': { '*direct': 'bool',
1708 '*no-flush': 'bool' } }
1713 # Drivers that are supported in block device operations.
1715 # @host_device, @host_cdrom: Since 2.1
1716 # @gluster: Since 2.7
1717 # @nbd, @nfs, @replication, @ssh: Since 2.8
1721 { 'enum': 'BlockdevDriver',
1722 'data': [ 'archipelago', 'blkdebug', 'blkverify', 'bochs', 'cloop',
1723 'dmg', 'file', 'ftp', 'ftps', 'gluster', 'host_cdrom',
1724 'host_device', 'http', 'https', 'luks', 'nbd', 'nfs', 'null-aio',
1725 'null-co', 'parallels', 'qcow', 'qcow2', 'qed', 'quorum', 'raw',
1726 'replication', 'ssh', 'vdi', 'vhdx', 'vmdk', 'vpc',
1730 # @BlockdevOptionsFile
1732 # Driver specific block device options for the file backend.
1734 # @filename: path to the image file
1735 # @aio: #optional AIO backend (default: threads) (since: 2.8)
1739 { 'struct': 'BlockdevOptionsFile',
1740 'data': { 'filename': 'str',
1741 '*aio': 'BlockdevAioOptions' } }
1744 # @BlockdevOptionsNull
1746 # Driver specific block device options for the null backend.
1748 # @size: #optional size of the device in bytes.
1749 # @latency-ns: #optional emulated latency (in nanoseconds) in processing
1750 # requests. Default to zero which completes requests immediately.
1755 { 'struct': 'BlockdevOptionsNull',
1756 'data': { '*size': 'int', '*latency-ns': 'uint64' } }
1759 # @BlockdevOptionsVVFAT
1761 # Driver specific block device options for the vvfat protocol.
1763 # @dir: directory to be exported as FAT image
1764 # @fat-type: #optional FAT type: 12, 16 or 32
1765 # @floppy: #optional whether to export a floppy image (true) or
1766 # partitioned hard disk (false; default)
1767 # @label: #optional set the volume label, limited to 11 bytes. FAT16 and
1768 # FAT32 traditionally have some restrictions on labels, which are
1769 # ignored by most operating systems. Defaults to "QEMU VVFAT".
1771 # @rw: #optional whether to allow write operations (default: false)
1775 { 'struct': 'BlockdevOptionsVVFAT',
1776 'data': { 'dir': 'str', '*fat-type': 'int', '*floppy': 'bool',
1777 '*label': 'str', '*rw': 'bool' } }
1780 # @BlockdevOptionsGenericFormat
1782 # Driver specific block device options for image format that have no option
1783 # besides their data source.
1785 # @file: reference to or definition of the data source block device
1789 { 'struct': 'BlockdevOptionsGenericFormat',
1790 'data': { 'file': 'BlockdevRef' } }
1793 # @BlockdevOptionsLUKS
1795 # Driver specific block device options for LUKS.
1797 # @key-secret: #optional the ID of a QCryptoSecret object providing
1798 # the decryption key (since 2.6). Mandatory except when
1799 # doing a metadata-only probe of the image.
1803 { 'struct': 'BlockdevOptionsLUKS',
1804 'base': 'BlockdevOptionsGenericFormat',
1805 'data': { '*key-secret': 'str' } }
1809 # @BlockdevOptionsGenericCOWFormat
1811 # Driver specific block device options for image format that have no option
1812 # besides their data source and an optional backing file.
1814 # @backing: #optional reference to or definition of the backing file block
1815 # device (if missing, taken from the image file content). It is
1816 # allowed to pass an empty string here in order to disable the
1817 # default backing file.
1821 { 'struct': 'BlockdevOptionsGenericCOWFormat',
1822 'base': 'BlockdevOptionsGenericFormat',
1823 'data': { '*backing': 'BlockdevRef' } }
1826 # @Qcow2OverlapCheckMode
1828 # General overlap check modes.
1830 # @none: Do not perform any checks
1832 # @constant: Perform only checks which can be done in constant time and
1833 # without reading anything from disk
1835 # @cached: Perform only checks which can be done without reading anything
1838 # @all: Perform all available overlap checks
1842 { 'enum': 'Qcow2OverlapCheckMode',
1843 'data': [ 'none', 'constant', 'cached', 'all' ] }
1846 # @Qcow2OverlapCheckFlags
1848 # Structure of flags for each metadata structure. Setting a field to 'true'
1849 # makes qemu guard that structure against unintended overwriting. The default
1850 # value is chosen according to the template given.
1852 # @template: Specifies a template mode which can be adjusted using the other
1853 # flags, defaults to 'cached'
1857 { 'struct': 'Qcow2OverlapCheckFlags',
1858 'data': { '*template': 'Qcow2OverlapCheckMode',
1859 '*main-header': 'bool',
1860 '*active-l1': 'bool',
1861 '*active-l2': 'bool',
1862 '*refcount-table': 'bool',
1863 '*refcount-block': 'bool',
1864 '*snapshot-table': 'bool',
1865 '*inactive-l1': 'bool',
1866 '*inactive-l2': 'bool' } }
1869 # @Qcow2OverlapChecks
1871 # Specifies which metadata structures should be guarded against unintended
1874 # @flags: set of flags for separate specification of each metadata structure
1877 # @mode: named mode which chooses a specific set of flags
1881 { 'alternate': 'Qcow2OverlapChecks',
1882 'data': { 'flags': 'Qcow2OverlapCheckFlags',
1883 'mode': 'Qcow2OverlapCheckMode' } }
1886 # @BlockdevOptionsQcow2
1888 # Driver specific block device options for qcow2.
1890 # @lazy-refcounts: #optional whether to enable the lazy refcounts
1891 # feature (default is taken from the image file)
1893 # @pass-discard-request: #optional whether discard requests to the qcow2
1894 # device should be forwarded to the data source
1896 # @pass-discard-snapshot: #optional whether discard requests for the data source
1897 # should be issued when a snapshot operation (e.g.
1898 # deleting a snapshot) frees clusters in the qcow2 file
1900 # @pass-discard-other: #optional whether discard requests for the data source
1901 # should be issued on other occasions where a cluster
1904 # @overlap-check: #optional which overlap checks to perform for writes
1905 # to the image, defaults to 'cached' (since 2.2)
1907 # @cache-size: #optional the maximum total size of the L2 table and
1908 # refcount block caches in bytes (since 2.2)
1910 # @l2-cache-size: #optional the maximum size of the L2 table cache in
1913 # @refcount-cache-size: #optional the maximum size of the refcount block cache
1914 # in bytes (since 2.2)
1916 # @cache-clean-interval: #optional clean unused entries in the L2 and refcount
1917 # caches. The interval is in seconds. The default value
1918 # is 0 and it disables this feature (since 2.5)
1922 { 'struct': 'BlockdevOptionsQcow2',
1923 'base': 'BlockdevOptionsGenericCOWFormat',
1924 'data': { '*lazy-refcounts': 'bool',
1925 '*pass-discard-request': 'bool',
1926 '*pass-discard-snapshot': 'bool',
1927 '*pass-discard-other': 'bool',
1928 '*overlap-check': 'Qcow2OverlapChecks',
1929 '*cache-size': 'int',
1930 '*l2-cache-size': 'int',
1931 '*refcount-cache-size': 'int',
1932 '*cache-clean-interval': 'int' } }
1936 # @BlockdevOptionsArchipelago
1938 # Driver specific block device options for Archipelago.
1940 # @volume: Name of the Archipelago volume image
1942 # @mport: #optional The port number on which mapperd is
1943 # listening. This is optional
1944 # and if not specified, QEMU will make Archipelago
1945 # use the default port (1001).
1947 # @vport: #optional The port number on which vlmcd is
1948 # listening. This is optional
1949 # and if not specified, QEMU will make Archipelago
1950 # use the default port (501).
1952 # @segment: #optional The name of the shared memory segment
1953 # Archipelago stack is using. This is optional
1954 # and if not specified, QEMU will make Archipelago
1955 # use the default value, 'archipelago'.
1958 { 'struct': 'BlockdevOptionsArchipelago',
1959 'data': { 'volume': 'str',
1962 '*segment': 'str' } }
1965 # @BlockdevOptionsSsh
1967 # @server: host address
1969 # @path: path to the image on the host
1971 # @user: #optional user as which to connect, defaults to current
1974 # TODO: Expose the host_key_check option in QMP
1978 { 'struct': 'BlockdevOptionsSsh',
1979 'data': { 'server': 'InetSocketAddress',
1987 # Trigger events supported by blkdebug.
1991 { 'enum': 'BlkdebugEvent', 'prefix': 'BLKDBG',
1992 'data': [ 'l1_update', 'l1_grow_alloc_table', 'l1_grow_write_table',
1993 'l1_grow_activate_table', 'l2_load', 'l2_update',
1994 'l2_update_compressed', 'l2_alloc_cow_read', 'l2_alloc_write',
1995 'read_aio', 'read_backing_aio', 'read_compressed', 'write_aio',
1996 'write_compressed', 'vmstate_load', 'vmstate_save', 'cow_read',
1997 'cow_write', 'reftable_load', 'reftable_grow', 'reftable_update',
1998 'refblock_load', 'refblock_update', 'refblock_update_part',
1999 'refblock_alloc', 'refblock_alloc_hookup', 'refblock_alloc_write',
2000 'refblock_alloc_write_blocks', 'refblock_alloc_write_table',
2001 'refblock_alloc_switch_table', 'cluster_alloc',
2002 'cluster_alloc_bytes', 'cluster_free', 'flush_to_os',
2003 'flush_to_disk', 'pwritev_rmw_head', 'pwritev_rmw_after_head',
2004 'pwritev_rmw_tail', 'pwritev_rmw_after_tail', 'pwritev',
2005 'pwritev_zero', 'pwritev_done', 'empty_image_prepare' ] }
2008 # @BlkdebugInjectErrorOptions
2010 # Describes a single error injection for blkdebug.
2012 # @event: trigger event
2014 # @state: #optional the state identifier blkdebug needs to be in to
2015 # actually trigger the event; defaults to "any"
2017 # @errno: #optional error identifier (errno) to be returned; defaults to
2020 # @sector: #optional specifies the sector index which has to be affected
2021 # in order to actually trigger the event; defaults to "any
2024 # @once: #optional disables further events after this one has been
2025 # triggered; defaults to false
2027 # @immediately: #optional fail immediately; defaults to false
2031 { 'struct': 'BlkdebugInjectErrorOptions',
2032 'data': { 'event': 'BlkdebugEvent',
2037 '*immediately': 'bool' } }
2040 # @BlkdebugSetStateOptions
2042 # Describes a single state-change event for blkdebug.
2044 # @event: trigger event
2046 # @state: #optional the current state identifier blkdebug needs to be in;
2049 # @new_state: the state identifier blkdebug is supposed to assume if
2050 # this event is triggered
2054 { 'struct': 'BlkdebugSetStateOptions',
2055 'data': { 'event': 'BlkdebugEvent',
2057 'new_state': 'int' } }
2060 # @BlockdevOptionsBlkdebug
2062 # Driver specific block device options for blkdebug.
2064 # @image: underlying raw block device (or image file)
2066 # @config: #optional filename of the configuration file
2068 # @align: #optional required alignment for requests in bytes,
2069 # must be power of 2, or 0 for default
2071 # @inject-error: #optional array of error injection descriptions
2073 # @set-state: #optional array of state-change descriptions
2077 { 'struct': 'BlockdevOptionsBlkdebug',
2078 'data': { 'image': 'BlockdevRef',
2081 '*inject-error': ['BlkdebugInjectErrorOptions'],
2082 '*set-state': ['BlkdebugSetStateOptions'] } }
2085 # @BlockdevOptionsBlkverify
2087 # Driver specific block device options for blkverify.
2089 # @test: block device to be tested
2091 # @raw: raw image used for verification
2095 { 'struct': 'BlockdevOptionsBlkverify',
2096 'data': { 'test': 'BlockdevRef',
2097 'raw': 'BlockdevRef' } }
2100 # @QuorumReadPattern
2102 # An enumeration of quorum read patterns.
2104 # @quorum: read all the children and do a quorum vote on reads
2106 # @fifo: read only from the first child that has not failed
2110 { 'enum': 'QuorumReadPattern', 'data': [ 'quorum', 'fifo' ] }
2113 # @BlockdevOptionsQuorum
2115 # Driver specific block device options for Quorum
2117 # @blkverify: #optional true if the driver must print content mismatch
2118 # set to false by default
2120 # @children: the children block devices to use
2122 # @vote-threshold: the vote limit under which a read will fail
2124 # @rewrite-corrupted: #optional rewrite corrupted data when quorum is reached
2127 # @read-pattern: #optional choose read pattern and set to quorum by default
2132 { 'struct': 'BlockdevOptionsQuorum',
2133 'data': { '*blkverify': 'bool',
2134 'children': [ 'BlockdevRef' ],
2135 'vote-threshold': 'int',
2136 '*rewrite-corrupted': 'bool',
2137 '*read-pattern': 'QuorumReadPattern' } }
2142 # An enumeration of Gluster transport types
2144 # @tcp: TCP - Transmission Control Protocol
2146 # @unix: UNIX - Unix domain socket
2150 { 'enum': 'GlusterTransport',
2151 'data': [ 'unix', 'tcp' ] }
2157 # Captures the address of a socket
2159 # Details for connecting to a gluster server
2161 # @type: Transport type used for gluster connection
2163 # @unix: socket file
2165 # @tcp: host address and port number
2167 # This is similar to SocketAddress, only distinction:
2169 # 1. GlusterServer is a flat union, SocketAddress is a simple union.
2170 # A flat union is nicer than simple because it avoids nesting
2171 # (i.e. more {}) on the wire.
2173 # 2. GlusterServer lacks case 'fd', since gluster doesn't let you
2174 # pass in a file descriptor.
2176 # GlusterServer is actually not Gluster-specific, its a
2177 # compatibility evolved into an alternate for SocketAddress.
2181 { 'union': 'GlusterServer',
2182 'base': { 'type': 'GlusterTransport' },
2183 'discriminator': 'type',
2184 'data': { 'unix': 'UnixSocketAddress',
2185 'tcp': 'InetSocketAddress' } }
2188 # @BlockdevOptionsGluster
2190 # Driver specific block device options for Gluster
2192 # @volume: name of gluster volume where VM image resides
2194 # @path: absolute path to image file in gluster volume
2196 # @server: gluster servers description
2198 # @debug-level: #optional libgfapi log level (default '4' which is Error)
2200 # @logfile: #optional libgfapi log file (default /dev/stderr) (Since 2.8)
2204 { 'struct': 'BlockdevOptionsGluster',
2205 'data': { 'volume': 'str',
2207 'server': ['GlusterServer'],
2208 '*debug-level': 'int',
2209 '*logfile': 'str' } }
2214 # An enumeration of replication modes.
2216 # @primary: Primary mode, the vm's state will be sent to secondary QEMU.
2218 # @secondary: Secondary mode, receive the vm's state from primary QEMU.
2222 { 'enum' : 'ReplicationMode', 'data' : [ 'primary', 'secondary' ] }
2225 # @BlockdevOptionsReplication
2227 # Driver specific block device options for replication
2229 # @mode: the replication mode
2231 # @top-id: #optional In secondary mode, node name or device ID of the root
2232 # node who owns the replication node chain. Must not be given in
2237 { 'struct': 'BlockdevOptionsReplication',
2238 'base': 'BlockdevOptionsGenericFormat',
2239 'data': { 'mode': 'ReplicationMode',
2240 '*top-id': 'str' } }
2245 # An enumeration of NFS transport types
2247 # @inet: TCP transport
2251 { 'enum': 'NFSTransport',
2252 'data': [ 'inet' ] }
2257 # Captures the address of the socket
2259 # @type: transport type used for NFS (only TCP supported)
2261 # @host: host address for NFS server
2265 { 'struct': 'NFSServer',
2266 'data': { 'type': 'NFSTransport',
2270 # @BlockdevOptionsNfs
2272 # Driver specific block device option for NFS
2274 # @server: host address
2276 # @path: path of the image on the host
2278 # @user: #optional UID value to use when talking to the
2279 # server (defaults to 65534 on Windows and getuid()
2282 # @group: #optional GID value to use when talking to the
2283 # server (defaults to 65534 on Windows and getgid()
2286 # @tcp-syn-count: #optional number of SYNs during the session
2287 # establishment (defaults to libnfs default)
2289 # @readahead-size: #optional set the readahead size in bytes (defaults
2290 # to libnfs default)
2292 # @page-cache-size: #optional set the pagecache size in bytes (defaults
2293 # to libnfs default)
2295 # @debug-level: #optional set the NFS debug level (max 2) (defaults
2296 # to libnfs default)
2300 { 'struct': 'BlockdevOptionsNfs',
2301 'data': { 'server': 'NFSServer',
2305 '*tcp-syn-count': 'int',
2306 '*readahead-size': 'int',
2307 '*page-cache-size': 'int',
2308 '*debug-level': 'int' } }
2311 # @BlockdevOptionsCurl
2313 # Driver specific block device options for the curl backend.
2315 # @filename: path to the image file
2319 { 'struct': 'BlockdevOptionsCurl',
2320 'data': { 'filename': 'str' } }
2323 # @BlockdevOptionsNbd
2325 # Driver specific block device options for NBD.
2327 # @server: NBD server address
2329 # @export: #optional export name
2331 # @tls-creds: #optional TLS credentials ID
2335 { 'struct': 'BlockdevOptionsNbd',
2336 'data': { 'server': 'SocketAddress',
2338 '*tls-creds': 'str' } }
2341 # @BlockdevOptionsRaw
2343 # Driver specific block device options for the raw driver.
2345 # @offset: #optional position where the block device starts
2346 # @size: #optional the assumed size of the device
2350 { 'struct': 'BlockdevOptionsRaw',
2351 'base': 'BlockdevOptionsGenericFormat',
2352 'data': { '*offset': 'int', '*size': 'int' } }
2357 # Options for creating a block device. Many options are available for all
2358 # block devices, independent of the block driver:
2360 # @driver: block driver name
2361 # @node-name: #optional the node name of the new node (Since 2.0).
2362 # This option is required on the top level of blockdev-add.
2363 # @discard: #optional discard-related options (default: ignore)
2364 # @cache: #optional cache-related options
2365 # @read-only: #optional whether the block device should be read-only
2367 # @detect-zeroes: #optional detect and optimize zero writes (Since 2.1)
2370 # Remaining options are determined by the block driver.
2374 { 'union': 'BlockdevOptions',
2375 'base': { 'driver': 'BlockdevDriver',
2376 '*node-name': 'str',
2377 '*discard': 'BlockdevDiscardOptions',
2378 '*cache': 'BlockdevCacheOptions',
2379 '*read-only': 'bool',
2380 '*detect-zeroes': 'BlockdevDetectZeroesOptions' },
2381 'discriminator': 'driver',
2383 'archipelago':'BlockdevOptionsArchipelago',
2384 'blkdebug': 'BlockdevOptionsBlkdebug',
2385 'blkverify': 'BlockdevOptionsBlkverify',
2386 'bochs': 'BlockdevOptionsGenericFormat',
2387 'cloop': 'BlockdevOptionsGenericFormat',
2388 'dmg': 'BlockdevOptionsGenericFormat',
2389 'file': 'BlockdevOptionsFile',
2390 'ftp': 'BlockdevOptionsCurl',
2391 'ftps': 'BlockdevOptionsCurl',
2392 'gluster': 'BlockdevOptionsGluster',
2393 'host_cdrom': 'BlockdevOptionsFile',
2394 'host_device':'BlockdevOptionsFile',
2395 'http': 'BlockdevOptionsCurl',
2396 'https': 'BlockdevOptionsCurl',
2397 # TODO iscsi: Wait for structured options
2398 'luks': 'BlockdevOptionsLUKS',
2399 'nbd': 'BlockdevOptionsNbd',
2400 'nfs': 'BlockdevOptionsNfs',
2401 'null-aio': 'BlockdevOptionsNull',
2402 'null-co': 'BlockdevOptionsNull',
2403 'parallels': 'BlockdevOptionsGenericFormat',
2404 'qcow2': 'BlockdevOptionsQcow2',
2405 'qcow': 'BlockdevOptionsGenericCOWFormat',
2406 'qed': 'BlockdevOptionsGenericCOWFormat',
2407 'quorum': 'BlockdevOptionsQuorum',
2408 'raw': 'BlockdevOptionsRaw',
2409 # TODO rbd: Wait for structured options
2410 'replication':'BlockdevOptionsReplication',
2411 # TODO sheepdog: Wait for structured options
2412 'ssh': 'BlockdevOptionsSsh',
2413 'vdi': 'BlockdevOptionsGenericFormat',
2414 'vhdx': 'BlockdevOptionsGenericFormat',
2415 'vmdk': 'BlockdevOptionsGenericCOWFormat',
2416 'vpc': 'BlockdevOptionsGenericFormat',
2417 'vvfat': 'BlockdevOptionsVVFAT'
2423 # Reference to a block device.
2425 # @definition: defines a new block device inline
2426 # @reference: references the ID of an existing block device. An
2427 # empty string means that no block device should be
2432 { 'alternate': 'BlockdevRef',
2433 'data': { 'definition': 'BlockdevOptions',
2434 'reference': 'str' } }
2439 # Creates a new block device. If the @id option is given at the top level, a
2440 # BlockBackend will be created; otherwise, @node-name is mandatory at the top
2441 # level and no BlockBackend will be created.
2443 # This command is still a work in progress. It doesn't support all
2444 # block drivers among other things. Stay away from it unless you want
2445 # to help with its development.
2447 # For the arguments, see the documentation of BlockdevOptions.
2451 { 'command': 'blockdev-add', 'data': 'BlockdevOptions', 'boxed': true }
2456 # Deletes a block device that has been added using blockdev-add.
2457 # The command will fail if the node is attached to a device or is
2458 # otherwise being used.
2460 # This command is still a work in progress and is considered
2461 # experimental. Stay away from it unless you want to help with its
2464 # @node-name: Name of the graph node to delete.
2468 { 'command': 'x-blockdev-del', 'data': { 'node-name': 'str' } }
2471 # @blockdev-open-tray:
2473 # Opens a block device's tray. If there is a block driver state tree inserted as
2474 # a medium, it will become inaccessible to the guest (but it will remain
2475 # associated to the block device, so closing the tray will make it accessible
2478 # If the tray was already open before, this will be a no-op.
2480 # Once the tray opens, a DEVICE_TRAY_MOVED event is emitted. There are cases in
2481 # which no such event will be generated, these include:
2482 # - if the guest has locked the tray, @force is false and the guest does not
2483 # respond to the eject request
2484 # - if the BlockBackend denoted by @device does not have a guest device attached
2486 # - if the guest device does not have an actual tray
2488 # @device: #optional Block device name (deprecated, use @id instead)
2490 # @id: #optional The name or QOM path of the guest device (since: 2.8)
2492 # @force: #optional if false (the default), an eject request will be sent to
2493 # the guest if it has locked the tray (and the tray will not be opened
2494 # immediately); if true, the tray will be opened regardless of whether
2499 { 'command': 'blockdev-open-tray',
2500 'data': { '*device': 'str',
2502 '*force': 'bool' } }
2505 # @blockdev-close-tray:
2507 # Closes a block device's tray. If there is a block driver state tree associated
2508 # with the block device (which is currently ejected), that tree will be loaded
2511 # If the tray was already closed before, this will be a no-op.
2513 # @device: #optional Block device name (deprecated, use @id instead)
2515 # @id: #optional The name or QOM path of the guest device (since: 2.8)
2519 { 'command': 'blockdev-close-tray',
2520 'data': { '*device': 'str',
2524 # @x-blockdev-remove-medium:
2526 # Removes a medium (a block driver state tree) from a block device. That block
2527 # device's tray must currently be open (unless there is no attached guest
2530 # If the tray is open and there is no medium inserted, this will be a no-op.
2532 # This command is still a work in progress and is considered experimental.
2533 # Stay away from it unless you want to help with its development.
2535 # @device: #optional Block device name (deprecated, use @id instead)
2537 # @id: #optional The name or QOM path of the guest device (since: 2.8)
2541 { 'command': 'x-blockdev-remove-medium',
2542 'data': { '*device': 'str',
2546 # @x-blockdev-insert-medium:
2548 # Inserts a medium (a block driver state tree) into a block device. That block
2549 # device's tray must currently be open (unless there is no attached guest
2550 # device) and there must be no medium inserted already.
2552 # This command is still a work in progress and is considered experimental.
2553 # Stay away from it unless you want to help with its development.
2555 # @device: #optional Block device name (deprecated, use @id instead)
2557 # @id: #optional The name or QOM path of the guest device (since: 2.8)
2559 # @node-name: name of a node in the block driver state graph
2563 { 'command': 'x-blockdev-insert-medium',
2564 'data': { '*device': 'str',
2566 'node-name': 'str'} }
2570 # @BlockdevChangeReadOnlyMode:
2572 # Specifies the new read-only mode of a block device subject to the
2573 # @blockdev-change-medium command.
2575 # @retain: Retains the current read-only mode
2577 # @read-only: Makes the device read-only
2579 # @read-write: Makes the device writable
2583 { 'enum': 'BlockdevChangeReadOnlyMode',
2584 'data': ['retain', 'read-only', 'read-write'] }
2588 # @blockdev-change-medium:
2590 # Changes the medium inserted into a block device by ejecting the current medium
2591 # and loading a new image file which is inserted as the new medium (this command
2592 # combines blockdev-open-tray, x-blockdev-remove-medium,
2593 # x-blockdev-insert-medium and blockdev-close-tray).
2595 # @device: #optional Block device name (deprecated, use @id instead)
2597 # @id: #optional The name or QOM path of the guest device
2600 # @filename: filename of the new image to be loaded
2602 # @format: #optional, format to open the new image with (defaults to
2603 # the probed format)
2605 # @read-only-mode: #optional, change the read-only mode of the device; defaults
2610 { 'command': 'blockdev-change-medium',
2611 'data': { '*device': 'str',
2615 '*read-only-mode': 'BlockdevChangeReadOnlyMode' } }
2621 # An enumeration of action that has been taken when a DISK I/O occurs
2623 # @ignore: error has been ignored
2625 # @report: error has been reported to the device
2627 # @stop: error caused VM to be stopped
2631 { 'enum': 'BlockErrorAction',
2632 'data': [ 'ignore', 'report', 'stop' ] }
2636 # @BLOCK_IMAGE_CORRUPTED
2638 # Emitted when a corruption has been detected in a disk image
2640 # @device: device name. This is always present for compatibility
2641 # reasons, but it can be empty ("") if the image does not
2642 # have a device name associated.
2644 # @node-name: #optional node name (Since: 2.4)
2646 # @msg: informative message for human consumption, such as the kind of
2647 # corruption being detected. It should not be parsed by machine as it is
2648 # not guaranteed to be stable
2650 # @offset: #optional, if the corruption resulted from an image access, this is
2651 # the host's access offset into the image
2653 # @size: #optional, if the corruption resulted from an image access, this is
2656 # fatal: if set, the image is marked corrupt and therefore unusable after this
2657 # event and must be repaired (Since 2.2; before, every
2658 # BLOCK_IMAGE_CORRUPTED event was fatal)
2662 { 'event': 'BLOCK_IMAGE_CORRUPTED',
2663 'data': { 'device' : 'str',
2664 '*node-name' : 'str',
2668 'fatal' : 'bool' } }
2673 # Emitted when a disk I/O error occurs
2675 # @device: device name. This is always present for compatibility
2676 # reasons, but it can be empty ("") if the image does not
2677 # have a device name associated.
2679 # @node-name: node name. Note that errors may be reported for the root node
2680 # that is directly attached to a guest device rather than for the
2681 # node where the error occurred. (Since: 2.8)
2683 # @operation: I/O operation
2685 # @action: action that has been taken
2687 # @nospace: #optional true if I/O error was caused due to a no-space
2688 # condition. This key is only present if query-block's
2689 # io-status is present, please see query-block documentation
2690 # for more information (since: 2.2)
2692 # @reason: human readable string describing the error cause.
2693 # (This field is a debugging aid for humans, it should not
2694 # be parsed by applications) (since: 2.2)
2696 # Note: If action is "stop", a STOP event will eventually follow the
2697 # BLOCK_IO_ERROR event
2701 { 'event': 'BLOCK_IO_ERROR',
2702 'data': { 'device': 'str', 'node-name': 'str', 'operation': 'IoOperationType',
2703 'action': 'BlockErrorAction', '*nospace': 'bool',
2707 # @BLOCK_JOB_COMPLETED
2709 # Emitted when a block job has completed
2713 # @device: The job identifier. Originally the device name but other
2714 # values are allowed since QEMU 2.7
2716 # @len: maximum progress value
2718 # @offset: current progress value. On success this is equal to len.
2719 # On failure this is less than len
2721 # @speed: rate limit, bytes per second
2723 # @error: #optional, error message. Only present on failure. This field
2724 # contains a human-readable error message. There are no semantics
2725 # other than that streaming has failed and clients should not try to
2726 # interpret the error string
2730 { 'event': 'BLOCK_JOB_COMPLETED',
2731 'data': { 'type' : 'BlockJobType',
2739 # @BLOCK_JOB_CANCELLED
2741 # Emitted when a block job has been cancelled
2745 # @device: The job identifier. Originally the device name but other
2746 # values are allowed since QEMU 2.7
2748 # @len: maximum progress value
2750 # @offset: current progress value. On success this is equal to len.
2751 # On failure this is less than len
2753 # @speed: rate limit, bytes per second
2757 { 'event': 'BLOCK_JOB_CANCELLED',
2758 'data': { 'type' : 'BlockJobType',
2767 # Emitted when a block job encounters an error
2769 # @device: The job identifier. Originally the device name but other
2770 # values are allowed since QEMU 2.7
2772 # @operation: I/O operation
2774 # @action: action that has been taken
2778 { 'event': 'BLOCK_JOB_ERROR',
2779 'data': { 'device' : 'str',
2780 'operation': 'IoOperationType',
2781 'action' : 'BlockErrorAction' } }
2786 # Emitted when a block job is ready to complete
2790 # @device: The job identifier. Originally the device name but other
2791 # values are allowed since QEMU 2.7
2793 # @len: maximum progress value
2795 # @offset: current progress value. On success this is equal to len.
2796 # On failure this is less than len
2798 # @speed: rate limit, bytes per second
2800 # Note: The "ready to complete" status is always reset by a @BLOCK_JOB_ERROR
2805 { 'event': 'BLOCK_JOB_READY',
2806 'data': { 'type' : 'BlockJobType',
2815 # Preallocation mode of QEMU image file
2817 # @off: no preallocation
2818 # @metadata: preallocate only for metadata
2819 # @falloc: like @full preallocation but allocate disk space by
2820 # posix_fallocate() rather than writing zeros.
2821 # @full: preallocate all data by writing zeros to device to ensure disk
2822 # space is really available. @full preallocation also sets up
2823 # metadata correctly.
2827 { 'enum': 'PreallocMode',
2828 'data': [ 'off', 'metadata', 'falloc', 'full' ] }
2831 # @BLOCK_WRITE_THRESHOLD
2833 # Emitted when writes on block device reaches or exceeds the
2834 # configured write threshold. For thin-provisioned devices, this
2835 # means the device should be extended to avoid pausing for
2837 # The event is one shot. Once triggered, it needs to be
2838 # re-registered with another block-set-threshold command.
2840 # @node-name: graph node name on which the threshold was exceeded.
2842 # @amount-exceeded: amount of data which exceeded the threshold, in bytes.
2844 # @write-threshold: last configured threshold, in bytes.
2848 { 'event': 'BLOCK_WRITE_THRESHOLD',
2849 'data': { 'node-name': 'str',
2850 'amount-exceeded': 'uint64',
2851 'write-threshold': 'uint64' } }
2854 # @block-set-write-threshold
2856 # Change the write threshold for a block drive. An event will be delivered
2857 # if a write to this block drive crosses the configured threshold.
2858 # This is useful to transparently resize thin-provisioned drives without
2859 # the guest OS noticing.
2861 # @node-name: graph node name on which the threshold must be set.
2863 # @write-threshold: configured threshold for the block device, bytes.
2864 # Use 0 to disable the threshold.
2868 { 'command': 'block-set-write-threshold',
2869 'data': { 'node-name': 'str', 'write-threshold': 'uint64' } }
2872 # @x-blockdev-change
2874 # Dynamically reconfigure the block driver state graph. It can be used
2875 # to add, remove, insert or replace a graph node. Currently only the
2876 # Quorum driver implements this feature to add or remove its child. This
2877 # is useful to fix a broken quorum child.
2879 # If @node is specified, it will be inserted under @parent. @child
2880 # may not be specified in this case. If both @parent and @child are
2881 # specified but @node is not, @child will be detached from @parent.
2883 # @parent: the id or name of the parent node.
2885 # @child: #optional the name of a child under the given parent node.
2887 # @node: #optional the name of the node that will be added.
2889 # Note: this command is experimental, and its API is not stable. It
2890 # does not support all kinds of operations, all kinds of children, nor
2891 # all block drivers.
2893 # Warning: The data in a new quorum child MUST be consistent with that of
2894 # the rest of the array.
2898 { 'command': 'x-blockdev-change',
2899 'data' : { 'parent': 'str',