Lines Matching +full:int +full:- +full:clock +full:- +full:stable +full:- +full:broken
1 # -*- Mode: Python -*-
20 # @vm-state-size: size of the VM state
22 # @date-sec: UTC date of the snapshot in seconds
24 # @date-nsec: fractional part in nano seconds to be used with date-sec
26 # @vm-clock-sec: VM clock relative to boot in seconds
28 # @vm-clock-nsec: fractional part in nano seconds to be used with
29 # vm-clock-sec
32 # record/replay is enabled. Used for "time-traveling" to match
34 # counter may be obtained through @query-replay command (since
40 'data': { 'id': 'str', 'name': 'str', 'vm-state-size': 'int',
41 'date-sec': 'int', 'date-nsec': 'int',
42 'vm-clock-sec': 'int', 'vm-clock-nsec': 'int',
43 '*icount': 'int' } }
70 # @data-file: the filename of the external data file that is stored in
74 # @data-file-raw: True if the external data file must stay valid as a
75 # standalone (read-only) raw image without looking at qcow2
78 # @extended-l2: true if the image has extended L2 entries; only valid
81 # @lazy-refcounts: on or off; only valid for compat >= 1.1
86 # @refcount-bits: width of a refcount entry in bits (since 2.3)
93 # @compression-type: the image cluster compression method (since 5.1)
100 '*data-file': 'str',
101 '*data-file-raw': 'bool',
102 '*extended-l2': 'bool',
103 '*lazy-refcounts': 'bool',
105 'refcount-bits': 'int',
108 'compression-type': 'Qcow2CompressionType'
114 # @create-type: The create type of VMDK image
118 # @parent-cid: Parent VMDK image's cid
126 'create-type': 'str',
127 'cid': 'int',
128 'parent-cid': 'int',
141 # @virtual-size: Number of bytes covered by this extent
143 # @cluster-size: Cluster size in bytes (for non-flat extents)
153 'virtual-size': 'int',
154 '*cluster-size': 'int',
161 # @encryption-format: Image encryption format
167 '*encryption-format': 'RbdImageEncryptionFormat'
173 # @extent-size-hint: Extent size hint (if available)
179 '*extent-size-hint': 'size'
279 # @virtual-size: maximum capacity in bytes of the image
281 # @actual-size: actual size on disk in bytes of the image
283 # @dirty-flag: true if image is not cleanly closed
285 # @cluster-size: size of a cluster in bytes
291 # @backing-filename: name of the backing file
293 # @full-backing-filename: full path of the backing file
295 # @backing-filename-format: the format of the backing file
299 # @format-specific: structure supplying additional format-specific
305 'data': {'filename': 'str', 'format': 'str', '*dirty-flag': 'bool',
306 '*actual-size': 'int', 'virtual-size': 'int',
307 '*cluster-size': 'int', '*encrypted': 'bool', '*compressed': 'bool',
308 '*backing-filename': 'str', '*full-backing-filename': 'str',
309 '*backing-filename-format': 'str', '*snapshots': ['SnapshotInfo'],
310 '*format-specific': 'ImageInfoSpecific' } }
318 # @backing-image: info of the backing image
325 '*backing-image': 'ImageInfo'
372 # @check-errors: number of unexpected errors occurred during check
374 # @image-end-offset: offset (in bytes) where the image ends, this
381 # @corruptions-fixed: number of corruptions fixed during the check if
384 # @leaks-fixed: number of leaks fixed during the check if any
386 # @total-clusters: total number of clusters, this field is present if
389 # @allocated-clusters: total number of allocated clusters, this field
392 # @fragmented-clusters: total number of fragmented clusters, this
395 # @compressed-clusters: total number of compressed clusters, this
401 'data': {'filename': 'str', 'format': 'str', 'check-errors': 'int',
402 '*image-end-offset': 'int', '*corruptions': 'int', '*leaks': 'int',
403 '*corruptions-fixed': 'int', '*leaks-fixed': 'int',
404 '*total-clusters': 'int', '*allocated-clusters': 'int',
405 '*fragmented-clusters': 'int', '*compressed-clusters': 'int' } }
427 # file, ..., n - 1 = bottom image (where n is the number of images
442 'data': {'start': 'int', 'length': 'int', 'data': 'bool',
443 'zero': 'bool', 'compressed': 'bool', 'depth': 'int',
444 'present': 'bool', '*offset': 'int', '*filename': 'str' } }
455 # @no-flush: true if flush requests are ignored for the device
462 'no-flush': 'bool' } }
471 # @node-name: the name of the block driver node (Since 2.0)
473 # @ro: true if the backing device was open read-only
484 # @backing_file: the name of the backing file (for copy-on-write)
551 # @dirty-bitmaps: dirty bitmaps information (only present if node has
557 'data': { 'file': 'str', '*node-name': 'str', 'ro': 'bool', 'drv': 'str',
558 '*backing_file': 'str', 'backing_file_depth': 'int',
561 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
562 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
564 '*bps_max': 'int', '*bps_rd_max': 'int',
565 '*bps_wr_max': 'int', '*iops_max': 'int',
566 '*iops_rd_max': 'int', '*iops_wr_max': 'int',
567 '*bps_max_length': 'int', '*bps_rd_max_length': 'int',
568 '*bps_wr_max_length': 'int', '*iops_max_length': 'int',
569 '*iops_rd_max_length': 'int', '*iops_wr_max_length': 'int',
570 '*iops_size': 'int', '*group': 'str', 'cache': 'BlockdevCacheInfo',
571 'write_threshold': 'int', '*dirty-bitmaps': ['BlockDirtyInfo'] } }
582 # @nospace: The last I/O operation has failed due to a no-space
603 # @busy: true if the bitmap is in-use by some operation (NBD or jobs)
613 # it, use @block-dirty-bitmap-remove. (Since 4.0)
618 'data': {'*name': 'str', 'count': 'int', 'granularity': 'uint32',
627 # @in-use: This flag is set by any process actively modifying the
639 'data': ['in-use', 'auto'] }
678 # +------------------
708 # @io-status: @BlockDeviceIoStatus. Only present if the device
710 # (supported device models: virtio-blk, IDE, SCSI except
711 # scsi-generic)
721 '*tray_open': 'bool', '*io-status': 'BlockDeviceIoStatus' } }
741 # copying just allocated guest-visible contents.
743 # @fully-allocated: Image file size, in bytes, once data has been
744 # written to all sectors, when copying just guest-visible
747 # @bitmaps: Additional size required if all the top-level bitmap
755 'data': {'required': 'int', 'fully-allocated': 'int', '*bitmaps': 'int'} }
758 # @query-block:
767 # .. qmp-example::
769 # -> { "execute": "query-block" }
770 # <- {
773 # "io-status": "ok",
774 # "device":"ide0-hd0",
801 # "virtual-size":2048000,
803 # "full-backing-filename":"disks/base.qcow2",
804 # "backing-filename-format":"qcow2",
809 # "vm-state-size": 0,
810 # "date-sec": 10000200,
811 # "date-nsec": 12,
812 # "vm-clock-sec": 206,
813 # "vm-clock-nsec": 30
816 # "backing-image":{
819 # "virtual-size":2048000
827 # "io-status": "ok",
828 # "device":"ide1-cd0",
851 { 'command': 'query-block', 'returns': ['BlockInfo'],
852 'allow-preconfig': true }
910 'data': { 'interval_length': 'int', 'min_rd_latency_ns': 'int',
911 'max_rd_latency_ns': 'int', 'avg_rd_latency_ns': 'int',
912 'min_wr_latency_ns': 'int', 'max_wr_latency_ns': 'int',
913 'avg_wr_latency_ns': 'int', 'min_zone_append_latency_ns': 'int',
914 'max_zone_append_latency_ns': 'int',
915 'avg_zone_append_latency_ns': 'int',
916 'min_flush_latency_ns': 'int', 'max_flush_latency_ns': 'int',
917 'avg_flush_latency_ns': 'int', 'avg_rd_queue_depth': 'number',
1037 'data': {'rd_bytes': 'int', 'wr_bytes': 'int', 'zone_append_bytes': 'int',
1038 'unmap_bytes' : 'int', 'rd_operations': 'int',
1039 'wr_operations': 'int', 'zone_append_operations': 'int',
1040 'flush_operations': 'int', 'unmap_operations': 'int',
1041 'rd_total_time_ns': 'int', 'wr_total_time_ns': 'int',
1042 'zone_append_total_time_ns': 'int', 'flush_total_time_ns': 'int',
1043 'unmap_total_time_ns': 'int', 'wr_highest_offset': 'int',
1044 'rd_merged': 'int', 'wr_merged': 'int', 'zone_append_merged': 'int',
1045 'unmap_merged': 'int', '*idle_time_ns': 'int',
1046 'failed_rd_operations': 'int', 'failed_wr_operations': 'int',
1047 'failed_zone_append_operations': 'int',
1048 'failed_flush_operations': 'int',
1049 'failed_unmap_operations': 'int', 'invalid_rd_operations': 'int',
1050 'invalid_wr_operations': 'int',
1051 'invalid_zone_append_operations': 'int',
1052 'invalid_flush_operations': 'int', 'invalid_unmap_operations': 'int',
1065 # @discard-nb-ok: The number of successful discard operations
1068 # @discard-nb-failed: The number of failed discard operations
1071 # @discard-bytes-ok: The number of bytes discarded by the driver.
1077 'discard-nb-ok': 'uint64',
1078 'discard-nb-failed': 'uint64',
1079 'discard-bytes-ok': 'uint64' } }
1086 # @completion-errors: The number of completion errors.
1088 # @aligned-accesses: The number of aligned accesses performed by the
1091 # @unaligned-accesses: The number of unaligned accesses performed by
1098 'completion-errors': 'uint64',
1099 'aligned-accesses': 'uint64',
1100 'unaligned-accesses': 'uint64' } }
1128 # @node-name: The node name of the device. (Since 2.3)
1135 # @driver-specific: Optional driver-specific stats. (Since 4.2)
1148 'data': {'*device': 'str', '*qdev': 'str', '*node-name': 'str',
1150 '*driver-specific': 'BlockStatsSpecific',
1155 # @query-blockstats:
1159 # @query-nodes: If true, the command will query all the block nodes
1162 # behavior is as before - query all the device backends,
1171 # .. qmp-example::
1173 # -> { "execute": "query-blockstats" }
1174 # <- {
1177 # "device":"ide0-hd0",
1215 # "device":"ide1-cd0",
1273 { 'command': 'query-blockstats',
1274 'data': { '*query-nodes': 'bool' },
1276 'allow-preconfig': true }
1335 # @on-success: The bitmap is only synced when the operation is
1340 # treated solely as a read-only manifest of blocks to copy.
1348 'data': ['on-success', 'never', 'always'] }
1358 # @write-blocking: when data is written to the source, write it
1365 'data': ['background', 'write-blocking'] }
1372 # @actively-synced: Whether the source is actively synced to the
1379 'data': { 'actively-synced': 'bool' } }
1384 # Information about a long-running block device operation.
1407 # @io-status: the status of the job (since 1.3)
1413 # @auto-finalize: Job will finalize itself when PENDING, moving to the
1416 # @auto-dismiss: Job will dismiss itself when CONCLUDED, moving to the
1425 'base': {'type': 'JobType', 'device': 'str', 'len': 'int',
1426 'offset': 'int', 'busy': 'bool', 'paused': 'bool', 'speed': 'int',
1427 'io-status': 'BlockDeviceIoStatus', 'ready': 'bool',
1429 'auto-finalize': 'bool', 'auto-dismiss': 'bool',
1435 # @query-block-jobs:
1437 # Return information about long-running block device operations.
1443 { 'command': 'query-block-jobs', 'returns': ['BlockJobInfo'],
1444 'allow-preconfig': true }
1451 # Either @device or @node-name must be set but not both.
1455 # @node-name: graph node name to get the image resized (Since 2.0)
1460 # - If @device is not a valid block device, DeviceNotFound
1464 # .. qmp-example::
1466 # -> { "execute": "block_resize",
1468 # <- { "return": {} }
1472 '*node-name': 'str',
1473 'size': 'int' },
1475 'allow-preconfig': true }
1485 # @absolute-paths: QEMU should create a new image with absolute paths
1492 'data': [ 'existing', 'absolute-paths' ] }
1497 # Either @device or @node-name must be set but not both.
1501 # @node-name: graph node name to generate the snapshot from (Since
1504 # @snapshot-file: the target of the new overlay image. If the file
1508 # @snapshot-node-name: the graph node name of the new image (Since
1514 # 'absolute-paths'.
1517 'data': { '*device': 'str', '*node-name': 'str',
1518 'snapshot-file': 'str', '*snapshot-node-name': 'str',
1529 # "backing": null to blockdev-add).
1542 # @use-copy-range: Use copy offloading. Default false.
1544 # @max-workers: Maximum number of parallel requests for the sustained
1545 # background copying process. Doesn't influence copy-before-write
1548 # @max-chunk: Maximum request length for the sustained background
1549 # copying process. Doesn't influence copy-before-write
1550 # operations. 0 means unlimited. If max-chunk is non-zero then
1554 # @min-cluster-size: Minimum size of blocks used by copy-before-write
1562 'data': { '*use-copy-range': 'bool', '*max-workers': 'int',
1563 '*max-chunk': 'int64', '*min-cluster-size': 'size' } }
1568 # @job-id: identifier for the newly-created block job. If omitted,
1571 # @device: the device name or node-name of a root node which should be
1584 # (Since 2.4 (drive-backup), 3.1 (blockdev-backup))
1586 # @bitmap-mode: Specifies the type of data the bitmap should contain
1593 # @on-source-error: the action to take on an error on the source,
1595 # block device supports io-status (see BlockInfo).
1597 # @on-target-error: the action to take on an error on the target,
1601 # @auto-finalize: When false, this job will wait in a PENDING state
1602 # after it has finished its work, waiting for @block-job-finalize
1607 # @auto-dismiss: When false, this job will wait in a CONCLUDED state
1609 # @block-job-dismiss. When true, this job will automatically
1613 # @filter-node-name: the node name that should be assigned to the
1618 # @discard-source: Discard blocks on source which have already been
1621 # @x-perf: Performance options. (Since 6.0)
1625 # @unstable: Member @x-perf is experimental.
1627 # .. note:: @on-source-error and @on-target-error only affect
1634 'data': { '*job-id': 'str', 'device': 'str',
1635 'sync': 'MirrorSyncMode', '*speed': 'int',
1636 '*bitmap': 'str', '*bitmap-mode': 'BitmapSyncMode',
1638 '*on-source-error': 'BlockdevOnError',
1639 '*on-target-error': 'BlockdevOnError',
1640 '*auto-finalize': 'bool', '*auto-dismiss': 'bool',
1641 '*filter-node-name': 'str',
1642 '*discard-source': 'bool',
1643 '*x-perf': { 'type': 'BackupPerf',
1657 # 'absolute-paths'.
1670 # @target: the device name or node-name of the backup target node.
1679 # @blockdev-snapshot-sync:
1684 # - If @device is not a valid block device, DeviceNotFound
1688 # .. qmp-example::
1690 # -> { "execute": "blockdev-snapshot-sync",
1691 # "arguments": { "device": "ide-hd0",
1692 # "snapshot-file":
1693 # "/some/place/my-image",
1695 # <- { "return": {} }
1697 { 'command': 'blockdev-snapshot-sync',
1699 'allow-preconfig': true }
1702 # @blockdev-snapshot:
1713 # @allow-write-only-overlay: If present, the check whether this
1715 # backing file of a destination of a blockdev-mirror. (since 5.0)
1719 # .. qmp-example::
1721 # -> { "execute": "blockdev-add",
1723 # "node-name": "node1534",
1728 # <- { "return": {} }
1730 # -> { "execute": "blockdev-snapshot",
1731 # "arguments": { "node": "ide-hd0",
1733 # <- { "return": {} }
1735 { 'command': 'blockdev-snapshot',
1737 'features': [ 'allow-write-only-overlay' ],
1738 'allow-preconfig': true }
1741 # @change-backing-file:
1745 # (it may, however, perform a reopen to change permissions from r/o ->
1746 # r/w -> r/o, if needed). The new backing file string is written into
1749 # @image-node-name: The name of the block driver state node of the
1751 # "image-node-name" is in the chain described by "device".
1753 # @device: The device name or node-name of the root node that owns
1754 # image-node-name.
1756 # @backing-file: The string to write as the backing file. This string
1761 # - If "device" does not exist or cannot be determined,
1766 { 'command': 'change-backing-file',
1767 'data': { 'device': 'str', 'image-node-name': 'str',
1768 'backing-file': 'str' },
1769 'allow-preconfig': true }
1772 # @block-commit:
1774 # Live commit of data from overlay image nodes into backing nodes -
1780 # block-job-complete command after getting the ready event. (Since
1789 # @job-id: identifier for the newly-created block job. If omitted,
1792 # @device: the device name or node-name of a root node
1794 # @base-node: The node name of the backing image to write data into.
1798 # @base: Same as @base-node, except that it is a file name rather than
1803 # @top-node: The node name of the backing image within the image chain
1807 # @top: Same as @top-node, except that it is a file name rather than a
1812 # @backing-file: The backing file string to write into the overlay
1819 # QMP or HMP commands must use node-names for the image in
1827 # @backing-mask-protocol: If true, replace any protocol mentioned in
1834 # @on-error: the action to take on an error. 'ignore' means that the
1837 # @filter-node-name: the node name that should be assigned to the
1842 # @auto-finalize: When false, this job will wait in a PENDING state
1843 # after it has finished its work, waiting for @block-job-finalize
1848 # @auto-dismiss: When false, this job will wait in a CONCLUDED state
1850 # @block-job-dismiss. When true, this job will automatically
1856 # @deprecated: Members @base and @top are deprecated. Use @base-node
1857 # and @top-node instead.
1860 # - If @device does not exist, DeviceNotFound
1864 # .. qmp-example::
1866 # -> { "execute": "block-commit",
1869 # <- { "return": {} }
1871 { 'command': 'block-commit',
1872 'data': { '*job-id': 'str', 'device': 'str', '*base-node': 'str',
1874 '*top-node': 'str',
1876 '*backing-file': 'str', '*backing-mask-protocol': 'bool',
1877 '*speed': 'int',
1878 '*on-error': 'BlockdevOnError',
1879 '*filter-node-name': 'str',
1880 '*auto-finalize': 'bool', '*auto-dismiss': 'bool' },
1881 'allow-preconfig': true }
1884 # @drive-backup:
1886 # Start a point-in-time copy of a block device to a new destination.
1887 # The status of ongoing drive-backup operations can be checked with
1888 # query-block-jobs where the BlockJobInfo.type field has the value
1890 # using the block-job-cancel command.
1894 # @deprecated: This command is deprecated. Use @blockdev-backup
1898 # - If @device is not a valid block device, GenericError
1902 # .. qmp-example::
1904 # -> { "execute": "drive-backup",
1908 # <- { "return": {} }
1910 { 'command': 'drive-backup', 'boxed': true,
1912 'allow-preconfig': true }
1915 # @blockdev-backup:
1917 # Start a point-in-time copy of a block device to a new destination.
1918 # The status of ongoing blockdev-backup operations can be checked with
1919 # query-block-jobs where the BlockJobInfo.type field has the value
1921 # using the block-job-cancel command.
1924 # - If @device is not a valid block device, DeviceNotFound
1928 # .. qmp-example::
1930 # -> { "execute": "blockdev-backup",
1931 # "arguments": { "device": "src-id",
1933 # "target": "tgt-id" } }
1934 # <- { "return": {} }
1936 { 'command': 'blockdev-backup', 'boxed': true,
1938 'allow-preconfig': true }
1941 # @query-named-block-nodes:
1945 # @flat: Omit the nested data about backing image ("backing-image"
1952 # .. qmp-example::
1954 # -> { "execute": "query-named-block-nodes" }
1955 # <- { "return": [ { "ro":false,
1959 # "node-name": "my-node",
1979 # "virtual-size":2048000,
1981 # "full-backing-filename":"disks/base.qcow2",
1982 # "backing-filename-format":"qcow2",
1987 # "vm-state-size": 0,
1988 # "date-sec": 10000200,
1989 # "date-nsec": 12,
1990 # "vm-clock-sec": 206,
1991 # "vm-clock-nsec": 30
1994 # "backing-image":{
1997 # "virtual-size":2048000
2001 { 'command': 'query-named-block-nodes',
2004 'allow-preconfig': true }
2009 # @block-backend: corresponds to BlockBackend
2011 # @block-job: corresponds to BlockJob
2013 # @block-driver: corresponds to BlockDriverState
2018 'data': [ 'block-backend', 'block-job', 'block-driver' ] }
2024 # x-debug-query-block-graph and does not relate to any other
2027 # @type: Type of graph node. Can be one of block-backend, block-job
2028 # or block-driver-state.
2030 # @name: Human readable name of the node. Corresponds to node-name
2031 # for block-driver-state nodes; is not guaranteed to be unique in
2032 # the whole graph (with block-jobs and block-backends).
2044 # @consistent-read: A user that has the "permission" of consistent
2046 # device is complete and self-consistent, representing the
2055 # @write-unchanged: This permission (which is weaker than
2068 'data': [ 'consistent-read', 'write', 'write-unchanged', 'resize' ] }
2073 # Block Graph edge description for x-debug-query-block-graph.
2083 # @shared-perm: permissions that can still be granted to other users
2091 'shared-perm': [ 'BlockPermission' ] } }
2096 # Block Graph - list of nodes and list of edges.
2104 # @x-debug-query-block-graph:
2114 { 'command': 'x-debug-query-block-graph', 'returns': 'XDbgBlockGraph',
2116 'allow-preconfig': true }
2119 # @drive-mirror:
2129 # - If @device is not a valid block device, GenericError
2133 # .. qmp-example::
2135 # -> { "execute": "drive-mirror",
2136 # "arguments": { "device": "ide-hd0",
2137 # "target": "/some/place/my-image",
2140 # <- { "return": {} }
2142 { 'command': 'drive-mirror', 'boxed': true,
2144 'allow-preconfig': true }
2151 # @job-id: identifier for the newly-created block job. If omitted,
2154 # @device: the device name or node-name of a root node whose writes
2164 # @node-name: the new block driver state node name in the graph (Since
2169 # repair broken Quorum files. By default, @device is replaced,
2173 # 'absolute-paths'.
2186 # @buf-size: maximum amount of data in flight from source to target
2189 # @on-source-error: the action to take on an error on the source,
2191 # block device supports io-status (see BlockInfo).
2193 # @on-target-error: the action to take on an error on the target,
2203 # @copy-mode: when to copy data to the destination; defaults to
2206 # @auto-finalize: When false, this job will wait in a PENDING state
2207 # after it has finished its work, waiting for @block-job-finalize
2212 # @auto-dismiss: When false, this job will wait in a CONCLUDED state
2214 # @block-job-dismiss. When true, this job will automatically
2221 'data': { '*job-id': 'str', 'device': 'str', 'target': 'str',
2222 '*format': 'str', '*node-name': 'str', '*replaces': 'str',
2224 '*speed': 'int', '*granularity': 'uint32',
2225 '*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
2226 '*on-target-error': 'BlockdevOnError',
2227 '*unmap': 'bool', '*copy-mode': 'MirrorCopyMode',
2228 '*auto-finalize': 'bool', '*auto-dismiss': 'bool' } }
2250 # block-dirty-bitmap-add
2255 # for block-dirty-bitmap-add. (Since: 2.10)
2259 # with block-dirty-bitmap-enable. Default is false. (Since: 4.0)
2299 # @block-dirty-bitmap-add:
2305 # - If @node is not a valid block device or node, DeviceNotFound
2306 # - If @name is already taken, GenericError
2310 # .. qmp-example::
2312 # -> { "execute": "block-dirty-bitmap-add",
2314 # <- { "return": {} }
2316 { 'command': 'block-dirty-bitmap-add',
2318 'allow-preconfig': true }
2321 # @block-dirty-bitmap-remove:
2324 # with block-dirty-bitmap-add. If the bitmap is persistent, remove it
2328 # - If @node is not a valid block device or node, DeviceNotFound
2329 # - If @name is not found, GenericError
2330 # - if @name is frozen by an operation, GenericError
2334 # .. qmp-example::
2336 # -> { "execute": "block-dirty-bitmap-remove",
2338 # <- { "return": {} }
2340 { 'command': 'block-dirty-bitmap-remove',
2342 'allow-preconfig': true }
2345 # @block-dirty-bitmap-clear:
2352 # - If @node is not a valid block device, DeviceNotFound
2353 # - If @name is not found, GenericError
2357 # .. qmp-example::
2359 # -> { "execute": "block-dirty-bitmap-clear",
2361 # <- { "return": {} }
2363 { 'command': 'block-dirty-bitmap-clear',
2365 'allow-preconfig': true }
2368 # @block-dirty-bitmap-enable:
2373 # - If @node is not a valid block device, DeviceNotFound
2374 # - If @name is not found, GenericError
2378 # .. qmp-example::
2380 # -> { "execute": "block-dirty-bitmap-enable",
2382 # <- { "return": {} }
2384 { 'command': 'block-dirty-bitmap-enable',
2386 'allow-preconfig': true }
2389 # @block-dirty-bitmap-disable:
2394 # - If @node is not a valid block device, DeviceNotFound
2395 # - If @name is not found, GenericError
2399 # .. qmp-example::
2401 # -> { "execute": "block-dirty-bitmap-disable",
2403 # <- { "return": {} }
2405 { 'command': 'block-dirty-bitmap-disable',
2407 'allow-preconfig': true }
2410 # @block-dirty-bitmap-merge:
2423 # - If @node is not a valid block device, DeviceNotFound
2424 # - If any bitmap in @bitmaps or @target is not found,
2426 # - If any of the bitmaps have different sizes or granularities,
2431 # .. qmp-example::
2433 # -> { "execute": "block-dirty-bitmap-merge",
2436 # <- { "return": {} }
2438 { 'command': 'block-dirty-bitmap-merge',
2440 'allow-preconfig': true }
2455 # @x-debug-block-dirty-bitmap-sha256:
2467 # - If @node is not a valid block device, DeviceNotFound
2468 # - If @name is not found or if hashing has failed, GenericError
2472 { 'command': 'x-debug-block-dirty-bitmap-sha256',
2475 'allow-preconfig': true }
2478 # @blockdev-mirror:
2482 # @job-id: identifier for the newly-created block job. If omitted,
2485 # @device: The device name or node-name of a root node whose writes
2488 # @target: the id or node-name of the block device to mirror to. This
2493 # repair broken Quorum files. By default, @device is replaced,
2507 # @buf-size: maximum amount of data in flight from source to target
2509 # @on-source-error: the action to take on an error on the source,
2511 # block device supports io-status (see BlockInfo).
2513 # @on-target-error: the action to take on an error on the target,
2517 # @filter-node-name: the node name that should be assigned to the
2522 # @copy-mode: when to copy data to the destination; defaults to
2525 # @auto-finalize: When false, this job will wait in a PENDING state
2526 # after it has finished its work, waiting for @block-job-finalize
2531 # @auto-dismiss: When false, this job will wait in a CONCLUDED state
2533 # @block-job-dismiss. When true, this job will automatically
2539 # .. qmp-example::
2541 # -> { "execute": "blockdev-mirror",
2542 # "arguments": { "device": "ide-hd0",
2545 # <- { "return": {} }
2547 { 'command': 'blockdev-mirror',
2548 'data': { '*job-id': 'str', 'device': 'str', 'target': 'str',
2551 '*speed': 'int', '*granularity': 'uint32',
2552 '*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
2553 '*on-target-error': 'BlockdevOnError',
2554 '*filter-node-name': 'str',
2555 '*copy-mode': 'MirrorCopyMode',
2556 '*auto-finalize': 'bool', '*auto-dismiss': 'bool' },
2557 'allow-preconfig': true }
2633 '*id': 'str', 'bps': 'int', 'bps_rd': 'int',
2634 'bps_wr': 'int', 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
2635 '*bps_max': 'int', '*bps_rd_max': 'int',
2636 '*bps_wr_max': 'int', '*iops_max': 'int',
2637 '*iops_rd_max': 'int', '*iops_wr_max': 'int',
2638 '*bps_max_length': 'int', '*bps_rd_max_length': 'int',
2639 '*bps_wr_max_length': 'int', '*iops_max_length': 'int',
2640 '*iops_rd_max_length': 'int', '*iops_wr_max_length': 'int',
2641 '*iops_size': 'int', '*group': 'str' } }
2651 # @iops-total: limit total I/O operations per second
2653 # @iops-total-max: I/O operations burst
2655 # @iops-total-max-length: length of the iops-total-max burst period,
2656 # in seconds It must only be set if @iops-total-max is set as
2659 # @iops-read: limit read operations per second
2661 # @iops-read-max: I/O operations read burst
2663 # @iops-read-max-length: length of the iops-read-max burst period, in
2664 # seconds It must only be set if @iops-read-max is set as well.
2666 # @iops-write: limit write operations per second
2668 # @iops-write-max: I/O operations write burst
2670 # @iops-write-max-length: length of the iops-write-max burst period,
2671 # in seconds It must only be set if @iops-write-max is set as
2674 # @bps-total: limit total bytes per second
2676 # @bps-total-max: total bytes burst
2678 # @bps-total-max-length: length of the bps-total-max burst period, in
2679 # seconds. It must only be set if @bps-total-max is set as well.
2681 # @bps-read: limit read bytes per second
2683 # @bps-read-max: total bytes read burst
2685 # @bps-read-max-length: length of the bps-read-max burst period, in
2686 # seconds It must only be set if @bps-read-max is set as well.
2688 # @bps-write: limit write bytes per second
2690 # @bps-write-max: total bytes write burst
2692 # @bps-write-max-length: length of the bps-write-max burst period, in
2693 # seconds It must only be set if @bps-write-max is set as well.
2695 # @iops-size: when limiting by iops max size of an I/O in bytes
2700 'data': { '*iops-total' : 'int', '*iops-total-max' : 'int',
2701 '*iops-total-max-length' : 'int', '*iops-read' : 'int',
2702 '*iops-read-max' : 'int', '*iops-read-max-length' : 'int',
2703 '*iops-write' : 'int', '*iops-write-max' : 'int',
2704 '*iops-write-max-length' : 'int', '*bps-total' : 'int',
2705 '*bps-total-max' : 'int', '*bps-total-max-length' : 'int',
2706 '*bps-read' : 'int', '*bps-read-max' : 'int',
2707 '*bps-read-max-length' : 'int', '*bps-write' : 'int',
2708 '*bps-write-max' : 'int', '*bps-write-max-length' : 'int',
2709 '*iops-size' : 'int' } }
2714 # Properties for throttle-group objects.
2720 # @unstable: All members starting with x- are aliases for the same key
2721 # without x- in the @limits object. This is not a stable
2723 # future. Use @limits for a supported stable interface.
2729 '*x-iops-total': { 'type': 'int',
2731 '*x-iops-total-max': { 'type': 'int',
2733 '*x-iops-total-max-length': { 'type': 'int',
2735 '*x-iops-read': { 'type': 'int',
2737 '*x-iops-read-max': { 'type': 'int',
2739 '*x-iops-read-max-length': { 'type': 'int',
2741 '*x-iops-write': { 'type': 'int',
2743 '*x-iops-write-max': { 'type': 'int',
2745 '*x-iops-write-max-length': { 'type': 'int',
2747 '*x-bps-total': { 'type': 'int',
2749 '*x-bps-total-max': { 'type': 'int',
2751 '*x-bps-total-max-length': { 'type': 'int',
2753 '*x-bps-read': { 'type': 'int',
2755 '*x-bps-read-max': { 'type': 'int',
2757 '*x-bps-read-max-length': { 'type': 'int',
2759 '*x-bps-write': { 'type': 'int',
2761 '*x-bps-write-max': { 'type': 'int',
2763 '*x-bps-write-max-length': { 'type': 'int',
2765 '*x-iops-size': { 'type': 'int',
2769 # @block-stream:
2776 # streaming operations can be checked with query-block-jobs. The
2778 # block-job-cancel command.
2784 # node; presence of the 'base-node' parameter during introspection can
2799 # In case @device is a filter node, block-stream modifies the first
2800 # non-filter overlay node below it to point to the new backing node
2803 # @job-id: identifier for the newly-created block job. If omitted,
2808 # @base: the common backing file name. It cannot be set if @base-node
2811 # @base-node: the node name of the backing file. It cannot be set if
2815 # top. It cannot be set if @base or @base-node is also set. It
2818 # @backing-file: The backing file string to write into the top image.
2823 # node-names for the image in question, as filename lookup methods
2831 # @backing-mask-protocol: If true, replace any protocol mentioned in
2838 # @on-error: the action to take on an error (default report). 'stop'
2840 # io-status (see BlockInfo). (Since 1.3)
2842 # @filter-node-name: the node name that should be assigned to the
2847 # @auto-finalize: When false, this job will wait in a PENDING state
2848 # after it has finished its work, waiting for @block-job-finalize
2853 # @auto-dismiss: When false, this job will wait in a CONCLUDED state
2855 # @block-job-dismiss. When true, this job will automatically
2860 # - If @device does not exist, DeviceNotFound.
2864 # .. qmp-example::
2866 # -> { "execute": "block-stream",
2869 # <- { "return": {} }
2871 { 'command': 'block-stream',
2872 'data': { '*job-id': 'str', 'device': 'str', '*base': 'str',
2873 '*base-node': 'str', '*backing-file': 'str',
2874 '*backing-mask-protocol': 'bool',
2876 '*speed': 'int', '*on-error': 'BlockdevOnError',
2877 '*filter-node-name': 'str',
2878 '*auto-finalize': 'bool', '*auto-dismiss': 'bool' },
2879 'allow-preconfig': true }
2882 # @block-job-set-speed:
2898 # - If no background operation is active on this device,
2903 { 'command': 'block-job-set-speed',
2904 'data': { 'device': 'str', 'speed': 'int' },
2905 'allow-preconfig': true }
2908 # @block-job-cancel:
2918 # visible when enumerated using query-block-jobs.
2920 # Note that if you issue 'block-job-cancel' after 'drive-mirror' has
2924 # mirroring has ended and the destination now has a point-in-time copy
2942 # - If no background operation is active on this device,
2947 { 'command': 'block-job-cancel', 'data': { 'device': 'str', '*force': 'bool' },
2948 'allow-preconfig': true }
2951 # @block-job-pause:
2968 # - If no background operation is active on this device,
2973 { 'command': 'block-job-pause', 'data': { 'device': 'str' },
2974 'allow-preconfig': true }
2977 # @block-job-resume:
2992 # - If no background operation is active on this device,
2997 { 'command': 'block-job-resume', 'data': { 'device': 'str' },
2998 'allow-preconfig': true }
3001 # @block-job-complete:
3023 # - If no background operation is active on this device,
3028 { 'command': 'block-job-complete', 'data': { 'device': 'str' },
3029 'allow-preconfig': true }
3032 # @block-job-dismiss:
3035 # block-job-query list. This command only needs to be run for jobs
3041 # make use of the BLOCK_JOB_READY event, block-job-cancel or
3042 # block-job-complete will still need to be used as appropriate.
3048 { 'command': 'block-job-dismiss', 'data': { 'id': 'str' },
3049 'allow-preconfig': true }
3052 # @block-job-finalize:
3065 { 'command': 'block-job-finalize', 'data': { 'id': 'str' },
3066 'allow-preconfig': true }
3071 # @copy-mode: Switch to this copy mode. Currently, only the switch
3072 # from 'background' to 'write-blocking' is implemented.
3077 'data': { 'copy-mode' : 'MirrorCopyMode' } }
3096 # @block-job-change:
3102 { 'command': 'block-job-change',
3159 # Includes cache-related options for block devices
3164 # @no-flush: ignore any flush requests for the device (default: false)
3170 '*no-flush': 'bool' } }
3181 # @copy-on-read: Since 3.0
3189 # @copy-before-write: Since 6.2
3191 # @snapshot-access: Since 7.0
3202 'cloop', 'compress', 'copy-before-write', 'copy-on-read', 'dmg',
3203 'file', 'snapshot-access', 'ftp', 'ftps',
3210 'luks', 'nbd', 'nfs', 'null-aio', 'null-co', 'nvme',
3211 { 'name': 'nvme-io_uring', 'if': 'CONFIG_BLKIO' },
3216 { 'name': 'virtio-blk-vfio-pci', 'if': 'CONFIG_BLKIO' },
3217 { 'name': 'virtio-blk-vhost-user', 'if': 'CONFIG_BLKIO' },
3218 { 'name': 'virtio-blk-vhost-vdpa', 'if': 'CONFIG_BLKIO' },
3228 # @pr-manager: the id for the object that will handle persistent
3234 # @aio-max-batch: maximum number of requests to batch together into a
3236 # between this and the aio-max-batch value of the IOThread object
3244 # @drop-cache: invalidate page cache during live migration. This
3249 # @x-check-cache-dropped: whether to check that page cache was dropped
3256 # @dynamic-auto-read-only: If present, enabled auto-read-only means
3257 # that the driver will open the image read-only at first,
3258 # dynamically reopen the image file read-write when the first
3259 # writer is attached to the node and reopen read-only when the
3264 # @unstable: Member x-check-cache-dropped is meant for debugging.
3270 '*pr-manager': 'str',
3273 '*aio-max-batch': 'int',
3274 '*drop-cache': {'type': 'bool',
3276 '*x-check-cache-dropped': { 'type': 'bool',
3278 'features': [ { 'name': 'dynamic-auto-read-only',
3288 # @latency-ns: emulated latency (in nanoseconds) in processing
3292 # @read-zeroes: if true, reads from the device produce zeroes; if
3299 'data': { '*size': 'int', '*latency-ns': 'uint64', '*read-zeroes': 'bool' } }
3317 'data': { 'device': 'str', 'namespace': 'int' } }
3326 # @fat-type: FAT type: 12, 16 or 32
3341 'data': { 'dir': 'str', '*fat-type': 'int', '*floppy': 'bool',
3362 # @key-secret: the ID of a QCryptoSecret object providing the
3364 # metadata-only probe of the image.
3372 'data': { '*key-secret': 'str',
3423 # @main-header: Qcow2 format header
3425 # @active-l1: Qcow2 active L1 table
3427 # @active-l2: Qcow2 active L2 table
3429 # @refcount-table: Qcow2 refcount table
3431 # @refcount-block: Qcow2 refcount blocks
3433 # @snapshot-table: Qcow2 snapshot table
3435 # @inactive-l1: Qcow2 inactive L1 tables
3437 # @inactive-l2: Qcow2 inactive L2 tables
3439 # @bitmap-directory: Qcow2 bitmap directory (since 3.0)
3445 '*main-header': 'bool',
3446 '*active-l1': 'bool',
3447 '*active-l2': 'bool',
3448 '*refcount-table': 'bool',
3449 '*refcount-block': 'bool',
3450 '*snapshot-table': 'bool',
3451 '*inactive-l1': 'bool',
3452 '*inactive-l2': 'bool',
3453 '*bitmap-directory': 'bool' } }
3475 # @aes: AES-CBC with plain64 initialization vectors
3500 # except when doing a metadata-only probe of the image.
3511 # @aes: AES-CBC with plain64 initialization vectors
3537 # @prealloc-align: on preallocation, align file length to this number,
3540 # @prealloc-size: how much to preallocate, default 134217728 (128M)
3546 'data': { '*prealloc-align': 'int', '*prealloc-size': 'int' } }
3553 # @lazy-refcounts: whether to enable the lazy refcounts feature
3556 # @pass-discard-request: whether discard requests to the qcow2 device
3559 # @pass-discard-snapshot: whether discard requests for the data source
3563 # @pass-discard-other: whether discard requests for the data source
3566 # @discard-no-unref: when enabled, data clusters will remain
3570 # image file) depends on the setting of the pass-discard-request
3573 # re-allocating them later. Besides potential performance
3581 # @overlap-check: which overlap checks to perform for writes to the
3584 # @cache-size: the maximum total size of the L2 table and refcount
3587 # @l2-cache-size: the maximum size of the L2 table cache in bytes
3590 # @l2-cache-entry-size: the size of each entry in the L2 cache in
3594 # @refcount-cache-size: the maximum size of the refcount block cache
3597 # @cache-clean-interval: clean unused entries in the L2 and refcount
3603 # except when doing a metadata-only probe of the image. (since
3606 # @data-file: reference to or definition of the external data file.
3615 'data': { '*lazy-refcounts': 'bool',
3616 '*pass-discard-request': 'bool',
3617 '*pass-discard-snapshot': 'bool',
3618 '*pass-discard-other': 'bool',
3619 '*discard-no-unref': 'bool',
3620 '*overlap-check': 'Qcow2OverlapChecks',
3621 '*cache-size': 'int',
3622 '*l2-cache-size': 'int',
3623 '*l2-cache-entry-size': 'int',
3624 '*refcount-cache-size': 'int',
3625 '*cache-clean-interval': 'int',
3627 '*data-file': 'BlockdevRef' } }
3691 # @host-key-check: Defines how and what to check the host key against
3700 '*host-key-check': 'SshHostKeyCheck' } }
3712 # @cor_write: a write due to copy-on-read (since 2.11)
3748 # @write-zeroes: .bdrv_co_pwrite_zeroes()
3754 # @block-status: .bdrv_co_block_status()
3759 'data': [ 'read', 'write', 'write-zeroes', 'discard', 'flush',
3760 'block-status' ] }
3773 # injected; defaults to "all read, write, write-zeroes, discard,
3790 '*state': 'int',
3792 '*errno': 'int',
3793 '*sector': 'int',
3800 # Describes a single state-change event for blkdebug.
3814 '*state': 'int',
3815 'new_state': 'int' } }
3829 # @max-transfer: maximum size for I/O transfers in bytes, must be
3834 # @opt-write-zero: preferred alignment for write zero requests in
3839 # @max-write-zero: maximum size for write zero requests in bytes, must
3840 # be positive multiple of @align, of @opt-write-zero, and of the
3844 # @opt-discard: preferred alignment for discard requests in bytes,
3849 # @max-discard: maximum size for discard requests in bytes, must be
3850 # positive multiple of @align, of @opt-discard, and of the
3854 # @inject-error: array of error injection descriptions
3856 # @set-state: array of state-change descriptions
3858 # @take-child-perms: Permissions to take on @image in addition to what
3862 # @unshare-child-perms: Permissions not to share on @image in addition
3871 '*align': 'int', '*max-transfer': 'int32',
3872 '*opt-write-zero': 'int32', '*max-write-zero': 'int32',
3873 '*opt-discard': 'int32', '*max-discard': 'int32',
3874 '*inject-error': ['BlkdebugInjectErrorOptions'],
3875 '*set-state': ['BlkdebugSetStateOptions'],
3876 '*take-child-perms': ['BlockPermission'],
3877 '*unshare-child-perms': ['BlockPermission'] } }
3888 # @log-sector-size: sector size used in logging writes to @file,
3892 # @log-append: append to an existing log (default: false)
3894 # @log-super-update-interval: interval of write requests after which
3902 '*log-sector-size': 'uint32',
3903 '*log-append': 'bool',
3904 '*log-super-update-interval': 'uint64' } }
3956 # @vote-threshold: the vote limit under which a read will fail
3958 # @rewrite-corrupted: rewrite corrupted data when quorum is reached
3961 # @read-pattern: choose read pattern and set to quorum by default
3969 'vote-threshold': 'int',
3970 '*rewrite-corrupted': 'bool',
3971 '*read-pattern': 'QuorumReadPattern' } }
3994 '*debug': 'int',
4013 # Driver specific block device options for the nvme-io_uring backend.
4027 # Driver specific block device options for the virtio-blk-vfio-pci
4042 # Driver specific block device options for the virtio-blk-vhost-user
4045 # @path: path to the vhost-user UNIX domain socket.
4056 # Driver specific block device options for the virtio-blk-vhost-vdpa
4059 # @path: path to the vhost-vdpa character device.
4093 'data': [ 'crc32c', 'none', 'crc32c-none', 'none-crc32c' ] }
4111 # @password-secret: The ID of a QCryptoSecret object providing the
4115 # @initiator-name: The iqn name we want to identify to the target as.
4119 # @header-digest: The desired header digest. Defaults to none-crc32c.
4130 '*lun': 'int',
4132 '*password-secret': 'str',
4133 '*initiator-name': 'str',
4134 '*header-digest': 'IscsiHeaderDigest',
4135 '*timeout': 'int' } }
4148 # @luks-any: Used for opening either luks or luks2 (Since 8.0)
4153 'data': [ 'luks', 'luks2', 'luks-any' ] }
4158 # @key-secret: ID of a QCryptoSecret object providing a passphrase for
4164 'data': { 'key-secret': 'str' } }
4169 # @cipher-alg: The encryption algorithm
4175 'data': { '*cipher-alg': 'QCryptoCipherAlgo' } }
4240 'luks-any': 'RbdEncryptionOptionsLUKSAny'} }
4273 # @auth-client-required: Acceptable authentication modes. This maps
4277 # @key-secret: ID of a QCryptoSecret object providing a key for cephx
4294 '*auth-client-required': ['RbdAuthMode'],
4295 '*key-secret': 'str',
4321 # @top-id: In secondary mode, node name or device ID of the root node
4330 '*top-id': 'str' },
4375 # @tcp-syn-count: number of SYNs during the session establishment
4378 # @readahead-size: set the readahead size in bytes (defaults to libnfs
4381 # @page-cache-size: set the pagecache size in bytes (defaults to
4391 '*user': 'int',
4392 '*group': 'int',
4393 '*tcp-syn-count': 'int',
4394 '*readahead-size': 'int',
4395 '*page-cache-size': 'int',
4396 '*debug': 'int' } }
4406 # @readahead: Size of the read-ahead cache; must be a multiple of 512
4413 # @password-secret: ID of a QCryptoSecret object providing a password
4416 # @proxy-username: Username for proxy authentication (defaults to
4419 # @proxy-password-secret: ID of a QCryptoSecret object providing a
4426 '*readahead': 'int',
4427 '*timeout': 'int',
4429 '*password-secret': 'str',
4430 '*proxy-username': 'str',
4431 '*proxy-password-secret': 'str' } }
4443 # @cookie-secret: ID of a QCryptoSecret object providing the cookie
4451 '*cookie-secret': 'str'} }
4466 # @cookie-secret: ID of a QCryptoSecret object providing the cookie
4475 '*cookie-secret': 'str'} }
4513 # @tls-creds: TLS credentials ID
4515 # @tls-hostname: TLS hostname override for certificate validation
4518 # @x-dirty-bitmap: A metadata context name such as
4519 # "qemu:dirty-bitmap:NAME" or "qemu:allocation-depth" to query in
4522 # this option x-context would have made more sense) (since 3.0)
4524 # @reconnect-delay: On an unexpected disconnect, the nbd client tries
4526 # error. During the first @reconnect-delay seconds, all requests
4532 # @open-timeout: In seconds. If zero, the nbd driver tries the
4534 # If non-zero, the nbd driver will repeat connection attempts
4535 # until successful or until @open-timeout seconds have elapsed.
4540 # @unstable: Member @x-dirty-bitmap is experimental.
4547 '*tls-creds': 'str',
4548 '*tls-hostname': 'str',
4549 '*x-dirty-bitmap': { 'type': 'str', 'features': [ 'unstable' ] },
4550 '*reconnect-delay': 'uint32',
4551 '*open-timeout': 'uint32' } }
4566 'data': { '*offset': 'int', '*size': 'int' } }
4573 # @throttle-group: the name of the throttle-group object to use. It
4581 'data': { 'throttle-group': 'str',
4588 # Driver specific block device options for the copy-on-read driver.
4590 # @bottom: The name of a non-filter node (allocation-bearing layer)
4605 # An enumeration of possible behaviors for copy-before-write operation
4608 # @break-guest-write: report the error to the guest. This way, the
4612 # @break-snapshot: continue guest write. Doing so will make the
4619 'data': [ 'break-guest-write', 'break-snapshot' ] }
4624 # Driver specific block device options for the copy-before-write
4625 # driver, which does so called copy-before-write operations: when data
4632 # @target: The target for copy-before-write operations.
4634 # @bitmap: If specified, copy-before-write filter will do
4635 # copy-before-write operations only for dirty regions of the
4642 # @on-cbw-error: Behavior on failure of copy-before-write operation.
4643 # Default is @break-guest-write. (Since 7.1)
4645 # @cbw-timeout: Zero means no limit. Non-zero sets the timeout in
4646 # seconds for copy-before-write operation. When a timeout occurs,
4647 # the respective copy-before-write operation will fail, and the
4648 # @on-cbw-error parameter will decide how this failure is handled.
4651 # @min-cluster-size: Minimum size of blocks used by copy-before-write
4661 '*on-cbw-error': 'OnCbwError', '*cbw-timeout': 'uint32',
4662 '*min-cluster-size': 'size' } }
4672 # @node-name: the node name of the new node (Since 2.0). This option
4673 # is required on the top level of blockdev-add. Valid node names
4675 # alphanumeric characters, '-', '.' and '_'. Their maximum length
4678 # @discard: discard-related options (default: ignore)
4680 # @cache: cache-related options
4682 # @read-only: whether the block device should be read-only (default:
4683 # false). Note that some block drivers support only read-only
4688 # @auto-read-only: if true and @read-only is false, QEMU may
4689 # automatically decide not to open the image read-write as
4690 # requested, but fall back to read-only instead (and switch
4695 # @detect-zeroes: detect and optimize zero writes (Since 2.1)
4698 # @force-share: force share all permission on added nodes. Requires
4699 # read-only=true. (Since 2.10)
4705 '*node-name': 'str',
4708 '*read-only': 'bool',
4709 '*auto-read-only': 'bool',
4710 '*force-share': 'bool',
4711 '*detect-zeroes': 'BlockdevDetectZeroesOptions' },
4721 'copy-before-write':'BlockdevOptionsCbw',
4722 'copy-on-read':'BlockdevOptionsCor',
4740 'null-aio': 'BlockdevOptionsNull',
4741 'null-co': 'BlockdevOptionsNull',
4743 'nvme-io_uring': { 'type': 'BlockdevOptionsNvmeIoUring',
4755 'snapshot-access': 'BlockdevOptionsGenericFormat',
4760 'virtio-blk-vfio-pci':
4763 'virtio-blk-vhost-user':
4766 'virtio-blk-vhost-vdpa':
4810 # @blockdev-add:
4816 # .. qmp-example::
4818 # -> { "execute": "blockdev-add",
4821 # "node-name": "test1",
4828 # <- { "return": {} }
4830 # .. qmp-example::
4832 # -> { "execute": "blockdev-add",
4835 # "node-name": "node0",
4854 # <- { "return": {} }
4856 { 'command': 'blockdev-add', 'data': 'BlockdevOptions', 'boxed': true,
4857 'allow-preconfig': true }
4860 # @blockdev-reopen:
4871 # one of them, the top-level @node-name option (from BlockdevOptions)
4873 # reopened. Other @node-name options must be either omitted or set to
4894 # Unlike with blockdev-add, the @backing option must always be present
4901 { 'command': 'blockdev-reopen',
4903 'allow-preconfig': true }
4906 # @blockdev-del:
4908 # Deletes a block device that has been added using blockdev-add. The
4912 # @node-name: Name of the graph node to delete.
4916 # .. qmp-example::
4918 # -> { "execute": "blockdev-add",
4921 # "node-name": "node0",
4928 # <- { "return": {} }
4930 # -> { "execute": "blockdev-del",
4931 # "arguments": { "node-name": "node0" }
4933 # <- { "return": {} }
4935 { 'command': 'blockdev-del', 'data': { 'node-name': 'str' },
4936 'allow-preconfig': true }
4951 # @nocow: Turn off copy-on-write (valid only on btrfs; default: off)
4953 # @extent-size-hint: Extent size hint to add to the image file; 0 for
4963 '*extent-size-hint': 'size'} }
5033 # @cluster-size: Cluster size in bytes (default: 1 MB)
5040 '*cluster-size': 'size' } }
5051 # @backing-file: File name of the backing file if a backing file
5061 '*backing-file': 'str',
5098 # @data-file: Node to use as an external data file in which all guest
5102 # @data-file-raw: True if the external data file must stay valid as a
5103 # standalone (read-only) raw image without looking at qcow2
5106 # @extended-l2: True to make the image have extended L2 entries
5113 # @backing-file: File name of the backing file if a backing file
5116 # @backing-fmt: Name of the block driver to use for the backing file
5120 # @cluster-size: qcow2 cluster size in bytes (default: 65536)
5125 # @lazy-refcounts: True if refcounts may be updated lazily
5128 # @refcount-bits: Width of reference counts in bits (default: 16)
5130 # @compression-type: The image cluster compression method
5137 '*data-file': 'BlockdevRef',
5138 '*data-file-raw': 'bool',
5139 '*extended-l2': 'bool',
5142 '*backing-file': 'str',
5143 '*backing-fmt': 'BlockdevDriver',
5145 '*cluster-size': 'size',
5147 '*lazy-refcounts': 'bool',
5148 '*refcount-bits': 'int',
5149 '*compression-type':'Qcow2CompressionType' } }
5160 # @backing-file: File name of the backing file if a backing file
5163 # @backing-fmt: Name of the block driver to use for the backing file
5165 # @cluster-size: Cluster size in bytes (default: 65536)
5167 # @table-size: L1/L2 table size (in clusters)
5174 '*backing-file': 'str',
5175 '*backing-fmt': 'BlockdevDriver',
5176 '*cluster-size': 'size',
5177 '*table-size': 'int' } }
5189 # @cluster-size: RBD object size
5198 '*cluster-size' : 'size',
5256 # @backing-file: The path of backing file. Default: no backing file
5259 # @adapter-type: The adapter type used to fill in the descriptor.
5268 # @zeroed-grain: Whether to enable zeroed-grain feature for sparse
5278 '*backing-file': 'str',
5279 '*adapter-type': 'BlockdevVmdkAdapterType',
5282 '*zeroed-grain': 'bool' } }
5323 # @fixed: Preallocated fixed-size image file
5339 # @log-size: Log size in bytes, must be a multiple of 1 MB (default: 1
5342 # @block-size: Block size in bytes, must be a multiple of 1 MB and not
5348 # @block-state-zero: Force use of payload blocks of type 'ZERO'.
5349 # Non-standard, but default. Do not set to 'off' when using
5350 # 'qemu-img convert' with subformat=dynamic.
5357 '*log-size': 'size',
5358 '*block-size': 'size',
5360 '*block-state-zero': 'bool' } }
5367 # @fixed: Preallocated fixed-size image file
5385 # @force-size: Force use of the exact byte size instead of rounding to
5395 '*force-size': 'bool' } }
5428 # @blockdev-create:
5431 # automatically finalized, but a manual job-dismiss is required.
5433 # @job-id: Identifier for the newly created job.
5439 { 'command': 'blockdev-create',
5440 'data': { 'job-id': 'str',
5442 'allow-preconfig': true }
5487 # @x-blockdev-amend:
5491 # job-dismiss is required.
5493 # @job-id: Identifier for the newly created job.
5495 # @node-name: Name of the block node to work on
5510 { 'command': 'x-blockdev-amend',
5511 'data': { 'job-id': 'str',
5512 'node-name': 'str',
5516 'allow-preconfig': true }
5546 # @node-name: node name (Since: 2.4)
5550 # as it is not guaranteed to be stable
5565 # .. qmp-example::
5567 # <- { "event": "BLOCK_IMAGE_CORRUPTED",
5568 # "data": { "device": "", "node-name": "drive", "fatal": false,
5576 '*node-name' : 'str',
5578 '*offset' : 'int',
5579 '*size' : 'int',
5587 # @qom-path: path to the device object in the QOM tree (since 9.2)
5593 # @node-name: node name. Note that errors may be reported for the
5602 # @nospace: true if I/O error was caused due to a no-space condition.
5603 # This key is only present if query-block's io-status is present,
5604 # please see query-block documentation for more information
5614 # .. note:: This event is rate-limited.
5618 # .. qmp-example::
5620 # <- { "event": "BLOCK_IO_ERROR",
5621 # "data": { "qom-path": "/machine/unattached/device[0]",
5622 # "device": "ide0-hd1",
5623 # "node-name": "#block212",
5630 'data': { 'qom-path': 'str', 'device': 'str', '*node-name': 'str',
5653 # contains a human-readable error message. There are no semantics
5659 # .. qmp-example::
5661 # <- { "event": "BLOCK_JOB_COMPLETED",
5662 # "data": { "type": "stream", "device": "virtio-disk0",
5670 'len' : 'int',
5671 'offset': 'int',
5672 'speed' : 'int',
5694 # .. qmp-example::
5696 # <- { "event": "BLOCK_JOB_CANCELLED",
5697 # "data": { "type": "stream", "device": "virtio-disk0",
5705 'len' : 'int',
5706 'offset': 'int',
5707 'speed' : 'int' } }
5723 # .. qmp-example::
5725 # <- { "event": "BLOCK_JOB_ERROR",
5726 # "data": { "device": "ide0-hd1",
5758 # .. qmp-example::
5760 # <- { "event": "BLOCK_JOB_READY",
5768 'len' : 'int',
5769 'offset': 'int',
5770 'speed' : 'int' } }
5776 # finalize graph changes via @block-job-finalize. If this job is part
5786 # .. qmp-example::
5788 # <- { "event": "BLOCK_JOB_PENDING",
5822 # configured write threshold. For thin-provisioned devices, this
5825 # re-registered with another block-set-write-threshold command.
5827 # @node-name: graph node name on which the threshold was exceeded.
5829 # @amount-exceeded: amount of data which exceeded the threshold, in
5832 # @write-threshold: last configured threshold, in bytes.
5837 'data': { 'node-name': 'str',
5838 'amount-exceeded': 'uint64',
5839 'write-threshold': 'uint64' } }
5842 # @block-set-write-threshold:
5846 # threshold. The threshold is an offset, thus must be non-negative.
5850 # This is useful to transparently resize thin-provisioned drives
5853 # @node-name: graph node name on which the threshold must be set.
5855 # @write-threshold: configured threshold for the block device, bytes.
5860 # .. qmp-example::
5862 # -> { "execute": "block-set-write-threshold",
5863 # "arguments": { "node-name": "mydev",
5864 # "write-threshold": 17179869184 } }
5865 # <- { "return": {} }
5867 { 'command': 'block-set-write-threshold',
5868 'data': { 'node-name': 'str', 'write-threshold': 'uint64' },
5869 'allow-preconfig': true }
5872 # @x-blockdev-change:
5877 # child. This is useful to fix a broken quorum child.
5891 # @unstable: This command is experimental, and its API is not stable.
5905 # .. qmp-example::
5908 # -> { "execute": "blockdev-add",
5911 # "node-name": "new_node",
5914 # <- { "return": {} }
5915 # -> { "execute": "x-blockdev-change",
5918 # <- { "return": {} }
5920 # .. qmp-example::
5923 # -> { "execute": "x-blockdev-change",
5926 # <- { "return": {} }
5928 { 'command': 'x-blockdev-change',
5933 'allow-preconfig': true }
5936 # @x-blockdev-set-iothread:
5943 # @node-name: the name of the block driver node
5957 # .. qmp-example::
5960 # -> { "execute": "x-blockdev-set-iothread",
5961 # "arguments": { "node-name": "disk1",
5963 # <- { "return": {} }
5965 # .. qmp-example::
5968 # -> { "execute": "x-blockdev-set-iothread",
5969 # "arguments": { "node-name": "disk1",
5971 # <- { "return": {} }
5973 { 'command': 'x-blockdev-set-iothread',
5974 'data' : { 'node-name': 'str',
5978 'allow-preconfig': true }
6003 # @sector-num: number of the first sector of the failed read operation
6005 # @sectors-count: failed read operation sector count
6007 # .. note:: This event is rate-limited.
6011 # .. qmp-example::
6013 # <- { "event": "QUORUM_FAILURE",
6014 # "data": { "reference": "usr1", "sector-num": 345435, "sectors-count": 5 },
6018 'data': { 'reference': 'str', 'sector-num': 'int', 'sectors-count': 'int' } }
6028 # contains a human-readable error message. There are no semantics
6032 # @node-name: the graph node name of the block driver state
6034 # @sector-num: number of the first sector of the failed read operation
6036 # @sectors-count: failed read operation sector count
6038 # .. note:: This event is rate-limited.
6042 # .. qmp-example::
6045 # <- { "event": "QUORUM_REPORT_BAD",
6046 # "data": { "node-name": "node0", "sector-num": 345435, "sectors-count": 5,
6050 # .. qmp-example::
6053 # <- { "event": "QUORUM_REPORT_BAD",
6054 # "data": { "node-name": "node0", "sector-num": 0, "sectors-count": 2097120,
6055 # "type": "flush", "error": "Broken pipe" },
6059 'data': { 'type': 'QuorumOpType', '*error': 'str', 'node-name': 'str',
6060 'sector-num': 'int', 'sectors-count': 'int' } }
6065 # @device: the device name or node-name of a root node to generate the
6076 # @blockdev-snapshot-internal-sync:
6084 # - If @device is not a valid block device, GenericError
6085 # - If any snapshot matching @name exists, or @name is empty,
6087 # - If the format of the image used does not support it,
6095 # .. qmp-example::
6097 # -> { "execute": "blockdev-snapshot-internal-sync",
6098 # "arguments": { "device": "ide-hd0",
6101 # <- { "return": {} }
6103 { 'command': 'blockdev-snapshot-internal-sync',
6105 'allow-preconfig': true }
6108 # @blockdev-snapshot-delete-internal-sync:
6115 # @device: the device name or node-name of a root node to delete the
6126 # - If @device is not a valid block device, GenericError
6127 # - If snapshot not found, GenericError
6128 # - If the format of the image used does not support it,
6130 # - If @id and @name are both not specified, GenericError
6134 # .. qmp-example::
6136 # -> { "execute": "blockdev-snapshot-delete-internal-sync",
6137 # "arguments": { "device": "ide-hd0",
6140 # <- { "return": {
6143 # "vm-state-size": 0,
6144 # "date-sec": 1000012,
6145 # "date-nsec": 10,
6146 # "vm-clock-sec": 100,
6147 # "vm-clock-nsec": 20,
6152 { 'command': 'blockdev-snapshot-delete-internal-sync',
6155 'allow-preconfig': true }
6165 'data': { 'unused-block-graph-info': ['BlockGraphInfo'] } }